Activity Configuration Snap-In¶
The Activity Configuration snap-in contains the fields used to specify the conditions under which the business rule is enabled. For example, an EventEngineTrigger could specify that any time an Event Type of Answering Brief Filed gets an Event Status of Confirmed (both fields specified in the Activity Configuration snap-in), the workflow is enabled. The EventEngineResult could create a new event, specifying the Event Type, Event Location, Event Status, an offset determining how long from the execution of the business rule the new event will be scheduled, and involved people.
Configuring Activities in the Activity Configuration Snap-in¶
Configuring activities correctly in the Activity Configuration snap-in is crucial in making business rules function properly. Each activity contains different actions in the Activity Configuration snap-in. This section will describe each activity's options in the Activity Configuration snap-in in order to help you configure your activity properly. Some of the fields are required, and others are optional.
Note: The fields in the Activity Configuration snap-in update according to the activity selected in the Workflow editor. Click through the different activities in the workflow to view the fields relevant to that activity in the Activity Configuration snap-in below.
List of Activities¶
Click on a business rule activity to see detailed information about its use.
ApplyStampToDocument¶
This activity allows for a stamp to be placed on a PDF document when the file is uploaded. This could be used to stamp a document as received when the document is uploaded into JustWare.
Field |
Description |
---|---|
Location |
Specify the location on the document where the stamp will be placed. |
Image Path |
If you wish to include an image in the stamp (a county seal, for example), insert the file path here. This file path must be accessible by the File Access User in JustWare to enable the server to insert the image at the time of upload. |
Title |
Type a title that will appear at the top of the stamp (i.e., Received). |
Name |
Specify if you want a name to be included in the stamp. You can select the name of the person submitting the file, or provide a fixed name. |
Name Fixed Value |
Type the name for the fixed name that will be inserted with the stamp. |
Date Time Stamp |
Select this option to include in the stamp the date and time the document was uploaded. |
First Page Only |
Select this option to have the stamp only applied to the first page. Leaving this clear will apply the stamp to all pages of the document. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CaseAgencyResult¶
Creates/updates a case agency record as a result.
Field |
Description |
---|---|
Agency Type |
Specify the agency type that will be created or updated on the case. |
Agency |
Specify the agency that will be created or updated on the case. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Lead |
Select this check box to have the new agency be the lead agency. |
Active |
Select this check box to have the new agency be an active agency. |
Activity Type |
Specify how the new agency will be added to the case. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CaseAttributeResult¶
Uses a change in a case attribute as a result.
Field | Description |
---|---|
Case Attribute | Specify the case attribute you would like to change as a result of the trigger. |
Case Attribute Code | Select the code of the case attribute you wish to change as a result of the trigger. |
Value | Enter a value you want to be associated with the resulting case attribute. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CaseAttributeTrigger¶
Uses a change in a case attribute as a trigger. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Case Attribute | If you want a change in a case attribute to trigger a rule, specify the attribute here. |
Case Attribute Code | Select the code of the case attribute you wish to use as a trigger. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
CaseCopyActivity¶
Copies a case and performs actions on the newly-created case. CaseCopyActivity must be used in conjunction with a trigger and may contain a resulting activity that will affect the newly-created case. A CaseEvent cannot be contained within a CaseCopyActivity.
Note: The CaseCopyActivity is NOT designed to work in conjunction with the FinancialObligationResult activity.
Field | Description |
---|---|
Related Case Type | Specify how the newly-created case is related to the existing case. |
Case Agency Added By | Specify the agency responsible for creating the copy of the case. |
Case Type | Select a case type for the copy. If left blank, the original case's type will be used. |
Case Status | Select a case status for the copy. If left blank, the original case's status will be used. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Copy Case Status History | Select this to copy the case status history when the case is copied. |
Specify which components of the case should be copied to the new case by selecting the appropriate check boxes:
- Copy Non-PIP Involvements
- Copy Past Events
- Copy Future Events
- Copy Case Notes
- Copy Case Attributes
- Copy Charges
CaseEvent¶
CaseEvent combines a trigger and a result in one activity, allowing you to skip a step and create a business rule more efficiently.
Field |
Description |
---|---|
Event Type |
Specify the event you want to use as a trigger for the rule. |
Case Status |
If you want a change in case status to trigger the rule, specify the status here. |
Event Status |
If you want the rule to trigger when an event status is changed, specify the status here. |
Case Type |
Specify the type of case you want to act as a trigger. |
Resulting Event Type |
Specify what kind of event you want to create as a result of the trigger. |
Resulting Event Location |
Specify the location where the resulting event will take place. |
Resulting Event Status |
Specify the status you want to be associated with the resulting event. |
Result Offset |
Specify the amount of time you want the resulting event to be scheduled relative to the trigger event. For example, if your business rule was configured to automatically schedule an arraignment when a bench trial was scheduled, then you could specify that the arraignment be scheduled three days after the bench trial. |
UseInvPers |
Select this box if you want to include all involved persons from the triggering event in the resulting event. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NOTE: If an event is scheduled onto a docket by this activity, JustWare attempts to select a docket instance for the event which is free of conflicts. If there are no conflict-free instances, JustWare makes sequential attempts to find the next best-fitting instance by relaxing requirements one by one. The successive attempts are made in the following order:
- First, Duration is ignored as a requirement, and only Case Involved Name, Name-to-Name, Scheduling, and Capacity -related conflicts are checked.
- Second, Capacity is also ignored, leaving only Case Involved Name, Name-to-Name and Scheduling conflicts to be checked.
- Third, Scheduling conflicts are also ignored. Only Case Involved Name and Name-to-Name conflicts are checked.
- Fourth, Name-to-Name conflicts are also ignored, and only Case Involved Name conflicts are checked.
- Finally, if all available instances have Case Involved Name conflicts, the first chronologically available instance is selected for the event.
If an instance is found between any of these successive attempts that has no conflicts other than those already ignored, it is selected for the event. Understanding the order of these steps may be important if an event is automatically scheduled on an undesired instance by the business rule.
CaseInvPersResult¶
Adds a case involved person to the case as a result. See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
Involvement |
Specify the involvement type of the case involved person. |
Agency |
Specify the agency of the case involved person. This agency will only be used if no agency is passed to this activity from previous activities. If an agency is specified in previous activities, that agency will be the one used. Note: If the agency of the case involved person is not already listed on the case, the business rule will automatically insert that agency before it inserts the new case involved person. |
Name |
Specify the name of the case involved person. If you would like to specify a NameID from a query, you can use a GetDataWithChildren. This field would be left blank if NameIDs are being passed to it from the GetDataWithChildren activity. |
Notification |
Select this check box to send notification to a case involved person. |
Flag |
This is an agency-customizable check box that corresponds to the same check box in the Case Involved Person snap-in, which can be configured to do any desired task. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CaseStatusTrigger¶
Uses a change in case status as a trigger.
Field | Description |
---|---|
Case Status | If you want a change in case status to trigger the rule, specify the status here. |
Case Type | Specify the type of case you want to act as a trigger. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
CompareAgainstStatuteAttribute¶
The CompareAgainstStatuteAttribute activity compares the value in a field to the value of a statute attribute. Your comparison statements should be created so that a "true" response executes the child activity and a "false" response executes the next activity. For example, the value in Field A is checked to see if it is less than the value in Attribute B. If Field A's value is less than Attribute B's value, this true response executes the child activity of this comparison activity.
See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
Snap-in Name |
This drop-down list is populated with a specific subset of snap-ins that have a CountInvPersID. Select the snap-in that contains the field whose value you would like to compare to the statute attribute value. |
Field Name |
Type in the field name that appears in the selected snap-in. |
Operator |
Specify the operator to use for the comparison:
|
Attribute |
Only attributes with Duration, Money, or Numeric MasterCodes can be used for the comparison to the field value. Specify the attribute to use for the comparison. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
ConditionResult¶
Adds a condition to a case as a result.
Field |
Description |
---|---|
Resulting Event Type |
Specify what kind of event you want to create as a result of the trigger. |
Location |
Select the location to which the defendant is being sentenced from the list. |
Amount From |
Type the minimum time of the sentence. For example, type "30 d" if the defendant was sentenced to 30 days. The amount automatically changes to "4 weeks 2 days" and the Amount From Description auto-populates with "30 days." Type "m" for minutes and "mo" for months. |
Amount From Description |
This field auto-fills with the value from the Amount From field. You can edit it to specify a different or more detailed description. |
Status |
Select the status of the condition from the list. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Title |
Enter a short title or note for the condition. |
Currency 1 |
Enter an amount of money associated with this event. |
Currency 2 |
Enter any additional amount of money associated with this event. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CountAttributeResult¶
Uses a change in a case attribute as a result.
Field | Description |
---|---|
Count Attribute | Specify the count attribute you would like to change as a result of the trigger. |
Count Attribute Code | Select the code of the count attribute you wish to change as a result of the trigger. |
Value | Enter a value you want to be associated with the resulting count attribute. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CountInvPersResult¶
The CountInvPersResult activity adds case involvements to counts. It can be used in conjunction with CountTrigger or IfElse to provide CountIDs or they can be supplied with GetData or GetDataWithChildren.
There are two ways CountInvPersResult can operate: through case involvement types or through case involvement person IDs. If involvement types are selected when configuring this result, involvements on that case of that type will be added. Otherwise, the result will expect case involvement person IDs (CaseInvPersID) supplied by GetData or GetDataWithChildren and add those as count involvements.
Adds case involvements to counts. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Involvement Type | Select 0 or more case involvement types. Those involved on the count's case of that type will be involved on the count. If no types are selected, the result will add the CaseInvPersIDs passed into it via other activities as count involvements. |
Notes | Type a note that will be added to the count involvement. |
Notes2 | Type a secondary note that will be added to the count involvement. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
CountTrigger¶
Uses a change in the Charge snap-in as a trigger. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Statute | Select the statute you want to use to trigger the rule. You can do this by either performing a Statute Search or a Statute Quick Search. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
DeleteCase¶
This activity deletes a case, usually once the workflow has ended and the case is no longer needed. 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.
Note: This activity must have a Start Type of Batch, and it must be used after a GetData activity. The GetData activity must select the case IDs that will be deleted.
Field | Description |
---|---|
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
DeleteCaseSuper¶
This activity deletes a case, usually once the workflow has ended and the case is no longer needed. 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.
A Business Rule using the DeleteCaseSuper activity will only fail if there are obligations or an obligation count involved person record. An example would be using this rule for a group of cases where one of the case has an obligation. The rule would continue to run and move onto the other cases in the rule.
Note: This activity must have a Start Type of Batch, and it must be used after a GetData activity. The GetData activity must select the case IDs that will be deleted.
Field | Description |
---|---|
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
DeleteEventActivity¶
This activity deletes events in OnDemand/Batch. This activity also deletes documents. If a document cannot be deleted you will get a message in the workflow log.
Business rule example
- Create the rule and set to OnDemand
- Add GetData to the editor
- Add DeleteEventResult to the editor after GetData
- Set the GetData select string to: SELECT TOP 5 EventID FROM devEvent ORDER BY addDt desc
- Send the data to an appropriate table, i.e. NameAddress
- Launch the business rule
EventEngineResult¶
Uses an event as a result. An event result could be a document, event, task, correspondence, or case status. See "Business Rules Examples for an example of this activity.
Field | Description |
---|---|
Resulting Event Type | Specify what kind of event you want to create as a result of the trigger. |
Event Category | Specify the category you would like assigned to the event created by a business rule. |
Resulting Event Location | Specify the location where the resulting event will take place. |
Resulting Event Status | Specify the status you want to be associated with the resulting event. |
Result Offset | Specify the amount of time you want the resulting event to be scheduled relative to the trigger event. For example, if your business rule was configured to automatically schedule an arraignment when a bench trial was scheduled, then you could specify that the arraignment be scheduled three days after the bench trial. |
UseInvPers | Select this box if you want to include all involved persons from the triggering event in the resulting event. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NOTE: - Care needs to be taken when setting up business rules that are affected by complementary programs such as JDA. For example, if the insertion of a document from a complementary program causes a business rule to fire, which in turn generates new documents, then the generated document records created in JustWare will not link to actual documents. Moreover, if a change is made in a JustWare session that does not contain a filing cabinet snap-in and that change triggers a business rule to generate a new document, then the document will not be generated. - If an event is scheduled onto a docket by this activity, JustWare attempts to select a docket instance for the event which is free of conflicts. If there are no conflict-free instances, JustWare makes sequential attempts to find the next best-fitting instance by relaxing requirements one by one. The successive attempts are made in the following order:
- First, Duration is ignored as a requirement, and only Case Involved Name, Name-to-Name, Scheduling, and Capacity -related conflicts are checked.
- Second, Capacity is also ignored, leaving only Case Involved Name, Name-to-Name and Scheduling conflicts to be checked.
- Third, Scheduling conflicts are also ignored. Only Case Involved Name and Name-to-Name conflicts are checked.
- Fourth, Name-to-Name conflicts are also ignored, and only Case Involved Name conflicts are checked.
- Finally, if all available instances have Case Involved Name conflicts, the first chronologically available instance is selected for the event.
If an instance is found between any of these successive attempts that has no conflicts other than those already ignored, it is selected for the event. Understanding the order of these steps may be important if an event is automatically scheduled on an undesired instance by the business rule.
- If you are using the EventEngineResult to generate a document, use the following guidelines to ensure that your document is created:
- The session must contain a Filing Cabinet snap-in. Failure to do this will result in the document never being created.
- The Business Rule should be set as an After or Before Update. Using a Batch Start Type will result in no document being generated.
- The Business Rule should have an Execution Type of JustWare. Using the API and JusticeBroker Execution Types could result in no document being generated.
EventEngineTrigger¶
Uses an event as a trigger. An event trigger could be a document, event, task, or correspondence. For an update, EventEgineTrigger will only trigger on a change to Event Type. All available events can be seen in the Activity Configuration snap-in under Event Type. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Event Type | Specify the event you want to use as a trigger for the rule. |
Case Status | If you want a change in case status to trigger the rule, specify the status here. |
Event Status | If you want the rule to trigger when an event status is changed, specify the status here. |
Case Type | Specify the type of case you want to act as a trigger. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
EventInvPersResult¶
Adds an event involved person to an event as a result. This activity will not make the event involved person a case involved person. See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
NameID |
Enter a NameID by searching for the desired event involved person. If you would like to specify a NameID from a query, you can use a GetDataWithChildren. This field would be left blank if NameIDs are being passed to it from the GetDataWithChildren activity. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
|
Select this box if you want this involved person to receive an email reminder for the selected event. |
Pop-up |
Select this box if you want this involved person to receive a pop-up reminder for the selected event. |
Reminder Time Prior to Event |
Specify the amount of time (1 minute, 10 minutes, etc.) prior to the event for the reminder to be sent. |
Flag |
This is an agency-customizable check box that corresponds to the same check box in the Case Involved Person snap-in, which can be configured to do any desired task. |
Status |
Select the status you want for the activity. |
Flag 1-5 |
These check boxes share the same function as the first flag check box. There are five separate flag check boxes so that multiple customizable parameters can be set. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
FinancialAdjustingEntryResult¶
This activity enables you to zero out remaining balances on case financial obligations. This feature is helpful, for example, if you need to write off obligations, implement a fee waiver, or show that obligations should no longer be considered a part of accounts receivable.
The implemented business rule looks at each financial obligation on the case and the remaining balance. It then applies an adjusting entry to bring the remaining balance on each financial obligation row to zero. This includes financial obligations entered as Joint and Several. As a result, in the Adjusting Entry snap-in of the Financials view, corresponding adjusting entry records will appear.
Field |
Description |
---|---|
Adjusting Entry Type |
Specify the adjustment type that will appear on the case when obligations are adjusted to zero. This field is populated from entries in the Transfer Type code table that have a MasterCode of 0 - Adjustment. |
Obligation Type |
Specify the obligation type(s) that will be adjusted to zero. A single type or multiple types may be selected. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
FinancialAllocateToObligationResult¶
This activity enables you to automatically allocate overpay and/or escrow funds to financial obligations. Note: This activity cannot be used to automatically allocate funds to bonds.
See "Business Rules Examples" for an example of this activity.
Caution: This activity runs without regard to the value set in the How to Handle Auto-Allocation for Bonds field of Application Parameters. Pending bonds do not prevent this activity from allocating funds to financial obligations.
Overpay funds, funds in a name-based escrow account, and/or escrow funds that have been earmarked for a specific case record can be automatically allocated to financial obligations. The funds, specified in the Allocate From field, are allocated to financial obligations on case records in this order:
- Case-earmarked escrow funds for all financially responsible name records
- Name-based escrow funds for all financially responsible name records
- Overpay account funds for all financially responsible name records
The implemented business rule looks at collecting agency, financial obligations on a case, the name record(s) responsible for payment of the obligations, and the overpay and/or escrow funds for the responsible name record(s) in order to make appropriate matches for the allocations.
Note: If this activity is used in conjunction with a FinancialObligationTrigger with a declining balance, the FinancialAllocateToObligationResult will fire at the end of the business rule, regardless of where this activity is placed in the business rule.
Field | Description |
---|---|
Allocate From | Specify the type(s) of funds to be assessed for possible allocation to existing financial obligations. |
Non-Client User for Batch Start Type | This field is required for business rules that have a Start Type of Batch to specify the user for whom the allocations will be performed. For batch business rules, select the active user specified as a Non-Client User in the Application Person code table or in the Agency Person code table. This user should be a member of all of the collecting agencies for which you would like automatic allocations to occur. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Automatic allocations are recorded in the Allocation snap-in within the Financials snap-in header. Receipts for automatic allocations are generated and can be viewed from the hyperlink in the Receipt Number field of the Allocation or Payment snap-ins for the name record. Receipts can also be viewed from various financial reports.
Note: If this activity is triggered by an action taken in the database, such as entering a financial obligation, allocations are only performed for the collecting agencies the user is a member of. If this activity is run on a schedule as part of a batch, allocations are performed for all collecting agencies of which the specified non-client user is a member.
FinancialNonCollectableResult¶
Uses a non-collectable financial event as a result. This is used when keeping a record of a financial obligation that the organization will not actually be responsible for collecting. This is much simpler than using financial accounting features of JustWare because non-collectable financials are essentially treated as events instead of financial records.
Field |
Description |
---|---|
Resulting Event Type |
Specify the type of financial event you want to act as a result of the trigger. |
Amount 1 |
Specify a dollar amount to be associated with the non-collectable financial record. |
Amount 2 |
Specify another dollar amount to be associated with the non-collectable financial record. |
Resulting Event Location |
Specify the location where the resulting event will take place. |
Resulting Event Status |
Specify the status you want to be associated with the resulting event. |
Result Offset |
Specify the amount of time you want the resulting event to be scheduled relative to the trigger event. For example, if your business rule is configured to automatically schedule child support obligations when a guilty plea is accepted, then you could specify that the child support obligations begin from an earlier date. |
UseInvPers |
Select this box if you want to include all involved persons from the triggering event in the resulting event. |
Event Category |
Select a relevant category for the non-collectable financial result. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
FinancialObligationResult¶
Adds a financial obligation as a result. See "Business Rules Examples" for an example of this activity.
Tip: Financial results can be included in a business rule with any trigger type. It is necessary to use discretion, however, when creating a business rule of this type as a financial obligation cannot be created for a case that does not include at least one charge. Business rules that include financial obligation results will not work in such a scenario.
The FinancialObligationTrigger and the attached FinancialObligationResult will create a parent/child financial obligation relationship. When you add a record to the Financials snap-in for a case and use the specified trigger in the Type field, the attached result will also appear as a record in the snap-in after saving.
Field |
Description |
---|---|
Type |
Specify the type of financial obligation that will be added as a result of the trigger. |
Collecting Agency |
Select the agency that will collect funds on this financial obligation. If left blank, the default agency for the Type selected above will be used. If there is no default set, an error will be displayed when the business rule is run and a default or Collecting Agency will need to be selected for this activity. If Agency Added By is selected, the agency specified in the Agency Added By field of the case in question will be used. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Default Percent |
This field is used to spread an obligation into separate accounts by percentages instead of an exact amount. Default Percent overrides Default Amount, Calculated Override Amount, and Simple Override Amount. |
Calculated Override Amount (T-SQL) |
This field can be used to enter a T-SQL calculation to specify an amount that will override the Default Amount and Simple Override Amount based on the specified data and variables. See the ifElse FinancialObligationResult business rule example to see how this can be used. Tip: You can use this activity in conjunction with a trigger to get the value from a row. However, ensure that your @[row.fieldname] command uses the name of a field that is contained within the trigger. |
Simple Override Amount |
The amount specified in this field will override the Default Amount (from ctblAmtDueType). |
Default Amount |
This is the amount specified for each financial obligation in the Financial Obligations code table. This read-only section is auto-filled once you specify the financial obligation type. It will only be used if the Default Percent, Simple Override Amount, and Calculated Override Amount are blank. |
Round Amount To |
Use this field to round the amount generated by the financialObligationResult up to the nearest whole dollar, or down to the nearest whole dollar. By default amounts are not rounded. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Note: The FinancialObligationTrigger and the attached FinancialObligationResult will create a parent/child financial obligation relationship. When you add a record to the Financials snap-in for a case and use the specified trigger in the Type field, the attached result will also appear as a record in the snap-in after saving.
FinancialObligationResultWithVariable¶
Used in conjunction with a FinancialObligationTrigger, this activity causes a business rule to define the percent of the base fine for the obligation based on the formula.
Field |
Description |
---|---|
Type |
Specify the type of financial obligation that will be added as a result of the trigger. |
Percent |
Specify the percent that will define the obligation amount. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Note: This activity must be used in conjunction with the FinancialObligationTrigger to generate the desired result. A single FinancialObligationResult or multiples of this activity may be used sequentially between the FinanicalObligationTrigger and the FinancialObligationResultWithVariable.
The following is an example of how the FinancialObligationResultWithVariable activity may be used in a business rule:
- In the FinancialObligationTrigger activity, a financial obligation type is selected that has a default amount of $100. (This is the original amount of the financial obligation.) The Declining Balance check box is not selected.
- In the FinancialObligationResultWithVariable activity, a financial obligation type is selected that has a default amount of $1. The Percent field is set to 5. (This percent overrides the default amount of the selected financial obligation type.)
The process behind this business rule is explained below:
- The original amount of $100 is divided by 1.05. (The 1.05 represents in decimal format 100% of the original $100 plus the additional 5%.) After dividing, the adjusted amount is $95.24 if rounded up.
-
The adjusted amount of $95.24 is then multiplied by the 5% (or .05). The resulting amount is $4.76 if rounded.
Important: The percent used to define the obligation amount is multiplied by the adjusted obligation amount and not by the original obligation amount.
FinancialObligationTrigger¶
Uses a change in the fields of the Financials snap-in as a trigger.
Remember: Business rules with financial triggers can only have financial results.
Note: This activity is not designed to work with joint and several obligations.
Field | Description |
---|---|
Type | Specify the type of financial obligation that will trigger the event when added. |
Declining Balance | Select to show the declining balance in the case record. For example, if $20 of a $100 Base Fine is going to a Court Fee, the total balance would then be displayed as $80 if Declining Balance is selected. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
Note: The FinancialObligationTrigger and the attached FinancialObligationResult will create a parent/child financial obligation relationship. When you add a record to the Financials snap-in for a case and use the specified trigger in the Type field, the attached result will also appear as a record in the snap-in after saving.
GetData¶
Returns a list of event, case, or name IDs defined by the T-SQL parameter provided. This activity can be used by itself or on a trigger. See "Business Rules Examples" for an example of this activity.
Tip: You can use this activity in conjunction with a trigger to get the value from a row. However, ensure that your @[row.fieldname] command uses the name of a field that is contained within the trigger.
Field |
Description |
---|---|
Select String (T-SQL) |
Define the T-SQL parameter that will define the GetData results. Tip: Use the command @RootID to limit the results to a single name or case ID. |
Name of Data Table |
Type a name for the data returned by the query. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NOTE: When executing from a multi-root session, the Select command must include the root ID. If the root ID is not part of the query, use @rootID AS CaseID so that the @rootID is properly replaced with the currently executing case.
- CaseAttributeTrigger
- CaseCopyActivity
- CaseStatusTrigger
- CountTrigger
- EventEngineTrigger
- FinancialObligationTrigger
- IfElse
FolderResult¶
Creates a new folder or set of nested folders. See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
Folder Name |
Type in a valid windows folder name or path. Valid windows names do not contain < > : " | ? or *. The / and \ characters will be interpreted as paths and create sub-folders based off the path structure. An example would be "images/crime scene" this would create a folder named images with a sub-folder of crime scene. |
Name |
Type a name for the activity. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
GetDataWithChildren¶
Returns a data set that can be used by child activities.
Field |
Description |
---|---|
Select String (T-SQL) |
Define the T-SQL parameter that will define the GetData results. Tip: Filter by @RootID to limit the results to a single name or case ID. |
Name |
Type a name for the activity. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Note: The GetDataWithChildren activity is ONLY designed to work in conjunction with the following activities:
- PleaDispoResult - This can be used to add a plea or disposition to specific count involved persons. The select string for the GetDataWithChildren would need to be configured to return CountInvPersIDs.
- CaseInvPersResult - To use GetDataWithChildren with the CaseInvPersResult the T-SQL in the GetDataWithChildren must specify the nameID. Then, leave the NameID blank in the CaseInvPersResult activity.
- EventInvPersResult - To use GetDataWithChildren with the EventInvPersResult the T-SQL in the GetDataWithChildren must specify the nameID. Then, leave the NameID blank in the EventInvPersResult activity Nesting a GetDataWithChildren activity within another GetDataWithChildren is not supported and will cause undesired effects.
IfElse¶
Determines a condition to look for in the specified data in order to dictate a workflow path. For example, if one condition exists in the snap-in or data set, one consequential path will be followed, but if another condition is found to exist, a different path will be followed. See "Business Rules Examples" for an example of this activity.
The parent activity (e.g., ifElse1) can be configured using the following fields:
Field | Description |
---|---|
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
The branch activities (e.g., ifElseBranch1 and ifElseBranch2) can be configured using the following fields:
Field |
Description |
---|---|
DataSet |
When a session is saved in JustWare, all the datasets are sent to the Web service. When creating a business rule, it is necessary to define which dataset you want the business rule to search through. Choose from the following options:
|
Snap-in Name |
Specify the name of the snap-in that the business rule will search through to determine a condition. |
Select String (.NET DataTable.Select) |
A Select String is a line of code that you use to define the condition the business rule is checking for. The Select String is crucial for an IfElse business rule to fire properly. It must be written correctly or the business rule will fail. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
JDAActivity¶
Generates documents from JDA templates. A GetData activity is required for the JDAActivity to function properly.
Field |
Description |
---|---|
Root Type |
Specify either "Name" or "Case" depending on whether the document is being generated for a name or case record. If the Save to Filing Cabinet check box is selected, the generated document will be saved to the name or case record's filing cabinet. |
JDA2 Template |
Select the template you are generating the documents from. |
Generated File Destination (on print server) |
Specify the location where the file will be placed. This should be the same file location that the Print Service Manager is monitoring. Documents may be deleted or archived at this location, depending on the print server's configuration. Files will be generated by the user profile the service is running under, not the user profile being impersonated by the Maintenance Console. This profile must have permissions to the directory specified here. |
Save to Filing Cabinet |
Select this box to save a copy of the generated document to the filing cabinet of the applicable name or case record. Note: For this functionality to be enabled, the impersonation user must have read/write permissions to the name and case filing cabinets. These permissions are specified in the Maintenance Console. |
Document Type |
If the generated document is being saved to a filing cabinet, specify how the Document Type field in the Filing Cabinet snap-in will be populated when the document is saved in that location. Caution: Do not use a document type that already has a JDA 2 template mapped to it if the business rule will be triggered from an action in JustWare. You may review document type mappings to JDA 2 templates in the Document Type code table. Click System Administration | Code Tables | JDA Applications and Documents | Documents. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
See System Reports for information about the JDA Activity Workflow Log system report.
ModifyCaseInvPers¶
Modifies fields associated with a case involved person
Field | Description |
---|---|
Involvement Type | Select the case involvement type(s) that will be modified by this activity. If a involved person id is specified this field will be ignored. |
Notification, Active, Flag 1-5 | Select how you want to modify the field: No Change (Keep the current value), Select Check box, or Clear Check box. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
ModifyEventInvPers¶
Modifies fields associated with an event involved person
Field |
Description |
---|---|
Email, Popup, Notify, Flag 1-5 |
Select how you want to modify the field: No Change (Keep the current value), Select Check box, or Clear Check box. |
Reminder Time Prior To Event |
You can leave the time value the same by selecting "No Change" or you can select any available time value. |
Status |
You may set the status to "_Set to NULL " (No status) or "_No Change" (Keep current value) or any available event involved person status. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
ModifyEventActivity¶
Modifies an event's status and associates a status with the resulting event. See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
Event Type |
Select the event you wish the activity to modify. |
Resulting Event Status |
Specify the status you want to be applied to the selected event. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NameAttributeResult¶
Adds or deletes a name attribute to/from a specified case involved person. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Name Attribute | Specify the name attribute to be added or deleted by the activity. |
Name Attribute Code | Specify the name attribute code for the name attribute desired. |
Value | Enter the value you want to be applied to the name attribute you are inserting. |
Involvement | Specify the involvement type of the case involved person who will have the new name attribute added or deleted. |
Activity Type | Specify whether you want the name attribute inserted (added) or deleted from the case involved person. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NotifyInvolvedNames¶
If a change is made to a case or event, a notification email can be sent according to case or event involvement.
Field | Description |
---|---|
Send Email To | Specify who will receive the notification email by selecting Case Involved People or Event Involved People. This is a required field. |
Involvement Types | Specify the involvement type of the involved person you wish to receive the notification email. Choose "Select All" to have the notification email sent to all involvement types. |
Template | Specify the template that will be used for the notification email. Only templates that have been created through a notification template session will appear in the drop-down menu. To create templates, navigate to System Administration | Tools | Notification. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
NotifyNames¶
If a change is made to a case or event, a notification email can be sent. The template specified in the activity will generate the email content, such as a nightly email to an attorney listing cases set to appear in court the following day. A GetData Activity is required for the NotifyNames activity to work.
Field | Description |
---|---|
Template | Specify the template that will be used for the notification email. This is a required field. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
OnlineDocumentResult¶
This result makes a Filing Cabinet document available online via JusticeWeb downloads.
Field |
Description |
---|---|
Units |
Specify the units that will be associated with the document made available online. Online Document Pricing uses units to calculate price. For example, a document with 5 pages can be configured to cost 1 dollar for each page. |
Request |
Specify the JusticeWeb Request that will be used to make the document available online. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
PhysicalLocationTrigger¶
Creates an action after the location of a case or exhibit has been changed. A single business rule can be written to include both names and places involved in a case or exhibit's physical location simply by making selections from both drop-down menus. See "Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Location | Specify the name or names that will trigger the activity when the location of a case or exhibit has been changed. |
Physical Location | Specify the place or places that will trigger the activity when the location of a case or exhibit has been changed. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
PleaDispoResult¶
Creates a Plea and/or a Disposition on a case as a result of a business rule. By default, this affects every count involved person on the case. To further filter down to specific count involved persons, use the GetDataWithChildren activity to pass a specific list of count involved persons.
Field |
Description |
---|---|
Result Plea |
Specify the new Plea that will be entered when this business rule is run. |
Overwrite Existing Plea |
Select this checkbox if you want the original plea to be overwritten. If this checkbox is cleared, a new plea will be added if there is no existing plea. If there is an existing plea, nothing will be added. |
Result Dispo |
Specify the Disposition that will be entered when this business rule is run. |
Overwrite Existing Dispo |
Select this checkbox if you want the original disposition to be overwritten. If this checkbox is cleared, a new disposition will be added if there is no existing plea. If there is an existing disposition, nothing will be added. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, this activity and any child activities associated with it are disabled. |
SendNotificationEmail¶
Sends a notification email to the addresses you specify. You can select a single email address or a group of email addresses to receive a notification email when a change has been saved in JustWare. See " Business Rules Examples" for an example of this activity.
Field | Description |
---|---|
Template | Specify the template that will be used for the notification email. This is a required field. |
Email Address | Type the email address that the notification email will be sent to by the business rule. This is a required field. |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
SentenceResult¶
Adds a sentence to a case as a result.
Field |
Description |
---|---|
Resulting Event Type |
Specify the event type you want to result from the trigger. |
Location |
Select the location to which the defendant is being sentenced from the list. |
Amount From |
Type the minimum time of the sentence. For example, type "30 d" if the defendant was sentenced to 30 days. The amount automatically changes to "4 weeks 2 days" and the Amount From Description auto-populates with "30 days." Type "m" for minutes and "mo" for months. |
Amount From Description |
This field auto-fills with the value from the Amount From field. You can edit it to specify a different or more detailed description. |
Amount To |
Type the maximum time of the sentence if the sentence includes a range. For example, if the sentence is "3 to 5 years," type "5 years" here. If the sentence is not a range (e.g., "3 years"), leave this field blank. |
Amount To Description |
The amount to description auto-fills with the value from the Amount To field. Type to specify a different amount to description. |
Status |
Select the status of the sentence from the list. |
Notes |
Type a note that will be added to the Notes field of the snap-in as a result. |
Title |
Enter a short title or note for the condition. |
Currency 1 |
Enter an amount of money associated with this event. |
Currency 2 |
Enter any additional amount of money associated with this event. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
SetJBMessageStatusCode¶
SetJBMessageStatusCode allows you to set or update a JusticeBroker message status to be the result of a GetData activity in the workflow. This can be helpful in automating JusticeBroker message status codes. See the Creating Account Type Codes section of the JusticeBroker documentation for more information about message status codes.
Field | Description |
---|---|
New Status Field | Enter the column name for the status you are trying to set it to. You will need to add a GetData activity with a Queue ID and a status to update to in order to run SetJBMessageStatusCode. (See "GetData" for more information on adding a GetData activity.) |
Name | The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description | Type a description for the activity. |
Active | Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |
Terminate¶
The Terminate activity does not appear for business rules with a Start Type of After Update. It allows you to stop an action from posting to the database if the conditions are met. This is particularly useful in preventing bad data from being entered into the system. See "Business Rules Examples" for an example of this activity.
Field |
Description |
---|---|
Terminate message |
Enter a message that will appear on the user's screen when a business rule is terminated. NOTE: You can use this activity in conjunction with a trigger t o get the value from a row. However, ensure that your @[row.fieldname] command uses the name of a field that is contained within the trigger. If this activity is used in conjunction with the CompareAgainstStatuteAttribute, additional options are available. -@[StatuteDesc] This returns a description in the same format used in the Charge snap-in. For example, CL \~MURDER. -@[StatuteAttributeValue] This returns the actual value of the statute attribute. For example, 700. - @[StatuteAttributeValueDesc] This returns the text description of the statute attribute's value. For example, 23 years. - @[StatuteAttributeTypeDesc] This returns the description of the Statute Attribute Type. For example, Max Duration. |
Name |
The default name for the activity auto-populates this field. To rename the activity, type a name with no spaces. |
Description |
Type a description for the activity. |
Active |
Select this check box to activate the specified activity. If this check box is cleared, the rest of the business rule will still run; only this activity will be disabled. |