Saltar al contenido principal

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.

Context es un objeto global que proporciona acceso al documento que se está procesando, sus fields y los parámetros de la transacción asociada. Establezca CheckSucceeded para indicar si la regla se cumplió.

​
Propiedades

​
CheckSucceeded

Type: bool — Access: Lectura y escritura Indica si se cumple la condición de la regla. El valor predeterminado es true. Establézcalo en false si la condición no se cumple. En ese caso, el mensaje de error predeterminado que se muestra al operador es Error in the rule <rule_name>: <field_name>. Para personalizar el mensaje, establezca la propiedad ErrorMessage.
Solo se genera un error cuando el script establece CheckSucceeded en false. Si el script no lo establece explícitamente, no se muestra ningún error, aunque no se cumplan las condiciones de la regla.

​
CurrentField

Type: Field — Access: De solo lectura El campo que comprueba la regla. En el caso de campos repetibles en reglas repetibles, esta es la instancia específica que se está comprobando en la llamada actual. Devuelve null si la regla hace referencia al documento completo.

​
Document

Tipo: Document — Acceso: De solo lectura El documento sobre el que se ejecuta la regla.

​
ErrorMessage

Tipo: cadena — Acceso: Lectura y escritura Mensaje personalizado que se muestra cuando el script establece CheckSucceeded en false. Si no se establece, el mensaje predeterminado es Error in the rule <rule_name>: <field_name>.

​
Transaction

Type: Transaction — Access: De solo lectura La transacción actual.

​
Métodos

​
GetField

Field GetField(string fieldName);
Obtiene un campo por nombre o identificador. Usa la ruta completa para referirte a los campos dentro de un grupo; por ejemplo, BusinessUnit/Address. Cuando se usa en una regla repetible, GetField devuelve secuencialmente cada instancia procesada del campo. De lo contrario, devuelve la primera instancia de un campo repetible.
Pasa el nombre del campo como un literal de cadena, no como una variable. El preprocesador del script reemplaza el nombre literal por el identificador del campo antes de la ejecución; las variables no se procesan.

​
GetFields

Field[] GetFields(string fieldName);
Devuelve todos los fields con el nombre especificado; resulta útil para iterar por cada instancia de un campo repetible, incluida cada celda de una columna de una tabla.
Se aplica la misma restricción del preprocesador que en GetField: pase un literal de cadena, no una variable.

​
GetCatalogRecord

Record GetCatalogRecord(string catalogId, string externalId);
Obtiene un registro de un catálogo de datos (base de datos externa). Use este método para comparar los valores de los campos del documento con los valores de los campos del catálogo.
Disponible solo si el catálogo tiene configurado un identificador de registro (por ejemplo, un identificador de proveedor).

​
SkillParameter

SkillParameter SkillParameter(string ParameterName);
Obtiene un valor de un parámetro de la skill.
Disponible solo si el skill de documento tiene al menos un parámetro.

Modelo de objetos

Referencia completa de objetos de JavaScript para usar en reglas avanzadas de script.

Automatización de reglas de negocio

Agregue reglas con script a una Skill de documento, configure campos de lectura y escritura, y haga referencia a las columnas de la tabla.

Field

El objeto Field: inspeccione y modifique un campo del documento durante la ejecución de reglas.