Page History
| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
Overview
| Styleclass | ||
|---|---|---|
| ||
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:
...
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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://reporting.example.com/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&height=500" type="text/javascript"></script>
|
...
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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script type="text/javascript" src="http://reporting.example.com/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9"></script>
|
See the Basic Use for more information.
User Access
| Styleclass | ||
|---|---|---|
| ||
...
When a user enters their Yellowfin username and password to log in to the Javascript API, a cookie is stored in their browser to remember the user they logged in with. The next time they visit a page that includes a report or dashboard embedded using the Javascript API, they will automatically be logged in again using the same user. This prevents users from needing to enter their details every time they request a report or dashboard. By default, the cookie is valid for seven days from the last time the user logs in. This period can be changed by setting the External API cookie timeout value in Administration > Configuration > Email. To disable the cookie altogether, set the value to 0.
Note: the cookie value is 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 | ||
|---|---|---|
| ||
- Reports at the Client Org level are not supported
- Multiple reports may be added to a single HTML page, but each report may only be included once per page
- Only one dashboard is supported per HTML page
- The calendar selector for date filters is not available
- Drill Anywhere is not available
- Saved Filter Sets are not available
- Chart Animation is not available
- The Multi-Chart Canvas is not available
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||