Prerequisites

To embed a dashboard, you need:

• a project name

• a technical name of an existing dashboard

• a URL of the target page where the iFrame will be embedded

Creating the embedding

An embedding can be created via the Project Management Service APIs.

Proceed as follows

1. Open the Project Management Service APIs.

2. Open Embeddings: Embedding Management Controller.
   → A list of request is displayed.

3. Open the POST /v1/{project}/embeddings request.

   1. In the Parameters pane, enter the project name in the project field.

   2. In the embedding field, paste the following code block:

      {

      "active": true,

      "dashboard": "home",

      "allowedOrigins": [

      "https://mywebsite.example.com",

      "https://test.example.com"

      ],

      "authMethod": "USER_SESSION_GRACEFUL"

      }

      → This request creates an embedding for the dashboard with the name 'home' in your project.

The dashboard is allowed to be embedded on the URLs: https://mywebsite.example.com and https://test.example.com.

The response contains the embedding Id '609a6a07ea4ce82548dcf501'.

This Id is required to build the embedding URL, which follows this structure: https://bosch-iot-insights.com/embed/{project}/{id}.html.

If you want to initialize the view in a specific language, you can specifiy the language with the query paramater initialLang. Currently supported values are de and en. Furthermore, you can specify to load Bosch IoT Insights in full-screen mode using the query parameter fullscreen.

If you want the hyperlinks to consider your outer Frame URL use the prefixUrl parameter. It will prevent dashboard links to open outside of the outer Frame, by passing the URL of your frame server.

For instance, by passing

hyperlinks which forward to another dashboard, will be converted from

to

Embedding an iFrame

The embedding URL can be used to embed the dashboard within an iFrame on one of the allowed origins.

Troubleshooting