ログインセッションオプションの定義

Yellowfinへユーザーをリダイレクトする際には、ヘッダーの重複抑制や特定のレポートへの移動、特定のダッシュボードの表示など、異なるタスクを実行することができます。これは、ログイントークンで、ユーザーセッションオプションを定義することで実現できます。

セッションオプションは、以下の2つの方法で渡すことができます。

URLの一部として
SSOの呼び出しの一部として

URLを介してセッションオプションを渡す

URLを介してセッションオプションを渡します。例：

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

上記のURLに「entry=TIMELINE」と「disableheader」セッションオプションを含めることで、ログイン時にユーザーはタイムラインへと移動し、その際のYellowfinヘッダーは無効になります。

SSOの呼び出しの一部としてセッションオプションを渡す

「setParameters()」メソッドを適用することで、（LOGINUSERとLOGINUSERNOPASSWORDを含む）シングルサインオンの呼び出しを、セッションの受け渡しに使用することができます。

例：

String[] parameters = new String[] {"ENTRY=TIMELINE","DISABLEHEADER=TRUE"};
 
rsr.setParameters(parameters);

同様に、こちらの例はYellowfinのヘッダーを無効にし、ユーザーはタイムラインへとリダイレクトされます。

利用可能なセッションオプション

こちらは、URLやパラメーターメソッドを渡すために使用できる、主要なセッションオプションとその説明の一覧です。

パラメーターキー	URLキー	経由	説明
YFTOOLBAR	yftoolbar	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinツールバーを非表示にします。
ENTRY	entry	URL、 SSO	ログインプロセス完了時の、ユーザーの唯一のエントリーポイントを指定します。これは、他のパラメーターとともに使用することで、ユーザーに表示される内容を指定します。値の選択肢は、以下の通りです。 `DASHBOARD` `REPORTLIST` `BROWSE` `BROWSETAB` `CREATEREPORT` `EDITREPORT` `VIEWREPORT` `VIEWSTORY` `ADMINISTRATION` `EDITDASHBOARD` `VIEWDASHBOARD` `VIEWSTORYBOARD` `TIMELINE` `SIGNAL` `VIEWSIGNAL`
REPORTID	reportid	URL、 SSO	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートの内部IDです。
REPORTUUID	reportuuid	URL、 SSO	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートのUUIDです。
STORYBOARDUUID	storyboarduuid	URL、 SSO	`「ENTRY = VIEWSTORYBOARD」`とともに使用します。これは、リダイレクト先ストーリーボードのUUIDです。
CONTENTUUID	contentuuid	URL、 SSO	これは、リダイレクトしたいYellowfinコンテンツの内部UUIDであり、内部ストーリー、またはシグナルのいずれかです。「ENTRY = VIEWSTORY」、または「ENTRY = VIEWSIGNAL」とともに使用します。
MOBILEDEVICE	mobiledevice	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。ユーザーを、Yellowfinインターフェースのモバイルバージョンに移動させます。
REPORTNAME	reportname	URL、 SSO	`「ENTRY = EDITREPORT」、`または「`VIEWREPORT」`とともに使用します。これは、リダイレクト先レポートの名前です。
DISABLESOURCEFILTERS	－	SSO	`「TRUE」、または「FALSE」に設定します`。このセッションにおける、このユーザーのアクセスフィルター、またはクライアント参照フィルターを無効化します。これにより、ユーザーはすべてのデータを参照することができます。これは、クライアントソースの置換に基づくコンテンツでは機能しません。
DISABLEHEADER	disableheader	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinヘッダーを非表示にします。
HIDEHEADER	hideheader	URL、 SSO	`「DISABLEHEADER」`と同様です。
DISABLEFOOTER	disablefooter	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinフッターを非表示にします。
HIDEFOOTER	hidefooter	URL、 SSO	`「DISABLEFOOTER」`と同様です。
DISABLESIDENAV	disablesidenav	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinサイドナビゲーションを非表示にします。
HIDESIDENAV	hidesidenav	URL、 SSO	`「DISABLESIDENAV」`と同様です。
DISABLELOGOFF	disablelogoff	URL、 SSO	`「TRUE」、または「FALSE」に設定します`。このセッションのYellowfinログオフリンクを非表示にします。
HIDELOGOFF	hidelogoff	URL、 SSO	`「DISABLELOGOFF」`と同様です。
REASONCODE	reasoncode	URL、 SSO	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 SSO を使用して JS API にログインする場合、JS API はこのオプションを使用/無視することができます。
REASONDESCRIPTION	reasondescription	URL、 SSO	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 SSO を使用して JS API にログインする場合、JS API はこのオプションを使用/無視することができます。
DASHBOARDID	dashboardid	URL、 SSO	`「ENTRY = EDITDASHBOARD」、`または「`VIEWDASHBOARD」`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
DASHBOARDUUID	dashboarduuid	URL、 SSO	`「ENTRY = EDITDASHBOARD」、`または「`VIEWDASHBOARD」`とともに使用します。これは、リダイレクト先ダッシュボードタブのUUIDです。
FILTER<ID>	filter<ID>	URL、 SSO	`「ENTRY = VIEWREPORT」`とともに使用します。与えられたレポートのフィルター値を上書きします。「FILTER」はフィルターの内部IDへ付加され、その後にフィルター値の文字列表現が続きます。例： `FILTER2134=MALE` ひとつのレポートに、複数のフィルターを渡すことができます。
SOURCEFILTER_<FILTERCODE>	－	SSO	このセッションの、このユーザーのアクセスフィルター値を上書きします。 `「SOURCEFILTER_」`には、アクセスフィルター設定ページの「フィルタータイプコード」が付加され、その後にアクセスを許可する値が続きます。例： `SOURCEFILTER_COUNTRY=AU` ひとつのセッションで、複数のアクセスフィルター値を渡すことができます。 SSO を使用して JS API にログインする場合、JS API はこのオプションを使用/無視することができます。
CONTENT_<INCLUDE/EXCLUDE>	－	SSO	このセッションで、ユーザーが持つコンテンツアクセス権を上書きします。「`CONTENT_」`には、「`INCLUDE」、`または「`EXCLUDE」が`付加されます。このキーの値は、コンテンツフォルダーコード、またはコンテンツフォルダーUUIDです。 `「INCLUDE」`を選択した場合、これらは、ユーザーがアクセスできる唯一のコンテンツフォルダーになります。 `「EXCLUDE」`を選択した場合、これらの除外されたコンテンツフォルダーは、ユーザーが通常アクセスできるコンテンツから削除されます。コンテンツを含めるか除外するかは、フォルダーレベルに基づきます。指定したフォルダーのすべてのサブフォルダーは含められるか、除外されます。フォルダーのコード、およびUUIDを使用した例： `CONTENT_INCLUDE=TUTORIAL` `CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` `CONTENT_EXCLUDE=TUTORIAL` `CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` 同一のセッションで、「`INCLUDE」`と「`EXCLUDE」`両方の使用は論理的ではありません。 SSO を使用して JS API にログインする場合、JS API はこのオプションを使用/無視することができます。
LANGUAGE=<LANGUAGE_CODE>	－	SSO	ユーザーセッションの言語を、こちらのパラメーターで指定した言語に置き換えます。こちらを使用することで、ブラウザに設定されているデフォルト言語や、翻訳設定がすべて無効になることに注意してください。例えば、「LANGUAGE=JA」を渡すことで、セッションの言語は強制的に日本語になります。
USERNAME	－	SSO	このセッションのユーザーのUsernameフィールドを上書きします（パススルー認証に使用します）。
PASSWORD	－	SSO	このセッションのユーザーのパスワードフィールドを上書きします（パススルー認証に使用）。
FIRSTNAME	－	SSO	UIに表示されるユーザーのFirst nameフィールドを上書きします（共有ログインを使用してヘッダーの情報をカスタマイズする場合に使用されます）。
LASTNAME	－	SSO	UIに表示されるユーザーのSurnameフィールドを上書きします（共有ログインを使用してヘッダーの情報をカスタマイズする場合に使用されます）。
EMAIL	－	SSO	このセッションのユーザーのEmailフィールドを上書きします（共有ログインを使用する場合に使用されます）。
TIMEZONE	－	SSO	このセッションのユーザーのTimezoneフィールドを上書きします。
VIEWID	viewid	URL、 SSO	CREATEREPORT エントリーで使用します。
VIEWUUID	viewuuid	URL、 SSO	CREATEREPORT エントリーで使用します。