Configure Document Processing¶
PLOSSYS Distribution Engine converts, archives, or merges each document before distribution, based on DIST_TYPE. DIST_TYPE determines what happens to a document. The Want* keys enable or disable each processing step globally. Within an active step, DIST_TYPE then filters which individual documents get processed.
This use case covers the standard document processing scenarios.
Convert a Document to PDF¶
This converts a document to PDF before distribution.
Requirements:
WantProcess= YWantConvert= Y
Hint - defaults
WantProcess and WantConvert default to Y, so a job only needs to set them if a project-specific configuration disabled one.
Steps:
-
Set
DIST_TYPE= PDFon the document, or on the job to convert every document without its own value. -
Optionally set
DIST_FILENAMEto name the converted PDF. IfDIST_FILENAMEdoes not end with.pdf, PLOSSYS Distribution Engine replaces the file extension with.pdfand keeps the directory path.
Result: PLOSSYS Distribution Engine converts the document to PDF, on the same RLI line. IS_DIST_FILE = Y applies, since DIST_TYPE is PDF.
Archive Documents in a ZIP File¶
This archives one or more documents of a job in one ZIP file before distribution.
Requirements:
WantProcess= YWantZip= Y
Hint - defaults
WantProcess and WantZip default to Y, so a job only needs to set them if a project-specific configuration disabled one.
Steps:
-
Set
DIST_TYPE= ZIPon the documents to archive. -
Set
DIST_ZIP_FILENAMEon job level, to name the ZIP file. -
Optionally set
DIST_FILENAMEper document, to name the file inside the ZIP file.
Result: PLOSSYS Distribution Engine creates the ZIP file and appends it to the RLI as a new line, with IS_DIST_FILE = Y. The original documents stay in the RLI but are not distributed separately, since they do not receive IS_DIST_FILE = Y.
Merge Documents into One PDF¶
This merges multiple documents of a job into one PDF before distribution.
Requirements:
WantProcess= YWantMerge= YWantConvert= Y, only if a document to merge is not already a PDF
Hint - defaults
WantProcess, WantMerge, and WantConvert default to Y, so a job only needs to set them if a project-specific configuration disabled one.
Steps:
-
Set
DIST_TYPE= MERGEon the documents to merge. -
Set
DIST_MERGE_FILENAMEon job level, to name the merged PDF. Use a unique name if the job produces more than one merge result.
Result: PLOSSYS Distribution Engine creates the merged PDF and appends it to the RLI as a new line, with IS_DIST_FILE = Y. The original documents stay in the RLI but are not distributed separately, since they do not receive IS_DIST_FILE = Y.
Distribute a Document Unchanged¶
This distributes a document unchanged, without conversion, merging, or zipping.
Requirements: none. NATIVE documents skip conversion, merging, and zipping, regardless of WantProcess, WantConvert, WantMerge, and WantZip.
Steps:
-
Set
DIST_TYPE= NATIVEon the document. -
Optionally set
DIST_FILENAMEto rename the file.
Result: PLOSSYS Distribution Engine distributes the document as is, on the same RLI line. IS_DIST_FILE = Y applies, since DIST_TYPE is NATIVE.
Validate¶
-
Trigger a test job in SAP with one document for each scenario.
-
Check that PLOSSYS Distribution Engine produces the expected converted, zipped, merged, or unchanged file per document.
-
Check that only the expected files reach the distribution channel, refer to
IS_DIST_FILE.