HtmlViewServiceサービス

HtmlViewServiceサービスを使用して、Oracle Analytics HTMLの結果をサード・パーティの動的Webページ(Active Server Pages (ASP)、JavaServer Pages (JSP)など)やポータル・フレームワークに埋め込みます。

この埋込みプロセスにより、Oracle AnalyticsのWebサービス・コンテンツとサード・パーティのWebページのコンテンツがマージされます。

メソッド名	説明
addReportToPage()メソッド	結果をHTMLページに追加します。
endPage()メソッド	サーバー・ページ・オブジェクトとそれに関連付けられたすべてのデータを破棄します。
getCommonBodyHTML()メソッド	<BODY>セクションに含めるHTMLを取得します。
getHeadersHTML()メソッド	<HEAD>セクションに含めるHTMLを取得します。
getHtmlforPageWithOneReport()メソッド	1つの分析のみを含むページのHTMLを取得します。
getHTMLForReport()メソッド	特定の結果セットを表示するHTMLを取得します。
setBridge()メソッド	通信を受信するブリッジURLを指定します。Oracle Analytics Webサービス・サーバーとユーザーがアクセスしているプレゼンテーション・サービスが異なるマシン上にある場合や、アプリケーション開発環境で結果を変更する場合に役立つことがあります。
startPage()メソッド	新しいページ・オブジェクトを作成し、そのIDを戻します。

HtmlViewServiceのメソッドは、サード・パーティのWebページに挿入できるHTMLコード部分を抽出します。

HTMLコード部分	適切なページ位置
ヘッダー	HTMLページの<HEAD>セクションに挿入します。このコードには、共通のJavaScriptファイルとスタイルシートへのリンクが含まれます。
レポート・オブジェクト	<BODY>セクションの任意の位置に挿入できます。
共通ボディ	<BODY>タグのすべての分析リンクの後に挿入します。このコードには、ドリルダウン・リンクの実装に使用する非表示のHTML要素が含まれます。

HTMLコード部分には、戻される分析オブジェクトごとに、ブラウザがWebページをロードする際に自動的に追跡するコールバック・リンクが含まれます。コード部分には、分析のすべてのユーザー・インタフェース定義は含まれません。Oracle Analyticsプレゼンテーション・サービスにより分析が構築されている間は、サード・パーティのWebページに埋め込まれたOracle Analytics Webサービスの「検索中...」のイメージが表示されます。

分析が円滑に推移するように、Oracle Analyticsプレゼンテーション・サービスでは、サード・パーティのWebページの構築時に内部論理ページ・オブジェクト内の情報を管理することにより、サード・パーティのWebページに追加されたOracle Analyticsの分析を追跡します。HtmlViewServiceサービスのメソッドは、そのIDにより明示的に内部論理ページを参照します。

HtmlViewServiceブリッジおよびコールバックURLについて

アクティブなドリルダウン・リンクを持つ分析を埋め込むため、HtmlViewServiceサービスでは、埋め込まれた分析からOracle Analyticsプレゼンテーション・サービス・サーバーへのコールバック・リクエストをWebブラウザが発行できます。

リクエストを直接Oracle Analyticsプレゼンテーション・サービス・サーバーにルーティングすることも可能ですが、多くの場合、当初サード・パーティのページを処理していたOracle Analyticsインスタンスを介してリクエストをルーティングすることをお薦めします。また、Oracle Analyticsプレゼンテーション・サービスとサード・パーティのWebサーバーが同じDomain Name Service (DNS)ドメインに属していない状況では、クロスドメイン・スクリプトに対するブラウザのセキュリティ制約に関連するJavaScriptエラーが生じる場合があります。

このような問題を回避するには、setBridge()メソッドを使用して、サード・パーティのWebサーバーを指すようにコールバックURLを変更します。リクエストをOracle Analyticsプレゼンテーション・サービスにルーティングしなおすためにサード・パーティのWebサーバーによって実行されるWebコンポーネントは提供されていません。この機能は、サード・パーティのアプリケーションで実行する必要があります。setBridge()メソッドに関する詳細は、「setBridge()メソッド」を参照してください。

addReportToPage()メソッド

addReportToPage()メソッドを使用して、結果をHTMLページに追加します。

シグネチャ

void addReportToPage(String pageID, String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions options, String sessionID);

引数	説明
String pageID	startPage()メソッドにより戻された文字列ページIDを指定します。「startPage()メソッド」を参照してください。
String reportID	ページに追加する結果を含む分析を識別する文字列を指定します。これは、後続のメソッドの起動時にこの分析を参照する際に使用されます。たとえば、Oracle Analyticsプレゼンテーション・サービス・サーバーで生成される、対応するユーザー・インタフェース要素は、同じIDを参照します。
ReportRef report	ReportRef構造体で提供される分析定義を指定します。
String reportViewName	表示するビューを指定します。このパラメータがnullの場合、分析のデフォルトのビューが使用されます。ビュー名は、分析XML定義でビューの識別に使用するビュー名と一致している必要があります。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。
ReportHTMLOptions options	オプション。実行後に分析に適用する表示オプションを指定します。これはReportHTMLOptions構造体で提供されます。「QueryResults構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

endPage()メソッド

endPage()メソッドを使用して、Oracle Analyticsプレゼンテーション・サービスのサーバー・ページ・オブジェクトとそれに関連付けられたすべてのデータを破棄します。

シグネチャ

void endpage(String pageID, String sessionID);

引数	説明
String pageID	ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます。「startPage()メソッド」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getCommonBodyHTML()メソッド

getCommonBodyHTML()メソッドを使用して、<BODY>セクションに含めるHTMLを取得します。

シグネチャ

String getCommonBodyHTML(String pageID, String sessionID);

引数	説明
String pageID	ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます。「startPage()メソッド」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

<BODY>セクションに含めるHTMLを含む文字列を戻します。

getHeadersHTML()メソッド

getHeadersHTML()メソッドを使用して、<HEAD>セクションに含めるHTMLを取得します。

シグネチャ

String getHeadersHTML(String pageID, String sessionID);

引数	説明
String pageID	ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます。「startPage()メソッド」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

<HEAD>セクションに含めるHTMLを含む文字列を戻します。

getHtmlforPageWithOneReport()メソッド

getHtmlforPageWithOneReport()メソッドを使用して、1つの分析のみを含むページのHTMLを取得します。1つの分析のみを含むページには、<BODY>セクションおよび<HEAD>セクションはありません。

シグネチャ

String getHtmlForPageWithOneReport(String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions reportOptions, StartPageParams pageParams, String sessionID);

引数	説明
String pageReportID	getHtmlForPageWithOneReport()メソッドによって戻された分析IDを指定します。「addReportToPage()メソッド」を参照してください。
ReportRef report	ReportRef構造体で提供される分析定義を指定します。
String reportViewName	表示するビューを指定します。このパラメータがnullの場合、分析のデフォルトのビューが使用されます。ビュー名は、分析XML定義でビューの識別に使用するビュー名と一致している必要があります。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。
ReportHTMLOptions reportOptions	オプション。実行後に分析に適用する表示オプションを指定します。これはReportHTMLOptions構造体で提供されます。「QueryResults構造体」を参照してください。
StartPageParams pageParams	ページを開始する際に使用するオプションを指定します。これはStartPageParams構造体で提供されます。「StartPageParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getHTMLForReport()メソッド

getHTMLForReport()メソッドを使用して、特定の分析の結果を表示するHTMLの抜粋を取得します。このメソッドを起動する前に、addReportToPageメソッドを使用してHTMLページに結果を追加してください。

シグネチャ

String getHTMLForReport(String pageID, String pageReportID, String sessionID);

引数

説明

String pageID

ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます。「startPage()メソッド」を参照してください。

String pageReportID

addReportToPage()メソッドによって戻された分析IDを指定します。

「addReportToPage()メソッド」を参照してください。

String sessionID

セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

指定した分析を表示するHTMLの抜粋を含む文字列を戻します。

setBridge()メソッド

setBridge()メソッドを使用して、通信を受信するブリッジURLを指定します。ブリッジURLを指定すると、Oracle Analytics Webサービス・サーバーとユーザーのWebサーバーが異なるマシンにある場合や、アプリケーション開発環境で結果を変更する場合に役立つことがあります。

setBridge()メソッドをコールすると、クライアント・ブラウザからOracle Analyticsプレゼンテーション・サービス・サーバーへのすべてのリクエストは、ブリッジURLに送信され、そこからOracle Analyticsプレゼンテーション・サービス・サーバーに転送されます。

シグネチャ

setBridge(String bridge, String sessionID);

引数	説明
String bridge	ブリッジURLを指定します。たとえば、次のようにします。 http://myserver/myapplication/sawbridge
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

引数

説明

String bridge

ブリッジURLを指定します。たとえば、次のようにします。

http://myserver/myapplication/sawbridge

String sessionID

使用方法

クライアント・ブラウザが、Javaサーブレット、Active Server Pages (ASP)ページ、Common Gateway Interface (CGI)、Internet Server application programming interface (ISAPI)、または同等のアプリケーションの形式で、ブリッジURLにハンドラを提供していることを確認する必要があります。

また、次のタスクも実行する必要があります。

リクエスト文字列のRedirectURL引数にあるリクエストされたOracle Analytics Webサービス・リソースのパスをデコードします。「コールバックURLを置換する方法」を参照してください。
その他すべてのリクエスト引数を、すべてのヘッダーとリクエスト・ボディとともに、ブリッジURLに転送します。
レスポンスをOracle Analyticsプレゼンテーション・サービス・サーバーからレスポンス・ストリームにコピーします。

コールバックURLを置換する方法

新しいコールバックURLは、ブリッジURLに基づき、RedirectURL引数が追加されたものです。RedirectURL引数の値は、標準のURLエンコーディング・ルールを使用してエンコードされたURLの元の値である必要があります。

通常、Oracle Analytics Webサービスでは、内部的にコールバック・リンクの相対URLが使用されます。たとえば、元のコールバック・リンクがsaw.dll?Goであり、ブリッジURLが次のとおりだとします。

http://myserver/myapplication/sawbridge

この場合、新しいコールバックURLは次のようになります。

http://myserver/myapplication/sawbridge?RedirectURL=saw.dll%3fGo

startPage()メソッド

startPage()メソッドを使用してページ・オブジェクトを作成し、そのIDを戻します。

シグネチャ

String startPage(StartPageParams options, String sessionID);

引数	説明
StartPageParams options	ページを開始する際に使用するオプションを指定します。これはStartPageParams構造体で提供されます。「StartPageParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

Oracle Analyticsプレゼンテーション・サービスのページIDを含む文字列を戻します。