Skip to main content
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.

​
Data access

Scripts can define custom functions and access Vantage data catalogs through the Context 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

ObjectDescription
ContextAccess the document, fields, catalog records, and skill parameters from inside a rule.
ParameterA parameter value.
SkillParameterA skill parameter value.
SkillParameterTypeEnumeration of the possible skill parameter types.

​
Document structure

ObjectDescription
DocumentThe document being processed, including its pages, source files, and the skill applied to it.
PageA single document page.
FieldA document field, with properties and methods for inspecting and modifying it during rule execution.
FieldTypeEnumeration of available field types and the data types each supports.
DataTypeEnumeration of data types a field can contain. Includes the AmountOfMoney class for currency values.

​
Image regions

ObjectDescription
ImageRegionListA list of field regions on an image.
ImageRegionA single field region, which may consist of multiple rectangles.
RectangleListA list of rectangle areas on an image.
RectangleA rectangular area on an image. Coordinates are in pixels.
SymbolA character within the initial text value of a field.

​
Data and transactions

ObjectDescription
RecordA single row from a data catalog, returned by Context.GetCatalogRecord.
TransactionTransaction parameters for the current run.
SourceFileA source file used as input.

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.