Set up and update the Collaborator Portal
The Collaborator Portal is available in the
mvn-publications-planning-identity package and requires that a
Salesforce Digital Experience (formerly called Communities) is enabled
for your organization.
Note: On your behalf, 's delivery team will set up and update the Collaborator Portal for your Salesforce environment as appropriate. You do not need to complete the following steps.
To set up a new instance of the Collaborator Portal:
-
Install the
mvn-publications-planning-identitypackage. -
Enable the Salesforce Digital Experience. For more information, reference Salesforce's documentation on how to Enable the Experience Cloud Site in Your Org.
-
Add the mvn__Login Visualforce page. For more information, reference Salesforce's documentation on how to Use Visualforce in Experience Builder Sites.
Warning: If you want to customize the login page for the Collaborator Portal, you may create your own Visualforce page. Do not edit the out-of-the-box mvn__Login Visualforce page. For more information, reference Customize UI with static resources. ::::
-
(Optional) Configure a custom domain. For more information, reference Salesforce's documentation on how to Configure a Custom Domain for Your Experience Cloud Site.
Warning: A production domain must be created in order to host the Collaborator Portal community.
-
Provide the Scientific Publications Cloud product team with the Collaborator Portal URL. This will enable the product team to generate a portal identity provider to be used in step 7(ii) and a branch domain URL for a new origin URL pattern to be used in step 9.
-
To find the Collaborator Portal URL:
-
In Setup, search for and select All Sites.
-
In the Collaborator Portal row, find the link under the URL column. This is the URL to provide to the product team.
-
-
The product team will complete several setup steps on their end and provide both the portal identity provider and the branch domain URL in return.
-
-
Install the "Publications Planning Production" connected app. For more information, reference Salesforce's documentation on how to Install a Connected App.
Note: The "Publications Planning Production" connected app may not appear on the Connected Apps OAuth Usage page in your Salesforce org until you try using the Collaborator Portal for the first time. As a result, you may have to first skip this step, complete the following setup steps below, try logging into the Collaborator Portal, and then come back and complete this step. You may also encounter an OAuth error when trying to log into the Collaborator Portal for the first time, which will be resolved after this step is completed. ::::
-
Enable Microsoft 365 in the Collaborator Portal. To do so, you must create a new custom attribute on the Office 365 Connected App and then add the portal identity provider to the Default Microsoft 365 Setting metadata record.
Warning: To enable Microsoft 365 in the Collaborator Portal, make sure you have completed the prerequisite steps in the Optional prerequisite: Set up and configure Microsoft 365 section above.
-
To create a new custom attribute on the Office 365 Connected App:
-
From Setup, navigate to Manage Connected Apps.
-
Click the existing MCM Office 365 app if you're in a production environment and MCM Office 365 (Test) app if you're in a test environment.
-
Scroll down to the Custom Attributes section, and click New.
-
In the Attribute key field, enter
mvn__CA_O365_ExperienceSite. -
In the Attribute value field, enter the following code and substitute
\<communityUrl\>with the Collaborator Portal URL for your instance.If(ISPICKVAL($User.UserType,"PowerCustomerSuccess"),"\<communityUrl\>","")Warning: The URL of the Collaborator Portal that should be added to
\<communityUrl\>is not the same as the URL of the Salesforce environment. In other words, the URL that is entered for the\<communityUrl\>should open the Collaborator Portal and not the Salesforce environment. -
Click Save.
-
-
To add the portal identity provider to the Default Microsoft 365 Setting metadata record:
-
From Setup, navigate to the Microsoft 365 Setting (
mvn__CA_Office_365_Setting__mdt) custom metadata type. -
Edit the Default (
Default) metadata record. -
In the Portal Identity Provider field, enter the provider name that the product team provided in step 5(ii).
Note: If the Portal Identity Provider field is not readily available in the Office 365 Setting layout, edit the layout and add the field.
-
Click Save.
-
-
-
Enable Cross-Origin Resource Sharing (CORS). For more information, reference Salesforce's documentation on how to Enable CORS for OAuth Endpoints.
-
Add the branch domain URL that the product team provided in step 5(ii) as a new origin URL pattern to the CORS. This will allow the AWS instance to communicate with Salesforce. For more information, reference Salesforce's documentation on how to Configure Salesforce CORS Allowlist.
-
Add the Collaborator Portal landing page URL to the Default Collaborator Portal metadata record. This will ensure that users in the Collaborator Portal are directed to the corresponding Salesforce environment.
To configure the Default Collaborator Portal metadata record:
-
In Setup, navigate to the Collaborator Portal (
mvn__PP_Collaborator_Portal__mdt) custom metadata type. -
Edit the Default (
PP_Default) metadata record. -
Set the Portal Landing URL field to equal the Collaborator Portal landing page URL, or the URL of the AWS instance.
-
(Optional) Set the Static Resource Name field. For more information, reference the Customize UI with static resources section below.
-
Click Save.
-
The setup of a new instance of the Collaborator Portal is now complete. note ::: title :::
If you were previously unable to complete step 6 above, remember to try logging into the Collaborator Portal for the first time and completing step 6 again.
Upgrading the Collaborator Portal
To upgrade the collaborator portal, follow these steps:
Warning: Production requires that the product team pushes the upgrade to your portal instance. Coordinate with the product team before doing these steps. For sandboxes, see the next section.
-
Upgrade the
mvn-publications-planning-identitypackage through the . -
Create a new Pubs API Version (
mvn__PP_Pubs_API_Version__mdt) metadata record with the latest Pubs API and Portal API versions and check the Is Active? (mvn__PP_isActive__c) field (i.e., set totrue). -
Ensure that the Is Active? (
mvn__PP_isActive__c) field on all other Pubs API Version metadata records is unchecked (i.e., set tofalse).
Change Collaborator Portal versions in sandbox environments
You can use different versions of the Collaborator Portal in sandbox environments. This allows you to try out the features in the latest version and compare them with existing features without having to upgrade the Collaborator Portal instance that is associated with your production Salesforce environment.
To enable the ability to change Collaborator Portal versions, add the following URLs to the cross-origin resource sharing (CORS) list of your sandbox environment. Each URL corresponds to a specific Collaborator Portal version and, therefore, a specific version. For more information, reference Salesforce's documentation on Configure Salesforce CORS Allowlist:
| URL | Collaborator Portal version | version |
|---|---|---|
| current.test.pubs.komodohealth.com | v4 | Fall '25 |
| previous.test.pubs.komodohealth.com | v3 | Spring '25 |
| deprecated.test.pubs.komodohealth.com | v1/v2 | Fall '24 |
: Collaborator Portal version URLs
To change the Collaborator Portal version in a sandbox environment, repeat the Collaborator Portal upgrade steps using the Collaborator Portal version URLs above.
Once configured, you may have to open the Collaborator Portal in an incognito window. The URL of the Collaborator Portal will update accordingly based on the version.