Skip to content

Job Parameters

The parameters in a DPF system are job parameters specified when assigning the job or in the configuration of the working unit or the process. Other parameters are set internally by the DPF system.

This reference lists, in alphabetical order, the job parameters which are set or evaluated by the DPF clients or the DPF system.

Hint - notation

To make the parameter names easier to read and to normalize them, the "smart" notation for parameter names has been introduced in DPF 1.1.7:

  • Case insensitivity in the parameter names
  • Underscores are ignored

That means, CurrFileName is identical to CURRFILENAME and WuName is identical to WU_NAME.

Literature - usage

On how and where to set parameters, refer to these use case descriptions:

CurrAssocFileName

CurrAssocFileName<n> specifies the temporary absolute name of the n-th associated file used in a working unit. The counting of n starts with 1.

Available values: String

Default: none

CurrFileName

CurrFileName specifies the temporary absolute name of the current file used in the working unit as input file. The file must be located in the job directory to be deleted together with the other job files at the specified time.

Available values: String

Default: none

Hint - update

The working unit should update this parameter after it has created a new intermediate file. Therefore, all intermediate files are kept. This way, intermediate steps may easily be reconstructed if an error occurs.

CurrRliFileName

CurrRliFileName specifies the name of the current repro list file which is used as input file in the working unit. The file must be located in the job directory in order to be deleted together with the other job files at the specified time.

Available values: String

Default: none

DeleteJob

DeleteJob specifies the deletion time of the job files.

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: Value of DELETEJOB in the configuration of DPF Job Cleaner

Hint - quotes

The space between number and unit is optional. But if you use spaces, you have to quote the value as seen in the examples below.

Example

dpfclient -wf example -s DELETEJOB=2m
dpfclient -wf example -s DELETEJOB="2 m"

The job.log will show something like 

2024-05-15T11:06:56.827 [I] Job start time = 2024-05-15T11:06:51.372, finish time = 2024-05-15T11:06:56.827, period = 5.455 seconds
2024-05-15T11:06:56.851 [I] Parameter DELETEJOB = 2 M -> 120 seconds
2024-05-15T11:06:56.853 [I] Parameter FORGETJOB = 2D -> 172800 seconds
2024-05-15T11:06:56.868 [I] Job 202405142206510014 finished, status 'OK'

Hint - DeleteJob versus ForgetJob

Log files and the job itself are not deleted. Those stay in the job directory and the DPF Tracker for the time specified by ForgetJob.

Literature

Refer to Parameters for Deleting Jobs.

DpfControlCallbackUrl

DpfControlCallbackUrl specifies the callback URL to which seal-dpf-urlcallback service sends the PUT request containing the tracker URL of the job.

Available values: String

  • <callback_url>

Default: none

Example - request a callback with DPF client

dpfclient -wf example -s DpfControlCallbackUrl=http://callbackhost:port/ourjobmanager/ourjobno/12345

Literature - use case description

For the complete description of the sent PUT request, refer to URL Callback.

DpfJobIcon

DpfJobIcon specifies the base name of the PNG file displayed as icon in DPF Tracker. The graphic files are located in the server\dpf\filepool directory.

Available values: String

  • error

    In DPF Tracker, the error.png icon will be displayed (included in delivery).

  • ok

    In DPF Tracker, the ok.png icon will be displayed (included in delivery).

  • warn

    In DPF Tracker, the warn.png icon will be displayed (included in delivery).

  • <basename>

    In DPF Tracker, the <basename>.png icon will be displayed.

Default: none

Hint - debug

The jobs in debug mode are displayed with a bug icon in DPF Tracker.

DpfJobMessage

DpfJobMessage specifies the optional text which is displayed additionally in the status field of DPF Tracker.

Available values: String

Default: none

Hint - line break

In DpfJobMessage, you can generate multiline messages by using the <br> and <br/> HTML tags. All other HTML tags are displayed as clear text.

DpfJobProgress

DPfJobProcess specifies the percentage points displayed by DPF Tracker and other DPF clients as progress bar.

Available values: Integer

  • 0 ... 100

    Percentage points displayed by DPF Tracker and other DPF clients as progress bar

Default: none

DpfSrvGetFiles

DpfSrvGetFiles specifies the list of parameters containing names of files to be passed from the DPF client to the DPF system together with the job. The <parameter> parameters are set by the DPF client. After passing them to the DPF system, they are copied to the Source<parameter> parameters by the DPF system.

Available values: String

Default: none

Example of passing files using the DpfSrvGetFiles parameter

In a job, you want to pass file1.txt and file2.txt to the DPF system. The filenames are specified with the following parameters: 

parameter1=file1
parameter2=file2

Set the DpfSrvGetFiles parameter for transferring the files as follows: 

dpfclient -wf procname -s "DpfSrvGetFiles=parameter1 parameter2"

DPF Batch Client passes passes both files to the DPF system. The DPF system saves the values in the following parameters: 

Sourceparameter1=file1
Sourceparameter2=file2

Example illustrating the naming of parameters

The job call by the DPF client 

dpfclient -wf example -s foo=t:\tmp\capitol.pdf -s bar=t:\tmp\kandinsky1.pdf -s "DPF_SRV_GET_FILES=foo bar"

results in these parameters (excerpt): 

DPF_SRV_GET_FILES = foo bar
SOURCE_bar = t:\tmp\kandinsky1.pdf
SOURCE_foo = t:\tmp\capitol.pdf
bar = C:\SEAL\applications\data\dpf\dpfjob202405130413160011\kandinsky1.pdf
foo = C:\SEAL\applications\data\dpf\dpfjob202405130413160011\capitol.pdf

ErrDeleteJob

ErrDeleteJob specifies the deletion time of the job files of the erroneous jobs.

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: Value of ERR_DELETEJOB in the configuration of DPF Job Cleaner

Hint - qint - quotes

The space between number and unit is optional. But if you use spaces, you have to quote the value.

ErrJobStatus

ErrJobStatus specifies the job status at the time when the error occurred.

Backup of the JobStatus parameter.

Available values: String

Default: none

ErrJobStatusText

ErrJobStatusText specifies the language-specific text for the job status at the time when the error occurred. Backup of the JobStatusText parameter.

Available values: String

Default: none

ErrReason

ErrReason specifies an optional text concerning the error reason. The text is set by the working unit; the parameter's content will be displayed in DPF Tracker and other DPF clients with erroneous jobs.

Available values: String

Default: none

ErrWfName

ErrWfName specifies the name of the process or subprocess processing the job at the time when the error occurred. Backup of the WfName parameter.

Available values: String

Default: none

ErrWfPath

ErrWfPath specifies the complete hierarchy of the processes and subprocesses up to the current section where the job was when the error occurred. Backup of the WfPath parameter.

Available values: String

  • procname:procsection/sprocname:sprocsection

    complete hierarchy of the processes and subprocesses

Default: none

ErrWfPosition

ErrWfPosition specifies the name of the section in the process or subprocess where the job was when the error occurred. Backup of the WfPosition parameter.

Available values: String

Default: none

ErrWuName

ErrWuName specifies the name of the working unit where the job was when the error occurred. Backup of the WuName parameter.

Available values: String

Default: none

ExitCode

ExitCode specifies the return code of the external script. The return code is not written to the parameter file by the external program but by the working unit which called the external program. The 0 return code is considered a success, all other values are considered an error. In the case of error, the job is passed on as erroneous. In case of timeout, 553648141 will be returned.

Available values: Integer

Default: none

ExtProgCallStdout

ExtProgCallStdout specifies the messages of the external script on the standard output as single-line text.

Available values: String

Default: none

ForgetJob

ForgetJob specifies the deletion time of the job directory including the job.log. The job will no longer be visible in DPF Tracker.

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: Value of FORGETJOB in the configuration of DPF Job Cleaner

Hint - quotes

The space between number and unit is optional. But if you use spaces, you have to quote the value.

JobDir

JobDir specifies the absolute path of the job directory for the current job (without closing slash).

Available values: String

Default: none

JobID

JobID specifies the ID of the current job.

Available values: String

Default: none

JobName

JobName specifies the job name displayed in DPF Tracker.

Available values: String

Default: none

JobPriority

JobPriority specifies the job priority. The higher the number is, the higher is the priority.

Available values: Integer

Default: no

JobStatus

JobStatus specifies the current status of the job.

Available values: String

Default: none

Hint - backup

When an error occurs, the JobStatus parameter will be saved as ErrJobStatus.

JobStatusText

JobStatusText specifies the language-specific text concerning the current job status. JobStatusText is available for the entry in dialogs and log messages. The language is taken from the PLS_LANG environment variable.

Available values: String

Default: none

Hint - backup

When an error occurs, the JobStatusText parameter will be saved as ErrJobStatusText.

JobTimeStampBegin

JobTimeStampBegin specifies the time when a working unit starts processing a job. The parameter is set by the DPF system.

Available values: String

Default: none

JobTimeStampEnd

JobTimeStampEnd specifies the time when a working unit ends processing a job. The parameter is set by the DPF system.

Available values: String

Default: none

JobUserName

JobUserName specifies the user name displayed in DPF Tracker.

Available values: String

Default: none

KeepUntilForget

KeepUntilForget specifies the name of the job files kept until the job directory will be deleted. Wildcards are not possible here! In case of multiple file names, separate them by space and enclose the complete value with quotes.

Available values: String

  • <file1> <file2> ... <filen>

    Names of the job files that are kept

Default: Value of KEEPUNTILFORGET in the configuration of DPF Job Cleaner

Example

dpfclient -wf example -s KeepUntilForget="file1.pdf file2.pdf"

LogLevel

LogLevel specifies the log level for the job.

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!

Hint - service logs

To specify the log level for services, refer to LOG_LEVEL.

LogStdOut

LogStdOut specifies if the output of the external script is to be written into the log file.

Available values: Boolean

  • N

    The output of the external script is written into the log file only if the log level has been set to LOG_DEBUG.

  • Y

    The output of the external script is always written into the log file. For this, the log level must be at least LOG_INFO.

Default: Y

OrigAssocFileName

OrigAssocFileName<n> specifies the name of the n-th associated file as it has been stored in the job directory. The counting of n starts with 1.

Available values: String

Default: none

Do not change

The working unit should not change OrigAssocFileName<n>.

OrigAuthenticationId

OrigAuthenricationId specifies the number for logging on to Windows Terminal Server. When calling DPF Batch Client, this value can be specified as parameter as well.

Available values: Integer

Default: none

OrigClientIP

OrigClientIP specifies the IP address of the server where the DPF client was started. When calling DPF Batch Client, this value can be specified as parameter as well.

Available values: String

Default: none

OrigDpfData

OrigDpfData specifies the value of DPFDATA on the server. OrigDpfData is used with remote working units.

Available values: String

Default: none

OrigDpfRoot

OrigDpfRoot specifies the value of DPFROOT on the server. OrigDpfRoot is used with remote working units.

Available values: String

Default: none

OrigFileName

OrigFileName specifies the name of the job file as it has been stored in the job directory.

Available values: String

Default: none

Do not change

The file must not be changed and, also, the working units should not change the OrigFileName parameter.

OrigFileServerIOR

OrigFileServerIOR specifies the connection data of the DPF client for the file transfer between the DPF client and the DPF system.

Available values: String

Default: none

Requirement

Required for the data retransfer from the DPF system to the DPF client is that the used process contains a WUSendFile working unit and that the job assignment is synchronous.

OrigHostName

OrigHostName specifies the name of the server where the DPF client was started. When calling DPF Batch Client, this value can be specified as parameter as well.

Available values: String

Default: none

OrigUserName

OrigUserName specifies the name of the user who started the DPF client. When calling DPF Batch Client, this value can be specified as parameter as well.

Available values: String

Default: none

ParentJobID

ParentJobID specifies the ID of the main job. ParentJobID will be displayed in DPF Tracker.

Available values: String

Default: none

ParFileName

ParFileName specifies the absolute name of the parameter file. In the script call which you specify at the COMMAND keyword in the working unit, you can use it as %ParFileName% then.

Available values: String

Default: none

PreviousWorkingUnit

PreviousWorkingUnit specifies the name of the previous working unit. Usually, PreviousWorkingUnit is only evaluated by a working unit which is called when an error occurred and discloses the source of the error.

Available values: String

Default: none

Sourceparameter

Sourceparameter specifies the original file name passed as <parameter> parameter to the DPF system in the DpfSvrGetFiles list.

Available values: String

Default: none

Do not change

The working unit should not change Sourceparameter.

Example illustrating the naming of parameters

The job call by the DPF client 

dpfclient -wf example -s foo=t:\tmp\capitol.pdf -s bar=t:\tmp\kandinsky1.pdf -s "DPF_SRV_GET_FILES=foo bar"

results in these parameters (excerpt): 

DPF_SRV_GET_FILES = foo bar
SOURCE_bar = t:\tmp\kandinsky1.pdf
SOURCE_foo = t:\tmp\capitol.pdf
bar = C:\SEAL\applications\data\dpf\dpfjob202405130413160011\kandinsky1.pdf
foo = C:\SEAL\applications\data\dpf\dpfjob202405130413160011\capitol.pdf

SourceAssocFileName

SourceAssocFileName<n> specifies the original name of the n-th associated file.

Available values: String

Default: none

Do not change

The working unit should not change SourceAssocFileName<n>.

SourceFileName

SourceFileName specifies the original name of the job file.

Available values: String

Default: none

Do not change

The working unit should not change SourceFileName.

SourceFileProperties

SourceFileProperties specifies the parameters containing the paths and names of the job files.

Available values: String

Default: none

SubJobID

SubJobID specifies the ID of the job used by DPF Batch Client.

Available values: String

Default: none

TargetDir

TargetDir specifies the path that is put in front of the file names evaluated from TargetFileProperties.

Available values: String

Default: none

TargetFile

TargetFile specifies the base name of the result file.

Available values: String

Default: none

TargetFileName

TargetFileName specifies the file name of the result file.

Available values: String

Default: none

TargetFileProperties

TargetFileProperties specifies the parameters containing the paths and names of the result files.

Available values: String

Default: The paths and name are evaluated from SourceFileProperties.

TimeOut

TimeOut specifies the number of seconds after which DPF Working Unit Manager cancels the processing in the working unit for the job.

Available values: Integer

Default: Value set in the process

Validity

Set Timeout very selectively at specific locations in the process only and not generally in a Modify module due to this would apply to all working units until the job is finished.

WfName

WfName specifies the names of the process or subprocess where the job is being processed.

Available values: String

Default: none

Hint - backup

When an error occurs, the WfName parameter will be saved as ErrWfName.

WfPath

WfPath specifies the complete hierarchy of the processes and subprocesses up to the current section where the job is.

Available values: String

  • procname:procsection/sprocname:sprocsection

    complete hierarchy of the processes and subprocesses

Default: none

Hint - backup

When an error occurs, the WfPath parameter will be saved as ErrWfPath.

WfPosition

WfPosition specifies the name of the section of the process or subprocess where the job is being processed.

Available values: String

Default: none

Hint - backup

When an error occurs, the WfPosition parameter will be saved as ErrWfPosition.

WuDeleteParFile

WuDeleteParFile specifies if the parameter file will be deleted.

Available values: Boolean

  • N

    The parameter file will not be deleted.

  • Y

    The parameter file will be deleted.

Default: N

Hint - error case

The parameter file will never be deleted when an error occurs.

WuEnableDebugLoop

WuEnableDebugLoop specifies if a dialog is displayed after calling COMMAND. The dialog in question lets you decide whether the current process or working unit is to be passed through again, the process is to be continued or to be canceled.

Available values: Boolean

  • N

    After calling COMMAND, no dialog will be displayed.

  • Y

    After calling COMMAND, a dialog will be displayed.

Default: N

WuEnablePtkdb

WuEnablePtkdb specifies if Perl Tk Debugger is activated.

Available values: Boolean

  • N

    Perl Tk Debugger is deactivated.

  • Y

    Perl Tk Debugger is activated.

Default: N

WuHostName

WuHostName specifies the name of the server where the working unit is running.

Available values: String

Default: none

WuName

WuName specifies the name of the working unit which is processing the job.

Available values: String

Default: none

Hint - backup

When an error occurs, the WuName parameter will be saved as ErrWuName.

WuThreadNumber

WuThreadNumber specifies the number of the thread where the job is running.

Available values: Integer

Default: none

WuVersion

WuVersion specifies the version of the current working unit.

Available values: String

Default: none

Back to top