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

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

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

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

Oracle Analytics Desktopの最新バージョンをインストールするか、最新バージョンにアップグレードします。
  1. Oracle Analytics Desktopのインストールのダウンロードに移動し、「ダウンロード」をクリックして、Oracle Cloudアカウントにログインします。
  2. Oracle Software Delivery Cloudのページで、プラットフォームをクリックし、Apple Mac OS Xを選択します。
  3. ライセンス契約を確認して同意します。Oracle Analytics DesktopのZIPファイルをクリックしてダウンロードします。
  4. コンピュータ上のダウンロードの場所に移動してZIPファイルをクリックし、Oracle_Analytics_Desktop_<version>_Mac.pkgをクリックしてインストールを実行します。
  5. 「Applications」フォルダに移動して、インストールで次のアプリケーションが作成されたことを確認します:
    • Oracle Data Visualization for Desktop
    • Oracle Data Visualization for Desktop Configure Python

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

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

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

MacでのBashプロファイルまたはZSHRCファイルの更新と開発ディレクトリの作成

Oracle Analytics Desktopスクリプトで必要な変数を含めるためにbashプロファイルまたはZSHRCファイルを変更します。次に、開発環境を含める開発ディレクトリを作成します。

  1. Bashプロファイルを変更するには、ホーム・ディレクトリに移動して、bash_profileが表示されているかどうかを確認します。表示されていない場合、[Command] + [Shift] + [.]を押して、bash_profileを表示します。
    ZSHRCファイルを変更するには、ターミナルを開き、次のコマンドを実行します:
    open ~/.zshrc
  2. 次の行をbash_profileまたはZSHRCに追加します。
    PLUGIN_DEV_DIRで、開発ディレクトリの場所を指定します(例: /Users/<username>/Documents/dv-custom-plugins)。
    export DVDESKTOP_SDK_HOME=/Applications/dvdesktop.app/Contents/Resources/app.nw 
    
    export PLUGIN_DEV_DIR=/Users/<username>/Documents/dv-custom-plugins 
    
    export PATH=${DVDESKTOP_SDK_HOME}/tools/bin:$PATH 
    
    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-1.8.jdk/Contents/Home/
  3. bash_profileの場合、ターミナルを開き、次のコマンドを実行して変更を適用します:
    source ~/.bash_profile
    ZSHRCファイルの場合、ターミナルを開き、次のコマンドを実行して変更を適用します:
    source ~/.zshrc
  4. 拡張機能の開発ディレクトリを作成するには、ターミナルを開き、次のコマンドを実行します:
    mkdir $PLUGIN_DEV_DIR

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

bashプロファイルを構成したら、bicreateenvスクリプトを実行して、拡張機能の作成に必要なリソースを含む開発環境を作成します。

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

  3. build.gradleを開き、-pluginDevDirを検索します。-pluginDevDir引数に大文字が含まれている場合は、小文字に変更します。変更後の引数は次のようになります:

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

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

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

bicreatepluginスクリプトの実行時に作成できる拡張機能の詳細は、「Oracle Analytics拡張機能のタイプ」を参照してください。
スクリプトを実行すると、PLUGIN_DEV_DIRECTORY環境にフォルダが作成されます。このフォルダには、拡張機能の開発に使用するファイルが含まれます。<extension_name>.jsのrenderメソッドは、コードの記述を開始できるエントリ・ポイントです。
bicreatepluginスクリプトでは次の構文が使用されます:
bicreateplugin viz -subType <subtypename> -id <com.company.yourVizName>

説明:

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

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

  1. ターミナルで、拡張機能開発ディレクトリに移動して、bicreatepluginスクリプトを実行します。
    次の例は、datavizスケルトン拡張機能を作成する方法を示しています:
    bicreateplugin viz -subType dataviz -id com.companyabc.helloviz 
    次の例は、ワークブック・スケルトン拡張機能を作成する方法を示しています:
    bicreateplugin workbook -id com.companyabc.helloworkbook
  2. Finderで、src/customvizフォルダに移動し、新しいフォルダが作成され、その名前がスクリプトの実行時に指定した拡張機能名と一致していることを確認します。
    次の例は、dataviz拡張機能のディレクトリを示しています:

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

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

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

ワークブックの作成およびワークブックへのビジュアライゼーションの追加の詳細は、Oracle Analytics拡張機能開発リソースOracle Analytics製品ドキュメントの項を参照してください。
ワークブック拡張機能をOracle Analytics Desktopにアップロードしてテストする前に、それを構築してパッケージ化する必要があります。「拡張機能の構築とパッケージ化」を参照してください。
  1. ターミナルで、次のコマンドを実行してブラウザでOracle Analytics Desktopを起動します:
    ./gradlew run
  2. コマンドの実行後にOracle Analytics Desktopが開いてから閉じた場合、Macメニュー・バーを使用して、手動でブラウザにOracle Analytics Desktopを開くことができます。
    1. Macメニュー・バーに移動し、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. ツールバーで、「カスタム・ワークブック拡張機能」をクリックし、インスタンスにアップロードしたワークブック拡張機能のリストを表示します。