When writing Advanced Script Rules, you have access to a set of JavaScript objects representing the document, its fields, the execution context, image regions, and Vantage’s data catalogs. The Vantage JavaScript interpreter supports ECMAScript 5.1 and selected later features. For more information, see the ECMAScript repository.Documentation Index
Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
Use this file to discover all available pages before exploring further.
Data access
Scripts can define custom functions and access Vantage data catalogs through theContext object.
Scripts cannot:
- Send requests to databases other than Vantage data catalogs.
- Send requests to external services.
- Use third-party libraries such as jQuery.
Object reference
Use these objects when writing Advanced Script Rules.Execution context
| Object | Description |
|---|---|
| Context | Access the document, fields, catalog records, and skill parameters from inside a rule. |
| Parameter | A parameter value. |
| SkillParameter | A skill parameter value. |
| SkillParameterType | Enumeration of the possible skill parameter types. |
Document structure
| Object | Description |
|---|---|
| Document | The document being processed, including its pages, source files, and the skill applied to it. |
| Page | A single document page. |
| Field | A document field, with properties and methods for inspecting and modifying it during rule execution. |
| FieldType | Enumeration of available field types and the data types each supports. |
| DataType | Enumeration of data types a field can contain. Includes the AmountOfMoney class for currency values. |
Image regions
| Object | Description |
|---|---|
| ImageRegionList | A list of field regions on an image. |
| ImageRegion | A single field region, which may consist of multiple rectangles. |
| RectangleList | A list of rectangle areas on an image. |
| Rectangle | A rectangular area on an image. Coordinates are in pixels. |
| Symbol | A character within the initial text value of a field. |
Data and transactions
| Object | Description |
|---|---|
| Record | A single row from a data catalog, returned by Context.GetCatalogRecord. |
| Transaction | Transaction parameters for the current run. |
| SourceFile | A source file used as input. |
Related topics
Business rules automation
Add scripted rules to a Document skill, configure readable and writable fields, and reference table columns.
Rule verification
Use rules to validate, modify, or compute extracted field values in a Document skill.
Sample scripts
Working JavaScript samples for common Advanced Script Rule scenarios.