Skip to content

Configuration of DPF Server - main.customer.xml

The values set in main.customer.xml or main.xml are evaluated when services are started. Thus when making changes, you have to reload the respective services afterwards.

Hint - evaluated keywords

DPF 4.x evaluates only the elements and keywords described on this page. All other elements and keywords in main.xml or main.customer.xml are not evaluated by DPF 4.x, for example processmanager, workingunit, watchdog, or nodenames.

Hint - main.customer.xml

Customize the settings in server\dpf\templates\main.customer.xml to prevent the settings from being overwritten when updating the DPF system.

You can also save main.xml and main.customer.xml directly in %SEAL_CUSTOMDIR%, not in a subdirectory. Their values override the values from server\dpf\templates\. Refer to Customer-Specific Files on Linux or Windows.

This chapter describes the configuration settings for:

File Format

The following elements of the XML configuration files are predetermined:

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
    </config>
</DPF>

Each element possesses predetermined keywords which will be evaluated internally by the DPF system. In addition to the predetermined keywords, you may configure any keywords.

Hint - upper/lower case

Note that upper and lower case are considered when reading the configuration files! You must use the element names and keywords in the notation given in this documentation!

accounting

In accounting, values are logged which then for example can be evaluated in a statistic. For each job, a line containing the values of the configured parameters are written into the accounting file.

For configuring the accounting, the following keyword is available in the <accounting> element:

LOGFORMAT

LOGFORMAT specifies the text and parameters enclosed by % that are written into the accounting file for each job. Here, you can specify any text and all parameters that are set at the end of the job. Unless the parameter is set, the field remains empty. After changing the value, call dpfupdate in a DPF Shell and restart the seal-dpf-filebeat service.

Available values: String

Default: %JOB_TIMESTAMP_BEGIN%;%JOB_TIMESTAMP_END%;%JOBID%;%WFNAME%;%ORIGUSERNAME%;%ORIGHOSTNAME%;%JOBSTATUS%

Hint - Elastic Stack

When using Elastic Stack, the format specified here has to be identical to the tokenizer value of the filebeat configuration.

Example

Filebeat configuration:

...
tokenizer: "Account Info: ';%{JOB_TIMESTAMP_BEGIN};%{JOB_TIMESTAMP_END};%{JOBID};%{WFNAME};%{ORIGUSERNAME};%{ORIGHOSTNAME};%{EXITSTATUS};%{DIST_CONFIG};%{USED_CHANNELS};%{PRINTJOB_TYPE};%{PARENTJOBID};'"
...

LOGFORMAT:

LOGFORMAT=";%JOB_TIMESTAMP_BEGIN%;%JOB_TIMESTAMP_END%;%JOBID%;%WFNAME%;%ORIGUSERNAME%;%ORIGHOSTNAME%;%EXITSTATUS%;%DIST_CONFIG%;%USED_CHANNELS%;%PRINTJOB_TYPE%;%PARENTJOBID%;"

Example (accounting)

Example configuration of accounting

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <accounting
            LOGFORMAT="%JOB_TIMESTAMP_BEGIN%;%JOB_TIMESTAMP_END%;%JOBID%;%WFNAME%;%ORIGUSERNAME%;%ORIGHOSTNAME%;%JOBSTATUS%"
        />
        ...
    </config>
</DPF>

DPFRestService

This section contains the configuration for the REST API used by seal-dpf-jobclient-api service and the DPF panel of SEAL Operator.

convert and convertGeneric

The <convert> and <convertGeneric> sections contain the <jobConfig> child elements with the job configurations for conversion respective generic conversion jobs. Each <jobConfig> element has two parameters:

  • name: used for calling the workflow via REST service, case-sensitive
  • workflow: workflow that is to be called when name is called

<jobConfig> elements can contain job parameters as <jobParameters><jobParameter> and result parameters as <resultParameters><resultParameter>. Both parameter elements have a parameter:

  • name: name of the parameter

The content of the element is the value of the parameter. The value can be empty. When the job starts, DPF sets each configured job parameter and result parameter as job parameter with this value. The workflow can change the value during processing. The job result of the Jobclient API, GET /jobs/{jobID}/result, returns the job parameters with their current values.

Example (convert)

Example - configuration of ConvertJobs

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <DPFRestService>
            <convert>
                <jobConfig name="convert" workflow="DPF4Convert.net_convert">
                </jobConfig>
                <jobConfig name="convertNative" workflow="DPF4Convert.net_convert_native">
                </jobConfig>
                <jobConfig name="convert_with_result_parameters" workflow="DPF4Convert.net_convert">
                    <resultParameters>
                        <resultParameter name="CurrFileName"></resultParameter>
                        <resultParameter name="TestParamInputFile"></resultParameter>
                    </resultParameters>
                </jobConfig>
            </convert>
        </DPFRestService>
    </config>
</DPF>

Example (convertGeneric)

Example - configuration of GenericJobs

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <DPFRestService>
            <convertGeneric>
                <jobConfig name="merge" workflow="DPF4CONVERT.ConvertDocuments">
                    <jobParameters>
                        <jobParameter name="DPF4C_NET_PUT_DATA">Y</jobParameter>
                        <jobParameter name="WANT_MERGE">Y</jobParameter>
                        <jobParameter name="WANT_STAMP">Y</jobParameter>
                    </jobParameters>
                </jobConfig>
            </convertGeneric>
        </DPFRestService>
    </config>
</DPF>

SealOperatorPanels

In the SealOperatorPanels section you provide the panel.json needed for the DPF4Convert panel of SEAL Operator. The panel.json defines the UI and available options in the panel. For more information, refer to Connect a DPF System on Windows or on Linux in the SEAL Operator documentation.

Example (SealOperatorPanels)

Example - configuration of SEAL Operator DPF Panels

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <DPFRestService>
            <SealOperatorPanels>
                <SealOperatorPanel config="%DPFSRV%/conf/operator/panel.json"></SealOperatorPanel>
            </SealOperatorPanels>
        </DPFRestService>
    </config>
</DPF>

jobcleaner

seal-dpf-jobcleaner service deletes the finished jobs from the job files’ directory and the MongoDB database. The jobs are deleted in two steps:

  • In the first step, the job files are deleted.
  • In the second step, the complete job directory is deleted that means the information about the job.

seal-dpf-process-manager calculates both times when a job ends, from DELETEJOB, ERR_DELETEJOB, and FORGETJOB. Job parameters do not change these times.

For configuring seal-dpf-jobcleaner, the following keywords are available in the <jobcleaner> element:

DELETEJOB

DELETEJOB specifies when the job files of a successful job are deleted, counted from the end of the job. After changing this value, the seal-dpf-process-manager service has to be restarted.

Available values: String

  • atonce

    The job files will be deleted right after the processing.

  • time span, for example 1h or 2d

    The job files will be deleted after the specified time span.

Default: 1h

ERR_DELETEJOB

ERR_DELETEJOB specifies when the job files of an erroneous job are deleted, counted from the end of the job. After changing this value, the seal-dpf-process-manager service has to be restarted.

Available values: String

  • atonce

    The job files of the erroneous jobs will be deleted right after the processing.

  • time span, for example 1h or 2d

    The job files of the erroneous jobs will be deleted after the specified time span.

Default: 4d

FORGETJOB

FORGETJOB specifies when the job directory and the information about the job are deleted, counted from the deletion of the job files. After changing this value, the seal-dpf-process-manager service has to be restarted.

Available values: String

  • atonce

    The job directory will be deleted together with the job files.

  • time span, for example 1h or 2d

    The job directory will be deleted after the specified time span.

Default: 2d

RETRY_FORGETJOB

RETRY_FORGETJOB specifies the time after that seal-dpf-jobcleaner retries deleting the job information when an error occurred. After changing this value, the seal-dpf-jobcleaner service has to be restarted.

Available values: String

  • time span, for example 1m

    seal-dpf-jobcleaner retries deleting the job information after the specified time span.

Default: 1m

RETRY_DELETEJOB

RETRY_DELETEJOB specifies the time after that seal-dpf-jobcleaner retries deleting the job files when an error occurred. After changing this value, the seal-dpf-jobcleaner service has to be restarted.

Available values: String

  • time span, for example 1m

    seal-dpf-jobcleaner retries deleting the job files after the specified time span.

Default: 1m

Example (jobcleaner)

Example configuration

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <jobcleaner
            DELETEJOB="3h"
            ERR_DELETEJOB="4d"
            FORGETJOB="2d"
            RETRY_DELETEJOB="1m"
            RETRY_FORGETJOB="1m"
        />
        ...
    </config>
</DPF>
Back to top