Configuring Object-Level Comments (QMS)

QualityOne Vaults allow users to communicate and collaborate on object records using Comment Types. Comment Types are provisioned from a target QualityOne object and Comments object within the Comment Setup page, and include user mention functionality. Comments allow collaboration between the following types of users:

• Internal user to external user
• External user to internal user
• Internal user to internal user

User mentions allow users to tag specific users in a comment to allow those users to collaborate more efficiently. User mentions trigger a notification to the mentioned users in the Comment record. You must configure the appropriate Read, Create, Edit, and Delete permissions for Internal and External users on the target objects required. User mentions in object comments are not included in Vault Summary Emails, if configured.

Defining User Types

Comments on objects in QualityOne use two (2) user types: Internal and External. You determine a user’s user type by setting the value in the Organization field on the User (user__sys) object. Values in the Organization field in the User object differentiate between an internal organization and an external organization. Matching Sharing Rules apply to the Organization field on the Comment Type object from the User object, determining the user type for the comment records. When a User object record is determined to be either Internal or External, the user is able to interact with the Comment Type object according to their user type permissions.

Comments on object functionality behaves in the following ways for users after you have defined user types:

• Internal users can read all comment records for their organization, provided they have been granted the appropriate permissions.
• External users can only read comment records that have the Organization field from the comment record set to their own organization’s name.
• Internal users cannot mention External users from different organizations in one (1) comment. Internal users can only mention External users from the same organization.
• All users can edit and delete comment records that they have created themselves, provided they have been granted the appropriate permissions. Users cannot edit or delete other users’ comment records.
• Comments created by an Internal user for Internal users cannot be read by External users.

Configuring Comment Target Objects

Configuring comments on a target object in QualityOne requires the following:

Comment Setup Page

For a QualityOne object to have comment functionalities in each object detail record page, you need to create a Comment Type for the specific QualityOne object. Use the Comment Setup page to allow comments to be provisioned for the targeted QualityOne object. This is called a Comment Type.

Comment types generate separate target comment objects (associated to the target object) with the naming convention [target_object_name]_comment__v where [target_object_name] refers to the QualityOne object name. For example, provisioning comments on the target Complaint (complaint__v) object creates the Complaint Comment (complaint_comment__v) object as the Comment Type.

Only System Administrator or Vault Owner security profiles can view, create, and delete Comment Types on the Comment Setup page.

Creating Comment Types

To create a comment type:

1. Navigate to Admin > Configuration > Component Setup > Comment Setup.
2. Click Create.
3. Select a Target Object.
4. Click Continue.

A message indicates the provisioning is in progress and sends a notification once the comment type is provisioned.

Deleting Comment Types

Comment types can only be deleted if there are no existing comment object records for the comment type.

To delete a comment type:

1. Navigate to Admin > Configuration > Component Setup > Comment Setup.
2. In the appropriate comment type grid item, click Delete from the inline Actions menu.
3. Click Continue.

Configuring Object Layouts

The layout for a Comment Type object (for example, Complaint Comment (complaint_comment__v) object, a provisioned target object) displays each comment record, whereas the target object displays the Comment Type in the object detail record page as a Related Object section, after configuring. Insert the Comment control section into the Comment Type object layout to allow user mentions in comment records, and to allow hiding and auto-filling of the Organization field for External users.

After creating a comment type, you need to update the following object layouts:

• For the Comment Type object layout:
  • Detail Form Section:
    • Include the Organization field.
    • Insert the Comment control section with the slider () icon. This is critical to allow user mentions in comments. For example, if you provisioned comments on the Complaint (complaint__v) object, navigate to the layout for the Complaint Comments (complaint_comment__v) object.
    • Remove the default Comment field.

• For the target object layout:
  • Related Object Section: Insert the Comment Type object. For example, if you require comments on the Complaint (complaint__v) object, navigate to the object layout for the Complaint (complaint__v) object and insert Complaint Comments (complaint_comment__v) as the related object.

Limitations

The following limitations affect comment and user mention functionality:

• Users must mention at least one (1) other user in a comment record.
• Comments functionality can be provisioned to all QualityOne objects except objects that are inactive, locked, child, or are already comment objects.

Configuring User Permissions

You must ensure users have the appropriate read and create permissions to access the appropriate objects and object fields in addition to the permissions outlined below:

You must ensure Internal and External users have the appropriate permissions to access the appropriate Comment Type objects, target objects, target object types, and target object fields. The Organization field in the user profile must have an organization value to indicate the user type. To be able to mention a user, the user creating the mention must have Read permissions configured for Comment Type object and the target object required.

Related Permissions

You can complete all the 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 permissions:

Type	Permission	Controls
Security Profile	Objects: Organization: Read	Ability to view Organizations.
Security Profile	Objects: [Target Object Comment]: Read, Create, Edit, Delete	Ability to make changes to target object comment objects. You must create a comment type before completing this action.
Security Profile	Objects: [Target Object]: Create, Edit, Read	Ability to create, modify, and view new Vault target objects.