Skip to main content

Custom metadata

The custom metadata objects listed below help define the Scientific Publications Cloud product framework and configure product behavior.

Activity Action

The Activity Action (mvn__CM_Activity_Action__mdt) custom metadata type defines an action or option that can be selected when completing or closing a workflow task.

mvn__CM_Activity_Action__mdt schema
Field labelAPI nameData typeDescription
Action Label API Namemvn__CM_Action_Label__cText(56)The API name of the custom label that should appear on the action button in the Mark Task Complete modal.
Button Variantmvn__CM_Button_Variant__cText(20)The lightning-button variant that should appear for the action button in the Mark Task Complete modal. For the list of available lightning-button variant options, visit Salesforce's documentation on lightning-button.
Completed Label API Namemvn__CM_Completed_Label__cText(56)The API name of the custom label to appear on the (disabled) action button in the Task Tile component when the task is completed or closed.
Event Name (All)mvn__CM_Event_Name_All__cText(40)The workflow event name to use when all of the tasks in a workflow have been set to the corresponding Task Status value. For the list of available workflow event type names, reference Workflow Stage Transition.
Event Name (Single)mvn__CM_Event_Name_Single__cText(40)The workflow event name to use when a single task in a workflow is set to the corresponding Task Status value. For the list of available workflow event type names, reference Workflow Stage Transition.
Icon Namemvn__CM_Icon_Name__cText(30)The Salesforce icon to display on the action button in the Mark Task Complete modal (e.g., , utility:check and utility:close). For the list of available icons, visit Salesforce's documentation on Icons.
Task Statusmvn__CM_Task_Status__cText(40)The status to update on the task when a user performs an action on the workflow task.

Author Mapping

The Author Mapping (mvn__PP_Author_Mapping__mdt) custom metadata type maps Contact record types to User profiles and permission set groups. The Author Field Mapping (mvn__PP_Author_Field_Mapping__mdt) custom metadata type looks up to the Author Mapping custom metadata type.

mvn__PP_Author_Mapping__mdt schema
Field labelAPI nameData typeDescription
Collab Wizard Searches Users?mvn__PP_Collab_Wizard_Searches_Users__cCheckboxWhen checked, the Document Collaborator Search wizard will search for both users and contacts. When unchecked, the wizard will only search for contacts.
Contact Record Type API Namemvn__PP_Contact_Record_Type__cText(80) (Unique Case Insensitive)API name of the contact record type. If there is no available author mapping record for a given contact record type, the "Default" author mapping record will be applied.
New Contact Field Setmvn__PP_New_Contact_Field_Set__cText(80)Field set used for this contact record type when creating a new contact
Permission Set Group API Namemvn__PP_Permission_Set_Group_Name__cText(80)API name of the permission set group to assign to the user on creation.
Profile Namemvn__PP_Profile_Name__cText(80)The designated profile to be assign to the user on creation.
Reset Password Email Template Namemvn__PP_Reset_Password_Email_Template_Name__cText(80)API name of the email template used to notify the user to set their password.
Permission Set API Namemvn__PP_Permission_Set_Name__cText(80)The Developer Name of the permission set to assigned to the user on creation.

Author Field Mapping

The Author Field Mapping (mvn__PP_Author_Field_Mapping__mdt) custom metadata type maps Contact fields to User fields when creating an external author user. Author Field Mapping looks up to the Author Mapping (mvn__PP_Author_Mapping__mdt) custom metadata object.

mvn__PP_Author_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
Author Mappingmvn__PP_Author_Mapping__cMetadata Relationship(Author Mapping)Lookup relationship to the Author Mapping (mvn__PP_Author_Mapping__mdt) record.
Contact Field API Namemvn__PP_Contact_Field_Api_Name__cText(80)API name of the Contact field.
Sequencemvn__PP_Sequence__cNumber(6, 0)Order in which the fields display when creating a user.
User Field API Namemvn__PP_User_Field_Api_Name__cText(80)API name of the User field.

Collaborator Portal

The Collaborator Portal (mvn__PP_Collaborator_Portal__mdt) custom metadata type configures the Collaborator Portal.

mvn__PP_Collaborator_Portal__mdt schema
Field labelAPI nameData typeDescription
Collaborator Portal Namemvn__PP_Collaborator_Portal_Name__cText(255)The name of the Collaborator Portal site.
Email Logo Pathmvn__PP_Email_Logo_Resource_Path__cText(255)The path of the static resource for the logo in emails.
Enable Passwordless Loginmvn__PP_Enable_Passwordless_Login__cCheckboxWhen true, Collaborator Portal users can choose to log in without a password.
Login Page Logo URLmvn__PP_Login_Page_Logo_URL__cText(255)The URL of the logo for the login page.
Path to Logo in Resourcemvn__PP_Logo_Resource_Path__cText(255)The path of the static resource for the logo.
Portal Landing URLmvn__PP_Portal_Landing_URL__cText(255)The URL of the Collaborator Portal's landing page.
Identity Static Resource Namemvn__PP_Pubs_Identity_Resource__cText(255)The name of the static resource where the logo is located.
Notifications Static Resource Namemvn__PP_Pubs_Notification_Resource__cText(255)The path of the static resource for notifications.

Content Type

The Content Type (mvn__CT_Content_Type__mdt) custom metadata type determines what types of content can be uploaded to by defining the MIME type associated with each file extension.

mvn__CT_Content_Type__mdt schema
Field labelAPI nameData typeDescription
Descriptionmvn__CT_Description__cText(255)A description of the permitted content type.
File Extensionmvn__CT_File_Extension__cText(255)The file extension of the permitted content type.
MIME Typemvn__CT_MIME_Type__cText(255)The MIME type of the file extension.

Country

You can use the Country custom metadata to configure countries. By default the custom metadata contains 201 records, and each record has a distinct ISO 31661-1 country code. These records are not considered system metadata, so you may alter them in any way.

mvn__Country__mdt schema
Field labelAPI nameData typeDescription
ISO Codemvn__ISO_Code__cTextISO 3166-1 country code

Digital Science Setting

The Digital Science Setting (mvn__PP_Digital_Science_Setting__mdt) custom metadata type configures calls to Digital Science's APIs from your Salesforce instance.

:::: ::: title :::

The Digital Science Setting custom metadata type is only available as part of the Digital Science integration. If you do not have the Digital Science package installed, you will not have this custom metadata type in your instance of Scientific Publications Cloud product. ::::

mvn__PP_Digital_Science_Setting__mdt schema
Field labelAPI nameData typeDescription
Digital Science Named Credentialmvn__PP_Named_Credential__cText(255)The API name of the named credential that is used for Digital Science's API.
DS Last Modified Date Timemvn__PP_DS_Last_Modified_Date_Time__cDate/TimeThe date and time that Digital Science scheduled batch job was last run.

Document Lifecycle

Document lifecycles dictate the states and workflows available to a document. To configure a document lifecycle, use the CM_Document_Lifecycle__mdt custom metadata type.

mvn__CM_Document_Lifecycle__mdt schema
Field labelAPI nameData typeDescription
Descriptionmvn__CM_Description__cText Area (255)Description of the lifecycle
Initial Statemvn__CM_Initial_State__cText(40)The initial state in the document lifecycle
Obsolete Statemvn__CM_Obsolete_State__cText(40)The obsolete state in the document lifecycle
Published Statemvn__CM_Published_State__cText(40)The published state in the document lifecycle
Rejected Statemvn__CM_Rejected_State__cText(40)The rejected state in the document lifecycle
Review Statemvn__CM_Review_State__cText(40)The review state in the document lifecycle
Superseded Statemvn__CM_Superseded_State__cText(40)The superseded state in the document lifecycle
Withdrawn Statemvn__CM_Withdrawn_State__cText(40)The withdrawn state in the document lifecycle. A document is automatically placed in its lifecycle's withdrawn state when the document expires.

Document Lifecycle Type

Document Lifecycle Type custom metadata type is a junction between Document Lifecycle and Document Type.

mvn__CM_Document_Lifecycle_Type__mdt schema
Field labelAPI nameData typeDescription
Document Lifecyclemvn__CM_Document_Lifecycle__cMetadata Relationship(Document Lifecycle)The Document Lifecycle associated to this Document Lifecycle Type.
Document Typemvn__CM_Document_Type__cMetadata Relationship(Document Type)The Document Type associated to this Document Lifecycle Type.
Document Subtypemvn__CM_Document_Subtype__cMetadata Relationship(Document Subtype)The Document Subtype associated to this Document Lifecycle Type.

Document Notification Audience

The Document Notification Audience (mvn__CM_Document_Notification_Audience__mdt) custom metadata object defines target audiences for system event notifications. Target audience can be based on a Document Role, Group, Salesforce user ID, or user query filter. When defining a target audience based on Document Role, you must specify the Document Context in which the document role is notified.

Document Notification Audience is on the master side of a metadata relationship with the Document System Event Notification (mvn__CM_Document_System_Event_Notification__mdt) custom metadata object and the detail side of metadata relationships with the Document Relationship Type (mvn__CM_Document_Relationship_Group__mdt), Group (mvn__CM_Group__mdt), and Role (mvn__CM_Role__mdt) custom metadata objects.

mvn__CM_Document_Notification_Audience__mdt schema
Field labelAPI nameData typeDescription
Document Contextmvn__CM_Document_Context__cPicklistDefines the context of the document roles to notify. Picklist values include: - Working Document - Related Document :::: note ::: title ::: If you select Related Document, you must fill out the Document Relationship Direction and Document Relationship Type fields. ::::
Document Relationship Directionmvn__CM_Document_Relationship_Direction__cPicklistDefines the document relationship direction when the Document Context is set to Related Document. Picklist values include: - Outwards - Inwards - Both
Document Relationship Typemvn__CM_Document_Relationship_Type__cMetadata Relationship(Document Relationship Type)Defines the type of document relationship (mvn__CM_Document_Relationship_Type__mdt) when the Document Context field is set to Related Document.
Document Rolemvn__CM_Document_Role__cMetadata Relationship(Role)Document Role associated with the Document Notification Audience. Users assigned the Document Role are sent system event notification.
Groupmvn__CM_Group__cMetadata Relationship(Group)Group (mvn__CM_Group__mdt) associated with the Document Notification Audience. Users who belong to the Group are sent system notifications.
User Id Matchermvn__CM_User_Id_Matcher__cText(255)Id of the user who are sent the system event notifications.
User Query Filtermvn__CM_User_Query_Filter__cLong Text Area(32768)Query filters that determines the users who are sent the system event notifications.

Document Relationship Type

Document Relationship Type (mvn__CM_Document_Relationship_Type__mdt) records specify the types of document relationships. Document Relationship Type has a metadata relationship with Document Type Relationship Type (mvn__CM_Document_Type_Relationship_Type__mdt), which connects the Document Relationship Type and Document Type (mvn__CM_Document_Type__mdt) custom metadata objects.

mvn__CM_Document_Relationship_Type__mdt schema
Field labelAPI nameData typeDescription
Activemvn__CM_Active__cCheckboxIndicates if the relationship type is active (checked) or not (unchecked).
Inward Description Labelmvn__CM_Inward_Description_Label__cText(255)Custom Label API name describing the inward (destination document to source document) relationship. For example, a global document version has 3 translations. The 3 translated document versions have an inward relationship with the global document, and the global document has an outward relationship with the 3 translations.
Is Peermvn__CM_Is_Peer__cCheckboxWhen checked (i.e., true), the current document relationship type is considered to be a peer relationship and will appear as horizontal lines and nodes in the Relationship Visualizer. When unchecked (i.e., false), the current document relationship type is a parent-child relationship and will appear as vertical lines and nodes in the Relationship Visualizer.
Outward Description Labelmvn__CM_Outward_Description_Label__cText(255)Custom Label API name describing the outward (source to destination) relationship. For example, a global document version has 3 translations. The global document has an outward relationship with the 3 translations, and the 3 translated document versions have an inward relationship with the global document.
Relationship Name Labelmvn__CM_Relationship_Name_Label__cText(255)Custom Label API name for the relationship.

Document Sharing Rule

Use the CM_Document_Sharing_Rule__mdt custom metadata type to set the criteria for a document sharing rule.

mvn__CM_Document_Sharing_Rule__mdt schema
Field labelAPI nameData typeDescription
Activemvn__CM_Active__cCheckboxIndicates the Document Sharing Rule is active
Criteriamvn__CM_Criteria__cLong Text Area(32768)JSON criteria used to determine whether a role(s) has access to a document. You can base a sharing rule on any field that the running user can see as well as the document's relationship with products and regions.
Descriptionmvn__CM_Description__cText Area(255)Description of the Document Sharing Rule
Rolemvn__CM_Role__cMetadata Relationship(Role)Role associated to the Document Sharing Rule

Document Sharing Rule Group

CM_Document_Sharing_Rule_Group__mdt is a junction between CM_Document_Sharing_Rule__mdt and CM_Group__mdt. A Document Sharing Rule Group record applies a Document Sharing Rule to a group.

mvn__CM_Document_Sharing_Rule_Group__mdt schema
Field labelAPI nameData typeDescription
Document Sharing Rulemvn__CM_Document_Sharing_Rule__cMetadata RelationshipDocument Sharing Rule associated to the Document Sharing Rule Group
Groupmvn__CM_Group__cMetadata RelationshipGroup associated to the Document Sharing Rule Group

Document State

Document State (mvn__CM_Document_State__mdt) custom metadata type contains the list of possible states that a document can be assigned as the document progresses through its lifecycle.

mvn__CM_Document_State__mdt schema
Field labelAPI nameData typeDescription
Colormvn__CM_Color__cPicklistColor when depicting the Document State in the user interface.
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)Custom Label API Name used for translating the Document State.
Descriptionmvn__CM_Description__cText Area(255)Description of the Document State.
Display in Path Componentmvn__CM_Display_in_Path_Component__cCheckboxWhether to display this Document State in the path component on the Document Detail Page.
Document Lifecyclemvn__CM_Document_Lifecycle__cMetadata Relationship (Document Lifecycle)Document Lifecycle associated to this Document State.
Document State Groupingmvn__PP_Document_State_Group__cMetadata Relationship (Document State Grouping)Adds the Document State to a Document State Group. Each group encapsulates the associated states with a label. This label is used in user interface displays, such as the document path, to prevent the displays from becoming overcrowded and hard for the user to process at a glance.
Notifications Muted by Defaultmvn__CM_Notifications_Muted_by_Default__cCheckboxWhen checked (true), document notifications are muted by default according to the document's status or state. This can be overridden on the Document record.
Sort Ordermvn__CM_Sort_Order__cNumber (18, 0)The order in which this Document State is displayed in the user interface.

Document State Entry Action

mvn__CM_Document_State_Entry_Action__mdt schema
Field labelAPI nameData typeDescription
Document Statemvn__CM_Document_State__cMetadata Relationship(Document State)Document State associated to this Document State Role
Typemvn__CM_Type__cPicklistType of Document State Entry Action.

Document State Grouping

The Document State Groupings (mvn__PP_Document_State_Group__mdt) custom metadata object groups document states within a document lifecycle. Each Document State Grouping record encapsulates the associated states with a label. This label is used in user interface displays, such as the document path, to prevent the displays from becoming overcrowded and hard for the user to process at a glance. For example, the Approval document group state has two associated document states: In approval and Approved. The document path displays Approval rather than both of the states.

Note: To keep the path styling clean, Mavens recommends not associating more than five document states to the same document state group.

mvn__PP_Document_State_Group__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__PP_Custom_Label_API_Name__cText(255)Name of the custom label to display in the user interface for this record.

Document State Role

Document State Role is a junction between Document State and Role. Document State Roles are managed in the CM_Document_State_Role__mdt custom metadata type.

mvn__CM_Document_State_Role__mdt schema
Field labelAPI nameData typeDescription
Document Statemvn__CM_Document_State__cMetadata Relationship(Document State)Document State associated to this Document State Role
Rolemvn__CM_Role__cMetadata Relationship(Role)Role associated to this Document State Role

Document State Role Permission

Document State Role Permission is a junction between Document State Role and Permission and grants a Role for a given Document State a specific Permission. Document State Role Permissions are managed in the CM_Document_State_Role_Permission__mdt custom metadata type.

mvn__CM_Document_State_Role_Permission__mdt schema
Field labelAPI nameData typeDescription
Document State Rolemvn__CM_Document_State_Role__cMetadata Relationship(Document State Role)Document State Role associated to this Document State Role Permission
Permissionmvn__CM_Permission__cMetadata Relationship(Permission)Permission associated to this Document State Role Permission

Document System Event Notification

The Document System Event Notification (mvn__CM_Document_System_Event_Notification__mdt) custom metadata object manages how system event notifications are sent to users via Salesforce notifications and emails. Document System Event Notification is on the detail side of metadata relationships with the Document Notification Audience (mvn__CM_Document_Notification_Audience__mdt) and System Event Configuration (mvn__SE_System_Event_Configuration__mdt) custom metadata objects.

mvn__CM_Document_System_Event_Notification__mdt schema
Field labelAPI nameData typeDescription
Activemvn__CM_Active__cCheckboxIndicates if the configuration record is processed (true) or ignored (false).
Document Notification Audiencemvn__CM_Document_Notification_Audience__cMetadata Relationship(Document Notification Audience)Audience to receive the emails and notifications generated by this notification configuration.
Email Builder Namemvn__CM_Email_Builder_Name__cText(40)API name of the Apex class used to build the email.
Email Builder Namespacemvn__CM_Email_Builder_Namespace__cText(15)Namespace of the Apex class used to build the email.
Send Emailmvn__CM_Send_Email__cCheckboxIndicates if an email is sent to the configured audience (true) or not (false).
Send Salesforce Notificationmvn__CM_Send_Salesforce_Notification__cCheckboxIndicates if a Salesforce notification is sent to the configured audience (true) or not (false).
System Event Configurationmvn__CM_System_Event_Configuration__cMetadata Relationship(System Event Configuration)System event configuration for this notification configuration.

Document Type

CM_Document_Type__mdt is the highest level of classification for a document and dictates the lifecycle, states, metadata, and workflows that are available to the document once it is created. Document subtypes are also managed using this custom metadata type.

mvn__CM_Document_Type__mdt schema
Field labelAPI nameData typeDescription
Categorymvn__CM_Category__cPicklistType or Subtype. Subtype allows further categorization of records and is based on Type. For instance, when creating a document, the Subtype values available for you to choose from depend on the Type value that was already selected for the document. :::: note ::: title ::: Subtype trumps Type. For example, if a document version is associated to a Document Subtype and a Document Type, the Document Subtype controls the document version's Default Expiration in Days. ::::
Default Expiration in Daysmvn__CM_Default_Expiration_in_Days__cNumber(18,0)The number of days after the document is published that the document expires
Descriptionmvn__CM_Description__cText Area(255)Description of the Document Type
Disable Advanced Publishmvn__CM_Disable_Advanced_Publish__cCheckboxIndicates if the Advanced Publish step of the Publish wizard is enabled (false) or if the step is disabled (true) when there are published dependent documents. When disabled, users are not able to use the Publish wizard to create tasks and notify owners of related documents that the document was published.
Disable Expiration Date Requirednessmvn__CM_Disable_Expiration_Date_Requiredness__cCheckboxIndicates if the expiration date field on the Publish Document form is required (false) or not required (true).

Document Type Relationship Type

Document Type Relationship Type (CM_Document_Type_Relationship_Type__mdt) is a junction between Document Relationship Type (CM_Document_Relationship_Type__mdt) and Document Type (CM_Document_Type__mdt).

mvn__CM_Document_Type_Relationship_Type__mdt schema
Field labelAPI nameData typeDescription
Document Relationship Typemvn__CM_Document_Relationship_Type__cMetadata Relationship(Document Relationship Type)CM_Document_Relationship_Type__mdt record associated with this record.
Document Typemvn__CM_Document_Type__cMetadata Relationship(Document Type)CM_Document_Type__mdt record associated with this record.

Document Type Role Permission

The CM_Document_Type_Role_Permission_mdt custom metadata type manages document-level permissions for a specific role.

mvn__CM_Document_Type_Role_Permission__mdt schema
Field labelAPI nameData typeDescription
Document Typemvn__CM_Document_Type__cMetadata Relationship(Document Type)Document Type associated to this Document Type Role Permission
Permissionmvn__CM_Permission__cMetadata Relationship(Permission)Permission associated to this Document Type Role Permission
Rolemvn__CM_Role__cMetadata Relationship(Role)Role associated to this Document Type Role Permission

Enterprise Framework Setting

The Enterprise Framework Setting custom metadata enables you to disable Apex triggers.

mvn__Enterprise_Framework_Settings__mdt schema
Field labelAPI nameData typeDescription
Disable Triggersmvn__Disable_Triggers__cCheckboxIf true, triggers are disabled. :::: note ::: title ::: Disabling Apex triggers may result in records with invalid data as some automations may not run. ::::

Feature Activation

The Feature Activation (mvn__Feature_Activation__mdt) custom metadata type controls which features are turned on and off. Each Feature Activation metadata record represents a separate feature that can be activated.

mvn__Feature_Activation__mdt schema
Field labelAPI nameData typeDescription
Activemvn__Active__cCheckboxWhen set to true, the feature is turned on and is active. ::::: note ::: title ::: ::: {wrapper="1" role="accordion"} For all Feature Activation metadata records that are provided out of the box, the Active field equals false and the feature is turned off. ::: :::::

Field

Fields are managed using the LY_Field__mdt custom metadata type. Each record is a pointer to a custom field defined on LY_Document_Version__c and can be displayed in a Layout.

Note: Geolocation fields are not supported.

mvn__LY_Field__mdt schema
Field labelAPI nameData typeDescription
Child Relationship Namemvn__LY_Child_Relationship_Name__cText(255)Name of the child relationship when the field to display comes from a related child object. Use this field only to display children related objects.
Component Configurationmvn__LY_Component_Configuration__cLong Text Area(32768)JSON document used to configure the component override. JSON document fields include: - max - default value is 100. - min - default value is 0. - step - default value is 1. - size - defaults to viewport width. Accepted values include: - x-small - small - medium - large For example, if Slider is the component override, you can specify the component's properties with JSON: {"max": 100,"min":0,"step":2,"size":"x-small"}
Component Overridemvn__LY_Component_Override__cPicklistComponent to be rendered in place of the default. Picklist values include: - Slider - renders an input range slider, which users can use to specify a value between two set numbers. Slider is only compatible with number fields. :::: note ::: title ::: For the slider to display a range field with start and end inputs: - Set LY_Field__mdt.LY_Component_Override__c to slider. - Set LY_Layout_Field__mdt.LY_Filter__c to true. The document wizard does not support a range slider. :::: You can use the mvn__LY_Component_Configuration__c field to configure the selected component.
Field API Namemvn__LY_Field_API_Name__cText(255)API name of the field to be displayed in the layout.
Icon Namemvn__LY_Icon_Name__cText(255)Name of the Lightning Design System icon associated to this field. For example, standard:avatar. Visit Salesforce's Icons documentation.
Lookup Criteriamvn__LY_Lookup_Criteria__cLong Text Area(32768)Lookup filter that restricts the valid values for the field.
Lookup Subtitle Field Set Namemvn__LY_Lookup_Subtitle_Field_Set_Name__cText(255)Field set lookup that sets the subtitle for the field. For example, if you create a field set on the Product object that contains the Country field and the Therapeutic Area field and then select that field set for the Lookup Subtitle Field Set Name, the Subtitle for the Product field would be Country - Therapeutic Area. :::: note ::: title ::: Only fields in the field set that are directly on the object and that have values display in the Subtitle. ::::
SObjectmvn__LY_SObject__cPicklistSObject from where to get the displayed field.

Field Audit Settings

The Field_Audit_settings__mdt custom metadata type maintains the settings for Field Audit Trail.

mvn__Field_Audit_Settings__mdt schema
Field labelAPI nameData typeDescription
Capture Valuesmvn__Capture_Values__cCheckboxCheckbox field that will decide if the field's value will be tracked or if is a protected field whose values should not be tracked
Data Sensitivitymvn__Data_Sensitivity__cPicklistSensitivity of field's data
Field Namemvn__Field_Name__cText(60)The API name of the field to be tracked
Object Typemvn__Object_Type__cText(62)The SObject API name for the object whose fields are to be tracked

Field Mapping

The Field Mapping (mvn__PP_Field_Mapping__mdt) metadata type maps fields for data integrations.

mvn__PP_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
Contractmvn__PP_Contract__cText(255)The contract to which the field mapping belongs.
Parsermvn__PP_Parser__cText(255)The parser class to be used when transforming the field. - PP_AbbreviatedDateParser transforms date values from type String to type Date. - PP_AbbreviatedDateTimeParser transforms date values from type String to type Datetime. - PP_MultiSelectParser transforms multi-select values of type String to picklist values of type String. - PP_PercentParser transforms percentage values of type String to decimal values of type Decimal. - PP_SerializedJSONParser transforms Objects to Strings, including null values.
Sourcemvn__PP_Source__cText(255)The source to which the field mapping belongs.
Source Field Keymvn__PP_Source_Field_Key__cText(255)The source field key.
Target Field API Namemvn__PP_Target_Field_API_Name__cText(255)The API name of the target field.

Gantt Chart

The Gantt Chart (mvn__KHV_Gantt_Chart__mdt) custom metadata type configures the container of the enhanced timeline visualization. Each Gantt Chart metadata record can be used in a Timeline (kbvTimelineWrapper) Aura component to configure the UI/UX of the timeline visualization.

Warning: There may be additional fields on the Gantt Chart custom metadata type that are not listed in the schema table below. Those fields do not yet implement or save any changes to the enhanced timeline visualization and have therefore been omitted from the current documentation.

mvn__KHV_Gantt_Chart__mdt schema
Field labelAPI nameData typeDescription
Alignmvn__KHV_Align__cPicklistThe alignment for child Gantt Chart Item (mvn__KHV_Gantt_Chart_Item__mdt) metadata records whose Type field equals box, range, or background. Picklist values are: - auto (default) - center - left - right If the Gantt chart item is a box, then the auto alignment is the same as center. If the Gantt chart item is a range, then the auto alignment is dynamic such that the data is always visible in the component.
Content Valuemvn__KHV_Content_Value__cText(255)The content value of the item. This can be a field on the sObject or a string.
CSS Resourcemvn__KHV_CSS_Resource__cText(255)The path to the CSS file that will style the timeline visualization. The CSS file should be located in Static Resources such that the path is /resource/\<css_file_name\>.css.
Default Zoom Levelmvn__KHV_Default_Zoom_Level__cPicklistThe time interval that the timeline visualization should zoom into by default. Picklist values are: - 3 months - 6 months - 1 year (default) - 2 years If the zoom is set to 3 months, the timeline visualization will show weeks. If the zoom is set to 6 months, 1 year, or 2 years, the timeline visualization will show months. For all selections, the default view will always show the current date.
Filter Fieldsmvn__KHV_Filter_Fields__cLong Text Area(2000)A JSON list of fields that will be used as a filter on the timeline. It supports picklist, dates, numbers, and text fields. The JSON should be formatted as follows: [ { "sObjectLabel": "<Object name>", "sObjectType": "<Object API name>", "fieldApiName": "<Object field API name>" }, { "sObjectLabel": "<Object name>", "sObjectType": "<Object API name>", "fieldApiName": "<Object field API name>" } ]
Horizontal Scroll?mvn__KHV_Horizontal_Scroll__cCheckboxWhen true, users can scroll horizontally in the timeline visualization to move the time range forward or backward. This only applies if the Zoomable? field is false and the Zoom Key field is not None.
Legend Componentmvn__KHV_Legend_Component__cText(255)The name of the Lightning Web Component (LWC) to be used as a legend in the timeline visualization. Custom LWCs must be prefixed with c/. If left blank, no legend will appear on the timeline.
Moveable?mvn__KHV_Moveable__cCheckboxWhen true, users can move the timeline visualization by clicking and dragging inside the component. Additionally, when true, the timeline visualization can be enabled to zoom in and out via the Zoomable? field.
Zoomable?mvn__KHV_Zoomable__cCheckboxWhen true, users can adjust the zoom of the timeline visualization by scrolling in the component. This only applies if the Moveable? field is also set to true.
Zoom Keymvn__KHV_Zoom_Key__cPicklistSpecifies whether users can only adjust the zoom of the timeline visualization when an additional key is pressed. This only applies when the Moveable? field is set to true. Picklist values are: - None - altKey - ctrlKey - shiftKey - metaKey

Gantt Chart Item

The Gantt Chart Item (mvn__KHV_Gantt_Chart_Item__mdt) custom metadata type defines and configures the information to appear in the enhanced timeline visualization. Each Gantt Chart Item metadata record directly relates to a parent Gantt Chart (mvn__KHV_Gantt_Chart__c) metadata record and can look up to another "parent" Gantt Chart Item metadata record. Each Gantt chart item is either a group, a nested group, a subnested group, or an item.

Note: Some fields on this Gantt Chart Item custom metadata type accept both strings and merge fields. Merge fields contain field paths, or API names of fields, in curly brackets (\{\}) to retrieve dynamic values on sObjects. For more information, reference Salesforce's documentation on Merge Field Syntax.

Warning: There may be additional fields on the Gantt Chart Item custom metadata type that are not listed in the schema table below. Those fields do not yet implement or save any changes to the enhanced timeline visualization and have therefore been omitted from the current documentation.

mvn__KHV_Gantt_Chart_Item__mdt schema
Field labelAPI nameData typeDescription
Class Namemvn__KHV_Class_Name__cText(255)The name of the CSS class to style the Gantt chart item. This can be either a string or a merge field.
Content Valuemvn__KHV_Content_Value__cText(255)The text that appears for the Gantt chart item in the visualization. This can be either a string or a merge field.
End Date Field API Namemvn__KHV_End_Date_Field_API_Name__cText(255)The merge field that contains the end date to appear in the visualization. This must be populated in order for the Gantt chart item to appear if the Item Type field equals Item and the Type field equals range.
Gantt Chartmvn__KHV_Gantt_Chart__cMetadata Relationship(Gantt Chart)The parent Gantt Chart (mvn__KHV_Gantt_Chart__c) metadata record.
Generate a Rangemvn__KHV_Generate_a_Range__cCheckboxWhen true, a new Gantt chart item will be created with the Type field set to range. This generates a background/box to appear in the visualization that spans from the start date of the first item in the group to the end date of the last item in the group. This item cannot be hovered or clicked on.
Group Collection Variablemvn__KHV_Group_Collection_Variable__cText(255)A variable to store a list of group identifiers if the value on the Group Identifier field is a merge field. This variable can subsequently be used in the Query field in any child Gantt Chart Item metadata record or any other Gantt Chart Item metadata record where the Item Type field equals Nested Group or Item and the Group Sort Order has a greater numeric value and is therefore lower in the visualization. :::: warning ::: title ::: Group collection variables must be created and referenced in curly brackets (\{\}). ::::
Group Identifiermvn__KHV_Group_Identifier__cText(255)The value to identify the Gantt chart item. This must be unique, but can be either a string or a merge field. If the latter, the values retrieved can be stored in a variable via the Group Collection Variable field.
Group Sort Ordermvn__KHV_Group_Sort_Order__cNumber(1, 0)The order that the Gantt chart item is processed, and the order that the Gantt chart item appears in the visualization if the Item Type field equals Group or Nested Group. The lower the number, the earlier the Gantt chart item is processed and the higher the group or nested group appears in the visualization. :::: note ::: title ::: If the Item Type field equals Item, then the order that the Gantt chart item appears is determined by the value on the Start Date Field API Name field instead. ::::
Item Typemvn__KHV_Item_Type__cPicklistThe type of the Gantt chart item. Picklist values are: - Group - Nested Group - Item Items are always the children of a group or a nested group. Nested groups can be the children of either a group or another nested group, in which case the child nested group can be referred to as a subnested group. :::: warning ::: title ::: Mavens recommends having no more than a parent-child relationship between nested groups. ::::
Link Idmvn__KHV_Link_Id__cText(255)The merge field that contains the ID of the record that can open the record's page. Typically, but not always, the value on this field equals the value on the Group Identifier field.
Parent Group Identifiermvn__KHV_Parent_Group_Identifier__cText(255)The value on the Group Identifier field of another Gantt Chart Item metadata record. The current Gantt chart item will become the "child" while the referenced Gantt chart item will become the "parent". The parent-child relationship should follow the nesting guidelines of the Item Type field.
Popover Labelmvn__KHV_Popover_Label__cText(255)The label that appears on the hover popover.
Querymvn__KHV_Query__cLong Text Area(32768)The query to retrieve the desired data. Any IDs or unique values retrieved from the query can be used as unique identifiers in the Group Identifier field and subsequently stored in a variable in the Group Collection Variable field. If the Group Sort Order value on the current Gantt chart item is greater than the Group Sort Order value on another Gantt Chart Item metadata record, then the current Gantt chart item can reference and use the group collection variable on the other Gantt chart item. Similarly, if the Group Sort Order value on the current Gantt chart item is less than the Group Sort Order value on another Gantt Chart Item metadata record, then the other Gantt chart item can reference and use the group collection variable on the current Gantt chart item. :::: warning ::: title ::: Group collection variables must be created and referenced in curly brackets (\{\}). :::: :::: note ::: title ::: To reference the ID of the record that the visualization will be embedded on, use \{recordId\} in the query. ::::
Start Date Field API Namemvn__KHV_Start_Date_Field_API_Name__cText(255)The merge field that contains the start date to appear in the visualization. This must be populated in order for the Gantt chart item to appear if the Item Type field equals Item.
Stylemvn__KHV_Style__cText(255)Standard CSS syntax to style the Gantt chart item.
Tree levelmvn__KHV_Tree_Level__cPicklistThe tree level of the Gantt chart item, or the number of indentations the Gantt chart item should have, if the Item Type field equals Group or Nested Group. Picklist values are: - 1 - 2 - 3 Typically, if the Gantt chart item is a group, then the tree level should be 1; if the Gantt chart item is a nested group, then the tree level should be 2; and if the Gantt chart item is a subnested group, then the tree level should be 3.
Typemvn__KHV_Type__cPicklistThe type of appearance for a Gantt chart item whose Item Type field equals Item. Picklist values are: - box - point - range - background

Global List View

List views display queries of data. To configure global list views, use the Global_List_View__mdt custom metadata type.

mvn__CM_Global_List_View__mdt schema
Field labelAPI nameData typeDescription
Columns Field Setmvn__CM_Columns_Field_Set__cText(255)API name of the field set that defines the columns for this view
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)API name of the associated Custom Label
Filtersmvn__CM_Filters__cLong Text Area(32768)Filters used for this view
Keywordmvn__CM_Keyword__cText(255)Keywords used for this view
List View Object Settingmvn__CM_List_View_Object_Setting__cMetadata Relationship(List View Object Setting)List View Object Setting associated to this view
Ordermvn__CM_Order__cNumber(3, 0)Display order of rows in this view
Sort Directionmvn__CM_Sort_Direction__cPicklistAscending or descending sort for this view
Sort Field API Namemvn__CM_Sort_Field_API_Name__cText(255)API name of the sort field used for this view

Group

Groups define groups of users and are maintained in the CM_Group__mdt custom metadata type.

mvn__CM_Group__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)Custom label used to translate the name of the Group in the user interface.
Descriptionmvn__CM_Description__cText Area(255)Description of the Group.

Installed Product

A list of all products installed in an org is maintained in the mvn__Installed_Product__mdt custom metadata type.

mvn__Installed_Product__mdt schema
Field labelAPI nameData typeDescription
Custom Handler Locationsmvn__Custom_Handler_Locations__cLong Text Area(2000)Comma separated list of custom metadata locations to query for configurable Apex handlers
Custom Permissionmvn__Custom_Permission__cText(255)Comma separated list of custom permission that designates the types of users of this product
Product Versionmvn__Product_Version__cText(10)Version of Scientific Publications Cloud product that is currently installed

Interface Handler

The Interface Handler custom metadata object extends the search interface and makes it possible to query external data sources. Create an Interface Handler record for each external search handler you write.

mvn__PP_Interface_Handler__mdt schema
Field levelAPI nameData typeDescription
Classmvn__PP_Class__cText(40)API name of the class that implements the Interface.
Interfacemvn__PP_Interface__cPicklistInterface (contract) that the Interface Handler record follows. Interface picklist values include: - Contact Omni Search - allows users to use an omni search field. - Contact Filter Search - allows users to perform advanced search and specify field values to search for.
Sequencemvn__PP_Sequence__cNumber(18, 0)The sequence the classes will be called in if there are multiple configured.

Journal Metrics Configuration

The Journal Metric Configuration (mvn__PP_Journal_Metrics_Configuration__mdt) custom metadata type configures the Journal Metric (mvn__PP_DS_Journal_Metric__c) custom object, such as where and how to display a journal metric.

:::: ::: title :::

The Journal Metrics Configuration custom metadata type is only available as part of the Digital Science integration. If you do not have the Digital Science package installed, you will not have this custom metadata type in your instance of Scientific Publications Cloud product. ::::

mvn__PP_Journal_Metrics_Configuration__mdt schema
Field labelAPI nameData typeDescription
Chart Typemvn__PP_Chart_Type__cPicklistThe type of visualization to render for the journal metric in the target comparison screen of the Document Target Search and Proposed Target Search modals. Picklist values include, but are not limited to: - line - bar - pie
Display in Journal Detailsmvn__PP_Display_In_Journal_Details__cCheckboxWhen checked (i.e., true), the journal metric appears on the Journal Record Page.
Display in Journal Searchmvn__PP_Display_In_Journal_Search__cCheckboxWhen checked (i.e., true), the journal metric appears in the Document Target Search modal.
Journal JSON Field Namemvn__PP_Journal_JSON_Fieldname__cText(255)The API name of the field on the Journal (mvn__PP_Journal__c) custom object that contains the JSON data for the journal metric.
Metric Help Text Custom Labelmvn__PP_Metric_Help_Text_Custom_Label__cText(255)The API name of the custom label for the journal metric help text.
Metric Label Custom Labelmvn__PP_Metric_Label_Custom_Label__cText(255)The API name of the custom label for the journal metric label.
Render Asmvn__PP_Render_As__cPicklistThe type of visualization to render for the journal metric. Picklist values are: - Score - Index - Bar - Line Plot
Sectionmvn__PP_Section__cText(255)The name of the collapsible section that the journal metric will appear under.
Sequencemvn__PP_Sequence__cNumber(6, 0)The display order of the journal metric in the specified section.

Key Store

The Key Store (mvn__Key_Store__mdt) metadata type stores secrets or keys to be used by an application.

mvn__Key_Store_mdt schema
Field labelAPI nameTypeDescription
Keymvn__key__cText Area (255)The key to be stored.

Layout

Layouts are managed using the Layout (LY_Layout__mdt) custom metadata type. Each Layout record refers to a specific location in the application.

Note: LY_Layout__mdt records are considered internal system metadata and should not be changed in any way.

mvn__LY_Layout__mdt schema
Field labelAPI nameData typeDescription
Columnsmvn__LY_Columns__cPicklistNumber of columns to use when rendering this layout.
Descriptionmvn__LY_Description__cText Area(255)Layout details, e.g. a description of where the layout is used.
Read Onlymvn__LY_Read_Only__cCheckboxWhen true, the layout is rendered as read only. Otherwise, it is rendered as an editable form.

Layout Fact

The LY_Layout_Fact__mdt object articulates how the rules engine should process layout criteria (mvn__LY_Layout_Type__mdt.mvn__LY_Criteria__c) for custom and standard objects.

mvn__LY_Layout_Fact__mdt
Field labelAPI nameData typeDescription
Apex Class Namemvn__LY_Apex_Class_Name__cText(80)API name of a custom Apex class that tells the rules engine how to process layout criteria (mvn__LY_Layout_Type__mdt.mvn__LY_Criteria__c) for a custom or standard object. This class must implement the LY_ILayoutFact interface.
Apex Class Namespacemvn__LY_Apex_Class_Namespace__cText(80)Namespace of the Apex Class Name.
Prioritymvn__LY_Priority__cNumber(2, 0)Priority in which LY_Layout_Fact__mdt records are used when more than one record exists for the same SObject Type. The Layout Fact record with the highest number is processed first. :::: note ::: title ::: To override a default LY_Layout_Fact__mdt record, create a LY_Layout_Fact__mdt record that has a higher LY_Priority__c. ::::
SObject Typemvn__LY_SObject_Type__cText(80)API name of the SObject.

Layout Field

Layout Field (LY_Layout_Field__mdt) is a junction between Layout Type and Field. Layout Field records control which fields appear on a layout.

mvn__LY_Layout_Field__mdt schema
Field labelAPI nameData typeDescription
Disabledmvn__LY_Disabled__cCheckboxWhether the field is disabled.
Fieldmvn__LY_Field__cMetadata Relationship(Field)Field to be included in the related Layout. A null value inserts a blank space in the layout.
Filtermvn__LY_Filter__cCheckboxWhen true, the field is displayed as a filter. For example, picklist fields display with multiple selections, and date, datetime, and time fields display as a range with a start and end input. :::: note ::: title ::: The Document Wizard does not support displaying date, datetime, and time fields as a range. ::::
Layout Sectionmvn__LY_Layout_Section__cMetadata Relationship(Layout Section)Layout Section where the related field is included.
Layout Typemvn__LY_Layout_Type__cMetadata Relationship(Layout Type)Layout where the related field will be included.
Ordermvn__LY_Order__cNumber(4, 0)Order in which the Layout Field displays in the layout. :::: note ::: title ::: To enable easier re-ordering of Layout Fields, set Order values in increments of 100 up to a maximum Order value of 1,000. This enables you to insert a Layout Field into any position without having to edit Order values for existing Layout Fields. ::::
Requiredmvn__LY_Required__cCheckboxWhether the field is required in an editable form.

Layout Section

The Layout Section (LY_Layout_Section__mdt) custom metadata object groups fields on a layout into sections. Layout Section records are associated to Layout Type (LY_Layout_Type__mdt) and Layout Field (LY_Layout_Field__mdt) records. Associated Layout Type records determines when a section should be used and connects the section to a Layout (mvn__LY_Layout__mdt), and associated Layout Field records define the fields that are part of a section. Layout Field records not associated to a section are automatically placed in a section at the bottom of the layout.

mvn__LY_Layout_Section__c schema
Field labelAPI nameData typeDescription
Columnsmvn__LY_Columns__cPicklistNumber of columns to use when rendering the section.
Custom Label API Namemvn__LY_Custom_Label_API_Name__cText(255)Custom label for the section's header text.
Layout TypeLY_Layout_Type__cMetadata Relationship(Layout Type)Layout Type (mvn__Layout_Type__mdt) custom metadata record associated with the section. The associated record determines where the section is included.
OrderLY_Order__cNumber(4, 0)Order in which the section displays on the layout. :::: note ::: title ::: To enable easier re-ordering of Layout Section, set Order values in increments of 100 up to a maximum Order value of 1,000. This enables you to insert a Layout Section into any position without having to edit Order values for existing Layout Sections. ::::

Layout Type

Layout Types (LY_Layout_Type__mdt) are similar to Salesforce Record Types in that they allow you to display and capture data specific to the type of document or task being managed. For example, since FAQs and Corporate documents have different metadata requirements, you can configure the LY_Document_Edit_Metadata layout to render the FAQ_Edit_Metadata layout type for FAQ document types and the Corporate_Edit_Metadata layout type for Corporate document types. In other words, LY_Layout_Type__mdt records determine when layout types should be used.

mvn__LY_Layout_Type__mdt schema
Field labelAPI nameData typeDescription
Columnsmvn__LY_Columns__cPicklistNumber of columns to use when rendering the Layout. If you select a value, the selected value will override the value set on the associated LY_Layout__mdt record.
Criteriamvn__LY_Criteria__cLong Text Area(32768)JSON criteria used to determine when the Layout Type should be used. For example, the criteria below states that the Document Type of the Document Version must be FAQ__c. Visit Criteria definition. {"path":"documentVersion.mvn__LY_Document_Type__c","operator":"Equals","value":"FAQ__c"} :::: note ::: title ::: To use criteria that is more complex and customizable than what this field supports, create LY_Layout_Fact__mdt records. LY_Layout_Fact__mdt records articulate how the rules engine should process layout criteria (mvn__LY_Layout_Type__mdt.mvn__LY_Criteria__c) for custom and standard objects. ::::
Field Set Namemvn__LY_Field_Set_Name__cText(80)API name of the field set that contains the fields that should be part of the associated layout. :::: note ::: title ::: Field sets that include fields through a lookup or master-detail relationship are not supported. Only direct fields are supported. :::: :::: note ::: title ::: If this field is populated, do not create a mvn__LY_Layout_Field__mdt record for each field that you want to include on the associated layout. ::::
Layoutmvn__LY_Layout__cMetadata Relationship(Layout)The LY_Layout__mdt that will be used if the Criteria is met.
Prioritymvn__LY_Priority__cNumber(18, 0)Priority of the Layout Type. If multiple layout types are found when evaluating layout type criteria, the layout type with the highest priority is used.

List View Object Settings

List views display queries of data. To configure list views, use the List View Object Setting custom metadata type.

Note: For performance reasons, the list view on the Home page of the MCM Console only displays the last 100 records the user viewed. This number is not configurable.

mvn__CM_List_View_Object_Setting__mdt schema
Field labelAPI nameData typeDescription
Columns Field Setmvn__CM_Columns_Field_Set__cText(255)API name of the field set that controls which columns the user can add to a list view.
Most Recently Viewed Columns Field Setmvn__CM_Recently_Viewed_Columns_Field_Set__cText(255)The columns that will display when viewing the "Recently Viewed" documents list view.
Object API Namemvn__CM_Object_API_Name__cText(255)API name of the object that the list view configuration is related to. :::: note ::: title ::: Only the Document Version custom object is supported. Visit Document Version. ::::
Search Result Columns Field Setmvn__CM_Search_Result_Columns_Field_Set__cText(255)API name of the field set that determines the document search result columns.

Log Setting

With the Log Setting custom metadata, you can select the user whom you want to collect logs for and set the date and time when you want to stop capturing information about the selected user.

mvn__Log_Setting__mdt schema
Field labelAPI nameData typeDescription
Log Untilmvn__Log_Until__cDate/TimeThe date and time that you want to stop generating logs.
User IDmvn__User_ID__cTextThe User ID of the user whom you want to generate logs for.

Logger Settings

The Logger Settings custom metadata enables you to set the debug log level and whether logs written to CM_Logger publish platform events.

mvn__Logger_Settings__mdt schema
Field labelAPI nameData typeDescription
Log Levelmvn__Log_Level__cPicklistThe debug log level. Visit Debug logs.
Publish Log Eventsmvn__Publish_Log_Events__cCheckboxWhen checked logs written to CM_Logger will publish platform events. :::: note ::: title ::: This value should only be checked for emergency debugging purposes as it risks consuming platform event deliveries in the org. ::::

MCM Global Setting

MCM Global Settings are stored using the static CM_Global_Setting__mdt.CM_Default custom metadata type record.

Note: You may modify CM_Global_Setting__mdt.CM_Default values; however, this record is considered system metadata and should not be removed.

mvn__CM_Global_Setting__mdt schema
Field labelAPI nameData typeDescription
Complete Tasks on Behalf of Other Usersmvn__CM_Task_Completion_On_Behalf_Of_Enabled__cCheckboxWhen checked, document collaborators with the CM_TaskApproverOnBehalfOf permission set can complete tasks on behalf of the originally assigned user.
Default Document Lifecyclemvn__CM_Default_Document_Lifecycle__cMetadata Relationship(Document Lifecycle)The lifecycle a document goes in if a lifecycle cannot be automatically applied.
Default Document Statemvn__CM_Default_Document_State__cMetadata Relationship(Document Lifecycle)Default Document State for new Document records.
Document Clone Excluded Fieldsmvn__CM_Document_Clone_Excluded_Fields__cNumber(18, 0)Developer name of the field set containing the fields that are excluded when cloning a document version.
Document Expiration Reminder Daysmvn__CM_Document_Expiration_Reminder_Days__cNumberNumber of days before a document is expired to send a reminder notification.
Document Scheduled Publish Batch Sizemvn__CM_Publish_Batch_Size__cNumber(3, 0)Number of records to be processed in each batch when publishing document versions scheduled to be published. The scheduled publishing batch size for document versions is a positive number less than 200.
Document Search Field Set Namemvn__CM_Document_Search_Field_Set_Name__cText(255)The API Name of the field set that contains the CM_Document_Version__c fields to be returned when using the Document Search API.
Enable Changelog Requirementmvn__CM_Enable_Changelog_Requirement__cCheckboxWhen true, as is by default, users are required to provide a "reason for change" when creating a new document version or checking in a document.
Enable Edit Metadata on Check Outmvn__CM_Enable_Edit_Metadata_Checkout__cCheckboxWhen true, users with the Edit Metadata document permission can modify the metadata of checked out documents.
Enable External Files Connect Servicemvn__CM_Enable_External_Files_Connect__cCheckboxWhen true, the premium Files Connect integration and the external service are enabled for the org.
Enhanced Viewer Extensionsmvn__CM_Enhanced_Viewer_Extensions__cText AreaComma-separated list of file extensions (e.g. .docx, .pdf, .xlsx) to render in the enhanced document viewer. :::: note ::: title ::: The enhanced document viewer only supports the .pdf file extension. ::::
Files Connect Environmentmvn__CM_Files_Connect_Environment__cPicklistThe environment for the Files Connect service. Picklist values include: - Production - Staging - Dev
Files Connect Excel Templatemvn__CM_Files_Connect_Excel_Template__cText(80)The name of the template static resource to use when creating a new Microsoft Excel file.
Files Connect PowerPoint Templatemvn__CM_Files_Connect_PowerPoint_Template__cText(80)The name of the template static resource to use when creating a new Microsoft PowerPoint file.
Snapshot file to current versionmvn__CM_Files_Connect_Snapshot_To_Current__cCheckboxWhen checked (true), the creation of a new snapshot saves the content from the Files Connect service into the current document version and a new document version will be created that references the external file in Google Drive. When unchecked (false), a new document version will be created with the content from the Files Connect service.
Files Connect Word Templatemvn__CM_Files_Connect_Word_Template__cText(80)The name of the template static resource to use when creating a new Microsoft Word file.
Hide External File Buttonmvn__CM_Hide_External_File_Button__cCheckboxWhen checked (true), the External Link option in the New Document wizard will be hidden.
Hide Files Connect File Buttonmvn__CM_Hide_Files_Connect_File_Button__cCheckboxWhen checked (true), the Files Connect option in the New Document wizard will be hidden.
Hide M365 File Buttonmvn__CM_Hide_M365_File_Button__cCheckboxWhen checked (true), the Microsoft 365 option in the New Document wizard will be hidden.
Hide No File Buttonmvn__CM_Hide_No_File_Button__cCheckboxWhen checked (true), the No File option in the New Document wizard will be hidden.
Hide Translation File Buttonmvn__CM_Hide_Translation_File_Button__cCheckboxWhen checked (true), the Translation File option in the New Document wizard will be hidden.
Hide Upload File Buttonmvn__CM_Hide_Upload_File_Button__cCheckboxWhen checked (true), the Upload File option in the New Document wizard will be hidden. The Upload File option will still appear in the Package Files component.
Ignore Permission on Document Publishmvn__CM_Ignore_Permission_on_Document_Publish__cCheckboxWhen checked, a user can mark related documents as obsolete when publishing a document even if the user does not have access/permission for those records
Product API Namemvn__CM_Product__cPicklistProduct Catalog API Name.
Require Electronic Signaturesmvn__CM_Require_Electronic_Signatures__cCheckboxWhen checked, electronic signature is required when completing all workflow activities. Visit Electronic signature.
Salesforce API Versionmvn__CM_Salesforce_API_Version__cNumber(4, 1)Salesforce API Version used by MCM.
Stop User with Open Tasks Inactivemvn__CM_Stop_User_With_Open_Tasks_Inactive__cCheckboxWhen checked, if a user is deactivated an error will prevent this action if the user has open tasks.
Strict Document Rolesmvn__CM_Strict_Document_Roles__cCheckboxWhen checked, Document Roles will be removed when users have completed assigned workflow activities.
System Fields Field Set Namemvn__CM_System_Fields_Field_Set_Name__cTextAPI Name of the Document Version field set that contains fields that are considered system fields. Fields in this field set are not copied when cloning a document.

Microsoft 365 Setting

The Microsoft 365 Setting (mvn__CA_Office_365_Setting__mdt) custom metadata contains settings related to the Microsoft 365 integration. With this metadata, you can enable Microsoft 365 for an org and declare the subdomain of the Microsoft 365 instance that you want to use.

mvn__CA_Office_365_Setting__mdt schema
Field labelAPI nameData typeDescription
Enabledmvn__CA_Enabled__cCheckboxWhether the Microsoft 365 server is enabled for the org.
Environmentmvn__CA_Environment__cStringThe Microsoft 365 environment that the environment is integrating with.
Subdomainmvn__CA_Subdomain__cText(255)Subdomain of the Microsoft 365 instance. The production subdomain that all customers use is office, and the subdomain of the test instance that developers can use is office--test.
User Overrides Apex Class Namemvn__CA_User_Overrides_Apex_Class__cText(255)Apex class implementing the CA_IOffice365CheckoutUserOverrides interface. This interface customizes the Microsoft 365 user interface based on the type of user checking out the document to Microsoft 365.
User Overrides Apex Class Namespacemvn__CA_User_Overrides_Apex_Namespace__cText(15)Namespace of the Apex class defined in the CA_User_Override_Apex_Class__c field.

Milestone Service Level

The Milestone Service Level (mvn__PP_Milestone_Service_Level__mdt) custom metadata object defines milestone service level templates. Milestone Service Level is a junction between the Service Level and Milestone Type custom metadata objects.

mvn__PP_Milestone_Service_Level__mdt schema
Field labelAPI nameData typeDescription
Milestone Typemvn__PP_Milestone_Type__cMetadata Relationship(Milestone Type)Lookup relationship to the milestone type.
Service Levelmvn__PP_Service_Level__cMetadata Relationship(Service Level)Lookup relationship to the service level.

Milestone Type

The Milestone Type (mvn__PP_Milestone_Type__mdt) custom metadata object defines milestone templates.

mvn__PP_Milestone_Type__mdt schema
Field labelAPI nameData typeDescription
Date API Field Namemvn__PP_Date_API_Field_Name__cText(80)API name of the sObject date field that maps to the milestone PP_Date__c.
Days Added to Datemvn__PP_Days_Added_to_Date__cNumber(6, 0)Number of days added (or subtracted) to the milestone PP_Date__c.
Milestone Completion Criteriamvn__PP_Milestone_Completion_Criteria__cLong Text Area(32768)JSON criteria used to determine when a milestone record should be completed. The path property must reference the document, studyDocument, and/or target object using dot notation. :::: note ::: title ::: This field is only required for the Document sObject. :::: For example, the criteria below states that the Document Latest Version Status must be PP_Review_Complete. { "path": "document.mvn__CM_Latest_Version_Status__c", "operator": "Equals", "value": "PP_Review_Complete" }
Milestone Creation Criteriamvn__PP_Milestone_Creation_Criteria__cLong Text Area(32768)JSON criteria used to determine when a milestone record should be created. The path property must reference the document, studyDocument, and/or target object using dot notation. Example criteria include: { "path": "document.mvn__CM_Latest_Version_Type__c", "operator": "Equals", "value": "PP_Publication" } { "path": "studyDocument.CreatedDate", "operator": "NotEquals", "value": "null" } { "path": "studyDocument.mvn__PP_Document__r.mvn__CM_Latest_Version__r.mvn__CM_Document_Type__c", "operator": "Equals", "value": "Publication" }
Milestone Namemvn__PP_Milestone_Name__cText(80)Title or name of the milestone. This field maps to milestone Name.
Milestone Record Typemvn__PP_Milestone_Record_Type__cPicklistDesignated milestone record type.
Milestone Statusmvn__PP_Milestone_Status__cPicklistDesignated milestone status value. Picklist values include: - Pending - milestone is incomplete. - Completed - milestone is concluded. - N/A - milestone status is not applicable.
SObjectmvn__PP_SObject__cPicklistSObject for which milestone records are created. Picklist values include: - Document - Study Document - Target
SObject Document Field API Namemvn__PP_SObject_Document_Field_API_Name__cText(80)API name of the related document lookup field on the junction sObject (e.g. mvn__PP_Document__c). This field maps to the milestone PP_Document__c. :::: note ::: title ::: This field is only required when mvn__PP_SObject__c is set to Study Document or Target. ::::

Office 365 Override

Configuration object for mapping profiles to Microsoft 365 URLs.

mvn__PP_Office365_Override__mdt
Field labelAPI nameData typeDescription
Action Return URLmvn__PP_Action_Return_URL__cText(255)The action return URL for the Override.
Action Return URL Namemvn__PP_Action_Return_URL_Name__cText(255)The action return URL name for the Override.
Action URLmvn__PP_Action_URL__cText(255)The action URL for the Override.
Action URL Namemvn__PP_Action_URL_Name__cText(255)The action URL name for the Override.
Close URLmvn__PP_Close_URL__cText(255)The close URL for the Override.
Profile Namemvn__PP_Profile_Name__cText(255)The name of the profile that the Override maps to.
Use Collaborator Portal URLmvn__PP_Use_Collaborator_Portal_URL__cCheckboxIndicates if the action return URL should default to the Collaborator Portal base URL configured in the Pubs Global Settings.

Permission

Scientific Publications Cloud ships with eleven predefined permissions, which can be found in the CM_Permission__mdt custom metadata type. Each permission grants a user or group of users a system-defined action at either the document or document version level. Once granted, document-level permissions give users the ability to perform actions regardless of the document's state. Document version-level permissions are governed by the matrix model of state and permission.

mvn__CM_Permission__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText Area(255)API name of the associated Custom Label.
Descriptionmvn__CM_Description__cText Area(255)Description of the permission.
SObject API Namemvn__CM_SObject_API_Name__cText Area(255)API name of the SObject from where to get the permission.

Pubs API Version

The Pubs API Version (mvn__PP_Pubs_API_Version__mdt) custom metadata type tracks the active and inactive versions of the Pubs API that is used in the Collaborator Portal and called by external API clients.

Note: Scientific Publications Cloud product ships with the appropriate Pubs API Version metadata records that indicate which Pubs API versions are active and inactive in the Collaborator Portal and in API client calls. You should only modify the metadata records if you decide to revert the available APIs to a previous version.

mvn__PP_Pubs_API_Version__mdt schema
Field labelAPI nameData typeDescription
Is Active?mvn__PP_isActive__cCheckboxWhen checked, the versions specified in this Pubs API Version metadata record are the active Pubs API versions used in the Collaborator Portal and called by external API clients.
Portal API Versionmvn__PP_Portal_API_Version__cText(80)The API version of the Pubs API that is used in the Collaborator Portal.
Pubs API Versionmvn__PP_Pubs_API_Version__cText(80)The API version of the Pubs API that is called by an external API client.

Pubs Global Setting

The Pubs Global Setting (mvn__PP_Global_Setting__mdt) custom metadata type configures areas of the system, such as the following:

Warning: If you update this custom metadata type or any of its metadata records, you must clear its cache for the changes to take effect. For information on how to clear the cache, reference Platform cache.

mvn__PP_Global_Setting__mdt schema
Field labelAPI nameData typeDescription
Active Publication Criteriamvn__PP_Active_Publication_Criteria_V2__cLong Text Area(32768)The JSON criteria used to determine if a publication should be considered active. For information on how to write the JSON criteria, reference Criteria definition.
Author Search Popover Field Setmvn__PP_Author_Search_Popover_Field_Set__cText(70)The API name of the field set on the Contact object that determines which fields will appear when users hover on a contact in the Document Collaborator Search results list view.
Author Search Result Field Setmvn__PP_Author_Search_Result_Field_Set__cText(70)The API name of the field set on the Contact object that determines which fields will appear in the Document Collaborator Search results list view.
Author Search Result Record Limitmvn__PP_Author_Search_Result_Record_Limit__cNumber(3, 0)The number of records to appear in the Document Collaborator Search results.
Clone Collaborators on Document Clonemvn__PP_Doc_Collaborator_Propagation_on_Clone__cCheckboxWhen true, the related Document Collaborator (mvn__PP_Document_Author__c) records are copied/propagated onto cloned documents.
Cloned Doc Collaborator Field Set Namemvn__PP_Cloned_Doc_Collab_Field_Set_Name__cText(80)The API name of the Document Collaborator (mvn__PP_Document_Author__c) field set that contains the fields to be copied onto cloned documents.
Collaborator Portal Base URLmvn__PP_Collaborator_Portal_Base_URL__cText(255)The base URL of the Collaborator Portal.
Congress Compare Field Set Namemvn__PP_Congress_Compare_Field_Set_Name__cText(80)The API name of the field set on the Congress (mvn__Congress__c) object used to compare Congress records on the target comparison screen of the Document Target Search modal. This field set appears below the field set specified in the Target Congress Compare Field Set Name field of the same metadata record.
Congress Location Compare Field Set Namemvn__PP_Cong_Loc_Compare_Field_Set_Name__cText(80)The API name of the field set on the Congress Location (mvn__Congress_Location__c) object containing the fields displayed in the Document Target Search modal.
Congress Search Field Set Namemvn__PP_Congress_Search_Field_Set_Name__cText(80)The API name of the field set on the Congress (mvn__Congress__c) object that determines which columns will appear in the search results list view of the Document Target Search modal.
Congress Search Query Field Set Namemvn__PP_Congress_Search_Query_Field_Set__cText(80)The API name of the field set on the Congress (mvn__Congress__c) object that determines the fields to be queried in the Document Target Search modal.
Contact User Email Checkmvn__PP_Contact_User_Email_Check__cCheckboxWhen checked, the email address of new Contact records with a record type are checked against that of active users. If the email address of a new contact matches the email address of an active user, an error message will appear.
Default Collab Search to Advancedmvn__PP_Default_Collab_Search_To_Advanced__cCheckboxWhen checked, the Document Collaborator Search wizard will default to the advanced search experience.
Default Concept Target Search To Journalmvn__PP_Default_Con_Tgt_Search_To_Journal__cLong Text Area(32768)The JSON criteria used to determine when the default target type in the Proposed Target Search component for concepts should be set to journals. For information on how to write the JSON criteria, reference Criteria definition.
Default Pln Bdt Target Search To Journalmvn__PP_Default_Bdg_Tgt_Search_To_Journal__cLong Text Area(32768)The JSON criteria used to determine when the default target type in the Proposed Target Search component for plan budgets should be set to journals. For information on how to write the JSON criteria, reference Criteria definition.
Default Target Search To Journalmvn__PP_Default_Target_Search_To_Journal__cLong Text Area(32768)The JSON criteria used to determine when the default target type in the Document Target Search modal should be set to to journals. For information on how to write the JSON criteria, reference Criteria definition.
Doc Role Error No Collab Criteriamvn__PP_Error_For_No_Collaborator_Criteria__cLong Text Area(32768)The JSON criteria used to determine whether or not an error should appear if no Document Collaborator record exists for the user when assigning the user a document role. For information on how to write the JSON criteria, reference Criteria definition.
Document Clone Included Fieldsmvn__PP_Document_Clone_Included_Fields__cText(255)The API name of the field set on the Document Version (mvn__CM_Document_Version__c) object that specifies which fields to include when a document version is cloned.
Document Collab Search V2 Enabledmvn__PP_Document_Collab_Search_V2_Enabled__cCheckboxWhen checked, Document Collaborator Search wizard V2 is enabled. This is the unified Document Collaborator Search experience.
Enable Expanded Doc Collaborator Listmvn__PP_Enable_Expanded_Doc_Collaborator_List__cCheckboxWhen checked, each row in the Document Collaborators component can be expanded to display all of the activities and communications related to a specific document collaborator.
Enhanced Doc Revision Historymvn__PP_Enhanced_Doc_Revision_History__cCheckboxWhen checked, the enhanced timeline view of the SPC - Document Version History (ppDocumentVersionHistory) Lightning component is used. When unchecked, the feed view of the component is used.
External User Iconmvn__PP_External_User_Icon__cText(255)The icon used to represent external users in the Document Collaborator Search results.
External User Icon Labelmvn__PP_External_User_Icon_Label__cText(255)The label used to describe external users in the Document Collaborator Search results.
Group Iconmvn__PP_Group_Icon__cText(255)The icon used to represent groups in the Document Collaborator Search results.
Group Icon Labelmvn__PP_Group_Icon_Label__cText(255)The label used to describe groups in the Document Collaborator Search results. This appears when users hover on the group icon.
Internal User Iconmvn__PP_Internal_User_Icon__cText(255)The icon used to represent internal users in the Document Collaborator Search results.
Internal User Icon Labelmvn__PP_Internal_User_Icon_Label__cText(255)The label used to describe internal users in the Document Collaborator Search results. This appears when users hover on the internal user icon.
Journal Compare Field Set Namemvn__PP_Journal_Compare_Field_Set_Name__cText(80)The API name of the field set on the Journal (mvn__PP_Journal__c) object used to compare Journal records on the target comparison screen of the Document Target Search modal. This field set appears below the field set specified in the Target Journal Compare Field Set Name field of the same metadata record.
Journal Search Field Set Namemvn__PP_Journal_Search_Field_Set_Name__cText(80)The API name of the field set on the Journal (mvn__PP_Journal__c) object that determines which columns appear in the search results list view of the Document Target Search modal.
Journal Search Query Field Set Namemvn__PP_Journal_Search_Query_Field_Set__cText(80)The API name of the field set on the Journal (mvn__PP_Journal__c) object that determine the fields to be queried when searching in the Document Target Search modal.
Prop Target Cng Related Field Set Namemvn__PP_Prop_Trgt_Cng_Related_Field_Set_Name__cText(80)The API name of the field set on the Target (mvn__PP_Target__c) object that determines which fields appear in the Targets related list for proposed target congresses. By default, the Target Related List - Congress (mvn__PP_Target_Related_List_Congress) field set is used.
Prop Target Jrnl Related Field Set Namemvn__PP_Prop_Trgt_Jrnl_Related_Field_Set_Name__cText(80)The API name of the field set on the Target (mvn__PP_Target__c) object that determines which fields appear in the Targets related list for proposed target journals. By default, the Target Related List - Journal (mvn__PP_Target_Related_List_Journal) field set is used.
Publication Document Criteriamvn__PP_Publication_Document_Criteria__cLong Text Area(32768)The JSON criteria used to determine if a document qualifies as a publication document and therefore if the document should automatically create Document Collaborator (mvn__PP_Document_Author__c) records for owners and plan team members. For information on how to write the JSON criteria, reference Criteria definition.
Publication Objective Autonamemvn__PP_Publication_Objective_Autoname__cCheckboxWhen checked, the system will autoname new publication objectives in the Publication wizard. By default, this field is not checked.
Publication Tracker Settingsmvn__PP_Publication_Tracker_Settings__cLong Text Area(32768)The JSON configuration for styling the Publications Tracker on the Home page, including the display name, colors, and cssKeys for each document state.
Pub Wizard Add Related Objectsmvn__PP_Pub_Wizard_Add_Related_Objects__cLong Text Area(32768)The JSON object that specifies which sObjects can be selected in the Add menu of the Relate Data step in the Publication wizard. :::: note ::: title ::: By default, users cannot relate Target (mvn__PP_Target__c) records. To enable users to relate targets: 1. In the PP_Default Pubs Global Setting metadata record, click Edit. 2. In the Pub Wizard Add Related Objects field, update "targets": false to "targets": true. 3. Click Save. 4. Clear the platform cache for the ppDefault cache partition. ::::
Rate Card Search Display Fieldmvn__PP_Rate_Card_Search_Field__cText(80)The API name of the Rate Card (mvn__PP_Rate_Card__c) field that should appear as the second line of the Rate Card combobox in the Publication wizard.
Target Congress Compare Field Set Namemvn__PP_Trgt_Congress_Compare_Field_Set_Name__cText(80)The API name of the field set on the Target (mvn__PP_Target__c) object used to compare Congress (mvn__Congress__c) records on the target comparison screen of the Document Target Search modal. This field set appears above the field set specified in the Congress Compare Field Set Name field of the same metadata record.
Target Congress Related Field Set Namemvn__PP_Trgt_Congress_Related_Field_Set_Name__cText(80)The API name of the field set on the Congress (mvn__Congress__c) object that determines which fields appear in the Targets related list.
Target Journal Compare Field Set Namemvn__PP_Target_Journal_Compare_Field_Set_Name__cText(80)The API name of the field set on the Target (mvn__PP_Target__c) object used to compare Journal (mvn__PP_Journal__c) records on the target comparison screen of the Document Collaborator Search modal. This field set appears above the field set specified in the Journal Compare Field Set Name field of the same metadata record.
Target Journal Related Field Set Namemvn__PP_Target_Journal_Related_Field_Set_Name__cText(80)The API name of the field set on the Journal (mvn__PP_Journal__c) object that determines which fields appear in the Targets related list.
User Search Result Field Setmvn__PP_User_Search_Popover_Field_Set__cText(70)The API name of the field set on the User object that determines which fields will appear when users hover on a user in the Document Collaborator Search results list view.
User Search Result Field Setmvn__PP_User_Search_Result_Field_Set__cText(70)The API name of the field set on the User object that determines which fields will appear in the Document Collaborator Search results list view.

Relationship Visualizer Configuration

The Relationship Visualizer Configuration (mvn__RV_Relationship_Visualizer_Configuration__mdt) custom metadata type configures the Relationship Visualizer, including how document relationships are visualized in and how users can interact with the component.

mvn__RV_Relationship_Visualizer_Configuration__mdt schema
Field labelAPI nameData typeDescription
Apex Implementation Classmvn__RV_Apex_Implementation_Class__cText(57)The Apex service class that implements the non-global RV_IRelationshipVisualizer interface.
Card Styles Static Resourcemvn__RV_Card_Styles_Resource_Name__cText(35)The static resource that styles the Relationship Visualizer. It should contain a card-styles.css file. If blank, the default styling will be used.
Default Legend Configurationmvn__RV_Default_Legend_Configuration__cLong Text Area(570)A JSON array that defines the items in the legend. The "label" property should be the API name of a custom label. If blank, the default configuration will be used. Each legend item to be included in the JSON array should be formatted as follows: [ { "value": "anchor", "label": "<Custom_Label_API_Name>", "checked": true } ]
Default Zoom Levelmvn__RV_Default_Zoom_Level__cPicklistThe initial zoom level, or starting zoom percentage, for the canvas. If blank, this will default to 100%.
Draggablemvn__RV_Draggable__cCheckboxWhen checked (i.e., true), as it is by default, users can drag and pan the canvas.
Enable Drop Shadowmvn__RV_Enable_Drop_Shadow__cCheckboxWhen checked (i.e., true), as it is by default, a drop shadow appears for each node and label. :::: note ::: title ::: Mavens recommends unchecking this (i.e., set to false) to improve the performance and load time of the canvas. ::::
Field Set Namemvn__RV_Field_Set_Name__cText(57)The API name of the field set that contains the fields for the pop-up card that opens when a user clicks a node in the canvas. This field set must exist on the object that is set on the Object Name field below.
Max Nodes Per Groupmvn__RV_Max_Nodes_Per_Group__cNumber(6, 0)The maximum number of nodes for each document relationship group (i.e., parent, related, and child node groups). If blank, there is no limit. :::: note ::: title ::: Mavens recommends setting a limit to improve the performance and load time of the canvas. ::::
Max Zoom Levelmvn__RV_Max_Zoom_Level__cPicklistThe maximum zoom level, or the highest zoom percentage, for the canvas. If blank, this will default to 100%.
Min Zoom Levelmvn__RV_Min_Zoom_Level__cPicklistThe minimum zoom level, or the lowest zoom percentage, for the canvas. If blank, this will default to 10%.
Object Namemvn__RV_Object_Name__cText(62)The API name of the object whose fields should appear in the Relationship Visualizer. For fields that should appear in the pop-up card that opens when a user clicks a node in the canvas, create a field set and set the API name on the Field Set Name field above.
Popup Titlemvn__RV_Popup_Title__cText(30)The custom title for the pop-up card that opens when a user clicks a node in the canvas. If blank, this defaults to "Item Details."
Relationship Label Max Lengthmvn__RV_Relationship_Label_Max_Length__cNumber(3, 0)The maximum number of characters that can appear for the relationship labels between two nodes. Additional characters will be truncated and replaced with an ellipsis. If blank, this defaults to 15.
Zoomablemvn__RV_Zoomable__cCheckboxWhen checked (i.e., true), as it is by default, users can zoom in and out of the canvas.
Zoom Stepmvn__RV_Zoom_Step__cPicklistThe zoom step percentage when a user zooms in or out of the canvas using the arrow keys in the top left corner. If blank, this defaults to 25%.

Rendition Type

With the Rendition Type custom metadata, you can configure different types of renditions. Users are required to select a Rendition Type when adding a rendition to a Document Version record.

mvn__CM_Rendition_Type__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText Area(255)API name of the custom label to translate the name of this rendition in the user interface.
Descriptionmvn__CM_Description__cText Area(255)Description of how the rendition is intended to be used.

Role

Roles define the function or capacity in which a user or group of users can act. By themselves, roles do not provide users or groups of users permission to perform actions. Only when they are combined with document states and permissions do they grant access to documents.

mvn__CM_Role__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)Custom Label API Name used to translate the name of the role in the user interface

Role Notification Configuration

Role notifications are managed using the CM_Role_Notification_Configuration__mdt custom metadata type. Each record defines what notifications users in specific roles receive when specific system events occur.

mvn__CM_Role_Notification_Configuration__mdt schema
Field labelAPI nameData typeDescription
Emailmvn__CM_Email__cCheckboxWhether to send an email. When checked, users assigned to a role receive an email.
Notificationmvn__CM_Notification__cCheckboxWhether to send a notification. When checked, users assigned to a role receive a custom notification.
Relationship Typemvn__CM_Relationship_Type__cText(255)When populated, this configuration is associated to a specific relationship type, e.g. Bundle, Relevant, Sourced, Local Version, or Translation. Visit Relationships.
Rolemvn__CM_Role__cMetadata Relationship(Role)The associated role. Visit Document roles.
System Event Namemvn__CM_System_Event_Name__cText(255)The system event that causes the notification.

Service Level

The Service Level custom metadata object defines payment amount structures for Plan Budget Line Item records, which are used to calculate the amount due for related Milestone records.

Service Level has a metadata relationship with the Milestone Service Level custom metadata object, which is a junction between the Service Level and Milestone Type custom metadata objects. A single Service Level record can be associated with multiple Milestone Service Level records.

mvn__PP_Service_Level__mdt schema
Field LabelAPI nameData typeDescription
Amount %mvn__PP_Amount_Percent__cPercent(6, 2)Designated amount percent used to calculate Milestone amount.
Budget Line Item Record Typemvn__PP_Budget_Line_Item_Record_Type__cText(255)Plan Budget Line Item record type for the corresponding Service Level.
Service Levelmvn__PP_Service_Level__cText(255)Designated Service Level value.

Service Setting

The Service Setting custom metadata contains the settings specific to individual services that rely on content authoring.

mvn__CA_Service_Setting__mdt schema
Field labelAPI nameData typeDescription
Descriptionmvn__CA_Description__cText Area(255)Description of the setting.
Permission Apex Classmvn__CA_Permission_Apex_Class__cText(56)Name of the Apex class that implements CA_IPermissionService. Include the namespace of the class if the class is outside of the mvn namespace, e.g. mynamespace.MyClass.

Supporting Document Type

The Supporting Document Type (mvn__PP_Supporting_Document_Type__mdt) metadata type is a configuration object used to define supporting document types.

mvn__PP_Supporting_Document_Type__mdt schema
Field labelAPI nameData typeDescription
Document Typemvn__PP_Document_Type__cMetadata Relationship(Document Type)Document type or subtype.
Rolemvn__PP_Collaborator_Role_Assignment__cMetadata Relationship(Role)Lookup relationship to the role that should be assigned to the document author when they download the document.

System Event

The System Event (mvn__SE_System_Event__mdt) custom metadata object defines system wide events that can be listened and processed using a configured custom Apex class. System Event is on the master side of a master-detail relationship with the System Event Configuration (mvn__SE_System_Event_Configuration__mdt) custom metadata object.

mvn__SE_System_Event__mdt schema
Field labelAPI nameData typeDescription
Create Document Audit Logmvn__CM_Create_Document_Audit_Log__cCheckboxIndicates if a Document Audit Log entry is created for the system event (true) or not created (false).
Create Document Chatter Postmvn__CM_Create_Document_Chatter_Post__cCheckboxIndicates if a feed item entry is created in the document record for the system event (true) or not created (false).
Custom Label API Namemvn__SE_Custom_Label_API_Name__cText(80)API name for the custom label to use with the system event.
Document Typemvn__PP_Document_Type__cMetadata Relationship(Document Type)Lookup relationship to the document type.
Payload Apex Class Namemvn__SE_Payload_Apex_Class_Name__cText(255)API name of the Apex class that implements the SE_ISystemEventApexClassPayload interface and defines the payload type for the system event. Leave this field blank if the system event uses a list of SObjects as the payload.
Payload Apex Class Namespacemvn__SE_Payload_Apex_Class_Namespace__cText(15)Namespace of the Apex class defined in the Payload Apex Class Name field.
Portal URL Pathmvn__PP_Portal_URL_Path__cText(255)Extension of the URL path to be used in the call to action.
Prioritymvn__SE_Priority__cNumber(18, 0)Order in which the system event should be processed. A system event with a Priority of 1 is processed before a system event with a Priority of 2.

System Event Configuration

The System Event Configuration (mvn__SE_System_Event_Configuration__mdt) custom metadata object configures handlers for system events. System Event Configuration is on the detail side of a master-detail relationship with the System Event (mvn__SE_System_Event__mdt) custom metadata object.

mvn__SE_System_Event_Configuration__mdt schema
Field labelAPI nameData typeDescription
Activemvn__SE_Active__cCheckboxIndicates if the system event configuration should be processed (true) or not processed (false).
Handler Namemvn__SE_Handler_Name__cText(40)API name of the Apex class used for this configuration.
Handler Namespacemvn__SE_Handler_Namespace__cText(15)Namespace of the Apex class handling the system event.
System Eventmvn__SE_System_Event__cMetadata Relationship(System Event)System Event (mvn__SE_System_Event__mdt) record listened by this configuration.

System Event Setting

The System Event Setting (mvn__SE_System_Event_Setting__mdt) custom metadata type contains configuration settings that affect all system events.

mvn__SE_System_Event_Setting__mdt schema
Field labelAPI nameData typeDescription
Default Email Logo URLmvn__SE_Default_Email_Logo_URL__cLong Text Area(1000)The default email logo URL used in system event emails.
Disable Chatter Postsmvn__SE_Disable_Chatter_Posts__cCheckboxIndicates if Chatter post notifications for systems events are disabled (true) or enabled (false). This setting is helpful during data loads.
Disable Notificationsmvn__SE_Disable_System_Event_Notifications__cCheckboxIndicates if all notification channels for system events are disabled (true) or enabled (false).
Email Call To Action Button Colormvn__SE_Email_Call_To_Action_Button_Color__cText(8)The hex value of the fill color of the call-to-action button in emails. If left blank, the default value is purple (3a225d).
Email Call To Action Text Colormvn__SE_Email_Call_To_Action_Text_Color__cText(8)The hex value of the text color of the call-to-action button in emails. If left blank, the default value is white (ffffff).
Org Wide Sender Email Addressmvn__PP_Org_Wide_Sender_Email_Address__cText(255)The Org Wide Email address for notifications.
Portal URLmvn__PP_Portal_URL__cText(255)The base URL of the Collaborator Portal.

Trigger Action

The Trigger Action (mvn__TAF_Trigger_Action__mdt) custom metadata type represents an individual trigger action to be executed on an sObject via the Trigger Action Framework. The trigger action can be either an Apex action or a flow action.

mvn__TAF_Trigger_Action__mdt schema
Field labelAPI nameData typeDescription
After Deletemvn__TAF_After_Delete__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the AFTER DELETE context.
After Insertmvn__TAF_After_Insert__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the AFTER INSERT context.
After Undeletemvn__TAF_After_Undelete__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the AFTER UNDELETE context.
After Updatemvn__TAF_After_Update__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the AFTER UPDATE context.
Allow Flow Recursion?mvn__TAF_Allow_Flow_Recursion__cCheckboxWhen true, the flow can execute recursively.
Apex Class Namemvn__TAF_Apex_Class_Name__cText(255)The name of the Apex class that defines the trigger action.
Apex Class Namespacemvn__TAF_Apex_Class_Namespace__cText(15)The namespace of the Apex class.
Before Deletemvn__TAF_Before_Delete__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the BEFORE DELETE context.
Before Insertmvn__TAF_Before_Insert__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the BEFORE INSERT context.
Before Updatemvn__TAF_Before_Update__cMetadata Relationship(Trigger sObject Setting)The related Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) metadata record that represents the sObject on which the trigger action should be executed. This action will execute in the BEFORE UPDATE context.
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxWhen true, the trigger action is bypassed and not executed.
Bypass Permissionmvn__TAF_Bypass_Permission__cText(97)The API name of a custom permission that users must have in order for the trigger or action to be bypassed for them. This is optional.
Descriptionmvn__TAF_Description__cLong Text Area(32768)A description of the trigger action.
Flow Namemvn__TAF_Flow_Name__cText(97)The API name of the flow that defines the trigger action.
Ordermvn__TAF_Order__cNumber(4, 2)The order in which the trigger action should be executed.
Required Permissionmvn__TAF_Required_Permission__cText(97)The API name of a custom permission that users must have in order for the trigger or action to be executed for them. This is optional.

Trigger Finalizer

The Trigger Finalizer (mvn__TAF_DML_Finalizer__mdt) custom metadata type represents a Data Manipulation Language (DML) finalizer that can be called via the Trigger Action Framework.

mvn__TAF_DML_Finalizer__mdt schema
Field labelAPI nameData typeDescription
Apex Class Namemvn__TAF_Apex_Class_Name__cText(255) (Unique Case Insensitive)The name of the Apex class that defines the DML finalizer.
Apex Class Namespacemvn__TAF_Apex_Class_Namespace__cText(15)The namespace of the Apex class.
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxWhen true, the DML finalizer is bypassed and not executed.
Bypass Permissionmvn__TAF_Bypass_Permission__cText(97)The API name of a custom permission that users must have in order for the trigger or action to be bypassed for them. This is optional.
Ordermvn__TAF_Order__cNumber(4, 2)The order in which the DML finalizer should be executed.
Required Permissionmvn__TAF_Required_Permission__cText(97)Optional. Enter the API name of a permission. If this field has a value, then the triggers on this object will only execute if the running user has the custom permission identified.

Trigger sObject Setting

The Trigger sObject Setting (mvn__TAF_sObject_Trigger_Setting__mdt) custom metadata type represents an sObject on which a trigger should be executed on via the Trigger Action Framework.

mvn__TAF_sObject_Trigger_Setting__mdt schema
Field labelAPI nameData typeDescription
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxWhen true, all trigger actions are bypassed and do not execute on this sObject.
Bypass Permissionmvn__TAF_Bypass_Permission__cText(97)The API name of a custom permission that users must have in order for the trigger or action to be bypassed for them. This is optional.
Object API Namemvn__TAF_Object_API_Name__cText(40)The API name of the sObject on which trigger actions should be executed (or bypassed). If the sObject is part of a managed package, do not include the prefix on this field and instead set the prefix on the Object Namespace field.
Object Namespacemvn__TAF_Object_Namespace__cText(15)The namespace of the sObject. This is only required if the sObject on the Object API Name field is from a managed package.
Required Permissionmvn__TAF_Required_Permission__cText(97)The API name of a custom permission that users must have in order for the trigger or action to be executed for them. This is optional.

Unpaywall Setting

The configuration of the Unpaywall Setting (mvn__PP_Unpaywall_Settings__mdt) metadata type ensures the appropriate URL is being used to obtain Unpaywall data when integrated into Scientific Publications Cloud product.

mvn__PP_Unpaywall_Settings__mdt schema
Field labelAPI nameData typeDescription
Unpaywall API Base URLmvn__PP_Unpaywall_API_Base_URL__cText(255)The base url of the Unpaywall API. The value of this field must be https://api.unpaywall.org.

Workflow

A workflow or document process is defined in the CM_Workflow__mdt custom metadata type. Each workflow is associated with a single lifecycle and has entry criteria that determine whether/when a document can enter the workflow. Only a single document is supported per workflow.

mvn__CM_Workflow__mdt schema
Field labelAPI nameData typeDescription
Activemvn__CM_Active__CCheckboxWhether the Workflow is active.
Auto Startmvn__CM_Auto_Start__cCheckboxWhether the Workflow should automatically start when a Document is created matching its entry criteria.
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)Custom Label used to translate the name of this Workflow in the user interface.
Descriptionmvn__CM_Description__cText Area(255)Description of the workflow: how it's used, which document types it applies to, etc.
Document Lifecyclemvn__CM_Document_Lifecycle__cMetadata Relationship(Document Lifecycle)Document Lifecycle associated to this Workflow.
Entry Criteriamvn__CM_Entry_Criteria__cLong Text Area(32768)JSON representation of this workflow's entry criteria. Entry criteria determines whether the workflow is available for a document. Visit Criteria definition.
Sort Ordermvn__CM_Sort_Order__cNumber(18, 0)Order in which the Workflow displays in the user interface. :::: note ::: title ::: To enable easier re-ordering of Workflows, set Sort Order values in increments of 100 up to a maximum Sort Order value of 1,000. This enables you to insert a Workflow into any position without having to edit Sort Order values for existing Workflows. ::::

Workflow Activity Capacity

The Workflow Activity Capacity (CM_Workflow_Activity_Capacity__mdt) custom metadata type defines the capacities in which users act when reviewing workflow activities.

To configure a custom capacity for a specific Workflow Stage Activity, associate a Workflow Activity Capacity record to the appropriate Workflow Stage Activity record via the mvn__CM_Workflow_Stage_Activity__mdt.mvn__CM_Workflow_Activity_Capacity__c field.

CM_Workflow_Activity_Capacity__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)API name of the custom label used to translate this record in the user interface.

Workflow Activity Service

The Workflow Activity Service (mvn__PP_Workflow_Activity_Service__mdt) custom metadata type defines the sObject records that are created or updated when (1) Tasks are created or completed and (2) administrator configured criteria is met. For example, the Target Submission - Create (PP_Target_Submission_Accepted) record is an out-of-the-box Workflow Activity Service record that creates a Target Submission record when a Submit Publication task is created on the Document Version object and this criteria is met:

{
"path": "task.Subject",
"operator": "Equals",
"value": "Submit Publication"
}

The Workflow Activity Service Mapping custom metadata object looks up to the Workflow Activity Service custom metadata object.

mvn__PP_Workflow_Activity_Service__mdt schema
Field labelAPI nameData typeDescription
Actionmvn__PP_Action__cPicklistPicklist that indicates the type of action which to execute for the corresponding related sObject. For example, Create inserts a Related sObject record and stores the Id in the Relationship API Field Name, and Update modifies the related record in the Relationship API Field Name. Picklist values include: - Create - Update
Criteriamvn__PP_Criteria__cLong Text Area(32768)JSON criteria used to determine when the workflow activity service should execute. For example, this criteria states that the Task subject must be Submit Publication: { "path": "task.Subject", "operator": "Equals", "value": "Submit Publication" }
Operationmvn__PP_Operation__cPicklistPicklist that indicates the type of operation which to execute on for the corresponding sObject. Picklist values include: - Insert - Update
Related SObjectmvn__PP_Related_SObject__cPicklistRelated sObject to be created or updated by the workflow activity service. Picklist values include: - Document - Document Version - Contact Verification - Target Submission
Relationship API Field Namemvn__PP_Relationship_API_Field_Name__cText(60)API name of the sObject field looking up to the related sObject. For example, the API name for Task.mvn__PP_Target_Submission__c should be indicated as mvn__PP_Target_Submission__c.
SObjectmvn__PP_SObject__cPicklistSObject initiating the workflow activity service. This value must be Task. :::: warning ::: title ::: Do not add picklist values for this field. Task is the only supported SObject that can initiate the workflow activity service. ::::

Workflow Activity Service Mapping

The Workflow Activity Service Mapping (mvn__PP_Workflow_Activity_Service_Mapping__mdt) custom metadata type represents a workflow activity service mapping on a document.

mvn__PP_Workflow_Activity_Service_Mapping__mdt schema
Field labelAPI nameData typeDescription
Source Field API Namemvn__PP_Source_Field_API_Name__cText(60)API name of the source field to map to the target field. For example, the API name for Task.Status should be indicated as Status.
Target Field API Namemvn__PP_Target_Field_API_Name__cText(60)API name of the target field which the source field will map to. For example, the API name for mvn__PP_Target_Submission__c.mvn__PP_Status__c should be indicated as mvn__PP_Status__c.
Workflow Activity Servicemvn__PP_Workflow_Activity_Service__cMetadata Relationship(Workflow Activity Service)Lookup relationship to the Workflow Service Activity (mvn__PP_Workflow_Activity_Service__mdt).

Workflow Stage

Workflow Stages are defined in the CM_Workflow_Stage__mdt custom metadata type and represent the list of possible steps in a workflow. Not every instance of a workflow will necessarily enter every defined Workflow Stage. The stages that become activated in a workflow instance depend on the outcome of workflow activities and the transitions configured for the workflow.

mvn__CM_Workflow_Stage__mdt schema
Field labelAPI nameData typeDescription
Custom Label API Namemvn__CM_Custom_Label_API_Name__cText(255)Custom label name for translating this stage in the UI.
Descriptionmvn__CM_Description__cText Area(255)Description of the stage.
Document Statemvn__CM_Document_State__cMetadata Relationship(Document State)The document state to transition the document to when the workflow enters this stage. If null, the workflow will not update the document state when the workflow enters this stage.
Error Stagemvn__CM_Error_Stage__cCheckboxWhether this is the error stage for the workflow. Workflows should have a single error stage. When a workflow encounters an error, it will transition to this stage.
Final Stagemvn__CM_Final_Stage__cCheckboxWhether this is a final stage of the workflow. If true, when the workflow enters this stage it is considered complete.
Final Stage Outcomemvn__CM_Final_Stage_Outcome__cPicklistIf this is the final stage of the workflow, the value to stamp to the workflow instance's CM_Outcome__c field when the workflow enters this stage.
Initial Stagemvn__CM_Initial_Stage__cCheckboxWhether this is the initial stage of the workflow. Workflows should have one initial stage.
Manual Stagemvn__CM_Manual_Stage__cCheckboxWhether this stage requires manual intervention to assign activities.
Workflowmvn__CM_Workflow__cMetadata Relationship(Workflow)The workflow associated to this stage.

Workflow Stage Activity

Workflow Stage Activities are the types of activities or to-do items that upon completion and when paired with transitions activate different stages in a workflow and progress a document through the workflow. Workflow Stage Activities are defined in the CM_Workflow_Stage_Activity__mdt custom metadata type. You can associate many Workflow Stage Activities to a single Workflow Stage.

mvn__CM_Workflow_Stage_Activity__mdt schema
Field labelAPI nameData typeDescription
Allow Relationship Attachmentsmvn__CM_Allow_Relationship_Attachments__cCheckboxWhen checked, files can be attached to review and approval task emails for external document collaborators via the Start Workflow (cmStartWorkflow) modal.
Assignmentmvn__CM_Assignment__cPicklistHow to assign this activity. Manual means a user must manually assign the activity.
Days to Completemvn__CM_Days_To_Complete__cNumber(18,0)The default number of days to complete the activity. Users may update this value if the activity is set to Manual assignment.
Days to Complete Calculationmvn__CM_Days_To_Complete_Calculation__cPicklistThe way in which the Days to Complete field is calculated for the activity. Picklist options include: - Actual Days - Business Days
Directionsmvn__CM_Directions__cText Area(255)Directions to the assignee. Users may update this value if the activity is set to Manual assignment.
Display Ordermvn__CM_Display_Order__cNumber(18, 0)Adjusts the order in which activities and associated tasks are displayed in the user interface. If this value is not defined, order is determined by the Due Date (ActivityDate) of the task and then the Status (Status) of the task. :::: note ::: title ::: To enable easier re-ordering, set values in increments of 100 up to a maximum value of 1,000. This enables you to insert a stage into any position without having to edit Display Order values for existing records. ::::
Document Rolemvn__CM_Document_Role__cMetadata Relationship(Role)The document role for which activities are created. Users manually select a Document Role when the mvn__CM_Assignment__c field is set to Document Role.
Role Assignmentmvn__CM_Role_Assignment__cPicklistThe role to be applied to the Document Role when a specified workflow activity is assigned to a user.
Is Optionalmvn__CM_Is_Optional__cCheckboxIndicates if the workflow stage activity is optional (true) or not (false). When an activity is configured as optional, the Start Workflow modal displays a toggle button next to the activity. The user can use this toggle to specify whether to create an assignment for that activity or not. At least one activity must be assigned before the workflow can be started.
Subjectmvn__CM_Subject__cText(255)Subject of the assigned activity. Users may update this value if the activity is set to Manual assignment.
Typemvn__CM_Type__cPicklistType of the activity: either Approve or General. Approve activities require users to enter an approval or rejection verdict. General activities are non-specific activities that can be marked as completed, e.g. peer reviews.
Workflow Activity Capacitymvn__CM_Workflow_Activity_Capacity__cMetadata Relationship(Workflow Activity Capacity)The Workflow Activity Capacity record associated with this record Workflow Stage Activity.
Workflow Stagemvn__CM_Workflow_Stage__cMetadata Relationship(Workflow Stage)The stage this activity is associated with.

Workflow Stage Activity Action

The Workflow Stage Activity Action (mvn__CM_Workflow_Stage_Activity_Action__mdt) custom metadata type is a junction object relating Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) and Activity Action (mvn__CM_Activity_Action__mdt) custom metadata records to configure custom action buttons for specific workflow events.

mvn__CM_Workflow_Stage_Activity_Action__mdt schema
Field labelAPI nameData typeDescription
Activity Actionmvn__CM_Activity_Action__cMetadata Relationship(Activity Action)The related Activity Action (mvn__CM_Activity_Action__mdt) custom metadata record.
Ordermvn__CM_Order__cNumber(4, 0)The order in which the custom action button should appear in the Mark Task Complete modal.
Workflow Stage Activitymvn__CM_Workflow_Stage_Activity__cMetadata Relationship(Workflow Stage Activity)The related Workflow Stage Activity (mvn__CM_Workflow_Stage_Activity__mdt) custom metadata record.

Workflow Stage Transition

Workflow Stage Transitions are the criteria that must be met to move a workflow to a different stage. Workflow Stage Transitions are defined in the CM_Workflow_Stage_Transition__mdt custom metadata type. You can associate many Workflow Stage Transitions to a single Workflow Stage.

mvn__CM_Workflow_Stage_Transition__mdt schema
Field labelAPI nameData typeDescription
Conditionmvn__CM_Condition__cLong Text Area(32768)Condition that, when evaluated to true, transitions the workflow.
Destination Stagemvn__CM_Destination_Stage__cMetadata Relationship(Workflow Stage)The stage to transition the workflow to when the condition evaluates to true. :::: note ::: title ::: The Destination Stage must be a stage under the same workflow as the current stage. ::::
Ordermvn__CM_Order__cNumber(4, 0)Order in which the transition is evaluated by the rules engine. Transitions are evaluated in ascending order, and the first matching transition is used to transition the workflow. :::: note ::: title ::: To enable easier re-ordering of transitions, set Order values in increments of 100 up to a maximum Order value of 1,000. This enables you to insert a transition into any position without having to edit Order values for existing transition records. ::::
Workflow Stagemvn__CM_Workflow_Stage__cMetadata Relationship(Workflow Stage)The stage associated to this transition.