Business Rule Editor Snap-In¶
The Business Rule Editor Snap-in consists of the navigation controls at the top of the snap-in, several required settings, the Workflow Editor, and the Activity Pane.
Current Record/Grid View Button:
Click this button or press
Snap-in Navigation Buttons:
These buttons allow you to navigate through all available business rules, add/delete rules, and cancel edits and filters.
Specifies whether the business rule starts before or after the database is updated, or on a schedule.
Assigns a name to the business rule for easy reference.
Makes the business rule active. If this box is not selected, the business rule will not run.
Wait for Execution:
Select the box to run business rules synchronously, so that a rule is completed before any other action takes place. Clear the box to allow business rules to run asynchronously, so that rules can run in the background while other actions are taking place.
Note: If this checkbox is unchecked, the results of the business rule will not show up in the user's session after a save. For example, if a case event is added in a business rule, the event may not show up on the case when the user saves. The user would need to refresh the case session at a later time to see the event created by the business rule.
Specify when the business rule runs:
Note: Execution Type is only relevant for non-batched workflows and will not affect batched workflows.
Adding Activities to Workflows¶
To add an activity to a workflow, click and drag an activity from the Activity Pane to the Workflow Editor.
The Workflow Editor is the area where business rules are actually created. You can drag and drop activities from the Activity Pane into the Workflow Editor to create the business rule.
Note: The activities listed in the Activity Pane will vary depending on the Start Type selected.
The Workflow Editor places activities in a sequential workflow diagram for a quick overview of the business rule. An example is shown below:
The Activity Pane contains all of the available activities that define what a business rule accomplishes. Note: This list is filtered by the selection made in the Start Type field.
To add an activity to the workflow, click and drag it from the Activity Pane into the desired location in the Workflow Editor.
The following activities can be used in business rules:
- ApplyStampToDocument: This activity allows for a stamp to be placed on a PDF document when the file is uploaded.
- CaseAgencyResult: Creates/updates a case agency record as a result.
- CaseAttributeResult: Uses a change in a case attribute as a result.
- CaseAttributeTrigger: Uses a change in a case attribute as a trigger.
- CaseCopyActivity: Copies a case and performs actions on the newly-created case.
- CaseEvent: Combines a trigger and a result in one activity.
- CaseInvPersResult: Adds a case involved person to the case as a result.
- CaseStatusTrigger: Uses a change in case status as a trigger.
- CompareAgainstStatuteAttribute: Compares the value in a field to the value of a statute attribute.
- ConditionResult: Adds a condition to a case as a result.
- CountTrigger: Uses a change in the Charge snap-in as a trigger.
- DeleteCase: Sets a case to be deleted (usually at the end of the workflow). Caution: As this activity deletes entire cases, it should be used with care and consideration. It is recommended that this activity should only be used by individuals who can verify that the cases should be deleted.
- EventEngineResult: Uses an event as a result, such as a document, event, task, correspondence, or case status.
- EventEngineTrigger: Uses an event as a trigger, such as a document, event, task, or correspondence.
- EventInvPersResult: Adds an event involved person to an event as a result.
- FinancialAdjustingEntryResult: Zeroes out remaining balances on case financial obligations as a result.
- FinancialAllocateToObligationResult: Automatically allocates escrow and/or overpay funds to financial obligations.
- FinancialNonCollectableResult: Uses a non-collectable financial event as a result.
- FinancialObligationResult: Adds a financial obligation as a result.
- FinancialObligationResultWithVariable: Defines the percent of a base fine for a financial obligation.
- FinancialObligationTrigger: Uses a change in the fields of the Financials snap-in as a trigger.
- GetData: Returns a list of event, case, or name IDs defined by the T-SQL parameter provided.
- GetDataWithChildren: Returns a data set that can be used by child activities.
- IfElse: Determines a condition to look for in the specified data in order to dictate a workflow path.
- JDAActivity: Generates documents from JDA templates.
- ModifyEventActivity: Modifies an event's status and associates a status with the resulting event.
- NameAttributeResult: Adds or deletes a name attribute to/from a specified case involved person.
- NotifyInvolvedNames: If a change is made to a case or event, a notification email can be sent according to case or event involvement.
- NotifyNames: If a change is made to a case or event, a notification email can be sent.
- PhysicalLocationTrigger: Creates an action after the location of a case or exhibit has been changed.
- SendNotificationEmail: Sends a notification email and specifies who to send it to.
- SentenceResult: Adds a sentence to a case as a result.
- SetJBMessageStatusCode: Sets or updates a JusticeBroker message status.
- Terminate: Stops an action from posting to the database if the conditions are met.