Oracle Analytics Desktop SDKのリファレンス

Oracle Analytics Desktop SDK

SDKに用意されている開発環境では、カスタムのビジュアライゼーション・プラグインを作成および開発し、Oracle Analytics Desktopインストールにデプロイできます。

トピック:

スクリプト

インストールには、開発環境の作成およびスケルトン・ビジュアライゼーション・プラグインの作成に使用するスクリプトが含まれます。

スクリプトは、ディレクトリ<your_installation_directory>\Oracle Analytics Desktop\tools\binにあります。

例: C:\Program Files\Oracle Analytics Desktop\tools\bin

次のスクリプト名および説明に注意してください:

bicreateenv - このスクリプトを実行して、プラグインを開発する開発環境を作成します。
bicreateplugin - このスクリプトを実行して、カスタム・プラグインの開発をすばやく開始するためのスケルトン・ビジュアライゼーションを作成します。
bideleteplugin - このスクリプトを実行して、開発環境からプラグインを削除します。
bivalidate - gradlew validateコマンドが含まれるこのスクリプトを実行して、bivalidateスクリプトを呼び出します。bivalidateスクリプトでは、JSON構成ファイルの形式が正しいか、適切なビジュアライゼーション構成が含まれているかが検証されます。

その他のリソース

スクリプト以外のリソースを使用してカスタム・ビジュアライゼーション・プラグインを開発できます。

使用可能なリソースを次に示します。

circlePackサンプル - circlePackサンプルは開発環境に含まれています。このサンプルはすぐにデプロイおよび使用できます。ただし、このサンプルは、ビジュアライゼーション・プラグインの開発方法を学習するために提供されているチュートリアルで使用するよう設計されています。サンプルをコピーして、作成するビジュアライゼーション・プラグインのテンプレートとして使用することもできます。

circlePackサンプルの場所は、<your_development_directory>\src\sampleviz\sample-circlepack です

例: C:\OracleDVDev\src\sampleviz\sample-circlepack
その他のビジュアライゼーション・プラグイン・サンプル - Oracle Analyticsライブラリからプラグイン例をダウンロードできます。
チュートリアル - チュートリアルには、堅牢なビジュアライゼーション・プラグインの作成方法を理解するための情報および手順が含まれています。このチュートリアルでは、プラグイン開発環境に含まれるcirclePackサンプルを変更するための段階的なステップが示されます。

チュートリアル
JS APIドキュメント - このドキュメントには、ビジュアライゼーション・プラグインの開発に必要なJavaScriptリファレンス情報が含まれています。Oracle Analytics Desktop SDK JavaScriptのリファレンスを参照してください。

ビジュアライゼーション・プラグイン開発環境の作成

ビジュアライゼーション・プラグインを作成する前に、PATH環境変数を設定し、開発環境を作成しておく必要があります。

コマンド・プロンプトを使用して、空の開発ディレクトリを作成します。たとえば、C:\OracleAnalyticsDevとなります。

PATH環境変数を設定します。次に例を示します。

set ANALYTICSDESKTOP_SDK_HOME="C:\Program Files\Oracle Analytics Desktop"
set PLUGIN_DEV_DIR=C:\OracleAnalyticsDev
REM add tools\bin to path: 
set PATH=%ANALYTICSDESKTOP_SDK_HOME%\tools\bin;%PATH%

インストールに含まれるbicreateenvスクリプトを実行し、空のディレクトリに開発環境を作成します。次に例を示します。
```
cd C:\OracleAnalyticsDev
bicreateenv
```
このスクリプトの実行について使用可能なオプションの詳細は、スクリプトのコマンドライン・ヘルプを参照してください。次に例を示します。

C:\OracleAnalyticsDev>bicreateenv -help

build.gradleおよびgradlewを含む完全な開発環境が、指定したディレクトリに作成されます。
オプション: Webプロキシの裏で作業している場合は、gradle.propertiesを設定してプロキシを指定する必要があります。gradle.propertiesは開発環境にあります。例: C:\OracleAnalyticsDev\gradle.properties。
次の例を使用して、gradle.propertiesを設定します。
```
systemProp.https.proxyHost=www-proxy.somecompany.com
systemProp.https.proxyPort=80
systemProp.https.nonProxyHosts=*.somecompany.com|*.companyaltname.com
```

スケルトン・ビジュアライゼーション・プラグインの作成

開発環境においてスケルトン・ビジュアライゼーション・プラグインを作成した後、このプラグインを開発して堅牢なビジュアライゼーション・プラグインにし、Oracle Analytics Desktop環境にデプロイします。

スケルトン・ビジュアライゼーションを作成するには、インストールに含まれるbicreatepluginスクリプトを実行します。次の構文を使用します。
bicreateplugin viz -<subType> -<id> -<name>
- <subType>は、作成するビジュアライゼーションのタイプです。選択肢は次のとおりです。
  - basic - Oracle Analytics Desktopのデータを使用しない、またはデータ・モデル・マッピングを使用しないビジュアライゼーションを作成するには、このオプションを使用します。これは、Oracle Analytics Desktopで提供されているイメージおよびテキストのビジュアライゼーション・タイプと似ています。たとえば、このビジュアライゼーション・タイプを使用して、プラグインに記述された、または構成から取得されたイメージまたはテキストを表示できます。このタイプのビジュアライゼーションを使用して、書式設定を改善できます。
  - dataviz -このタイプでは、Oracle Analytics Desktopに登録されたデータ・ソースのデータが、グラフ、表または他の形式で画面上に表示されます。また、同じキャンバスの他のビジュアライゼーションからのマーキング・イベントに応答し、相互作用イベントを公開して同じキャンバスの他のビジュアライゼーションに影響を与えることもあります。
  - embeddableDataviz - このタイプでは、Oracle Analytics Desktopに登録されたデータ・ソースのデータが、トレリスのビジュアライゼーションのセルに表示されます。また、同じキャンバスの他のビジュアライゼーションからのマーキング・イベントに応答し、相互作用イベントを公開して同じキャンバスの他のビジュアライゼーションに影響を与えることもあります。
- <id>は、開発環境でビジュアライゼーション・ディレクトリおよびコンポーネントに設定するドメインおよび名前です。例: com-company.basicviz。
- <name>は、プロジェクトでテスト、デプロイおよび使用するビジュアライゼーション・プラグインの名前です。
たとえば、基本的なビジュアライゼーションを作成するには、開発ディレクトリの名前をcom-company-basicvizに、ビジュアライゼーション・プラグインの名前をhelloVizにして、次のコマンドを実行します。
C:\OracleDevDir>bicreateplugin viz –subType basic –id com.company.basicviz —name helloViz
オプション: このスクリプトの実行で使用可能なオプションについては、スクリプトのコマンドライン・ヘルプを開いてください。例: C:\OracleDVDev> bicreateplugin -help

bicreateplugin -vizコマンドの初回実行時には、次の場所にcustomvizディレクトリが作成されます。<your_development_environment>\src\customviz

作成したカスタムのビジュアライゼーション開発ディレクトリはすべてこのディレクトリに追加されます。

例: C:\OracleDVDev\src\customviz\com-company-basicviz

スケルトン・スキンまたは未分類のプラグインの作成

bicreateplugin -unclassifiedコマンドでは、plugin.xml、ローカリゼーション・バンドルにより空のプラグインが作成されます。bicreateplugin -skinコマンドでは、スケルトン・スキン・プラグインが作成されます。

スケルトン・プラグインを作成するには、インストールに含まれるcreatepluginスクリプトを実行します。次のいずれかの構文を使用します:
bicreateplugin -skin -<id>

bicreateplugin -unclassified -<id>
- <id>は、ビジュアライゼーションに設定するドメインおよび名前です。例: com-company.newskin
たとえばスキン・プラグインを作成するには、次のコマンドを入力して実行します:
C:\OracleDevDir>bicreateplugin skin –id com.company.newskin

ビジュアライゼーション・プラグインの開発

スケルトン・ビジュアライゼーション・プラグインの作成後、Oracleで提供されているリソースを使用してプラグインを開発できます。

datavizおよびembeddableDatavizタイプのディレクトリに格納されているdatamodelhandler.jsファイルには、物理対論理データ・マッピング形式が含まれます。このファイルは、Oracle Analytics Desktopがユーザー操作をどのようにレンダリングしサーバーに渡すかも決定します。

チュートリアルを使用し、データ・マッピングの実装などの開発タスクの実行方法を学習します。

チュートリアル
.JS APIドキュメントを使用して、依存性の追加方法を学習します。Oracle Analytics Desktop SDK JavaScriptのリファレンスを参照してください。

SDKモードでの実行およびプラグインのテスト

ビジュアライゼーション・プラグインの開発時、またはビジュアライゼーション・プラグインのテスト時に、Oracle Analytics DesktopをブラウザからSDKモードで実行できます。

gradlew runコマンドを実行します。例: C:\OracleDevDir>gradlew run
コマンドの実行後、次の結果に注意してください:
- Oracle Analytics Desktopが、デフォルトのブラウザでSDKモードで開きます。ブラウザのJavaScriptデバッガを使用して、アプリケーションをテストおよびデバッグします。
- 作成したビジュアライゼーションは、Oracle Analytics Desktopの「ビジュアライゼーション」ペインで使用可能になります。
- オペレーティング・システムのツールバーにシステム・トレイが表示されます。次の3つのリンクが含まれます: 「ブラウザを起動する」は、Oracle Analytics Desktopを表示するためにデフォルトのブラウザを起動または再起動する際に使用します。「URLをクリップボードにコピー」は、URLをコピーして別のブラウザに貼り付ける際に使用します。「シャットダウン」は、開発ブラウザをシャットダウンする際に使用します。
ビジュアライゼーションをプロジェクトのキャンバスにドラッグ・アンド・ドロップしてデータ要素を追加することで、ビジュアライゼーションをテストします。
必要に応じて、ビジュアライゼーション・プラグインの開発を続行します。ブラウザにおいてSDKモードで操作している場合、.JS定義を更新し、ブラウザをリフレッシュして変更を確認できます。

ビジュアライゼーション・プラグインの検証

ビジュアライゼーション・プラグインをテストした後、パッケージ化およびデプロイするには検証が必要です。

gradlew validateコマンドを実行します。次に例を示します。
```
cd C:\OracleDVDev
.\gradlew validate
```
このステップでは、JSON構成ファイルの形式が正しいか、適切なビジュアライゼーション構成が含まれているかが検証されます。検証によってエラーが検出された場合は、エラー・メッセージが表示されます。
JavaScriptソース・ファイルのエラーを確認するには、ブラウザの開発ツールを使用します。

ビジュアライゼーション・プラグインの構築、パッケージ化およびデプロイ

ビジュアライゼーション・プラグインの検証後、このプラグインを構築およびパッケージ化してから、結果の配布ファイルをインストール・ディレクトリにコピーする必要があります。

構築およびパッケージ化のプロセスは、開発ディレクトリに含まれるすべてのビジュアライゼーションに対して実行され、各プラグインはその個別のzipファイルに格納されます。特定のビジュアライゼーションを構築およびパッケージ化する方法はありません。構築およびパッケージ化のプロセスからビジュアライゼーションを除外する必要がある場合は、除外するビジュアライゼーションを開発ディレクトリから取り出すか、構築の実行前に開発ディレクトリから削除する必要があります。「開発環境からのプラグインの削除」を参照してください。

gradlew buildコマンドを実行します。次に例を示します。
```
cd C:\OracleDVDev
.\gradlew clean build
```
構築ディレクトリが開発環境に追加されます。例: C:\OracleDVDev\build\distributions。このディレクトリには、各ビジュアライゼーションのzipファイルが含まれています。zipファイルの名前は、スケルトンを作成したときにビジュアライゼーションに割り当てた名前です。たとえば、basicviz.zipです。
zipファイルをインストール・ディレクトリにコピーします。たとえば、%localappdata%\OracleAnalyticsDesktop\pluginsです。

開発環境からのプラグインの削除

bideletepluginスクリプトを使用して、開発環境から不要なプラグインを削除できます。

構築およびパッケージ化のプロセスには、開発ディレクトリに含まれるすべてのビジュアライゼーションが含まれます。特定のビジュアライゼーションを構築およびパッケージ化する方法はありません。不要なビジュアライゼーションをビルドから除外するには、構築およびパッケージ化のプロセスを実行する前にビジュアライゼーションを削除できます。

ビジュアライゼーション・プラグインを削除する場合、次の構文を使用してbideletepluginコマンドを実行します。
```
cd C:\<your_development_directory>
bideleteplugin viz -id <name_of_your_domain>.<name_of_viz_plugin>
```
未分類のプラグインを削除する場合、次の構文を使用してbideletepluginコマンドを実行します。
```
cd C:\<your_development_directory>
bideleteplugin unclassified -id <name_of_your_domain>.<name_of_unclassified_plugin>
```
スキン・プラグインを削除する場合、次の構文を使用してbideletepluginコマンドを実行します。
```
cd C:\<your_development_directory>
bideleteplugin skin -id <name_of_your_domain>.<name_of_skin_plugin>
```