Bold BI supports embedding the dashboards to other web applications using Single Sign-On authentication.
Below are the steps to embed dashboards into other web applications.
Go to the settings page and click Embed
. Enable the Enable embed authentication
under that page.
Click Generate Secret
button.
On clicking it, the secret code will be generated. Save the secret key safely, as it will not be able to retrieve or restore this generated secret.
Once the secret code is generated, it can be reset by clicking the Reset Secret
button.
Warning : Resetting this code will break the previously working embedded dashboards.
The embed URL should be in the below format,
{dashboard URL}/{embed parameters}&embed_signature={signature}
Example: http://test.boldbi.com/bi/en-us/site/site1/dashboards/8428c9d9-85db-418c-b877-ea4495dcddd7/Predictive%20Analytics/Personal%20Expense%20Analysis&embed_nonce=3e253410-1a82-4fb3-a337-122a8007dafc&embed_user_email=test@syncfusion.com&embeds=sdwd&embed_dashboard_views_edit=true&embed_dashboard_views=true&embed_dashboard_export=true&embed_dashboard_comments=true&embed_widget_comments=true&embed_dashboard_favorite=true&embed_timestamp=1583928213&embed_expirationtime=100&embed_signature=VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY=' |
Please find the details of the parameter in the URL as below,
Parameter | Description |
dashboard URL | URL of the dashboard to be embed. |
embed parameters | Parameters required to embed the dashboard with SSO. |
signature | Authorized key for the dashboard to be embed. |
The below values are necessary to form the signature
Parameter | Mandatory | Description | Example |
embed_nonce | Yes | Random string that restricts the URL reconstruction or attacks from the hackers. | 0fa8d95d-e262-4a89-0976-390e3a57ee50 |
embed_user_email | Yes | The email id of the user. | test@syncfusion.com |
embed_dashboard_views | No | This value makes you to check the views in the embedded dashboard. | true |
embed_dashboard_views_edit | No | This value allows you to perform the actions such as save view, update view and delete views in the embedded dashboard. | true |
embed_dashboard_export | No | The export option to various format of the dashboard and widget in embedded dashboard is displayed based on this value. | true |
embed_dashboard_comments | No | The actions related to comments such as post, edit, delete, reply, watch, un-watch, posting the image and user mention list options can be performed in dashboard based on this value. | true |
embed_widget_comments | No | The actions related to comments such as post, edit, delete, reply, posting the image and user mention list options can be performed in widgets based on this value. | true |
embed_dashboard_favorite | No | The embedded dashboard can be marked as favorite based on this value. | true |
embed_datasource_filter | No | The embedded dashboard can be filtered with passed Dashboard Parameter and URL Parameter. | `If passing Dashboard Parameter - embed_datasource_filter=&&Parameter1=Value1` |
`If passing URL Parameter - embed_datasource_filter=&Parameter2=Value2` | |||
`If passing both filter - embed_datasource_filter=&&Parameter1=Value1&Parameter2=Value2` | |||
embed_timestamp | Yes | The current time as UNIX time stamp. The embed URL formed is valid for 5 minutes from this embed time stamp. | 1583934776 |
embed_expirationtime | No | Set the duration for the token to be alive. It must be represented in seconds. The default time is 86400 s and the maximum is 604800 s. | 604800 |
In embed URL, you can pass both types of filters(Dashboard Parameter/URL Filter Parameter) values at the same time.
Pass your filters to the embed_datasource_filter
URL parameter in the embed URL as follows,
Example: http://test.boldbi.com/bi/en-us/site/site1/dashboards/8428c9d9-85db-418c-b877-ea4495dcddd7/Predictive%20Analytics/Personal%20Expense%20Analysis&embed_nonce=3e253410-1a82-4fb3-a337-122a8007dafc&embed_user_email=test@syncfusion.com&embeds=sdwd&embed_dashboard_views_edit=true&embed_dashboard_views=true&embed_dashboard_export=true&embed_dashboard_comments=true&embed_widget_comments=true&embed_dashboard_favorite=true&embed_timestamp=1583928213&embed_expirationtime=100&embed_datasource_filter=&&dashboardparameter1=value1&urlparameter1=value1&embed_signature=VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY= |
The Dashboard Parameter filter must be started with a double ampersand &&
in the embed URL. Refer to this link for more details.
The URL filter Parameter must be started with a single ampersand &
in the embed URL. Refer to this link for more details.
Parameter | Mandatory | Description | Example |
embed_signature | Yes | A signature generated using the secret code to authenticate the embed URL. | VYrDMVX4h85PrRBKX9mystRHYkU8z+HVC9bkVMc2qGY= |
The embed parameter should be formed as in the below format.
embed_nonce=55a1c8f4-5015-487d-8463-d3ebeae655fd&embed_user_email=test@syncfusion.com&embed_dashboard_views_edit=true&embed_dashboard_views=true&embed_dashboard_export=true&embed_dashboard_comments=true&embed_widget_comments=true&embed_dashboard_favorite=true&embed_timestamp=1583935418&embed_expirationtime=100 |
The above formed embed parameter is signed with the secret code generated in the Bold BI server using the HMACSHA256 algorithm and the generated signed key will be appended with the embed URL as embed_signature.
You can download the sample here.