WindowsでのOracle Analytics拡張機能開発環境の設定

このトピックでは、Oracle Analytics拡張機能開発環境を設定および使用するために実行する必要があるタスクについて説明します。

WindowsへのOracle Analytics Desktopのインストール

Oracle Analytics Desktopでは、開発環境と拡張機能スケルトン、およびローカル・テスト環境を作成するのに必要なスクリプトを提供しています。

Oracle Analytics Desktopの最新バージョンをインストールするか、最新バージョンにアップグレードします。
  1. Oracle Analytics Desktopのインストールのダウンロードに移動し、「ダウンロード」をクリックして、Oracle Cloudアカウントにログインします。
  2. Oracle Software Delivery Cloudのページで、プラットフォームをクリックし、Microsoft Windows x64を選択します。
  3. ライセンス契約を確認して同意します。Oracle Analytics DesktopのZIPファイルをクリックしてダウンロードします。
  4. コンピュータ上のダウンロードの場所に移動してZIPファイルをダブルクリックし、Oracle_Analytics_Desktop_<version>_Win.exeをダブルクリックしてインストールを実行します。
  5. C:\Program Files\Oracle Analytics Desktopに移動してインストールを確認します。

WindowsへのJava JDKのインストール

使用しているWindowsおよびプロセッサと互換性のあるJava JDKバージョンを使用します。この章のすべての例は、Java JDK 8u201で開発されました。

  1. コマンド・プロンプトを開き、次のコマンドを入力してJava JDKがインストールされているかどうかを確認します:
    java -version
  2. 1つ以上のJava JDKがインストールされている場合は、macOSおよびプロセッサと互換性があることを確認します。
  3. Java JDKをインストールする必要がある場合は、Java SE 8アーカイブのダウンロードに進みます。
  4. 使用しているWindowsおよびプロセッサと互換性のあるJDKインストール・ファイルを見つけてダウンロードします。
  5. インストールが完了したら、コマンド・プロンプトを開き、次のコマンドを入力して、選択したJava JDKバージョンが正常にインストールされたかどうかを確認します:
    java -version

Windowsでのユーザー変数の設定と開発ディレクトリの作成

Oracle Analytics Desktopスクリプトで必要なユーザー変数を作成または変更します。次に、開発環境を含める開発ディレクトリを作成します。

この手順では、次の必要なユーザー変数を作成または更新します:
  • PLUGIN_DEV_DIR - 開発ディレクトリの場所(例: C:\PLUGIN_DEV_DIR)。
  • DVDESKTOP_SDK_HOME - Oracle Analytics Desktopインストールの場所(例: C:\Program Files\Oracle Analytics Desktop\dvdesktop)。
  • JAVA_HOME - JDK 1.8インストールの場所(例: C:\Program Files\Java\jdk-1.8)。
  • Path - Oracle Analytics Desktopのbinディレクトリの場所(例: C:\Program Files\Oracle Analytics Desktop\tools\bin)。この変数はWindowsにすでに存在します。これを更新する場合は、変数の既存のパスを削除または変更しないようにしてください。
  1. ファイル・エクスプローラを開き、「PC」を右クリックして、「プロパティ」をクリックします。「システムの詳細設定」をクリックし、「詳細設定」タブで「環境変数」をクリックします。
  2. 「環境変数」で、「<コンピュータ名>のユーザー環境変数」の下の「新規」をクリックします。「新しいユーザー変数」ダイアログで、「変数名」に移動して変数の名前を入力し、ディレクトリの場所を参照または入力します。必要な変数の名前と値は、このタスクの最初にあるリストを参照してください。「OK」をクリックします。
  3. 「環境変数」で、「<コンピュータ名>のユーザー環境変数」の下の「Path」変数をクリックし、「編集」をクリックします。Oracle Analytics Desktopのbinディレクトリの場所を参照または入力します。「OK」をクリックします。
  4. 「環境変数」ダイアログで、「OK」をクリックします。
  5. 開発ディレクトリを作成するには、コマンド・プロンプトを開き、次のコマンドを実行します:
    cd C:\
    mkdir $PLUGIN_DEV_DIR

Windowsでの拡張機能開発環境の作成

ユーザー変数を構成したら、bicreateenvスクリプトを実行して、拡張機能の作成に必要なリソースを含む開発環境を作成します。

このスクリプトの実行について使用可能なオプションの詳細は、次のようにスクリプトのコマンドライン・ヘルプを参照してください:
cd $PLUGIN_DEV_DIR
bicreateenv -help
  1. コマンド・プロンプトを開き、次のようにbicreateenvスクリプトを実行して環境を作成します:
    cd $PLUGIN_DEV_DIR
    bicreateenv
  2. ファイル・エクスプローラで、作成したディレクトリに移動し、その内容が次のようになっていることを確認します:

  3. オプション: Webプロキシの背後で作業している場合、gradle.propertiesを開き、プロキシを指し示すシステム・プロパティを追加します。
    次の例を使用して、gradle.propertiesを設定します。
    systemProp.https.proxyHost=www-proxy.somecompany.com
    systemProp.https.proxyPort=80
    systemProp.https.nonProxyHosts=*.somecompany.com|*.companyaltname.com

Windowsでのスケルトン拡張機能の作成

bicreatepluginスクリプトを使用して、Oracle Analytics拡張機能スケルトンを作成します。

bicreatepluginスクリプトでは次の構文が使用されます:
bicreateplugin viz -subType <subtypename> -id <com.company.yourVizName>

説明:

subTypeは、作成するビジュアライゼーション拡張機能のタイプです。有効な値は、basicdatavizおよびembeddableDatavizです。ワークブック拡張機能を作成する場合はsubTypeを含めないでください。

idは、拡張機能の名前です。指定する名前は次の形式である必要があります: <com.company.yourVizName>

bicreatepluginスクリプトの実行時に作成できる拡張機能の詳細は、「Oracle Analytics拡張機能のタイプ」を参照してください。このトピックで使用されている例は、datavizおよびワークブック・スケルトン拡張機能を作成する方法を示しています。
スクリプトを実行すると、PLUGIN_DEV_DIRECTORY環境にフォルダが作成されます。このフォルダには、拡張機能の開発に使用するファイルが含まれます。<extension_name>.jsのrenderメソッドは、コードの記述を開始できるエントリ・ポイントです。
  1. コマンド・プロンプトで、bicreatepluginスクリプトを開発ディレクトリで実行します。
    cd $PLUGIN_DEV_DIR
    bicreateplugin viz -subType <subtypename> -id <com.company.yourVizName>
    次の例は、datavizスケルトン拡張機能を作成する方法を示しています:
    bicreateplugin viz -subType dataviz -id com.companyabc.helloviz 
    次の例は、ワークブック・スケルトン拡張機能を作成する方法を示しています:
    bicreateplugin workbook -id com.companyabc.helloworkbook
  2. ファイル・エクスプローラで、開発環境および拡張機能ディレクトリ(例: C:\PLUGIN_DEV_DIR\src\customviz)に移動し、新しいフォルダが作成され、その名前が指定した拡張機能名と一致していることを確認します。
    次の例は、dataviz拡張機能のディレクトリを示しています:

    次の例は、ワークブック拡張機能のディレクトリを示しています:

Windowsでのビジュアライゼーションおよびワークブック拡張機能のテスト

コマンド・プロンプトを使用してSDKモードでOracle Analytics Desktopを実行し、Oracle Analyticsビジュアライゼーションおよびワークブック拡張機能をテストします。SDKモードでOracle Analytics Desktopを実行すると、ブラウザにOracle Analytics Desktopが開かれます。

ワークブックの作成およびワークブックへのビジュアライゼーションの追加の詳細は、Oracle Analytics拡張機能開発リソースOracle Analytics製品ドキュメントの項を参照してください。
ワークブック拡張機能をOracle Analytics Desktopにアップロードしてテストする前に、それを構築してパッケージ化する必要があります。「拡張機能の構築とパッケージ化」を参照してください。
  1. コマンド・プロンプトで、PLUG_IN_DEV_DIRに変更し、次のコマンドを実行してブラウザでOracle Analytics Desktopを起動します:
    cd $PLUGIN_DEV_DIR
    ./gradlew run
  2. コマンドの実行後にOracle Analytics Desktopが開いてから閉じた場合、Windowsタスク・バーを使用して、手動でブラウザにOracle Analytics Desktopを開くことができます。
    1. Windowsタスク・バーに移動して、「非表示のアイコンを表示」をクリックします。Oracle Analytics Desktopアイコンを見つけて右クリックします。
    2. 「URLをクリップボードにコピー」を選択します。

    3. ブラウザで、コピーしたURLを貼り付けて[Enter]を押します。
  3. ビジュアライゼーション拡張機能をテストするには:
    1. Oracle Analytics Desktopで、ワークブックを開くか作成します。
    2. ワークブックのデータ・パネルで、「ビジュアライゼーション」をクリックし、ビジュアライゼーション・リストの一番下にスクロールして、作成したカスタム・ビジュアライゼーションを含む「カスタム・ビジュアライゼーション」セクションを見つけます。

  4. ワークブック拡張機能をテストするには:
    1. Oracle Analytics Desktopで、「ナビゲータ」をクリックし、次に「コンソール」をクリックします。「拡張機能とエンリッチメント」セクションに移動し、「拡張機能」をクリックします。
    2. 「拡張機能のアップロード」をクリックし、ワークブック拡張機能のZIPファイルを参照して選択します。「開く」をクリックします。
    3. Oracle Analytics Desktopで、ワークブックを開くか作成します。
    4. ツールバーで、「カスタム・ワークブック拡張機能」をクリックし、インスタンスにアップロードしたワークブック拡張機能のリストを表示します。