Page History

...

...

概要

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.

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.

Javascript APIを使用すると、Yellowfinのレポートおよびダッシュボードを、Yellowfinとは別のWebサーバーにホストされている可能性のある外部のWebページに埋め込むことができます。エンドユーザーのブラウザーがYellowfinサーバーにアクセスできることが唯一の要件です。

HTMLページには複数のレポートを含めることができますが、個々のレポートを表示できるのは各ページに1つのみです。

注意： 1ページに複数のダッシュボードを表示することは現在サポートされていません。

ドリルスルー、ドリルダウン、ユーザープロンプトフィルター、シリーズ選択、PDFへのエクスポートといった対話型要素を使用できます。

表示

...

Styleclass
Class topLink
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:

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.

...

ダッシュボード

埋め込みダッシュボードには、ダッシュボード全体のタイトルバーと、それぞれのダッシュボードレポートがあり（埋め込みレポートと同じように表示されます）、Yellowfinフロントエンドを通じて表示したときと同様に配置されます。
注意： ダッシュボードフィルターおよびKPIダッシュボードがサポートされます。

使用例

Embedding a Report

レポートの埋め込み

「 共有 」メニューを使用して、HTMLページ、Wiki、またはブログで使用するためにロードするレポートを指定する 埋め込みタグ をコピーします。これは以下のような形式をとります：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:

<script src="http://reporting.example.com/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&height=500" type="text/javascript"></script>

See the Basic Use for more information.

Embedding a Dashboard

詳細については、 基本的な使用 を参照してください。

ダッシュボードの埋め込み

「 共有 」メニューを使用して、HTMLページ、Wiki、またはブログで使用するためにロードするダッシュボードを指定する 埋め込みタグ をコピーします。これは以下のような形式をとります：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:

<script type="text/javascript" src="http://reporting.example.com/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9"></script>

See the Basic Use for more information.

...

詳細については、 基本的な使用 を参照してください。

ユーザーアクセス

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.

Authentication details can be passed to the API when the dashboard or report is loaded, either by passing a username and password, or authenticating via web services and passing the login token to the API. This allows you to use a specific user to load content rather than requiring the user to enter their details.

See the Basic Use for more information.

When a report or dashboard is requested through the Javascript API, the following process is used to authenticate the user:

• if user authentication details are passed to the API when a dashboard or report is loaded, they will be used to log the user in
• if the user is already logged in to the Javascript API on the page, the existing login session is used
• if the user has previously logged in to the Javascript API, they are automatically logged in with the same account (see below)
• if a multicast licence is installed, and a Guest role is available, the user will be logged in as a Guest

When the above process is complete, there are several cases that will not result in the user immediately loading the requested content:

• if none of the conditions above are met, the user cannot be logged in, and they will be prompted to enter their Yellowfin username and password manually.
• if the process above results in the user logging in with the Guest account, but the requested report or dashboard is not available to guest users, they will be prompted to enter their Yellowfin username and password.
• if the process above results in the user being authenticated with a non-guest account, but the account does not have access to the requested content, an appropriate error message will be displayed.

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).

...

ユーザーが認証を受けるのは、Javascript APIを介してレポートまたはダッシュボードにアクセスするときです。ユーザーがまだログインしていない場合は、ゲストユーザーとしてコンテンツを表示できる可能性があります。レポートまたはダッシュボードをゲストユーザーとして実行できるかどうか、または承認を受けていないユーザーはログインすることが要求されるかどうかを判断するために数多くの要因が用いられます。

認証の詳細は、ダッシュボードまたはレポートがロードされるときにAPIに渡されます。その方法には、ユーザー名およびパスワードを渡す方法、またはWebサービス経由で認証してログイントークンをAPIに渡す方法があります。これにより、コンテンツをロードするために特定のユーザーを使用することができ、ユーザーに詳細を入力させる必要はありません。

詳細については、 基本的な使用 を参照してください。

Javascript APIを介してレポートまたはダッシュボードがリクエストされると、以下のプロセスでユーザーが認証されます：

• ダッシュボードまたはレポートがロードされるときにユーザー認証の詳細がAPIに渡されると、その情報がユーザーのログインに使用されます。
• ページのJavascript APIでユーザーがすでにログインしている場合、既存のログインセッションが使用されます。
• Javascript APIでユーザーが以前ログインしたことがある場合、同じアカウントを使用して自動的にログインします（後述）。
• マルチキャストライセンスがインストールされていて、ゲストロールが使用可能な場合、ユーザーはゲストとしてログインします。

上記のプロセスが完了したときに、リクエストされたコンテンツがただちにロードされない場合があります：

• 上記の条件のいずれも満たさない場合、ユーザーはログインできず、Yellowfinユーザー名およびパスワードを手動で入力するように要求されます。
• 上記のプロセスの結果、ユーザーがゲストアカウントでログインしたが、要求されたレポートまたはダッシュボードをゲストユーザーが使用できない場合、ユーザーはYellowfinユーザー名およびパスワードを入力するように要求されます。
• 上記のプロセスの結果、ユーザーがゲスト以外のアカウントで認証を受けたが、リクエストされたコンテンツにそのアカウントがアクセスできない場合、適切なエラーメッセージが表示されます。

ユーザーがYellowfinユーザー名およびパスワードを入力してJavascript APIにログインすると、cookieがブラウザーに保存されて、ログインするために使用されたユーザーが記録されます。Javascript APIを使用して埋め込まれたレポートまたはダッシュボードが含まれるページに次回アクセスすると、同じユーザーを使用して再び自動的にログインします。これにより、ユーザーはレポートまたはダッシュボードをリクエストするたびに、自分の詳細を入力する必要がありません。デフォルトでは、cookieはユーザーが最後にログインしてから7日間有効です。この期間は、管理>システム構成>電子メールで外部API cookieタイムアウトの値を設定することで変更できます。cookieを無効にするには、値を0に設定します。

注意： ブラウザーに保存されるcookieの値は暗号化されます。cookieはYellowfinを再起動すると無効になります（Yellowfinが再起動すると、すべてのユーザーは再度ログインする必要があります）。

制限

The current limitations of the Javascript API include:

Javascript APIの現在の制限は以下のとおりです：

• クライアント組織レベルのレポートはサポートされません。
• 複数のレポートを1つのHTMLページに追加することはできますが、それぞれのレポートは1ページに1つしか含めることができません。
• 1つのHTMLページでサポートされるダッシュボードは1つのみです。
• 日付フィルターでカレンダーセレクターは利用できません。
• ドリルエニウェアは利用できません。
• フィルターセットは利用できません。
• グラフアニメーションは利用できません。
• 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