Spring '23 release notes
This topic contains the release notes for the Spring '23 release of Komodo Publications Planning. The release notes are organized into these high-level sections:
New features – new features and functionalities released in the new version.
Updated features – updated features and functionalities released in the new version.
Defect fixes and maintenance – fixed defects and maintenance items within the new version.
Hotfixes – defects identified in the Spring '23 release that were fixed via hotfix patches.
Metadata changes – changes to the underlying data models, user permissions, or system configurations included within the new version.
Required upgrade actions - required actions to upgrade to the new version.
As this page is maintained and updated over time to ensure accurate and timely information, Komodo Health recommends referencing the release notes online rather than printing and referencing static versions of this page.
For the release notes from earlier versions of Komodo Publications Planning, visit the Archive page.
New features
The new release of Komodo Publications Planning contains several new features whose functionalities are detailed below. Details about enablement and configuration are included within the product documentation.
Caching system
A product-specific caching system has been introduced for Komodo Publications Planning. The ppDefault cache partition, along with the PP_GlobalSettingsService Apex class, can clear the cache for the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type. This addresses concerns about hitting CPU and SOQL governor limits. Salesforce’s platform cache limits still apply. For product documentation, reference Platform Cache.
Related work item(s): MPP-1098, MPP-1222, MPP-1226
Track Pubs API versions
The Pubs API Version (mvn__PP_Pubs_API_Version__mdt) custom metadata type is a new custom metadata type that tracks the active and inactive versions of the Pubs API. This custom metadata type allows the Komodo Publications Planning product to support the versioning of future Pubs API updates and should only be modified if you choose to revert the Pubs API that is used in the Collaborator Portal or in API client calls to a previous version. For product documentation, reference APIs.
Related work item(s): MPP-1212
Complete task on another user's behalf
Komodo Publications Planning now offers document collaborators the ability to complete tasks on another user’s behalf while maintaining the original assignee on the task. Previously, users could only complete tasks on another user’s behalf to progress a workflow by reassigning the tasks to themselves. This was misleading if the original assignee actually completed work required in the task but did not mark the task as complete. This new capability allows traceability on both who the task was actually assigned to and who the task was marked completed by.
The Complete Tasks on Behalf of Other Users (mvn__CM_Task_Completion_On_Behalf_Of_Enabled__c) field on the MCM Global Setting (mvn__CM_Global_Setting__mdt) custom metadata type enables this capability while the CM Complete Tasks On Behalf Of Others (CM_Task_Completion_On_Behalf_Of) custom permission via the CM TaskApproverOnBehalfOf (CM_TaskApproverOnBehalfOf) permission set controls which users can use this capability. The new Complete On Behalf Of Flag (mvn__CM_Complete_On_Behalf_Of_Flag__c) field on the Activity object tracks whether or not a task was completed on another user's behalf. For product documentation, reference Complete a task.
Related work item(s): MPP-1455, MPP-1838
Updated features
The new release of Komodo Publications Planning also contains several improvements and optimizations to existing features and functionalities to better align with customer feedback and provide an enhanced user experience. Unless noted otherwise, all updated features are shipped "off" by default for existing customers and "on" by default for new customers.
View document collaborator's assigned roles
A new Assigned Roles (mvn__PP_Assigned_Roles__c) field is available on the Document Collaborator (mvn__PP_Document_Author__c) object. The roles selected in this field are surfaced and formatted in the Document Roles column of the Pubs - Related Document Collaborators (ppRelatedDocumentAuthors) component. This allows users to more easily identify and perform reporting on all of the roles that each document collaborator has or had on a Document (mvn__CM_Document__c) record. For product documentation, reference Document collaborators.
Related work item(s): MPP-1390
Redesigned Document Revision Activity component
The Document Revision Activity (PpDocumentVersionHistory) Lightning component has been redesigned for an improved user experience. Previously, the component only had a feed-like interface where users would view individual document revisions in reverse chronological order. Now, the component also offers a timeline-like interface where users could sort and filter the document revisions as well as bulk download the revision files from all of the tasks. This enhanced timeline view of the Document Revision History component lets users more easily review the revisions and feedback submitted by document collaborators. You can switch between the two versions of the component via the new Enhanced Doc Revision History (mvn__PP_Enhanced_Doc_Revision_History__c) field on the Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type. For product documentation, reference Document Version History Details.
Related work item(s): MPP-1453, MPP-1458 MPP-1618
Hotfixes
Table 30, “Hotfix items” details defects identified in Komodo Publications Planning Spring '23 that were fixed via a hotfix patch. To update your Salesforce environment with the hotfix patch, install the latest version of Komodo Publications Planning Spring '23 at https://install.komodohealth.com/products/kpp/1.27.5.
Work item | Description | Fix/new behavior | Hotfix/patch version |
|---|---|---|---|
PLTFM-2410 | Upon upgrading to Salesforce’s Spring ’24 release, users who tried to use the Document Collaborator Search ( NoteThis issue was identified in KI-115. | Users are able to progress through the Document Collaborator Search wizard and add document collaborators to documents. | Spring '23 1.27 |
Defect fixes and maintenance
Table 31, “Fixed items” below details defects and maintenance items identified in the Fall '22 release that are resolved in the new Spring '23 release.
Work item | Description | New behavior |
|---|---|---|
MPP-1346 | The Pubs - Related Document Collaborators ( | Discrepancies between the Pubs - Related Document Collaborators component and the Document Roles list have been fixed. Changes made to one will be properly reflected in the other. |
MPP-1365 | When a search is performed in the Document Collaborator Search wizard, all contacts, users, and groups that match the query, including inactive users, would appear in the search results. However, when the inactive users were selected, an error was thrown. | Inactive users, as well as Contact records that have related inactive User records, no longer appear in the search results of the Document Collaborator Search wizard. They will still appear in the standard recently viewed contacts list view, but clicking on an inactive user will prompt a detailed error message to appear. |
MPP-1366 | When a new collaborator is added to a document via the Document Collaborator Search wizard, any role from the Role ( | The roles that can be selected and assigned to document collaborators now respect the roles that are configured to be available for the specific Document Collaborator record type. The UI of the Role dropdown menu in the Document Collaborator Search wizard has also been improved so that the available roles are more visible and readable. |
MPP-1389 | External MDM Contact records could not be added as document collaborators in the Document Collaborator Search wizard. This was because the external contacts were mistakenly treated as internal document groups and would subsequently throw an error. | The Document Collaborator Search wizard has been fixed to treat MDM Contact records as external contacts instead of internal groups. Going forward, external MDM contacts can now be added to documents as document collaborators without any error. |
MPP-1620 | Users encountered an error when using the collaborator type filter in the Document Collaborator Search wizard. This occurred because the collaborator types in the filter failed to map to internal users in the product and only mapped to external contacts. | The collaborator type filter has been fixed with the new Collab Wizard Searches Users? ( |
MPP-1622 | The branding of the product did not reflect that of Komodo Health's, and the names "Publication Planning" and "Publications Planning" were used interchangeably within the product. | The colors and logo within the Komodo Publications Planning product have been updated to better align with Komodo Health's branding. Additionally, the name has been updated to "Publications Planning" to ensure consistency throughout the product. |
Metadata changes
The following subsections capture the changes against entities in key areas of Komodo Publications Planning that have been introduced in the latest release. This list is not exhaustive, as it does not contain changes that are internal to the application and that are not exposed to customers for customization, extension, or integration.
Custom label changes are listed in the table below:
Work item | Custom label |
|---|---|
MPP-1365 | PP_Document_Collab_Inactive_User_Error |
MPP-1390 | PP_No_Assigned_Roles |
MPP-1543, MPP-1618 | PP_Apply_Filters PP_Filters_Header PP_Owner PP_Record_Type PP_Revision_History_Header |
Custom metadata type changes are listed in these tables below:
Work item | Custom metadata type |
|---|---|
MPP-1212 | mvn__PP_Pubs_API_Version__mdt |
Work item | Custom metadata type | Field |
|---|---|---|
MPP-1390 | mvn__PP_Global_Setting__mdt | mvn__PP_External_User_Icon__c |
MPP-1453 | mvn__PP_Global_Setting__mdt | mvn__PP_Enhanced_Doc_Revision_History__c |
MPP-1455, MPP-1838 | mvn__CM_Global_Setting__mdt | mvn__CM_Task_Completion_On_Behalf_Of_Enabled__c |
MPP-1620 | mvn__PP_Author_Mapping__mdt | mvn__PP_Collab_Wizard_Searches_Users__c |
Work item | Custom metadata type | Metadata record name |
|---|---|---|
MPP-1620 | mvn__PP_Author_Field_Mapping__mdt | PP_MailingCountryCode_Default PP_MailingCountryCode_Employee PP_MailingCountryCode_Non_HCP PP_MailingCountryCode_HCP |
Work item | Custom metadata type | Metadata record name | Modification explanation |
|---|---|---|---|
MPP-1618 | mvn__LY_Layout__mdt | PP_Task_Version_History | The number of columns will be increased from 1 to 2 for the enhanced timeline view of the Document Revision Activity ( |
mvn__LY_Layout_Type__mdt | PP_Task_Version_History_Default | ||
MPP-1620 | mvn__PP_Author_Mapping__mdt | Default PP_Employee | The new Collab Wizard Searches Users? ( |
PP_HCP PP_Non_HCP | The new Collab Wizard Searches Users? ( |
Layout changes are listed in the table below:
Work item | Object | Layout | Modification explanation |
|---|---|---|---|
MPP-1390 | mvn__PP_Document_Author__c | External Document Author Group Document Author Internal Document Author | The new Assigned Roles ( |
Lightning component changes are listed in these tables below:
Work item | Object | Lightning component |
|---|---|---|
MPP-1453 | mvn__CM_Document__c | ppDocumentVersionHistoryFilter |
Work item | Object | Lightning component | Modification explanation |
|---|---|---|---|
MPP-1390 | mvn__PP_Document_Author__c | ppRelatedDocumentAuthors | The new PP_No_Assigned_Roles custom label will be added to the Document Roles ( |
MPP-1453, MPP-1618 | mvn__CM_Document__c | ppDocumentVersionHistory | An enhanced timeline view will be added to the component. |
Object changes are listed in these tables below:
Work item | Object | Field |
|---|---|---|
MPP-1390 | mvn__PP_Document_Author__c | mvn__PP_Assigned_Roles__c |
MPP-1838 | Activity | mvn__CM_Complete_On_Behalf_Of_Flag__c |
Work item | Object | Field set |
|---|---|---|
MPP-1458 | Task | mvn__PP_Task_Version_History_Detail |
Permissions changes are listed in the tables below:
Work item | Custom permission |
|---|---|
MPP-1455, MPP-1838 | CM_Task_Completion_On_Behalf_Of |
Work item | Permission set |
|---|---|
MPP-1455 | CM_TaskApproverOnBehalfOf |
Platform cache and event changes are listed in the table below:
Work item | Cache partition |
|---|---|
MPP-1226 | ppDefault |
Required upgrade actions
This section includes the required actions that must be completed in order to upgrade a previous release of the Komodo Publications Planning product (i.e., either version 1.17 or version 1.19.0.4) to the current Spring '23 release (i.e., version 1.24.0.10). The steps for both 1.17 and 1.19.0.4 are the same.
Note
On your behalf, Komodo Health's implementations team will complete the upgrade steps in your Salesforce environment. You do not need to complete the following steps.
Complete the following pre-upgrade steps before upgrading to the latest Komodo Publications Planning version.
Disable any flow that uses the Contact Verification (
mvn__PP_Contact_Verification__c), Document Collaborator (mvn__PP_Document_Author__c), and/or Task (Task) objects.Disable any email alert that may be going out to users.
Back up all of your production data.
Cancel the following batch jobs:
CM_CacheSObjectMetadataSchedulable
CM_ScheduledPublishJob
PP_DeleteOrphanedContentDocuments
PP_DigitalScienceSchedulable
PP_NewUserRequestSchedulable
PP_UnpaywallSchedulable
PP_UpdateCongressLocationsSchedulable
PP_UpdateCongressesSchedulable
PP_UpdateJournalsSchedulable
Install the following packages to upgrade to the latest Komodo Publications Planning version.
Warning
If you completed the upgrade steps prior to August 4, 2023, you must install the following packages again for the latest version of the Komodo Publications Planning Spring '23 release. The specific packages that have been updated as of August 4, 2023 with new package IDs or versions will be called out below.
Install mvn-auth@1.0.0.
sfdx force:package:install --package 04t3x0000015EliAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-utilities@4.3.0.
sfdx force:package:install --package 04t3x0000015ElnAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-ui@1.5.1.
sfdx force:package:install --package 04t3x0000015Wy5AAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Warning
If you completed the upgrade steps prior to August 4, 2023, you must install this package again for the latest version of the Komodo Publications Planning Spring '23 release. This package has been updated as of August 4, 2023.
Install mvn-logger@3.1.0.
sfdx force:package:install --package 04t3x0000015WyKAAU -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Warning
If you completed the upgrade steps prior to August 4, 2023, you must install this package again for the latest version of the Komodo Publications Planning Spring '23 release. This package has been updated as of August 4, 2023.
Install mvn-query@1.4.0.
sfdx force:package:install --package 04t3x000000WyySAAS -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-apex-metadata-api@3.1.0.
sfdx force:package:install --package 04t3x000000WxbmAAC -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-layout@3.1.0.
sfdx force:package:install --package 04t3x0000015WyZAAU -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-system-event@4.1.0.
sfdx force:package:install --package 04t3x000000WyyXAAS -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-content-translation@1.5.1.
sfdx force:package:install --package 04tQr00000002ZhIAI -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Warning
If you completed the upgrade steps prior to August 4, 2023, you must install this package again for the latest version of the Komodo Publications Planning Spring '23 release. This package has been updated as of August 4, 2023.
Install mvn-content@11.4.3.
sfdx force:package:install --package 04t3x0000015apvAAA -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Warning
If you completed the upgrade steps prior to August 4, 2023, you must install this package again for the latest version of the Komodo Publications Planning Spring '23 release. This package has been updated as of August 4, 2023.
Install mvn-health-check@4.0.0.5.
sfdx force:package:install --package 04t3x0000015GkcAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS}Install mvn-publications-identity@1.9.0.2.
sfdx force:package:install --package 04t3x0000015WQbAAM -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-publications-planning@1.24.0.10.
sfdx force:package:install --package 04t3x0000015WhsAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-publications-planning-unpaywall@0.4.0.5.
sfdx force:package:install --package 04t3x0000015WibAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-publications-planning-digital-science@1.6.0.9.
sfdx force:package:install --package 04t3x0000015WigAAE -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}Install mvn-publications-planning-pubshub@0.13.0.4.
sfdx force:package:install --package 04t3x0000015WiWAAU -s AdminsOnly -r -w 300 -u {YOUR_ORG_ALIAS} -k {PLATFORM_INSTALL_KEY}
Complete the following post-upgrade steps after upgrading to the latest Komodo Publications Planning version.
Reschedule all of the jobs that were canceled in pre-upgrade step 4.
Run the following PP_MigrateDocumentAuthorsContactsBatch job. This Apex class updates the Author Contact (
mvn__PP_Author_Contact__c) field on the Document Collaborator (mvn__PP_Document_Author__c) object.database.executeBatch(new PP_MigrateDocumentAuthorContactsBatch(), 1);
Verify that for each Document Collaborator record, any value on the now deprecated Contact (
mvn__PP_Contact__c) field is populated on the new Author Contact (mvn__PP_Author_Contact__c) field. The Contact field was deprecated in the Fall '22 release of Komodo Publications Planning.For any flow or Apex code that references the Contact field (i.e.,
mvn__PP_Document_Author__c.mvn__PP_Contact__c), remove the reference and replace it with the Author Contact field as necessary. The Contact field cannot be used in any flow or Apex code in order for it to be deleted in step 4, and the Contact field must be deleted for the Document Collaborator Search wizard to function as expected.
Delete the unpackaged PP_MigrateDocumentAuthorsContactsBatch class.
From the Document Collaborator (
mvn__PP_Document_Author__c) object, delete the Contact (mvn__PP_Contact__c) field.Note
If you are in the Lightning experience and do not see the Delete button on the Contact field, switch to the Classic experience.
Run the following PP_CreateDocumentCollaboratorBatchable job and smoke test some records to ensure that Document Collaborator records were created for internal users and groups.
database.executeBatch(new mvn.PP_CreateDocumentCollaboratorBatchable(), 1);