Skip to main content

Document collaborators

Document collaborators are the people associated with a document. External collaborators are stored in Komodo Publications Planning as Contact records while internal collaborators are stored as User records or in Document Group (mvn__CM_Document_Group__c) records. Contacts can be created locally or be derived from an external data source that an administrator has configured. When a contact, user, or document group is added as a collaborator to a document, a Document Collaborator (mvn__PP_Document_Author__c) record is created with the PP_External, PP_Internal, and PP_Group record types, respectively. The Document Collaborator record is subsequently related to the Document (mvn__CM_Document__c) record along with any corresponding Task records and Contact Verification (mvn__PP_Contact_Verification__c) records. Contact Verification records help track background checks and consent details for external contacts. Reference the Configure Contact Verification and Task automation section below for more information.

Document collaborators can be assigned specific roles on a document that determine the function or capacity in which they can interact with the document. There are two experiences for the searching, adding, and assigning of collaborators on documents. While V1 more clearly distinguishes the handling between external contacts and internal users and groups, V2 unifies all potential collaborators. Both are done in the Collaborators tab of a Document record.

Document Collaborator Search V1 vs. V2 unified experience

In the V1 experience of the Document Collaborator Search feature, contacts are managed separately from users and document groups. You can only add and assign document roles to external contacts in the Pubs - Related Document Authors component and only add and assign document roles to internal users and document groups in the Document Roles related list.

In the V2 experience of the Document Collaborator Search feature, all contacts, users, and groups can be added and assigned roles on a document in the Pubs - Related Document Authors component. V2 is therefore otherwise known as the "unified" Document Collaborator Search experience. This means that you no longer need to know whether a potential document collaborator is external or internal to Komodo Publications Planning in order to be able to search for and add them to a document.

Note

All new customers after the Spring ’23 release will have the V2 unified experience. Existing customers from before the Spring ’23 release will remain on the V1 experience. Existing customers who would like to take advantage of the unified V2 experience need to perform the necessary upgrade steps below.

Note

Only active users and Contact records with related active User records will appear in the search results. Inactive users cannot be searched for in the Document Collaborator Search wizard.

Upgrade from V1 to V2

If you have a Komodo Publications Planning environment with V1 of the Document Collaborator Search experience and would like to update it to the V2 unified experience:

  1. In Setup, navigate to the Interface Handler (mvn__PP_Interface_Handler__mdt) custom metadata type.

    1. In the Internal Contact Filter Search (PP_Internal_Contact_Filter_Search) metadata record, update the Class field from PP_ContactFilterSOQLSearchV1 to PP_ContactFilterSOQLSearchV2.

    2. In the Internal Contact Omni Search (PP_Internal_Contact_Omni_Search) metadata record, update the Class field from PP_ContactOmniSOSLSearchV1 to PP_ContactOmniSOSLSearchV2.

  2. In Setup, navigate to the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type.

    • In the Default (PP_Default) metadata record, check the Document Collab Search V2 Enabled checkbox.

Migration script

When upgrading to the V2 unified experience of the Document Collaborator Search, you may not have any corresponding Document Collaborator records for the roles you previously assigned in the V1 experience. To create the missing Document Collaborator records, you can complete the following migration script using Apex Anonymous and the batch class PP_CreateDocumentCollaboratorBatchable.

Note

You only need to complete the migration script if you are upgrading the Komodo Publications Planning product (e.g., from version 1.19.0.4) to the Spring '23 release. The migration script only applies to publication documents, not supporting documents, and will only create Document Collaborator records for the roles that do not already have the corresponding records. There should be only one Document Collaborator record per user and per document.

To complete the migration script:

  1. Open an Execute Anonymous Window. Visit Salesforce's documentation on Apex Anonymous for more information.

  2. In the Enter Apex Code window, execute the following code block:

    mvn__PP_CreateDocumentCollaboratorBatchable b = new mvn__PP_CreateDocumentCollaboratorBatchable();
Id batchProcessId = Database.executeBatch(b, 100);

You can monitor the status of the batch process as well as view any errors that may occur during the batch process with the Processing Result (mvn__PP_Processing_Result__c) and Processing Error Message (mvn__PP_Processing_Error_Message__c) fields on the Plan Team Member (mvn__PP_Plan_Team_Member__c) custom object.

Pubs - Related Document Authors component

The Pubs - Related Document Authors (ppRelatedDocumentAuthors) component lists all document collaborators and their assigned roles on the given document. This includes pending, active, and inactive contacts, users, and groups. From this component, you can add collaborators to the document via the Document Collaborator Search wizard as well as provision pending contacts. You can also configure the appearance of the component by choosing the columns that should appear as well as the icons and labels that represent the different types of collaborators.

Note

In the V1 experience, only contacts can be viewed, searched, added, and assigned roles in this component.

Provision pending contact

Contacts with a Pending status have not yet been provisioned. However, you can provision them directly in the Pubs - Related Document Authors component.

To provision a pending contact:

  1. Click the dropdown arrow at the right end of the row.

  2. Click Provision User.

  3. Enter the details about the contact.

  4. Click + Provision User.

A new User Request (mvn__PP_User_Request__c) record will be created. It will be processed asynchronously to provision the contact. For more information, reference Users.

Assign document role

All document collaborators are assigned an initial or default role when they are first added to a document. (For more information, reference step 4 in the Search for and add a document collaborator section below.) Additional roles can be assigned after a document collaborator is added.

To manually add a document role to a document collaborator:

  1. Click the dropdown arrow at the right end of the row.

  2. Click Add Document Role.

  3. Select a role.

  4. Click Save.

Document roles can also be automatically added if a document collaborator is assigned a task that requires a specific document role. For more information, reference the Configure Contact Verification and Task automation section below.

Remove document role

You can remove any document role from a document collaborator, unless the collaborator has an assigned task that they have not yet completed.

To remove a single document role from a document collaborator, including the Owner role:

  1. Click the role to be removed. The Role Permissions modal will appear.

  2. Click Delete.

    • If you clicked on the Owner role in step 1, a Transfer Ownership button will appear in the Role Permissions modal instead of a Delete button. Click Transfer Ownership to remove the Owner role from the current owner and assign the Owner role to another user.

To bulk remove all document roles from a document collaborator:

  1. Click the dropdown arrow at the right end of the row.

  2. Click Remove Document Roles.

Document roles can also be automatically removed if a document collaborator completes the task that was assigned to them because of their role. To configure this, check the Strict Document Roles (mvn__CM_Strict_Document_Roles__c) field on the Default (PP_Default) metadata record of the MCM Global Setting (mvn__CM_Global_Setting__mdt) custom metadata type.

Configuration

Configure component columns

To configure the fields that appear as columns in the component:

  1. In Setup, navigate to the Document Collaborator (mvn__PP_Document_Author__c) custom object.

  2. Click Field Sets.

  3. Click the Related Document Authors Fields (mvn__PP_Related_Document_Authors_Fields) field set.

  4. Modify the field set and click Save. Each field in the field set will appear as a column in the Pubs - Related Document Authors (ppRelatedDocumentAuthors) component.

Out of the box, the Document Roles (mvn__PP_Document_Roles__c) field is used to format and list all of the selected roles from the Assigned Roles (mvn__PP_Assigned_Roles__c) field. This includes the initial or default role identified in the Role (mvn__PP_Role__c) field and any additional role that is assigned to the collaborator. You can click on each role in the Document Roles column to identify the specific permissions of that role. If a collaborator is added to the document without a role or if all of a collaborator's roles on the document are removed, the Document Roles column for that collaborator will say "No assigned roles."

Similarly, the User Type (mvn__PP_User_Type__c) field is used to format and represent the different types of document collaborators. For more information on configuring the icons and labels of each document collaborator type, reference the Configure collaborator icons and labels section below.

Configure collaborator icons and labels

To configure the icons that represent the different types of document collaborators as well as the labels that appear when you hover on an icon:

  1. In Setup, navigate to the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type.

  2. In the Default (PP_Default) metadata record, modify the following for each document collaborator type you wish to configure:

    Document Collaborator record type

    Pubs Global Setting metadata fields

    External (PP_External)

    External User Icon (mvn__PP_External_User_Icon__c)

    External User Icon Label (mvn__PP_External_User_Icon_Label__c)

    Group (PP_Group)

    Group Icon (mvn__PP_Group_Icon__c)

    Group Icon Label (mvn__PP_Group_Icon_Label__c)

    Internal (PP_Internal)

    Internal User Icon (mvn__PP_Internal_User_Icon__c)

    Internal User Label (mvn__PP_Internal_User_Icon_Label__c)

  3. Save your changes.

The icons and labels identified in this metadata record are surfaced and formatted in the User Type (mvn__PP_User_Type__c) field of the Document Collaborator object.

Document Collaborator Search wizard

The Document Collaborator Search (ppCollaboratorSearchModal) wizard is the wizard that appears when you click New in the Pubs - Related Document Authors (ppRelatedDocumentAuthors) component. You can use it to search for and add document collaborators. You can also click the columns to sort the search results and hover over a result to view its details.

Search for and add a document collaborator

To search for and add an existing contact, user, or group as a document collaborator:

Note

In the V1 experience, only contacts can be viewed, searched, added, and assigned roles in this component.

  1. In the Pubs - Related Document Authors component, click New. The Document Collaborator Search wizard will open.

  2. (Optional) In the search box, enter the exact names of the people you wish to add or use a wildcard search with the asterisk (*) symbol, and click Search. Local Contact records and external MDM Contact records that match your filter criteria will appear.

    Note

    Out of the box, the Country field is pre-populated with the value on the Region (mvn__CM_Region__c) field of the Document Version (mvn__CM_Document_Version__c) record.

  3. Select the document collaborator to be added, and click Next.

    • If you selected a contact, modify the details about the contact as needed, and click Next.

  4. Select a role. This will be the initial and default role of the collaborator on the document. To assign additional roles at a later time, reference Assign document role. The available roles that you can select may differ depending on if you are adding a contact, user, or group.

    • If you selected a contact, select a status in addition to a role.

  5. Click Save and Done.

A new Document Collaborator (mvn__PP_Document_Author__c) record will be created with the appropriate record type and related to the given Document (mvn__CM_Document__c) record. If you added a contact, a User Request (mvn__PP_User_Request__c) record will also be created and processed asynchronously to provision the contact. For more information, reference Users.

Note

You do not have to manually search for and add document collaborators who you will be assigning workflow tasks. If you assign a user a workflow task on a document and the user is not yet a document collaborator for the document, a corresponding Document Collaborator record will be created automatically for the user.

Add new contact

To create a new contact and then add them as a document collaborator:

  1. Complete steps 1-2 from the section above. You do not need to enter any name or filter criteria in the search box to click Search.

  2. Click Create New Contact.

  3. Select a Record Type ID and click Next.

  4. Enter the details about the contact and click Next. A Contact record will be created.

  5. Complete steps 4-5 from the section above.

To configure the fields that appear in the new Contact form, reference the Configure new contact form section below.

Configuration

Configure search filters

To configure the search filters in the Document Collaborator Search wizard, create or modify Layout Type (mvn__LY_Layout_Type__mdt) metadata records. Depending on if you are configuring basic or advanced search filters, make sure the Layout Type metadata record relates to the appropriate Layout (mvn__LY_Layout__mdt) metadata record.

For more instructions on how to configure Komodo Publications Planning layouts, visit Layout configuration.

Search filter

Layout metadata record

Basic

Collaborator Search - Basic (PP_Collaborator_Search_Basic)

Advanced

Collaborator Search - Advanced (PP_Collaborator_Search_Advanced)

Note

Out of the box, if the collaborator type filter is left blank, both users and contacts are included in the document collaborator search results. Conducting an employee search will also include both users and contacts while conducting an HCP and non-HCP search will exclude users and only include contacts. To configure whether or not a collaborator type filter should include users in the search results, update the Collab Wizard Searches Users? (mvn__PP_Collab_Wizard_Searches_Users__c) field on the Author Mapping (mvn__PP_Author_Mapping__mdt) custom metadata type. There are four metadata records provided out of the box, one for each of the collaborator types available (PP_Employee, PP_HCP, PP_Non_HCP) and one for when no collaborator type is selected (Default).

Configure list view columns

To configure the columns in the recently viewed list view and the search results list view:

  1. In Setup, navigate to the Contact standard object.

  2. Click Field Sets.

  3. Click the Author Search Result Fields (mvn__PP_Author_Search_Result_Fields) field set.

  4. Modify the field set and click Save.

Out of the box, this field set is used on the Author Search Result Field Set (mvn__PP_Author_Search_Result_Field_Set__c) field of the Default (PP_Default) metadata record of the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type.

Configure search result popover

To configure the fields that appear in the additional information popover when users hover on a search result:

  1. In Setup, navigate to the Contact standard object.

  2. Click Field Sets.

  3. Click the Author Search Popover Fields (mvn__PP_Author_Search_Popover_Fields) field set.

  4. Modify the field set and click Save.

Out of the box, this field set is used on the Author Search Popover Field Set (mvn__PP_Author_Search_Popover_Field_Set__c) field of the Default (PP_Default) metadata record of the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type.

Configure new contact form

To configure the fields that appear when creating a new Contact record:

  1. Create Author Mapping (mvn__PP_Author_Mapping__mdt) custom metadata records to connect a Contact field set to a Contact record type.

    Note

    Author Mapping records control what Contact record types are available to create.

  2. Modify the Contact field set.

Warning

Do not add MailingState or MailingCountry to a field set because the fields will not map correctly for external contacts. Instead, use MailingStateCode and MailingCountryCode.

Note

The field sets do not need to contain every field that you want mapped for external contacts as long as the fields are correctly mapped via the Class (mvn__PP_Class__c) field on the Interface Handler (mvn__PP_Interface_Handler__mdt) custom metadata type. For example, you can leave the mvn__PP_External_ID__c field off a field set as long as the corresponding mvn__PP_Interface_Handler__c.mvn__PP_Class__c correctly maps the field. For more information, reference the Add external collaborator search handler section below.

Configure available roles for collaborator type

You can specify which document roles can be assigned for each document collaborator type. To configure the available roles based on a document collaborator type:

  1. In Setup, navigate to the Document Collaborator (mvn__PP_Document_Author__c) custom object.

  2. Click Record Types, and select the record type you would like to configure the available roles for.

  3. Click Edit next to Assigned Roles and/or Role as appropriate.

  4. Modify the picklist values available for selection.

  5. Click Save.

Add external collaborator search handler

You can extend the Document Collaborator Search interface to support an external, master data management (MDM) search handler. Once configured, you can search the external source, create a local Salesforce Contact record from an external contact, and add the new Contact record as a document collaborator. Search behavior is the same for both external contacts and internal users and groups.

To add an external search handler, create a custom Interface Handler (mvn__PP_Interface_Handler__mdt) metadata record. Key Interface Handler fields include:

  • Interface - select a search interface. Contact Omni Search maps to the document collaborator quick search while Contact Filter Search maps to the document collaborator advanced search.

  • Class - enter the API name of the custom class that implements the interface you selected. The class must map the relevant Account and Contact fields using fieldName.

    Note

    If you map the State field, you must also map the Country field as State is a picklist field that depends on Country.

  • Sequence - enter the order number that this class should be called if there are multiple configured.

Automation

Configure Contact Verification and Task automation

The Contact Verification (mvn__PP_Contact_Verification__c) custom object tracks background checks and consent details for external contacts. You can use a combination of process builders and flows to automate the creation of Contact Verification records and corresponding Task records. To help you get started, the Komodo Publications Planning product includes the process builder and flow templates listed in Table 76, “Contact verification templates”. Using standard Salesforce Process Builder and Flow Builder functionality, you can modify these templates to meet your business needs and requirements.

The process builder and flow templates are designed to work together. When a Document Collaborator record is created or edited, the Document Author: Create Contact Verification process builder determines if a Contact Verification record is needed. If it is needed, the process builder triggers the Create Contact Verification flow. The Create Contact Verification flow then creates the Contact Verification record with the appropriate record type. Upon creation of the Contact Verification record, the Contact Verification: Create Task process builder determines what Tasks are needed to complete the verification and triggers the Contact Verification Tasks flow. The Contact Verification Tasks flow creates the Task with the appropriate record type and relates the Task record to the relevant Contact Verification record. When a user marks the Task as Complete, the Task: Update Contact Verification Status process builder updates the status of the related Contact Verification record.

Table 76. Contact verification templates

Label

Description

Process builder template

Flow template

Document Author: Create Contact Verification

Determines if verification is needed for HCP and Non-HCP Document Authors and triggers the Create Contact Verification flow if verification is needed. This process builder is triggered when a Document Author record is created or edited.

✓

Create Contact Verification

Creates Contact Verification records with a specified record type. The Document Author: Create Contact Verification process builder triggers this flow.

✓

Contact Verification: Create Task

Determines the type of contact verification Task that is needed and triggers the Create Contact Verification Tasks flow. This process builder is triggered when a Contact Verification record is created.

✓

Create Contact Verification Tasks

Creates a contact verification Task record with a specified record type. The Create Verification: Create Task process builder triggers this flow.

✓

Task: Update Contact Verification Status

Updates the Status field on a Contact Verification record when a related Task is Closed.

✓



Configure Document Collaborator and Plan Team Member automation

Users can retroactively add plan team members to existing plan documents as document collaborators. This can be automated by scheduling batch jobs to run every hour or ad hoc via Apex Anonymous.

To ensure that the batch jobs create the appropriate document collaborators with their specific roles, populate the Existing Role (mvn__PP_Existing_Role__c) field on the Plan Team Member (mvn__PP_Plan_Team_Member__c) custom object.

To schedule a batch job to run every 10 minutes:

  1. Open an Execute Anonymous Window. Visit Salesforce's Apex Anonymous for more information.

  2. In the Enter Apex Code window, execute the following code block:

    System.schedule('PP_PlanTeamMemberQueueSchedulable 1', '0 0 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));
System.schedule('PP_PlanTeamMemberQueueSchedulable 2', '0 10 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));
System.schedule('PP_PlanTeamMemberQueueSchedulable 3', '0 20 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));
System.schedule('PP_PlanTeamMemberQueueSchedulable 4', '0 30 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));
System.schedule('PP_PlanTeamMemberQueueSchedulable 5', '0 40 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));
System.schedule('PP_PlanTeamMemberQueueSchedulable 6', '0 50 * * * ?', new mvn.PP_PlanTeamMemberQueueSchedulable(0, 400));

    Warning

    The arguments passed in for PP_PlanTeamMemberQueueSchedulable class are 0 and 400, respectively, where 0 is the offset and 400 is the number of documents related to the plan team members that will be processed per queueable job. Do not modify the offset value, and make sure the number of documents does not exceed 900 to avoid hitting governor limits.

Note

This batch job will always create document roles. If you enable the V2 unified Document Collaborator Search experience, a Document Collaborator (mvn__PP_Document_Author__c) record will be created in addition to the Document Role (mvn__CM_Document_Role__c) record.