Howto: Embed a report on other sites

Board Support

Starting from Board 10.1, Board web reports can be embedded directly in other webpages, such as enterprise portal,  customer portal, intranet portal or other public websites. When you embed a report, it will appear as a box on your page that contains the full contents of your report, including charts, tables, and other custom visualizations.
Please note that this feature is only available for on-premises installations.

Configuration

For your embedded reports to be visible in an iframe, the "X-Frame-options-enabled" parameter in the appSettings.config file must set to "false". The appSettings.config file can be found at the path C:\Program Files (x86)\Board\Board WebApi Server\App_Data\config on the machine where Board Server has been installed.

<add-key="X-Frame-options-enabled" value="false" />

Notes:
- If you want to embed a report on a webpage hosted on the same machine where Board is installed, the "X-Frame-options-enabled" parameter described below can be omitted
- If you want to embed a report on a webpage hosted on a machine other than where Board is installed, the "X-Frame-options-enabled" parameter must be added to the appSettings.config file and configured as described above.
Please be aware that enabling the embed feature may pose security risks, such as clickjacking

Usage

To embed a report, you have to add an iframe tag in your html page using the following syntax:

Who can see my embed?

By default, embeds can be seen by people who have access to the embedded report.
When Anonymous user is enabled, all users can display the report without having to type username and password, all users will inherit the same credentials and profile.
Otherwise it's possible to manage authentication to Board web portal, including the web page a simple java script function:

 

All users not yet authenticated, you will see a pop-up in order to submit the Board credential.
callback.html is the html file that will be in pop-up.  This file must be visible via web.
The report will be displayed according to the user profile.

Embedded report with parameters

You can interact dynamically with the iframe through a url call indicating the name of the report. 
With this option you can also pass parameters to the report, simply by appending parameters to the URL.
Multiple parameters must be separated by ampersands (&).

The following parameters are supported:

• Capsule and screen

- #/screen/?capsulePath=Capsule.bcps
- screenName=Screen1      

Example

BoardWebPath/#/screen/?capsulePath=CapsuleName.bcps&screenName=Screen1

With the Capsule and Screen parameters you can override the server defaults (if specified).
If the Capsule name is specified but the Screen name is not, the home screen will be opened by default.
If Screen name is specified but the Capsule name is omitted, this setting is ignored.

• Select

- selection=EntityName1:value;EntityName2:value

Example

BoardWebPath/#/screen/?capsulePath=CapsuleName.bcps&screenName=Screen1&selection=Year:2012,2011;Division:Watches

Using this option it's possible to apply a selection to the Screen. The selection will be combined with the Screen selection.
The parameters in the URL must match the exact names of the parameters as they are shown in the entity name.
Multiple selections on the same entity must be separated by commas, while selections on different entities must be separated by semicolons.

• showMenu

- showMenu=true/false

Example

BoardWebPath/#/screen/?capsulePath=CapsuleName.bcps&screenName=Screen1&showMenu=true

With this parameter you can override the server default and show/hide the toolbar. If the toolbar is hidden, the user cannot access Board's interactive functions and can only navigate through Screens using navigation Objects included in the Screens themselves (Menus, Labels, Buttons, etc.).

Please review the Application Settings to correctly configure your web server according to the architecture you want to implement.

callback.zip

iframe.zip

Previous Member

Hi together,

 

does anybody know whether all functions e.g. data entry, tooltips are available in such an iframe used in a web portal ? I guess yes, just want to ensure if there could be some caveats.

 

Thanks

 

BR

Tomi

Fabio Donatellis

Hi Tomy,

An iframe is just a window that displays a web page. All functions are supported.

The only point of attention is authentication.

 

Fabio

Previous Member

Hi together,

is it possible to set a specific user for the login. We would need this for some testing reasons.

 

THX

 

BR

Tomi

Fabio Donatellis

Hi Tomi

you can use authentication with an anonymous user. 

In this way, all users will be connected to the same user/security/profile.

Remember that the anonymous user requires an Unlimited license.

 

BR

Fabio

Unknown

By using an iframe to embed a report, does the BOARD server need to be added as a trusted site for each client’s browser if the domain is different?

 

I thought iframes were blocked if crossing domains unless listed as a trusted site. 

 

Protect Your Website From Its Embedded Content With Iframes | Tinfoil Security 

Unknown

We are trying to hide site map and selector on our reports but this seems to conflict with the URL based navigation - please can you shed some light on how to do this?

Fabio Donatellis

Hi Matthew Layman

 

The option ShowMenu allows to show/hide the toolbar.

This solution is perfect to display a single report, but if you have a goto screen action, the header will be displayed, because this option can not be inherited.

 

In order to hide the site map, you should change the properties of the capsule and hide the screen list.

 

Fabio

Unknown

Hi Fabio

 

My point on this is that if I hide the Screen List then URL based navigation does not work (where I specify the screen name in the URL of the web client).

 

Regards
Matt

Dominik Haas

Hi 

Since Board 11.1 it's not possible to set showMenu=false, maybe you have to upgrade it.

 

I had installed Board 11.1 but had to go back to Board 11 for this reason.

 

Best regards

Dominik

Tim Lindemann

Is there any way of embedding sites in a portal etc. WITHOUT using iframe??

Some potential customers have company IT-guidelines in which iframes are not allowed.

 

Best regards,

Tim

Björn Reuber

Syntax has changed a little bit. in 10.6 following Syntax is working BoardWebPath/#/screen/?capsulePath=CapsuleName.cpsx&screenName=Screen&selection=Division:Watches

Dominik Haas

Hi all
is it in the meantime possible to hide the Menu again in the new board updates? (showMenu=false)
And as Tim asked, is there any alternative to an iFrame?

best regards
Dominik