Skip to main content

Configuration

This topic covers how to configure the Engagement Web Component for use in your website of choice.

Installation

The Engagement Web Component installation is separate from the Medical Information Cloud installation. To install the Engagement Web Component, use the following link: https://install.komodohealth.com/products/mei/latest.

User permissions

Create a user specifically for the Engagement Web Component integration using the standard Salesforce license. The following permissions must be created and/or assigned.

Permission sets

Admins must create a new permission set using the following process:

  1. In Setup, search for and select Permission Sets.

  2. Click New.

  3. Add a name for the new permission set.

  4. Click Save.

  5. Click Object Settings and add permissions for Inbound Forms (MED_Inbound_Form__c) with the following permissions:

    • Read and create object permissions

    • Read access and Edit access for all fields in Field Permissions

  6. Assign this permission to the Engagement Web Component user created for integration.

The user must also be assigned the MEI Integration permission set. This assignment grants the user access to the Apex classes, API, and Apex REST services related to the Engagement Web Component and gives them the ability to manage connected apps and modify metadata.

Note

Engagement Web Component Admin users must have Read / Write access to all object fields that will be interacted with by the component.

Medical engagement component generator

The component tab is available for Engagement Web Component Admin users to authenticate their org with the Engagement Web Component server and view a code snippet. They can then surface the component on their website by copying the snippet and adding it to their existing html site.

To authenticate your organization, first log in as the Engagement Web Component user, then follow the process below:

  1. Send your org ID to Customer Support to authorize it for this component (requires a license).

  2. From the App Launcher, click Medical Engagement Component Generator.

    MEI_AppLauncher.png

  3. Click Authenticate to authenticate with the server.

    MEI_TabSelectConfig.png

  4. Click Allow when prompted. If successfully authenticated, the new browser tab opens and will redirect you back to the component generator tab.

    MEI_AllowAccess.png

  5. Select an Engagement Component Configuration from the Select Configuration dropdown.

Warning

The "Login as another user" feature should not be used.

Localization

Component localization uses the Salesforce-provided Translation Workbench such that the component will attempt to identify a user's language from the browser and obtain values for fields and custom labels if the language is supported and translation is available. You may use the Translation Workbench to add additional language support and provide translated values for relevant field and custom labels.

Note

If translations are unavailable for the browser language, the default language labels will be used (English).

Troubleshooting

You may encounter the following issues:

  • You see the following error: "You are not currently licensed for this service. Contact your Komodo Health representative for more information." This error means your org has not been whitelisted.

  • Your org does not redirect you back to the Engagement Component Configuration tab after authentication. Refresh the page as this can take a moment to process.

Engagement Component Configuration custom metadata type

The Engagement Component Configuration (mvn__MED_Engagement_Component_Settings__mdt) custom metadata type is used to configure how the component behaves, including which features are available, default values, and labels. For clarity, these fields have been separated into two distinct tables: General fields and Inquiry Submission fields.

Table 139. Engagement Component Configuration (mvn__MED_Engagement_Component_Settings__mdt) custom metadata type general fields

Field

Description

mvn__MED_Active__c

Controls the overall visibility of the component. If disabled, the component will not render on the embedded page.

Note

if the component is active but no individual features are active, the component will not render.

mvn__MED_Available_Product_IDs__c

Contains a list of all available products visible to the component, specified by CMS ID delimited by new lines or semicolons. The products specified must be available for the country code provided in mvn__MED_Country_Code__c. If blank, all products from the corresponding County Code field will be available.

mvn__MED_Close_Button_Label__c

The custom label to use for close button text.

mvn__MED_Country_Code__c

The two-letter country code that specifies the region of the component. This determines the regional values available to the component such as available products and sets the default value for the MED_Country__c field in the Inbound Form custom object.

mvn__MED_Default_Language__c

The default language for the component translations and data. This is used if the user's language cannot be derived or is not supported and sets the default value for the MED_Language__c field in the Inbound Form custom object.

mvn__MED_Default_Product_ID__c

The CMS ID of the default product that is to be displayed and selected on the component. If specified, it is automatically treated as being added to the mvn__MED_Available_Product_IDs__c field.

mvn__MED_Generic_Error_Label__c

The Salesforce custom label to use for text to indicate an unexpected error (e.g., inquiry submission failure).

mvn__MED_Submit_Button_Label__c

The Salesforce custom label to use for the Submit button text.



Table 140. Engagement Component Configuration (mvn__MED_Engagement_Component_Settings__mdt) custom metadata type Inquiry Submission fields

Field

Description

mvn__MED_Inquiry_Channel__c

The default value to use for the MED_Channel__c Inbound Form field. This field can be used to track how the Inbound Form was created.

Note

Required if Inquiry Submission Enabled is true.

mvn__MED_Inquiry_Confirmation_Label__c

The Salesforce custom label to use for text displayed after an inquiry submission is successfully submitted.

mvn__MED_Inquiry_External_ID_Prefix__c

The prefix for Inbound Form External ID to use when submitting inquiries. This can be used to track how the Inbound Form was created.

Note

Required if Inquiry Submission Enabled is true.

mvn__MED_Inquiry_Footer_Label__c

The Salesforce custom label to use for text is displayed as a footer under inquiry submission form fields.

mvn__MED_Inquiry_Header_Label__c

The Salesforce custom label to use for text is displayed as a header of the inquiry submission form.

mvn__MED_Inquiry_Preamble_Label__c

The Salesforce custom label to use for text is displayed as a preamble above inquiry submission form fields.

mvn__MED_Inquiry_Subheader_Label__c

The Salesforce custom label to use for text is displayed as a subheader of the inquiry submission form.

mvn__MED_Inquiry_Submission_Enabled__c

This field controls the visibility of the inquiry submission feature. If no features are active, the component will not render.

mvn__MED_Inquiry_Submission_Fields__c

The JSON value specifies which Inbound Form fields should be displayed if they are required, and the order rendered on the component’s inquiry submission feature. Any fields specified that are not valid (either because they don’t exist, or the Engagement Web Component Admin user does not have read access to) are ignored. Example Valid JSON:

{
	"MED_Requester_Name__c": {
		"required": true,
		"order": 1
	},
	"MED_Email__c": {
		"required": true,
		"order": 2
	},
	"MED_Inquiry_Text__c": {
		"required": true,
		"order": 3
	}
}

Note

Required if Inquiry Submission Enabled is true.