Skip to content
AIV

What is Embed Link

By using this document user will know how to generate Embed Link for Dashboard.

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 AIV application, you can place the required dashboard in your existing website using the Embed link of the dashboard.

Objective

To generate Embed Link of Dashboard

Prerequisites

For this example we are using the Test Dashboard.

Download dashboard.zip file from link given dashboard.zip.

After downloading the zip file, open Preview-Edit_Dashboard folder inside it & upload Test Dashboard dash file into the Dashboard & Sales.cds into Master data —> Dataset Section of the AIV. To add it into AIV follow this Link.

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

Steps to get Embed Link

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

Get Embed link from Dashboard List view:

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

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

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

  4. You will see an embed window that will open with various options. All options description is as under. Image

  5. 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. Image

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

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

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

  4. 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.

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

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

  7. 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. Image

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

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

Get Embed link from Dashboard Edit mode:

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

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

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

  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: Image

  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.

Common features:

Audit
Clone
Copy
Move
Upload
Delete
Share
Version
Download
Property
Save as quicklink