MergePDFDocumentsHandler

Description

The ActionHandler MergePDFDocumentsHandler merges all PDF documents attached to a process instance into one document and may remove the original documents.

If an original PDF contains form elements, they are deactivated before the merging process and converted to normal, plain, non-editable PDFs. The content of the form fields are passed to the final PDF as normal text.

Class

com.dooris.bpm.actionhandler.MergePDFDocumentHandler

Parameter

Parameter name	Default value	Description	Valid examples
`mergeDocumentName`		This parameter is used to set the name of the newly created merged documents.	`testReport`
`overwriteExisting`	`false`	This parameter is used to decide if an existing document with the same name as the generated document should be overwritten. If set to false, all currently-attached PDF files will be merged (including those that have already been merged). If the document that has already been merged should not be merged again, the parameter `excludedDocuments` can be used. If set to true, all currently-attached PDF files that have not already been merged will be merged. Documents that have already been merged will not be merged again.	`true`
`addTimestampToDescription`	`false`	This parameter is used to insert a time stamp to the document. It will insert a timestamp if it is set to `true`.	`true`
`sortDocuments`	`false`	This parameter is used to decide if the order in the new document be determined by the name of the documents to be processed. It will sort the documents by their name if it is set to `true`. If it is set to `false`, the documents will be attached in accordance with the date of creation. The oldest document will come at the very beginning.	`false`
`sortChronological`	`true`	This parameter is only considered if the parameter `sortDocuments` is set to `false`. If `sortChronological` is set to `true`, the oldest documents will be inserted at the very beginning and the newest documents will be inserted at the end of the document. If `sortChronological` is set to `false`, the situation is reversed and the newest documents will be inserted at the very beginning and the oldest documents will be inserted at the end of the document.	`true`
`convertOfficeFilesToPdf`	`false`	This parameter is used to decide if the attached .docx, .pptx and .xlsx files should be converted to PDFs, and be included in the merging process.	`true`
`convertTxtFilesToPdf`	`false`	This parameter is used to decide if the attached .txt files should be converted to PDFs, and be included in the merging process.
`convertCsvFilesToPdf`	`false`	This parameter is used to decide if the attached .csv files should be converted to PDFs, and be included in the merging process.
`deleteOriginalOfficeFiles`	`false`	This parameter is used to decide if the original .docx, .pptx, .xlsx files that are used for the merge should be deleted.	`true`
`deleteOriginalFiles`	`null`	This parameter is used to decide if the original files that are used for the merge should be deleted. This parameter has higher priority in decision over the `deleteOriginalOfficeFiles`. If `deleteOriginalFiles` is set to null, the value of the `deleteOriginalOfficeFiles` will be applied.	`true` → Original documents will be deleted. `false` → Original document won’t be deleted. `null` → Value of the `deleteOriginalOfficeFiles` will be considered.
`excludedDocuments`	`null`	This parameter is used to set a specific string to exclude the documents which contain this string value in their names.	`Offer` All documents with "Offer" in the file name are excluded from the merging process