You can perform different tasks when redirecting a user to Yellowfin, such as suppressing the header, navigating to a particular report, displaying a particular dashboard, etc. This is done by defining user session options in the login token.

 

Session options can be passed in two ways:

  1. As part of a URL
  2. As part of a SSO call

 

Passing Session Options via URL

Pass session options through a URL. For example:

http://<yellowfin-server>/logon.i4?LoginWebserviceId=<token>&disableheader=true&entry=TIMELINE

With the inclusion of entry=TIMELINE, and disableheader options in the URL, the user will be taken to the Timeline page, and the Yellowfin header will be disabled, when they log in.

 

Passing Session Options as Part of a SSO Call

A Single Sign-On, or SSO, call (which includes LOGINUSER and LOGINUSERNOPASSWORD) can be used to pass sessions, by applying the setParameters() method.

For example:

String[] parameters = new String[] {"ENTRY=TIMELINE","DISABLEHEADER=TRUE"};

rsr.setParameters(parameters);

Similarly, this example will disable the Yellowfin header, and the user will be redirected to the Timeline page.

 

Available Session Options

Below is a list of key session options and their descriptions that you can use to pass through URLs or the Parameters method:

Parameter KeyURL KeyDescription

YFTOOLBAR

yftoolbar

TRUE/FALSE. To hide the Yellowfin toolbar for this session.

ENTRY

entry

Determine the user's only entry point on completion of the login process. This is used in conjunction with other parameters to determine the content the user is shown. Possible values include:

  • DASHBOARD
  • REPORTLIST
  • BROWSE
  • BROWSETAB
  • CREATEREPORT
  • EDITREPORT
  • VIEWREPORT
  • ADMINISTRATION
  • EDITDASHBOARD
  • VIEWDASHBOARD
  • VIEWSTORYBOARD
  • TIMELINE

REPORTID

reportid

Used with ENTRY = EDITREPORT or VIEWREPORT. This is the internal ID of the report to redirect to.

REPORTUUID

reportuuid

Used with ENTRY = EDITREPORT or VIEWREPORT. This is the UUID of the report to redirect to.

STORYBOARDUUID

storyboarduuid

Used with ENTRY = VIEWSTORYBOARD. This is the UUID of the storyboard to redirect to.

MOBILEDEVICE

mobiledevice

TRUE/FALSE. Takes the user to a mobile version of the Yellowfin interface.

REPORTNAME

reportname

Used with ENTRY = EDITREPORT or VIEWREPORT. This is the name of the report to redirect to.

DISABLESOURCEFILTERS

 

TRUE/FALSE. Disables Source Filter or Client Reference Filters for this user, for this session. This allows the user to see all the data. This doesn't work for content based on Client Source Substitution.

DISABLEHEADER

disableheader

TRUE/FALSE. Hides the Yellowfin header for this session.

HIDEHEADER

hideheader

Same as DISABLEHEADER.

DISABLEFOOTER

disablefooter

TRUE/FALSE. Hides the Yellowfin footer for this session.

HIDEFOOTER

hidefooter

Same as DISABLEFOOTER.

DISABLESIDENAV

disablesidenav

TRUE/FALSE. Hides the Yellowfin side navigation for this session.

HIDESIDENAV

hidesidenav

Same as DISABLESIDENAV.

DISABLELOGOFF

disablelogoff

TRUE/FALSE. Hides the Yellowfin logoff link for this session.

HIDELOGOFF

hidelogoff

Same as DISABLELOGOFF.

REASONCODE

reasoncode

Custom string (80 ASCII characters) that will be dropped in all events generated by this session. Events are dropped in the Event table in the Yellowfin database.
This option can also be used with the JavaScript API.

REASONDESCRIPTION

reasondescription

Custom string (2048 ASCII characters) that will be dropped in all events generated by this session. Events are dropped in the Event table in the Yellowfin database.
This option can also be used with the JavaScript API.

DASHBOARDID

dashboardid

Used with ENTRY = EDITDASHBOARD or VIEWDASHBOARD. This is the internal ID of the dashboard tab to redirect to.

DASHBOARDUUID

dashboarduuid

Used with ENTRY = EDITDASHBOARD or VIEWDASHBOARD. This is the UUID of the dashboard tab to redirect to.

FILTER<ID>

filter<ID>

Used with ENTRY = VIEWREPORT. Overrides filter values for the given report. FILTER is appended with the internal ID of the filter, plus the string representation of the filter value. For example:
FILTER2134=MALE
You can pass multiple filters for the one report.

SOURCEFILTER_<FILTERCODE>

 

Overrides the source filter values for this user, for this session.
SOURCEFILTER_ is appended with the Filter Type Code from the Source Filter setup page, plus the value you wish to give access to. For example:
SOURCEFILTER_COUNTRY=AU
You can pass multiple source filter values for the one session.
This option can also be used with the JavaScript API.

CONTENT_<INCLUDE/EXCLUDE>

 

Overrides the content access that a user has for this session.

CONTENT_ is appended with either INCLUDE or EXCLUDE. The value for this key is either the Content Category Code, or the Content Category UUID.

  • If you choose to INCLUDE content, then these will be the only Content Categories that the user will have access to.
  • If you choose to EXCLUDE content, then these excluded Content Categories will be removed from the content that the user normally has access to.

Content Inclusion and Exclusion is based on the Category level. All sub categories with the specified category are included or excluded.
An example of including/excluding with category codes and UUIDs:
CONTENT_INCLUDE=TUTORIAL
CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77
CONTENT_EXCLUDE=TUTORIAL
CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77
It is not logical to use both INCLUDE and EXCLUDE for the same session.
This option can also be used with the JavaScript API.

LANGUAGE=<LANGUAGE_CODE>

Not applicable

Overrides the language of the user's session with the one specified in this parameter. Note that doing so will invalidate the default language or any translation settings configured in the browser.

For example, passing LANGUAGE=JA will force the session's language to be Japanese.

 

 

 

 

 

  • No labels