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
filename Returns the fully qualified file name of the data file, i.e. the temporary work file being processed.
properties Returns an array of the custom properties defined in the Preprocessor step that have their Scope set to "Entire data". These properties are statically set at the start of the job.
(See Properties and runtime parameters for details.)

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

extractMeta()

Extracts the value of a metadata field.

Extract, Condition, Repeat, and Action steps

All

fieldExists()

Method that returns true if the specified metadata field, column or node exists.

Boundaries

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

findRegExp()

Finds the first match for a regular expression pattern starting from the current position.

Extract, Condition, Repeat, Multiple Conditions and Action steps

Text, PDF