SAP Help Home SAP Intelligent RPA Help Portal SAP Intelligent RPA Community

Table of Contents

Advanced PDF Activities
PDF Core
Document Information Extraction Activities
Enumerations
PDF Filter
Invoice Activities
PDF Utilities

Module - PDF Filter

Collection of functions to manage filters allowing you to work on defined parts of a PDF document.

Activities

Create Custom Filter (PDF)

Restrict the operation of all the PDF activities to a custom defined area of a PDF page, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
customAreaFilter synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageNum number mandatory Provides the page number on which the operation is applied. Only a single page can be specified. For example: "2" to specify the second page.
top number mandatory Provides the distance from the top of the page.
left number mandatory Provides the distance from the left side of the page.
width number mandatory Provides the width of the area.
height number mandatory Provides the height of the area.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page number


Filter Page Upper Half (PDF)

Restrict the operation of all the PDF activities to the upper half area of a PDF page, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
filterUpperHalfOfPage synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageNum number mandatory Provides the page number on which the operation is applied. Only a single page can be specified. For example: "2" to specify the second page.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page number


Filter Page Lower Half (PDF)

Restrict the operation of all the PDF activities to the lower half area of a PDF page, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
filterLowerHalfOfPage synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageNum number mandatory Provides the page number on which the operation is applied. Only a single page can be specified. For example: "2" to specify the second page.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page number


Filter Page Left Side (PDF)

Restrict the operation of all the PDF activities to the left side of a PDF page, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
filterLeftSideOfPage synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageNum number mandatory Provides the page number on which the operation is applied. Only a single page can be specified. For example: "2" to specify the second page.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page number


Filter Page Right Side (PDF)

Restrict the operation of all the PDF activities to the right side of a PDF page, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
filterRightSideOfPage synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageNum number mandatory Provides the page number on which the operation is applied. Only a single page can be specified. For example: "2" to specify the second page.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page number


Filter Pages (PDF)

Restrict the operation of all the PDF activities to a specified page range, until the Clear Filter activity is applied.


Technical Name Type Minimal Agent Version
filterPages synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
pageRange string mandatory Mandatory parameter to provide the page number or page range on which the operation is applied. For example: Single page: "2" for the second page. Multiple pages: "1,3-7,10".

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid page range


Clear Filter (PDF)

Clear all applied filters.


Technical Name Type Minimal Agent Version
clearFilter synchronous WIN-3.24, MAC-3.24, CLOUD-3.34