boundaries
Returns a boundaries object encapsulating properties and methods allowing to define the boundaries of each document in the job.
This object is available when triggering document boundaries On script.
Properties
The following table lists the properties of the boundaries object.
| Property | Description |
|---|---|
| currentDelim | A read-only 1-based index (number) of the current delimiter in the file. In other words, the Beginning Of File (BOF) delimiter equals 1. It indicates the position of the current delimiter relative to the last document boundary. |
Methods
The following table describes the functions of the boundaries object. They are available with all file types.
| Method | Description | Script type |
|---|---|---|
| find() | Finds the first occurrence of a string starting from the current position. |
Boundaries Preprocessor, Extract, Condition, Repeat, Action, and Postprocessor steps |
| Retrieves an array of strings. |
Boundaries |
|
| getVariable() | Retrieves a value of a variable stored in the boundaries object. |
Boundaries |
| Sets a new record boundary. (See: Record boundaries.) |
Boundaries |
|
Sets a boundaries variable to the specified value, automatically creating the variable if it doesn't exist yet. |
Boundaries |