基本的な使用

概要

Javascript APIの有効化

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

Javascript APIの使用

HTMLページで、レポートやダッシュボードをロードする方法は二つあります。簡単な方法では、ひとつの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は、YellowifnのフロントエンドにアクセスするURLを基にしています。例えば、ユーザー「http://reporting.example.com:8080/」を経由してアクセスをしている場合、Javascript API のURLは、「http://reporting.example.com/8080/JsAPI」となります。このURLは、エンドユーザーのブラウザを使用してアクセスされるため、エンドユーザーがページを使用するあらゆる場所（インターネットネットワーク、外部ネットワーク、VPN経由、など）からアクセスできるようにしなくてはいけません。

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

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

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

より詳細な情報は、/wiki/spaces/yfcurrent/pages/1902054を参照してください。

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