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.

...

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  is enabled and the displayed content is not secured.   For more details, see the User Access (http://wiki.yellowfin.com.au/display/yfcurrent/JavaScript+API#JavaScriptAPI-UserAccess) section below.

If the embedded report is being used on a dynamic page or portal, a SSO (link to Single Sign On page from webservices) can  can be used to to automatically 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)Refer to the Limitations section below for more details.

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.

...

 

Description

Displays basic Report Information including; Name, Description, Last Modified Date, Category, Sub Category, and Current User

Displays the Javascript 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

...

Using the Share menu, copy the Embed Javascript 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.

Anchor
userAccess
userAccess

User Access

Styleclass
ClasstopLink

Embedding with JavaScript

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. (Click here to learn how to do this.) 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 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).

 

Anchor
limitations
limitations

Limitations

Styleclass
ClasstopLink

Embedding with JavaScript

The current limitations of the Javascript API include:

...