Page Comparison

{anchor:top}
{toc: class=contents}

h2. Overview 概要
{styleclass: Class=topLink}[topページトップ|#top]
{styleclass}
Using the Javascript API, YellowfinAPIを使用すると、Yellowfinのレポートおよびダッシュボードを、Yellowfinとは別のWebサーバーにホストされている可能性のある外部のWebページに埋め込むことができます。エンドユーザーのブラウザーが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. {color:#CC0000}*Note:
HTMLページには複数のレポートを含めることができますが、個々のレポートを表示できるのは各ページに1つのみです。{color:#cc0000}{*}注意：*{color}1ページに複数のダッシュボードを表示することは現在サポートされていません。
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. 


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


h2. 表示
{styleclass: Class=topLink}[topページトップ|#top]

{styleclass}


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

|| ||Description 説明 ||
| !js_info.png! |Displays basic *Report Information* including; Name, Description, Last Modified Date, Category, Sub Category, and Current User|
|基本的な{*}レポート情報*（名前、説明、最終変更日、カテゴリー、サブカテゴリー、現在のユーザーなど）を表示します。 |
| !js_share.png! |Displays the レポートの埋め込みに使用する{*}Javascript{* used to embed the report}を表示します。 |
| |!js_chart.png! |Allows the user to toggle to *Chart* view if Table and Chart display is used|
| テーブル表示とグラフ表示が使用されている場合に、ユーザーが{*}グラフ{*}表示に切り替えられるようにします。 |
| !js_table.png! |Allows the user to toggle to *Table* view if Table and Chart display is used|
| テーブル表示とグラフ表示が使用されている場合に、ユーザーが{*}テーブル{*}表示に切り替えられるようにします。 |
| !js_filter.png! |Opens a panel of *User Prompt Filters* enabled on the report|
| レポートで有効になっている{*}ユーザープロンプトフィルター{*}のパネルを開きます。 |
| !js_series.png! |Opens a *Series Selection* panel if the Visible Series Selection option is enabled|
|「シリーズ選択を表示」オプションが有効な場合に、*シリーズ選択{*}パネルを開きます。 |
| !js_aggregation.png! |Opens a *Unit Selection* panel if the Visible Units Selection option is enabled|
|「単位選択を表示」オプションが有効な場合に、*単位選択{*}パネルを開きます。 |
| !js_next.png! |Opens a *Page Navigation panel* if the report contains multiple pages|
|レポートに複数のページが含まれている場合に、*ページナビゲーションパネル{*}を開きます |
| !js_section.png! |Opens a *Section Navigation* panel if the report contains sections|
|レポートにセクションが含まれている場合に、*セクションナビゲーション{*}パネルを開きます。 |
| !js_gis.png! |Opens the *GIS Map Navigation* panel if the map has Hover Navigation enabled|
|マップで「Hoverナビゲーション」が有効な場合に、*GISマップナビゲーション{*}パネルを開きます。 |
| !js_export.png! |Opens the *Export* panel, allowing the user to export the report to various formats, including:
エクスポート{*}パネルを開きます。このパネルでは、レポートを以下のようなさまざまな書式にエクスポートできます：
* !js_xls.png! Export toCSVにエクスポート
CSV
* !js_doc.png! Export toDOCにエクスポート
DOC
* !js_pdf.png! Export to PDFPDFにエクスポート
* !js_rtf.png! Export to Rich Text Formatリッチテキスト形式にエクスポート
* !js_txt.png! Export toテキストにエクスポート
Text
* !js_xls.png! Export toXLSにエクスポート XLS|


h3. 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. 
{color:#CC0000}*Note:
埋め込みダッシュボードには、ダッシュボード全体のタイトルバーと、それぞれのダッシュボードレポートがあり（埋め込みレポートと同じように表示されます）、Yellowfinフロントエンドを通じて表示したときと同様に配置されます。
{color:#cc0000}{*}注意：*{color}ダッシュボードフィルターおよびKPIダッシュボードがサポートされます。
dashboard
filters and KPI dashboards are supported.

|| || Description ||
| !js_info.png! |Displays basic *Dashboard Information* including; Name, Description, Last Modified Date, and Current User|
|基本的な{*}ダッシュボード情報*（名前、説明、最終変更日、現在のユーザーなど）を表示します。 |
| !js_share.png! |Displays the ダッシュボードの埋め込みに使用する{*}Javascript{*}を表示します。 used to embed the dashboard|
| |!js_filter.png! |Opens a panel of *User Prompt Filters* enabled on the dashboard|
| ダッシュボードで有効になっている{*}ユーザープロンプトフィルター{*}のパネルを開きます。 |
| !js_export.png! |Opens the *Export* panel, allowing the user to export the dashboard to various formats, including:
エクスポート{*}パネルを開きます。このパネルでは、ダッシュボードを以下のようなさまざまな書式にエクスポートできます：
* !js_xls.png! Export to CSVCSVにエクスポート
* !js_doc.png! Export to DOCDOCにエクスポート
* !js_pdf.png! Export toPDFにエクスポート
PDF
* !js_rtf.png! Exportリッチテキスト形式にエクスポート
to Rich Text Format
* !js_txt.png! テキストにエクスポート
* !js_xls.png! Export toXLSにエクスポート XLS|


h2. Example Usage使用例
{styleclass: Class=topLink}[topページトップ|#top]

{styleclass}


h3. Embeddingレポートの埋め込み
a Report
Using the [Share|共有] menu, copy the [Embed|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:


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

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




bq. See the [詳細については、[基本的な使用|Basic Use] for more information.


を参照してください。
h3. Embeddingダッシュボードの埋め込み
a Dashboard
Using the [Distribute
「[配信|共有タブの共有とセキュリティ# Distributing a Public Tab] menu, copy the [Embed|共有タブの共有とセキュリティ#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:

」メニューを使用して、HTMLページ、Wiki、またはブログで使用するためにロードするダッシュボードを指定する[埋め込み|共有タブの共有とセキュリティ#Embed]タグをコピーします。これは以下のような形式をとります：

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




bq. See the [詳細については、[基本的な使用|Basic Use] for more information.

を参照してください。
h2. User Accessユーザーアクセス
{styleclass: Class=topLink}[topページトップ|#top]

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

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


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




bq. 詳細については、[基本的な使用|Basic Use]を参照してください。
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*.

{color:#CC0000#cc0000}{*Note:}注意：*{color} 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).


h2. Limitations
{styleclass: Class=topLink}[topページトップ|#top]

{styleclass}
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

\\
\\
{horizontalrule}
{styleclass: Class=topLink}[topページトップ|#top]

{styleclass}