# Enable PSMF Periodic Reviews

With the 23R2 release, SafetyDocs supports the automatic triggering of <a href="/en/gr/01241/">periodic reviews of PSMF content</a>. You can configure your Vault to detect documents or binders that are due for review and assign tasks to check if any updates need to be made. This feature provides an efficient way of ensuring your PSMF content is regularly reviewed and updated to maintain compliance.  

## 26R1 Update: PSMF Binder Periodic Reviews {#r261-update}

With the 26R1 release, SafetyDocs extends the PSMF periodic review functionality to include _PSMF Binders_. To configure this feature in your Vault, see [Configure PSMF Binder Periodic Reviews][18].

## Overview

To enable PSMF Periodic Reviews:
- [Configure object layouts][1]
- [Configure the _PSMF Coordination Actions_ permission set][4]
- [Create the _PSMF Periodic Review Workflow_][5]
- [Configure object lifecycles][6]
- [Configure Custom Sharing Rules on PSMF periodic review objects][15]
- [Configure the _PSMF Periodic Review_ job][16]

## Configure Layouts {#configure-layouts}

To configure object layouts, complete the following for the _PSMF Periodic Review_ and _PSMF Document Review_ objects:
1. <a href="/en/gr/26387/#save-as-layout">Copy</a> the standard layout and ensure it is <a href="/en/gr/26387/#object-type-layout">active</a>.
2. <a href="/en/gr/26387/#set-a-default-layout">Set the new custom layout as the default</a>.
3. <a href="/en/gr/26387/#delete-a-layout">Delete</a> any other existing custom layouts.

## Configure the PSMF Coordination Actions Permission Set {#psmf-coordination-actions-permissions}
Add security settings to grant access to the PSMF Periodic Review features. Use the following settings as a starting point, but configure access according to your business processes:
1. <a href="/en/gr/23647/#copy_permission_set">Copy</a> the standard _PSMF Coordination Actions_ permission set.
2. To manage <a href="/en/gr/22824/#tab-permissions">tab-level permissions</a>, grant _View_ access to the _Periodic Document Reviews_ tab.

## Add the PSMF Periodic Review Workflow {#psmf-periodic-review-workflow}

Create a workflow to manage PSMF periodic reviews. Use these steps as a starting point, but configure your workflow according to your business processes:

1. Navigate to **Admin > Configuration > Workflows**.
2. Select **Create**.
3. In the _Create Workflow_ window, select **Object Workflow**.
4. Select **Continue**.
5. On the _Create Workflow_ page, populate the fields as follows:
    * **Label**: Enter `PSMF Periodic Review Workflow`
    * **Lifecycle**: Select **PSMF Periodic Review Lifecycle**
6. Select **Save**.
7. In the _Workflow Steps_ section, configure the workflow to include the following steps in order:
    * _Start_ <a href="/en/gr/33550/#start">Start step</a>
    * _Add Role_ <a href="/en/gr/33550/#how-to-define-an-update-sharing-settings-step">Update Sharing Settings step</a>
    * _Task: Verify Selected Docs_ <a href="/en/gr/33550/#wftaskstep">Task step</a>
    * _SC: In Progress_ state change <a href="/en/gr/33550/#how-to-define-an-action-step">action step</a>
    * _Task: Coordinate Review_ <a href="/en/gr/33550/#wftaskstep">Task step</a>
    * _SC: Complete_ state change <a href="/en/gr/33550/#how-to-define-an-action-step">action step</a>
    * _End_ <a href="/en/gr/33550/#how-to-define-an-end-workflow-step">End step</a>
8. In the **Status** field, select **Make configuration active**.

<a href="https://platform.veevavault.help/assets/images/saf-23r1a-psmf-periodic-review-workflow.png" data-lightbox="saf-23r1a-psmf-periodic-review-workflow.png" data-title="PSMF Periodic Review Workflow" data-alt="PSMF Periodic Review Workflow">
  <img class="docimage" src="https://platform.veevavault.help/assets/images/saf-23r1a-psmf-periodic-review-workflow.png" alt="PSMF Periodic Review Workflow" style=""  />
</a>

## Configure Object Lifecycles {#configure-object-lifecycles}

Configure the following object lifecycles:
- [_PSMF Periodic Review Lifecycle_][7]
- [_PSMF Document Review Lifecycle_][8]

### Configure the PSMF Periodic Review Lifecycle {#psmf-periodic-review-lifecycle}

To configure the _PSMF Periodic Review Lifecycle_:

1. [Add the _PSMF Office_ role][9]
2. [Update role permissions][10]
3. [Add the _Start Revew_ user action to the _New_ state][11]
4. [Add entry criteria to the _Complete_ state][12] 

#### Add the PSMF Office Role {#psmf-office-role-periodic}

To add the _PSMF Office_ role:

1. Navigate to **Admin > Configuration > Object Lifecycles > PSMF Periodic Review Lifecycle**.
2. In the _Roles_ section, select the **Add Role** (<img class="inline" src="https://platform.veevavault.help/assets/images/saf-blue-square-add-button.png" alt="Add Role" style="" />) icon. 
3. In the _Search: Application Role_ window, select **PSMF Office**.
4. Select **OK**.

#### Update Role Permissions {#update-role-permissions-periodic}

<a href="/en/gr/36440/#edit-role-lifecycle-state-permissions">Edit</a> role permissions as follows:
* To the _Editor_ and _Owner_ roles, add permissions to lifecycle states as follows:
    * To the _New_ state, select **Read**, **Edit**, and **Delete**
    * To the _Inactive_ state, select **Read**, **Edit**, and **Delete**
    * To the _In Progress_ state, select **Read**
    * To the _Complete_ state, select **Read**
* To the _PSMF Office_ role, add permissions to lifecycle states as follows:
    * To the _New_ state, select **Read** and **Edit**
    * To the _Inactive_ state, select **Read** and **Edit**
    * To the _In Progress_ state, select **Read** and **Edit**
    * To the _Complete_ state, select **Read**
* To the _Viewer_ role, add **Read** permissions to all lifecycle states

#### Add Start Review User Action to the New State {#add-start-review-user-action}

To add the _Start Review_ user action to the _New_ state: 

1. In the _States_ section, select **New**.
2. In the _User Actions_ section, select **Edit**.
3. Select **Create Rule** and configure the rule as follows:
    - **Condition Type**: Select **Always**
    - **Allow the following actions**: Select **Workflow > PSMF Periodic Review**
    - **Action Label**: Enter `Start Review`
4. Select **Save**.

#### Add Entry Criteria to the Complete State {#complete-state-entry-criteria}

To add entry criteria to the _Complete_ state:

1. In the _States_ section, select **Complete**.
2. In the _Entry Criteria_ section, select **Edit**.
3. Select **Create Rule** and configure the rule as follows:
    * **Condition Type**: Select **Always**
    * **Validate that**: Select **State of Related Record > PSMF Document Reviews > All records equal > Complete**
4. Select **Save**.

### Configure the PSMF Document Review Lifecycle {#psmf-document-review-lifecycle}

To configure the _PSMF Document Review Lifecycle_:

1. [Add the _PSMF Office_ role][13]
2. [Update role permissions][14]

#### Add the PSMF Office Role {#psmf-office-role-document}

To add the _PSMF Office_ role:

1. Navigate to **Admin > Configuration > Object Lifecycles > PSMF Document Review Lifecycle**.
2. In the _Roles_ section, select the **Add Role** (<img class="inline" src="https://platform.veevavault.help/assets/images/saf-blue-square-add-button.png" alt="Add Role" style="" />) icon. 
3. In the _Search: Application Role_ window, select **PSMF Office**.
4. Select **OK**.

#### Update Role Permissions {#update-role-permissions-document}

<a href="/en/gr/36440/#edit-role-lifecycle-state-permissions">Edit</a> role permissions as follows:
* To the _Assigned To_ and _PSMF Office_ roles, add permissions to lifecycle states as follows:
    * To the _Complete_ state, select **Read**
    * To the _Open_ state, select **Read** and **Edit**
* To the _Editor_ and _Owner_ roles, add permissions to lifecycle states as follows:
    * To the _Complete_ state, select **Read**
    * To the _Open_ state, select **Read**, **Edit**, and **Delete**
* To the _Viewer_ role, add **Read** permissions to all lifecycle states

## Configure Custom Sharing Rules on PSMF Periodic Review Objects {#custom-sharing-rules}

To configure Custom Sharing Rules, complete the following for both the _PSMF Periodic Review_ and _PSMF Document Review_ objects:

1. Navigate to **Admin > Configuration > Objects > [Object]**.
2. Select **Edit**. 
3. Select the **Enable Custom Sharing Rules** checkbox, then select **Continue** and **Save**.
4. Navigate to the **Sharing Rules** tab and select **Create**. 
5. In the **Label** field, enter a name for your rule, then select **Save**.
6. In the _Roles_ section, select **Add**. 
7. In the _Add Manual Assignment_ window, populate the fields as follows, then select **Save**:
    * **Role**: Select **PSMF Office**
    * **Users and Groups**: Select **PSMF Coordination**

## Configure the PSMF Periodic Review Job {#configure-psmf-periodic-review-job}

To configure the _PSMF Periodic Review_ job:

1. Navigate to **Admin > Operations > Job Definitions > PSMF Periodic Review**.
2. Select **Edit**.
3. Complete the applicable [fields][17], then select **Save**.

Once configured, the _PSMF Periodic Review_ job runs monthly, automating review task assignment and allowing users to assess and update PSMF content as necessary. Each time the _PSMF Periodic Review_ job runs, if PSMF documents and binders are eligible for review, Vault <a href="/en/gr/01241/#psmf-periodic-review-job-process">creates a series of records and review tasks</a>.

### PSMF Periodic Review Job Fields {#psmf-periodic-review-job-fields}

<table>
    <thead>
        <tr>
            <th>Field</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><em>Job Owner</em></td>
            <td>Select the group in your organization that will be responsible for overseeing this job. This group will receive notifications for any errors encountered.</td>
        </tr>
         <tr>
            <td><em>Schedule</em></td>
            <td>This field is set to <em>Monthly</em> by default and cannot be modified.</td>
        </tr>
        <tr>
            <td><em>Repeat By</em></td>
            <td>Update the <strong>Repeat By</strong> value to define whether Vault runs this job on a specified day of the week or day of the month.</td>
        </tr>
        <tr>
            <td><em>Repeat On Day</em></td>
            <td>This field appears if you select <em>Day of Month</em> in the <em>Repeat By</em> field. Use the drop-down to select the day of the month on which Vault runs this job.</td>
        </tr>
        <tr>
            <td><em>Repeat On</em></td>
            <td>This field appears if you select <em>Day of the Week</em> in the <em>Repeat By</em> field. Use the drop-downs to select the day of the week on which Vault runs this job every month.</td>
        </tr>
        <tr>
            <td><em>Vault Time</em></td>
            <td>Use the drop-downs to define when on the selected day Vault runs this job.</td>
        </tr>
        <tr>
            <td><em>Status</em></td>
            <td>Select <strong>Active</strong> from the picklist to activate this job.</td>
        </tr>
    </tbody>
</table>

## (26R1) Configure PSMF Binder Periodic Reviews {#r261-configure}

To configure PSMF Binder Periodic Reviews:
- Under the _Pharmacovigilance System Master File_ document type, <a href="/en/gr/4884/#use-shared-field">assign</a> the following shared fields to the either the _PSMF Binder_ document subtype or the _PSMF Global Binder_ or _PSMF Local Binder_ document classification, depending on your organization's processes:
   - _Last Review Date_
   - _Review Frequency_
   - _Next Review Date_
- <a href="/en/gr/1535/#how-to-reorder-fields-in-sections">Reorder</a> these fields in the _PSMF Details_ field layout to the following order, below the _PSMF Annex_ field:
   - _Last Review Date_
   - _Review Frequency_
   - _Next Review Date_


[1]: #configure-layouts
[4]: #psmf-coordination-actions-permissions
[5]: #psmf-periodic-review-workflow
[6]: #configure-object-lifecycles
[7]: #psmf-periodic-review-lifecycle
[8]: #psmf-document-review-lifecycle
[9]: #psmf-office-role-periodic
[10]: #update-role-permissions-periodic
[11]: #add-start-review-user-action
[12]: #complete-state-entry-criteria
[13]: #psmf-office-role-document
[14]: #update-role-permissions-document
[15]: #custom-sharing-rules
[16]: #configure-psmf-periodic-review-job
[17]: #psmf-periodic-review-job-fields
[18]: #r261-configure