- 概要
- レポートURLのパラメーター
- ここを展開... パラメーター 説明 reportUUID reportUUID、reportId、wsNameのいずれかが存在する必要があります。 reportId reportUUID、reportId、wsNameのいずれかが存在する必要があります。 ロードするレポートを識別する数値のreportIdです。代わりにreportUUIDパラメーターを使用することをお勧めします。 wsName reportUUID、reportId、wsNameのいずれかが存在する必要があります。ロードするレポートを識別するWebサービス名です。代わりにreportUUIDパラメーターを使用することをお勧めします。 version 使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。 elementId レポートをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。 showTitle デフォルト： trueSet 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. showInfo デフォルト： trueSet to false to omit the Info button in the title bar. showFilters デフォルト： trueSet to false to omit the Filters button in the title bar. Any user-prompt filters will not be displayed. showSections デフォルト： trueSet to false to omit the Sections button in the title bar (for reports with tabbed or multi-page sections). showSeries デフォルト： trueSet to false to omit the Series button in the title bar (for reports with the series selection option). showPageLinks デフォルト： trueSet to false to omit the previous page/next page button in the title bar (for reports with multiple pages). showExport デフォルト： trueSet to false to omit the Export button in the title bar. 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 デフォルト： chartSet to table to display the report initially as a table.Set to chart to display the report initially as a chart.This is ignored for reports that do not have both table and chart available. fitTableWidth デフォルト： trueSet to true to attempt to scale the report to the width of the enclosing element. canChangeDisplay デフォルト： trueSet to false to omit the buttons that allow the user to switch between chart and table display. username Set this 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. "> ここを展開... パラメーター 説明 reportUUID reportUUID、reportId、wsNameのいずれかが存在する必要があります。 reportId reportUUID、reportId、wsNameのいずれかが存在する必要があります。 ロードするレポートを識別する数値のreportIdです。代わりにreportUUIDパラメーターを使用することをお勧めします。 wsName reportUUID、reportId、wsNameのいずれかが存在する必要があります。ロードするレポートを識別するWebサービス名です。代わりにreportUUIDパラメーターを使用することをお勧めします。 version 使用するAPIバージョンです。サーバーがリクエストされたバージョンをサポートしない場合は、エラーメッセージが表示されます。このパラメーターが含まれない場合、サーバーは現在のAPIバージョンを使用します。 elementId レポートをロードするHTML要素のIDです。このパラメーターが含まれない場合、スクリプトタグが含まれる時点でコンテナー要素が作成されます。 showTitle デフォルト： trueSet 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. showInfo デフォルト： trueSet to false to omit the Info button in the title bar. showFilters デフォルト： trueSet to false to omit the Filters button in the title bar. Any user-prompt filters will not be displayed. showSections デフォルト： trueSet to false to omit the Sections button in the title bar (for reports with tabbed or multi-page sections). showSeries デフォルト： trueSet to false to omit the Series button in the title bar (for reports with the series selection option). showPageLinks デフォルト： trueSet to false to omit the previous page/next page button in the title bar (for reports with multiple pages). showExport デフォルト： trueSet to false to omit the Export button in the title bar. 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 デフォルト： chartSet to table to display the report initially as a table.Set to chart to display the report initially as a chart.This is ignored for reports that do not have both table and chart available. fitTableWidth デフォルト： trueSet to true to attempt to scale the report to the width of the enclosing element. canChangeDisplay デフォルト： trueSet to false to omit the buttons that allow the user to switch between chart and table display. username Set this 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.
- 例
- ダッシュボードURLのパラメーター
- ここを展開... Parameter Description dashUUID Must be present.The unique ID identifying the dashboard to load. version The 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 dashboard. If this is not included, a container element will be created at the point that the script tag is included. showTitle デフォルト： trueSet 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. showInfo デフォルト： trueSet to false to omit the Info button in the title bar. showFilters デフォルト： trueSet to false to omit the Filters button in the title bar. Any analytical filters will not be displayed. showExport デフォルト： trueSet to false to 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 to a numeric value to override the dashboard width.Set this to auto 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 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. "> ここを展開... Parameter Description dashUUID Must be present.The unique ID identifying the dashboard to load. version The 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 dashboard. If this is not included, a container element will be created at the point that the script tag is included. showTitle デフォルト： trueSet 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. showInfo デフォルト： trueSet to false to omit the Info button in the title bar. showFilters デフォルト： trueSet to false to omit the Filters button in the title bar. Any analytical filters will not be displayed. showExport デフォルト： trueSet to false to 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 to a numeric value to override the dashboard width.Set this to auto 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 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.
- 例
概要
Unknown macro: {styleclass}
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のパラメーター
Unknown macro: {styleclass}
レポートは、reportUUIDパラメーターによって識別されます。下位互換性のために、reportIdまたは wsNameパラメーターで識別することもできます。レポートの表示方法を変更する追加のパラメーターをURLに追加することもできます。使用可能なパラメーターは以下のとおりです：
">
例
レポートを含め、レポートの寸法を設定する例を示します：
<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のパラメーター
Unknown macro: {styleclass}
ダッシュボードは、dashUUIDパラメーターによって識別されます。ダッシュボードの表示方法を変更する追加のパラメーターをURLに追加することもできます。使用可能なパラメーターは以下のとおりです：
">
例
ダッシュボードを含め、ダッシュボードの寸法を設定する例を示します：
<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>
Unknown macro: {horizontalrule}
Unknown macro: {styleclass}