rrunner actions
Use the rrunner actions to do miscellaneous utility functions.
The rrunner actions can check batch integrity, manipulate the values of fields and variables, raise condition flags, and control rule execution.
- AbortOnError
Determines whether a task that encounters an error stops or continues. - CheckAllIntegrity
Checks all documents in the batch to determine whether they meet the document integrity requirements that are specified in the document hierarchy (setup DCO). - CheckDocCount
Determines whether the number of documents in the runtime hierarchy matches the expected document count as specified by the scan operator. - CheckPageCount
Determines whether the number of pages in the runtime hierarchy matches the expected page count as specified by the scan operator. - DebugMode_OFF
Disables enhanced logging. - DebugMode_ON
Enables enhanced logging (disabled by default). - GoToNextFunction
Returns False, which causes the next function in the ruleset to run. - MessageID
Adds a runtime MESSAGE and a MessageID variable to the bound object of the document hierarchy. - MessageIDParameter
Adds a runtime Value, Type, and Substitution index for use with a preconfigured MESSAGE and MessageID variable to the bound object of the Document Hierarchy. - PilotMessage_Clear
Removes the MESSAGE variable from the current object. - PilotMessage_Set
Assigns a message to the MESSAGE variable of the current object. - ProcessChildren
Initiates the processing of elements that are represented by the bound object and its children. - rr_AbortBatch
Stops processing the current batch and sets its status to Abort. - rr_Get
Assigns the value of the specified variable to the Text property of the current object. - rr_WriteNode
Creates a separate XML data file for the current object. - rrAppend
Appends the value of the source object to the specified field. - rrCompare
Compares the values of two variables and returns True if they are the same. - rrCompareCase
Runs a comparison of two strings or smart parameters to see whether they are identical. - rrCompareCaseLength
Uses the smart parameters that you enter as the parameter to locate and compare the values of two object's variables. - rrCompareNot
Compares the values of two variables and returns False if they are the same. - rrCompareNotCase
Negates the running of the rrCompareCase action. You can run this action in instances when two of the string or smart parameter values are different. - rrCompareNotCaseLength
Negates the running of the rrCompareCaseLength action. You can run this action in instances when two of the values are different. - rrCompareNumeric
Uses the Smart Parameters that you enter as the parameter to locate and compare the numeric values of two object's variables. - rrContains
Uses the Smart Parameters that you enter as the parameter to locate and compare the values of two objects' variables. - rrCopy
Copies the value, confidence levels, and positions from one field to another. - rrPrepend
Inserts a value at the beginning of the specified field. - rrSet
Assigns a value to a variable or field. - SetBatchPriority
Sets the priority of the batch at the completion of the task. - SetOperatorID
Sets the ID of the person who is operating Rulerunner. - SetReturnValue
Returns True or False depending on the parameter that is specified. - SetStationID
Sets the ID of the station where the person is operating Rulerunner. - SetTaskStatus
Specifies the task status that is returned to an application as Abort, Canceled, Finished, Hold, or Pending when the current task completes. - SkipChildren
Prevents the running of rules on child objects of the current object. - Status_Preserve_OFF
Allows rules to change the STATUS value of fields, for example, to assign a problem status. - Status_Preserve_ON
Prevents rules from changing the STATUS value of fields. - Task_NumberOfSplits
Specifies the number of jobs the batch is sent to when a condition is raised before it returns to the main workflow. - Task_RaiseCondition
Specifies the group index and the index of the condition to raise from the list on the Datacap Web Client Workflow tab. 0 is the first condition.
Parent topic: Global actions