埋込みOracle AnalyticsコンテンツのHTMLページの準備

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

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

Doctype宣言

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

ディレクトリ・グローバル属性

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

ノート:

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

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

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

<script>タグおよびJavaScriptソース・リファレンス

ノート:

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

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

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

  • ”https://<instance>.analytics.ocp.oraclecloud.com/public/dv/v1/embedding/<embeddingMode>/embedding.js”。 このドキュメントの例ではこのURLを使用します。
  • 古いデプロイメントの場合は、次を使用します: "http://<instance>.analytics.ocp.oraclecloud.com/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ユーザー・インタフェースに使用されるJavaスクリプト・ベースのライブラリのセットです。

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

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

認証

埋込み分析コンテンツを表示するには認証されたセッションが必要です。 ログオン・プロンプトまたは3-Legged OAuth認証を使用できます。 「認証の追加」を参照してください。

<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はワークブックを指します。 次のオプションを渡すことができます:

    • 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: Default. 優先度の低い問合せを発行する場合に使用します。 ユーザーがビジュアライゼーションと対話する場合、ブラッシング問合せが完了するまで、他のビジュアライゼーション内のマークを表示する遅延がある可能性があります。

  • 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のすべてのインスタンスが「ワークブック」を参照しています。