Skip to main content

Customization guidelines

To support your business requirements and processes, you can customize and extend the Komodo Care Connect product. All customizations and extensions must be implemented in accordance with the prescribed tools, technologies, and functionalities described on this page. Wherever possible, Komodo Health recommends leveraging the product's existing functionality rather than developing customizations. If you have questions on how best to alter the standard behavior of Komodo Care Connect, contact Customer Support.

Warning

Adhering to the guidance on this page ensures customizations and extensions remain functional and do not incur regressions as upgrades are shipped to the product over time. Failure to follow this guidance or altering the product’s behavior in a manner not explicitly defined on this page may hinder performance and cause unexpected results of stated features and functionalities. Remember to always test any new customizations or configuration changes in a sandbox before releasing them to your production users.

Note

When creating custom child metadata records, you will not have the option to click the New button from the parent metadata record, as is typical in Salesforce. The child metadata record must be created from the metadata type itself and a lookup must be used to link to its parent metadata record.

Customize product components

To ensure custom features and functionalities remain functional and do not incur regressions as upgrades are shipped to the product, follow these guidelines:

  • Do not edit or delete any Komodo Care Connect component unless it is listed in Table 65, “Customization matrix”. Components not listed in this table may be removed from the product at any point in time without advance notice.

  • If you want to alter the functionality of components that are not listed in Table 65, “Customization matrix”, create a copy of the existing component. Only make the desired alterations to the copied component.

  • Do not reference Komodo Care Connect components in customizations. This includes referring to Komodo Care Connect components in custom code on or off the platform and in declarative configurations, such as a formula field.

Reuse out-of-the-box components

Before you build custom solutions to extend Komodo Care Connect, consider reusing out-of-the-box components from Komodo Care Connect for your specific business needs. The following examples are instances where you may find it more efficient to reuse existing components instead of building new features:

  • Defaulting values on new care plans and activities – if you want to stamp values onto Case records when creating a new care plan or activity, use the mapping engine via mapping jobs and the various child metadata objects.

  • Setting care plan lookup fields – if you want to stamp values from a child record of a care plan onto a lookup field on the care plan, use the Care Plan Lookup Mapping (mvn__PJN_Care_Plan_Lookup_Mapping__mdt) custom metadata type.

  • Adding people to the care plan or care team – if you want to add new people to a patient's care team, as shown in the Care Map subtab, use either the Zip To Team functionality to set user lookups on the care plan or the Case Field Configuration (mvn__PJN_Case_Field_Configuration__mdt) custom metadata type.

Component identification

You can differentiate Komodo Care Connect components from non-product components by looking at their API names. All Komodo Care Connect components have a mvn__, mvn__PJN_, or PJN_ prefix in their API names. Komodo Care Connect components in managed packages have the mvn__ or mvn__PJN_ prefix. All other Komodo Care Connect components that are not in managed packages have the PJN_ prefix.

Note

The acronym PJN is used instead of KCC because Komodo Care Connect was formerly known as the Patient Journey Navigator.

You can also verify if a component is part of Komodo Care Connect by checking whether the component is part of a required package. To view a list of components for a package:

  1. In the Quick Find box in Setup, search for and select Installed Packages.

  2. Click the package name of the installed package that you want to view a list of components for. "Komodo" is the publisher for all Komodo Care Connect required packages.

  3. Click View Components. The list of components that are part of the installed package appears.

Components in managed packages are locked and therefore cannot be edited or deleted. For more information about editing components that are part of a managed package, visit Salesforce's documentation on Components Available in Managed Packages.

To prevent the cessation of any custom features or functionalities upon product upgrade, only edit, delete, and reference components explicitly named in the Edit and delete components section.

Unless explicitly stated within a given component’s API name, label, description, or help text, any component whose API name is NOT prefixed with mvn__, mvn__PJN_, or PJN_ is free of product concern. You may alter or remove these components without impacting out-of-the-box product behavior.

Warning

This guidance is specific to out-of-the-box product behavior. Before making changes to components not prefixed with mvn__, mvn__PJN_, or PJN_, consult the parties responsible for implementing or altering Komodo Care Connect to prevent the cessation of any custom features or functionalities.

Edit and delete components

Table 65, “Customization matrix” specifies the components of Komodo Care Connect that you can modify and any relevant exceptions to keep in mind. The table is subject to change over time.

The table contains these columns:

  • Type - the type of component.

  • Editable - indicates if you may make alterations to the component (✓) or not (null).

  • Deletable - indicates if you may delete the component (✓) or not (null).

  • Permitted modification - specifies alterations to the component that are supported.

  • Modification exceptions - specifies alterations to the component that are NOT supported.

Note

If you want to alter a component not listed in Table 65, “Customization matrix”, create a copy of the existing component and make the desired alterations to the copied component. Do not edit or delete the original Komodo Care Connect component.

Table 65. Customization matrix

Type

Editable

Deletable

Permitted modifications

Modification exceptions

Apex classes

  • Only globally accessible classes can be referenced as needed. Refer to the Apex classes page for the list of globally accessible classes.

  • Only references to certain non-global Apex classes can be repointed and deactivated. Refer to the Trigger handler exceptions page for the list of these trigger handlers and where they can be repointed or deactivated.

  • Do NOT modify Apex code in any way.

Apps

✓

Auth. Providers

✓

Custom metadata types

✓

✓

  • Only custom metadata records can be altered.

  • Do NOT alter custom metadata object definitions.

  • Do NOT delete the following custom metadata records:

    • mvn__PJN_Global_Setting__mdt.PJN_Global_Setting

    • Any mvn__PJN_Trigger_Handler_Setting__mdt metadata record with a PJN_ prefix. However, they can be inactivated where required. Inactivation of Komodo Care Connect triggers should be treated with caution and may lead to unintended consequences.

Custom objects

✓

  • New custom fields may be added.

  • Selected fields for Field Audit Trail may be modified.

Dashboards

✓

✓

Fields

✓

  • Picklist values may be added and modified.

  • Dependencies between controlling picklist fields and dependent picklist fields may be modified.

Field sets

✓

Flows

  • Out-of-the-box flows may be overridden.

  • New custom flows may be added.

  • Do NOT alter or deactivate flows prefixed with PJN_. Instead, create a flow override.

Lightning record page assignments

✓

✓

  • Only assign record pages to App Default or below.

  • Do NOT assign record pages of mvn__ objects to Org Default.

Lightning record pages

✓

✓

  • Do NOT edit or delete the following FlexiPage:

    • PJN_Account_Search_App_Page

List views

✓

✓

Named credentials

✓

Page layouts

✓

✓

  • Do NOT modify page layouts of mvn__ metadata types.

Path assistants

✓

Permission sets

  • In Komodo Care Connect V1, you may modify the KCC - Editable Permissions (PJN_Editable_Permissions) permission set. However, note that the KCC - Editable Permissions permission set has been deprecated as of Komodo Care Connect V2.

  • Do NOT modify any other PJN_ permission set or any PJN_ permission set group.

  • Do NOT modify any "Komodo" permission set. This includes the Komodo DocuSign Permissions (DocuSign_OneClick_Permissions) and the Komodo - Feature - Document Editing Permissions (Document_Editing_Permissions).

Picklist value sets

✓

  • Picklist values may be added and modified.

  • Picklist values that do NOT have a Do Not Delete label may be deleted.

  • Do NOT delete picklist values that have a Do Not Delete label.

Record types

✓

  • Picklist values may be modified.

  • In Komodo Care Connect V1, PJN_ record types may be removed from the KCC - Editable Permissions (PJN_Editable_Permissions) permission set. However, note that the KCC - Editable Permissions permission set has been deprecated as of Komodo Care Connect V2.

  • Do NOT deactivate PJN_ record types.

Reports

✓

✓

Report types

✓

✓

Roles

✓

✓

Search layouts

✓

✓

  • Only modify profile-specific search layouts.

Note

Search layouts affect the following areas of Komodo Care Connect:

  • Global search result columns

  • Global search filter fields

  • Lookup search result columns

  • Lookup search filters

  • Items list view in an object tab

  • Do NOT modify the default layout.

Sharing rules

✓

✓

Validation rules

✓



Globally accessible classes

Only Apex classes that are globally accessible are referenceable. Reference the Apex classes page for the list of globally accessible Apex classes.

Trigger handler exceptions

All Apex classes that are not globally accessible are not referenceable. However, the Trigger handler exceptions page specifies the trigger handlers that can be repointed or deactivated through the Trigger Handler Setting (mvn__PJN_Trigger_Handler_Setting__mdt) custom metadata type. The Trigger Handler Setting metadata records that call such trigger handlers are provided by Komodo Care Connect via the initial installation script.

Automation

Komodo Care Connect provides several automations out of the box, including triggers on objects, flows, and validation rules. You can skip all of the automations so that they do not run for specific users, such as users who perform data migrations. To skip the out-of-the-box automations for a user:

  1. In Setup, search for and select Users.

  2. Click the user who needs to skip the automations.

  3. Click Edit.

  4. Check the Skip KCC Automation (mvn__PJN_Skip_KCC_Automation__c) checkbox so that it equals true. If the field is not on the page, modify the page layout on the User object to add the custom field.

  5. Click Save.

Translation

Komodo Care Connect supports translation through the use of Translation Workbench and custom labels. Package upgrades do not override translation configurations.

Translation Workbench

Translation Workbench is a standard Salesforce feature through which you can specify translation values for metadata and data labels, such as custom objects, fields, and picklist values. Translation values include both translations to other languages as well as changes to the terminology that best suits your users and business needs. You may impart translation changes to any component supported within the Salesforce Translation Workbench; based on the translated values in Translation Workbench, Komodo Care Connect will display metadata and data labels in a user's language.

Custom labels

Custom labels are a standard Salesforce feature through which you can specify translation values for all Komodo Care Connect text that appear in the user interface.

Keep these guidelines in mind when working with custom labels:

  • Never edit the base value. Only add language-specific translations.

  • Never reference Komodo Care Connect custom labels in custom code or formulas. Custom labels could be deleted at any time if they are no longer used in the product.