Source: https://vaultcrmhelp.veeva.com/doc/Content/CRM_topics/Multichannel/ConsentCapture/CCConfiguration.htm

## Configuring Consent Capture

In this topic you can find information on Consent Capture components as well as all the configuration steps you need to use Consent Capture out of the box.

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Components](#)

### Consent Header (consent\_header\_\_v)

Consent headers define the countries and languages for capturing consent along with other attributes required for advanced functionality. There can be multiple headers for one country, each for a different language, allowing end users to select the preferred language for an HCP. Switching languages displays translations of the consent text, disclaimer text, and consent lines.

Consent headers have 3 statuses:

* Active
* Inactive
* Staged

End users can view active consent headers. Business admins can view both staged and active consent headers.

Business admins cannot edit a consent header or create and edit related consent types and consent lines if the status of the consent header is Active. This prevents business admins from making changes while the consent header is in use.

There can only be one active consent header per country per language.

See [Creating Consent Headers](CreateManageConsent/CreateConsentHeader.htm) for more information about how to create and use consent headers.

### Consent Type (consent\_type\_\_v)

Consent types define the communication channels and the disclaimers or consent lines related to that consent channel. Each consent type is related to a consent header.

Customers can define custom object types for communication channels outside of Vault CRM, for example, SMS or portal. Every custom object type created on the consent\_type\_\_v object must have a corresponding custom object type on the multichannel\_consent\_\_v object.

See [Creating Consent Types](CreateManageConsent/CreateConsentType.htm) for more information about how to create and use consent types.

### Consent Line (consent\_line\_\_v)

Consent lines define the type of information a customer wants to send. Each consent line is related to a consent type.

There are 3 object types:

* Product
* Content Type — customer-defined categories of information which are not tied to products
* Sub Channel — temporary channels for consent types

See [Creating Consent Lines](CreateManageConsent/CreateConsentLine.htm) for more information about how to create and use consent lines.

### Multichannel Consent (multichannel\_consent\_\_v)

Multichannel consent records track consent activity. When a user captures consent, a multichannel consent record is created for each channel with consent changes, containing the consent type and consent line information for that channel.

Each object type on the multichannel\_consent\_\_v object must correspond to a object type on the consent\_type\_\_v object.

The following fields are always populated on multichannel consent records:

* Account
* Capture Datetime
* Opt Type

Other fields, including channel\_value\_\_v or sent\_email\_\_v, are only stamped if the values exist for the captured consent.

The multichannel\_consent\_\_v object can be populated using a data loader or other integrations. When data loading records, a trigger expires the corresponding current opt-in and opt-out records by stamping the date of the previous day in the opt\_expiration\_date\_\_v field. This prevents conflicts, for example, when the capture date of an opt-in record is the same as the expiration date of a opt-out record. If the consent line is populated for the current opt-in and opt-out records and matches the consent line populated in the data loaded records, only the matched records are expired. Otherwise, all current opt-in and opt-out records are expired. The date of the previous day is stamped in the opt\_expiration\_date\_\_v field of the record to expire it.

#### Data Loading Consent Records

The multichannel\_consent\_\_v object can be populated using a data loader or other integrations. Each multichannel\_consent\_\_v record requires the following values:

* object\_type\_\_v
* account\_\_v
* capture\_datetime\_\_v
* channel\_value\_\_v – In approved\_email\_\_v type records, this field references the associated email address
* opt\_type\_\_v – Can be either opt\_in\_\_v or opt\_out\_\_v
* optout\_event\_type\_\_v – Only required when opt\_type\_\_v is opt\_out\_\_v

When data loading consent records with Vault Loader, do not select No Triggers. Triggers are essential for the proper functioning of multichannel consent. They expire related existing records, ensuring only the new record is valid.

#### Examples of Consent Records

For example, an HCP opts in to receiving emails sent to exampleaddress@gmail.com. A multichannel\_consent\_\_v record with an object type of approved\_email\_\_v is created with the following fields:

* account\_\_v – References the HCP's account
* capture\_datetime\_\_v – The datetime when the HCP consented to receive emails
* channel\_value\_\_v – exampleaddress@gmail.com
* opt\_type\_\_v – opt\_in\_\_v
* optout\_event\_type\_\_v – The HCP did not opt out of emails, so this picklist is blank

Emails for all products can now be sent to the HCP at exampleaddress@gmail.com.

In another example, an HCP selects the Unsubscribe link in an email associated with Cholecap sent to his email address exampleaddress@gmail.com. A multichannel\_consent\_\_v record with an object type of approved\_email\_\_v is created with the following fields:

* account\_\_v – References the HCP's account
* capture\_datetime\_\_v – The datetime when the HCP submitted the unsubscribe request
* channel\_value\_\_v – exampleaddress@gmail.com
* opt\_type\_\_v – opt\_out\_\_v
* optout\_event\_type\_\_v – unsubscribed\_\_v
* product\_\_v – Cholecap

Validation prevents all Cholecap emails sent to the HCP using exampleaddress@gmail.com from sending until an end user captures opt-in consent from the HCP. Emails about other products can still be sent to exampleaddress@gmail.com.

### Configuring Consent Capture

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Approved Email Integration Users](#)

To configure Consent Capture for integration users:

1. Navigate to **Admin > Users & Groups > Permission Sets**.
2. Select the appropriate permission set.
3. Select the **Objects** tab.
4. Grant the following permissions:

   | Objects | Object Permissions | Object Types | Fields | Field Permission |
   | --- | --- | --- | --- | --- |
   | consent\_line\_\_v | CRED | content\_type\_\_v | * content\_type\_\_v * content\_type\_display\_name\_\_v | Edit |
   | content\_type\_\_v | CRED | content\_type\_\_v | n/a | n/a |
   | multichannel\_consent\_\_v | CRED | approved\_email\_\_v | content\_type\_\_v | Edit |

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Business Admin Users](#)

To configure Consent Capture for business admins:

1. Navigate to **Admin > Configuration > Objects > User > Layouts**.
2. Add the **consent\_admin\_\_v** checkbox to the appropriate user\_\_sys object layouts.
3. Navigate to **Business Admin > Objects > Users**.
4. Select the **Consent Admin** checkbox on the appropriate user\_\_sys records to allow the user to view and edit Staged consent\_header\_\_v records and related records.
5. Navigate to **Admin > Users & Groups > Permission Sets**.
6. Select the appropriate permission set.
7. Select the **Objects** tab.
8. Grant the following permissions:

   | Objects | Object Permissions | Object Types | Fields | Field Permissions |
   | --- | --- | --- | --- | --- |
   | account\_\_v | n/a | n/a | * language\_\_v * vcountry\_\_v | Read |
   | consent\_header\_\_v | CRED | consent\_header\_default\_\_v | * consent\_header\_help\_text\_\_v * consent\_header\_status\_\_v * country\_\_v * inactive\_datetime\_\_v * language\_\_v * name\_\_v * object\_type\_\_v * signature\_required\_on\_opt\_out\_\_v * status\_\_v * subscription\_option\_\_v | Edit |
   | consent\_type\_\_v | CRED | * approved\_email\_\_v * clm\_\_v * messaging\_\_v Grant object permission only for the object types corresponding to the consent channels for which end users are capturing consent. | * channel\_source\_v * consent\_expires\_in\_\_v * consent\_custom\_duration\_\_v * consent\_text\_required\_\_v * default\_consent\_type\_\_v * disclaimer\_text\_file\_\_v * display\_order\_\_v * object\_type\_\_v * product\_preference\_\_v * zvod\_consent\_default\_consent\_text\_file\_\_v | Edit |
   | consent\_line\_\_v | CRED | * content\_type\_\_v * product\_\_v * sub\_channel\_\_v | * content\_type\_\_v * content\_type\_display\_name\_\_v * display\_order\_\_v * end\_date\_\_v * group\_by\_\_v * object\_type\_\_v * product\_\_v * sub\_channel\_description\_\_v * sub\_channel\_display\_name\_\_v * sub\_channel\_key\_\_v * start\_date\_\_v | Edit |
   | content\_type\_\_v | CRED | content\_type\_\_v | * external\_id\_\_v * name\_\_v | Edit |
   | country\_\_v | CRED | country\_\_v | n/a | n/a |
   | multichannel\_consent\_\_v | CRED | * approved\_email\_\_v * messaging\_\_v | * capture\_datetime\_\_v * channel\_value\_\_v * consent\_line\_\_v * consent\_type\_\_v * content\_type\_\_v * default\_consent\_text\_file\_\_v * disclaimer\_text\_file\_\_v * object\_type\_\_v * opt\_type\_\_v * product\_\_v * signature\_\_v * sub\_channel\_key\_\_v | Edit |
   | user\_\_sys | n/a | n/a | consent\_admin\_\_v | Read |
   | vcountry\_\_v | CRED | vcountry\_\_v | * alpha\_2\_code\_\_v * country\_name\_\_v | Edit |
9. Navigate to **Admin > Users & Groups > Permission Sets**.
10. Select the appropriate permission set.
11. Navigate to **Objects > Consent Type**.
12. Grant **View** permission to the following object controls on the consent\_type\_\_v object for all object types:
    * Consent Line
    * Signature Capture
13. Select the **Pages** tab.
14. Grant View permission to the **CRM PL3 Generic Page**.
15. Navigate to **Admin > Configuration > Objects > Account > Object Types**.
16. Enable the **Consent Capture** (consent\_capture\_action\_\_v) action for the appropriate object types.
17. Navigate to **Admin > Configuration > Objects > Consent Header > Layouts**.
18. Ensure a layout for the **consent\_header\_default\_\_v** object type on the consent\_header\_\_v object exists.
19. Add the following fields to the **consent\_header\_default\_\_v** object type layout:
    * consent\_header\_help\_text\_\_v
    * consent\_header\_status\_\_v
    * country\_\_v
    * inactive\_datetime\_\_v
    * language\_\_v
    * signature\_required\_on\_opt\_out\_\_v
    * subscription\_option\_\_v
20. Add the **Consent Types** related object section to the consent\_header\_default\_\_v layout.
21. Navigate to **Admin > Configuration > Objects > Consent Type > Layouts**.
22. Ensure a layout for each object type on the consent\_type\_\_v object exists.
23. Add the following fields to the layouts for the appropriate consent\_type\_\_v object types:
    * consent\_custom\_duration\_\_v
    * consent\_text\_required\_\_v
    * zvod\_consent\_default\_consent\_text\_file\_\_v
24. Add the **Consent Lines** related object section to the layouts for the appropriate consent\_type\_\_v object types.
25. Add the following object controls to the layouts for the appropriate consent\_type\_\_v object types:
    * Consent Line
    * Signature Capture
26. Ensure the **consent\_type\_\_v** layouts are 1-column. This determines the order in which the fields display when confirming consent changes.
27. Navigate to **Admin > Configuration > Objects > Content Type > Layouts**.
28. Add the following fields to the layout for the **content\_type\_\_v** object type on the consent\_line\_\_v object:
    * content\_type\_\_v
    * content\_type\_display\_name\_\_v
29. Add the **external\_id\_\_v** field to the content\_type\_\_v object layout.
30. Navigate to **Admin > Configuration > Objects > Multichannel Consent > Layouts**.
31. Add the following fields to the appropriate **multichannel\_consent\_\_v** layout:
    * channel\_value\_\_v
    * consent\_line\_\_v
    * default\_consent\_text\_file\_\_v
    * consent\_type\_\_v
    * content\_type\_\_v
    * disclaimer\_text\_file\_\_v
    * id
    * opt\_type\_\_v
    * product\_\_v
    * signature\_\_v
    * sub\_channel\_key\_\_v

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)End Users](#)

To configure Consent Capture for end users:

Users must be fully configured to view the Consent Summary screen and accurately capture consent.

1. Assign the [Consent Capture End User Permission Set](../../PermissionSets.htm#CCEndUser) to the appropriate security profiles, or perform the following steps:
   * Navigate to **Admin > Users & Groups > Permission Sets**
   * Select the appropriate permission set
   * Select the **Application** tab
   * Grant **Access** permission for File Staging in the Vault Actions section
   * Select the **Objects** tab
   * Grant the following permissions:

     | Objects | OLS | Object Types | Fields | FLS |
     | --- | --- | --- | --- | --- |
     | account\_\_v | R | n/a | + created\_by\_\_v + created\_date\_\_v + modified\_by\_\_v + modified\_date\_\_v + language\_\_v + vcountry\_\_v | Read |
     | consent\_header\_\_v | R | consent\_header\_default\_\_v | + approved\_email\_consent\_level\_\_v + created\_by\_\_v + created\_date\_\_v + consent\_header\_help\_text\_\_v + consent\_header\_status\_\_v + country\_\_v + custom\_list\_unsubscribe\_header\_\_v + inactive\_datetime\_\_v + language\_\_v + modified\_by\_\_v + modified\_date\_\_v + name\_\_v + object\_type\_\_v + ownerid\_\_v + signature\_required\_on\_opt\_out\_\_v + status\_\_v + subscription\_option\_\_v | Read |
     | consent\_line\_\_v | RE | + content\_type\_\_v + product\_\_v + sub\_channel\_\_v | + consent\_type\_\_v + content\_type\_\_v + created\_by\_\_v + created\_date\_\_v + detail\_group\_\_v + detail\_group\_display\_name\_\_v + content\_type\_display\_name\_\_v + display\_order\_\_v + end\_date\_\_v + group\_by\_\_v + modified\_by\_\_v + modified\_date\_\_v + product\_\_v + product\_display\_name\_\_v + sub\_channel\_description\_\_v + sub\_channel\_display\_name\_\_v + sub\_channel\_key\_\_v + start\_date\_\_v | Read |
     | consent\_type\_\_v | R | + approved\_email\_\_v + clm\_\_v + messaging\_\_v Grant object permission only for the object types corresponding to the consent channels for which end users are capturing consent. | + channel\_label\_\_v + channel\_source\_v + consent\_header\_\_v + consent\_expires\_in\_\_v + consent\_custom\_duration\_\_v + consent\_text\_required\_\_v + created\_by\_\_v + created\_date\_\_v + default\_consent\_type\_\_v + disclaimer\_text\_file\_\_v + display\_order\_\_v + modified\_by\_\_v + modified\_date\_\_v + product\_preference\_\_v + zvod\_consent\_default\_consent\_text\_file\_\_v To make the zvod\_consent\_default\_consent\_text\_file\_\_v field required, end users must have Read field permission to the consent\_text\_required\_\_v field and the consent\_text\_required\_\_v field must be selected on the appropriate consent\_type\_\_v record. | Read |
     | content\_type\_\_v | R | content\_type\_\_v | + created\_by\_\_v + created\_date\_\_v + external\_id\_\_v + modified\_by\_\_v + modified\_date\_\_v + name\_\_v + ownerid\_\_v | Read |
     | multichannel\_consent\_\_v | CRE | + approved\_email\_\_v + messaging\_\_v | + account\_\_v + capture\_datetime\_\_v + channel\_source\_\_v + channel\_value\_\_v + consent\_header\_\_v + consent\_line\_\_v + consent\_type\_\_v + content\_type\_\_v + created\_by\_\_v + created\_date\_\_v + default\_consent\_text\_file\_\_v + detail\_group\_\_v + disclaimer\_text\_file\_\_v + last\_device\_\_v + mobile\_id\_\_v + modified\_by\_\_v + modified\_date\_\_v + object\_type\_\_v + optout\_event\_type\_\_v + opt\_expiration\_date\_\_v + opt\_type\_\_v + product\_\_v + signature\_\_v + signature\_data\_\_v + signature\_datetime\_\_v + signature\_id\_\_v + sub\_channel\_key\_\_v | Edit |
     | user\_\_sys | R | n/a | + consent\_admin\_\_v + created\_by\_\_v + created\_date\_\_v + modified\_by\_\_v + modified\_date\_\_v | Read |
     | vcountry\_\_v | R | vcountry\_\_v | + alpha\_2\_code\_\_v + country\_name\_\_v + created\_by\_\_v + created\_date\_\_v + modified\_by\_\_v + modified\_date\_\_v + ownerid\_\_v | Read |
   * Navigate to **Objects > Account > Actions**
   * Grant **Execute** permission to the Consent Capture action
   * Navigate to **Objects > Consent Type**
   * Grant **View** access to the following object controls appropriate consent\_type\_\_v object types:
     + Consent Line
     + Signature Capture
   * Select the **Pages** tab
   * Grant View permission to the **CRM PL3 Generic Page**
2. Navigate to **Business Admin > Objects > VMobile Object Configurations**.
3. Enable **Full Sync VMOCs** for the appropriate platforms for the following objects:
   * consent\_header\_\_v
   * consent\_type\_\_v
   * consent\_line\_\_v
   * content\_type\_\_v
   * country\_\_v
   * multichannel\_consent\_\_v
   * vcountry\_\_v

Admins should not add the Multichannel Consents related object section to account\_\_v layouts. This prevents end users from editing multichannel\_consent\_\_v records via the related object section. End users can view an account's consent for channels from the Consent Summary screen.

### Related Topics

[Consent Capture Overview](CCOverview.htm)

[Creating Consent Headers](CreateManageConsent/CreateConsentHeader.htm)

[Creating Consent Lines](CreateManageConsent/CreateConsentLine.htm)