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 - 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.

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 keywords are 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%;"

LOGLEVEL (accounting)

LOGLEVEL specifies here if the line is written into the accounting file.

Available values: Enumeration

  • LOG_OFF or OFF

    Nothing is written into the accounting file.

  • LOG_INFO or I

    The line is written into the accounting file.

Default: LOG_INFO

LOGNAME

LOGNAME specifies the base name of the accounting file.

Available values: String

  • <basename>

    The <basename>.log file will be created in the log directory, data\log.

Default: account

LOGSIZE (accounting)

LOGSIZE specifies the size of the accounting file in KB. When reaching the specified size, the accounting file will be saved with the extension .old and a new accounting file will be started. If a saved accounting file with the .old extension already exists, it will be overwritten.

Available values: Integer

Default: 1000

Example (accounting)

Example configuration of accounting

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

dpfgate

DPF Gate is not available for DPF 4.0.0.

DPFRestService

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

LOGLEVEL (DPFRestService)

LOGLEVEL specifies the log level.

Available values: Enumeration

  • LOG_OFF or OFF

    No log messages

  • LOG_RUN or R

    Only start and stop messages; the identifier of these messages is [R].

  • LOG_FATAL or F

    LOG_RUN and fatal error messages; the identifier of these messages is [F].

  • LOG_ERROR or E

    LOG_FATAL and all errors; the identifier of these messages is [E].

  • LOG_WARN or W

    LOG_ERROR and all warnings; the identifier of these messages is [W].

  • LOG_INFO or I

    LOG_WARN and info messages; the identifier of the messages is [I].

  • LOG_DEBUG or D

    LOG_INFO and debug messages; the identifier of these messages is [D].

  • LOG_TRACE or T

    LOG_DEBUG and trace messages; the identifier of these messages is [T].

Default: LOG_INFO

Large file

With LOG_TRACE, the log files become very large and, therefore, slow down the system very much. For this reason, activate this log level only very selectively and deactivate it again as soon as possible!

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 result parameters as <resultParameters><resultParameter>. Job parameters as <jobParameters><jobParameter> can only be configured for <convertGeneric> jobs. Both parameter elements have a parameter:

  • name: name of the parameter

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>

OIDC

The OIDC section is no longer supported as of DPF 4.0.0.

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>

javawu

LOGLEVEL (javawu)

LOGLEVEL specifies the log level.

Available values: Enumeration

  • LOG_OFF or OFF

    No log messages

  • LOG_RUN or R

    Only start and stop messages; the identifier of these messages is [R].

  • LOG_FATAL or F

    LOG_RUN and fatal error messages; the identifier of these messages is [F].

  • LOG_ERROR or E

    LOG_FATAL and all errors; the identifier of these messages is [E].

  • LOG_WARN or W

    LOG_ERROR and all warnings; the identifier of these messages is [W].

  • LOG_INFO or I

    LOG_WARN and info messages; the identifier of the messages is [I].

  • LOG_DEBUG or D

    LOG_INFO and debug messages; the identifier of these messages is [D].

  • LOG_TRACE or T

    LOG_DEBUG and trace messages; the identifier of these messages is [T].

Default: LOG_INFO

Large file

With LOG_TRACE, the log files become very large and, therefore, slow down the system very much. For this reason, activate this log level only very selectively and deactivate it again as soon as possible!

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.

For seal-dpf-jobcleaner, the keywords INSTANCES, KEEPUNTILFORGET, LOGLEVEL, SLEEP_MILLI_SECONDS, VERSION are obsolet.

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

DELETEJOB (jobcleaner)

DELETEJOB specifies the deletion time of the job files. 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.

  • never

    The job files will never be deleted.

  • <week> W <day> D <hour> H <minute> M <second> S

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

Default: never

Hint - evaluation

The keyword is only evaluated if it is not specified with the job.

ERR_DELETEJOB

ERR_DELETEJOB specifies the deletion time of the job files of the erroneous jobs. 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.

  • never

    The job files of the erroneous jobs will never be deleted.

  • <week> W <day> D <hour> H <minute> M <second> S

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

Default: never

Hint - evaluation

The keyword is only evaluated if it is not specified with the job.

FORGETJOB

FORGETJOB specifies the deletion time of the job directory. After changing this value, the seal-dpf-process-manager service has to be restarted.

Available values: String

  • atonce

    The job directory will be deleted right after the processing.

  • never

    The job directory will never be deleted.

  • <week> W <day> D <hour> H <minute> M <second> S

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

Default: never

Hint - evaluation

The keyword is only evaluated if it is not specified with the job.

LOGLEVEL (jobcleaner)

LOGLEVEL specifies the log level.

Available values: Enumeration

  • LOG_OFF or OFF

    No log messages

  • LOG_RUN or R

    Only start and stop messages; the identifier of these messages is [R].

  • LOG_FATAL or F

    LOG_RUN and fatal error messages; the identifier of these messages is [F].

  • LOG_ERROR or E

    LOG_FATAL and all errors; the identifier of these messages is [E].

  • LOG_WARN or W

    LOG_ERROR and all warnings; the identifier of these messages is [W].

  • LOG_INFO or I

    LOG_WARN and info messages; the identifier of the messages is [I].

  • LOG_DEBUG or D

    LOG_INFO and debug messages; the identifier of these messages is [D].

  • LOG_TRACE or T

    LOG_DEBUG and trace messages; the identifier of these messages is [T].

Default: LOG_INFO

Large file

With LOG_TRACE, the log files become very large and, therefore, slow down the system very much. For this reason, activate this log level only very selectively and deactivate it again as soon as possible!

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

  • <week> W <day> D <hour> H <minute> M <second> S

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

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

  • <week> W <day> D <hour> H <minute> M <second> S

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

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"
        </jobcleaner>
        ...
    </config>
</DPF>

nodenames

For configuring the server for the DPF system and the servers of the remote <nodenames> working unit, the following element is available in the <nodesname> element:

In the <nodenames><node> element, you configure the names of the servers for the DPF systems and the remote working units. The following attributes are available in the <nodenames><node> element:

NAME specifies the name of the server of the DPF system.

In the <nodenames><node><variable> element, you can configure any servers of the remote working units as variable variable. Then, you use this variable in the configuration of the working units.

In the <nodenames><node><DEFAULTNODE> element, you specify the server where all working units are to be executed if no server has been specified in the configuration.

Example - simple remote system

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
    ...
        <nodenames>
            <node NAME="dpf01">
                <REMOTENODES>
                    dpf001 dpf006
                </REMOTENODES>
                <DEFAULTNODE>
                    %DB_HOST%
                </DEFAULTNODE>
            </node>
        </nodenames>
    ...
    </config>
</DPF>

Example - complex remote system with different CAD converters, test and productive systems

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
    ...
        <nodenames>
            <node NAME="dpftst01">
                <ACADNODES>
                    dpftst001
                </ACADNODES>
                <PROE_NODES>
                    dpftst003
                </PROE_NODES>
                <OFFICENODES>
                    dpftst004 dpftst005
                </OFFICENODES>
                <DEFAULTNODE>
                    %DB_HOST%
                </DEFAULTNODE>
            </node>
            <node NAME="dpf01">
                <ACADNODES>
                    dpf001
                </ACADNODES>
                <PROE_NODES>
                    dpf003
                </PROE_NODES>
                <OFFICENODES>
                    dpf004 dpf005
                </OFFICENODES>
                <DEFAULTNODE>
                    %DB_HOST%
                </DEFAULTNODE>
            </node>
        </nodenames>
    ...
    </config>
</DPF>

processmanager

The seal-dpf-process-manager handles the execution of workflows.

The keywords INSTANCES, NODENAMES, SLEEP_MILLI_SECONDS, THREADS, WARN_BEFORE_LICENSE_EXPIRES are no longer supported for this service.

For configuring seal-dpf-process-manager service, the following keywords are available in the element:

LOGLEVEL (processmanager)

LOGLEVEL specifies the log level.

Available values: Enumeration

  • LOG_OFF or OFF

    No log messages

  • LOG_RUN or R

    Only start and stop messages; the identifier of these messages is [R].

  • LOG_FATAL or F

    LOG_RUN and fatal error messages; the identifier of these messages is [F].

  • LOG_ERROR or E

    LOG_FATAL and all errors; the identifier of these messages is [E].

  • LOG_WARN or W

    LOG_ERROR and all warnings; the identifier of these messages is [W].

  • LOG_INFO or I

    LOG_WARN and info messages; the identifier of the messages is [I].

  • LOG_DEBUG or D

    LOG_INFO and debug messages; the identifier of these messages is [D].

  • LOG_TRACE or T

    LOG_DEBUG and trace messages; the identifier of these messages is [T].

Default: LOG_INFO

Large file

With LOG_TRACE, the log files become very large and, therefore, slow down the system very much. For this reason, activate this log level only very selectively and deactivate it again as soon as possible!

LOGSIZE (processmanager)

LOGSIZE specifies the maximum size of the DPF Process Manager log file in KB. When reaching the specified size, the log file will be saved with the extension .old and a new log file will be started. If a file with the .old extension already exists, it will be overwritten.

Available values: Integer

Default: 1000

Example (processmanager)

Example configuration of DPF Process Manager

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <processmanager
            LOGLEVEL="LOG_INFO"
            LOGSIZE="1000"
        />
        ...
    </config>
</DPF>

watchdog

This section is obsolet. DPF Watchdog is no longer part of Digital Process Factory.

workingunit

seal-dpf-wusystemcall service starts and manages all working units of the type WUSystemCall but the application converter.

The keywords NODENAMES, SLEEP_MILLI_SECONDS, THREADS are no longer supported for this service.

For configuring seal-dpf-wusystemcall service, the following keywords are available in the element:

LOGLEVEL (workingunit)

LOGLEVEL specifies the log level.

Available values: Enumeration

  • LOG_OFF or OFF

    No log messages

  • LOG_RUN or R

    Only start and stop messages; the identifier of these messages is [R].

  • LOG_FATAL or F

    LOG_RUN and fatal error messages; the identifier of these messages is [F].

  • LOG_ERROR or E

    LOG_FATAL and all errors; the identifier of these messages is [E].

  • LOG_WARN or W

    LOG_ERROR and all warnings; the identifier of these messages is [W].

  • LOG_INFO or I

    LOG_WARN and info messages; the identifier of the messages is [I].

  • LOG_DEBUG or D

    LOG_INFO and debug messages; the identifier of these messages is [D].

  • LOG_TRACE or T

    LOG_DEBUG and trace messages; the identifier of these messages is [T].

Default: LOG_INFO

Large file

With LOG_TRACE, the log files become very large and, therefore, slow down the system very much. For this reason, activate this log level only very selectively and deactivate it again as soon as possible!

LOGSIZE (workingunit)

LOGSIZE specifies the maximum size of the DPF Working Unit Manager log file in KB. When reaching the specified size, the log file will be saved with the extension .old and a new log file will be started. If a file with the .old extension already exists, it will be overwritten.

Available values: Integer

Default: 1000

Example (workingunit)

Example configuration of DPF Working Unit Manager

<?xml version="1.0" encoding="ISO-8859-1"?>
<DPF>
    <config>
        ...
        <workingunit
            LOGLEVEL="LOG_INFO"
            LOGSIZE="1000"
        />
        ...
    </config>
</DPF>
Back to top