跳转到主要内容
一个全局对象,用于访问文档、其字段,以及处理该文档的事务的参数。将检查结果赋值给 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);按名称或标识符获取字段。重要! 将字段名对应的字符串直接传递给此方法:具有相同字符串值的变量将不起作用。在执行脚本代码之前进行解析的预处理器会将字段名称替换为其标识符,但无法处理变量。对于位于字段组中的字段,请使用完整路径进行引用,例如 BusinessUnit/Address。在重复规则中使用时,此方法会按顺序返回每个已处理的字段实例。否则,当引用重复字段时,此方法将返回该字段的第一个实例。
Field[] GetFields(string fieldName);返回具有指定名称的字段列表。此方法可用于获取重复字段的所有实例,包括表格列中的所有单元格。在使用循环时,此方法可以更轻松地访问重复字段。重要! 将字段名对应的字符串直接传递给此方法:具有相同字符串值的变量将不起作用。在执行脚本代码之前进行解析的预处理器会将字段名称替换为其标识符,但无法处理变量。
Record GetCatalogRecord(string catalogId, string externalId);从目录(外部数据库)中获取记录。使用此方法从目录中获取信息,并将文档中的字段值与目录中的字段值进行比较。目录名称(catalogId)和目录记录标识符(externalId)作为参数传递。仅当已在目录中设置了相应标识符(例如供应商标识符)时,才能使用此方法。
SkillParameter SkillParameter(string ParameterName);获取技能参数的值。仅当文档技能至少具有一个参数时,才能使用此方法。