Once you have added a new rule, and while the rule is selected, the right side of the Properties pane displays an rule configuration section.
The remaining information necessary to configure a rule depends on the rule type selected. Since many of the rule types have the same configuration requirements, the rule field configuration is grouped by rule type, followed by a description of the related rule fields.
When configuring a rule, you can click on the Rule Type drop-down list and type the name of the rule you want to use. Typing the name of the rule will select the rule in the drop-down list.
If rule is not properly and completely configured, it cannot be executed.
You can also select from the Use Property Bag drop-down to choose which type of Property Bag you want the rule to use.
-
Use Session Property Bag- Select if you want to use a session property that persists only for the duration of the user's session.
-
Use Scoped Property Bag- Select if you want to use a scoped property that persists only for the duration of a task's execution.
Note:During an incremental, parallel upgrade process, if a rule configured to use the scoped property bag in OnBase 16 or later is executed or modified in a version prior to OnBase 16, that rule will use the session property bag instead.
-
Use Persistent Property Bag- Select if you want to use a persistent property that persists for as long as the associated item exists in the Life Cycle.
This option is only available when a persistent property can be used in a configuration.
The persistent property bag contains properties for the primary item that the rule is being executed against, and not for a related item. If the rule executes against a related item, the property bag for the primary item is used.
Use the Persistent Property Bag configuration only when necessary. This configuration option has increased processing needs and could affect performance.
The following options are also available.
Option |
Description |
---|---|
Disable |
Allows you the flexibility of turning off a rule without deleting it. The rule can be reinstated, without reconfiguring, by deselecting this box. A rule in a disabled state appears grayed-out. |
Enable Debug Breakpoint |
Used for determining the location of logic problems in a Workflow configuration. Causes a message box to display before the execution of the rule. To use this option in the OnBase Client, you must have the –WFTRACE switch on the command line of the Client module and the Step Debug toolbar button or the Debug Window open in the Client module. A command line switch is not required to use this option in the Unity interface. Note:
This option is only supported in the Classic Client, Core-based client, and Unity interfaces. |
Log Execution |
When selected and the rule is executed, an entry is made in the database. If the rule is disabled when an entry is made, it will be logged in the OnBase database that the rule was disabled at the time of execution. |
For more information about rules, see Workflow Rules.