This week I’ve been working on a website to showcase the power of our MagnumBI platform – the demo isn’t quite live yet but all will be revealed soon. As part of it I’ve learnt how to embed reports from Yellowfin onto a web page which turns out is quite easy, once you’ve made a few tweaks to the configuration.
The first part is to make sure Yellowfin knows it’s own address, otherwise your embed script will just say localhost. There’s a setting within Configuration under the Administration menu – if you don’t have that menu then you’ll need to talk to your administrator to make the change.
Once you’re in Configuration, click on the cog:
Expand the General Settings list and amend the External Instance Base URL to the website you use to login to Yellowfin. E.g. http://www.website.com/ or http://yellowfin.website.com
Once that’s been done, you need to find your report that you want to embed – click Browse then find the dashboard which contains your chart. You have a choice to embed the entire dashboard or just a chart from it.
To embed the full dashboard, click on the next to the name or click after hovering over the chart you want to share. The embed text can be found via Share.
You just need to add this embed script to your html code and the chart will appear. There are a few little tweaks you can do around appearance explained here:
The Expand Here… section under Loading a Report has the parameters you can specify in the embed command.
The last bit is to make sure the permissions are set correctly. I’d assume if you’re embedding a report you want to make it available to the public, but if not then you can get it to display a username and password box, once they’ve logged in they’ll see the report on the page. This behaviour is dictated by the permissions you’ve assigned to the report using categories.
Before making changes to the categories to make reports public, you need to make sure you have a guest role setup and a guest user. Information on this can be found here: http://www.yellowfinbi.com/YFForum-How-to-give-external-users-access-to-a-report-?thread=100865
To add categories or change them, go to Admin Console under Administration.
When you expand content categories it will display a list of the ones you have created. Sub-categories are the part where we’ve set the permissions. You can see that we have two main categories in our example, each with their own sub-category; Twitter with a sub-category of Unsecured Reports and Yellowfin Usage with a subcategory of Yellowfin usage Reports. It displays a lock symbol to show whether these are secured categories or public:
You can use an existing parent category or create a new one, once you have the parent category you want to use, click add for a sub-category, or if you want to amend an existing one, click on it’s name.
Give it a Name and Description, then select sub-category and choose the parent you wish to assign to it, mark it as Active and change the Security Type at the bottom to Unsecure. Once created, just assign the category and sub-category to the report and it should be available publicly.
One thing to note; we came across it asking for a username and password when viewing the embedded report while already logged in to Yellowfin in the same browser instance, but apart from that everyone else could access fine, worth noting in case you have a similar result in your testing.
Keep exploring! – Daniel