Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...

Beschreibung

Der ActionHandler MergePDFDocumentsHandler führt alle PDF-Dokumente, die an eine Prozessinstanz angehängt sind, zu einem Dokument zusammen und entfernt möglicherweise die Originaldokumente.

Enthält ein Original-PDF Formularelemente, werden diese vor dem Zusammenführen deaktiviert und in normale, einfache, nicht editierbare PDFs umgewandelt. Der Inhalt der Formularfelder wird als normaler Text an das finale PDF übergeben.

...

Klasse

Code Block
com.dooris.bpm.actionhandler.MergePDFDocumentHandler

Parameter

This parameter is used to set the name of the newly created merged documents

Parameter name

Default value

Description

Valid examples

mergeDocumentName

Name des Parameters

Standardwert

Beschreibung

Gültige Beispiele

mergeDocumentName

Dieser Parameter wird verwendet, um den Namen der neu erstellten zusammengeführten Dokumente festzulegen.

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.

Info

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 processFALSCH

Dieser Parameter wird verwendet, um zu entscheiden, ob ein vorhandenes Dokument mit dem gleichen Namen wie das generierte Dokument überschrieben werden soll.

Wenn diese Option auf false gesetzt ist, werden alle aktuell angehängten PDF-Dateien zusammengeführt (einschließlich derer, die bereits zusammengeführt wurden). Wenn das bereits zusammengeführte Dokument nicht erneut zusammengeführt werden soll, wird der Parameter excludedDokumente verwendet werden. 

Wenn auf true gesetzt, werden alle aktuell angehängten PDF-Dateien, die noch nicht zusammengeführt wurden, zusammengeführt. Dokumente, die bereits zusammengeführt wurden, werden nicht erneut zusammengeführt.

STIMMT

addTimestampToDescription

FALSCH

Dieser Parameter wird verwendet, um einen Zeitstempel in das Dokument einzufügen. Es wird ein Zeitstempel eingefügt, wenn es auf STIMMT.

STIMMT

sortDocuments

FALSCH

Mit diesem Parameter wird entschieden, ob die Reihenfolge im neuen Beleg durch den Namen der zu bearbeitenden Belege bestimmt wird. Es sortiert die Dokumente nach ihrem Namen, wenn es auf STIMMT.

Wenn es auf FALSCHwerden die Dokumente entsprechend dem Erstellungsdatum beigefügt. Das älteste Dokument kommt ganz am Anfang.

FALSCH

sortChronologisch

STIMMT

Dieser Parameter wird nur berücksichtigt, wenn der Parameter sortDocuments ist auf FALSCH.

Wenn sortChronologisch ist auf STIMMTklicken, werden die ältesten Dokumente ganz am Anfang und die neuesten Dokumente am Ende des Dokuments eingefügt.

Wenn sortChronologisch ist auf FALSCH, ist die Situation umgekehrt und die neuesten Dokumente werden ganz am Anfang und die ältesten Dokumente am Ende des Dokuments eingefügt.

STIMMT

convertOfficeFilesToPdf

FALSCH

Dieser Parameter wird verwendet, um zu entscheiden, ob die angehängten .docx-, .pptx- und .xlsx-Dateien in PDFs konvertiert und in den Zusammenführungsprozess einbezogen werden sollen.

STIMMT

convertTxtFilesToPdf

FALSCH

Dieser Parameter wird verwendet, um zu entscheiden, ob die angehängten .txt Dateien in PDFs konvertiert und in den Zusammenführungsprozess einbezogen werden sollen.

convertCsvFilesToPdf

FALSCH

Dieser Parameter wird verwendet, um zu entscheiden, ob die angehängten .csv Dateien in PDFs konvertiert und in den Zusammenführungsprozess einbezogen werden sollen.

deleteOriginalOfficeFiles

FALSCH

Dieser Parameter wird verwendet, um zu entscheiden, ob die ursprünglichen .docx, .pptx .xlsx Dateien, die für die Zusammenführung verwendet werden, gelöscht werden sollen.

STIMMT

deleteOriginalFiles

null

Dieser Parameter wird verwendet, um zu entscheiden, ob die Originaldateien, die für die Zusammenführung verwendet werden, gelöscht werden sollen.

Info

Dieser Parameter hat bei der Entscheidung eine höhere Priorität als der deleteOriginalOfficeFiles. Wenn deleteOriginalFiles auf null gesetzt ist, wird der Wert der deleteOriginalOfficeFiles angewendet werden.

STIMMT → Originaldokumente werden gelöscht.

FALSCH → Originaldokument wird nicht gelöscht.

null → Wert der deleteOriginalOfficeFiles berücksichtigt werden.

excludedDokumente

null

Dieser Parameter wird verwendet, um eine bestimmte Zeichenfolge festzulegen, um die Dokumente auszuschließen, die diesen Zeichenfolgenwert in ihren Namen enthalten.

Angebot

Alle Dokumente mit "Angebot" im Dateinamen werden vom Zusammenführungsprozess ausgeschlossen