Page History
...
| Table of Contents | ||
|---|---|---|
|
Overview
| Styleclass | ||
|---|---|---|
| ||
| Code Block | ||
|---|---|---|
| ||
<script src="http://reporting.example.com/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&height=500" type="text/javascript"></script> |
The example scriptlet above will render a report within the enclosing page. If the user does not have a current session on the instance that the embedded report is coming from, the user will be prompted to log in unless the Guest User login (http://wiki.yellowfin.com.au/display/yfcurrent/Guest+Users) is enabled and the displayed content is not secured. For more details, see User Access (http://wiki.yellowfin.com.au/display/yfcurrent/JavaScript+API#JavaScriptAPI-UserAccess)
If the embedded report is being used on a dynamic page or portal, a SSO (link to Single Sign On page from webservices) can be used to log the user in automatically using Yellowfin's LOGINUSER web service. The token is appended to the URL (how to use the token with JavaScript API link).
The widget that is embedded cannot be greatly styled or modified. A compromise needs to be made between ease of integration with the JSAPI with limited customizability or complex integration using the Report Service API (Reporting webservices link) with unrestricted customizability. More details: Limitations (http://wiki.yellowfin.com.au/display/yfcurrent/JavaScript+API#JavaScriptAPI-Limitations)
Some third-party application implementations use a combination of Administration Service web services to return the available reports/dashboards for a user and render these for the user using the JavaScript API.
The HTML page can include multiple reports, however each separate report may only be displayed once on each page. Note: multiple dashboards on a single page are not currently supported.
Interactive elements such as Drill Through, Drill Down, User Prompt Filters, Series Selection, and Export to PDF are available.
Display
| Styleclass | ||
|---|---|---|
| ||
Report
The embedded report contains a Title Bar and the Report itself. The Title Bar contains the name of the report, as well as buttons to control any interactive elements used on the report. The interactive features include:
| Description |
|---|---|
| Displays basic Report Information including; Name, Description, Last Modified Date, Category, Sub Category, and Current User |
| Displays the Javascript used to embed the report |
| Allows the user to toggle to Chart view if Table and Chart display is used |
| Allows the user to toggle to Table view if Table and Chart display is used |
| Opens a panel of User Prompt Filters enabled on the report |
| Opens a Series Selection panel if the Visible Series Selection option is enabled |
| Opens a Unit Selection panel if the Visible Units Selection option is enabled |
| Opens a Page Navigation panel if the report contains multiple pages |
| Opens a Section Navigation panel if the report contains sections |
| Opens the GIS Map Navigation panel if the map has Hover Navigation enabled |
| Opens the Export panel, allowing the user to export the report to various formats, including:
|
Dashboard
The embedded dashboard contains a Title Bar for the entire dashboard, and then each of the dashboard reports (displayed the same as embedded reports), laid out the same way as they are when viewed through the Yellowfin front end.
Note: dashboard filters and KPI dashboards are supported.
| Description |
|---|---|
| Displays basic Dashboard Information including; Name, Description, Last Modified Date, and Current User |
| Displays the Javascript used to embed the dashboard |
| Opens a panel of User Prompt Filters enabled on the dashboard |
| Opens the Export panel, allowing the user to export the dashboard to various formats, including:
|
Example Usage
| Styleclass | ||
|---|---|---|
| ||
Embedding a Report
Using the Share menu, copy the Embed Javascript, which identifies the report to load, for use in your HTML page, wiki, or blog. It will take a form similar to this:
...
See the Basic Use for more information.
Embedding a Dashboard
Using the Distribute menu, copy the Embed Javascript, which identifies the dashboard to load, for use in your HTML page, wiki, or blog. It will take a form similar to this:
...
See the Basic Use for more information.
User Access
| Styleclass | ||
|---|---|---|
| ||
...
Note: The cookie value stored in the browser is encrypted. The cookie will not work across a restart of Yellowfin (i.e. when Yellowfin is restarted, all users will be required to log in again).
Limitations
| Styleclass | ||
|---|---|---|
| ||
...
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||