Learn how to create and configure Safety Rule Sets for ISCR reporting to custom destinations.
About Custom Safety Rule Sets
Vault provides Safety Rule Sets for certain reporting destinations. If the standard Safety Rule Sets do not cover your particular ICSR submissions to Agencies or Reporting Families, you can create and configure custom Safety Rule Sets and then assign them to the applicable Organization.
To create and configure a custom Safety Rule Set:
Create a Safety Rule Set
To create a Safety Rule Set:
- Navigate to Business Admin > Objects > Safety Rule Sets.
- Select Create.
- Complete applicable fields.
- Select Save.
Safety Rule Set Fields
The following fields may be available:
| Field | Description |
|---|---|
| Name | Enter a name for the Safety Rule Set. |
| Base Rule Set |
To create a rule set based on an existing Safety Rule Set, select that rule set from the dropdown list. Your custom rule set will inherit the Safety Rules and Safety Rule Parameters of the selected Base Rule Set. See Standard Reporting Rule Sets for a description of Vault-provided rule sets you can select as a base for your new Safety Rule Set. Note: If you select a Base Rule Set, the Base Rule Set’s Rules will not appear in the list of Rules in your new Rule Set. The list will be empty until you add new Rules. See How to Remove an Overridden Rule Parameter and the Overridden Rule field below for help modifying inherited Base Set Rules. If you do not want to inherit any Safety Rules from another Safety Rule Set, leave this field blank. You can add Safety Rules to the rule set below. |
| Eligibility Criteria | Leave this field blank. |
| API Name | Enter an API name. |
| Active Rule Version | Leave this field blank. |
Result
Vault creates a new custom Safety Rule Set.
Add Rule Set Parameters to a Custom Safety Rule Set
Safety Rule Set Parameters are Rule Parameters that apply to all the Rules in your custom Rule Set.
For any Rule in your Rule Set to generate a Transmission, all of the parameters in the Rule and any Rule Set Parameters must evaluate as “True”.
For example, your custom Rule Set is for a specific agency that requires reports for only Suspect Products. If you add the Suspect Rule Set Parameter that specifies the Product must be Suspect, then you do not need to add the Suspect Rule Parameter to each of the Rules in your Rule Set.
Rule Set Parameters appear in the Safety Rule Parameters section of a Rule Set.
Note: Adding Rule Set Parameters is optional. You do not need to add Rule Set Parameters if your Rule Set does not require them.
Add a Rule Set Parameter to a Rule Set
Complete the following steps for all the Rule Set Parameters your Rule Set requires.
- Navigate to Business Admin > Objects > Safety Rule Sets.
- Select the Rule Set.
- In the Safety Rule Parameters section, click Create.
- Complete applicable fields.
- Select Save.
Safety Rule Set Parameter Fields
The following fields may be available:
| Field | Description |
|---|---|
| Parameter | Select the required parameter from the dropdown list. For a description of the available parameters, see Reporting Rule Parameters. |
| Value |
Enter the value for the selected parameter. See Reporting Rule Parameters for help with specifying the value for a given parameter.
Note: If the Value you entered is invalid for the selected Parameter, you will receive an error message when you save the Safety Rule Set Parameter record. |
Result
Your custom Safety Rule Set now contains records for all the required Safety Rule Set Parameters.
Add Rules to a Custom Rule Set
To create and configure Safety Rules for a Safety Rule Set:
Note: You must create at least one Safety Rule within a Safety Rule Set in order for Vault to evaluate that rule set.
Add a Safety Rule to a Custom Safety Rule Set
To add a Safety Rule to a custom Rule Set, complete the following steps:
- Navigate to Business Admin > Objects > Safety Rule Sets.
- Select the Safety Rule Set.
- In the Rules section, click Create.
- Complete applicable fields.
- Select Save.
Safety Rule Fields
The following fields may be available:
| Field | Description |
|---|---|
| Name | Enter a name for the Safety Rule. |
| Rule Priority |
Enter this Rule's priority as a number between 1 and 100. The priority determines the execution order of the Rules in a Rule Set, starting with the smallest number first. Note: If you create one or more Rules with the same Priority, the Safety Rules Engine will execute them in the creation date order. |
| Evaluation Function | Select Classify Case from the dropdown list. |
| Execution Function | Select Create Transmission from the dropdown list. |
| Overridden Rule | If you selected a Base Rule Set when you created your custom Rule Set and you need to modify one of the Base Set's Rules, select the Rule from the dropdown list. The rules that appear in the dropdown list depend on the Base Rule Set you selected.
See the Parameter field below for more information on modifying inherited Rule Parameters. |
| Rule Status | Select Active.
If you want to disable a rule without deleting it, select Inactive. |
Result
Your custom Safety Rule Set now contains a new Safety Rule.
Add Safety Rule Parameters to a Safety Rule
Once you have created a new Safety Rule, add the required Safety Rule Parameters for that rule as follows:
- Navigate to the Safety Rule you created in the previous step. In the Rule Parameters section, click Create.
- Complete applicable fields.
- Select Save.
- Repeat these steps to add all the Safety Rule Parameters required for this rule.
Safety Rule Parameter Fields
The following fields may be available:
| Field | Description |
|---|---|
| Parameter | Select the required parameter from the dropdown list.
For a description of the available parameters, see Reporting Rule Parameters. Each Rule must have a Rule Parameter that defines the Due Date. Acceptable Rule Parameters to define a due date are either of the following:
Rule Parameters from Overridden Rules If the Rule for this Rule Parameter overrides a Base Rule Set (see Overridden Rule), then any Rule Parameters you add to this Rule will be used in addition to the Rule Parameters of the selected Overridden Rule. Ensure you do not add Rule Parameters to your custom Rule that conflict with those of the Overridden Rule. For example, if the Overridden Rule contains a Rule Parameter for "Suspect = Yes", do not add a Rule Parameter to your custom Rule for "Suspect = No". How to Remove an Overridden Rule Parameter To remove a Rule Parameter inherited from an Overridden Rule, select that parameter from the dropdown list, then enter two (2) dashes ( |
| Value | Enter the value for the selected parameter.
See Reporting Rule Parameters for help with specifying the value for a given parameter. Note: If the Value you entered is invalid for the selected Parameter, you will receive an error message when you save the Safety Rule Parameter record. |
Result
Your Safety Rule now contains all the required Safety Rule Parameters.
You now have a custom Safety Rule Set complete with your configured Safety Rules and Safety Rule Parameters.
Next Steps
Once you have created your custom Safety Rule Set, consider the following next steps:
- Assign the rule set to an Agency or Reporting Family.
- Complete any remaining rule set configuration, such as a Transmission Profile. See Understand the Reporting Rules Engine for more information.
- Test your custom Safety Rule Set to ensure your configuration is correct.