Best Of

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.

The following instructions can help you identifying the exact .NET version installed on a specific machine.

.NET Framework v. 4.5 or higher:

1. On the Start menu, choose Run.

2. In the Open box, enter regedit.exe.

   You must have administrative credentials to run regedit.exe.

3. In the Registry Editor, open the following subkey:

   HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full

Note: If the Full subkey is not present, then you do not have a the .NET Framework 4.5 or later installed.

Check for a DWORD value named Release. The existence of the Release DWORD indicates that the .NET Framework 4.5 or newer has been installed on that computer.

The value of the Release DWORD indicates which version of the .NET Framework is installed.

.NET Framework v. 1 to 4:

To find .NET Framework versions by viewing the registry (.NET Framework 1-4)

1. On the Start menu, choose Run.

2. In the Open box, enter regedit.exe.

   You must have administrative credentials to run regedit.exe.

3. In the Registry Editor, open the following subkey:

   HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP

   The installed versions are listed under the NDP subkey. The version number is stored in the Version entry. For the .NET Framework 4 the Version entry is under the Client or Full subkey (under NDP), or under both subkeys.

Note: The "NET Framework Setup" folder in the registry does not begin with a period.