Page Comparison

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

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


h3. Enabling the Javascript APIAPIの有効化
The
Javascript API is enabled on all new installations of Yellowfin, form version 5.1 onwards. If you have upgraded from an older version, contact [Yellowfin Support|mailto:support@yellowfin.bi] for instructions on enabling the API for your installation.


h3. Using the Javascript API
There are two ways to load a report or dashboard on your HTML page. The simple method involves including a single Javascript URL. The more advanced method allows you to customise the report or dashboard display and load content on demand from other scripts.


h4. Basic Use
Include a script tag in your HTML page that points to your Yellowfin server. The report or dashboard identifier must be included as a parameter on the URL. For example:

APIは、新規インストールされたバージョン5.1以降のYellowfinで有効です。古いバージョンからアップグレードした場合は、お使いのインストールでAPIを有効にする手順について [Yellowfinのサポート|mailto:yellowfin@kmsi.co.jp] にお問い合わせください。


h3. Javascript APIの使用

HTMLページにレポートまたはダッシュボードをロードする方法は2つあります。簡単な方法では、1つのJavascript URLを使用します。高度な方法では、レポートまたはダッシュボードの表示をカスタマイズして、他のスクリプトから必要に応じてコンテンツをロードできます。


h4. 基本的な使用

HTMLページにYellowfinサーバーを示すスクリプトタグを含めます。レポートまたはダッシュボードの識別子をURLのパラメーターとして含める必要があります。例：

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

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

The URL to the API is based on the URL used to access the Yellowfin front-end. For example, if users access Yellowfin through *APIのURLは、Yellowfinフロントエンドにアクセスするときに使用されるURLが基になります。たとえば、ユーザーが *[http://reporting.example.com:8080/]\* then経由でYellowfinにアクセスする場合、Javascript the Javascript API URL will be *APIのURLは *[http://reporting.example.com/8080/JsAPI] \*.になります。このURLはエンドユーザーのブラウザーからアクセスされるため、エンドユーザーがページを使用するあらゆる場所（社内ネットワーク、外部、VPN経由など）からアクセスできる必要があります。
The URL will be accessed by the end user's browser, so it must be accessible from anywhere that end users will user your page (internal network, external, via VPN, etc.).

To ensure the server supports the version of the API your page is written for, you can use the {{version}} parameter. If the server supports multiple versions of the API, this parameter determines which version the server will use. If the server does not support the requested version, an error message will be displayed.  

{
ページの記述に使用したAPIのバージョンをサーバーが確実にサポートするように、versionパラメーターを使用できます。サーバーがAPIの複数バージョンをサポートする場合に、このパラメーターを使用して、サーバーが使用するバージョンが決定されます。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。

{code:html}
<script src="http://localhost/JsAPI?version=2.1&reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63" type="text/javascript"></script>
{code}

If
the
{{version}} parameterパラメーターが含まれない場合、サーバーは現在のバージョンを使用します。
is
not
included, the server will use its current version.

bq. See詳細については、 [Version Historyバージョン履歴|Basic基本的な使用#Version Use#Version History] forを参照してください。
more
information.


h2. Report URL ParametersレポートURLのパラメーター
{styleclass: Class=topLink}[topページトップ|#top]
{styleclass}
A report isレポートは、reportUUIDパラメーターによって識別されます。下位互換性のために、reportIdまたはwsNameパラメーターで識別することもできます。レポートの表示方法を変更する追加のパラメーターをURLに追加することもできます。使用可能なパラメーターは以下のとおりです：
identified
by the {{reportUUID}} parameter. For backwards compatibility, it may alternatively be identified by the {{reportId}} or {{wsName}} parameters. Additional parameters may also be added to the URL, which will alter the way the report is displayed. The available parameters are:

h3. {expand:title=Expand hereここを展開...}
||Parameter パラメーター ||Description 説明 ||
|{{reportUUID}}|Either {{reportUUID}}, {{reportId}} or {{wsName}} must be present.
The unique ID identifying the dashboard to load.|
|{{reportId}}|Either {{reportUUID}},| reportUUID、reportId、wsName のいずれかが存在する必要があります。
ロードするレポートを識別する固有のIDです。 |
| {{reportId}} or {{wsName}} must be present.
The numeric reportId identifying the report to load. It is recommended to use the {{reportUUID}} parameter instead.|
|{{wsName}}|Either {{reportUUID}}, {{reportId}} or {{| reportUUID、reportId、wsName のいずれかが存在する必要があります。
ロードするレポートを識別する数値のreportIdです。代わりにreportUUIDパラメーターを使用することをお勧めします。 |
| {{wsName}} must| bereportUUID、reportId、wsName present.のいずれかが存在する必要があります。
The Web Service name identifying the report to load. It is recommended to use the {{reportUUID}} parameter instead.|
|ロードするレポートを識別するWebサービス名です。代わりにreportUUIDパラメーターを使用することをお勧めします。 |
| {{version}} |The API使用するAPIのバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。 version to use. If the server does not support the requested version, an error message will be displayed. If this is not included, the server will use its current API version.|
||
| {{elementId}} |The id of the html element in which to load the report. If this is not included, a container element will be created at the point that the script tag is included.|
|レポートをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。 |
| {{showTitle}} |Default: デフォルト： {{true{}}
Set to {{false}} to omit the title bar at the top of the report. All interactive buttons included in the title bar will also be omitted.|
|}falseに設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。 |
| {{showInfo}} |Default: デフォルト： {{true{}}
Set to {{false}}
tofalseに設定すると、タイトルバーの情報ボタンが省略されます。 omit the Info button in the title bar.|
| |{{showFilters}} |Default: デフォルト： {{true}}
Set to {{false{}}}
tofalseに設定すると、タイトルバーのフィルターボタンが省略されます。ユーザープロンプトフィルターは表示されません。 omit the Filters button in the title bar. Any user-prompt filters will not be displayed.|
||
| {{showSections}} |Default: デフォルト： {{true{}}
Set to {{false}}
to omit the Sections button in the title bar (for reports with tabbed or multi-page sections).|
|falseに設定すると、タイトルバーのセクションボタンが省略されます（タブ形式または複数ページのセクションを使用するレポートの場合）。 |
| {{showSeries}} |Default: デフォルト： {{true{}}
Set to {{false}}
to omit the Series button in the title bar (for reports with the series selection option).|
|falseに設定すると、タイトルバーのシリーズボタンが省略されます（シリーズ選択オプションを使用するレポートの場合）。 |
| {{showPageLinks}} |Default: デフォルト： {{true}}
Set to {{false{}}}
to omit the previous page/next page button in the title bar (for reports with multiple pages).|
|falseに設定すると、タイトルバーの前のページ/次のページボタンが省略されます（複数ページを使用するレポートの場合）。 |
| {{showExport}} |Default: デフォルト： {{true{}}
Set to {{false}}
to omit the Export button in the title bar.|
|falseに設定すると、タイトルバーのエクスポートボタンが省略されます。 |
| {{height}} |Set thisレポートの高さを上書きするには、数値を設定します。 to a numeric value to override the report height.|
| |{{width}} |Set thisレポートの幅を上書きするには、数値を設定します。 to a numeric value to override the report width.|
| |{{display}} |Default: デフォルト： {{chart}}
Set to {{table}} to display the report initially as a table.
Set to {{chart}}
totableに設定すると、レポートの初期状態がテーブルで表示されます。
displaychartに設定すると、レポートの初期状態がグラフで表示されます。
the report initially as a chart.
This is ignored for reports that do not have both table and chart available.|
|テーブルとグラフの両方が使用可能でないレポートでは無視されます。 |
| {{fitTableWidth}} |Default: デフォルト： {{true{}}
Set to {{true}}
to attempt to scale the report to the width of the enclosing element.|
|trueに設定すると、レポートを囲み要素の幅に合わせようとします。 |
| {{canChangeDisplay}} |Default: デフォルト： {{true{}}
Set to {{false}}
tofalseに設定すると、ユーザーがグラフ表示とテーブル表示を切り替えできるボタンが省略されます。 omit the buttons that allow the user to switch between chart and table display.|
||
| {{username}} |Set thisこれをpasswordパラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。ユーザーは制限されているレポートを表示する前に、ログインの詳細を入力する必要がありません。 along|
with the| {{password}} parameter to authenticate as a particular user when loading the report. This avoids the need for users to enter their login details before viewing restricted reports.|
|{{password}}|Set this along with the {{username}} parameter to authenticate as a particular user when loading the report.|
|{{token}}|Use a web service token to authenticate a user when loading the report. | これをusernameパラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。 |
| {{token}} | Webサービストークンを使用して、レポートをロードするときにユーザーが認証されます。 |
{expand}


h3. Examples例
This example includes a report and sets the dimensions of the report:

レポートを含め、レポートの寸法を設定する例を示します：
{code:html}
<script src="http://localhost/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&height=350" type="text/javascript"></script>
{code}

This example uses an existing element to display the report in, and passes the user credentials:
既存の要素の中にレポートを表示し、ユーザー資格情報を渡す例を示します：
{code:html}
<div id="myReportDiv" style="background: blue; width: 500px; height: 350px">
<script src="http://localhost/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&elementId=myReportDiv&username=admin@yellowfin.com.au&password=test" type="text/javascript"></script>
</div>
{code}

This example uses an existing element to display the report in, overrides the report dimensions, and changes some of the initial display options:
既存の要素の中にレポートを表示し、レポートの寸法を上書きし、初期の表示オプションの一部を変更する例を示します：
{code:html}
<div id="myReportDiv" style="background: blue; width: 500px; height: 350px">
<script src="http://localhost/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&elementId=myReportDiv&width=400&height=300&showFilters=false&display=table" type="text/javascript"></script>
</div>
{code}


h2. Dashboard URLダッシュボードURLのパラメーター
Parameters
{styleclass: Class=topLink}[topページトップ|#top]
{styleclass}
A dashboard is identified by the {{dashUUID}} parameter. Additional parameters may also be added to the URL, which will alter the way the dashboard is displayed. The available parameters are:


ダッシュボードは、dashUUIDパラメーターによって識別されます。ダッシュボードの表示方法を変更する追加のパラメーターをURLに追加することもできます。使用可能なパラメーターは以下のとおりです：


h3. {expand:title=Expand hereここを展開...}
||Parameter パラメーター || Description ||
| {{dashUUID}} |Must be必須です。
present.ロードするダッシュボードを識別する固有のIDです。 The unique ID identifying the dashboard to load.|
| |{{version}} |The API使用するAPのIバージョンです。
version to use. If the server does not support the requested version, an error message will be displayed. If this is not included, the server will use its current API version.|
|サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。 |
| {{elementId}} |The idダッシュボードをロードするHTML要素のIDです。
of the html element in which to load the dashboard. If this is not included, a container element will be created at the point that the script tag is included.|
|このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。 |
| {{showTitle}} |Default: デフォルト： {{true{}}
Set to {{false}}
to omit the title bar at the top of the report. All interactive buttons included in the title bar will also be omitted.|
|falseに設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。 |
| {{showInfo}} |Default: デフォルト： {{true}}
Set to {{false{}}}
tofalseに設定すると、タイトルバーの情報ボタンが省略されます。 omit the Info button in the title bar.|
| |{{showFilters}} |Default: デフォルト： {{true}}
Set to {{false{}}}
tofalseに設定すると、タイトルバーのフィルターボタンが省略されます。分析フィルターは表示されません。 omit the Filters button in the title bar. Any analytical filters will not be displayed.|
||
| {{showExport}} |Default: デフォルト： {{true}}
Set to {{false{}}}
tofalseに設定すると、タイトルバーのエクスポートボタンが省略されます。 omit the export button in the title bar.|
| |{{height}} |Set thisダッシュボードの高さを上書きするには、数値を設定します。
to a numeric value to override the dashboard height.
If not specified, the dashboard height will be set large enough to show all reports without scrolling.|
|指定しない場合、ダッシュボードの高さはスクロールしなくてもすべてのレポートが表示されるのに十分な大きさに設定されます。 |
| {{width}} |Set thisダッシュボードの幅を上書きするには、数値を設定します。
toautoに設定すると、上位要素に合わせて拡大します。
a指定しない場合、ダッシュボードの幅は、ログインユーザーの設定またはシステム設定に基づいて設定されます。 numeric|
value to override the dashboard width.
Set this to {{auto| {{username}} to expand to fill the parent element.
If not specified, the dashboard width will be set based on the logged-in user's preference setting, or the system configuration setting.|
|{{username}}|Set this along with the | これをpasswordパラメーターと共に設定すると、ダッシュボードをロードするときに特定のユーザーとして認証されます。ユーザーは制限されているダッシュボードを表示する前に、ログインの詳細を入力する必要がありません。 |
| {{password}} parameter to authenticate as a particular user when loading the dashboard. This avoids the need for users to enter their login details before viewing restricted dashboards.|
|{{password}}|Set this along with the {{username}} parameter to authenticate as a particular user when loading the dashboard.|
|{{token}}|Use a web service token to authenticate a user when loading the dashboard.| これをusernameパラメーターと共に設定すると、ダッシュボードをロードするときに特定のユーザーとして認証されます。 |
| {{token}} | Webサービストークンを使用して、ダッシュボードをロードするときにユーザーが認証されます。 |
{expand}


h3. Examples
This例
example
includes a dashboard, and sets the dimensions of the dashboard:
ダッシュボードを含め、ダッシュボードの寸法を設定する例を示します：
{code:html}
<script src="http://localhost/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9&width=auto&height=500" type="text/javascript"></script>
{code}

This example uses an existing element to display the report in and passes user credentials:
既存の要素の中にレポートを表示し、ユーザー資格情報を渡す例を示します：
{code:html}
<div id="myDashDiv" style="background: blue; width: 900px; height: 500px">
<script src="http://localhost/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9&elementId=myDashDiv&username=admin@yellowfin.com.au&password=test" type="text/javascript"></script>
</div>
{code}

This example uses an existing element to display the report in, overrides the report dimensions, and changes some of the initial display options:
既存の要素の中にレポートを表示し、レポートの寸法を上書きし、初期の表示オプションの一部を変更する例を示します：
{code:html}
<div id="myDashDiv" style="background: blue; width: 900px; height: 500px">
<script src="http://localhost/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9&elementId=myDashDiv&width=800&height=400&showFilters=false" type="text/javascript"></script>
</div>
{code}

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