Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

transfer.ini [TransferSettings]

The settings of [TransferSettings] in transfer.ini: Engine, ToolEngine, QueueNeedsWorker, KeepDays

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/transfer/TransferSettings.md

On this page

transfer.ini [TransferSettings]

The block [TransferSettings] of settings/transfer.ini, with 4 setting(s).

Never edit settings/transfer.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/transfer.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/transfer.ini.append.php for one siteaccess,
  • extension/<extension>/settings/transfer.ini.append.php in an extension (read when the extension is active).

Engine

Which engine runs a tool's background runs:
auto the job queue (expqueue) when it can take them, else the kernel's content jobs, else the
tool's own process (the default)
expqueue the job queue; needs expqueue active, its tables installed, the tool's job type in expqueue.ini
(the tool's QueueJobType=) and a live queue worker (see QueueNeedsWorker)
contentjob the kernel's content jobs (content.ini [ContentJobSettings] JobTypes[transfer]), which start a
worker process of their own for each run
process the tool's own way of running in the background, as before 6.0.15
An engine that is not available falls back in that order. A tool may name its own engine (Engine= in its
[Service_transfer.<id>] block of kernelservices.ini); ToolEngine[<tool id>] here wins over both.

Default: auto.

<?php /* #?ini charset="utf-8"?
# settings/override/transfer.ini.append.php
[TransferSettings]
Engine=auto
*/ ?>

ToolEngine

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/transfer.ini.append.php
[TransferSettings]
# an empty "ToolEngine[]" first replaces the shipped list; without it the items are added
ToolEngine[]
*/ ?>

QueueNeedsWorker

ToolEngine[transfer.xrowextract]=contentjob
Whether the job queue is used only while a queue worker is alive (a run queued with no worker would wait
until one starts). disabled: queue the run anyway.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/transfer.ini.append.php
[TransferSettings]
QueueNeedsWorker=enabled
*/ ?>

KeepDays

Days the run history keeps a finished run (exp_transfer_run); 0 keeps every run.
The tools keep their own records and files as long as their own settings say.

Default: 365.

<?php /* #?ini charset="utf-8"?
# settings/override/transfer.ini.append.php
[TransferSettings]
KeepDays=365
*/ ?>

Generated by ./console exp:help:examples from settings/transfer.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x