You can use the PDFReader activity to read data from editable fields of PDF files. This activity uses a PDF file that is specified on the
General tab to create an output schema. The input PDF file on the
Input tab is parsed and read by matching its own schema with the created schema displayed on the
Output tab.
General
The following table describes the fields on the
General tab of the PDFReader activity.
| Field
|
Module Property?
|
Description
|
| Name
|
No
|
(Required) The name of the activity displayed in the process. The default value is
PDFReader.
|
| Input File
|
No
|
(Required) The input PDF template file that is used to generate a template schema on the
Output tab. Type a PDF template file path with its name in your local system in this field or click the
Choose a resource icon to navigate to the PDF template file.
Note: When the input PDF template file is not read because it cannot be decrypted, an error message is displayed in the
Input File Password field. Only if the PDF template file cannot be read because it is encrypted with an empty string, the error message is displayed next to the
Input File field.
|
| Input File Password
|
Yes
|
(Optional) Type a correct password for the input PDF template file if it is encrypted.
Note: If the input PDF template file is not encrypted, leave this field blank.
|
| Use Process Data
|
No
|
(Optional) A check box that is used to allow acceptance of binary data on the
Input tab.
|
Description
On the
Description tab, you can add a short description for the PDFReader activity.
Input
The input of the PDFReader activity depends on the configuration specified on the
General tab. The following table describes the input elements on the
Input tab of the PDFReader activity.
| Input Item
|
Data Type
|
Description
|
| inputPDFFilePath
|
String
|
Type the path and name of the input PDF file to be read in double or single quotation marks, for example,
"D:\PDF\test.pdf".
Note: The PDF file specified on the
General tab and the PDF file specified on the
Input tab must have the same structure. Otherwise, an error message is displayed at run time. You can check the error message in Console view or in the log file.
|
| inputPDFFilePassword
|
String
|
Type a password for the PDF file to be read.
Note: If the PDF file is encrypted, type the correct password. If the PDF file is not encrypted, leave this field blank.
|
| processData
|
Binary
|
Get binary data on the
Input tab when
Use Process Data is selected on the
General tab.
|
Output
The
Output tab contains the
tibPdfRoot item.
The
tibPdfRoot item is created according to the PDF template file, and the schema varies depending on the PDF template file.
Fault
The following table describes the error schema elements on the
Fault tab of the PDFReader activity.
| Error Schema Element
|
Data Type
|
Description
|
| msg
|
String
|
This error message is displayed when the PDF plug-in captures an exception for the PDFReader activity.
|
| msgCode
|
String
|
This error code is displayed when the PDF plug-in captures an exception for the PDFReader activity.
|
Copyright © TIBCO Software Inc. All rights reserved.
