Worker Configuration¶
Job Directories¶
XF Worker uses a temporary directory for each job. These directories are usually deleted when a job finishes successfully, but when jobs fail they are kept for diagnostic purposes. They should be deleted manually regularly to free up disk space.
By default, if the environment variable %XFTEMP% is not defined, the directories are created in %LOCALAPPDATA%\Lucid_Concepts_AG\WorkerService\JobsTemp.
The environment variable %XFTEMP% can be used to configure a different location, e.g. to use a different disk.
The worker service must be restarted when the environment variable is changed.
Dependency Packages¶
XF Worker can be configured to execute only certain jobs, by installing or not installing dependency packages.
Dependency packages can be installed via the XF Desktop UI or via command line option /add-dependency.
By default, if the environment variable %XAMFLOW_OVERRIDE_DIR_PACKAGES_DEPS% is not defined, dependency packages are installed in %LOCALAPPDATA%\Lucid_Concepts_AG\WorkerService\Deps_Workstation.
To remove them delete the respective directory.
The environment variable %XAMFLOW_OVERRIDE_DIR_PACKAGES_DEPS% can be used to configure a different location, e.g. to use a different disk.
The worker service must be restarted when the environment variable is changed.
Task Type Packages¶
XF Worker automatically installs task type packages to execute jobs.
By default, if the environment variable %XAMFLOW_OVERRIDE_DIR_PACKAGES_TASKTYPES% is not defined, task type packages are installed in %LOCALAPPDATA%\Lucid_Concepts_AG\WorkerService\Packages.
To remove them delete the respective directory.
The environment variable %XAMFLOW_OVERRIDE_DIR_PACKAGES_TASKTYPES% can be used to configure a different location, e.g. to use a different disk.
The worker service must be restarted when the environment variable is changed.
Network Connection¶
XF Worker uses a network connection to XF Server,
which can be configured via the command line options /config-username, /config-password and /config-url.
License¶
XF Worker (but not XF Workstation) usually executes jobs under a special Windows account LocalService.
Licenses for that account can be imported using the command line options /import-license (for Lucid command line tools, like LUPO)
or /import-scanco-license (for Scanco command line tools, like IPL).
Compression¶
By default, if the environment variable %XFAUTOCOMPRESS% is not defined, output images are compressed on disk where possible.
The environment variable %XFAUTOCOMPRESS% can be set to 1 to explicitly enable automatic compression of output images,
or it can be set to 0 to disable automatic compression.
The worker service must be restarted when the environment variable is changed.
MPI CPU Usage¶
By default, if the environment variable %XFMPITASKS% is not defined, some task types use most available CPU power using MPI processes.
The environment variable %XFMPITASKS% can be set to the number of MPI processes to use. It should usually not be lower than 2 or higher than the number of available CPUs.
The worker service must be restarted when the environment variable is changed.
IPL¶
IPL can be used in XamFlow. By default, XamFlow attemps to parse the IPL output error messages and triggers IPL jobs to fail when an error is detected.
The environment variable %XFIPLIGNOREERRORS% is not defined by default, but when set to certain values XamFlow ignores certain IPL error messages.
For the value ALL, all IPL error messages are ignored.
For the value ERRORX5, the IPL error messages ERROR ERROR ERROR ERROR ERROR is ignored.
It is not recommended to set these values in general, but it can be useful in certain situations for example to investigate the results IPL is warning about.
