Page Comparison

概要

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

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

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

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

表示

レポート

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

ダッシュボード

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

注意：ダッシュボードフィルターおよびKPIダッシュボードがサポートされます。ダッシュボードフィルターと、KPIダッシュボードがサポートされます。

使用例

レポートの埋め込み

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

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

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

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

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

<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に渡すことができます。そのためには、ユーザー名とパスワードを渡すか、ウェブサービスを介して認証し、APIにログイントークンを渡すか、の2つの方法があります。これにより、ユーザーがログイン情報を入力するのではなく、コンテンツのロードに特定のユーザーを使用することができます。

より詳細な情報は、基本的な使用を参照してください。

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

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

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

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

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

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

制限

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

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

...

• • ユーザーが、ページ上のJavascript APIに既にログインしている場合、既存のログインセッションが使用されます。
  • ユーザーが、以前Javascript APIにログインしていた場合、同様のアカウントを使用して、自動的にログインします（以下を参照してください）。
  • マルチキャストライセンスがインストールされ、ゲストロールが有効化されている場合、ユーザーはゲストとしてログインします。

上述のプロセスが完了すると、リクエストされたコンテンツが、直ちにロードされない場合があります。

• • 上述のいずれの条件にも該当しない場合、ユーザーはログインすることができず、Yellowfinのユーザー名とパスワードを、手動で入力するように促されます。
  • 上述のプロセスで、ユーザーがゲストアカウントでログインしたが、リクエストされたレポートやダッシュボードが、ゲストユーザーには利用できない場合、Yellowfinのユーザー名とパスワードを、手動で入力するように促されます。
  • 上述のプロセスで、ユーザーはゲストアカウントではないユーザーとして認証されたが、アカウントにリクエストされたコンテンツへのアクセス権限がない場合、エラーメッセージが表示されます。

ユーザーが、Javascript APIにログインするために、Yellowfinのユーザー名とパスワードを入力した場合、ブラウザにcookieが保存され、ログイン時に使用したユーザー情報が記憶されます。次回ユーザーが、Javascript APIを使用して埋め込まれたレポートやダッシュボードを含むページにアクセスした場合、同様のユーザー情報を使用して、自動的にログインします。これによりユーザーは、レポートやダッシュボードをリクエストする都度、ユーザー情報を入力する必要がなくなります。デフオルトでは、cookieはユーザーの最終ログインから7日間有効です。こちらの設定は、「管理コンソール」＞「システム構成」＞「電子メール」で、「外部API cookieタイムアウト」から変更することができます。こちらを「0」に設定すると、cookieは無効化されます。

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

制限

現時点でのJavascript APIの制限は、以下の通りです。

• • クライアント組織のレポートは、サポートされていません。
  • 複数のレポートを、ひとつのHTMLページに追加することができますが、個々のレポートは、ひとつのページにひとつのみ含めることができます。
  • ひとつのHTMLページでサポートされるダッシュボードは、ひとつのみです。
  • カレンダーを使用した日付フィルターは、使用することができません。
  • ドリルエニウェアを使用することはできません。
  • 保存されたフィルターのセットを使用するはできません。
  • グラフアニメーションを使用することはできません。
  • マルチグラフキャンバスを使用することはできません。