Saltar al contenido principal
Un objeto global que proporciona acceso al Document, a sus fields y a los Parameter de la transacción donde se está procesando el documento. Asigne el resultado de la verificación a la propiedad CheckSucceeded.

Propiedades

NombreTipoNivel de accesoDescripción
CheckSucceededboolLectura y escrituraIndica si se cumple la condición de la regla. El valor predeterminado es true. Su script debe establecerlo en false si la condición no se cumple. En ese caso, se mostrará al operador el mensaje de error predeterminado: “Error in the rule <rule_name>: <field_name>”. Si prefiere un mensaje diferente, configúrelo con la propiedad ErrorMessage. ¡Importante! Solo se genera un error si CheckSucceeded se establece en false. Si el script no cambió el valor de CheckSucceeded a false, no se mostrará un mensaje de error incluso si no se han cumplido las condiciones.
CurrentFieldFieldDe solo lecturaEl campo verificado por la regla. Para campos repetidos verificados por reglas repetidas: la instancia específica del campo que está siendo verificada por la llamada actual. Si la regla hace referencia al documento en su conjunto, devuelve un valor null.
DocumentDocumentDe solo lecturaEl documento para el cual se ejecuta la regla.
ErrorMessagestringLectura y escrituraMensaje definido por el usuario que se mostrará si el script establece CheckSucceeded en false. Si no configura esta propiedad, el mensaje que se mostrará en caso de error será “Error in the rule <rule_name>: <field_name>”.
TransactionTransactionDe solo lecturaLa transacción actual.

Métodos

NombreDescripción
Field GetField(string fieldName);Obtiene el campo por nombre o identificador. Importante: pase directamente a este método el nombre del campo como cadena; una variable con el mismo valor de cadena no funcionará. El preprocesador que analiza el código del script antes de ejecutarlo sustituirá el nombre del campo por su identificador, pero no podrá procesar una variable. Use la ruta completa para dirigirse a los campos que están dentro de un grupo de campos, por ejemplo, BusinessUnit/Address. Cuando se usa en una regla repetitiva, este método devolverá secuencialmente cada instancia de campo procesada. De lo contrario, cuando se haga referencia a un campo repetitivo, devolverá su primera instancia.
Field[] GetFields(string fieldName);Devuelve una lista de campos con el nombre especificado. Este método se puede usar para obtener todas las instancias de un campo repetitivo, incluidas todas las celdas de una columna de tabla. Facilita el acceso a campos repetitivos cuando se usan bucles. Importante: pase directamente a este método el nombre del campo como cadena; una variable con el mismo valor de cadena no funcionará. El preprocesador que analiza el código del script antes de ejecutarlo sustituirá el nombre del campo por su identificador, pero no podrá procesar una variable.
Record GetCatalogRecord(string catalogId, string externalId);Obtiene un registro de un catálogo (base de datos externa). Use este método para obtener información de un catálogo y comparar los valores de los campos del documento con los del catálogo. El nombre del catálogo (catalogId) y el identificador del registro (externalId) se pasan como argumentos. Este método solo se puede usar si se ha configurado el identificador correspondiente en el catálogo (p. ej., el identificador del Proveedor).
SkillParameter SkillParameter(string ParameterName);Obtiene un valor del parámetro de la Habilidad. Este método solo se puede usar si el Skill de documento tiene al menos un parámetro.