mergePDFFiles Step

Use this step to merges multiple PDF files into 1 PDF file

Last published at: May 29th, 2024

Description:

This step merges multiple PDF files on the application server into one PDF file.

 

Inputs

  • filePathList – File path list
  • outputFilePath – Output file path
  • pdfVirtualPath – PDF Virtual file path
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
  • Error - step execution error 
 

 

Usage:

 

 

Example:

Let’s build and execute the mergePDFFilesDef example.                             

  • Create a new definition called “mergePDFFilesDef”
  • Select the definition and click the “design” button
  • Drag  “updateVariable” and “mergePDFFiles” steps to the canvas
  • Connect the dots between the start and the steps as shown in the above image 
  • Define a few variables/globals to store the file path result after execution

 

  • Click the "updateVariable" step to configure its "Settings" properties. Provide a name to the step. Select the “Advanced” tab. Click on the button to update multiple variables. Click on the AddRow (+) button to insert an empty row. Provide the variable name and the file path on the application server as the variable value. You may add as many individual file path references as you can here. 

 

  • Click the "mergePDFFiles" step to configure its "Settings" properties. Give the step a name. Provide the variable references to hold the Output and Virtual PDF file paths. Click on the button to provide the source file path list. 

 

  • The file path list popup window is displayed for configuration. Click on the AddRow (+) button to insert an empty row. Provide the variable reference with a file path as a value. You may also provide an actual file path, as shown below. Click on the Save button to confirm. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new process instance, and execute. Render the process instance.

 

 

  • Click on the “mergePDFFiles” process step to view the properties. The step should merge multiple PDF files on the application server into one PDF file. Copy and paste the pdfVirtualPath variable value into a browser window to view the merged PDF file.