pdfAddTableOfContents Step
Description:
This step creates a PDF copy that includes a table of contents.
Inputs
- inputFilePath - Input File Path
- afterPageNo – After Page Number
- 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 “pdfAddTableOfContentsDef” example.
- Create a new process definition named “pdfAddTableOfContentsDef” and open it in designer mode.
- Drag “pdfAddTableOfContents” step to the canvas.
- Connect the dots between the “Start” step and “pdfAddTableOfContents” steps, as shown above.
- Define a variable or a global to store the file path result.
- Click the "pdfAddTableOfContents" step to configure its "Required" properties. Provide a name for the step. Provide the source file path on the application server. Specify the page number where you want to insert the table of contents. Provide variable references to store 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” 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 the “Logging” using the following properties.
- Save the process definition, create a new instance, and execute it. Render the process instance. Click the “pdfAddTableOfContents” process step to view its properties. The step creates a copy of the PDF with a table of contents inserted, as configured. Copy and paste the “pdfVirtualPath” variable value into a browser window to view the PDF.
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.