RuleError

The RuleError object — a single Document skill validation rule error in a Condition activity script.

RuleError describes a single Document skill validation rule error returned by Document.RuleErrors in a Condition activity.

Properties

Name	Type	Access	Description
CurrentFieldId	string	Read-only	The document field identifier of the field that caused the rule error.
CustomMessage	string	Read-only	An error message from a custom skill. Returns an empty string for built-in rules, or when no custom message is set.
ErrorParameters	object	Read-only	The error parameters. Returned only for built-in rules.
ErrorType	string	Read-only	The error type. Returned only for built-in rules.
RuleId	string	Read-only	The identifier of the rule that generated the error.

Related topics

• Document
• Object model