Skip to content

Workflow Keys

The following keys control the PLOSSYS Distribution Engine distribution workflow (dpf4distribute.main).

Caution - standard workflow only

This page lists only the keys of the standard dpf4distribute.main workflow. A project-specific custom workflow can define additional keys, not listed here.

Hint - notation

Key names are case-insensitive. DPF also ignores underscores in key names. For example, PRINT_MISSING is identical to PRINTMISSING, and CurrDistChannelValue is identical to CURR_DIST_CHANNEL_VALUE.

Initialize

RliSectionNames

PLOSSYS Distribution Engine reads the parameters of the RLI sections in the order specified in RliSectionNames. Values from a later section overwrite values from an earlier section. Empty values do not overwrite. The JOBINFO section is always read last, independent of its position in the list.

RECEIVER is a keyword. It reads all receiver sections listed in the [RECEIVER] section of the RLI, except default.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String, space-separated RLI section names, for example:

  • JOBINFO default

    Reads the default section, then the JOBINFO section.

  • JOBINFO default RECEIVER

    Reads the default section, then all receiver sections, then the JOBINFO section. Values from the receiver sections overwrite values from the default section. Use this value in the following cases:

    • Multiple receivers, refer to Configure Multiple Receivers.
    • An existing SAP configuration writes parameters into the receiver section instead of the job, for example receiver and sender. As an alternative, change the user exit for receiver determination in SAP, so that it writes the parameters to the job. In new installations, the BC Set already sets the user exit this way.

Default: JOBINFO default

Retrieve

WantRetrieve

WantRetrieve enables the Retrieve step as a whole.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the Retrieve step.

  • N

    Disables the Retrieve step. WantSapCheckout does not run.

Default: Y

WantSapCheckout

WantSapCheckout enables SAP check-out during the Retrieve step.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables SAP check-out.

  • N

    Disables SAP check-out.

Default: Y

Cover, Trailer and Missing Sheets

Refer to Configure Cover, Trailer, and Missing Sheets.

COVER_CONFIG

COVER_CONFIG specifies the basename of the cover sheet configuration file.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: cover_default

CoverConfigFile

CoverConfigFile specifies the full path to the cover sheet configuration file. %SAPLANGU_ISO% resolves to the SAP login language of the user who triggered the job, so the sheet language follows the user's SAP session language.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: %DPFSRV%/conf/dpf4distribute/%COVER_CONFIG%_%SAPLANGU_ISO%.ini

MISSING_CONFIG

MISSING_CONFIG specifies the basename of the missing sheet configuration file.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: missing_default

MissingConfigFile

MissingConfigFile specifies the full path to the missing sheet configuration file. %SAPLANGU_ISO% resolves to the SAP login language of the user who triggered the job, so the sheet language follows the user's SAP session language.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: %DPFSRV%/conf/dpf4distribute/%MISSING_CONFIG%_%SAPLANGU_ISO%.ini

PRINT_COVER creates a cover sheet.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Creates a cover sheet.

  • N

    Does not create a cover sheet.

Default: N

PRINT_MISSING enables missing sheet creation.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables missing sheet creation.

  • N

    Disables missing sheet creation.

Default: Y

PRINT_TRAILER creates a trailer sheet.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Creates a trailer sheet.

  • N

    Does not create a trailer sheet.

Default: N

StampCover

StampCover activates document stamping for the cover sheet.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Stamps the cover sheet.

  • N

    Does not stamp the cover sheet.

Default: N

StampMissing

StampMissing activates document stamping for the missing sheet.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Stamps the missing sheet.

  • N

    Does not stamp the missing sheet.

Default: N

StampTrailer

StampTrailer activates document stamping for the trailer sheet.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Stamps the trailer sheet.

  • N

    Does not stamp the trailer sheet.

Default: N

TEXT_STATUS_FAILED

TEXT_STATUS_FAILED sets the status text a missing sheet shows when the CreateErrSheet RLI column is set to any value other than missing, unless ErrReason is already set.

Set in the missing sheet configuration file, missing_default_<language>.ini.

Available values: String

Default: Error!

TEXT_STATUS_MISSING

TEXT_STATUS_MISSING sets the status text a missing sheet shows when the CreateErrSheet RLI column is missing.

Set in the missing sheet configuration file, missing_default_<language>.ini.

Available values: String

Default: Doc. missing!

TRAILER_CONFIG

TRAILER_CONFIG specifies the basename of the trailer sheet configuration file.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: trailer_default

TrailerConfigFile

TrailerConfigFile specifies the full path to the trailer sheet configuration file. %SAPLANGU_ISO% resolves to the SAP login language of the user who triggered the job, so the sheet language follows the user's SAP session language.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: %DPFSRV%/conf/dpf4distribute/%TRAILER_CONFIG%_%SAPLANGU_ISO%.ini

WantCreateSheets

WantCreateSheets enables the cover/trailer/missing sheet workflow at all.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the cover/trailer/missing sheet workflow.

  • N

    Disables the cover/trailer/missing sheet workflow.

Default: Y

Preprocess

WantPreprocess

WantPreprocess enables the Preprocess step as a whole. This step sets the RLI distribution defaults, for example DIST_TYPE and the distribute file name, and prepares the stamp settings for the Process step.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the Preprocess step.

  • N

    Disables the Preprocess step.

Default: Y

Conversion and Merging

WantConvert

WantConvert enables conversion and stamping for every document with DIST_TYPE = PDF or MERGE, using DPF4Convert.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables conversion and stamping.

  • N

    Disables conversion and stamping.

Default: Y

WantMerge

WantMerge merges all documents with DIST_TYPE = MERGE into one document.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Merges the documents.

  • N

    Does not merge the documents.

Default: Y

WantMergeBookmarks

WantMergeBookmarks creates bookmarks while merging documents.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Creates bookmarks.

  • N

    Does not create bookmarks.

Default: N

WantProcess

WantProcess enables the Process step, meaning conversion, merging, and zipping, as a whole.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

Default: Y

WantZip

WantZip archives all documents with DIST_TYPE = ZIP in one ZIP file.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Archives the documents.

  • N

    Does not archive the documents.

Default: Y

PDF Adapt

Refer to Configure PDF Adapt. Available as of PLOSSYS Distribution Engine 2.2.0.

DESTINATION_FORMAT_QUALITY

DESTINATION_FORMAT_QUALITY specifies the PDF/A version to create.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String

Default: pdfa2b

DistributeTypePdfAdaptFilter

DistributeTypePdfAdaptFilter lists the DIST_TYPE values excluded from PDF Adapt.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String, one or more DIST_TYPE values separated by |

Default: NATIVE|ZIP

PdfaIgnoreErrors

PdfaIgnoreErrors continues the job if PDF Adapt fails for a document.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Continues the job if PDF Adapt fails for a document.

  • N

    Fails the job if PDF Adapt fails for a document.

Default: N

WantPdfa

WantPdfa enables PDF Adapt to convert documents to PDF/A.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables PDF Adapt.

  • N

    Disables PDF Adapt.

Default: N

Distribute

CurrDistChannelValue

CurrDistChannelValue holds the workflow module name of the distribution channel currently running, resolved from DistChannel_n at the current DistChannelIndex. PLOSSYS Distribution Engine sets it before each channel's user exit runs.

The key is set automatically, not configured by SAP or a project.

Caution - name differs from the general Prozessdruck documentation

Internal SEAL documentation for the general Prozessdruck framework names this parameter CurrDistChannel. The current PLOSSYS Distribution Engine source code confirms CurrDistChannelValue as the actual name.

Available values: One of the values listed under DistChannel_n

DistChannel_n

DistChannel_n, with n starting at 1 and counting up without gaps, selects the workflow module executed for the n-th distribution channel during the Distribute step. Multiple channels can be chained for one job, for example to send e-mail and upload to Web Portal for the same order.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini. At least DistChannel_1 is required to distribute anything.

Available values:

  • dpf4distribute.DistributeMail

    Sends the distributed files by e-mail.

  • dpf4distribute.DistributeFileSystem

    Stores the distributed files on the file system.

  • dpf4distribute.DistributePrint

    Sends the distributed files as an IPP print job to PLOSSYS Output Engine.

  • dpf4distribute.DistributeWebportal

    Uploads the distributed files to SEAL Operator/Web Portal.

  • dpf4distribute.DistributeSendback

    Returns the distributed files to the client that started the job. Available as of PLOSSYS Distribution Engine 2.2.0.

  • dpf4distribute.DistributeResultFile

    Sets the result file of the previous channel as the distribute file for the next channel, for example to archive a sent e-mail.

Default: none

DistChannelIndex

DistChannelIndex counts the distribution channel currently running, during the Distribute step. PLOSSYS Distribution Engine starts it at 1 and increases it by 1 after each channel, until DistChannel_n has no configured value left for the next index.

The key is set automatically, not configured by SAP or a project.

Available values: Integer, starting at 1

Default: 1

WantDistribute

WantDistribute enables the Distribute step as a whole, meaning sending the job through the configured distribution channels.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the Distribute step.

  • N

    Disables the Distribute step. DistChannel_n does not run.

Default: Y

Archiving and Notification

WantArchive

WantArchive enables the Archive step as a whole.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the Archive step.

  • N

    Disables the Archive step. WantArchiveMail does not run.

Default: Y

WantArchiveMail

WantArchiveMail archives the sent e-mail via DPF4Loader.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Archives the sent e-mail.

  • N

    Does not archive the sent e-mail.

Default: N

WantNotify

WantNotify enables the Notify step as a whole.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Enables the Notify step.

  • N

    Disables the Notify step. The step ends immediately, before WantNotifySap is evaluated.

Default: Y

WantNotifySap

WantNotifySap sends the DDD OMS_STATUS back to SAP. It only runs when WantNotify enables the Notify step. SAP_COMM_TECHNOLOGY selects whether the reply uses RFC or OData.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Sends the OMS_STATUS back to SAP.

  • N

    Does not send the OMS_STATUS back to SAP.

Default: Y

Miscellaneous

ElkLogParams

ElkLogParams lists the job-level parameters WantElkLog writes to the ELK log entry, separated by spaces.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values: String, space-separated job-level parameter names

Default: DPFTRACKER_URL_JOB, PRINTJOB_NUMBER, PRINTJOB_TYPE, SAPBO_OBJECTKEY, PLS_USERNAME, PLS_PLOTTER

WantElkLog

WantElkLog writes a job tracking log entry to ELK, via the dpf4distribute.WriteElkLog working unit. PLOSSYS Distribution Engine writes this entry after the Retrieve, Preprocess, Process, Distribute, Notify, Archive, and error handling steps. ElkLogParams lists the job-level parameters the entry contains.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Writes the log entry.

  • N

    Does not write the log entry.

Default: Y

WantRegisterPlossysJob

WantRegisterPlossysJob registers the job with legacy PLOSSYS job tracking. During Initialize processing, it registers the job via the dpf4distribute.iscli working unit's REGISTER action. During Notify and error handling, it additionally sets the legacy PLOSSYS status parameters.

Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.

Available values:

  • Y

    Registers the job with PLOSSYS.

  • N

    Does not register the job with PLOSSYS.

Default: N

Back to top