Javascript API

概要

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

HTMLページには複数のレポートを含めることができますが、個々のレポートを表示できるのは各ページに1つのみです。注意：1ページに複数のダッシュボードを表示することは現在サポートされていません。

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

表示

レポート

埋め込みレポートには、タイトルバーとレポートそのものが含まれます。タイトルバーにはレポートの名前、およびレポートで使用される対話型要素を制御するためのボタンがあります。対話型の機能は以下のとおりです：

ダッシュボード

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

使用例

レポートの埋め込み

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

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

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

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

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

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

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

ユーザーアクセス

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

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

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

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

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

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

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

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.

注意： 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

The current limitations of the Javascript API include:

• 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