# Create Custom Safety Rule Sets

Learn how to create and configure Safety Rule Sets for ISCR reporting to custom destinations.

## About Custom Safety Rule Sets {#about}

Vault provides _Safety Rule Sets_ for <a href="/en/gr/01252/">certain reporting destinations</a>. 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_:

1. [Create a _Safety Rule Set_][2].
2. (Optional) [Add _Safety Rule Set Parameters_][3].
3. [Add _Safety Rules_][4].
4. [Next Steps][7].

## Create a Safety Rule Set {#create-rule-set}

To create a _Safety Rule Set_:
1. Navigate to **Business Admin > Objects > Safety Rule Sets**.
2. Select **Create**.
3. Complete applicable [fields][8].
4. Select **Save**.

### Safety Rule Set Fields {#rule-set-fields}

The following fields may be available:

<table>
    <thead>
        <tr>
            <th>Field</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><em>Name</em></td>
            <td>Enter a name for the <em>Safety Rule Set</em>.</td>
        </tr>
        <tr>
            <td><a id="base-rule-set"></a><em>Base Rule Set</em></td>
            <td>
                <p>
                    To create a rule set based on an existing <em>Safety Rule Set</em>, select that rule set from the dropdown list. Your custom rule set will inherit the <em>Safety Rules</em> and <em>Safety Rule Parameters</em> of the selected <em>Base Rule Set</em>. See <a href="/en/gr/01252/">Standard Reporting Rule Sets</a> for a description of Vault-provided rule sets you can select as a base for your new <em>Safety Rule Set</em>.
                    
                    <div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: 
                    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 <a href="#remove-overridden-rule-parameter">How to Remove an Overridden Rule Parameter</a> and the <a href="#overridden-rule">Overridden Rule</a> field below for help modifying inherited Base Set Rules.</p>

    </div>
  </div>
</div>


                </p>
                <p>
                    If you do not want to inherit any <em>Safety Rules</em> from another <em>Safety Rule Set</em>, leave this field blank. You can add <em>Safety Rules</em> to the rule set <a href="#add-rules">below</a>.
                </p>
            </td>
        </tr>
        <tr>
            <td><em>Eligibility Criteria</em></td>
            <td>Leave this field blank.</td>
        </tr>
        <tr>
            <td><em>API Name</em></td>
            <td>Enter an API name.</td>
        </tr>
        <tr>
            <td><em>Active Rule Version</em></td>
            <td>Leave this field blank.</td>
        </tr>
    </tbody>
</table>

**Result**

Vault creates a new custom _Safety Rule Set_.

## Add Rule Set Parameters to a Custom Safety Rule Set {#add-rule-set-parameters}

_Safety Rule Set Parameters_ are <a href="/en/gr/01250/#reporting-rule-parameters">Rule Parameters</a> 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.

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: Adding Rule Set Parameters is optional. You do not need to add Rule Set Parameters if your Rule Set does not require them.</p>
    </div>
  </div>
</div>



### Add a Rule Set Parameter to a Rule Set

Complete the following steps for all the Rule Set Parameters your Rule Set requires.

1. Navigate to **Business Admin > Objects > Safety Rule Sets**.
2. Select the Rule Set.
3. In the **Safety Rule Parameters** section, click **Create**.
4. Complete applicable [fields][9].
5. Select **Save**.

### Safety Rule Set Parameter Fields {#rule-set-parameter-fields}

The following fields may be available:

<table>
    <thead>
        <tr>
            <th>Field</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><em>Parameter</em></td>
            <td>Select the required parameter from the dropdown list. For a description of the available parameters, see <a href="/en/gr/01250/#reporting-rule-parameters">Reporting Rule Parameters</a>.</td>
        </tr>
        <tr>
            <td><em>Value</em></td>
            <td>
                <p>
                    Enter the value for the selected parameter.
                </p>
                <p>
                    See <a href="/en/gr/01250/#reporting-rule-parameters">Reporting Rule Parameters</a> for help with specifying the value for a given parameter.
                </p>
                <p>
                    <div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: 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.</p>
    </div>
  </div>
</div>


                </p>
            </td>
        </tr>
    </tbody>
</table>

**Result**

Your custom _Safety Rule Set_ now contains records for all the required _Safety Rule Set Parameters_.

## Add Rules to a Custom Rule Set {#add-rules}

To create and configure _Safety Rules_ for a _Safety Rule Set_:

1. [Add a Safety Rule to a Custom Safety Rule Set][5].
2. [Add Rule Parameters to a Safety Rule][6].

<div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: You must create at least one <em>Safety Rule</em> within a <em>Safety Rule Set</em> in order for Vault to evaluate that rule set.</p>
    </div>
  </div>
</div>



### Add a Safety Rule to a Custom Safety Rule Set {#add-rule}

To add a Safety Rule to a custom Rule Set, complete the following steps:

1. Navigate to **Business Admin > Objects > Safety Rule Sets**.
2. Select the _Safety Rule Set_.
3. In the **Rules** section, click **Create**.
4. Complete applicable [fields][10].
5. Select **Save**.

### Safety Rule Fields {#rule-fields}

The following fields may be available:

<table>
    <thead>
        <tr>
            <th>Field</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><em>Name</em></td>
            <td>Enter a name for the <em>Safety Rule</em>.</td>
        </tr>
        <tr>
            <td><em>Rule Priority</em></td>
            <td>
                <p>Enter this Rule's priority as a number between 1 and 100.</p>
                <p>The priority determines the execution order of the Rules in a Rule Set, starting with the smallest number first.</p>
                <p><div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: If you create one or more Rules with the same Priority, the Safety Rules Engine will execute them in the creation date order.</p>
    </div>
  </div>
</div>

</p>
            </td>
        </tr>
        <tr>
            <td><em>Evaluation Function</em></td>
            <td>Select <strong>Classify Case </strong>from the dropdown list.</td>
        </tr>
        <tr>
            <td><em>Execution Function</em></td>
            <td>Select <strong>Create Transmission</strong> from the dropdown list.</td>
        </tr>
        <tr>
            <td><a id="overridden-rule"></a><em>Overridden Rule</em></td>
            <td>If you selected a <a href="#base-rule-set">Base Rule Set</a> 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.
            <p>See the <a href="#rule-parameter">Parameter</a> field below for more information on modifying inherited Rule Parameters.</p></td>
        </tr>
        <tr>
            <td><em>Rule Status</em></td>
            <td>Select <strong>Active</strong>.
            <p>If you want to disable a rule without deleting it, select <strong>Inactive</strong>.</p></td>
        </tr>
    </tbody>
</table>

**Result**

Your custom _Safety Rule Set_ now contains a new _Safety Rule_.

### Add Safety Rule Parameters to a Safety Rule {#add-parameters}

Once you have created a new _Safety Rule_, add the required _Safety Rule Parameters_ for that rule as follows:

1. Navigate to the _Safety Rule_ you created in the previous step. In the **Rule Parameters** section, click **Create**.
2. Complete applicable [fields][11].
3. Select **Save**.
4. Repeat these steps to add all the _Safety Rule Parameters_ required for this rule.

### Safety Rule Parameter Fields {#parameter-fields}

The following fields may be available:

<table>
    <thead>
        <tr>
            <th>Field</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><a id="rule-parameter"></a><em>Parameter</em></td>
            <td>Select the required parameter from the dropdown list.
                <p>For a description of the available parameters, see <a href="/en/gr/01250/#reporting-rule-parameters">Reporting Rule Parameters</a>.</p>
                <p>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:</p>
                <ul>
                <li><strong>Due in Days</strong></li>
                <li><strong>Previously Submitted</strong></li>
                </ul>
                <p><strong>Rule Parameters from Overridden Rules</strong></p>
                <p>If the Rule for this Rule Parameter overrides a Base Rule Set (see <a href="#overridden-rule">Overridden Rule</a>), then any Rule Parameters you add to this Rule will be used in addition to the Rule Parameters of the selected Overridden Rule.</p>
                <p>Ensure you do not add Rule Parameters to your custom Rule that conflict with those of the Overridden Rule.
                </p>
                <p>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".</p>
                <p><a id="remove-overridden-rule-parameter"></a><strong>How to Remove an Overridden Rule Parameter</strong></p>
                <p>To remove a Rule Parameter inherited from an Overridden Rule, select that parameter from the dropdown list, then enter two (2) dashes (<code>--</code>) in the <strong>Value</strong> field.</p></td>
        </tr>
        <tr>
            <td><em>Value</em></td>
            <td>Enter the value for the selected parameter.
                <p>See <a href="/en/gr/01250/#reporting-rule-parameters">Reporting Rule Parameters</a> for help with specifying the value for a given parameter.</p>
                <p><div class="note-border alert-info">
  <div class="alert alert-info" role="alert">
    <div><i class="far fa-info-circle"></i></div>
    <div class="alert-text">
      <p><strong>Note</strong>: If the Value you entered is invalid for the selected Parameter, you will receive an error message when you save the <strong>Safety Rule Parameter</strong> record.</p>
    </div>
  </div>
</div>

</p>
            </td>
        </tr>
    </tbody>
</table>

**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 {#next}

Once you have created your custom _Safety Rule Set_, consider the following next steps:

1. Assign the rule set to an <a href="/en/gr/01256/#submission-rules">Agency</a> or <a href="/en/gr/01256/#distribution-rules">Reporting Family</a>.
2. Complete any remaining rule set configuration, such as a _Transmission Profile_. See <a href="/en/gr/01256/">Understand the Reporting Rules Engine</a> for more information.
3. Test your custom _Safety Rule Set_ to ensure your configuration is correct.

[1]: #about
[2]: #create-rule-set
[3]: #add-rule-set-parameters
[4]: #add-rules
[5]: #add-rule
[6]: #add-parameters
[7]: #next
[8]: #rule-set-fields
[9]: #rule-set-parameter-fields
[10]: #rule-fields
[11]: #parameter-fields