**Source URL:** https://regulatory.veevavault.help/en/lr/77855/index.md

# Configuring Content Plan Synchronization

Users managing global content plans at an organization's headquarters can leverage Vault's content plan synchronization capability to incrementally dispatch _Global Content Plans_ as sections are finalized, allowing local affiliates to review and accept or reject the changes Vault will make to the market-specific _Submission Content Plan_ as a result of the dispatch.

This method supplements Vault's existing content plan dispatching capability: While users can still dispatch a source _Global Content Plan_ in its entirety from an _Event_, incremental dispatching reduces overall effort in synchronizing the source content plan with the target _Submission Content Plan_ as headquarters users update the source with new records and documents over time.

To support the review and synchronization, Vault generates a snapshot of the differences between what's been dispatched from the source global plan and the target submission plans, then makes them available for review in a comparison viewer. Selections in the Comparison Viewer are saved across multiple users to facilitate collaboration. The Comparison can only be reviewed by one user at a time, but each successive user that accesses the Comparison can see the selections, deselections, and manually mapped documents from the users who previously accessed the comparison. Changes are synchronized to the target Content Plan based on the selections that are present in the Comparison viewer at the time the Comparison review is completed. Users can also use the comparison viewer to review, accept, and reject proposed document additions or updates when dispatching global content plans across templates.

You can also configure Vault to generate Active Dossier records from a Global Content Plan dispatch. See [Active Dossier Configuration](/en/lr/71560/#configuring-active-dossier-generation-from-global-content-plan-dispatch) for more information.



<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>: This feature is available in Vaults licensed with both RIM Submissions and RIM Registrations and requires you to first <a href="/en/lr/77854/">configure global content planning</a>.</p>
    </div>
  </div>
</div>



## Configuration Overview

1. [Configure](/en/lr/77854/) your Vault to support Global Content Plans.
2. [Configure][1] the _Dispatch Global Content Plan_ and _Review Comparison_ actions.
3. [Configure][2] object fields and object page layouts.
4. [Update][4] your Vault's security configurations to allow users to access the feature and receive the _Comparison Ready_ notification.
  * Ensure users have the required Document Set Assignment permissions and access to Document Set and Document Set Content Plan Item objects to use Include Document Sets during Copy Into.
5. Enable the **Enable Content Plan Comparison** setting, then populate at least one _Content Plan_ **Lifecycle State** in which Vault will generate a dispatch comparison. The states you select should correspond to the _Content Plan_ object lifecycle states configured to use the _Dispatch Global Content Plan_ action in Step 2.
6. [Create][5] _Content Plan Item Template Mapping_ records to map _Global Content Plan Templates_ to market-specific _Content Plan Templates_.
  * Configure the new _Unique Across Events_ field settings for supported *Event* relationship RimObjectConfig records to support Event relationship matching during GCP-to-GCP Copy Into operations.
7. Recommended: In the _Dispatch Content Plan Results_ (`dispatch_cp_results__v`) notification template, update the label preceding the `${dispatchSubGroupings}` token to include dispatching to both Document Sets and Countries, for example "Dispatched to:".
8. Optional: [Configure](/en/lr/71560/#configuring-active-dossier-generation-from-global-content-plan-dispatch) Vault to generate [Active Dossier](/en/lr/71782/) records from a [Global Content Plan dispatch](/en/lr/77853/).



<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>: <a id="manufacturing-site-role-note"></a>The <em>Enable Global to Local Manufacturing Site Role Mapping</em> setting and related <em>Manufacturing Site Role</em> Constraints are not supported when <a href="/en/lr/77853/">dispatching</a> a global content plan. For content plans, we recommend that the <em>Submission</em> and <em>Event</em> relationships used for content planning have a blank <em>Manufacturing Site Role</em>. We also recommend using separate records for Content Planning/Publishing versus Registrations.</p>
    </div>
  </div>
</div>



## Configuring Object Actions {#configuring-object-actions}

To allow users to dispatch from the content plan and review comparisons:

1. [Assign](/en/lr/32857/#user-actions) the _Review Comparison_ action to all relevant _Submission_ object types.
2. In the _Content Plan_ object lifecycle, [define](/en/lr/59885/#define-actions) a user action for the _Dispatch Global Content Plan_ system action within the relevant lifecycle states. We recommend creating the user action with a matching label (_Dispatch Global Content Plan_) within the _Draft_ and _Baselined_ states. To determine whether to select the _Ignore Content Plan Template Constraints_, _Copy Relationships_, and _Validate Matched Documents are Locked_ configuration options, see [Configuring Global Content Plans](/en/lr/77854/#additional-configuration-options).
3. Recommended: Define a [conditional user action](/en/lr/59885/#conditions) for the _Dispatch Global Content Plan_ action with the _Dispatch Documents Only_ option selected to dispatch documents only for _Module 1_ (or other administrative documents module) content plan sections. Update existing _Dispatch Global Content Plan_ user actions with the _Dispatch Documents Only_ option deselected for _Modules 2_ through _5_.

### About the Dispatch Documents Only Option {#dispatch-documents-only}

When dispatching a _Global Content Plan_ to a _Submission_ that uses the same _Content Plan Template_ as the _Global Content Plan_, Vault dispatches both the documents and the structure by default. The _Dispatch Documents Only_ option allows you to create a _Dispatch Global Content Plan_ user action that prompts Vault to dispatch only documents during the dispatch process and ignore the content plan structure, even when the _Global Content Plan_ uses the same _Content Plan Template_ as the target _Submission_. 

When dispatch is initiated by a user action with _Dispatch Documents Only_ enabled, Vault dispatches documents matched to Global _Content Plan Items_ with a blank _Lead Market_, with a _Lead Market_ that matches the target _Application's Lead Market_, or with a _Lead Market_ that matches the target _Submission's Lead Market_.

The _Dispatch Documents Only_ option is useful when you want to dispatch documents only to a specific _Content Plan Section_ (such as _Module 1_ or another administrative module) without updating the section structure if the structure varies between regions.

## Configuring Object Fields & Page Layouts {#configuring-object-fields-and-page-layouts}

To allow users to access _Dispatch Message_ record details and actions, add a [related object section](/en/lr/26387/#related-object) for the _Dispatch Message_ object to the _Event_ and _Activity_ object page layouts.

Additionally, within the _Content Plan_ object, update the _Copied From_ (`copied_from__v`) field to include the _Do not copy this field in Copy Record_ option.

For dispatching _Global Content Plans_ across templates, add the indicated fields to the following object page layouts:
* Content Plan Template (`edl_template__v`): Add Root Content Plan Template (`root_content_plan_template__v`)
* Content Plan Item Template (`edl_item_template__v`): Add Root Content Plan Template (`root_content_plan_template__v`)
* Dispatch Message (`dispatch_message__v`): Add Document Only Dispatch (`document_only_dispatch__v`), Target Content Plan Template (`target_content_plan_template__v`), and Number of Unmapped Documents (`number_of_unmapped_documents__v`)

After adding the above fields, we recommend populating the _Root Content Plan Template_ (`root_content_plan_template__v`) field on existing _Content Plan Template_ and _Content Plan Item Template_ records. 

### About the Mandatory for Dispatch Acceptance Field {#about-the-mandatory-for-dispatch-acceptance-field}

The _Mandatory for Dispatch Acceptance_ field is available for configuration in the following objects and select object types:
  * _Content Plan_
  * _Content Plan Item_
  * _Content Plan Template_
  * _Content Plan Item Template_

When this checkbox field is populated (true), Vault requires the change for the row to be applied when the _Accept_ verdict is selected in the comparison viewer. This means that the user cannot deselect rows where the record is marked as mandatory:
  * When a _Content Plan_ record is mandatory, only that specific row is mandatory (cannot be deselected) in the comparison viewer.
  * When a _Content Plan Item_ record is mandatory, that specific row and its matched documents are mandatory (cannot be deselected) in the comparison viewer.
  * When a document for a mandatory _Content Plan Item_ is dispatched but cannot be automatically matched to a target _Content Plan Item_, the user must [manually match the document](/en/lr/77853/#matching-unmapped-documents) to a target _Content Plan Item_ in the comparison viewer before accepting the changes.

To mark a record as mandatory, you can:
  * Add the _Mandatory for Dispatch Acceptance_ column to the content plan grid view, then use inline editing to select the checkbox in individual records.
  * Update the _Mandatory Dispatch Acceptance_ field via bulk action.

To allow users to set the field value as new records are created, you can also add the field to the page layouts of all listed objects and their applicable object types.

## Configuring Permissions {#configuring-permissions}
The sections below describe the minimum permissions required for users to synchronize and dispatch content plans.

### Document Permissions

Generally, to dispatch and review comparisons, users must be assigned to a document role with *View Document* and *View Content* permission for any document types matched to *Content Plan Items*.

### Object, Page & Application Permissions

The permissions described below are located in the **Objects**, **Pages**, or **Application** Permission Set tabs. 

For objects, you can also set these by clicking on the object and making selections under the **Object Permissions** heading.

| Object or Page | Permission Label(s) | Controls |
|---|---|---|
| Content Plan, plus applicable object types | Read, Create, Edit | Ability for the synchronization to add or update records in the Submission Content Plan. |
| Content Plan Item, plus applicable object types | Read, Create, Edit | Ability for the synchronization to add or update records in the Submission Content Plan. |
| Dispatch Message | Read | Ability to access records for regenerating comparisons and tracking and troubleshooting dispatches. |
| Dispatch Message Content Plans | Read | Ability to access records for regenerating comparisons and tracking and troubleshooting dispatches. |
| Pages: EDL Comparison Viewer | View | Ability to view the EDL Comparison Viewer page. |
| Application: EDL Matching | Edit Document Matches | Ability to edit the relationship between a document and its matching record. This ability is supported by additional configuration in the Content Plan Item object lifecycle. See [Object Actions for Document Matching][7] and [Object Lifecycle Atomic Security][8]. |

### Object Actions

The permissions described below are located in the Permission Set tab **Objects > [Object] > Object Action Permissions**.

| Object | Action | Permission | Controls |
|---|---|---|---|
| Content Plan | Dispatch Global Content Plan | Execute | Ability to dispatch content plans. |
| Dispatch Message | Review Comparison | Execute | Ability to run the action and view all items in the generated comparison. <br>**Note**: With this permission, users can view all items in the comparison. Separate object and field permissions are required to apply updates in a comparison. |
| Dispatch Message | Regenerate Comparison | Execute | Ability to regenerate a comparison from a Dispatch Message record. |
| Submission | Review Comparison | Execute | Ability to run the action and view all items in the generated comparison. <br>**Note**: With this permission, users can see all items in the comparison. Separate object and field permissions are required to apply updates in a comparison. |

#### Object Actions for Document Matching {#object-actions-for-doc-matching}

 When the comparison process results in an update to matched documents during synchronization, the user who confirms the comparison must have a corresponding permission to do so. For example, when Vault replaces a document during synchronization, the initiating user must have *Add Document* and *Remove Document* object action permission.

A user's permission set must include *Execute* permission for the below actions to work with matched documents during comparison and synchronization:

* Add Document
* Exclude Document
* Include Document
* Lock Version
* Remove Document


### Object Fields

The object fields listed below are minimally required to participate in content plan dispatch and synchronization. 

The permissions described are located in the permission set tab **Objects > [Object] > Object Field Permissions**.

| Object | Field | Permission Label | Controls |
|---|---|---|---|
| Content Plan, plus applicable object types | Primary Submission | Read | Ability to dispatch Content Plans. |
| Content Plan, plus applicable object types | Any editable fields to be updated during comparison | Create, Edit | Ability to apply changes to Content Plan fields during dispatch comparison. |
| Content Plan Item, plus applicable object types | Any editable fields to be updated during comparison | Create, Edit | Ability to apply changes to Content Plan Item fields during dispatch comparison. |
| Event | Global Content Plan | Read | Ability to dispatch Content Plans. |
| Event | Global Submission | Read | Ability to dispatch Content Plans. |

### Object Lifecycle Atomic Security {#lc-atomic-security}

Review your Vault's [Atomic Security configuration](/en/lr/68399/) in the _Content Plan_ and _Submission_ object lifecycles. If your organization uses Application Role overrides to secure any action or field listed in the sections above, users must be assigned an Application Role with _Execute_ access to that action. Otherwise, the default behavior must be set to _Execute_.

### Dynamic Access Control & the Submission Owner Application Role {#dac-and-the-submission-owner-application-role}

When Dynamic Access Control is configured, you can assign users to the _Submission Owner_ Application Role, to allow Vault to notify local affiliates when the _Submission Content Plan_ is initially created from dispatch and when a comparison is ready for review for a submission. This notification is sent to all users and user groups in the _Submission Owner_ role on the Submission's _Application_ as well as those on the Submission itself. Your organization may choose to implement the role assignment to receive the notification at only the _Application_ level, at the more granular _Submission_ level, or at both the _Application_ and _Submission_ levels.

To do this:

* Enable [Custom Sharing Rules](/en/lr/25494/) and/or [Matching Sharing Rules](/en/lr/36122/) for the _Application_ object, enabling Dynamic Access Control. You can also do this for the _Submission_ object. Dynamic Access Control must be enabled for the object in order to assign user roles and populate them in the object record's Sharing Settings. If your Vault already has Dynamic Access Control configured for the _Application_ object, you can skip this step.
    * If your organization does not want to fully configure Dynamic Access Control rules and is only planning to use it for the purpose of receiving _Comparison Ready_ notifications, we recommend configuring Custom Sharing Rules. Then, create a rule with blank rule criteria and add _All Internal Users_ into the _Editor_ role. This allows all users to be able to maintain their existing _Application_ object permissions as defined in their permission set. Otherwise, if no rule is created and Dynamic Access Control is enabled on the object, then users will not have access to any existing records by default.
* Optional: Identify the users or user groups who should receive notification that a comparison is ready for review for the _Applications_. Then, set up Custom or Matching Sharing Rules to assign users/groups into the _Submission Owner_ role. If using Matching Sharing Rules, you may opt to [create](/en/lr/69197/#assigning) _User Role Setup_ records to assign users into the _Submission Owner_ role.

If your Vault does not use Dynamic Access Control to automatically assign users or user groups to the _Submission Owner_ role on _Application_ or _Submission_ records, you can assign users and groups to the _Submission Owner_ role manually on existing _Application_ and _Submission_ records in bulk using the <a class="external-link " href="https://developer.veevavault.com/api/23.1/#assign-users-amp-groups-to-roles-on-object-records" target="_blank" rel="noopener">Assign Users & Groups to Roles on Object Records Vault API<i class="fa fa-external-link" aria-hidden="true"></i></a>.

## Creating Content Plan Item Template Mappings {#create-mappings}

The _Content Plan Item Template Mappings_ (`content_plan_item_template_mappings__v`) object allows you to map global content plan templates to market-specific templates. When dispatching a _Global Content Plan_ to a _Submission Content Plan_ that uses a different template, Vault uses _Content Plan Item Template Mappings_ records to determine the source items for dispatched documents. See [Dispatching & Synchronizing Content Plans](/en/lr/77853/#how-vault-dispatches-content-plans) for more information about how Vault dispatches global content plans across templates.

To create a _Content Plan Item Template Mappings_ record:

1.  Navigate to **Business Admin > Objects > Content Plan Item Template Mappings** (`content_plan_item_template_mappings__v`).
2.  Click **Create** and enter the following information:
    * **Source Content Plan Template Root**: The root template of the source _Global Content Plan_.
    * **Source Content Plan Template Section**: The template section within the selected _Source Content Plan Template Root_.
    * **Source Content Plan Item Template**: The item template within the selected _Source Content Plan Template Section_.
    * **Target Content Plan Template Root**: The root template of the target _Submission Content Plan_.
    * **Target Content Plan Template Section**: The template section within the selected _Target Content Plan Template Root_.
    * **Target Content Plan Item Template**: The item template within the selected _Target Content Plan Template Section_ that you want to map to the selected _Source Content Plan Item Template_.
3.  By default, the _Status_ for the mapping is _Active_. Select **Inactive** as the **Status** if you want to create the mapping as _Inactive_. 
4.  Click **Save** or **Save + Create**.
    
Complete the above steps for each additional _Content Plan Item Template Mappings_ record.

[1]: #configuring-object-actions
[2]: #configuring-object-fields-and-page-layouts
[3]: #about-the-mandatory-for-dispatch-acceptance-field
[4]: #configuring-permissions
[5]: #create-mappings
[6]: #dispatch-documents-only
[7]: #object-actions-for-doc-matching
[8]: #lc-atomic-security