跳转到主要内容
一个全局对象，可用于访问文档、其 field，以及该文档所处处理事务的参数。将检查结果赋值给 CheckSucceeded 属性。

​
属性

名称类型访问级别说明
CheckSucceededbool读写指示规则条件是否满足。默认值为 true。如果条件不满足，脚本应将其设为 false。此时将向操作员显示默认错误消息：“Error in the rule <rule_name>: <field_name>”。如果需要自定义消息，请使用 ErrorMessage 属性设置。重要！ 仅当 CheckSucceeded 设为 false 时才会生成错误。如果脚本未将 CheckSucceeded 的值改为 false，即使未满足条件也不会显示错误消息。
CurrentFieldField唯讀由规则检查的字段。对于由重复规则检查的重复字段：当前调用正在检查的该字段的具体实例。如果规则引用整个文档，则返回 null。
DocumentDocument唯讀执行该规则的文档。
ErrorMessagestring读写当脚本将 CheckSucceeded 设为 false 时显示的用户自定义消息。如果未设置此属性，出错时将显示的消息为：“Error in the rule <rule_name>: <field_name>”。
TransactionTransaction唯讀当前处理事务。

​
方法

名称描述
Field GetField(string fieldName);按名称或标识符获取该 field。重要！ 直接将 field 的字符串名称传给此方法：具有相同字符串值的变量将不起作用。执行前解析脚本代码的预处理器会把 field 名称替换为其标识符，但无法处理变量。对于包含在字段组中的 field，请使用完整路径进行引用，例如 BusinessUnit/Address。在重复规则中使用时，此方法会按顺序返回每个已处理的 field 实例。否则，当引用重复的 field 时，此方法将返回其第一个实例。
Field[] GetFields(string fieldName);返回具有指定名称的 field 列表。此方法可用于获取重复 field 的所有实例，包括表格列中的所有单元格。在使用循环时，此方法能更方便地访问重复 field。重要！ 直接将 field 的字符串名称传给此方法：具有相同字符串值的变量将不起作用。预处理器会把 field 名称替换为其标识符，但无法处理变量。
Record GetCatalogRecord(string catalogId, string externalId);从目录（外部数据库）获取记录。使用此方法从目录中获取信息，并将文档中的字段值与目录中的字段值进行比较。目录名称（catalogId）和目录记录标识符（externalId）作为参数传入。仅当目录中已设置相应标识符（例如 Vendor 标识符）时，才能使用此方法。
SkillParameter SkillParameter(string ParameterName);从 Skill 参数获取值。仅当 Document skill 至少包含一个参数时，才能使用此方法。