1. Oracle Analytics Serverのための開発者ガイド
  2. コンテンツの埋込み
  3. JavaScript埋込みフレームワークを使用したOracle Analyticsコンテンツの埋込み
  4. 埋め込まれたOracle Analyticsコンテンツ用のHTMLページの準備

埋め込まれたOracle Analyticsコンテンツ用のHTMLページの準備

Oracle Analyticsコンテンツを埋め込むには、HTMLページを作成または更新して必要なDOCTYPE宣言、dirグローバル属性を含め、embedding.js JavaScriptソースおよび埋込みワークブックのURLを参照する必要があります。また、埋込みモード(JETまたはスタンドアロン)と認証方法を指定し、任意の属性を追加してください。

このトピックでは、以下について説明します。

DOCTYPE宣言

doctype宣言を<!DOCTYPE html>に設定します。<!DOCTYPE html>以外のdoctype宣言を使用した場合、またはdoctype宣言を含めなかった場合、ページが正しくレンダリングされないなどの予期しない動作が発生します。

Dirグローバル属性

Webページのロケールに応じて、dirグローバル属性を設定します。dirグローバル属性は、埋込み分析コンテンツのレイアウト方向を示します。

ノート:

複数のロケールをサポートする必要がある場合は、JavaScriptを使用して属性を設定します。

属性の値オプションは次のとおりです。

  • rtl - 右から左へのレイアウトに使用します。
  • ltr - 左から右へのレイアウトに使用します。
  • auto - 使用しません。この値はOracle Analyticsではサポートされていません。

<script>タグおよびJavaScriptソース参照

ノート:

Oracle Analyticsによって、含める必要がある<script>タグおよびJavaScriptソースのURLが生成されます。

embedding.jsを参照する<script>タグをHTMLページに追加します。

JavaScriptソースのURL構造は次のとおりです:

  • "https://<instance>/public/dv/v1/embedding/<embeddingMode>/embedding.js"。このドキュメントの例ではこのURLを使用します。
  • 以前のデプロイメントの場合は、"http://<instance>/ui/dv/v1/embedding/<embeddingMode>/embedding.js"を使用します。

<embeddingMode>はjetまたはstandaloneである必要があります。

  • 分析コンテンツを既存のOracle JETアプリケーション内に埋め込む場合は、jetを使用します。jetを使用する場合は、アプリケーションで使用されるOracle JETのバージョンと、Oracle Analyticsで使用されるOracle JETのメジャー・バージョンが一致している必要があります。たとえば、Oracle AnalyticsでJET 11.0.0が使用されている場合は、カスタム・アプリケーションでもJET 11.0.0または11.1.0を使用する必要があります。Oracle Analyticsでは、Oracle JETバージョン11.1.10が使用されます。

    Oracle Analyticsで使用されているJETのバージョンを確認するには、Oracle Analyticsにログインしてブラウザ・コンソールを開き、次のコマンドを実行します:
    requirejs('ojs/ojcore').version

    埋込みアプリケーションでOracle JETが使用されている場合、Oracle Analyticsによってアプリケーションおよびアプリケーションに必要なコンポーネントが拡張されます。Oracle JETを使用するカスタム・アプリケーションへのOracle Analyticsコンテンツの埋込みを参照してください。

    Oracle JETは、Oracle Analyticsユーザー・インタフェースに使用されるJavascriptベースのライブラリ・セットです。

  • Oracle JETを使用しない汎用アプリケーションにビジュアライゼーション・コンテンツを埋め込む場合は、standaloneを使用します。

    埋込みアプリケーションがOracle JETを使用しない場合は、Oracle Analyticsによって、そのJET配信は追加のコンポーネントとともにページに表示されます。Oracle JETを使用しないカスタム・アプリケーションへのOracle Analyticsコンテンツの埋込みを参照してください。

認証

埋込み分析コンテンツを表示するには認証されたセッションが必要です。埋込みOracle Analyticsコンテンツでのログイン・プロンプト認証の使用を参照してください。

<oracle-dv>要素

ワークブックを埋め込むには、次のHTMLスニペットと属性値を適切にサイズ設定された要素の内部に追加する必要があります。Oracle Analyticsによって、含める必要があるHTMLが生成されます。

<oracle-dv project-path="" active-page="" active-tab-id="" filters=""></oracle—dv>

サポートされる属性 — 次の属性では、Knockoutモデルに定義されている静的文字列およびプロパティがサポートされます。 Knockoutは、Oracle JETで使用されているテクノロジです。

ノート:

これらの属性をKnockoutモデルにバインドする例は、Oracle JETを使用しないカスタム・アプリケーションへのOracle Analyticsコンテンツの埋込みを参照してください。

  • project-path: レンダリングするワークブックのパスを指定します。

  • active-page: (オプション)デフォルト以外のインサイトがレンダリングされるかどうかを指定します。active-pageを指定する場合はactive-tab-idも使用して、表示する正確な「表示」キャンバスを指定します。有効な値はinsightです。

    ノート:

    active-page値canvasは非推奨です。Oracleでは、canvasを使用する埋込みコードをinsightに変更することをお薦めします。canvasを使用している既存の埋込み分析コンテンツは引き続き動作しますが、ブラウザ・コンソールに警告が表示されます。

  • active-tab-id: (オプション)表示している「表示」キャンバスのIDを指定します。

  • filters: (オプション)埋込みワークブックにフィルタ値をプログラムにより渡すことを許可します。

  • project-options: (オプション)この属性では、projectはworkbookを指します。次のオプションを渡すことを許可します:

    • bDisableMobileLayout: モバイル・レイアウトを無効または有効にします。モバイル・レイアウトは、電話デバイスでのみ使用できるサマリー・カード・レイアウトを指します。値はtrueまたはfalseである必要があります。

    • bShowFilterBar: フィルタ・バーを表示または非表示にします。値はtrueまたはfalseである必要があります。

    • showCanvasNavigation: ワークブックの「表示」タブにあるキャンバス・ナビゲーション設定に従ってワークブックのキャンバスを表示するか非表示にします。値はtrueまたはfalseである必要があります。

    たとえば、<oracle-dv project-path="{{projectPath}}" active-page="canvas" active-tab-id="1" filters="{{filters}}" project-options='{"bDisableMobileLayout":true, "bShowFilterBar":false}'></oracle-dv>

  • brushing-type: ブラッシングの仕組みを制御します。指定した値により、システム・デフォルト、および保存済ワークブック内の設定を含む、他のすべての設定がオーバーライドされます。値には、文字列on、offまたはautoを使用する必要があります。

    • on: 通常の優先度のブラッシング問合せを発行するために使用します。ブラッシング問合せや視覚化問合せは混在しており、同時に実行されます。

    • auto: デフォルト。低い優先度のブラッシング問合せを発行するために使用します。ユーザーがビジュアライゼーションと対話する場合、ブラッシング問合せが完了するまで、他のビジュアライゼーション内のマークの表示が遅延する可能性があります。

  • compatibility-mode: Oracle JETの異なるメジャー・バージョンが存在する場合に使用します。これにより、埋込み分析コンテンツをサンドボックス化するiFrameが実行時に作成されます。値には、文字列yes、noまたはautoを使用する必要があります。

    ノート:

    この属性を設定する際は、次の2つのことに注意してください:

    互換性モードを使用している場合は、管理者が安全ドメインとして登録したアプリケーションで、「フレームを許可」が選択されていることを確認してください。安全ドメインとしてのアプリケーションの登録を参照してください。

    Oracle Analyticsで使用されているJETのバージョンを確認するには、Oracle Analyticsにログインしてブラウザ・コンソールを開き、次のコマンドを実行します:
    requirejs('ojs/ojcore').version
    • yes: 分析埋込みコンテンツを常にサンドボックス化する場合に使用します。これは、Oracle APEXアプリケーションに埋め込む場合に役立ちます。
    • no: デフォルト。iFrameを作成しない場合に使用します。
    • auto: ホスト埋込みアプリケーションとOracle Analytics間でOracle JETバージョンの大きな違いを自動的に検出する場合に使用します。Oracle APEXに埋め込む場合にこれを使用できます。

例

この例では、projectのすべてのインスタンスはworkbookを指します。

embedding.jsファイルの正確なURLは、ワークブックの「開発者」ウィンドウの「埋込み」タブから取得できます。 

<!DOCTYPE html>
<html dir="ltr">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
        <title>Embedded Oracle Analytics Workbook Example</title>
        <script src="https://<instance>/public/dv/v1/embedding/<embedding mode>/embedding.js" type="application/javascript">
        </script>

    </head>
    <body>
        <h1>Embedded Oracle Analytics Workbook</h1>
        <div style="border:1px solid black;position: absolute; width: calc(100% - 40px); height: calc(100% - 120px)" >
            <!--
            The following <oracle-dv> tag is the tag that will embed the specified workbook.
            -->
            <oracle-dv
               project-path="<project path>"
               active-page="insight"
               active-tab-id="snapshot!canvas!1">
            </oracle-dv>
        </div>
        <!--
        Apply Knockout bindings after DV workbook is fully loaded.  This should be executed in a body onload handler or in a <script> tag after the <oracle-dv> tag.
        -->
        <script>
        requirejs(['knockout', 'ojs/ojcore', 'ojs/ojknockout', 'ojs/ojcomposite', 'jet-composites/oracle-dv/loader'], function(ko) {
        ko.applyBindings();
        });
        </script>
    </body>
</html>