Skip to main content

What is Embed Link ?

The Embed link in HTML is used for embedding external applications which is generally multimedia content like audio or video into an HTML document. It is used as a container for embedding plug-ins such as flash animations.

Talking about the Embed link in terms of the OPNBI application, you can place the required dashboard in your existing website using the Embed link of the dashboard.

Embed link can be generated from below sections;

Dashboard embed link of dashboard can be generated and can be used to add dashboard in external application.

Click on link to know more about how to create and use Dashboard embed link. Click Here

Click on link to know more about how to create and use report embed link. Click Here

Click on link to know more about how to create and use adhoc embed link. Click Here

Click on link to know more about how to create and use dataset embed link. Click Here

Objective​

Objective of this document is to guide user how to generate embed link in various section.

Prerequisites​

To generate embed link of report we will use sample report available in Templates folder

Embed Link: This video contains how does embed link work in the dashboard in OPNBI.

  1. How to get embed link of a dashboard from OPNBI application

  2. There are 2 ways you can generate an Embed link of the dashboard, 1 from the Dashboard list view and 2 Directly from the dashboard edit view. Let’s go through both the ways one by one.

  1. login to OPNBI using system credentials.

  2. Click on the herger Docusaurus Slash Introduction menu and you will see a List view options icon just the right side of the + icon in the visualization section.

    Docusaurus Slash Introduction

  3. Once you click on list view it will show you a list of dashboards available in your repository for that login user.

  4. Search for required dashboard in list view. of Dashboard Section. For this example; Test Dashboard is used.

    Docusaurus Slash Introduction

  5. Click on that dashboard to select dashboard. You will see the checkbox Is marked.

  6. Click on 3 vertical dots at the left of the dashboard name, select the embed option.

    Docusaurus Slash Introduction

  7. you will see an embed window that will open with various options. All options description is as under;

    Docusaurus Slash Introduction

1. Embed Duration: With this option you can select duration up to when this link remains active. There are 2 options:

  • I. Infinite: which is by default selected. When using this option, the validity of your dashboard embed link will never end.
  • II. Validity: Use this option when you want this link to expire at some point in time. To do so when you select the validity radio button a new validity field is added just below the radio button where you can select the date and time when this link is supposed to be expired.

Docusaurus Slash Introduction

2. File Name: This field is non-editable and shows the name of the dashboard.

3. Section: This field is non-editable and shows dashboard section info.

4. Owner: This field is non-editable and shows owner info of the dashboard.

5. Bypass: When the user wants to bypass token info then the user needs to mark this checkbox. And when users need to use a token for security purposes then this check box is deselected before generating an embed link.

6. Generate: When clicked, an external embed link of the dashboard will be generated.

7. Grid view: In this section, a list of generated embed links will be listed.

8. Generate with selected key: This is used when you already have an embedded link and you want it to regenerate. Just select generated embed link from the grid section above this button and click on this button. In this case, the dashboard ID will remain the same as in the previous link.

  1. When you click on generate button, scroll down you will see the External embed link and Embedded code will be generated.

  2. User can use this External embed link to embed this dashboard into an external web application.

  1. Search for required dashboard in list view. of Dashboard Section. For this example; Test Dashboard is used.

    Docusaurus Slash Introduction

  2. Double click on Test Dashboard & Dashboard will open in preview mode.

  3. For Demonstration purposes, we will generate an embed link from the Test Dashboard.

    Docusaurus Slash Introduction

  4. Go to dashboard edit mode by clicking the edit icon available at the top right corner.

  5. when you entered dashboard edit mode, you will see an embed icon on the top right corner as shown in the image below:

    Docusaurus Slash Introduction

  6. Click on this icon and you will see the embed window will open.

  7. You can generate an embed link by referring to 7 steps given in option 1.