pdf_adaptor
Differences
This shows you the differences between two versions of the page.
|
pdf_adaptor [2022/03/21 13:03] montse |
pdf_adaptor [2024/12/10 13:03] (current) montse [Predefined Functions] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== PDF Adaptor ====== | ====== PDF Adaptor ====== | ||
| =====Introduction ===== | =====Introduction ===== | ||
| - | PDF adaptor allow you to interact with a .pdf file, so that you can check if it has been generated properly and contains the information it is supossed to. It will be useful for you to test all those procesess where the generation of a .pdf file is implied. | + | PDF adaptor allow you to interact with a .pdf file, so that you can check if it has been generated properly and contains the information it is supposed to. It will be useful for you to test all those processes where the generation of a .pdf file is implied. |
| ===== Initialization Parameters ===== | ===== Initialization Parameters ===== | ||
| Line 7: | Line 7: | ||
| * **FilePath:** complete path of the file | * **FilePath:** complete path of the file | ||
| - | ===== Predefined Functions (PF): ===== | + | ===== Predefined functions ===== |
| - | * **checkTextInSlide(Page, Occurrences, Search Text, ExactSearch)**: Looks for a given text on a specific Page of the document. Checks if it is present the number of times expressed in "Occurences" and returns "true" or "false" accordingly. "Exact Search" allows you to tell the function if you are looking for an exact match or if the number of spaces between each part of the Search String is variable.\\ \\ **IMPORTANT**: Please be aware of the "Occurrences" behaviour: | + | * **checkTextOnDocument(Page Area, Search Text)**: looks for a given text on a specific area of the document (whole Page, Header, Body, Footer). This function looks for an exact match of the search text. |
| - | - When Occurrences is "empty", it will check that the string exists, no matter the number of times. | + | |
| - | - When Occurrences is different to "0", it will check that the Search String exists the indicated number of times. | + | |
| - | - When Occurrences is "0", it will check that the Search String does not exist, returning "true" if so, "false" if it is found any number of times. | + | |
| - | * **checkTextOnDocument(Page Area, Search Text)**: Looks for a given text on a specific area of the document (whole Page, Header, Body, Footer). This function looks for an exact match of the search text. | + | * **checkTextOnPage**: returns true, if it finds the text specified by the Search Text parameter, in the area indicated by the PageArea parameter, on the page represented by the Page parameter, the number of times entered in Ocurrences, false otherwise. |
| - | * **checkTextOnPageArea(Page, CoordinateX, CoordinateY, Width, Height, Text):** This function return true if the parameter text exists inside the page area defined by the parameters. Page parameter indicates the page number to transform. Coordinate X parameter, indicates the position x where the area starts. Coordinate Y parameter, indicates the position y where the area starts. Width and height parameters indicates the area and the text parameter, it’s the text to check on the defined area. The measure unit is 72 dpi. | + | * **checkTextOnPageArea(Page, CoordinateX, CoordinateY, Width, Height, Text):** this function return true if the parameter text exists inside the page area defined by the parameters. Page parameter indicates the page number to transform. Coordinate X parameter, indicates the position x where the area starts. Coordinate Y parameter, indicates the position y where the area starts. Width and height parameters indicates the area and the text parameter, it’s the text to check on the defined area. The measure unit is 72 dpi. |
| - | * **getNumPages()**: Returns the number of pages in the document. | + | * **generateFileAsEvidence**: the function generates a copy of the PDF file in its current state to be added as evidence. |
| - | * **getNumWhitePages()**: Returns the number of white pages in the document. | + | * **getCustomMetaData**: returns the value of the custom metadata specified in its input parameter. Custom metadata is different from the automatic metadata that is manually included in documents. The metadata name is case sensitive. |
| - | * **getPageAsImage(Page,File):** This function transform a PDF Page into a jpg image file with a resolution of 72 dpi. About the input parameters, the Page parameter indicates the page number to transform, The File parameter indicates the path and the file name where the image will be generated. The file extension is .jpg.\\ The purpose of this image is to allow the user to load it into any application that helps him to identify the coordinates where a piece of text appears.\\ Besides that, if Get Evidences is checked, the function generates the image file in the log directory as the step evidence. | + | * **getDataSigned**: gets the signature data of the document in case it is digitally signed. Returns in output a variable TastTableData. The data is returned in one row and N columns. |
| - | * **getPageText:** Reads the text contained in a page in a PDF, it generates a file as evidence with the text read by the function. | + | * **getMetaData**: returns the value of the metadata selected in the dropdown of the input parameter. These are the automatic metadata such as: title, author, subject, keyWords, creator, producer, pageCount, creationDate, modificationDate, traped. |
| - | * **getTextByPageArea(Page, CoordinateX, CoordinateY, Width, Height):** This function extract and return the text that its contained inside the page area defined by the parameters. Page parameter indicates the page number to transform. Coordinate X parameter, indicates the position x where the area starts. Coordinate Y parameter, indicates the position y where the area starts. Width and height parameters indicates the area. The measure unit is 72 dpi. | + | * **getNumPages()**: returns the number of pages in the document. |
| + | |||
| + | * **getNumRows**: | ||
| + | |||
| + | * **getNumWhitePages()**: returns the number of white pages in the document. | ||
| + | |||
| + | * **getPageAsImage(Page,File):** this function transform a PDF Page into a jpg image file with a resolution of 72 dpi. About the input parameters, the Page parameter indicates the page number to transform, The File parameter indicates the path and the file name where the image will be generated. The file extension is .jpg.\\ The purpose of this image is to allow the user to load it into any application that helps him to identify the coordinates where a piece of text appears.\\ Besides that, if Get Evidences is checked, the function generates the image file in the log directory as the step evidence. | ||
| + | |||
| + | * **getPageText:** allows you to retrieve the text contained in a page of a PDF, and the function generates as evidence a file with the retrieved text. | ||
| + | |||
| + | * **getTextCountOnDocument(Search Text)**: counts the number of times the Search Text is present on the document. | ||
| + | |||
| + | * **getTextCountOnPage(Page, Search Text, Page Area)**: counts the number of times the Search Text is present on a specific area (Page, Header, Body, Footer) of a given page. The function looks for exact matches of the given Search Text. | ||
| + | |||
| + | * **getTextPageByArea(Page, CoordinateX, CoordinateY, Width, Height):** this function extract and return the text that its contained inside the page area defined by the parameters. Page parameter indicates the page number to transform. Coordinate X parameter, indicates the position x where the area starts. Coordinate Y parameter, indicates the position y where the area starts. Width and height parameters indicates the area. The measure unit is 72 dpi. | ||
| + | |||
| + | * **isPageWhite(Page)**: returns “true” if the specified page is white, “false” otherwise. | ||
| + | |||
| + | * **isSigned**: returns in its boolean output variable, **true** or **false**, depending on whether the document is digitally signed or not. | ||
| + | |||
| + | * **readPdfFile**: reads a PDF file and loads it for processing. | ||
| - | * **getTextCountOnPage(Page, Search Text, Page Area)**: Counts the number of times the Search Text is present on a specific area (Page, Header, Body, Footer) of a given page. The function looks for exact matches of the given Search Text. | ||
| - | * **getTextCountOnDocument(Search Text)**: Counts the number of times the Search Text is present on the document. | ||
| - | * **isPageWhite(Page)**: Returns “true” if the specified page is white, “false” otherwise. | ||
pdf_adaptor.1647867803.txt.gz · Last modified: 2022/03/21 13:03 by montse
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
