Page History

Versions Compared

Old Version 1

changes.mady.by.user Yellowfin Admin

Saved on Apr 21, 2016

compared with

New Version Current

changes.mady.by.user Yellowfin Admin

Saved on Mar 27, 2017

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Migration of unmigrated content due to installation of a new plugin

...

Javascript APIは、新規インストールされたバージョン5.1以降のYellowfinで有効です。古いバージョンからアップグレードした場合は、お使いのインストールでAPIを有効にする手順についてYellowfinのサポートにお問い合わせください。1以降で有効化されています。古いバージョンからアップグレードをした場合は、Javascript APIを有効化する手順について、Yellowfinサポートに問い合わせをしてください。

Javascript APIの使用

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

基本的な使用

HTMLページに、Yellowfinサーバを指すスクリプトタグを含めます。レポートやダッシュボードの識別子を、URL上のパラメーターとして含めなくては行けません。

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

Code Block

	html
	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>

APIのURLは、Yellowfinフロントエンドにアクセスするときに使用されるURLが基になります。たとえば、ユーザーが*APIへのURLは、YellowifnのフロントエンドにアクセスするURLを基にしています。例えば、ユーザー「http://reporting.example.com:8080/*経由でYellowfinにアクセスする場合、Javascript APIのURLは*」を経由してアクセスをしている場合、Javascript API のURLは、「http://reporting.example.com/8080/JsAPI*になります。このURLはエンドユーザーのブラウザーからアクセスされるため、エンドユーザーがページを使用するあらゆる場所（社内ネットワーク、外部、VPN経由など）からアクセスできる必要があります。」となります。このURLは、エンドユーザーのブラウザを使用してアクセスされるため、エンドユーザーがページを使用するあらゆる場所（インターネットネットワーク、外部ネットワーク、VPN経由、など）からアクセスできるようにしなくてはいけません。

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

Code Block

	html
	html

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

versionパラメーターが含まれない場合、サーバーは現在のバージョンを使用します。バージョンパラメーターが含まれていない場合、サーバは現在のバージョンを使用します。

詳細については、より詳細な情報は、バージョン履歴を参照してください。

レポートURLのパラメーター

Styleclass

Class	topLink

ページトップ

レポートは、レポートは、「reportUUIDパラメーターによって識別されます。下位互換性のために、」パラメーターにより識別されます。下位互換性のために、「reportIdまたは」、または「wsNameパラメーターで識別することもできます。レポートの表示方法を変更する追加のパラメーターをURLに追加することもできます。使用可能なパラメーターは以下のとおりです：」パラメーターにより識別されることもあります。URLに追加パラメーターを追加することもでき、これは、レポートの表示方法を変更します。使用可能なパラメーターは、以下の通りです。

Expand

title	ここを展開...こちらを展開する

パラメーター	説明
`reportUUID`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。のいずれかが、存在する必要があります。ロードするダッシュボードを識別する固有のIDです。
`reportId`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。のいずれかが、存在する必要があります。ロードするレポートを識別する数値のreportIdです。代わりにロードするレポートを識別する数値reportIdです。代わりに`reportUUID`パラメーターを使用することをお勧めします。
`wsName`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。のいずれかが、存在する必要があります。ロードするレポートを識別するWebサービス名です。代わりに`reportUUID`パラメーターを使用することをお勧めします。
`version`	使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしていない場合、エラーメッセージが表示されます。こちらのパラメーターが含まれていない場合、サーバーは現在のAPIバージョンを使用します。
`elementId`	レポートをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。レポートをロードするHTML要素のIDです。こちらのパラメーターが含まれていない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。
`showTitle`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。`」`に設定することで、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべてのインタラクティブボタンも省略されます。
`showInfo`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーの情報ボタンが省略されます。`」`に設定することで、タイトルバーの情報ボタンが省略されます。
`showFilters`	デフォルトでは、「`true」に設定されています。`デフォルト：`true` `こちらを「false`に設定すると、タイトルバーのフィルターボタンが省略されます。ユーザープロンプトフィルターは表示されません。`」`に設定することで、タイトルバーのフィルターボタンが省略されます。ユーザープロンプトフィルターは表示されません。
`showSections`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーのセクションボタンが省略されます（タブ形式または複数ページのセクションを使用するレポートの場合）。`」`に設定することで、タイトルバーのセクションボタンが省略されます（タブ形式、または複数ページのセクションを使用するレポートの場合）。
`showSeries`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーのシリーズボタンが省略されます（シリーズ選択オプションを使用するレポートの場合）。`」`に設定することで、タイトルバーのシリーズボタンが省略されます（シリーズ選択オプションを使用するレポートの場合）。
`showPageLinks`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーの前のページ`」`に設定することで、タイトルバーの前のページ/次のページボタンが省略されます（複数ページを使用するレポートの場合）。
`showExport`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーのエクスポートボタンが省略されます。`」`に設定することで、タイトルバーのエクスポートボタンが省略されます。
`height`	レポートの高さを上書きするには、数値を設定します。レポートの高さを上書きするために、こちらに数値を設定します。
`width`	レポートの幅を上書きするには、数値を設定します。レポートの幅を上書きするために、こちらに数値を設定します。
`display`	デフォルト：デフォルトでは、「`chart」に設定されています。` `こちらを「table」`に設定すると、レポートの初期状態がテーブルで表示されます。 `こちらを「chart」`に設定すると、レポートの初期状態がグラフで表示されます。テーブルとグラフの両方が使用可能でないレポートでは無視されます。こちらの設定は、テーブルとグラフの両方が使用可能でないレポートでは無視されます。
`fitTableWidth`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「true`に設定すると、レポートを囲み要素の幅に合わせようとします。`」`に設定することで、レポートを囲み要素の幅に合わせようとします。
`canChangeDisplay`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、ユーザーがグラフ表示とテーブル表示を切り替えできるボタンが省略されます。`」`に設定することで、ユーザーがグラフ表示とテーブル表示を切り替えることができるボタンが省略されます。
`username`	これをこちらを「`password`パラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。ユーザーは制限されているレポートを表示する前に、ログインの詳細を入力する必要がありません。パラメーター」と共に設定することで、レポートをロードするときの特定のユーザーとして認証されます。ユーザーは制限されているレポートを表示する前に、ログイン詳細を入力する必要がありません。
`password`	これをこちらを「`username`パラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。パラメーター」と共に設定することで、レポートをロードするときの特定のユーザーとして認証されます。
`token`Webサービストークンを使用して、レポートをロードするときにユーザーが認証されます。	レポートをロードするときに、Webサービストークンを使用して、ユーザーが認証されます。

例

レポートを含め、レポートの寸法を設定する例を示します：こちらの例には、レポートと、レポートのディメンション（次元）の設定が含まれます。

Code Block

	html
	html

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

レポートの表示に既存の要素を使用し、ユーザー資格情報を渡す例を示します：こちらの例は、レポートの表示に既存の要素を使用し、ユーザー資格情報を渡します。

Code Block

	html
	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 Block

	html
	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>

...

Styleclass

Class	topLink

ページトップ

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

Expand

title	ここを展開...こちらを展開する

パラメーター	説明
`dashUUID`	必ず存在する必要があります。存在する必要があります。ロードするダッシュボードを識別する固有のIDです。
`version`	使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしていない場合、エラーメッセージが表示されます。こちらのパラメーターが含まれていない場合、サーバーは現在のAPIバージョンを使用します。
`elementId`	ダッシュボードをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。ダッシュボードをロードするHTML要素のIDです。こちらのパラメーターが含まれていない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。
`showTitle`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。`」`に設定することで、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべてのインタラクティブボタンも省略されます。
`showInfo`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーの情報ボタンが省略されます。`」`に設定することで、タイトルバーの情報ボタンが省略されます。
`showFilters`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーのフィルターボタンが省略されます。分析フィルターは表示されません。`」`に設定することで、タイトルバーのフィルターボタンが省略されます。分析フィルターは表示されません。
`showExport`	デフォルト：デフォルトでは、「`true」に設定されています。` `こちらを「false`に設定すると、タイトルバーのエクスポートボタンが省略されます。`」`に設定することで、タイトルバーのエクスポートボタンが省略されます。
`height`	ダッシュボードの高さを上書きするために、こちらに数値を設定します。ダッシュボードの高さを上書きするには、数値を設定します。指定しない場合、ダッシュボードの高さはスクロールしなくてもすべてのレポートが表示されるのに十分な大きさに設定されます。こちらを指定しない場合、ダッシュボードの高さは、スクロールをしなくてもすべてのレポートが表示されるのに十分な大きさに設定されます。
`width`	ダッシュボードの幅を上書きするために、こちらに数値を設定します。ダッシュボードの幅を上書きするには、数値を設定します。 `こちらを「auto`に設定すると、上位要素に合わせて拡大します。`」`に設定すると、親要素に合わせて拡大します。指定しない場合、ダッシュボードの幅は、ログインユーザーの設定またはシステム設定に基づいて設定されます。こちらを指定しない場合、ダッシュボードの幅は、ログインユーザーの設定、またはシステム構成設定に基づいて設定されます。
`username`	これをこちらを「`password`パラメーターと共に設定すると、ダッシュボードをロードするときに特定のユーザーとして認証されます。ユーザーは制限されているダッシュボードを表示する前に、ログインの詳細を入力する必要がありません。パラメーター」と共に設定することで、ダッシュボードをロードするときの特定のユーザーとして認証されます。ユーザーは制限されているダッシュボードを表示する前に、ログイン詳細を入力する必要がありません。
`password`	これをこちらを「`username`パラメーターと共に設定すると、ダッシュボードをロードするときに特定のユーザーとして認証されます。パラメーター」と共に設定することで、ダッシュボードをロードするときの特定のユーザーとして認証されます。
`token`Webサービストークンを使用して、ダッシュボードをロードするときにユーザーが認証されます。	ダッシュボードをロードするときに、Webサービストークンを使用して、ユーザーが認証されます。

例

ダッシュボードを含め、ダッシュボードの寸法を設定する例を示します：こちらの霊には、ダッシュボードと、ダッシュボードのディメンション（次元）の設定が含まれます。

Code Block

	html
	html

<script src="http://localhost/JsAPI?dashUUID=3b0b6c9a-9dfb-41f0-b85a-eb17bb8aeeb9&width=auto&height=500" type="text/javascript"></script>

Code Block

	html
	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 Block

	html
	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>

...

horizontalrule

Styleclass

Class	topLink

ページトップ

Content

Space Tools

Versions Compared

Old Version 1

New Version Current

Key

Javascript APIの使用

基本的な使用

レポートURLのパラメーター

例

例