Skip to main content

Component setup

To set up the Komodo Insights Component in your Salesforce environment after the initial installation, please complete the following steps.

Note

The steps below assume that the Komodo Insights Component has already been installed in your Salesforce environment and that you have a Consumer Key and Consumer Secret. If you have yet to install the component or receive your customer credentials, please reference Installation and reach out to your Komodo Health Customer Success Manager (CSM).

Create an Auth. Provider

To allow your users to log into the custom Komodo Insights Component with their Salesforce credentials, you need to create a Salesforce authentication provider.

  1. In the Quick Find box in Setup, search for and select Auth. Providers.

  2. Click New.

  3. Set the Provider Type Name to Open ID Connect. Additional fields will appear.

  4. Enter a Name for the provider. The URL Suffix will populate automatically.

  5. Enter the Consumer Key and Consumer Secret you received from Komodo Health CSM.

  6. Set the Authorize Endpoint URL to https://aperture-admin.komodohealth.net/oauthv2/authorize.

  7. Set the Token Endpoint URL to https://aperture-admin.komodohealth.net/oauthv2/token.

  8. Keep all other fields as they are, and click Save.

  9. Provide the Callback URL under the Salesforce Configuration section to Komodo Health CSM. This will allow Komodo Health to catalog your URL as a trusted endpoint for added security.

auth. provider settings for Komodo Insights component admin setup

Create a new Named Credential

The Komodo Insights Component Named Credential from the initial installation needs to be updated to include the newly created authentication provider.

  1. In the Quick Find box in Setup, search for and select Named Credentials.

  2. Click the dropdown arrow next to New and select New Legacy.

    KIC_NamedCredential_NewButton.png

  3. Complete the following fields:

    • Label: Example, KH Insights

    • Name: Auto-populated

    • URL: https://aperture-admin.komodohealth.net/

    • Certificate: Leave null

    • Identity Type: Per user

    • Authentication Protocol: OAuth 2.0

    • Authentication Provider: Select Auth. Provider created in step 1

    • Scope: aperture-iris:tag:read openid offline_access

    • Start Authentication Flow on Save: Check this to initiate authentication

    • Generate Authorization Header: Checked

    • Allow Merge Fields in HTTP Header: Unchecked

    • Allow Merge Fields in HTTP Body: Unchecked

  4. Click Save.

    Note

    This step can only be completed once the Callback URL is provided to your Komodo Health representative and has been added to our list of allowed Callback URLs. If you continue to see the "Callback URL mismatch" error, please reach out to your Komodo Health representative for assistance.

Update custom metadata

You will need to update the Komodo Health Insights Settings (mvn__KHBI_Komodo_Insights_Settings__mdt) custom metadata type and the Named Credential you just created.

To do so:

  1. In the Quick Find box in Setup, search for and select Custom Metadata Types.

  2. Click Manage Records next to the Komodo Health Insights Settings custom metadata type.

  3. Click Edit next the the Default record.

  4. Add the Named Credential you created into the Named Credential field.

  5. Click Save.

Configure a permission set

Komodo Health recommends using a permission set to manage access to the Komodo Insights Component.

  1. In the Quick Find box in Setup, search for and select Permission Sets.

  2. Create a new permission set or select an existing one.

  3. In the permission set, click Apex Class Access.

  4. Click Edit.

  5. Add mvn.KHBI_KomodoComponentCtrl to the Enabled Apex Classes list.

  6. Click Save.

  7. Click Permission Set Overview to return to the permission set.

  8. In the permission set, click Named Credential Access.

  9. Click Edit.

  10. Add the Named Credential created above to the Enabled Named Credentials list.

  11. Click Save.

  12. Assign the permission set to the users who should have access to the Komodo Insights Component.

Note

Optionally, you can also create and add a custom permission to the permission set so that the component is only visible to users assigned with the permission set. Visit Salesforce's documentation on how to Create Custom Permissions and Enable Custom Permissions in Permission Sets.

Add to page(s)

The Komodo Insights Component needs to be added to one or more pages for your users to use the component.

  1. Open the desired page(s) in the Lightning App Builder.

  2. Drag and drop the KH - Komodo Health Insights custom component into the desired location on the page.

  3. Set the Record NPI Field to the API name of the field on the record that contains the desired National Provider Identifier (NPI) value. For example, if you are adding the component to the Account record page and have a field on the Account object with the API name of NPI__c, enter NPI__c.

  4. Click Save.

Note

If you created and added a custom permission to the permission set for the component, you can add a filter on the component in the page layout so that the component will only display for users assigned with the permission set. Visit Salesforce's documentation on Dynamic Lightning Pages.