Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
classcontents

Overview

Styleclass
ClasstopLink

top

Using the Javascript API, Yellowfin Reports and Dashboards can be embedded into external webpages, which can be hosted on a seperate web server to Yellowfin. The only requirement is that the end user's browser can access the Yellowfin server.

...

Interactive elements such as Drill Through, Drill Down, User Prompt Filters, Series Selection, and Export to PDF are available.

Display

Styleclass
ClasstopLink

top

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:

  • Export to CSV
  • Export to DOC
  • Export to PDF
  • Export to Rich Text Format
  • Export to Text
  • Export to XLS

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:

  • Export to CSV
  • Export to DOC
  • Export to PDF
  • Export to Rich Text Format
  • Export to XLS

Example Usage

Styleclass
ClasstopLink

top

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
ClasstopLink

top

Users are authenticated when accessing a report or dashboard through the Javascript API. If a user has not yet logged in, they may be able to view the content as a Guest user. There are a number of factors used to determine whether a report or dashboard can be run as a Guest user, or whether unauthenticated users are required to log in.

...

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
ClasstopLink

top

The current limitations of the Javascript API include:

...