Skip to main content

Intro

To get started with Domo Everywhere, you must establish a connection between the publishing instance and all of the subscribing instances. The Domo administrator for the publishing instance creates and maintains the connections to the subscribing instances from the Domo Everywhere page. See Access Domo Everywhere below for more information on setting this up.
Definition: The admin also configures the authentication for each user within the subscribing instances. This is called routing.
After configuring routing, the Domo admin must create each subscribing instance within the publishing instance and provide key attributes for the individual users so that as they log in they are mapped to the appropriate subscribing instances. After the admin provides the key attributes, Domo completes mapping automatically. The admin can then view the mapping details from within the publishing instance.
Domo_Everywhere_Graphic.png


Prerequisites

Complete the following before routing, creation, and mapping:
  • Purchase the Domo Everywhere product.
  • Configure the publishing instance in Domo.
  • Find your instances’ authentication method in the following table and get the required information.
Note: If a third-party system hosts key attributes used to authenticate the identity of your users, choose OIDC or SAML.

Authentication Method

Description

JWT Secret

This method requires the simplest implementation. If your system hosts key attributes used to authenticate the identity of your users, choose JWT Secret. No additional information is needed. Generate the secret as instructed in the UI.

Important: A secret is a one-to-many relationship. After you select Generate Secret one time, copy it and put it in the places that you need it. When you navigate away from the page, that secret cannot be recovered. Generating a new secret invalidates all existing secrets.

JWT Public Key

If your organization uses this method, you can get the Public Key from your IT manager.

OpenID Connect (OIDC)

You need the following information:

  • Client ID
  • Client Secret
  • Authorization URL
  • Token endpoint
  • Exchange endpoint
  • User information endpoints

SAML (SSO)

You need the following information:

  • Entity ID
  • Login endpoint URL
  • Logout endpoint URL

Access Domo Everywhere

From the Domo navigation header, select More > Admin to open the Admin Settings. Under Domo Everywhere, go to the section you need to complete the task.
Screenshot 2024-03-26 at 9.18.07 AM.png

Routing

After completing the prerequisites, complete the following tasks to configure routing.

Choose the Authentication Method

  1. Access Domo Everywhere and go to the Embed section.
Domo Everywhere - Embed.png
  1. In the Embed section, go to the Routing tab.
  2. Select your authentication method from the menu.
authentication_method_menu.png
  1. Fill in the information for your authentication method.
Important: As a reminder, if you use JWT Secret, make sure to copy and save the secret after you generate it. After navigating away from the page, you cannot recover the secret. If you generate a new secret, all existing secrets are invalidated.

Grant Embed Access

Note: This security feature is optional. The Embed Url feature allows you to create a pre-approved list of domains that can display your embedded Domo content. Even with the embed code, a domain that is not on the allowlist cannot display the content.
Find this feature under Domo Everywhere > Embed in the Routing tab. Under Embed Url, in the Domain name field, enter the URL of a site to add to the allowlist and select Add. Repeat for each URL to add.
embed url.png
The URLs on the allowlist display below the Domain name field.
allowlist.jpg

Download Routing Certificate

This security feature is optional. If your website or portal requires certificate encryption between Domo and the website, you can download the certificate here. To download the certificate, select Download to the right of the Routing Certificate field.
download certificate.jpg
You can now upload the certificate to your authentication provider.

Uploading the Routing Certificate to the Subscribing Instance

After you download the Routing Certificate, you can upload it to a subscriber’s Domo environment by following these steps:
  1. Load the Domo environment you want to upload the certificate to.
  2. Access Domo Everywhere and select Embed.
  3. Go to the Routing tab.
  4. In the Authentication Method menu, select SAML (SSO).
  5. Select Edit. The Edit SAML (SSO) dialog displays.
    domo everywhere - embed edit.png
    edit_saml_dialog.png
  6. In the Certificate field, enter the Routing Certificate.
  7. Select Save.

Paste the Embed URL

After you have chosen the authentication method and configured all security features, you can view the embed URL.
  1. Copy the address in the Embed Url for identity broker field by selecting Copy.
  2. Paste the address into your host site or software to redirect users to their mapped account.
    Screen_Shot_2022-07-11_at_2.56.19_PM.png
    Note: If the format of your URL does not display as https:// domain . identity.domo.com , contact your account team.

Subscriber Instance Setup

After setting up routing, the next step is adding subscriber organizations to receive your published content. A Domo admin can create, update, and delete any number of subscribing instances based on needs and workflows. Before creating a subscriber instance for the first time, you must define your key attribute. Domo uses the key attribute to map a user to an instance. To help you determine your key attribute, consider which field in a user’s Domo profile comes from your identity provider (IdP). Common examples are customer ID and partner ID. We recommend renaming the Key attribute field to your preferred value. After you define your key attribute once, you can skip this section and begin with Create a Subscriber Instance.

Define the Key Attribute

  1. In Domo Everywhere, go to the Embed section.
  2. In Embed, go to the Mapping tab. At the top of the Mapping tab, the Key attribute field displays
  3. Select Edit to edit the field and name your key attribute. The Edit key attribute modal displays.
    edit_key_attribute.png
    You can name your key attribute whatever your organization uses for the value that identifies your customers. In this example, we are using customerID.
    edit_key_attribute_modal.png
  4. After you enter your key attribute name, select Save.
Your key attribute now displays throughout Domo Everywhere where the key attribute appears.

Create a Subscriber Instance

If your key attribute is defined, follow these steps to create a subscriber instance.
  1. Access Domo Everywhere and go to the Instance Management section. The Instances section of Domo Everywhere displays.
    domo everywhere - instance management.png
  2. Select + New Instance. The New Instance Creation modal displays.
    instance management.jpg
  3. In the modal, enter the Instance Name. We recommend giving the instance a name that corresponds with a service account that the organization uses consistently to validate all end customer accounts .
  4. Enter the Service account email.
  5. Enter the value for your key attribute, which displays in the modal how you configured it in the Mapping tab. In this example, the key attribute is configured as the customerID.
Screenshot 2024-03-15 at 11.28.00 AM.png
  1. (Optional) Check the box if you want to share with the default group.
  2. Select Save.
Saving may take a few seconds because the system confirms that no duplicate customer names have been sent.

Remove a Subscriber Instance

Important: The subscriber instance must unsubscribe from all publications before you can remove it.
  1. From the navigation header, go to More > Admin. The Admin Settings display.
  2. In the Domo Everywhere menu, select Publications. The Publications page displays.
    domo everywhere - publications.png
    Screenshot 2024-03-26 at 1.59.17 PM.png
  3. Open the Subscribers tab. Each subscriber instance displays as a row.
    Screenshot 2024-03-26 at 2.03.43 PM.png
  4. Select More for the subscriber you want to remove. The edit and delete options display.
    more menu.jpg
    Screenshot 2023-04-11 at 11.54.23 AM.png
  5. Select Delete Subscriber. A dialog displays where you must acknowledge that you understand that the subscriber is being removed from Domo permanently and that access to that subscriber’s Domo environment will be revoked.
    delete subscriber dialog.jpg
  6. Select Delete to remove the subscriber or Cancel to cancel the operation.

Mapping

After creating an instance, it’s time to set its key attribute for mapping. Users are mapped according to the Attribute Value on the left side of the mapping table. As each user signs into the host portal, Domo redirects the iframe to the Child instance URL listed on the right side of the mapping table.
mapping_table.png
Follow these steps to map a subscriber instance:
  1. From the navigation header, go to More > Admin.
  2. In the Domo Everywhere menu, select Embed.
  3. Go to the Mapping tab.
  4. Select + Add Mapping.
The Add mapping dialog displays.
add_mapping_dialog.png
  1. In the dialog, fill in the Attribute Value and the Child instance URL for the user.
  2. Select Save.
The dialog closes. Users are now mapped to the correct subscribing instance.

Change the Key Attribute Name

  1. Inside Domo Everywhere, go to the Embed section.
  2. Go to the Mapping tab.
  3. In the Key attribute field, enter the value you would like to use instead.

Troubleshooting

This usually occurs if you have changed the Key Attribute name from the default and your host page has not adjusted to watch for the new name. The default always looks for “keyAttribute.” We recommend you change it to the field in your data and user profiles. Common examples include “Customer ID” and “Partner ID.”
ce6d562b-07ce-4ccc-bd99-6d5684843c34.png
This usually occurs if you or the automated process have not successfully uploaded the cert.pem to the SSO settings in the subscriber instance’s Domo environment. Routing Certificates are usually uploaded automatically by the published configuration.
cert_to_download_callout.png
If that process was not successful, or if you are integrating a preexisting instance that was not created through a Domo Everywhere admin, you can also manually download the SSO certificate from the publishing organization and upload it to the subscriber instance. For detailed instructions on how to do this, see Downloading the Routing Certificate, above. “Browser cannot open page in embedded iframe” This usually happens if the no-iframe-embedding feature switch is active. Deactivation of the switch is normally done automatically as a part of the configuration published from the parent to the child along with the rest of the brand kit and subscriber feature switches. If you click the “open site in new window” and the cert mentioned above has been uploaded, the child should load when accessed directly or when you click the “Open Site in New Window” button above. If that published configuration was unsuccessful or the child is a preexisting instance, “no-iframe-embedding” can be activated by contacting your Domo representative. This will ensure the child environment also loads in embedded iframes.

FAQ

For this version, we require all subscribing instances to use the same “embedded end customer account” feature switch template. That template hides the Domo platform header and footer, removes Domo branding, and activates auto-subscription capabilities. However, if you have additional unique needs, you can coordinate additional template changes by contacting your CSM/AE.Your custom template is then automatically used to create subscriber instances for that publisher.
Bulk creation is not currently available.
This is not currently available.
Yes, you can set the default role at the instance level for each instance. It can be set to any standard or custom role.