Embedding Code Formats

When embedding pixel-perfect dashboards, KPI dashboards, or Analytical Designer, you need to construct the URL for an embedded object.

The structure of the URL varies depending on whether you use Life Cycle Management (see Managing Projects via Life Cycle Management) and also on the method of identifying the embedded object.

Contents:

Embed Pixel-Perfect Dashboards

When embedding pixel-perfect dashboards (see Embed Dashboards and Reports), you need to identify the embedded dashboard and where it belongs to (workspaces/projects to use).

Identify the Dashboard

As best practice, use the dashboard identifier (/obj/identifier:{dashboard_identifier}). Alternatively, you can use the dashboard ID (/obj/{dashboard_id}).

For details about the identifiers, see Acquiring Object Identifiers for Project Metadata.

We recommend that you use the dashboard identifier over the dashboard ID because the ID of the same dashboard can be different in different projects. The dashboard identifier, however, will always be the same if the project is cloned or imported with partial metadata import.

Identify the Project/Workspace

To identify where the dashboard belongs to:

  • If you do not use LCM, use the project ID (see Find the Project ID).
  • If you use LCM, use the combination of the data product ID and client ID (see Managing Projects via Life Cycle Management).

    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID.

Construct the URL

  • Without LCM
    • Use the project ID and the dashboard identifier:

      https://{your.domain.com}/dashboard.html#project=/gdc/projects/{project_id}&dashboard=/gdc/md/{project_id}/obj/identifier:{dashboard_identifier}
    • Use the project ID and the dashboard ID:

       https://{your.domain.com}/dashboard.html#project=/gdc/projects/{project_id}&dashboard=/gdc/md/{project_id}/obj/{dashboard_id}
  • With LCM

    • Use the dashboard identifier and the combination of the data product ID and client ID:

      https://{your.domain.com}/dashboard.html#project=/gdc/projects/client:{data_product_id}:{client_id}&dashboard=/gdc/md/client:{data_product_id}:{client_id}/obj/identifier:{dashboard_identifier}
    • Use the dashboard ID and the combination of the data product ID and client ID:

      https://{your.domain.com}/dashboard.html#project=/gdc/projects/client:{data_product_id}:{client_id}&dashboard=/gdc/md/client:{data_product_id}:{client_id}/obj/{dashboard_id}


    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID. For example:

    https://{your.domain.com}/dashboard.html#project=/gdc/projects/client:default:{client_id}&dashboard=/gdc/md/client:default:{client_id}/obj/identifier:{dashboard_identifier}

When embedding KPI dashboards (see Embed a KPI Dashboard), you need to identify the embedded KPI dashboard and where it belongs to (workspaces/projects to use).

Identify the Dashboard

As best practice, use the dashboard identifier (/dashboard/{dashboard_identifier}). Alternatively, you can use the dashboard ID (/dashboardId/{dashboard_id}).

For details about the identifiers, see Acquiring Object Identifiers for Project Metadata.

We recommend that you use the dashboard identifier over the dashboard ID because the ID of the same dashboard can be different in different projects. The dashboard identifier, however, will always be the same if the project is cloned or imported with partial metadata import.

Identify the Project/Workspace

To identify where the KPI dashboard belongs to:

  • If you do not use LCM, use the project ID (see Find the Project ID).
  • If you use LCM, use the combination of the data product ID and client ID (see Managing Projects via Life Cycle Management).

    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID.

Construct the URL

  • Without LCM
    • Use the project ID and the dashboard identifier:

      https://{your.domain.com}/dashboards/embedded/#/project/{project_id}/dashboard/{dashboard_identifier}
    • Use the project ID and the dashboard ID:

      https://{your.domain.com}/dashboards/embedded/#/project/{project_id}/dashboardId/{dashboard_id}
  • With LCM

    • Use the dashboard identifier and the combination of the data product ID and client ID:

      https://{your.domain.com}/dashboards/embedded/#/product/{data_product_id}/client/{client_id}/dashboard/{dashboard_identifier}
    • Use the dashboard ID and the combination of the data product ID and client ID:

      https://{your.domain.com}/dashboards/embedded/#/product/{data_product_id}/client/{client_id}/dashboardId/{dashboard_id}/


    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID. For example:

    https://{your.domain.com}/dashboards/embedded/#/product/default/client/{client_id}/dashboard/{dashboard_identifier}

Embed Analytical Designer

When embedding Analytical Designer (see Embed Analytical Designer), you need to identify the embedded insight and where it belongs to (workspaces/projects to use).

Identify the Insight

Use the insight ID. For details about the identifiers, see Acquiring Object Identifiers for Project Metadata.

Depending on your use case, you can choose to open the form for creating a new insight instead of opening a specific insight.

Identify the Project/Workspace

To identify where the insight belongs to:

  • If you do not use LCM, use the project ID (see Find the Project ID).
  • If you use LCM, use the combination of the data product ID and client ID (see Managing Projects via Life Cycle Management).

    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID.

Construct the URL

  • Without LCM
    • Use the project ID and the insight ID to open a specific insight:

      https://{your.domain.com}/analyze/embedded/#/{project_id}/{insight_id}/edit
    • Use the project ID, and set the URL to open the form for creating a new insight:

      https://{your.domain.com}/analyze/embedded/#/{project_id}/reportId/edit
  • With LCM

    • Use the insight ID and the combination of the data product ID and client ID to open a specific insight:

      https://{your.domain.com}/analyze/embedded/#/client/{data_product_id}:{client_id}/{insight_id}/edit
    • Use the combination of the data product ID and client ID, and set the URL to open the form for creating a new insight:

      https://{your.domain.com}/analyze/embedded/#/client/{data_product_id}:{client_id}/reportId/edit


    If you do not know the data product ID or do not use data products in your LCM implementation, use the value default instead of the data product ID. For example:

    https://{your.domain.com}/analyze/embedded/#/client/default:{client_id}/reportId/edit