> For the complete documentation index, see [llms.txt](https://docs.qatts.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qatts.com/automation/objects/smarty/pdf-utils.md).

# PDF Utils

<table><thead><tr><th width="228">Property Name</th><th width="236.33333333333331">Property Value</th><th>Description</th></tr></thead><tbody><tr><td>StartPage</td><td>1</td><td>The starting page number for comparison/Extraction</td></tr><tr><td>EndPage</td><td>-1</td><td>The ending page number for comparison/Extraction</td></tr><tr><td>PDFAction</td><td>--</td><td>The action to be performed on the PDF files. Available options: "compare", "ExtractText"</td></tr><tr><td>File1</td><td>Value can be provide either in expressions (td:fileName, ud:fileName) or absolute path</td><td>The path or location of the first PDF file for comparison / extraction</td></tr><tr><td>File2</td><td>Value can be provide either in expressions (td:fileName, ud:fileName) or absolute path</td><td>The path or location of the second PDF file for comparison / extraction</td></tr><tr><td>TrimWhiteSpaces</td><td>Default : false</td><td>Flag to indicate whether to trim white spaces in the PDF files</td></tr><tr><td>HighlightDifference</td><td>Default : false</td><td>Flag to indicate whether to highlight differences in the PDF files</td></tr><tr><td>DifferenceImageColor</td><td>Default : MAGENTA</td><td>The color code (e.g., #FF0000) for highlighting differences in the PDF files</td></tr><tr><td>CompareAllPages</td><td>Default : false</td><td>Flag to indicate whether to compare all pages of the PDF files</td></tr><tr><td><strong>CompareType</strong></td><td>--</td><td>The type of comparison. Available options: "visual", "text"</td></tr><tr><td>ExcludeRegexPattern</td><td>--</td><td>Regular expression pattern to exclude specific text during comparison</td></tr><tr><td>fileName</td><td>Value can be provide either in expressions (td:fileName, ud:fileName) or absolute path</td><td>The path or location of the file <br>Note : Only when PDF Action is "ExtractText"</td></tr><tr><td>ExtractionOperation</td><td>Refer to : <a href="/pages/Jpfzozehpw9I1pIJKB0J">Extraction Rules</a></td><td>Given extraction operation will be applied to the extracted text<br><br>Note : Only when PDF action is "ExtractText"</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.qatts.com/automation/objects/smarty/pdf-utils.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.