基本的な使用

概要

Javascript APIの有効化

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

Javascript APIの使用

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

基本的な使用

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

<!-- 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が基になります。たとえば、ユーザーが*http://reporting.example.com:8080/*経由でYellowfinにアクセスする場合、Javascript APIのURLは*http://reporting.example.com/8080/JsAPI*になります。このURLはエンドユーザーのブラウザーからアクセスされるため、エンドユーザーがページを使用するあらゆる場所（社内ネットワーク、外部、VPN経由など）からアクセスできる必要があります。

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

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

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

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

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

ページトップ

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

パラメーター	説明
`reportUUID`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。ロードするダッシュボードを識別する固有のIDです。
`reportId`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。ロードするレポートを識別する数値のreportIdです。代わりに`reportUUID`パラメーターを使用することをお勧めします。
`wsName`	`reportUUID`、`reportId`、`wsName`のいずれかが存在する必要があります。ロードするレポートを識別するWebサービス名です。代わりに`reportUUID`パラメーターを使用することをお勧めします。
`version`	使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。
`elementId`	レポートをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。
`showTitle`	デフォルト：`true` `false`に設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。
`showInfo`	デフォルト：`true` `false`に設定すると、タイトルバーの情報ボタンが省略されます。
`showFilters`	デフォルト：`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サービストークンを使用して、レポートをロードするときにユーザーが認証されます。

例

レポートを含め、レポートの寸法を設定する例を示します：

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

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

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

レポートの表示に既存の要素を使用し、レポートの寸法を上書きし、初期の表示オプションの一部を変更する例を示します：

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

ダッシュボードURLのパラメーター

ページトップ

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

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

例

ダッシュボードを含め、ダッシュボードの寸法を設定する例を示します：

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

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

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

レポートの表示に既存の要素を使用し、レポートの寸法を上書きし、初期の表示オプションの一部を変更する例を示します：

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

ページトップ

Content

Space Tools

概要

Javascript APIの有効化

Javascript APIの使用

基本的な使用

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

例

ダッシュボードURLのパラメーター

例