PDF Optimize File

This feature optimizes a PDF file

Last published at: February 25th, 2025

pdfOptimizeFile Step

Description:

This step reduces the file size of the PDF document through optimization.

 

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 called “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 timezone from the drop-down list. Select the expiration date and time. Provide the variable or global references to hold the Output and Virtual PDF file paths. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

  • 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 then execute it. Render the process instance. Click the “pdfOptimizeFile” process step to view the properties. This step reduces the file size of the PDF document through optimization. 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 import. Then, save the definition to confirm the changes. 

Click here to download the sample file.