# Enable the Signal Alert Rule Engine

Learn how to configure your Vault to run the Signal Alert Rule Engine.

## About the Feature

With the 25R1 release, you can use the Signal Alert Rule Engine to determine whether a _Product-Event Combination_ (PEC) meets the criteria for a potential signal and requires further review. For signal detection, the Signal Alert Rule Engine runs predefined _Signal Alert Rule Sets_ and _Signal Alert Rules_ against _Statistical Data_ records.

After you have configured this feature, see the following resources for next steps:
* <a href="/en/lr/808068/">Manage Signal Product Profiles</a>
* <a href="/en/lr/808067/">Configure Signal Alerts</a>
* <a href="/en/lr/808066/">Run & Review Signal Alerts</a>

## Configure Object Layouts

Create new custom layouts and update the list layouts for the following objects:
* [_Signal Alert Rule_][1]
* [_Signal Alert Rule Set_][2]
* [_Signal Alert Rule Set Product Profile_][3]
* [_Signal Product Profile_][4]

You must also update the [_Signal Reporting Period_][5] object layout.

Navigate to **Admin > Configuration > Objects**.

### Configure the Signal Alert Rule Layout

Before creating the _Signal Alert Rule_ object layout, update the list layout:
1. Navigate to the **Signal Alert Rule Set** object and select the **List Layouts** tab.
2. Select **Reorder**.
3. Drag field names so the list layout appears in the following order:
    * _Signal Alert Rule Set_
    * _Signal Alert Rule Name_
    * _Description_
    * _Expression_
    * _Alert Category_
    * _API Name_
4. Select **Save**.

To create the _Signal Alert Rule_ object layout:
1. Select the **Layouts** tab.
2. Select **Create**.
3. In the _Add Layout_ dialog, enter a name for the layout in the **Layout Label** field, for example, `Signal Alert Rule Detail Page Layout`.
4. Select **Done**.
5. On the new object layout, add the following fields to the _Details_ section:
    * **Signal Alert Rule Set**
    * **Signal Alert Rule Name**
    * **Description**
    * **Expression**
    * **API Name**
6. Select **Save**.

### Configure the Signal Alert Rule Set Layout

Before creating the _Signal Alert Rule Set_ object layout, update the list layout:
1. Navigate to the **Signal Alert Rule Set** object and select the **List Layouts** tab.
2. Select **Reorder**.
3. Drag field names so the list layout appears in the following order:
    * _Signal Alert Rule Set Name_
    * _Description_
    * _API Name_
4. Select **Save**.

To create the _Signal Alert Rule Set_ object layout:
1. Select the **Layouts** tab.
2. Select **Create**.
3. In the _Add Layout_ dialog, enter a name for the layout in the **Layout Label** field, for example, `Signal Alert Rule Set Detail Page Layout`.
4. Select **Done**.
5. On the new object layout, in the _Details_ section, add the following fields:
    * **Signal Alert Rule Set Name**
    * **API Name**
6. Use the following table to <a href="/en/lr/26387/#how-to-add-sections">insert related object sections</a> and then select **Done**:

| Related Object                        | Section Label                   | Creation Option                |
| ------------------------------------- | ------------------------------- | ------------------------------ |
| _Signal Alert Rule_                     | `Signal Alert Rules`              | Create record in pop-up dialog |
| _Signal Alert Rule Set Product Profile_ | `Related Signal Product Profiles` | Prevent record addition        |

Optionally, <a href="/en/lr/26387/#how-to-edit-related-object-columns">edit the default columns</a>:

<table>
    <thead>
        <tr>
            <th>Section</th>
            <th>Default Columns</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><em>Signal Alert Rules</em></td>
            <td><ul>
                    <li><em>Signal Alert Rule Name</em></li>
                    <li><em>Description</em></li>
                    <li><em>Expression</em></li>
                    <li><em>Alert Category</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Related Signal Product Profiles</em></td>
            <td><ul>
                    <li><em>Name</em></li>
                    <li><em>Signal Product Profile > Product Family</em></li>
                    <li><em>Last Executed Date</em></li>
                </ul>
            </td>
        </tr>
    </tbody>
</table>

### Configure the Signal Alert Rule Set Product Profile Layout

To create the _Signal Alert Rule Set Product Profile_ object layout:
1. Navigate to the **Signal Alert Rule Set Product Profile** object and select the **Layouts** tab.
2. Select **Create**.
3. In the _Add Layout_ dialog, enter a name for the layout in the **Layout Label** field, for example, `Signal Alert Rule Set Product Profile Detail Page Layout`.
4. Select **Done**.
5. On the new object layout, add the following fields to the _Details_ section:
    * **Name**
    * **Signal Alert Rule Set**
    * **Signal Product Profile**
6. Select **Save**.

### Configure the Signal Product Profile Layout

Before creating the _Signal Product Profile_ object layout, configure the list layout:
1. Navigate to the **Signal Product Profile** object and select the **List Layouts** tab.
2. Select **Reorder**.
3. Drag field names so the list layout appears in the following order:
    * **Organization**
    * **Profile Name**
    * **Product Family**
    * **Source**
    * **Health Authority Database**
4. Select **Save**.

To create the _Signal Product Profile_ object layout:
1. Select the **Layouts** tab.
2. Select **Create**.
3. In the _Add Layout_ dialog, enter a name for the layout in the **Layout Label** field, for example, `Signal Product Profile Detail Page Layout`.
4. Select **Done**.
5. On the new object layout, add the following fields to the _Details_ section:
    * **Organization**
    * **Profile Name**
    * **Product Family**
    * **Source**
    * **Health Authority Database**
6. <a href="/en/lr/26387/#how-to-add-sections">Insert a related object section</a> with the following information:
    * **Related Object**: Signal Alert Rule Set Product Profile
    * **Section Label**: `Alert Rule Sets`
    * **Creation Option**: Create record in pop-up dialog
7. Select **Done**.
8. Optional: <a href="/en/lr/26387/#how-to-edit-related-object-columns">Edit the default columns</a> to display the following fields:
    * _Name_
    * _Signal Alert Rule Set_
    * _Signal Alert Rule Set > Description_
9. Select **Save**.

### Update the Signal Reporting Period Layout

To update the _Signal Reporting Period_ object layout:
1. Navigate to the **Signal Reporting Period** object and select the **Layouts** tab.
2. Select **Signal Reporting Period Page Layout**.
3. In the _Details_ section, add the **Signal Product Profile** field.
4. <a href="/en/lr/26387/#how-to-add-sections">Insert a related object section</a> with the following information:
    * **Related Object**: Statistical Data
    * **Section Label**: `Statistical Data`
    * **Creation Option**: Prevent record creation
5. Select **Done**.
6. Optional: <a href="/en/lr/26387/#how-to-edit-related-object-columns">Edit the default columns</a> to display the following fields:
    * _Statistical Data Unique Name_
    * _Product Family_
    * _MedDRA Term_
    * _Detection Date_
    * _Alert_
    * _Alert Category_
    * _Listed_ \
    Add additional default columns as needed.
7. Select **Save**.

## Update Fields on the Signal Alert Rule Set Object

On the _Signal Alert Rule Set_ object, update the _Frequency_ field to <a href="/en/lr/15057/#how-to-customize-standard-objects">clear the _Display in default lists and hovercards_ checkbox</a> as this field is inactive.

## Add the Run Signal Alerts Action to the Signal Reporting Period Object

<a href="/en/lr/43127/#assign-actions">Add the _Run Signal Alerts Runs_ action</a> to the _Signal Reporting Period_ object so users can manually run the Signal Alert Rule Engine. Leave the _Available in All Lifecycle States_ checkbox unselected.

## Configure Object Lifecycles

Navigate to **Admin > Configuration > Object Lifecycles** to update the following object lifecycles:
* [_Signal Reporting Period_][6]
* [_Statistical Data_][7]

### Update the Signal Reporting Period Lifecycle

Update the _Signal Reporting Period Lifecycle_ state types:
1. Navigate to the **Signal Reporting Period Lifecycle**.
2. In the _State Types_ section, use the table below to <a href="/en/lr/30683/#how-to-associate-an-object-state-type-with-a-state">associate a state type with the corresponding state</a>:

| State Type       | State       |
| ---------------- | ----------- |
| _Error State_    | _Error_     |
| _Initial State_  | _Active_    |
| _Ready State_    | _Ready_     |

The names of the _Signal Reporting Period Lifecycle_ states may differ in your Vault depending on your business needs.

Add the _Run Signal Alert Rules_ action to the _Signal Reporting Period Lifecycle_:
1. In the _States_ section, select the lifecycle state of the _Initial_ state type, for example, _Active_.
2. Beside the _User Actions_ section, select **Edit**.
3. Create the following rule
    * Always > Run Signal Alert Rules
        * **Action Label**: `Run Signal Alert Rules`
4. Select **Save**.

### Update the Statistical Data Lifecycle

Update the _Statistical Data Lifecycle_ state types:
1. Navigate to the **Statistical Data Lifecycle**.
2. Use the table below to <a href="/en/lr/30683/#how-to-associate-an-object-state-type-with-a-state">associate a state type with the corresponding state</a>:

| State Type       | State       |
| ---------------- | ----------- |
| _Complete State_ | _Complete_  |
| _Initial State_  | _Active_    |
| _Ready State_    | _Ready_     |

The names of the _Signal Reporting Period Lifecycle_ states may differ in your Vault depending on your business needs.

## Add the Signal Product Profile Tab

Add the _Signal Product Profile_ tab to the applicable <a href="/en/lr/542174/">tab collection</a>:
1. Navigate to **Admin > Configuration > Tab Collections > [Tab Collection]**.
2. In the desired tab collection, select **Add Tabs**.
3. In the _Available_ column, double-click or select _Signal Product Profile_ and use the left/right arrow buttons to add the tab to the _Selected_ column.
4. Select **Save**.
5. Optional: Select **Reorder** to reorder the tabs by dragging and dropping.

## Grant Permissions

Ensure your <a href="/en/lr/22824/#object-permissions">permission sets</a> are updated to grant the appropriate level of access for Admins and business users to objects, fields, and tabs according to your organization's process. Manage permissions from **Admin > Users & Groups > Permission Sets > [Permission Set]**.

### Admin & User Permissions

In the applicable permission sets, select the **Objects** tab and use the table below to grant permissions:

<table>
    <thead>
        <tr>
            <th>Permission Set</th>
            <th>Object</th>
            <th>Object Permissions</th>
            <th>Object Field Permissions</th>
            <th>Object Action/Control Permissions</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td rowspan="5">[Applicable Admin Permission Set]</td>
            <td><em>Signal Alert Rule Set</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Alert Rule</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Alert Rule Set Product Profile</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Product Profile</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Reporting Period</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant the <em>Run Signal Alert Rules</em> action the following permissions:
                <ul>
                    <li><em>View</em></li>
                    <li><em>Execute</em></li>
                </ul>
                Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td rowspan="5">[Applicable User Permission Set]</td>
            <td><em>Signal Alert Rule Set</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permission:
                <ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Alert Rule</em></td>
            <td>Optional:
                <ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Optional: Grant all fields the following permission:
                <ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Alert Rule Set Product Profile</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permission:
                <ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Product Profile</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permission:
                <ul>
                    <li><em>Read</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td><em>Signal Reporting Period</em></td>
            <td><ul>
                    <li><em>Read</em></li>
                    <li><em>Create</em></li>
                    <li><em>Edit</em></li>
                    <li><em>Delete</em></li>
                </ul>
            </td>
            <td>Grant all fields the following permissions:
                <ul>
                    <li><em>Read</em></li>
                    <li><em>Edit</em></li>
                </ul>
            </td>
            <td>Grant <em>All Object Controls</em> the following permission:
                <ul>
                    <li><em>View</em></li>
                </ul>
            </td>
        </tr>
    </tbody>
</table>

### Standard Tab Permissions

In the applicable permission sets, select the **Tabs** tab and grant _View_ permissions for the _Signal Product Profile_ tab.

[1]: #configure-the-signal-alert-rule-layout
[2]: #configure-the-signal-alert-rule-set-layout
[3]: #configure-the-signal-alert-rule-set-product-profile-layout
[4]: #configure-the-signal-product-profile-layout
[5]: #update-the-signal-reporting-period-layout
[6]: #update-the-signal-reporting-period-lifecycle
[7]: #update-the-statistical-data-lifecycle