Page tree
Skip to end of metadata
Go to start of metadata

When embedding both standard dashboards and KPI dashboards as well as Analytical Designer into your product, use the following conventions:

Embed Standard Dashboards

To embed dashboards, you can identify which dashboard to show either with /obj/### or with /obj/identifier:xxxx in the dashboard URL. For details about identifiers, see Acquiring Object Identifiers for Project Metadata.

To identify which workspaces/projects to use, you can specify either PROJECT_ID or client:yyy found in the URL.

client:yyy only works when  you use Life Cycle Management (LCM) (workspaces/projects associated to clientIDs in the segment).

Dashboard Examples:

  • Without LCM
    • using identifier:
      https://{hostname}/dashboard.html#project=/gdc/projects/{project_id}&dashboard=/gdc/md/{project_id}/obj/identifier:{dashboard_identifier}
    • using ID: 
      https://{hostname}/dashboard.html#project=/gdc/projects/{project_id}&dashboard=/gdc/md/{project_id}/obj/{dashboard_id}
  • With LCM
    • using identifier:
      https://{hostname}/dashboard.html#project=/gdc/projects/client:{data-product}:{client_id}&dashboard=/gdc/md/client:{data-product}:{client_id}/obj/identifier:{dashboard_identifier}

Embed KPI Dashboards

To embed KPI dashboards, you can identify which dashboard to show with the numerical ID in /dashboardId/$ID or with the identifier /dashboard/$IDENTIFIER (note the different path - dashboardId vs dashboard).

To identify which workspace/project to use, you can specify either /project/$PROJECT_ID/ or /client/$CID/.

The CID version only works when you use LCM (i.e. workspaces/projects associated to clientIDs in the segment).

You can use any combination of workspaces/projects and dashboards (client+id, client+identifier, pid+id, pid+identifier) to identify your embedded dashboards.

KPI Examples:

  • Without LCM (using Project ID)
    • using identifier:
      https://{hostname}/dashboards/embedded/#/project/{project_id}/dashboard/{dashboard_identifier}
    • using ID:
      https://{hostname}/dashboards/embedded/#/project/{project_id}/dashboardId/{dashboard_id}
  • With LCM (using Client ID)
    • using identifier:
      https://{hostname}/dashboards/embedded/#/product/{data-product}/client/{client_id}/dashboard/{dashboard_identifier}

If you have tags assigned to attributes, measures, or date datasets, you can hide and display the attributes, measures, or dates in embedded KPI dashboards based on tags.

For more information on adding tags, see:

More information: Embed a KPI Dashboard

Embed Analytical Designer

To embed Analytical Designer, use the project/workspace id.

Analytical Designer Examples:

  • To embed Analytical Designer to open to the form for creating a new insight:
    https://{hostname}/analyze/embedded/#/{project_id}/reportId/edit
  • To embed Analytical Designer to open to a specific insight:
    https://{hostname}/analyze/embedded/#/{project_id}/{insight_id}/edit

If you have tags assigned to attributes, measures, or date datasets, you can hide and display the attributes, measures, or dates in embedded Analytical Designer based on tags.

For more information on adding tags, see:

More information: Embed Analytical Designer

Best Practices

ObjectID vs Identifier

It is highly recommended to use the Identifier over ObjectID, as the Object ID of the same dashboard can be different in different workspaces. The Identifier will always be the same if the workspaces/projects are clones or created using LCM or imported with partial MD import.

Project Identifier vs Client ID

If you are using LCM, It is recommended to use the ClientID over Project Identifier (PID) as it helps to maintain persistency between workspaces/projects.

With the introduction of data product (LCM API and Managing Projects via Life Cycle Management) the format for Client IDs have changed. If you do not specify the data product in your URLs, they direct to the default data product.

Learn more about embedding

  • No labels