Skip to main content

Custom metadata settings

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

Account Field Contact Info Mapping

This metadata object maps Account Fields to Contact Information Records. When the specified field is edited a corresponding contact information record is created or updated as appropriate.

This configuration indicates the field on contact info to map to, the record type to set, and the type to set.

An example of how to use this would be if your org already makes use of the Account Phone field. Add a record to this configuration, which maps Account Phone to a contact info record with record Type MED_Phone and the appropriate type such as 'Work'. This will keep the contact info record in sync with the account. Data can also be initialized using Account Contact Information Synchronization.

MED_Account_Field_Contact_Info_Mapping__mdt schema
Field labelAPI nameData typeDescription
Account FieldMED_Account_Field__cText(40)The account field which is mapped to a contact information record.
Contact Info FieldMED_Contact_Info_Field__cText(40)The field on the contact information record to map the account field value to.
Contact Info Record TypeMED_Contact_Info_Record_Type__cText(80)The developer name of the contact information record type which should be created when the account field is mapped.
Contact Info TypeMED_Contact_Info_Type__cText(100)The Type which should be set for the contact information record type when the account field is mapped.

Account Field Setting

Controls various settings around Account and Contact Information fields.

This configuration is used throughout the application to drive things such as whether a field is used to search for accounts and if/where it shows up in the results.

MED_Account_Field_Setting__mdt schema
Field labelAPI nameTypeDescription
Account Create OrderMED_Account_Create_Order__cNumber(2,0)The order that this field is displayed on the Account Create form.
Account Record TypeMED_Account_Record_Type__cText(57)The Account Record Type that this field entry applies to. "All" means it applies to all person or institution record types depending on the MED_Is_Person_Record_Type__c setting.
Interaction Accounts OrderMED_Case_Accounts_Order__cNumber(2,0)The order which the fields should appear on the interaction accounts screen once an account has been selected. Any fields configured will appear before those configured in Contact Info Case Mappings.
Contact Info Create OrderMED_Contact_Info_Create_Order__cNumber(2,0)The order to display the field when creating a new contact information record on an existing account.
Contact Info Record TypeMED_Contact_Info_Record_Type__cText(57)The record type this field should be associated with if it is a Contact Information field.
FieldMED_Field__cText(60)The field that the settings are for.
Include in DCRMED_Include_in_DCR__cPicklistIndicates when a field should be considered for DCR creation.
Is Person Record Type?MED_Is_Person_Record_Type__cCheckboxIndicates the field belongs to a Person Account Configuration.
New Affiliation OrderMED_New_Affiliation_Order__cNumber(2,0)The order fields should appear in when creating a new Affiliation.
ObjectMED_Object__cPicklistThe object that the field is on. Possible values are: * Account * Child_Account_vod__c * MED_Affiliation__c * MED_Contact_Information__c.
Quick Search Field OrderMED_Quick_Search_Field_Order__cNumber(2,0)The order this field shows up on selected requester search fields.
Required for SaveMED_Required_for_Save__cCheckboxIn order to create or edit a record with this field on it the user must provide a value for this field.
Search Field OrderMED_Search_Field_Order__cNumber(2,0)Search field order.
Search Results OrderMED_Search_Results_Order__cNumber(3,0)Indicates the order this field should appear in search results on the Account Search.
SegmentMED_Segment__cMetadata Relationship (Segment)The segment this setting belongs to.
Show in Primary ResultsMED_Show_in_Primary_Results__cCheckboxIndicates that this field should be shown in the main row of the search results.
Show in Secondary ResultsMED_Show_in_Secondary_Results__cCheckboxIndicates that this field should be shown in the expanded information when a row is clicked in the search results.

Account Type Document Filter

Custom setting to add additional, account type specific filters to document search. Example: Non-HCP cannot see off label documents so if the account is a Non-HCP, document search will only show results where off_label__c = false.

MED_Account_Type_Document_Filter__mdt schema
Field labelAPI nameData typeDescription
Account Record TypeMED_Account_Record_Type__cText(57)The Account Record Type that this field entry applies to. "All" means it applies to all record types.
Custom Filter LogicMED_Custom_Filter_Logic__cText(255)Custom filter used for more sophisticated search logic (e.g., Date__c > 2013-04-24 and Date__c < today). If you use this field, there is no need to use the Case_Document_Field__c field.
Request Document FieldMED_Request_Document_Field__cText(60)API name of the Request Document field filtered in the document search.
Search Filter ValuesMED_Search_Filter_Values__cText(255)Filter value in the document search. The search filter will pair with the corresponding Case_Document_Field in a single expression (e.g., MED_Product__c in {'Cholecap'}) if only one value is provided.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this setting belongs to.

Account Type Setting

Settings for account record type. Includes various settings defining how Account Record Types are used throughout the application.

MED_Account_Type_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Record TypeMED_Account_Record_Type__cText(57)The Account Record Type that this field entry applies to. "All" means it applies to all person or institution record types depending on the MED_Is_Person_Record_Type__c setting.
Account Search OrderMED_Account_Search_Order__cNumber(2, 0)The order this record type should appear in the search parameters.
Allow Filter by Affiliation SearchMED_Allow_Filter_by_Affiliation_Search__cCheckboxIf true, when searching for accounts, the user can filter to those affiliated with the selected account of this type. e.g. if an HCP is selected then filter institutions to those the hcp is.
Allow Referred ByMED_Allow_Referred_By__cCheckboxThis record type can be added as the referred by account on the case.
Change Search Tab on SelectMED_Change_Search_Tab_on_Select__cCheckboxChange the search tab between Person and Institution automatically after selecting a result.
Default for SearchMED_Default_for_Search__cCheckboxThe default record type to search. Only specify one per record type/Person Account.
Include in Create?MED_Include_in_Create__cCheckboxShould this record type be included in the create modal on the account search screen?
Include in SearchMED_Include_in_Search__cCheckboxIndicates this record type should be included as a search parameter.
Is Person Record Type?MED_Is_Person_Record_Type__cCheckboxSpecifies if the record type is a person account record type.
Records Required for CreateMED_Records_Required_for_Create__cText(50)Comma separated list of Contact information Record Types required to create this type of account.
Require Institution on CreateMED_Require_Institution_on_Create__cCheckboxThis record type must have a related institution to create.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this account type is grouped under.

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 Event Types.
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 Event Types.
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.

Ad Hoc QA Filter Field

Defines the fields and field order to display filter fields in the Ad Hoc QA interface.

MED_Ad_Hoc_QA_Filter__mdt schema
Field labelAPI nameData typeDescription
FieldMED_Field__cText(60)The field to display, null allows for a blank placeholder spot.
ObjectMED_Object__cText(60)Case or the object related list name. Should end in __r.
OrderMED_Order__cNumber(4,0)The order to display the filter fields.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment that this entry applies to.

Address Field Contact Information Mapping

This metadata object maps Address_vod Fields to Contact Information Records. When the specified field is edited, a corresponding contact information record will be created or updated as appropriate. This configuration indicates the field on contact info to map to, the record type to set, and the type to set.

Note: This custom metadata type is only used and installed for orgs that are shared with Veeva CRM.

MED_Address_Field_Contact_Info_Mapping__mdt schema
Field labelAPI nameData typeDescription
Address FieldMED_Address_Field__cText(40)The address field which is mapped to a contact information record.
Contact Info FieldMED_Contact_Info_Field__cText(40)The field on the contact information record to map the account field value to.
Contact Info Record TypeMED_Contact_Info_Record_Type__cText(40)The developer name of the contact information record type which should be created when the account field is mapped.
Contact Info TypeMED_Contact_Info_Type__cText(100)The Type which should be set for the contact information record type when the account field is mapped. Not used for Address Component Fields.
Is Address ComponentMED_Is_Address_Component__cCheckboxIndicates that this field makes up part of the actual address, e.g., Address Line 2 or City. Used to keep all address field info on the same contact information record.

Adverse Event Layout

Defines the fields and field order to display on the Adverse Event UI (Beta).

MED_Adverse_Event_Layout__mdt schema
Field labelAPI nameData typeDescription
Field NameMED_Field_Name__cText(255)API Name of the AE Field.
Object NameMED_Object_Name__cText(255)API Name of the Object for the Field.
Position (Related List)MED_Position_Related_List__cNumber(3,0)The relative position this field should be shown on the related list column headers.
PositionMED_Position__cNumber(3,0)Position of the field on the edit layout.
Section NameMED_Section_NameText(60)API Name of a Custom Label for the section. Keep empty if the field should not be grouped.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment that this entry applies to.

AIMI Prompt Option

The AIMI Prompt Option (MAI_AIMI_Prompt_Option__mdt) custom metadata type represents an individual prompt template that can be selected in and run from the AIMI Prompt Selection modal. For more information, reference the Artificial Intelligence in Medical Information page.

MAI_AIMI_Prompt_Option__mdt schema
Field labelAPI nameData typeDescription
Default CheckedMAI_Default_Checked__cCheckboxWhen true, the prompt is selected to be run by default in the AIMI Prompt Selection modal.
Description Label API NameMAI_Description__cText(97)The API name of the custom label that should appear as the description for the prompt in the AIMI Prompt Selection modal.
Flow Action Label API NameMAI_Flow_Action_Label__cText(97)The API name of the custom label that should appear as the label for the flow referenced on the Flow Action Name field.
Flow Action NameMAI_Flow_Action_Name__cText(97)The API name of the autolaunched flow that a user can select and run after a prompt returns a response in the AIMI Prompt Selection modal.
Input Reference NameMAI_Input_Reference_Name__cText(70)The reference name of the input variable for the prompt (e.g., Input:Interaction).
Prompt Developer NameMAI_Prompt_Developer_Name__cText(97)The API name of the prompt template associated with this prompt option.
Prompt Label API NameMAI_Prompt_Label__cText(97)The API name of the custom label that should appear as the label for the prompt template referenced on the Prompt Developer Name field.
SObject API NameMAI_SObject_Name__cText(62)The API name of the sObject associated with this prompt. This determines which prompt templates should be retrieved for the record page that the AIMI Prompt Selection modal is opened from.
Sort OrderMAI_Sort_Order__cNumber(18, 0)The order in which the prompt should appear in the AIMI Prompt Selection modal.

Anonymizable Object Settings

Settings for configuration of Object-specific treatments to be applied within the Anonymization Batch Job.

MED_Anonymizable_Object_Settings__mdt schema
Field labelAPI nameData typeDescription
Anonymizable FieldMED_Anonymizable_Field__cText(62)Checkbox field that will be set to true during the anonymize process.
Anonymizable Object API NameMED_Anonymizable_Object_API_Name__cText(60)The object, related to a case, to be anonymized when the related account is anonymized. Must be an API name.
Anonymize Lookup FieldsMED_Anonymize_Lookup_Fields__cLong Text Area(630)Comma-separated list that represents the lookup fields in the object to be updated with null value during the Anonymization process.
Delete Attachments and FilesMED_Delete_Attachments_and_Files__cCheckboxCheckbox field that will decide if the attachment and files related to the record are deleted or no.
Delete EmailsMED_Delete_Emails__cCheckboxCheckbox field that will decide if the emails related to the record are deleted or no.
Delete NotesMED_Delete_Notes__cCheckboxShould related Enhanced Notes be deleted as part of the anonymization process.
Lookup Field Name To CaseMED_Case_Field__cText(62)Field API name that is a lookup in the object to Case. It should be Id when the object is Case.
Lookup Field On EmailMED_Email_Field_MVN__cText(62)The field API name on EmailMessage that relates the object with EmailMessaging. Should be ParentID for Case and can be RelatedTo or a custom field for all other objects.

Anonymization Setting

Settings for configuration of the Anonymization Batch Job

MED_Anonymization_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Record TypeMED_Account_Record_Type__cText(57)The Account Record Type that this field entry applies to. "All" means it applies to all person or institution record types depending on the MED_Is_Person_Record_Type__c setting.
Anonymize RecordsMED_Anonymize_Records__cCheckboxIndicates whether cases and related info defined by the related segment should be anonymized.
Hold DaysMED_Hold_Days__cNumber(18,0)The number of days after last closed Interaction before a record is eligible for anonymization.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this anonymization setting is configured for.

API Endpoint

The API Endpoint (mvn__API_Endpoint__mdt) custom metadata type defines the connection information for an external service. For example, this is used by the Translation Service to define which Salesforce environment an external vendor will provide translation services for.

mvn__API_Endpoint__mdt schema
Field labelAPI nameData typeDescription
Endpointmvn__Endpoint__cText(255)The fully qualified domain name (FQDN) of the API endpoint.
Versionmvn__Version__cNumber(18, 0)The version of the API to use.

CMS Connection

Holds the connection information for a content management system and groups content management system field and value mappings by connection.

Note: Two CMS Connections are only supported when the content management systems are Veeva Vault and .

MED_CMS_Connection__mdt schema
Field labelAPI nameData typeDescription
Call TimeoutMED_Call_Timeout__cNumber(8, 0)The timeout used for the web service call to the content management system.
Default MappingMED_Default_Mapping__cCheckboxWhether the CMS Connection record is the default record used for field and value mappings. Only one connection can be set as the default. If there two CMS Connections, search results from the default connection display first, followed by results from the other content management system.
Handler ClassMED_Handler_Class__cText(57)The search handler class that the connection uses.
Named CredentialsMED_Named_Credentials__cText(80)The named credentials that are used to call the custom content management system.
SegmentMED_Segment__cMetadata Relationship(Segment)The Segment this connection and mapping are used for.
Session TimeoutMED_Session_Timeout__cNumber(3, 0)The time, in minutes, that a Veeva Vault session should be considered timed out. This time should be less than the Vault session timeout to ensure that always has a valid session ID. This field is only used when authenticating via a named user.

CMS Field Mapping

Maps the Interaction Document fields to fields in the content management system.

Note: MED_Request_Document__c.MED_Name__c must be mapped to ensure users have access to the appropriate documents.

MED_Document_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
CMS ConnectionMED_CMS_Connection__cMetadata Relationship(CMS Connection)The CMS Connection the mapping is for.
CMS FieldMED_Document_Field__cText(60)API name of the field in the content management system that maps to the Request Document Field.
CMS Field TypeMED_CMS_Field_Type__cPicklistThe field type of CMS Field. CMS Field Type is used to build queries and parse results correctly. If no value for CMS Field Type is provided, String is the assumed CMS Field Type.
Field to Stamp toMED_Field_to_Stamp_to__cText(60)API name of the Request Document field that the CMS Field maps to when special circumstances are met. Specifically, when there are incompatibilities and inbound and outbound mappings are different, outbound mappings remain the same, but when the content management system data returns, MED_Field_to_Stamp_to__c directs the data into a different field than the field that MED_Request_Document_Field__c specifies.
Request Document FieldMED_Request_Document_Field__cText(60)API name of the Request Document field that the CMS Field maps to.
Request Document Related FieldMED_Request_Document_Related_Field__cText(60)Use this field for outbound mapping ( → content management system) when MED_Request_Document_Field__c is a lookup and you do not want to send the lookup Salesforce ID to your content management system for searching. The value for this field must be on the looked up object. :::: note ::: title ::: Heavy use of this field could cause performance issues or result in hitting governor limits. :::: :::: note ::: title ::: MED_Request_Document_Related_Field__c is usually used in conjunction with MED_Field_to_Stamp_to__c because if the lookup ID is not in the content management system, the lookup ID cannot be populated on the way back either, and the content management system data needs to be put somewhere other than the lookup field. ::::

CMS Value Mappings

Holds a list of value translations from the content management system to . Each CMS Value Mapping must have an associated CMS Field Mapping.

MED_CMS_Value_Mapping__mdt schema
Field labelAPI nameData typeDescription
CMS Field MappingMED_Document_Field_Mapping__cMetadata Relationship(CMS Field Mapping)The CMS Field Mapping that this applies to.
CMS ValueMED_CMS_Value__cText(255)Value that the content management system uses.
InboundMED_Inbound__cCheckboxIndicates if the value mapping is used for inbound data (content management system → ).
OutboundMED_Outbound__cCheckboxIndicates if the value mapping is used for outbound data ( → content management system).
Request Document ValueMED_Request_Document_Value__cText(255)Value that the Request Document uses.

Conditional Field Rule

Conditional Field Rule custom metadata records specify when to hide and show fields on a layout based on values in other fields. For example, the Request - Subcategory conditional field rule record that ships with states that if the Category field has a value, the Subcategory field should display on the layout.

Conditional Field Rule records only work with the Enhanced Record Edit component.

When a page loads or automatically saves, all relevant rules are evaluated for the object being shown.

  • If a rule evaluates to true, the field displays.

  • If a rule evaluates to false, the field is hidden.

  • If there are multiple conditional field rule records for the same field and only one of the rules evaluates to true, the field displays.

  • If there is no rule for the field or the user does not have field level security to the Controlling field, the field displays.

If all fields in a row are hidden, the row is removed from the user interface, bringing everything below it up. If all fields in a section are hidden, the section header is also removed from the user interface.

Conditional Field Rule custom metadata supports formula fields, and all formulas are recalculated each time the layout saves.

Note: Avoid using cross-object formula fields because they trigger additional SOQL queries and require additional processing time.

MED_Conditional_Field_Rule__mdt schema
Field labelAPI nameData typeDescription
Clear When HiddenMED_Clear_When_Hidden__cCheckboxWhen a field is hidden on a layout, the Clear When Hidden field determines if the value of the hidden field should be cleared. Special considerations include: - If the user does not have access to the Dependent field, field-level security is enforced, and the hiding rule is not applied. - If there are multiple rules for the same field, set "Clear when hidden" with the same value on all of the rules. If not, the clearing behavior appears random as the order the rules are returned from cache determines the behavior. - If the Conditional field is a checkbox, "Clear when Hidden" sets the Conditional field's value to false.
Conditional FieldMED_Conditional_Field__cText(62)Field API Name that is rendering/not rendering.
Controlling FieldMED_Controlling_Field__cText(62)Field API Name whose value controls the visibility of the Conditional field. It must be on the same object as the Conditional Field.
Controlling Field CriteriaMED_Controlling_Field_Criteria__cPicklistType of check to make. Options include: - Value - Controlling field's value must match the specified value. - Blank - Controlling field must be blank. - Not Blank - Controlling field must have a value. - Checkbox - Controlling field must be a checkbox type.
Controlling Field ValueMED_Controlling_Field_Value__cText(255)The Conditional field is rendered if the Controlling field value matches this value. Only set this value if you selected Value for Controlling Field Criteria.
ObjectMED_Object__cText(60)The object API Name this rule applies to.

Contact Info Case Mapping

This custom metadata type establishes a mapping between Contact Information Record Types and Case Lookup Fields. This allows the stamping of case lookups with the proper contact information records.

MED_Contact_Info_Case_Mapping__mdt schema
Field labelAPI nameData typeDescription
Account TypeMED_Account_Type__cPicklistThe type of account this mapping should be used for.
Case FieldMED_Case_Field__cText(40)The API name of the case field which is being mapped to.
Contact Info FieldMED_Contact_Info_Field__cText(40)The API name of the field on the contact information object where the value is stored for this record type.
Copy CI to CaseMED_Copy_CI_to_Case__cCheckboxIf checked, copy Existing Case Value Field into Contact Info Field from the related parent based on the lookup field specified in Case Field.
Existing Case Value FieldMED_Existing_Case_Value_Field__cText(62)When defaulting contact information for case, will try to match the contact info field value to this value on case. If they match, will use the matching contact info instead of primary.
Record Type Developer NameMED_Record_Type_Developer_Name__cText(40)The developer name of the record type being mapped to the Case Lookup Field.

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

Document Field Setting

This custom metadata type allows for configuration of fields that should appear on the Document Search, Search Results, and the Attached Documents Component for a request.

MED_Document_Field_Setting__mdt schema
Field labelAPI nameData typeDescription
Attachment List OrderMED_Attachment_List_Order__cNumber(2,0)The order the field should show up on the attached documents list. 0/null means it will not be included. On the document search page, only the 1st column is shown.
Checkbox Filter OptionsMED_Checkbox_Filter_Options__cPicklistFilter options for checkbox search fields (when ticked): Default Filter - Retrieves only the records that have this field ticked. Inclusion Filter - Retrieves the records that have this field ticked in addition to other records.
Default Value (Request)MED_Default_Value_Request__cText(182)The API name of the request field to pull the value from to default the search with.
Default Value (Static)MED_Default_Value_Static__cText(100)The value to default this field to. This value will not be used if Default Value (Request) is defined.
Hover for ValueMED_Hover_for_Value__cCheckboxIf set to true, the value from this field will only be displayed when the agent hovers over the icon rendered. This is useful for fields which have a long value in them.
Link To ViewerMED_Link_to_Viewer__cCheckboxIf set to true this field will be interpreted as a url that directs the agent to the document view. It will be displayed using the value from MED_Name__c on the document.
Picklist RowsMED_Picklist_Rows__cNumber(1,0)Number or rows to show in the picklist. 1 indicates a single select picklist, >1 will be multi-select, and 0/null will render as defined in the field definition. Note, can be used to render picklist fields as multiselect or multiselect fields as picklists. WARNING: Using this will break dependent picklists.
Request Document FieldMED_Request_Document_Field__cText(60)The referenced Request Document Field.
Restrict to Picklist ValuesMED_Restrict_to_Picklist_Values__cCheckboxWhen set to true, for a picklist field, a search will be filtered to only values in the picklist if no value is chosen.
Search Field Label (Classic Only)MED_Search_Field_Label__cText(100)The label that this field should show up in the search section.
Search Field OrderMED_Search_Field_Order__cNumber(2,0)The order that this field should show up in the search section. Populate to make it a search field.
Search Result OrderMED_Search_Result_Order__cNumber(2,0)The result column order for this field. Populate to show this field in the results columns.
SegmentMED_Segment__cMetadata Relationship (Segment)The segment this setting is configured for.

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 determine 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 Relationship(Document Sharing Rule)Document Sharing Rule associated to the Document Sharing Rule Group.
Groupmvn__CM_Group__cMetadata Relationship(Group)Group 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 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.

Document Wizard Settings

The Document Wizard Settings (mvn__MED_Document_Wizard_Settings__mdt) custom metadata sets the default values that pre-populate the document creation wizard modal for creating custom responses and FAQs.

mvn__MED_Document_Wizard_Settings__mdt schema
Field labelAPI nameData typeDescription
Document Typemvn__MED_Document_Type__cText(40)The default document type selected in the document creation wizard modal. This should be a valid value from the Document Version Document Type pick list. Visit Document Version.
Document Subtypemvn__MED_Document_Subtype__cText(40)The default document subtype selected in the document creation wizard modal. This should be a valid value from the Document Version Document Subtype pick list. Visit Document Version.

Dynamic Fulfillment Filter

Settings that control the filter criteria for documents pulled from the CMS into the DDP.

MED_Dynamic_Fulfillment_Filter__mdt schema
Field labelAPI nameData typeDescription
Document FieldMED_Document_Field__cMetadata Relationship(CMS Field Mapping)The applicable field mapping for the documents to use in DDP creation.
Dynamic Fulfillment SettingMED_Dynamic_Fulfillment_Setting__cMetadata Relationship(Dynamic Fulfillment Setting)The Fulfillment Config used in the DDP generation.
Fulfillment FieldMED_Fulfillment_Field__cText(60)Field on the Fulfillment object for value match.

Dynamic Fulfillment Setting

Settings that control the documents and sections pulled in and how they behave in the DDP.

MED_Dynamic_Fulfillment_Setting__mdt schema
Field labelAPI nameData typeDescription
All requiredMED_All_required__cCheckboxShould all documents in this section be required?
Document SubtypeMED_Document_Subtype__cText(200)Documents attached to a request that have a subtype value of Case Documents are merged in the Fulfillment.
Include by DefaultMED_Include_by_Default__cCheckboxDetermines if the optional documents in the fulfillment package generation screen are included by default. When true, the optional documents are checked and included by default. When false, the optional documents are unchecked and not included by default.
Merge within SectionMED_Merge_within_Section__cPicklistIndicates the type of merging to use within a DDP section.
Merge with Previous SectionMED_Merge_with_Previous_Section__cPicklistIndicates the type of merging to use between DDP sections.
OrderMED_Order__cNumber(2, 0)The section order that they should be placed in the final merged document.
Required SelectionsMED_RequiredPicklistRequired document selection for job based fulfillment generation. If not set, falls back to the value specified in MED_All_required.
MED_Section_Label__cMED_Section_Label__cText(60)Custom label API name to show for this section when selecting documents. It is used as a unique key. If duplicate, it is treated as one section. :::: note ::: title ::: This field is required if you are using the Running Job (MIC - Nintex Queue) utility bar item. ::::
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this dynamic fulfillment setting is designed for.

E2B Custom Generator

Configuration to register custom generators for the E2B file generation process.

MED_E2B_Custom_Generator__mdt schema
Field labelAPI nameData typeDescription
E2B SettingMED_E2B_Setting__cMetadata Relationship(E2B Setting)The E2B_Setting under which this is active.
Extending ClassMED_Extending_Class__cText(57)The Apex class name used to extend/customize product functionality.
Extension PointMED_Extension_Point__cText(60)The String value of an extension point in product code.

E2B Field Mapping

Field mappings for E2B generation for Adverse Events and related child objects.

MED_E2B_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
FieldMED_Field__cText(255)AE Field to map.
Mapping ValueMED_Mapping_Value__cPicklistDetermines if an element maps to a field or a static value.
ObjectMED_Object__cPicklistAE Object for the field mapping.
RequiredMED_Required__cCheckboxDetermines if the field is required or not.
ValueMED_Value__cText(255)Value to use for static value mappings.

E2B Setting

Determines the type of acknowledgment requested for batch.

MED_E2B_Setting__mdt schema
Field labelAPI nameData typeDescription
Acknowledgement ConditionMED_Acknowledgement_Condition__cPicklistDetermines the type of acknowledgment requested for batch.
Include Files?MED_Include_Files__cCheckboxIf checked, files attached to the AE will be included in the E2B output.
MedDRA VersionMED_MedDRA_Version__cText(4)The MedDRA version value that will be set on all MedDRA version elements in generated E2B files. E2B (R3): MedDRA Version Value Data Type: 4AN OID: None Value Allowed: Numeric and '. '(dot)
Processing CodeMED_Processing_Code__cPicklistDetermines the processing code for the batch.
Processing ModeMED_Processing_Mode__cPicklistDetermines the processing mode for the batch.
Ready to Send StatusMED_Ready_to_Send_Status__cText(255)Status on Adverse Event which indicates that the ICSR file is ready to be sent.
Sender CityMED_Sender_City__cText(35)C.3.4.2: Sender's City
Sender Country CodeMED_Sender_Country_Code__cText(2)Country code for sender.
Sender DepartmentMED_Sender_Department__cText(60)C.3.3.1 Sender's Department.
Sender Email AddressMED_Sender_Email_Address__cEmailC.3.4.8 Sender's E-mail Address.
Sender FaxMED_Sender_Fax__cText(33)C.3.4.7: Sender's Fax
Sender First NameMED_Sender_First_Name__cText(60)C.3.3.3 Sender's Given Name.
Sender Last NameMED_Sender_Last_Name__cText(60)C.3.3.5 Sender's Family Name.
Sender Middle NameMED_Sender_Middle_Name__cText(60)C.3.3.4 Sender's Middle Name.
Sender OrganizationMED_Sender_Organization__cText(100)C.3.2 Sender's Organisation User Guidance This data element captures the sender's organisation name (e.g. company name or regulatory authority name). Conformance Required if the 'Sender Type' (C.3.1) is not coded as 7 (Patient / Consumer). Data Type 100AN OID None Value Allowed Free text.
Sender Postal CodeMED_Sender_Postal_Code__cText(15)C.3.4.4: Sender's Postcode.
Sender State or ProvinceMED_Sender_State_or_Province__cText(40)C.3.4.3: Sender's State or Province.
Sender StreetMED_Sender_Street__cText(100)C.3.4.1: Sender's Street Address.
Sender TelephoneMED_Sender_Telephone__cText(33)C.3.4.6: Sender's Telephone.
Sender TitleMED_Sender_Title__cText(60)C.3.3.2 Sender's Title.
Sender TypeMED_Sender_Type__cPicklistC.3.1: Sender Type.
Use CompressionMED_Use_Compression__cCheckboxIf checked, use DF compression when attaching files to E2B output.
WWID Company NameMED_WWID_Company_Name__cText(60)Company name to use for WWID.

Engagement Component Configuration

This metadata type is used to configure the settings for the Medical Engagement Interface components.

mvn__MED_Engagement_Component_Settings__mdt schema
Field labelAPI nameData typeDescription
Activemvn__MED_Active__cCheckboxToggle the component completely on or off.
Available Productsmvn__MED_Available_Product_IDs__cLong Text Area(20000)List of all available products visible to the component. Specified by CMS ID delimited by new line or semicolons. If blank, all products from the corresponding County Code field will be available.
Close Button Labelmvn__MED_Close_Button_Label__cText(40)The name of the custom label to be displayed on the Close button.
Country Codemvn__MED_Country_Code__cText(2)The two-letter country code specifying the region of the component. Determines regional values available to the component such as available products.
Default Languagemvn__MED_Default_Language__cText(5)The default language for the component translations and data. This is used if the user's language cannot be derived or is not supported.
Default Productmvn__MED_Default_Product_ID__cText(255)The CMS ID of the default product to be displayed and selected on the component.
External ID Prefixmvn__MED_Inquiry_External_ID_Prefix__cText(14)Prefix for Inbound Form External ID to use when submitting inquiries.
Generic Error Labelmvn__MED_Generic_Error_Label__cText(40)Generic error message for the component.
Inbound Form Channelmvn__MED_Inquiry_Channel__cText(60)The Inbound Form channel for inquiries submitted by the component.
Inbound Form Fieldsmvn__MED_Inquiry_Submission_Fields__cLong Text Area(20000)Maps Inbound Form fields to their corresponding display order and indicates whether they are required. Accepts a JSON object containing field names as keys and their corresponding properties as values.
Inquiry Confirmation Labelmvn__MED_Inquiry_Confirmation_Label__cText(40)The name of the custom label to be displayed as confirmation text after submission.
Inquiry Footer Labelmvn__MED_Inquiry_Footer_Label__cText(40)The name of the custom label to be displayed as a footer.
Inquiry Header Labelmvn__MED_Inquiry_Header_Label__cText(40)The name of the custom label to be displayed as a header.
Inquiry Preamble Labelmvn__MED_Inquiry_Preamble_Label__cText(40)The name of the custom label to be displayed as preamble text.
Inquiry Subheader Labelmvn__MED_Inquiry_Subheader_Label__cText(40)The name of the custom label to be displayed as a subheader.
Inquiry Submission Enabledmvn__MED_Inquiry_Submission_Enabled__cCheckboxToggle the inquiry submission feature on and off.
Submit Button Labelmvn__MED_Submit_Button_Label__cText(40)The name of the custom label to be displayed on the Submit button.

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__cText(255)SObject 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 the 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.

Fulfillment PI Setting

Determines if a Country and Account Record Type will require Prescribing Information

MED_Fulfillment_PI_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Record Type Developer NameMED_Account_Record_Type_Developer_Name__cText(50)The Account Record Type Developer Name that this entry applies to. "All" means it applies to all person or institution record types.
Include PI DocsMED_Include_PI_Docs__cCheckboxDetermines if the Country Code and Account Record Type combination includes PI documents.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this fulfillment pi setting is configured for.

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.

Global Setting

The global settings used to control the behavior of the system and also defines some configuration mappings.

MED_Global_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Name FieldMED_Account_Name_Field__cText(60)Specifies what field to use when displaying the account name in these locations: - Name of selected accounts for case accounts - Dropdown option for creating new contact information for case accounts - Name of selected accounts in account search - Title of the Account affiliation modal The referenced field can include a formula for advanced formatting or additional information, such as salutation. If MED_Account_Name_Field__c is blank, the account name defaults to Account.MED_Account_Name_Formula__c and then Account.Name if MED_Account_Name_Formula__c does not exist.
Account Search Handler ClassesMED_Account_Search_Handler_Classes__cText(255)Comma separated list of classes used in the Account Search. Results from each class are merged. The win order is the order they are listed (eg: A,B,C means A>B>C with A being the winner).
Account Search Max Results :::: note ::: title ::: For Account Search V2 only ::::MED_Account_Search_Max_Results__cNumber(3, 0)Maximum number of search results returned by account search. When the number of account search results exceed the search results limit, the results up to the limit display, and a + sign indicates that not all of the results are shown. :::: note ::: title ::: The value for this field cannot exceed 200. ::::
Account Search Results Per PageMED_Account_Search_Results_Per_Page__cNumber(3, 0)Number of results that should appear on each page in the Account Search. :::: note ::: title ::: This only applies to the Classic Account Search UI. ::::
Account Search Results Per Page OptionsMED_Account_Results_Per_Page_Options__cText(20)A comma separated list of integers indicating the rows per page options that appear at the bottom of the account search results. It is highly recommended that the value for 'Account Search Results Per Page' appears in the list.
Alert Visible Duration - InfoMED_Alert_Visible_Duration_Info__cNumber(3, 0)The amount of time, in seconds, to show an info alert when it is presented using the MED_SldsNotifications Visualforce Component.
Alert Visible Duration - SuccessMED_Alert_Visible_Duration_Success__cNumber(3, 0)The amount of time, in seconds, to show a success alert when it is presented using the MED_SldsNotifications Visualforce Component.
Alert Visible Duration - WarningMED_Alert_Visible_Duration_Warning__cNumber(2, 0)The amount of time, in seconds, to show a warning alert when it is presented using the MED_SldsNotifications Visualforce Component.
Allow Global SearchesMED_Allow_Global_Searches__cCheckboxIf true, the null option will be presented for searches in the country drop down.
Auto Stamp Primary SourceMED_Auto_Stamp_Primary_Source__cCheckboxControls whether primary source records are automatically created and associated with an Adverse Event record when an Adverse Event record is created. When the setting is enabled, automatically creates and displays primary source records in the AE Primary Source related list on the Adverse Event record. The primary source records automatically populate with information from the Requester and Referred By accounts listed on the Interaction. For more information, see Adverse Event Primary Sources.
Component Document TypeMED_Component_Document_Type__cText(50)The type as mapped through Document Field Mappings, for documents to be used in Dynamic Fulfillment DDP Generation.
DCR Create Handler ClassMED_DCR_Create_Handler_Class__cText(57)The class used for creating Data Change Request records. Must implement the MED_DCRCreateIntf interface. If blank, DCR Process is disabled.
DCR Globally ActiveMED_DCR_Globally_Active__cCheckboxIf checked, the DCR integration is active.
Document Folder NameMED_Document_Folder_Name__cText(255)The Salesforce folder developer to be used to store generated DDP documents.
Document Search Max ResultsMED_Document_Search_Max_Results__cNumber(5, 0)Maximum number of results to return in document search. When the number of search results exceeds the limit, the results up to the limit display, and a + sign indicates that not all of the results are shown.
Enable Contact Info MappingsMED_Enable_Contact_Info_Mappings__cCheckboxIf true, edits to configured account fields (Account Field Contact Info Mapping) will be mapped to contact information records.
Key Affiliation FieldMED_Key_Affiliation_Field__cText(57)The API name of the field which is used to display the "Key" value of an affiliation. This should be a text field as it will render on the InstitutionAccounts page when the Requester and Institution are affiliated.
Email Service DomainMED_Email_Service_Domain__cText(60)Domain to be used for email service email addresses configured in Email Services, when matched with the provided `Domain` in Global Settings, will be used for the Channel Details field on the Case record.
New Case Phone ParamMED_New_Case_Phone_Param__cText(30)Name of the parameter passing in phone number from CTI.
Only Edit Log for Manually Created CasesMED_Only_Edit_Log_Manually_Created_Cases__cCheckboxIf true, the interaction log will only be editable for cases which are manually created.
PI Component Document SubtypeMED_PI_Component_Document_Subtype__cText(50)Document Subtype for PI components.
PI Component Document TypeMED_PI_Component_Document_Type__cText(50)Document type for PI Components.
Product Lookup Component FieldsMED_Product_Lookup_Component_Fields__cText(255)List of comma separated fields on the Product object. These fields are displayed as the secondary fields under the main product name in the product lookup component.
Product Match StrategyMED_Product_Match_Strategy__cPicklistThe strategy employed when attempting to match product names on Inbound Forms to the local product catalog. Product Name (MED_Product__c.name) is the default and OOB strategy. Value maps leverage the MIC Value Mapping custom metadata type.
Show New Button on Standalone SearchMED_Show_New_Button_on_Standalone_Search__cCheckboxWhen checked, the new account button will show on the standalone Account Search page.
UI LayoutMED_UI_Layout__cPicklistDetermines the default user interface density for displaying custom user interface components. For custom components' user interface display density to match the user interface display density used throughout the rest of the environment, set UI Layout to match the environment's default density setting. A user's density selection overrides this setting.
Use Account Search Version 3MED_Account_Search_V3_Enabled__cCheckboxWhen checked, Account Search will use the version 3 backend. When unchecked, it will use version 2.
Use Interaction QA ObjectMED_Use_Interaction_QA_Object__cCheckboxWhen checked, QA information for an Interaction is stored in child Interaction QA record(s).
Use Simplified Product CatalogMED_Use_Simplified_Product_Catalog__cCheckboxFor a company with a smaller product catalog. Product Lookups will filter out products with record type of Product and use product family instead.
Work Instructions ClassificationMED_Work_Instructions_Classification__cText(50)Document classification where Work instruction documents are stored.
Work Instructions SubtypeMED_Work_Instructions_Subtype__cText(50)Document Subtype that Work Instructions are tagged with.
Work Instructions TypeMED_Work_Instructions_Type__cText(50)Document type for Work Instruction documents.

Global Setting

The global settings used to control the behavior of the system and define some configuration mappings.

mvn__MED_Global_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Search Excluded Statusesmvn__MED_Account_Search_Excluded_Statuses__cText(80)A comma delimited list of account, contact information, and affiliation statuses to exclude from Account Search V3 search results. Setting a value on this field will override the default Account Search behavior of filtering out inactive records. For example, to exclude both inactive and pending records, set this field to equal Inactive,Pending, not Pending.
Account Search Max Resultsmvn__MED_Account_Search_Max_Results__cNumber(3, 0)The maximum number of search results returned by account search. :::: note ::: title ::: The value for this field cannot exceed 200. ::::
Account Search Max Contact Resultsmvn__MED_Account_Search_Max_Contact_Results__cNumber(3, 0)The maximum number of contact records per record type to display in the account search results table.
Sort Contact Results by Recent Firstmvn__MED_Sort_Contact_Results_By_Recent__cCheckboxIf checked, contact information records in the search results table will be sorted by the most recently created first. By default, the primary contact record is shown first.

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.

Insights Routing Rule

Defines rule sets to mark interactions as urgent and/or place interactions to a specific queue or user based on Aperture response tags.

mvn__MED_Insights_Routing_Rules__mdt schema
Field labelAPI nameData typeDescription
Activemvn__MED_Active__cCheckboxDetermines whether this routing rule is active or disabled.
Alert Iconmvn__MED_Alert_Icon__cText(255)Image URL of an icon to display as an alert on the Interaction.
Country Codemvn__MED_Country_Code__cText(2)The region in which this routing rule applies.
Insights Therapy Areamvn__MED_Therapy_Area__cMetadata Relationship(Insights Therapy Area)A reference to an Insights Therapy Area custom metadata record that maps the Aperture TA to the Product TAs.
Interaction Queuemvn__MED_Interaction_Queue__cText(80)The API name of the queue to route this interaction to.
Interaction Usermvn__MED_Interaction_User__cText(80)The username of the user to route this interaction to, found in the user's username field.
Mark as Urgentmvn__MED_Mark_As_Urgent__cCheckboxDetermines whether interaction records routed by this rule are flagged as urgent.
Rule Prioritymvn__MED_Priority__cNumber(3, 0) (Unique)Indicates the priority of this rule, with lower numbers taking higher priority.
Tagsmvn__MED_Tags__cLong Text Area(20000)The relevant Product Therapy Area tags for this routing rule, delimited by new line or semicolons.

Insights Routing Settings

General settings for Aperture based insights routing rules.

mvn__MED_Insights_Routing_Settings__mdt schema
Field labelAPI nameData typeDescription
Insights Routing Account NPI Fieldmvn__MED_Insights_Routing_Account_NPI_Field__cText(100)The field on Account to use for the NPI number when making inquiry routing Aperture callouts.
Insights Routing Enabledmvn__MED_Insights_Routing_Enabled__cCheckboxWhen checked, publishes an Inquiry Routing Event if an interaction or request is created or updated to be valid for KHBI Insights Routing.
Named Credentialsmvn__MED_Named_Credentials__cText(80)The Named Credentials to use when making Aperture Callouts for routing rules processing.

Insights Therapy Area

A representation of Aperture Therapy Area IDs to Product Therapeutic Areas.

mvn__MED_Insights_Therapy_Areas__mdt schema
Field labelAPI nameData typeDescription
Product Therapy Areasmvn__MED_Product_Therapy_Areas__cLong Text Area(20000)Mapped Product TAs, separated by a new line or semicolon.
Therapy Area IDmvn__MED_Therapy_Area_Id__cText(80) (Unique Case Insensitive)The identifier of the Therapy Area in Aperture.
Therapy Area Namemvn__MED_Therapy_Area_Name__cText(80)The name of the Therapy Area in Aperture.

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 the product that is currently installed.

Interface Handler

The Interface Handler (Interface_Handler__mdt) custom metadata type defines the custom implementation of a given interface.

Interface_Handler__mdt schema
Field labelAPI nameData typeDescription
Classmvn__Class__cText(40)The service class that will execute the interface implementation.
Class Namespacemvn__Class_Namespace__cText(15)The namespace of the service class.
Criteriamvn__Criteria__cLong Text Area(32768)The criteria for when the interface implementation should be used (and when the service class should execute).
Interfacemvn__Interface__cText(40)The API name of the interface that is being implemented.
Ordermvn__Order__cNumber(6, 0)The order in which the service class should execute the interface implementation. If the order is empty (null), then the order is random.

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.

Local Setting

Country specific settings. A record with no country specified will be the global default.

MED_Local_Setting__mdt schema
Field labelAPI nameData typeDescription
Account Search Min CharactersMED_Account_Search_Min_Characters__cNumber(1, 0)Minimum number of required characters for an account search. Default is 2, minimum is 1, and maximum is 4. When configuring MED_Account_Search_Min_Characters__c, the value must be set to 1, 2, 3, or 4.
Adverse Event SLAMED_Adverse_Event_SLA__cNumber(3, 2)SLA applied to Adverse Events in Business Hours before the due date. This sets the flag to red after the due date and stamps a date into the Due Date field.
AE Email ListMED_AE_Email_List__cText Area(255)List of email addresses to send to Adverse Events. Emails should be separated by ";".
AE Long Form IntakeMED_AE_Long_Form__cCheckboxCurrently unused.
Anonymization Deletable Account SourcesMED_AnonymizationDeletableAccountSources__cText Area(255)Comma-separated list of sources to delete. Accounts will be deleted in Anonymize process if the source is specified here.
Anonymous Fulfillment Key LengthMED_Anonymous_Fulfillment_Key_Length__cNumber(2,0)Determines the length of the key generated for anonymous fulfillments. Default is 6 and max is 15.
Business Hours NameMED_Business_Hours_Name__cText(80)Name of the associated Business Hours record.
CMS Custom HandlerMED_CMS_Custom_Handler__cText(57)Custom CMS Handler to use for searching content. Must implement the MED_CMSIntfDefinition.MED_CMSIntf interface.
CMS SourcesMED_CMS_Sources__cPicklistCMS sources that are used to retrieve content. Picklist values include: - MIC - only files are retrieved when a content search is executed. - Vault (Custom) - only Veeva Vault files are retrieved when a content search is executed. - Custom - only files from a custom content management system are retrieved when a content search is executed. - MIC & Vault - both and Veeva Vault files are retrieved when a content search is executed. search results display first followed by Veeva Vault search results. - Vault & MIC - both Veeva Vault and files are retrieved when a content search is executed. Veeva Vault search results display first followed by search results.
Default LanguageMED_Default_Language__cText(5)Sets the default Language on for this country.
Document Search on Load? (Classic only)MED_Document_Search_on_Load__cCheckboxShould document search run a default search immediately on page load?
Email2Case EmailsMED_Email2Case_Emails__cText(255) (Unique Case Insensitive)Comma separated list of inbound Email to Case emails for this Segment. Used to stamp country and channel details on case
Enable Institution SearchMED_Enable_Institution_Search__cCheckboxIndicates that Institution Search should be enabled when this setting is being used.
Escalated Request SLAMED_Escalated_Request_SLA__cNumber(3, 2)SLA applied to an escalated Request case (hours).
Escalation ReasonsMED_Escalation_Reasons__cLong Text AreaList of escalation reasons that when selected during a record transfer operation, trigger the escalation of Case and Request records. When configuring MED_Escalation_Reasons__c, each escalation reason must be entered on a new line and must be an exact value match to a value in the Escalation/Transfer Reasons value set.
Finalize Attachment DDP NameMED_Finalize_Attachment_DDP_Name__cText(80)DDP name for the Attachment Finalize process.
Fulfillment Email Subject LabelMED_Fulfillment_Email_Subject_Label__cText(97)The API name of the custom label to use as the default email subject for digital fulfillments.
Fulfillment Outbound EmailMED_Fulfillment_Outbound_Email__cText(100)The default organization wide email address to use for outbound digital fulfillments.
PI and Originals DDP NameMED_PI_and_Originals_DDP_Name__cText(80)Name of the DDP record that runs in order to pull document originals and product inserts.
PQC Email ListMED_PQC_Email_List__cText Area(255)List of email addresses to send to Product Quality Complaints. Emails should be separated by ";"
Product Quality Complaint SLAMED_Product_Quality_Complaint_SLA__cNumber(3, 2)SLA applied to Product Quality Complaints in Business Hours before due date. This sets the flag to red after the due date and stamps a date into the Due Date field.
QA EnabledMED_QA_Enabled__cCheckboxDetermines if the automated batch QA Process is enabled for this segment.
QA Minimum Quantity to FlagMED_QA_Minimum_Quantity_to_Flag__cNumber(6,0)The minimum quantity of Interactions to flag. The greater of the percentage and minimum quantity will be flagged.
QA Percent to FlagMED_QA_Percent_to_Flag__cPercent(3, 2)The percentage of Interactions to flag. The greater of the percentage and minimum quantity will be flagged.
Request SLAMED_Request_SLA__cNumber(3, 2)SLA applied to Request cases in Business Hours before due date. This sets the flag to red after the due date and stamps a date into the Due Date field. By default, a Request SLA is 40 Business Hours.
Search Institutions First?MED_Search_Institutions_First__cCheckboxSpecifies whether to search for institutions first instead of people when doing an account search.
SegmentMED_Segment__cMetadata Relationship(Segment)The segment this setting belongs to.
SLA WarningMED_SLA_Warning__cNumber(1, 3)SLA Warning in Business Hours before the due date. This sets the flag to orange and stamps the Due Date warning field.
Template DDP NameMED_Template_DDP_Name__cText(80)Name of the DDP record to use as a template when generating Fulfillment packages.

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. ::::

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.

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
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.
Default Search Rows Limitmvn__CM_Default_Search_Rows_Limit__cNumberDefault page limit for document searches.
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__cCheckboxFlag controlling whether or not a user is required to fill out a change log when creating a new document version or checking in a document. Defaulted to true.
Enable Edit Metadata on Check Outmvn__CM_Enable_Edit_Metadata_CheckoutCheckboxAllows users with the Edit Metadata document permission to modify document metadata while the document is checked out.
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.
Enable Translation Requestsmvn__CM_Enable_Translation_Requests__cCheckboxWhen checked (true), the Translation Service via TransPerfect is 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.
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 No File option in the New Document wizard will be hidden.
Hide Upload File Buttonmvn__CM_Hide_Upload_File_Button__cCheckboxWhen checked (true), the Translation File option in the New Document wizard will be hidden.
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
Maximum Search Resultsmvn__CM_Maximum_Search_Results__cNumberMaximum number of results the document search service returns for keyword searches.
Product API Namemvn__CM_Product__cPicklistProduct Catalog API Name. This field should be set to MED_Product__c when is integrating with , otherwise mvn__CM_Product__c.
Require Electronic Signaturesmvn__CM_Require_Electronic_Signatures__cCheckboxWhen checked, electronic signature is required when completing all workflow activities. Visit Electronic signatures.
Salesforce API Versionmvn__CM_Salesforce_API_Version__cNumber(4, 1)Salesforce API Version used by MCM.
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.
Strict Document Rolesmvn__CM_Strict_Document_Roles__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.
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.
System Event Batch Sizemvn__CM_System_Event_Batch_Size__cNumber(4, 0)Defines the maximum number of System Event Configuration records that are processed in a single transaction. The value must be greater than 0 and less than or equal to 4.
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.

MDM Connection

Configure timeouts and named credentials for a connection to an external system such as Veeva Network. This is related to a particular Segment.

MED_MDM_Connection__mdt schema
Field labelAPI nameData typeDescription
Custom Key Generator ClassMED_Custom_Key_Generator_Class__cText(57)Class used to generate custom key for a Veeva Network Connection.
Default MappingMED_Default_Mapping__cCheckboxOnly one connection will be set as default mapping.
Handler ClassMED_Handler_Class__cText(57)The MDM Search Handler class that can use this type.
MDM Call TimeoutMED_MDM_Call_Timeout__cNumber(8, 0)The timeout used for the web service call to Veeva Network.
MDM Named CredentialsMED_MDM_Named_Credentials__cText(80)The Named Credentials are used to call Veeva Network API, be sure to provide the username and password of a user who can access API. It should not build an auth header and must allow merge fields.
MDM Session TimeoutMED_MDM_Session_Timeout__cNumber(3, 0)The time in minutes that a network session should be considered timed out. This time should be less than the Veeva Network session timeout to ensure that we always have a valid session id. Only used if authenticating via a named user instead of delegated auth.
Network OpenData SearchMED_Network_OpenData_Search__cPicklistDetermines if network search should include OpenData results. Default does not specify how to use OpenData and relies on the Veeva Network configuration to determine if it is included.
Network System DescriptionMED_Network_System_Description__cText(255)The system interface description used in Network>Admin>System Interfaces>Systems that identifies the integration system.
Network System NameMED_Network_System_Name__cText(40)The system interface name used in Network>Admin>System Interfaces>Systems that identifies the integration system.
SegmentMED_Segment__cMetadata Relationship(Segment)Segment which this connection is related.
Supplemental HCOsMED_Supplemental_Parent_HCOs__cPicklistDetermines how many Parent HCOs to return for Veeva Network and corresponds with supplemental variable in Veeva Network search documentation.

MDM Field Mapping

Field mapping between current Salesforce org and MDM system.

MED_MDM_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
MDM ConnectionMED_MDM_Connection__cMetadata Relationship (MDM Connection)MDM Connection where is used this field mapping.
MDM Field NameMED_MDM_Field_Name__cText(255)MDM Field name.
MDM Field TypeMED_MDM_Field_Type__cPicklistProvide the field type for the MDM Field. Used to properly handle building queries and parsing results. If not provided, assumes String is the type.
Record TypeMED_Record_Type__cText(255)Record Type of the SObject where it is possible to use this field mapping. "All" applies for any Record Type.
SF Field NameMED_SF_Field_Name__cText(255)Salesforce Field name.
SObject API NameMED_SObject_API_Name__cPicklistSalesforce Object API Name where this field mapping will be used.

MDM Value Mapping

Values which will be converted for a specific MDM Field Mapping between Salesforce and the MDM system.

MED_MDM_Value_Mapping__mdt schema
Field labelAPI nameData typeDescription
InboundMED_Inbound__cCheckboxIndicates if the value is converted to Salesforce value.
MDM Field MappingMED_MDM_Field_Mapping__cMetadata Relationship(MDM Field Mapping)MDM Field Mapping parent.
MDM ValueMED_MDM_Value__cText(255)MDM Value which is translated for MDM system.
OutboundMED_Outbound__cCheckboxIndicates if the value is converted to MDM value.
Salesforce valueMED_Salesforce_Value__cText(255)Salesforce value which is translated for Salesforce.

MIC Value Mapping

The MIC Value Mapping (MED_MIC_Value_Mapping__mdt) custom metadata type defines value mappings used to swap inbound values with target values in .

MED_MIC_Value_Mapping__mdt schema
Field labelAPI nameData typeDescription
InboundMED_Inbound__cCheckboxIndicates if the value mapping is used for inbound data ( → ).
OutboundMED_Outbound__cCheckboxIndicates if the value mapping is used for outbound data ( → ).
Source EntityMED_Source_Entity__cText (40)The source system or entity that this map applies to. For example, in the case of a MIRF Product Value map, the value in this field should match the value contained within the Channel Details field on the Inbound Form (MED_Inbound_Form__c) object. For MIRF value mappings, the default value of this field is Remote.
Source ValueMED_Source_Value__cText (80)The inbound value to be swapped with a target value.
Target ValueMED_Target_Value__cText (80)The target value to be used in place of the source value.
TypeMED_Type__cText (40)The type of value map. The value in this field must match one of the supported values: - MIRF.MED_Product__c - User.Language
Unique KeyMED_Unique_Key__cText (244) (Unique Case Insensitive)A unique key value that should be the concatenated values of Type, Source Entity, & Source Value with a colon delimiter (i.e., Type:SourceEntity:SourceValue:TargetValue).

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
API Versionmvn__CA_API_Version__cIntegerAPI version used to build the Microsoft 365 endpoint URL.
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.

Ownership History Tracking Setting

Object settings for Ownership History Tracking.

MED_Ownership_History_Tracking_Setting__mdt schema
Field labelAPI nameData typeDescription
Object Developer NameMED_Object_Developer_Name__cText(62)Developer Name of the Object.
Ownership Tracking Lookup NameMED_Ownership_Tracking_Lookup_Name__cText(60)Lookup name on the Ownership Tracking object.
Reopen Reason FieldMED_Reopen_Reason_Field__cText(60)Reopen field on the tracked object. Value is stamped on the Reopen Reason field on the Ownership Tracking.
Transfer Reason FieldMED_Transfer_Reason_Field__cText(60)Transfer Reason field on the tracked object. Value is stamped on the Reason field on the Ownership Tracking.

Permission

Regulated Content 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.

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 ::: 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 ::: 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.

Request Document Create Field Setting

Field settings for Case Document. Used when creating a new Case Document.

MED_Request_Document_Create_Field__mdt schema
Field labelAPI nameData typeDescription
Default ValueMED_Default_Value__cText(80)Default value for field.
OrderMED_Order__cNumber(3, 0)Order in which the field appears.
Read OnlyMED_Read_Only__cCheckboxDetermines if the field is read only.
Request Document FieldMED_Request_Document_Field__cText(60)Developer Name of the Request Document Field this setting applies to.
SegmentMED_Segment__cMetadata Relationship(Segment)Lookup to the segment this setting is grouped by.

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' permissions 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 Roles.
System Event Namemvn__CM_System_Event_Name__cText(255)The system event that causes the notification.

Segment

This object defines a grouping of certain metadata records. A segment could be a country or (future enhancement) a customer plus country.

MED_Segment__mdt schema
Field labelAPI nameData typeDescription
Country CodeMED_Country_Code__cText(2)A two letter country ISO code.

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.

Snapshot Configuration (in-house)

The Snapshot Configuration (MED_Snapshot_Config__mdt) custom metadata contains settings related to 's in-house snapshot generation functionality. With this metadata, you can configure the objects, fields, and layout of the generated snapshots for the designated records.

MED_Snapshot_Config__mdt schema
Field labelAPI nameData typeDescription
Field Set NameMED_Field_Set_Name__cText(42)The API name of the field set that determines which fields are displayed in the generated snapshot.
Parent SnapshotMED_Parent_Snapshot__cText(42)The Snapshot Configuration Name of the parent snapshot object in which the current snapshot object is included. In-house snapshots can include records of parent, child, and grandchild objects.
Relationship FieldMED_Relationship_Field__cMetadata Relationship(Field Definition)The parent object that the current snapshot object looks up to. This is required if the Parent Snapshot field is populated.
SegmentMED_Segment__cMetadata Relationship(Segment)The country that has the snapshot configuration available for the object.
Snapshot ObjectMED_Snapshot_Object__cMetadata Relationship(Entity Definition)The object of the record that the snapshot is being generated on.

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.
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.
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) 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)Email logo URL used by default 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).

Translation Setting

The Translation Setting (mvn__MED_Translation_Setting__mdt) custom metadata type contains the configurations for a specific translation vendor.

mvn__MED_Translation_Setting__mdt schema
Field labelAPI nameData typeDescription
Automated Translationmvn__MED_Automated_Translation__cCheckboxThis checkbox indicates that the relevant record should automatically be submitted for translation upon closure.
Object Typemvn__MED_Object_Type__cMetadata Relationship(Entity Definition)The MIC object for which a translation setting is configured.
Source Fieldmvn__MED_Source_Field__cMetadata Relationship(Field Definition)The field that should be translated.
Source Language Fieldmvn__MED_Source_Language_Field__cText(255)The field that indicates the source language.
Source Region Fieldmvn__MED_Source_Region_Field__cText(255)The field that indicates the region that should be associated with the translation request.
Target Fieldmvn__MED_Target_Field__cMetadata Relationship(Field Definition)The API name of the field to which the translated source field will be stored.
Target Languagemvn__MED_Target_Language__cText(10)The language to which data should be translated.

Translation Vendor

The Translation Vendor (mvn__CT_Vendor__mdt) custom metadata type contains the configurations for a specific translation vendor.

mvn__CT_Vendor__mdt schema
Field labelAPI nameData typeDescription
API Endpointmvn__CT_Endpoint__cMetadata Relationship(API Endpoint)The related API Endpoint (mvn__API_Endpoint__mdt) metadata record. This is the external API that the vendor uses for translations.
Enabled?mvn__CT_IsEnabled__cCheckboxWhen true, the vendor is enabled.
Translatormvn__CT_Translator__cText(255)The name of the Apex class that implements the mvn.CT_ITranslator interface for the vendor.
Translator Namespacemvn__CT_TranslatorNamespace__cText(255)The namespace of the Apex class identified in the Translator field.

Translation Vendor Page

The Translation Vendor Page (mvn__CT_VendorPage__mdt) custom metadata type adds Lightning Web Components (LWCs) as pages to a custom user interface to capture information and send translation requests to a vendor.

Note: The Request Translation Wizard (cmRequestTranslationWizardModal) is a user interface provided out of the box for the TransPerfect Vendor. Custom translation vendor pages are added to the wizard after the default Select Locale (cmRequestTranslationWizardLocaleStep) and Edit Document Details (cmRequestTranslationWizardDocumentStep) pages and before the Confirm (cmRequestTranslationWizardConfirmStep) page.

mvn__CT_VendorPage__mdt schema
Field labelAPI nameData typeDescription
Aura Appmvn__CT_Aura_App__cText(40)The API name of the Aura Application that embeds the Lightning Web Component for this page.
Display Ordermvn__CT_Display_Order__cNumber(3, 0)The order that this page appears in the Request Translation Wizard relative to other pages for the given vendor. All pages come after the Select Locale and Edit Document Details pages but before the Confirm page.
LWC Componentmvn__CT_LWC_Component__cText(40)The API name of the Lightning Web Component to appear in this page of the Request Translation Wizard.
Namespacemvn__CT_Namespace__cText(15)The namespace of the Aura Application and Lightning Web Component for this page.
Vendormvn__CT_Vendor__cMetadata Relationship(Translation Vendor)The related Translation Vendor (mvn__CT_Vendor__mdt) metadata record. This represents the vendor that this page is used for to capture additional information in each translation request.

Trigger Action

An individual trigger (Apex) or flow to run.

mvn__TAF_Trigger_Action__mdt schema
Field labelAPI nameData typeDescription
After Deletemvn__TAF_After_Delete__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the after delete context.
After Insertmvn__TAF_After_Insert__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the after insert context.
After Undeletemvn__TAF_After_Undelete__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the after undelete context.
After Updatemvn__TAF_After_Update__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the after update context.
Allow Flow Recursion?mvn__TAF_Allow_Flow_Recursion__cCheckboxCheck this box to allow the flow to execute recursively.
Apex Class Namemvn__TAF_Apex_Class_Name__cTextEnter the name of the Apex Class which defines the action to be taken.
Apex Class Namespacemvn__TAF_Apex_Class_Namespace__cText(15)Enter the Apex class namespace.
Before Deletemvn__TAF_Before_Delete__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the before delete context.
Before Insertmvn__TAF_Before_Insert__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the before insert context.
Before Updatemvn__TAF_Before_Update__cMetadata Relationship(Trigger sObject Setting)Enter the name of the sObject you want to have this action execute on during the before update context.
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxSet this to true to bypass this Trigger Action from being called.
Bypass Permissionmvn__TAF_Bypass_Permission__cTextOptional. Enter the API name of a custom permission. If this field has a value, then the triggers on this object will be bypassed if the running user has the custom permission identified.
Descriptionmvn__TAF_Description__cLong Text AreaFor informational purposes to see what a trigger is used for when viewing the custom metadata type records.
Flow Namemvn__TAF_Flow_Name__cTextEnter the API name of the flow you would like to execute.
Ordermvn__TAF_Order__cNumberThe order in which the trigger should be executed.
Required Permissionmvn__TAF_Required_Permission__cTextOptional. Enter the API name of a custom 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 Finalizer

Defines a DML (Data Manipulation Language) finalizer. A DML finalizer is a piece of code that executes exactly one time at the very end of a DML operation.

mvn__TAF_DML_Finalizer__mdt schema
Field labelAPI nameData typeDescription
Apex Class Namemvn__TAF_Apex_Class_Name__cTextEnter the name of the Apex Class which defines the action to be taken.
Apex Class Namespacemvn__TAF_Apex_Class_Namespace__cTextEnter the Apex class namespace.
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxSet this to true to bypass this Trigger Action from being called.
Bypass Permissionmvn__TAF_Bypass_Permission__cTextEnter the name of the sObject you want to have this action execute on during the after undelete context.
Ordermvn__TAF_Order__cNumberThe order in which the trigger should be executed.
Required Permissionmvn__TAF_Required_Permission__cTextOptional. 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 custom metadata type that corresponds to the sObject that we want to enable usage of the framework onto. This custom metadata type has object wide settings and related lists for all triggers on the object.

mvn__TAF_sObject_Trigger_Setting__mdt schema
Field labelAPI nameData typeDescription
Bypass Executionmvn__TAF_Bypass_Execution__cCheckboxSet this to true to bypass this Trigger Action from being called.
Bypass Permissionmvn__TAF_Bypass_Permission__cText(255)Enter the name of the sObject you want to have this action execute on during the after undelete context.
Object API Namemvn__TAF_Object_API_Name__cText(255)Enter the API Name of the object for this trigger. If this object is part of a managed package, do not include the prefix.
Object Namespacemvn__TAF_Object_Namespace__cText(255)Enter the namespace object for this trigger.
Required Permissionmvn__TAF_Required_Permission__cText(255)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.

Vault Setting

Stores configuration around connecting to Veeva Vault.

MED_Vault_Setting__mdt schema
Field labelAPI nameData typeDescription
Delegated Auth SourceMED_Delegated_Auth_Source__cText(50)The delegated auth source that Salesforce reports itself as to Vault.
External Viewer Download FormatMED_External_Viewer_Download_Format__cPicklistIdentify the document rendition a recipient of the external viewer link may download.
External Viewer Link DurationMED_External_Viewer_Link_Duration__cNumber(4, 0)The number of days a vault external viewer link is valid (1 - 3650).
Named CredentialsMED_Named_Credentials__cText(80)The Named Credentials are used to create Vault External Viewer links, be sure to provide the credentials of a user who can view all documents and create External Viewer Links. Only needed if using external Viewer Links.
Relationship IncludesMED_Relationship_Includes__cText(255)Comma separated list of document relationships to include when selecting a document.
Session TimeoutMED_Session_Timeout__cNumber(3, 0)The time in minutes that a vault session should be considered timed out. This time should be less than the Session Timeout for Vault user.
TimeoutMED_Timeout__cNumber(8, 0)The timeout used for the web service call to Vault.
Use Vault Viewer Links?MED_Use_Vault_Viewer_Links__cCheckboxWhen checked, vault external viewer links are generated rather than attaching the vault document pdf to a case.
Viewer Doc Type Exclusion ListMED_Viewer_Doc_Type_Exclusion_List__cText(255)This is a comma separated list of article types that do not get a viewer window.

Veeva Org

Stores Veeva Org reference for VeevaCRM MIRF integration.

Note: MasterLabel for each record must be unique. Non-unique values may cause errors or data to be crossed between Veeva CRM Orgs.

MED_Veeva_Org__mdt schema
Field labelAPI nameData typeDescription
MIRF Query ProviderMED_MIRF_Query_Provider__cText(57)Name of the Apex Class that has implemented the callable interface and can handle a BUILD_VEEVA_MIRF_QUERY action.
Named CredentialMED_Named_Credential__cText(40)Named Credential for storing/connecting to external Veeva Orgs securely.
TypeMED_Type__cPicklistVeeva org type which will filter according to the functionality executed: Default will be used to store common data Remote will be used to sync MIRF and Inbound Forms.

Veeva MIRF Field Mapping

Stores mappings for creating an Inbound Form from a VeevaCRM MIRF.

MED_Veeva_MIRF_Field_Mapping__mdt schema
Field labelAPI nameData typeDescription
Inbound Copy?MED_Inbound_Copy__cCheckboxField used to connect from remote Veeva org to this org.
Local ValueMED_Local_Value__cText(255)Field API name for this org.
Local Value TypeMED_Local_Value_Type__cPicklistField type for this org. It could be Field (default) which is used to get the value from the field or Constant.
Outbound Copy?MED_Outbound_Copy__cCheckboxField used to connect from this org to remote Veeva org.
Remote ValueMED_Remote_Value__cText(255)Field API name for the remote Veeva org.
Remote Value TypeMED_Remote_Value_Type__cPicklistField type for remote Veeva org. It could be Field (default) which is used to get the value from the field or Constant.
Veeva OrgMED_Veeva_Org__cMetadata RelationshipThis is used to get all the fields linked to a Veeva org (MED_Veeva_Org__mdt).

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 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
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.
Day to Complete Calculationmvn__CM_Days_To_Complete_Calculation__cPicklistProvides the option to set the due date based on business hours rather than actual 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.