SAP Keys¶

The following keys are passed to PLOSSYS Distribution Engine from SAP, either as RLI/DDD job or file parameters. They are grouped by topic.

Hint - notation

Key names are case-insensitive. DPF also ignores underscores in key names. For example, PLS_MAIL_ZIPFILENAME is identical to PLS_MAIL_ZIP_FILENAME, and DIST_FILENAME is identical to DistFileName.

General¶

DIST_CONFIG¶

DIST_CONFIG selects the default configuration for a distribution behavior, for example a preconfigured order distributed by mail with archiving.

Available values:

EMAIL

Distribution via e-mail.
PRINT

Distribution via PLOSSYS Output Engine.
FILEOUT

Distribution to the file system.
WEBPORTAL

Distribution via Web Portal.
SENDBACK

Return to the client that started the job, refer to Configure Sendback. Available as of PLOSSYS Distribution Engine 2.2.0.
a customer-specific value

A project-specific distribution behavior.

Available as of DDD version: 1.1.0

Hint - configuration file

The value of DIST_CONFIG selects the matching <DIST_CONFIG>.ini file (for example email.ini or webportal.ini) under customer/server/dpf/conf/dpf4distribute/.

DIST_TYPE¶

DIST_TYPE determines what happens to a document in the distribution workflow. It can be set on job level (default for all documents without their own value) or on file level. Historically passed from SAP as MAIL_ATTACH_TYPE, before being renamed to DIST_TYPE.

Available values:

NATIVE

The document keeps its native format.
PDF

The document is converted to PDF.
ZIP

The document is archived in a ZIP file.
MERGE

The document is merged with other documents of the job.

Values are combinable across the files of one job.

Available as of DDD version: 1.0.x

Mail¶

PLS_SUBJECT¶

PLS_SUBJECT specifies the e-mail subject. If the parameter is configured in SAP as MAILSUBJECT, SAP DDD maps it to PLS_SUBJECT before passing it on, comparable to PLS_STAMP_n.

Available values: Text

PLS_SENDER¶

PLS_SENDER specifies the e-mail sender. If the parameter is configured in SAP as MAILSENDER, SAP DDD maps it to PLS_SENDER before passing it on, comparable to PLS_STAMP_n.

Available values: E-mail address

PLS_RECEIVER¶

PLS_RECEIVER specifies the e-mail receiver. If the parameter is configured in SAP as MAILRECEIVER, SAP DDD maps it to PLS_RECEIVER before passing it on, comparable to PLS_STAMP_n.

Available values: E-mail address

PLS_RECEIVER_CC¶

PLS_RECEIVER_CC specifies the e-mail receiver CC. If the parameter is configured in SAP as MAIL_RECEIVER_CC, SAP DDD maps it to PLS_RECEIVER_CC before passing it on, comparable to PLS_STAMP_n.

Available values: E-mail address

PLS_RECEIVER_BCC¶

PLS_RECEIVER_BCC specifies the e-mail receiver BCC. If the parameter is configured in SAP as MAIL_RECEIVER_BCC, SAP DDD maps it to PLS_RECEIVER_BCC before passing it on, comparable to PLS_STAMP_n.

Available values: E-mail address

SAP_LTEXT_FORMAT¶

SAP_LTEXT_FORMAT specifies the format of the e-mail body.

Available values:

HTML

The e-mail body is HTML-formatted.
PLAIN

The e-mail body is plain text.

Default: PLAIN, pre-set in dpf4distribute.ini. Applies if SAP does not pass the key. The DDD BC Set usually pre-sets HTML.

The e-mail body text itself is passed from SAP in the MAIL_BODY_LTEXT section, with individual lines as LINE_n parameters. At least 10,000 characters per line are supported.

PLS_MAIL_ZIP¶

PLS_MAIL_ZIP specifies whether all attachments of an e-mail are packed into one ZIP file. The key is optional.

Available values:

Y

The attachments are packed into one ZIP file. If this ZIP file exceeds the maximum attachment size, PLOSSYS Distribution Engine distributes the attachments across several ZIP files and e-mails. The e-mail body then contains a notice that the combined ZIP file is too large.
N

The attachments are attached individually. If they exceed the maximum attachment size, PLOSSYS Distribution Engine distributes them across several e-mails.

Default: N

For the maximum attachment size, refer to Configure E-mail.

Available as of PLOSSYS Distribution Engine 2.2.0.

PLS_MAIL_ZIPFILENAME¶

PLS_MAIL_ZIPFILENAME specifies the file name of the ZIP file for PLS_MAIL_ZIP = Y. The key is optional. If the file name does not end with .zip, PLOSSYS Distribution Engine appends .zip. If the attachments are distributed across several ZIP files, the file name of the second and every further ZIP file gets a part number.

Available values: Text, a file name with or without the .zip extension

Default: attachmentsZip.zip

Available as of PLOSSYS Distribution Engine 2.2.0.

Hint - not related to DIST_ZIP_FILENAME

PLS_MAIL_ZIPFILENAME is independent of DIST_ZIP_FILENAME. DIST_ZIP_FILENAME names the ZIP file for documents with DIST_TYPE = ZIP.

Print¶

seal-dpf-workingunit-print-ipp forwards every job and document parameter with the PLS_ prefix to PLOSSYS Output Engine, with a fixed exclude list (the connection parameters below, plus a handful of mail parameters that do not apply to print). It also always forwards a fixed set of non-PLS_-prefixed parameters, listed further down in this section. Document-level values take precedence over job-level values for the same parameter name.

Queue (PLS_PLOTTER)¶

Queue, read by PLOSSYS Distribution Engine as PLS_PLOTTER, specifies the target printer/queue on PLOSSYS Output Engine. Can be set as a job parameter, or overridden per document. seal-dpf-workingunit-print-ipp reads PLS_PLOTTER as a DPF job parameter, confirmed to also work when passed directly as SAP job data, not only via dpf4distribute.customer.ini on the Distribution Engine server, refer to Connect PLOSSYS Output Engine (Print).

The key is mandatory.

Available values: Printer name from the PLOSSYS Output Engine configuration

PLS_PRINTSERVER¶

PLS_PRINTSERVER specifies the hostname of the PLOSSYS Output Engine IPP checkin. Assumes protocol ipp and port 631. seal-dpf-workingunit-print-ipp reads PLS_PRINTSERVER as a DPF job parameter, confirmed to also work when passed directly as SAP job data, not only via dpf4distribute.customer.ini on the Distribution Engine server, refer to Connect PLOSSYS Output Engine (Print).

The key is optional.

Available values: Hostname

PLS_PRINTSERVER_URL¶

PLS_PRINTSERVER_URL specifies the full URL of the PLOSSYS Output Engine IPP checkin. Overrides PLS_PRINTSERVER if set. seal-dpf-workingunit-print-ipp reads PLS_PRINTSERVER_URL as a DPF job parameter, confirmed to also work when passed directly as SAP job data, not only via dpf4distribute.customer.ini on the Distribution Engine server, refer to Connect PLOSSYS Output Engine (Print).

The key is optional.

Available values: String, for example ipp://host:631

P5JOBTIMEOUT¶

P5JOBTIMEOUT specifies the timeout in milliseconds to wait until the print job completes.

The key is optional.

Available values: Integer, milliseconds

Default: 3600000 (one hour)

OUT_NGN_JOB_POLLING_INTERVAL¶

OUT_NGN_JOB_POLLING_INTERVAL specifies the interval in milliseconds at which seal-dpf-workingunit-print-ipp polls PLOSSYS Output Engine for the print job status.

The key is optional.

Available values: Integer, milliseconds

Default: 2000 (two seconds)

ALIGN / ROTATE / SCALEMODE / SCALEFORMAT / TOLERANCE¶

ALIGN, ROTATE, SCALEMODE, SCALEFORMAT, and TOLERANCE are custom scaling parameters, always forwarded to PLOSSYS Output Engine by seal-dpf-workingunit-print-ipp if set, regardless of the PLS_ prefix rule above.

The keys are optional.

SAPBO_OBJECTKEY / SAPBO_OBJECTTYPE¶

seal-dpf-workingunit-print-ipp also always forwards SAPBO_OBJECTKEY and SAPBO_OBJECTTYPE to PLOSSYS Output Engine, alongside PRINTJOB_NUMBER and PRINTJOB_TYPE. These two are documented in the SAP Archiving section on this page, where they originate.

Web Portal¶

The six WEBPORTAL_COLLECTION_* parameters were added together in DDD 1.5.0, as fields of the /SEAL/DDD_DST_WP_DAT BC Set for the WEBPORTAL output channel (DDD-2408, 2025-02-21).

WEBPORTAL_COLLECTION_DESCRIPTION¶

WEBPORTAL_COLLECTION_DESCRIPTION specifies the description of the share. If the field is configured in SAP as WP_DESCRIPTION, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_DESCRIPTION before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values: Text

Available as of DDD version: 1.5.0

WEBPORTAL_COLLECTION_NAME¶

WEBPORTAL_COLLECTION_NAME specifies the name of the share. If the field is configured in SAP as WP_NAME, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_NAME before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values: Text

Available as of DDD version: 1.5.0

WEBPORTAL_COLLECTION_ACCESS_NOTIFICATION¶

WEBPORTAL_COLLECTION_ACCESS_NOTIFICATION specifies whether to notify on access to the share. If the field is configured in SAP as WP_NOTIFY, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_ACCESS_NOTIFICATION before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values:

true

Notifies on access to the share.
false

Does not notify on access to the share.

Default: false

Available as of DDD version: 1.5.0

WEBPORTAL_COLLECTION_EXPIRATION_DATE¶

WEBPORTAL_COLLECTION_EXPIRATION_DATE specifies the duration until the share expires. Uses the parse-duration format. If the field is configured in SAP as WP_EXP_DATE, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_EXPIRATION_DATE before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values: String, for example 30d

Default: 30d

Available as of DDD version: 1.5.0

WEBPORTAL_COLLECTION_PUBLIC¶

WEBPORTAL_COLLECTION_PUBLIC specifies whether to create a public link, meaning access without authentication. If the field is configured in SAP as WP_PUBLIC, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_PUBLIC before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values:

true

Creates a public link.
false

Does not create a public link.

Default: false

Available as of DDD version: 1.5.0

WEBPORTAL_COLLECTION_SHARED_WITH¶

WEBPORTAL_COLLECTION_SHARED_WITH specifies a comma-separated list of receivers. If the field is configured in SAP as WP_SHAREWITH, BC Set /SEAL/DDD_DST_WP_DAT maps it to WEBPORTAL_COLLECTION_SHARED_WITH before seal-dpf-workingunit-webportal reads it, comparable to PLS_STAMP_n.

Available values: String, for example user1@example.com,user2@example.com

Default: %PLS_RECEIVER%

Available as of DDD version: 1.5.0

WEBPORTAL_MAIL_AGENT¶

WEBPORTAL_MAIL_AGENT controls whether the DPF sends a mail after a Web Portal upload.

Available values:

empty

The DPF does not send a mail after the upload.
DPF

The DPF sends a mail after the upload.

Default: empty

Available as of DDD version: 1.2.x

WEBPORTAL_FILE_N / WEBPORTAL_FILE_LIST¶

WEBPORTAL_FILE_N specifies the physical path of the N-th file to upload to the Web Portal, with N as the file index. WEBPORTAL_FILE_LIST lists the WEBPORTAL_FILE_N parameter names to use, for example WEBPORTAL_FILE_1 WEBPORTAL_FILE_2 WEBPORTAL_FILE_N.

Available values: File path

WEBPORTAL_TARGET_FILE_N / WEBPORTAL_TARGET_FILE_LIST¶

WEBPORTAL_TARGET_FILE_N specifies the logical path of the N-th file inside the Web Portal share, including any folder structure. Its index must match the index of the corresponding WEBPORTAL_FILE_N. A target index without a matching resource index creates an empty folder. Leave the value empty to keep the file in the share root. To place the file in a folder without renaming it, end the value with a trailing slash /. WEBPORTAL_TARGET_FILE_LIST lists the WEBPORTAL_TARGET_FILE_N parameter names to use.

Available values: File path, or folder path ending in /

Caution - not a standard SAP-configured field

WEBPORTAL_TARGET_FILE_N is not a field mapped through a DDD BC-Set. The standard DIST-NGN Web Portal workflow does not set it directly either: WU PrepareWebportalAttachmentList fills the deprecated AttachmentNameN parameter from the RLI column named by DistributeFileNameColumnName (default: DIST_FILENAME), and seal-dpf-workingunit-webportal maps that to WEBPORTAL_TARGET_FILE_N. In practice, a folder structure comes from DIST_FILENAME: a value such as foo/bar/baz.pdf creates the subfolders foo/bar/ automatically. Populating DIST_FILENAME with an order- or document-specific path from SAP is project-specific configuration, for example through SAP Datenermittlung or a UserExit.

WEBPORTAL_FILE_DESC_N / WEBPORTAL_FILE_DESC_LIST¶

WEBPORTAL_FILE_DESC_N specifies a free-text description of the N-th file, used for Web Portal searches. WEBPORTAL_FILE_DESC_LIST lists the WEBPORTAL_FILE_DESC_N parameter names to use.

Available values: Text

Deprecated Web Portal file parameters¶

seal-dpf-workingunit-webportal 1.10.17 replaced the following file parameters. The old parameters still work: if a job sets one and the corresponding new parameter is not also set, the service maps its value to the new parameter automatically.

Deprecated parameter	Replaced by
`AttachmentFileN`	`WEBPORTAL_FILE_N`
`Attachment_FileList`	`WEBPORTAL_FILE_LIST`
`AttachmentNameN`	`WEBPORTAL_TARGET_FILE_N`
`Attachment_NameList`	`WEBPORTAL_TARGET_FILE_LIST`
`AttachmentDescriptionN`	`WEBPORTAL_FILE_DESC_N`
`Attachment_DescriptionList`	`WEBPORTAL_FILE_DESC_LIST`

The standard DIST-NGN Web Portal workflow currently still sets the deprecated names itself, through WU PrepareWebportalAttachmentList.

File Naming and Target¶

DIST_FILENAME¶

DIST_FILENAME specifies the final file name. If DIST_TYPE = MERGE, DIST_MERGE_FILENAME applies instead. Historically passed from SAP as MAILFILENAME, before being renamed to DIST_FILENAME.

If the document is converted to PDF and DIST_FILENAME does not end with .pdf, PLOSSYS Distribution Engine replaces the file extension with .pdf. The directory path and the rest of the file name are kept, for example 100/200/300/my.file.name.tif becomes 100/200/300/my.file.name.pdf.

If DIST_FILENAME is not set, PLOSSYS Distribution Engine uses the file name of the retrieved file. If a missing sheet replaces the document, PLOSSYS Distribution Engine adds the prefix ERROR_ to the file name.

The key is optional.

Available values: File name including extension

DIST_MERGE_FILENAME¶

DIST_MERGE_FILENAME specifies the file name of the merge PDF, for DIST_TYPE = MERGE.

Available values: File name including extension

DIST_ZIP_FILENAME¶

DIST_ZIP_FILENAME specifies the file name of the ZIP file, for DIST_TYPE = ZIP. Historically passed from SAP as MAIL_ZIP_FILENAME, before being renamed to DIST_ZIP_FILENAME.

Available values: File name including extension (.zip)

TARGETDIR¶

TARGETDIR specifies the path for storing documents on the file system for the FILEOUT channel.

Available values: File path

Distribution Result Columns¶

IS_DIST_FILE, DIST_RESULT, and DIST_RESULT_TYPE are RLI columns. PLOSSYS Distribution Engine sets them itself during processing. SAP does not pass them.

IS_DIST_FILE¶

IS_DIST_FILE marks whether PLOSSYS Distribution Engine distributes a file in the current distribution step, refer to DistChannel_n. During Preprocess, PLOSSYS Distribution Engine sets Y on every document whose DIST_TYPE is NATIVE or PDF. A value from the RLI is overwritten. DefaultDistributeFilesFilter in dpf4distribute.ini defines these types. Converting to ZIP or MERGE sets Y on the resulting archive or merge file instead of the source documents. Distributing the result of one channel to the next channel, for example archiving a sent e-mail, sets Y again on that result file.

Available values:

Y

The file is distributed in the current step.
N or empty

The file is not distributed in the current step.

Default: Y for documents with DIST_TYPE NATIVE or PDF

DIST_RESULT¶

DIST_RESULT marks an RLI line as the result of a distribution channel, for example the EML file of a sent e-mail.

Available values:

Y

The line is a channel result.
N or empty

The line is not a channel result.

DIST_RESULT_TYPE¶

DIST_RESULT_TYPE names the type of the channel result marked by DIST_RESULT.

Available values: MAIL

MAIL is the only confirmed value, set for the e-mail channel.

Stamping¶

STP_LAYOUT¶

STP_LAYOUT specifies the name of the stamp layout file. If set on job level, it is inherited by all documents without their own value. Refer to Stamp Documents.

Available values: File name including extension (.stp)

Available as of DDD version: 1.6.0

PLS_STAMP_n¶

PLS_STAMP_n specifies the texts to be stamped according to the stamp layout file. If the parameter is configured in SAP as STAMP_n, SAP DDD maps it to PLS_STAMP_n before passing it on. The SAP DDD BC Set provides STAMP_0 to STAMP_9. PLOSSYS Distribution Engine itself processes every PLS_STAMP_n parameter it receives, regardless of n. If set on job level, it is inherited by all documents without their own value.

Available values: Text

Available as of DDD version: 1.6.0

SAP Archiving¶

DPFL_VARIANT, the SAPAL_*/SAPGO_*/SAPBO_* parameters, and SAP_CREATOR were added together in DDD 1.3.0, as additional parameters of the "DDD - General configuration" BC Set (/seal/ddd, table /dvsrepro/plprok).