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 defaultReads the
defaultsection, then theJOBINFOsection. -
JOBINFO default RECEIVERReads the
defaultsection, then all receiver sections, then theJOBINFOsection. Values from the receiver sections overwrite values from thedefaultsection. 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:
-
YEnables the Retrieve step.
-
NDisables the Retrieve step.
WantSapCheckoutdoes 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:
-
YEnables SAP check-out.
-
NDisables 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¶
PRINT_COVER creates a cover sheet.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YCreates a cover sheet.
-
NDoes not create a cover sheet.
Default: N
PRINT_MISSING¶
PRINT_MISSING enables missing sheet creation.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YEnables missing sheet creation.
-
NDisables missing sheet creation.
Default: Y
PRINT_TRAILER¶
PRINT_TRAILER creates a trailer sheet.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YCreates a trailer sheet.
-
NDoes 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:
-
YStamps the cover sheet.
-
NDoes 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:
-
YStamps the missing sheet.
-
NDoes 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:
-
YStamps the trailer sheet.
-
NDoes 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:
-
YEnables the cover/trailer/missing sheet workflow.
-
NDisables 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:
-
YEnables the Preprocess step.
-
NDisables 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:
-
YEnables conversion and stamping.
-
NDisables 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:
-
YMerges the documents.
-
NDoes not merge the documents.
Default: Y
WantMergeBookmarks¶
WantMergeBookmarks creates bookmarks while merging documents.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YCreates bookmarks.
-
NDoes 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:
-
YEnables the Process step.
-
NDisables the Process step.
WantConvert,WantMerge, andWantZipdo not run.
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:
-
YArchives the documents.
-
NDoes 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:
-
YContinues the job if PDF Adapt fails for a document.
-
NFails 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:
-
YEnables PDF Adapt.
-
NDisables 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.DistributeMailSends the distributed files by e-mail.
-
dpf4distribute.DistributeFileSystemStores the distributed files on the file system.
-
dpf4distribute.DistributePrintSends the distributed files as an IPP print job to PLOSSYS Output Engine.
-
dpf4distribute.DistributeWebportalUploads the distributed files to SEAL Operator/Web Portal.
-
dpf4distribute.DistributeSendbackReturns the distributed files to the client that started the job. Available as of PLOSSYS Distribution Engine 2.2.0.
-
dpf4distribute.DistributeResultFileSets 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:
-
YEnables the Distribute step.
-
NDisables the Distribute step.
DistChannel_ndoes not run.
Default: Y
Web Portal Connection¶
The following keys configure the connection of seal-dpf-workingunit-webportal to SEAL Operator/Web Portal, refer to Connect SEAL Operator/Web Portal.
WEBPORTAL_AUTH_GRANT_TYPE¶
WEBPORTAL_AUTH_GRANT_TYPE specifies the grant type for requesting the access token for Web Portal. Available as of PLOSSYS Distribution Engine 2.2.0.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values:
-
passwordAuthenticates with the credentials of a Web Portal user. Requires
WEBPORTAL_CLIENT_ID,WEBPORTAL_CLIENT_SECRET,WEBPORTAL_USERNAME, andWEBPORTAL_PASSWORD. -
client_credentialsAuthenticates the client without user credentials. Requires
WEBPORTAL_CLIENT_ID,WEBPORTAL_CLIENT_SECRET, and the user information inWEBPORTAL_X_USER_AUTHorWEBPORTAL_X_USER_AUTH_FILE. The client must have the client credentials flow enabled in the identity provider. Use this grant type if the identity provider rejects thepasswordgrant type, for example an Azure AD or Microsoft Entra ID tenant that enforces multi-factor authentication.
Other values cause an error, and no file is uploaded.
Default: password
WEBPORTAL_CLIENT_ID¶
WEBPORTAL_CLIENT_ID specifies the client ID for requesting the access token. The key is required for both values of WEBPORTAL_AUTH_GRANT_TYPE.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String
Default: none
WEBPORTAL_CLIENT_SECRET¶
WEBPORTAL_CLIENT_SECRET specifies the client secret for requesting the access token. The key is required for both values of WEBPORTAL_AUTH_GRANT_TYPE.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String
Default: none
WEBPORTAL_OPERATOR_URL¶
WEBPORTAL_OPERATOR_URL specifies the URL of the SEAL Operator/Web Portal API. PLOSSYS Distribution Engine sends all Web Portal requests to this URL. It also queries the URL of the authorization server from it. The key is required.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: URL, for example https://<web-portal-api-host>:3008
Default: none
WEBPORTAL_PASSWORD¶
WEBPORTAL_PASSWORD specifies the password of the Web Portal user. The key is required if WEBPORTAL_AUTH_GRANT_TYPE is password. With client_credentials, PLOSSYS Distribution Engine does not use it.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String
Default: none
WEBPORTAL_RESOURCE¶
WEBPORTAL_RESOURCE specifies the resource that PLOSSYS Distribution Engine passes to the identity provider with the token request. The key is optional. It is only used with OIDC authentication, refer to Configure OIDC on Linux or Windows.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String
Default: none
WEBPORTAL_SCOPE¶
WEBPORTAL_SCOPE specifies the scope that PLOSSYS Distribution Engine passes to the identity provider with the token request. The key is optional. It is only used with OIDC authentication, refer to Configure OIDC on Linux or Windows.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String, for example openid
Default: none
WEBPORTAL_TOKEN_ENDPOINT¶
WEBPORTAL_TOKEN_ENDPOINT specifies the URL for requesting the access token. The key is optional. If it is not set, PLOSSYS Distribution Engine uses <authorization server URL>/protocol/openid-connect/token. PLOSSYS Distribution Engine queries the authorization server URL from WEBPORTAL_OPERATOR_URL. Set the key if the identity provider uses a different token endpoint.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: URL
Default: none
WEBPORTAL_UI_URL¶
WEBPORTAL_UI_URL specifies the URL of the Web Portal user interface. PLOSSYS Distribution Engine uses it to build the link to the created share. It returns the link in the job parameter WEBPORTAL_URL. The key is required.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: URL, for example https://<web-portal-host>/
Default: none
WEBPORTAL_USERNAME¶
WEBPORTAL_USERNAME specifies the user name of the Web Portal user. The key is required if WEBPORTAL_AUTH_GRANT_TYPE is password. With client_credentials, PLOSSYS Distribution Engine does not use it.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: String
Default: none
WEBPORTAL_X_USER_AUTH¶
WEBPORTAL_X_USER_AUTH specifies the Web Portal user for whom PLOSSYS Distribution Engine creates the share. It is used together with WEBPORTAL_AUTH_GRANT_TYPE = client_credentials. PLOSSYS Distribution Engine encodes the value in Base64 and sends it in the HTTP header x-user-auth with each Web Portal request. Available as of PLOSSYS Distribution Engine 2.2.0.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
If WEBPORTAL_X_USER_AUTH_FILE is also set, PLOSSYS Distribution Engine uses the file and logs a warning.
Available values: JSON object with the claims of the Web Portal user, for example {"sub":"<user-id>","name":"<name>","preferred_username":"<user-name>"}
Default: none
WEBPORTAL_X_USER_AUTH_FILE¶
WEBPORTAL_X_USER_AUTH_FILE specifies the path to a file with the Web Portal user information. The file contains the same JSON object as WEBPORTAL_X_USER_AUTH. It takes precedence over WEBPORTAL_X_USER_AUTH. If PLOSSYS Distribution Engine cannot read the file, an error occurs, and no file is uploaded. Available as of PLOSSYS Distribution Engine 2.2.0.
Set in webportal.ini, refer to Connect SEAL Operator/Web Portal.
Available values: File path, for example <directory>/xuserauth.json
Default: none
Archiving and Notification¶
WantArchive¶
WantArchive enables the Archive step as a whole.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YEnables the Archive step.
-
NDisables the Archive step.
WantArchiveMaildoes not run.
Default: Y
WantArchiveMail¶
WantArchiveMail archives the sent e-mail via DPF4Loader.
Set in dpf4distribute.ini, override in dpf4distribute.customer.ini.
Available values:
-
YArchives the sent e-mail.
-
NDoes 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:
-
YEnables the Notify step.
-
NDisables the Notify step. The step ends immediately, before
WantNotifySapis 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:
-
YSends the
OMS_STATUSback to SAP. -
NDoes not send the
OMS_STATUSback 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:
-
YWrites the log entry.
-
NDoes 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:
-
YRegisters the job with PLOSSYS.
-
NDoes not register the job with PLOSSYS.
Default: N