pdfOptimizeFile Step

Use this step to reduce the file size of the PDF document through optimization.

Last published at: January 13th, 2026

Description:

This step reduces the file size of the PDF document by optimizing it.

 

Inputs

  • inputFilePath - Input File Path
  • 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 “pdfOptimizeFileDef” example.                             

  • Create a new process definition named “pdfOptimizeFileDef” and open it in Designer mode. 
  • Drag the “pdfOptimizeFile” step to the canvas.
  • Connect the dots between the “Start” step and “pdfOptimizeFile” steps, as shown above.  
  • Define a variable or a global to store the file path result.
  • Click the "pdfOptimizeFile" step to configure its "Required" properties. Provide a name for the step. Provide the source file path on the application server. Select the time zone from the drop-down list. Select the expiration date and time. Provide variable or global references to store the Output and Virtual PDF file paths. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

 

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

 

  • Save the process definition, create a new instance, and execute it. Render the process instance. Click the “pdfOptimizeFile” process step to view its properties. This step optimizes the PDF document to reduce its file size. Copy and paste the “pdfVirtualPath” variable value into a browser window to download the optimized PDF file. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes. 

Click here to download the sample file.