This section explains how to enable global embed configuration and embed the dashboard with global custom attribute and isolation code using the configuration file.
Go to the settings page in ums and click
Embed for enabling the global embed configuration under that page.
Enable embed authentication: Enable or Disable the global embed authentication. Dashboards from any site can be embed using the global embed authentication.
Embed configuration: Attributes and isolation code can be configured for any site at any levels (user or group or site) using this embed configuration file.
Embed secret: Dashboards from any sites can be embed using the embed secret.
Generate Secret button.
By clicking it, the secret code will be generated. Save the secret key safely, as it cannot be retrieved or restored.
Once the secret code is generated, it can be reset by clicking the
Reset Secret button.
Warning : Resetting this code will break the previously working embedded dashboards.
You can download the sample template file to generate embed configuration file using the
Download template option.
If you need an existing embed configuration file, refer to the
CustomUI file from the following location
IsConfigurationBaseEmbed: It is used to enable or disable the configuration based embedding. If it is true, the dashboard uses the attributes and isolation code defined in the embed configuration file. Otherwise, dashboard uses the values from the site’s user and group profile pages.
EmbeddingProfile: Attributes and Isolation code can be defined in the embedding profile. You can create multiple embedding profiles with different names.
Name: Provide the name of the embedding profile. It will be used for referring the embedding profile in the users, groups or sites profile.
IsolationCode: Provide the isolation code for the embedding profile. Please refer to this page to know about the isolation code.
Attributes: Provide the attributes for the embedding profile. Please refer to this page to know about the attributes.
Embedding scope can be defined in three levels:
Based on these levels, the embedding profile will be selected and applied to render the dashboards.
Provides the user’s email and the defined embedding profile name. When the mentioned user renders the dashboard, the attributes and isolation code defined in the embedding profiles will be used to render the dashboard.
Provides the group name and the defined embedding profile name. When the user from the mentioned group renders the dashboard, the attributes and isolation code defined in the embedding profiles will be used to render the dashboard.
Provides the site name and the defined embedding profile name. When the user from the mentioned site renders the dashboard, the attributes and isolation code defined in the embedding profiles will be used to render the dashboard.
Based on the above hierarchy, it will select the embedding profile and reflect the changes in the dashboard. The priority order will be
Groups Profile and the