data
Returns a data object encapsulating properties and methods pertaining to the original data stream.
Properties
The following table lists the properties of the data object.
| Property | Description | Return type |
|---|---|---|
| filename |
The path of the input file. |
Returns the fully qualified file name of the temporary work file being processed. |
| properties |
Contains properties declared in the preprocessor step (see Preprocessor Step Properties for details). |
Returns an array of properties defined in the Preprocessor step with the data scope (i.e. statically set at the start of the job). |
Methods
The following table lists the methods of the data object.
| Method | Description | Script type | File type |
|---|---|---|---|
| extract() |
Extracts the text value from a rectangular region. |
Extract, Condition, Repeat, and Action steps |
All |
|
Extracts the value of a metadata field. |
Extract, Condition, Repeat, and Action steps |
All |
|
|
Method that returns true if the specified metadata field, column or node exists. |
Preprocessor, Extract, Condition, Repeat, Action, and Postprocessor steps |
All |
|
| find() |
Finds the first occurrence of a string starting from the current position. |
Boundaries Preprocessor, Extract, Condition, Repeat, Action, and Postprocessor steps |
All |
|
Finds the first match for a regular expression pattern starting from the current position. |
Extract, Condition, Repeat, Multiple Conditions and Action steps |
Text, PDF |