**Source URL:** https://regulatoryone.veevavault.help/en/gr/523453/index.md

# Configuring Comments (Veeva Claims)

<a href="/en/gr/54331/">Veeva Claims</a> provides users with the ability to <a href="/en/gr/520894/">add comments to certain object records</a>, capturing key discussions and decisions about a specific record. You can configure your Vault to allow single comments for any object record as well as bulk comments for multiple _Claims_, _Local Adaptations_, and _Projects_. You can also configure your Vault to allow users to reply to comments in comment threads for _Claims_, _Projects_, _Local Adaptations_, and _Pack Copies_. Users can edit and delete any comments they create and search comments for specific text, including text in comment threads. Users can also mention other active users in comments, and the mentioned users will receive email and Vault notifications. User mentions in comments are not included in <a href="/en/gr/2157/">Vault Summary Emails</a>, if configured. Users can edit and delete only the comments they have created but cannot delete any comments with replies.

## Configuration Overview {#overview}

Configuring your Vault to support comments involves the following steps:

1. [Configure comments on _Claims_ and _Projects_][7] with the option to support replies in [comment threads][2]
2. [Configure comments on objects][5] (applies to all objects except _Claims_ and _Projects_) with the option to support replies in comment threads for _Local Adaptations_ and _Pack Copies_
3. [Configure bulk comments for _Claims_, _Local Adaptations_, and _Projects_][4]
4. [Configure notification templates][16]
5. [Configure user permissions][15]

<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>: Depending on your Vault’s creation date and which features are currently enabled and configured, some of the steps described in this article may be unavailable or already complete in your Vault.</p>
    </div>
  </div>
</div>



## Configuring Comments on Claims & Projects {#c-p-comments}

You can configure your Vault to allow comments on _Claims_ and _Projects_ and to [reply to comment threads][2] on the _Claim_ and _Project_ objects.

<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>: Configuring comments for the <em>Claim</em> and <em>Project</em> objects differs from configuring <a href="#object-comments">comments</a> for other objects.</p>
    </div>
  </div>
</div>



### Configuring Object Layouts {#c-p-layouts}

You can configure the _Claim_ and _Project_ <a href="/en/gr/26387/">object's layouts</a> to support comments, either [with][2] or [without][3] the ability for users to reply to comment threads. Do not configure both options for either object.

#### Comments With Comment Threads {#c-p-with-threads}

To allow users to reply to comment threads on _Claims_ and _Projects_, you must configure the _Claim_ and _Project_ object layouts so users can add and reply to comments on individual _Claims_ and _Projects_. 

To configure layouts for comment threads:

1. Navigate to **Admin > Configuration > Objects > [Object] > Layouts > [Layout]**.
2. Insert the _Comments_ control section with the slider (<img class="inline" src="https://platform.veevavault.help/assets/images/CPC-Icon-Slider.png" alt="Slider Icon" style="" />) icon to the object layout.
3. In the _Add Comments_ dialog, you can make the following changes:
  * Optional: Change the **Section Label**.
  * Optional: In the **Show the section only in these lifecycle states** field, select one (1) or more lifecycle states. This option only appears if the object uses a <a href="/en/gr/29798/">lifecycle</a>.
  * Optional: Enter **Section Help** content to provide the user with any relevant information. Help content appears below the section label.
  * Optional: Select the **Expand the section by default** checkbox so that the section is always open when users open the records.
  * Optional: Change the default **Sort Order** of top-level root comments:
        * **Sort by Created**: Ordered by latest creation date.
        * **Sort by Activity**: Ordered by latest reply and, for comments without replies, by creation date.
4. Click **Done**.

This configuration displays up to 500 comments for a specific record. If your business needs require more than 500 comments, we recommend configuring comments [without comment threads][3]. If you have previously configured the object's layout to include a related object section with the _Claim Comment_ or _Project Comment_ object, remove that section from the layout.

When a user adds the first reply to a _Claim Comment_ or _Project Comment_, Vault generates a new _Claim Thread_ or _Project Thread_ that groups all _Claim Comment_ or _Project Comment_ replies to the root _Claim Comment_ or _Project Comment_ to which the user replied. _Claim Threads_ and _Project Threads_ are system-managed and cannot be modified.

#### Comments Without Comment Threads {#c-p-without-threads}

You must configure the _Claim_ and _Project_ object layouts so users can add comments to _Claims_ and _Projects_. This configuration does not allow users to reply to comments. To do this:

* Insert the _Claim Comment_ related object section to the _Claim_ object layout.
* Insert the _Project Comment_ related object section to the _Project_ object layout.

If you have previously configured either object's layout to include the _Comments_ control section with the slider (<img class="inline" src="https://platform.veevavault.help/assets/images/CPC-Icon-Slider.png" alt="Slider Icon" style="" />) icon, remove that section from the layout.

## Configuring Comments on Objects {#object-comments}

You can configure objects in your Vault to allow comments on any standard (`__v`) or custom (`__c`) object. You can also configure your Vault to allow users to reply to comment threads on the _Local Adaptation_ and _Pack Copy_ objects. To support comments on objects, you must [configure objects][8], [define comment settings][11], and [configure object layouts][12].

<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>: Configuring comments for the <a href="#c-p-comments">Claims_ and <em>Project</em> objects</a> differs from the configuration described in this section.</p>
    </div>
  </div>
</div>



### Configuring Objects {#configure-objects}

You must configure the [_Comment_][9] object to support comments on objects. To allow users to reply to comment threads on the _Pack Copy_ object, you must also configure the [_Comment Thread_][10] object.

<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 do not have to configure the <em>Comment</em> or <em>Comment Thread</em> objects to support comments and comment threads on <em>Local Adaptations</em> because Veeva Claims provides standard object types and fields to support comments for that object. If you configured <em>Comments</em> and <em>Comment Threads</em> for <em>Local Adaptations</em> using custom object types and fields, contact your Veeva Representative for details about migrating to the standard object types and fields.</p>
    </div>
  </div>
</div>



#### Configuring the Comment Object {#comment}

You must configure the _Comment_ object so that users can add comments to specified objects:

1. Navigate to **Admin > Configuration > Objects > Comment**.
2. On the **Object Types** tab, <a href="/en/gr/32857/#create">create and save an object type</a> with an appropriate label, such as "Pack Copy Comment".
3. On the **Fields** tab, create a custom field of type **Object** that references the object for which you are configuring _Comments_, such as "Pack Copy Comment".
4. On the **Object Types** tab, click the **Actions** menu and select **Edit Object Type Fields**.
5. Make the new custom field available on the applicable object by selecting the custom field in the column for the appropriate object type and clicking **Save**.
6. Click **Save**.

#### Configuring the Comment Thread Object for Pack Copy {#comment-thread}

To allow users to reply to comments in comment threads on _Pack Copies_, you must also configure the _Comment Thread_ object for the _Pack Copy_ object. To do this:

1. Navigate to **Admin > Configuration > Objects > Comment Thread**.
2. On the **Object Types** tab, <a href="/en/gr/32857/#create">create and save an object type</a> with an appropriate label, such as "Pack Copy Comment Thread".
3. On the **Fields** tab, create a custom field of type **Object** that references the _Pack Copy_ object, such as "Pack Copy Comment Thread".
4. On the **Object Types** tab, click the **Actions** menu and select **Edit Object Type Fields**.
5. Make the new custom field available to the object for which you are configuring _Comment Threads_ by selecting the custom field in the column for the appropriate object type.
6. Click **Save**.
7. Repeat these steps for each object for which you configure _Comment Threads_.

### Defining Comment Settings {#settings}

You must define comment settings to specify which objects support _Comments_.

#### Comment Setting Components {#comment-settings}

<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 configured comments prior to 23R3, settings may be defined in <a href="#comment-admin-settings"><em>Claim Admin Settings</em></a>. If this is the case in your Vault, we recommend deleting the <em>Claim Admin Settings</em> and redefining the settings in Comment Setting components as described in this section.</p>
    </div>
  </div>
</div>



Define comment settings by creating Comment Setting components for each [_Comment_ object type][9]. To do this: 

1. Navigate to **Admin > Configuration > Comment Setting**.
2. Click **Create**.
3. Enter a unique **Name** of the setting you are creating.
4. Specify if the setting is **Active**. If you select **No**, Vault ignores the setting.
5. In the **Comment Object Type Name** field, enter the name (not the label) of the applicable [_Comment_][9] object type, such as `pack_copy_comment__c`.
6. In the **Comment Reference Field Nam**e field, enter the applicable name (not the label) of the [_Comment_][9] object field, such as `pack_copy_comment__c`.
7. If you are defining settings for the _Local Adaptation or Pack Copy_ object and want to support comment threads:
  * In the **Thread Object Type Name** field, enter the name (not the label) of the applicable [_Comment Thread_][10] object type, such as `pack_copy_comment_thread__c`.
  * In the **Thread Reference Field Name** field, enter the name (not the label) of the applicable [_Comment Thread_][10] object field, such as `pack_copy_comment_thread__c`.
8. Click **Save**.

You can create one (1) Comment Setting for each [_Comment_][9] object type. After creation, you cannot modify the _Comment Object Type Name_ field on any Comment Setting.

#### Claim Admin Settings {#comment-admin-settings}

<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>: We recommend defining settings in <a href="#comment-settings">Comment Setting components</a> rather than in <em>Claim Admin Settings</em> as described in this section.</p>
    </div>
  </div>
</div>



You can define comment settings by creating _Comment Setting_ types of _Claim Admin Settings_. To do this:

1. Navigate to **Business Admin > Objects > Claim Admin Settings**.
2. Click **Create**.
3. Select **Comment Setting** as the **Setting Type**.
4. In the **Comment Object Type Name** field, enter the name (not the label) of the applicable [_Comment_][9] object type.
5. In the **Object Reference Field Name** field, enter the applicable name (not the label) of the [_Comment_][9] object field.
6. If you are creating a _Claim Admin Setting_ for the  _Local Adaptation_ or _Pack Copy_ objects and want to allow comment threads:
  * In the **Thread Object Type Name** field, enter the name (not the label) of the applicable [_Comment Thread_][10] object type.
  * In the **Thread Reference Field Name** field, enter the name (not the label) of the applicable [_Comment Thread_][10] object field.
7. Click **Save**.
8. Repeat these steps for each object for which you configure _Comments_.

If you define settings in a _Claim Admin Setting_ and a [Comment Setting component][17], Vault ignores the _Claim Admin Setting_.

### Configuring Object Layouts {#object-layouts}

You must configure an <a href="/en/gr/26387/">object's layout</a> differently depending on if the object supports comment threads. Vault supports comment threads on the _Local Adaptation_ and _Pack Copy_ objects, which you can configure either [with][14] or [without][13] the ability for users to reply to top-level root comments in comment threads.

#### Layouts for Comment Threads on Local Adaptations & Pack Copies {#with-threads}

To configure the _Local Adaptation_ and _Pack Copy_ object layouts with the ability for users to reply to comments:

1. Navigate to **Admin > Configuration > Objects > [Object] > Layouts > [Layout]**.
2. Insert the _Comments_ control section with the slider (<img class="inline" src="https://platform.veevavault.help/assets/images/CPC-Icon-Slider.png" alt="Slider Icon" style="" />) icon to the object layout.
3. In the _Add Comments_ dialog, you can make the following changes:
  * Optional: Change the **Section Label**.
  * Optional: In the **Show the section only in these lifecycle states** field, select one (1) or more lifecycle states. This option only appears if the object uses a <a href="/en/gr/29798/">lifecycle</a>.
  * Optional: Enter **Section Help** content to provide the user with any relevant information. Help content appears below the section label.
  * Optional: Select the **Expand the section by default** checkbox so that the section is always open when users open the records.
  * Optional: Change the default **Sort Order** of top-level root comments:
        * **Sort by Created**: Ordered by latest creation date.
        * **Sort by Activity**: Ordered by latest reply and, for comments without replies, by creation date.
4. Enter the name (not the label) of the applicable [_Comment_ object type][9] in the **Comment Object Type** field.
5. Click **Done**.

This configuration displays up to 500 comments for a _Local Adaptation_ or _Pack Copy_. If your business needs require more than 500 comments, we recommend configuring comments [without comment threads][13] for these objects.

When a user adds the first reply to a _Comment_ on a _Local Adaptation_ or _Pack Copy_, Vault generates a new _Comment Thread_ that groups all _Comment_ replies to the root _Comment_ to which the user replied. _Comment Threads_ are system-managed and cannot be modified.

#### Layouts for Comments without Comment Threads {#without-threads}

To configure _Comments_ on objects that do not support comment threads or to configure layouts for the _Local Adaptation_ or _Pack Copy_ without the ability for users to reply to comment threads, insert a related object section for the _Comment_ object to the applicable object's layout. In the **Criteria VQL** field of the _Comments_ section, enter a filter to constrain the records to only the applicable _Comment_ object type. For example: `object_type__vr.api_name__v = 'pack_copy_comment__c'`.

## Configuring Bulk Comments {#bulk}

<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 first configure single comments for <a href="#c-p-comments"><em>Claims</em></a>, <a href="#c-p-comments"><em>Projects</em></a>, and <a href="#object-comments"><em>Local Adaptations</em></a> before configuring bulk comments on any of those objects.</p>
    </div>
  </div>
</div>



Veeva Claims includes several actions that allow users to add a single comment to multiple _Claim_, _Project_, and _Local Adaptation_ records with a <a href="/en/gr/33725/">bulk object record action</a>:

* The _Bulk Claim Comments_ action on the _Claim_ object adds comments to multiple _Claims_ and creates _Claim Comments_.
* The _Bulk Project Comments_ action on the _Project_ object adds comments to multiple _Projects_ and creates _Project Comments_.
* The _Bulk Add Comments_ action on the _Local Adaptation_ object adds comments to multiple _Local Adaptations_ and creates _Local Adaptation Comment_ types of _Comments_. 

 When users run these actions, Vault collects the user's comment with the _Bulk Comment User Input_ object and creates [temporary _Bulk Comment User Inputs_][6] for each record to which the user adds the comment. Vault then creates new _Claim Comment_, _Project Comment_, or _Local Adaptation Comment_ types of _Comments_ for each record the user selects after running the bulk action on the applicable records.

 Make the following changes to support bulk  comments:

* Depending on your business needs, configure the following actions as <a href="/en/gr/43127/#assign-actions">record actions</a> with the _Available in All Lifecycle States_ option selected for the supported objects:
  * _Bulk Claims Comments_ on the _Claim_ object.
  * _Bulk Project Comments_ on the _Project_ object.
  * _Bulk Add Comments_ on the _Local Adaptation_ object.
* Configure the _Bulk Comment User Input_ <a href="/en/gr/26387/">object layout</a>. This object is displayed to users on the _Details (Step 4)_ page when they <a href="/en/gr/520894/#multiple">bulk add comments</a>.
  * Remove the _Comment_ (`comment_body__v`) long text field from the object layout.
  * Insert the _Comment_ (`bulk_comment_control__c`) control field with the slider (<img class="inline" src="https://platform.veevavault.help/assets/images/CPC-Icon-Slider.png" alt="Slider Icon" style="" />) icon.
  * Optional: Remove or hide any unnecessary fields. We suggest hiding all fields except the _Comment_ (`bulk_comment_control__c`) control field.

### Configuring the Bulk User Input Object Cleanup Job {#cleanup-job}

The _Bulk User Input Object cleanup Job_ deletes temporary user input records created from the bulk comment actions more than 24 hours before the jobs run. You can <a href="/en/gr/22897/#scheduling">configure the job's schedule</a> to run at a specific time. We recommend that you schedule this job to run daily. 

##  Configuring Notifications {#notifications}

Veeva Claims uses the following notification templates to notify users about comments:

* **C1: Bulk Comment Notification**: Sent to users tagged in comments [added in bulk][4].
* **C1: Comment Notification**: Sent to users tagged in an individual comment.
* **C1: Comment Notification Fallback**: Sent to users tagged in an individual comment for which Vault cannot determine the record's ID due to a configuration issue.
* **C1: Comment Thread Notification**: Sent to comment creators when another user adds a reply to that comment.

<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>: For Vaults created prior to 23R3, we recommend downloading this <a class="download-link " href="https://platform.veevavault.help/assets/downloads/cp-claims-bulk-translation-example.zip" target="_blank" rel="noopener">bulk translation file example<i class="fa fa-download" aria-hidden="true"></i></a> to see how to add the applicable tokens to notification templates using the <a href="/en/gr/13309/#bulk-translation">bulk translation tool</a>. Contact your Veeva Representative for more details.</p>
    </div>
  </div>
</div>



## Configuring User Permissions {#user-permissions}

You must ensure users have the appropriate read and create <a href="/en/gr/22824/">permissions</a> to access the appropriate objects and object fields in addition to the permissions outlined below:

* To use mentions in a comment, users must have _Read_ permission on the _User_ object and _Read_ permissions on the following _User_ object fields:

  * _ID_
  * _First Name_
  * _Last Name_
  * _User Name_
  * _Status_

### Comments on Claims

Users must have  the following permissions to create and reply to _Claim Comments_:

* For the _Claim_ object: _Create_ permission.
* For the _Claim Comment_ object: 
  * _Create_ permission and _Edit_ permission on the _Claim_ and _Comment_ fields. 
  * To reply to _Claim Comments_, users must have _Edit_ permission on the _Is Root Comment_ and _Thread Comment_ fields.
  * To search for comments, users must have _Read_ permission on the _Comment_, _Created By_, and _Created Date_ fields.

### Comments on Projects

Users must have the following permissions to create and reply to _Project Comments_:

* For the _Project_ object: _Create_ permission.
* For the _Project Comment_ object: 
  * _Create_ permission and _Edit_ permission on the _Comment_ and _Project_ fields. 
  * To reply to _Project Comments_, users must have _Edit_ permission on the _Is Root Comment_ and _Thread Comment_ fields.
  * To search for comments, users must have _Read_ permission on the _Comment_, _Created By_, and _Created Date_ fields.

### Comments on Objects

Users must have the following permissions to create _Comments_ on the specified object:

* For the objects on which you configured comments: _Create_ permission, including _Create_ permission on the applicable object types.
* For the _Comment_ object: _Create_ permission and _Edit_ permission on the _Claim_ and _Comment_ fields. 
  * To reply to _Comments_ on _Local Adaptations_ and _Pack Copies_, users must have _Edit_ permission on the _Comment Thread_, _Comment Type_, and _Is Root Comment_ fields.
  * To search for comments, users must have _Read_ permission on the _Comment_, _Created By_, and _Created Date_ fields.

### Bulk Comments

Users must have the following permissions to bulk add comments to multiple _Claims_, _Local Adaptations_, and _Projects_:

* For the _Bulk Comment User Input_ object: _Create_ permission and _Edit_ permission on the _Comment_ (`comment_body__v`) field. 
* _Application: Object: Bulk Action_ permission to perform bulk actions.
* _Execute_ permission on the applicable actions:
  * _Bulk Claims Comments_ on the _Claim_ object.
  * _Bulk Add Comments_ on the _Local Adaptation_ object.
  * _Bulk Project Comments_ on the _Project_ object.

## Related Permissions {#related-permissions}

You can complete all steps in this article with the standard _System Administrator_ or _Vault Owner_ security profile. If your Vault uses custom security profiles, your profile must grant the following <a href="/en/gr/22824/">permissions</a>:

<table>
  <tr>
    <th><strong>Type</strong></th>
    <th><strong>Permission</strong></th>
    <th><strong>Controls</strong></th>
  </tr>
    <tr>
    <td>Security Profile</td>
    <td>Admin: Configuration: Objects: Create, Edit</td>
    <td>Ability to create and modify Vault objects and Comment Setting components.</td>
  </tr>
  <tr>
    <td>Security Profile</td>
    <td>Admin: Security: Permission Sets: Edit</td>
    <td>Ability to modify permission sets for users.</td>
  </tr>
  <tr>
    <td>Security Profile</td>
    <td>Application: API: Metadata API</td>
    <td>Ability to access the <em>Comment Settings</em> page.</td>
  </tr>
</table>

[2]: #c-p-with-threads
[3]: #c-p-without-threads
[4]: #bulk
[5]: #object-comments
[6]: #cleanup-job
[7]: #c-p-comments
[8]: #configure-objects
[9]: #comment
[10]: #comment-thread
[11]: #settings
[12]: #object-layouts
[13]: #without-threads
[14]: #with-threads
[15]: #user-permissions
[16]: #notifications
[17]: #comment-settings