pdfOptimizeFile Step

Use this step to optimize the PDF document and reduce the file size

Last published at: May 17th, 2024


This step reduces the PDF document file size by optimization.



  • inputFilePath - Input File Path
  • outputFilePath – Output file path
  • pdfVirtualPath – PDF Virtual file path



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






Let’s build and execute the pdfOptimizeFile example.                             

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


  • Click the "pdfOptimizeFile" step to configure its "Settings" properties. Give the step a name. Provide the source file path on the application server. Select the timezone from the drop-down list. Select the expiration date and time. Provide the variable references to hold the Output and Virtual PDF file paths. Click 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 instance, and execute. Render the process instance. Click on the “pdfOptimizeFile” process step to view the properties. This step reduces the PDF document file size by optimization. Copy and paste the pdfVirtualPath variable value into a browser window to download the optimized PDF file.