Fall '23 release notes

This topic contains the release notes for the Fall '23 release of Scientific Publications Cloud product. The release notes are organized into these high-level sections:

• Installation -- link to install and/or upgrade to the new version.

• New features -- new features and functionalities released in the new version.

• Updated features -- updated features and functionalities released in the new version.

• Hotfixes -- defects identified in the Fall '23 release that were fixed via hotfix patches.

• Defect fixes and maintenance -- fixed defects and maintenance items within the new version.

• Metadata changes -- changes to the underlying data models, user permissions, or system configurations included within the new version.

• Deprecated and deleted items -- components of Scientific Publications Cloud product that have been deprecated, removed, or retired from the new version.

• Required post-upgrade actions -- required actions administrators must take after upgrading to the new version.

To identify if a feature request you made was included in this release, search these release notes or the release note archive for the work item number that Customer Support gave you. The release notes include a work item number for every new feature, updated feature, and defect fix.

As this page is maintained and updated over time to ensure accurate and timely information, Mavens recommends referencing the release notes online rather than printing and referencing static versions of the page. The Changelog page lists all notable changes made to this page.

Installation

The Fall '23 release can be installed with the at https://install.komodohealth.com/products/kpp/1.31.0.8. New installs of will be on the latest release while current customers will need to run and deploy the latest update.

Warning: Current customers who use the to upgrade to the latest Fall '23 release must remember to complete the steps in the Required post-upgrade actions section.

New features

The new release of Scientific Publications Cloud product contains several new features whose functionalities are detailed below. Details about enablement and configuration are included within Scientific Publications Cloud product documentation, which will be updated as the release is made available.

Attach files to external review and approval task emails

Users now have the option to attach files for external document collaborators when starting workflows and assigning tasks. The attached files will then be available in the email notifications that are sent out to the external task assignees so that they can view tasks and files directly in their emails without having to log into the Collaborator Portal.

Admin users must enable this capability via the new Allow Relationship Attachments (mvn__CM_Allow_Relationship_Attachments__c) field on the Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) custom metadata type. A new Attachment File Type Mapping (mvn__SE_Attachment_File_Type_Mapping__mdt) custom metadata type has also been created to ensure that the files are readable in emails. For product documentation, reference Attach files.

Related work item(s): MPP-1456, MPP-1766, MPP-1798

Package files

Users can now relate multiple files, called package files, to a single Document Version (mvn__CM_Document_Version__c) record. This can be helpful in instances where a manuscript, for example, is split into multiple sections across different files. Each package file is stored in a Document Version Package File (mvn__CM_Document_Version_Package_File__c) record and is automatically carried over onto new document versions that are uploaded and new drafts that are created.

Package files can be managed via the Package Files (cmDocumentVersionPackageFiles) related list and be retrieved via the pubs/publication/\{id\}/Accept-version endpoint. Package files are also available for download in the Collaborator Portal. In both the Salesforce instance and the Collaborator Portal, package files that meet certain requirements can also be checked out and opened with Office 365^TM^.

If you are upgrading from an existing version of Scientific Publications Cloud product to the latest Fall '23 release, you must complete the steps in the Update Pubs API metadata section. For product documentation, reference Package files and Pubs API.

Related work item(s): MPP-1713, MPP-1714, MPP-1715, MPP-1716, MPP-1717, MPP-1718, MPP-1719, MPP-1720, MPP-1721, MPP-1828, MPP-1850, MPP-1867, MPP-2036/PLTFM-2257

Updated features

The new release of Scientific Publications Cloud product 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.

Calculate activity due dates with regional business hours

Publication coordinators can now more easily account for regional business hours when setting due dates on workflow stage activities. This can be helpful in instances where document collaborators are located in different areas of the world and have different holidays, timezones, and business hours. Previously, the due date for each collaborator assigned to an activity was always the same, unless the publication coordinator had looked up the collaborators' regional business hours, manually calculated the due dates, and created separate activities for each collaborator accordingly. Now, the due date on activities can be calculated automatically based on the collaborators' timezones as well as any Business Hours records that are set for those timezones. If no Business Hours record is created for a collaborator's timezone, then the new PP_Default record that ships with is used. To enable this functionality, admin users can change the value on the new Days to Complete Calculation (mvn__CM_Days_To_Complete_Calculation__c) field on the Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) custom metadata type from Actual Days to Business Days. For product documentation, reference Due date.

Related work item(s): MPP-1938, MPP-1939, MPP-1940, MPP-1941

Download checked out Office 365^TM^ documents in portal

Admin users can now configure whether or not documents that are checked out to Office 365^TM^ in the Salesforce instance can be downloaded in the Collaborator Portal via the new Enable Checked Out Document Download (mvn__PP_Enable_Checked_Out_Document_Download__c) field on the Collaborator Portal (mvn__PP_Collaborator_Portal__mdt) custom metadata type. This enables external document collaborators to review and edit documents offline and complete their assigned tasks while internal users review and edit in Office 365^TM^. For product documentation, reference Open and download documents.

Related work item(s): MPP-1956

Increased Office 365^TM^ file size limit

The Office 365^TM^ integration has been updated to support greater file size limits in alignment with those of the Microsoft Cloud Storage Partner Program (CSPP). Along with the update, the API Version (mvn__CA_API_Version__c) field on the Office 365 Setting (mvn__CA_Office_365_Setting__mdt) custom metadata type has been deprecated. For product documentation, reference Microsoft 365.

Related work item(s): PLTFM-1530

Sortable document list views

Users can now sort Document list views by product and region with the new Products (mvn__CM_Products__c) and Regions (mvn__CM_Regions__c) fields on the Document Version (mvn__CM_Document_Version__c) object. To enable and use this feature, you must complete the steps in the Populate sortable Products and Regions columns section below after upgrading to the Fall '23 release. The steps include a data migration on existing documents to ensure that the new Products and Regions fields are populated as appropriate.

Related work item(s): PLTFM-2245

Self-service installation of Digital Science and Unpaywall

You can now install the Digital Science and Unpaywall connector packages for Fall '23 and above via the https://install.komodohealth.com/products#publications-planning without needing to contact Mavens' customer support. For product documentation, reference Digital Science and Unpaywall.

Hotfixes

The table below details defects identified in Fall '23 that were fixed via a hotfix patch. To update your Salesforce environment with the latest hotfix patch, reinstall Fall '23 at https://install.komodohealth.com/products/kpp/1.31.0.8.

Hotfix items

Work item	Description	Fix/new behavior	Hotfix/patch version
PLTFM-2409	Upon upgrading to Salesforce's Spring '24 release, users who tried to use the Document Collaborator Search (ppCollaboratorSearchModal) wizard to add a new document collaborator ran into an issue where the subsequent screens in the wizard never finished loading. :::: note ::: title ::: This issue was identified in KI-115. ::::	Users are able to progress through the Document Collaborator Search wizard and add document collaborators to documents.	Fall '23 1.28.0.19
PLTFM-2483	When a document collaborator completed a workflow task on behalf of a task assignee, the task assignee would inadvertently lose their document role(s).	Task assignees retain their document roles when other document collaborators complete workflow tasks on their behalf.	Fall '23 1.28.0.25
MPP-2401	In certain scenarios, the batch job to provision new document collaborators failed to send out the welcome email required to set up Collaborator Portal accounts, so the external users were never created. Additionally, the batch job sometimes provisioned users but failed to update the document collaborator status from Pending to Active.	When the batch job to provision new document collaborators is run, a welcome email is sent out to every user who needs to set up a Collaborator Portal account and the status for all provisioned users is set to Active.	Fall '23 1.31.0.8
MPP-2431	If a document was related to a publication plan and plan team members were configured to be automatically provisioned access to the document, duplicate document collaborators were created for some of the plan team members on the document in certain scenarios. Additionally, if an external document collaborator completed a task that initiated an auto-start workflow and the user who was assigned with the auto-start workflow task did not have the necessary document role to perform the task, a duplicate document collaborator could be created for the user to include the additional document role. :::: note ::: title ::: The first issue was identified in KI-122. ::::	Every user and plan team member will only have one Document Collaborator (mvn__PP_Document_Author__c) record on a document. This means that if a task assignee needs an additional document role that is not yet on the document collaborator, the document role will be added to the existing Document Collaborator record for the task assignee.

Defect fixes and maintenance

The table below details defects and maintenance items identified in Spring '23 that were fixed in Fall '23.

Fixed items

Work item	Description	New behavior
MPP-1243	To prevent errors during an upgrade, admin users had to reset the Type (mvn__CM_Type__c) field on the Document Relationship (mvn__CM_Document_Relationship__c) object from the active CM_Sourced value to the default Sourced value. Then, after the upgrade, admin users had to switch the default Sourced value back to the desired CM_Sourced value as well as re-enable history tracking on the Account, Contact, and Product (mvn__CM_Product__c) objects.	enableHistory and trackHistory tags on specific SObject fields were causing field history to be reset during upgrades and have therefore been removed for all SObjects and SObject fields. The Type field on the Document Relationship object should always equal CM_Sourced and will no longer be reset to the default Sourced value.
MPP-1324	Customers had a maximum limit of 12,000 active users with the CM_User custom permission in the Collaborator Portal. If customers exceeded this limit, users would run into a Too many query rows: 50001 error when assigning and canceling workflow tasks.	Users ran into the error because the query on 's backend that loads the appropriate permissions for the Collaborator Portal users was getting called too many times. The query has been optimized, and customers can now add more than 12,000 users to the Collaborator Portal as needed.
MPP-1680	Customers ran into errors when adding new plan team members to existing plans that had more than 5,000 documents because the PP_ExistingRolePlanTeamMemberBatchJob batch class would hit governor limits.	The PP_ExistingRolePlanTeamMemberBatchJob batch class has been converted into a Queueable Apex class that creates document collaborators and document roles on a set of documents without hitting governor limits. The code to Configure Document Collaborator and Plan Team Member automation has also been updated to use the new PP_PlanTeamMemberQueueSchedulable class.
MPP-1681	Canceled and Cancelled were redundant task statuses. The Update Canceled Tasks to Cancelled (PP_Update_Canceled_Tasks_To_Cancelled) flow was created to update unclosed Canceled tasks to closed Cancelled tasks.	The Cancelled task status has been removed and the Update Canceled Tasks to Cancelled (PP_Update_Canceled_Tasks_To_Cancelled) flow has been deprecated. Canceled tasks are closed automatically.
MPP-1892	The alternative (alt) text for the logo in system event emails always said "Mavens Komodo Health Logo," even if users changed the image via the System Event Setting (mvn__SE_System_Event_Setting__mdt) custom metadata type.	The alt text has been updated from "Mavens Komodo Health Logo" to "Logo."
MPP-1896, PLTFM-2147	The non-enhanced previewer displayed a "No preview available" message for Office 365^TM^ files (e.g., docx, doc, pptx, etc). This was caused by Salesforce dropping svg-based preview renditions in Hyperforce. (For more information, reference Salesforce's notice on Content file preview issues.) :::: note ::: title ::: This issue was previously identified in KI-105. ::::	Different rendition types (e.g., SVG, JPG, or thumbnail) will now be used depending on whether an org has Hyperforce or non-Hyperforce infrastructure. This ensures that file previews will always open as expected.
MPP-1964	Visualforce pages had cross-site scripting (XXS) vulnerabilities.	All URL parameters and user input handled by script tags have been encoded with JSENCODE. Visualforce pages are no longer vulnerable to cross-site scripting attacks.
MPP-2035 / PLTFM-2250	If a user checked out and modified a package file and then checked in the updated package file with the parent document, the updated package file would be associated with both the original document version and the new document version. However, the modifications in the package file should only be retained in the new document version.	Modifications to checked out package files are now only saved in the new document version when the updated package files are checked in with the parent document.
MPP-2099 / PLTFM-2290	If a Workflow Stage (mvn__CM_Workflow_Stage__mdt) metadata record had multiple Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) metadata records whose Days to Complete Calculation (mvn__CM_Days_To_Complete_Calculation__c) field was set to Business Days and task assignees were automatically populated in the Start Workflow modal, the task due dates would be calculated with actual days instead of regional business hours. Additionally, users were unable to correct the due dates because the Business days until due and Due Date fields in the modal would be disabled. The due dates would only correct themselves if users navigated to the next screen in the modal and then back.	The due date for every task in the Start Workflow modal is now calculated according to the Days to Complete Calculation field and the selected task assignees as expected. Additionally, the fields in the modal are no longer disabled, so users can update the due dates as needed.
PLTFM-1863	If a user clicked the down arrow under a document title in the Related Documents component, the related document would open instead of the menu containing the Delete option. This meant that users were unable to delete documents from the Related Documents component.	The down arrow for each document in the Related Documents component now appears next to the document title instead of under and opens the menu with the Delete option instead of the related document. This allows users to delete documents from the Related Documents component.
PLTFM-2248	If a user set the Assignment (mvn__CM_Assignment__c) field on a Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) metadata record to Workflow Creator, the workflow would hang on the spinner and never start.	Workflows where activities are assigned to the workflow creator no longer hang on the spinner and instead start as expected.
PLTFM-2249	If a user checked out a document that had no existing package files, another document collaborator was able to upload a single new package file to the document. Only after the first package file was uploaded would the New button in the Package Files related list become disabled for document collaborators who did not check out the parent document.	If a user checks out a document, the New button in the Package Files related list is immediately disabled for other document collaborators. Only the user who checks out the parent document is able to upload new package files.
PLTFM-2254	If a user checked out and opened a package file in Office 365^TM^ and then uploaded a new package file in the Package Files related list, the new package file would overwrite the checked out Office 365^TM^ package file.	New package files no longer overwrite existing package files. If a user checks out and opens a package file in Office 365^TM^ and then uploads a new package file in the Package Files related list, the new package file will appear in the related list along with the existing package file.
PLTFM-2271	If a user assigned a task via the Start Workflow modal and the Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) metadata record was configured such that the Days to Complete Calculation (mvn__CM_Days_To_Complete_Calculation__c) field equaled Business Hours while the Role Assignment (mvn__CM_Role_Assignment__c) field was set to a role that was already on the document, the due date on the task would be calculated with actual days instead of regional business hours. The due date would only correct itself if the user hovered over the Business days until due field in the Start Workflow modal.	The due date for any task assigned via the Start Workflow modal is now calculated according to the Days to Complete Calculation field on the Workflow Stage Activity custom metadata type as expected.
PLTFM-2284	The due date for the first task in an auto-start workflow was always calculated with actual days, even if the Days to Complete Calculation (mvn__CM_Days_To_Complete_Calculation__c) field on the Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) metadata record was configured to use regional business hours.	The due date for every task in auto-start workflows is now calculated according to the Days to Complete Calculation field on the Workflow Stage Activity custom metadata type as expected.
PLTFM-2298	Users were unable to complete tasks on behalf of other users and instead received error messages like "Update failed... Insufficient access rights on object...", even if 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 was checked and the users had all the necessary permissions.	Users are now able to complete tasks on behalf of other users without encountering any error messages.

Metadata changes

The following subsections capture the changes against entities in key areas of 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.

APIs

API changes are listed in the tables below:

Modified APIs

Work item	API	Endpoint	Modification description
MPP-1713	Pubs	publications/{id}	The Accept-version parameter has been added.

Business hours

New business hours

Work item	Name
MPP-1943	PP_Default

Custom metadata types

Custom metadata type changes are listed in the tables below:

New custom metadata types

Work item	Custom metadata type
MPP-1456	mvn__SE_Attachment_File_Type_Mapping__mdt

New custom metadata type fields

Work item	Custom metadata type	Field
MPP-1456	mvn__CM_Workflow_Stage_Activity__mdt	mvn__CM_Allow_Relationship_Attachments__c
MPP-1939	mvn__CM_Workflow_Stage_Activity__mdt	mvn__CM_Days_To_Complete_Calculation__c
MPP-1956	mvn__PP_Collaborator_Portal__mdt	mvn__PP_Enable_Checked_Out_Document_Download__c

New custom metadata records

Work item	Custom metadata type	Metadata record name
MPP-1715	mvn__PP_Pubs_API_Version__mdt	PP_Pubs_API_Version_2 :::: warning ::: title ::: If you are upgrading from an existing version of Scientific Publications Cloud product to the latest Fall '23 release, you must complete the steps in the Update Pubs API metadata section. ::::

Modified custom metadata records

Work item	Custom metadata type	Metadata record name	Modification explanation
MPP-1715	mvn__PP_Pubs_API_Version__mdt	PP_Pubs_API_Version_1	The Is Active? (mvn__PP_isActive__c) field has been updated from true to false.

Deprecated custom metadata type fields

Work item	Custom metadata type	Field	Description
PLTFM-1530	mvn__CA_Office_365_Setting__mdt	mvn__CA_API_Version__c	API version used to build the Office 365 endpoint URL.

Flows and flow actions

Flow changes are listed in the tables below:

Deprecated flows

Work item	Flow	Flow description
MPP-1681	PP_Update_Canceled_Tasks_To_Cancelled	Updated non-closed Canceled tasks to closed Cancelled tasks.

Lightning components

Lightning component changes are listed in the tables below:

New Lightning components

Work item	Lightning component
MPP-1456	cmAssignWorkflowActivities
MPP-1717	cmDocumentVersionPackageFiles

Objects

Object changes are listed in the tables below:

New objects

Work item	Object
MPP-1716, MPP-1721	mvn__CM_Document_Version_Package_File__c

New object fields

Work item	Object	Field
PLTFM-2245	mvn__CM_Document_Version__c	mvn__CM_Products__c mvn__CM_Regions__c

Permissions

Permission changes are listed in the tables below:

Modified permission sets

Work item	Permission set	Modification description
MPP-1716	mvn__CM_ContentAuthor	Added read and write permissions for the Document Version Package File (mvn__CM_Document_Version_Package_File__c) custom object and fields.
mvn__CM_ContentReadOnly	Added read permissions for the Document Version Package File (mvn__CM_Document_Version_Package_File__c) custom object and fields.
mvn__CM_SystemAdmin	Added read and write permissions for the Document Version Package File (mvn__CM_Document_Version_Package_File__c) custom object and fields.

Deprecated and deleted items

The following entities have either been deprecated or deleted from the latest version of and will no longer be available or supported in future releases.

Deprecated custom metadata type fields

Work item	Custom metadata type	Field	Description
PLTFM-1530	mvn__CA_Office_365_Setting__mdt	mvn__CA_API_Version__c	API version used to build the Office 365 endpoint URL.

Deprecated flows

Work item	Flow	Flow description
MPP-1681	PP_Update_Canceled_Tasks_To_Cancelled	Updated non-closed Canceled tasks to closed Cancelled tasks.

Required post-upgrade actions

This section includes the required actions administrators must take after upgrading to the Fall '23 release. Each required action specifies the criteria for consideration, which details the conditions that must exist to warrant action by a customer.

Update Pubs API metadata

To enable Package files, you must complete the following steps to update the Pubs API metadata:

1. Add the following Apex classes to the PP_App_Permissions_External permission set:

   • mvn.PP_CollaboratorPortalAPIResource

   • mvn.PP_PubsAPIResource

2. Create a new Pubs API Version (mvn__PP_Pubs_API_Version__mdt) metadata record as follows:

Field label	Value
Label	Pubs API Version 2.00
Portal API Version	v2
Pubs API Version	v2
Is Active?	✓

3. Modify the existing Pubs API Version metadata record that is labeled Pubs API Version 1.00 so that the Is Active? field is unchecked.

Populate sortable Products and Regions columns

To enable Sortable document list views, you must complete the following steps to populate the sortable Products and Regions columns:

1. Download this migration script zip file and deploy it with the Salesforce CLI or Workbench.

2. Ensure no users are in the system.

3. Ensure that the Default MCM Global Setting (mvn__CM_Global_Setting__mdt) metadata record has an API name of CM_Default.

4. Disable triggers in the Enterprise Framework Setting (mvn__Enterprise_Framework_Settings__mdt) custom metadata type.

5. In Execute Anonymous as CM_SystemAdmin, run the following:

   Database.executeBatch(new DocVersionStampRegionsProductsBatch(), 200);

6. When completed, re-enable triggers in the Enterprise Framework Setting custom metadata type.

7. Check the Debug Log (mvn__Debug_Log__c) custom object for documents that failed to update.

8. Delete the DocVersionStampRegionsProductsBatch and DocVersionStampRegionsProductsBatch__TEST Apex classes as they are no longer needed.