pdfAddTableOfContents Step

Use this step to add a table of contents to a PDF document

Last published at: May 17th, 2024


This step creates a copy of the PDF document by including a table of contents. 



  • inputFilePath - Input File Path
  • afterPageNo – After Page Number
  • 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 pdfAddTableOfContents example.                             

  • Create a new definition called “pdfAddTableOfContentsDef.”
  • Select the definition and click the “design” button
  • Drag  “pdfAddTableOfContents” 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 "pdfAddTableOfContents" step to configure its "Settings" properties. Give the step a name. Provide the source file path on the application server. Provide the page number to insert the table of contents. 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 “pdfAddTableOfContents” process step to view the properties. The step makes a copy of the PDF with a table of contents inserted per the configuration. Copy and paste the pdfVirtualPath variable value into a browser window to view the PDF file.