| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-03 |
|
 前 |
 次 |
| Oracle® Fusion Middleware Oracle Business Intelligence Enterprise Editionインテグレーターズ・ガイド 11g リリース1 (11.1.1) B63033-03 |
|
前 |
次 |
この章では、Oracle Business Intelligenceのセッション・ベースWebサービスで使用するサービスおよびメソッドについて説明します。
このドキュメントでは、JavaScriptに類似した構文を使用して構造体を表現します。正確な構文および実装は、アプリケーション開発環境で使用されるSOAPコード生成ツールおよびターゲット言語により異なります。
この章の内容は次のとおりです。
このサービスは、Oracle BI EEの条件をプログラムで評価するために使用します。このサービスでは、条件で使用できるカスタマイズ可能なフィルタを取得することもできます。
表3-1は、サポートされるメソッドを示しています。
表3-1 ConditionServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
第3.1.1項「evaluateCondition()メソッド」 |
カタログに保存されている条件を評価します。 |
|
第3.1.2項「evaluateInlineCondition()」メソッド |
パラメータとして指定された条件を評価します。 |
|
第3.1.3項「getConditionCustomizableReportElements()メソッド」 |
カタログに保存されている条件のカスタマイズ可能なフィルタを取得します。 |
このメソッドを使用して、カタログに保存されている条件を評価します。このメソッドは、条件の結果(trueまたはfalse)を含むXML文字列を戻します。
boolean evaluateCondition(String path, String[] reportCustomizationParameters, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内の条件のフルパスおよび名前を指定します。例: /users/jchan/Conditions/IsRegionUnderBudget |
|
String [] reportCustomizationParameters |
カスタマイズ・パラメータXMLを指定します。これは、条件にカスタマイズ可能なフィルタがある場合のみ使用されます。このXMLは、orahome/bifoundation/web/schemas/analysis_customization.xsdで使用できるカスタマイズ・スキーマに対して検証されます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、Oracle BI EEプレゼンテーション・サービス外で定義された条件を評価します。条件XMLは、conditionXMLパラメータで指定されます。このメソッドは、条件評価の結果(trueまたはfalse)を含むXML文字列を戻します。
boolean evaluateInlineCondition(String conditionXML, String[] reportCustomizationParameters, String sessionID);
| 引数 | 説明 |
|---|---|
|
String conditionXML |
条件XMLを指定します。このXMLは、orahome/bifoundation/web/schemas/condition.xsdで使用可能な条件スキーマに対して検証されます。 |
|
String[] ListreportCustomizationParameters |
カスタマイズ・パラメータXMLを指定します。これは、条件にカスタマイズ可能なフィルタがある場合のみ使用されます。このXMLは、orahome/bifoundation/web/schemas/analysis_customization.xsdで使用できるカスタマイズ・スキーマに対して検証されます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログに格納されている条件で使用できるカスタマイズ可能なフィルタを判断します。このメソッドは、条件内で使用できるカスタマイズ可能なフィルタの定義を含むXML文字列を戻します。XMLは、orahome/bifoundation/web/schemas/analysis_customization.xsdで使用可能なカスタマイズ・スキーマに定義された形式です。
String[] getConditionCustomizableReportElements(String path, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内の条件のフルパスおよび名前を指定します。例: /users/jchan/Conditions/IsRegionUnderBudget |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、Oracle BI EE HTMLの結果をサード・パーティの動的Webページ(Active Server Pages (ASP)、JavaServer Pages (JSP)など)やポータル・フレームワークに埋め込みます。この埋込みプロセスにより、Oracle BI EEのWebサービス・コンテンツとサード・パーティのWebページのコンテンツがマージされます。
表3-2は、サポートされるメソッドを示しています。
表3-2 HtmlViewServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
第3.2.2項「addReportToPage()メソッド」 |
結果をHTMLページに追加します。 |
|
|
サーバー・ページ・オブジェクトとそれに関連付けられたすべてのデータを破棄します。 |
|
第3.2.4項「getCommonBodyHTML()メソッド」 |
<BODY>セクションに含めるHTMLを取得します。 |
|
|
<HEAD>セクションに含めるHTMLを取得します。 |
|
第3.2.6項「getHtmlforPageWithOneReport()メソッド」 |
1つの分析のみを含むページのHTMLを取得します。 |
|
第3.2.7項「getHTMLForReport()メソッド」 |
特定の結果セットを表示するHTMLを取得します。 |
|
|
通信を受信するブリッジURLを指定します。Oracle Business Intelligence Webサービス・サーバーとユーザーがアクセスしているプレゼンテーション・サービスが異なるマシン上にある場合や、アプリケーション開発環境で結果を変更する場合に役立つことがあります。 |
|
|
新しいページ・オブジェクトを作成し、そのIDを戻します。 |
HTMLViewServiceサービスのメソッドは、サード・パーティのWebページに挿入できるHTMLコード・フラグメントを抽出します。表3-3では、HTMLコードの抜粋と適切なページ位置について説明します。
表3-3 HtmlViewServiceサービスのHTMLコード・フラグメントとページ位置
| HTMLコード・フラグメント | 適切なページ位置 |
|---|---|
|
ヘッダー |
HTMLページの<HEAD>セクションに挿入します。このコードには、共通のJavaScriptファイルとスタイルシートへのリンクが含まれます。 |
|
レポート・オブジェクト |
<BODY>セクションの任意の位置に挿入できます。 |
|
共通ボディ |
<BODY>タグのすべての分析リンクの後に挿入します。このコードには、ドリルダウン・リンクの実装に使用する非表示のHTML要素が含まれます。 |
戻される分析オブジェクトごとに、HTMLコード・フラグメントには、ブラウザがWebページをロードする際に自動的に追跡するコールバック・リンクが含まれます。コード・フラグメントには、分析のすべてのユーザー・インタフェース定義は含まれません。分析がOracle BI EEプレゼンテーション・サービスにより構築されている間、そのインタフェースは、サード・パーティのWebページに埋め込まれたOracle BI EE Webサービスの「検索中...」のイメージを表示します。
円滑な分析の移行のため、Oracle BI EEプレゼンテーション・サービスでは、サード・パーティのWebページの構築時に内部論理ページ・オブジェクト内の情報を管理することにより、サード・パーティのWebページに追加されたOracle Business Intelligenceの分析を追跡します。HtmlViewServiceサービスのメソッドは、そのIDにより明示的に内部論理ページを参照します。
アクティブなドリルダウン・リンクを持つ分析を埋め込むため、HtmlViewServiceサービスでは、埋め込まれた分析からOracle BI EEプレゼンテーション・サービス・サーバーへのコールバック・リクエストをWebブラウザが発行できます。リクエストを直接Oracle BI EEプレゼンテーション・サービス・サーバーにルーティングすることも可能ですが、多くの場合、当初サード・パーティのページを処理していたOracle BI EEインスタンスを介してリクエストをルーティングすることをお薦めします。また、Oracle BI EEプレゼンテーション・サービスとサード・パーティのWebサーバーが同じDomain Name Service (DNS)ドメインに属していない状況では、クロスドメイン・スクリプトに対するブラウザのセキュリティ制約に関連するJavaScriptエラーが生じる場合があります。
このような問題を回避するには、setBridge()メソッドを使用して、サード・パーティのWebサーバーを指すようにコールバックURLを変更します。リクエストをOracle BI EEプレゼンテーション・サービスにルーティングしなおすためにサード・パーティのWebサーバーによって実行されるWebコンポーネントは提供されていません。この機能は、サード・パーティのアプリケーションで実行する必要があります。setBridge()メソッドの詳細は、第3.2.8項「setBridge()メソッド」を参照してください。
このメソッドを使用して、結果をHTMLページに追加します。
void addReportToPage(String pageID, String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions options, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pageID |
startPage()メソッドにより戻された文字列ページIDを指定します。startPage()メソッドの詳細は、第3.2.9項「startPage()メソッド」を参照してください。 |
|
String reportID |
ページに追加する結果を含む分析を識別する文字列を指定します。これは、後続のメソッドの起動時にこの分析を参照する際に使用されます。たとえば、Oracle Business Intelligenceプレゼンテーション・サービス・サーバーで生成される、対応するユーザー・インタフェース要素は、同じIDを参照します。 |
|
ReportRef report |
ReportRef構造体で提供される分析定義を指定します。 |
|
String reportViewName |
表示するビューを指定します。このパラメータがnullの場合、分析のデフォルトのビューが使用されます。ビュー名は、分析XML定義でビューの識別に使用するビュー名と一致している必要があります。 |
|
ReportParams reportParams |
オプション。実行前に分析に適用するフィルタまたは変数を指定します。これはReportParams共通構造体で提供されます。 詳細は、第3章「Oracle BI EE Webサービスにおけるサービスとメソッドについて」を参照してください。 |
|
ReportHTMLOptions options |
オプション。実行後に分析に適用する表示オプションを指定します。これはReportHTMLOptions構造体で提供されます。詳細は、第2.15項「QueryResults構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、Oracle BI EEプレゼンテーション・サービスのサーバー・ページ・オブジェクトとそれに関連付けられたすべてのデータを破棄します。
void endpage(String pageID, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pageID |
ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます(詳細は、第3.2.9項「startPage()メソッド」を参照してください)。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、<BODY>セクションに含めるHTMLを取得します。
String getCommonBodyHTML(String pageID, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pageID |
ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます(詳細は、第3.2.9項「startPage()メソッド」を参照してください)。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、<HEAD>セクションに含めるHTMLを取得します。
String getHeadersHTML(String pageID, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pageID |
ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます(詳細は、第3.2.9項「startPage()メソッド」を参照してください)。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、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メソッドの詳細は、第3.2.2項「addReportToPage()メソッド」を参照してください。 |
|
ReportRef report |
ReportRef構造体で提供される分析定義を指定します。 |
|
String reportViewName |
表示するビューを指定します。このパラメータがnullの場合、分析のデフォルトのビューが使用されます。ビュー名は、分析XML定義でビューの識別に使用するビュー名と一致している必要があります。 |
|
ReportParams reportParams |
オプション。実行前に分析に適用するフィルタまたは変数を指定します。これはReportParams共通構造体で提供されます。 詳細は、第3章「Oracle BI EE Webサービスにおけるサービスとメソッドについて」を参照してください。 |
|
ReportHTMLOptions reportOptions |
オプション。実行後に分析に適用する表示オプションを指定します。これはReportHTMLOptions構造体で提供されます。詳細は、第2.15項「QueryResults構造体」を参照してください。 |
|
StartPageParams pageParams |
ページを開始する際に使用するオプションを指定します。これはStartPageParams構造体で提供されます。StartPageParams構造体の詳細は、第2.26項「StartPageParams構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、特定の分析の結果を表示するHTMLの抜粋を取得します。このメソッドを起動する前に、addReportToPageメソッドを使用してHTMLページに結果を追加してください。
String getHTMLForReport(String pageID, String pageReportID, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pageID |
ページ・オブジェクトのIDを指定します。このIDはstartPage()メソッドにより戻されます(詳細は、第3.2.9項「startPage()メソッド」を参照してください)。 |
|
String pageReportID |
addReportToPage()メソッドによって戻された分析IDを指定します。 addReportToPageメソッドの詳細は、第3.2.2項「addReportToPage()メソッド」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、通信を受信するブリッジURLを指定します。ブリッジURLを指定すると、Oracle BI EE Webサービス・サーバーとユーザーのWebサーバーが異なるマシンにある場合や、アプリケーション開発環境で結果を変更する場合に役立つことがあります。
setBridge()メソッドをコールすると、クライアント・ブラウザからOracle BI EEプレゼンテーション・サービス・サーバーへのすべてのリクエストは、ブリッジURLに送信され、そこからOracle BI EEプレゼンテーション・サービス・サーバーに転送されます。
setBridge(String bridge, String sessionID);
| 引数 | 説明 |
|---|---|
|
String bridge |
ブリッジURLを指定します。たとえば、次のようになります。 http://myserver/myapplication/sawbridge |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
クライアント・ブラウザが、Javaサーブレット、Active Server Pages (ASP)ページ、Common Gateway Interface (CGI)、Internet Server application programming interface (ISAPI)、または同等のアプリケーションの形式で、ブリッジURLにハンドラを提供していることを確認する必要があります。
また、次のタスクも実行する必要があります。
リクエスト文字列のRedirectURL引数にあるリクエストされたOracle BI EE Webサービス・リソースのパスをデコードします。RedirectURL引数の詳細は、第3.2.8.3項「コールバックURLを置換する方法」を参照してください。
その他すべてのリクエスト引数を、すべてのヘッダーとリクエスト・ボディとともに、ブリッジURLに転送します。
レスポンスをOracle BI EEプレゼンテーション・サービス・サーバーからレスポンス・ストリームにコピーします。
新しいコールバックURLは、ブリッジURLに基づき、RedirectURL引数が追加されたものです。RedirectURL引数の値は、標準のURLエンコーディング・ルールを使用してエンコードされたURLの元の値である必要があります。
通常Oracle BI EE Webサービスでは、内部的にコールバック・リンクの相対URLが使用されます。たとえば、元のコールバック・リンクがsaw.dll?Goであり、ブリッジURLが次のとおりだとします。
http://myserver/myapplication/sawbridge
この場合、新しいコールバックURLは次のようになります。
http://myserver/myapplication/sawbridge?RedirectURL=saw.dll%3fGo
このメソッドを使用して、新しいページ・オブジェクトを作成し、そのIDを戻します。
String startPage(StartPageParams options, String sessionID);
| 引数 | 説明 |
|---|---|
|
StartPageParams options |
ページを開始する際に使用するオプションを指定します。これはStartPageParams構造体で提供されます。StartPageParams構造体の詳細は、第2.26項「StartPageParams構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、Oracle BI EEエージェントの保存、編集、削除、登録、登録解除、カスタマイズ、および実行を行います。Oracle Business Intelligence 11g (11.1.1) リリース以降、iBotsという名前はエージェントに変更されました。
表3-4は、サポートされるメソッドを示しています。
表3-4 iBotServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
|
新しいエージェントをカタログに書き込み、これをOracle BIスケジューラに登録します。 |
|
|
エージェントをカタログから削除し、Oracle BIスケジューラから登録解除します。 |
|
|
カタログに保存されているエージェントを実行します。 |
|
|
エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。 |
|
|
Oracle BI EEのユーザー、グループ、またはその両方に、メッセージを送信します。 |
|
|
公開されているエージェントに登録します。登録のカスタマイズも行います。 |
|
|
エージェントから登録解除します。 |
このメソッドを使用して、新しいエージェントをカタログに書き込み、これをOracle BIスケジューラに登録します。このメソッドは、カタログへの書込みのみを行う、WebCatalogServiceサービスの「writeObjects()メソッド」とは異なります。
int writeIBot (CatalogObject obj, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
| 引数 | 説明 |
|---|---|
|
CatalogObject obj |
カタログに書き込まれるオブジェクトを指定します。このオブジェクトのXMLは、orahome/bifoundation/web/schemasディレクトリにあるanalysis_ibot.xsdに対して検証されます。 |
|
String path |
カタログ内のエージェントのフルパスおよび名前を指定します。例: /users/jchan/iBots/BrandDollars |
|
boolean resolveLinks |
TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。 |
|
boolean allowOverwrite |
既存のオブジェクトをオーバーライドするかどうかを指定します。パスによって指定された場所にすでに存在するオブジェクトをオーバーライドするには、TRUEに設定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、保存されているエージェントを削除します。エージェントを削除すると、カタログからこれ(オブジェクト)が削除されるだけでなく、Oracle BIスケジューラからエージェントが登録解除されます。このメソッドは、「WebCatalogServiceサービス」のdeleteitemメソッドとは異なります。deleteitemメソッドの場合、エージェントはOracle BIスケジューラから登録解除されません。
このメソッドを使用して、エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。このメソッドは、「WebCatalogServiceサービス」のmoveItemメソッドとは異なります。moveItemメソッドの場合、カタログ・オブジェクトを移動し、さらにOracle BIスケジューラにオブジェクトが移動されたことを通知します。
void moveIBot(String fromPath, String toPath, boolean resolveLinks, boolean allowOverwrite, String sessionID);
| 引数 | 説明 |
|---|---|
|
String fromPath |
移動するエージェントのフル・カタログ・パスを指定します。 |
|
String toPath |
エージェントの移動先のフル・カタログ・パスを指定します。 |
|
boolean resolveLinks |
子オブジェクトを移動するかどうかを指定します。この引数をTRUEに設定し、fromPath引数に指定したバスがリンクである場合、このリンクが指す子オブジェクトは移動されます。 |
|
boolean allowOverwrite |
既存のオブジェクトをオーバーライドするかどうかを指定します。この引数をTRUEに設定し、toPathによって指定されたパスに別のカタログ・オブジェクトが存在する場合、このオブジェクトはオーバーライドされます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、Oracle BI EEのユーザー、グループ、またはその両方にメッセージを送信します。メッセージは、対応する受信者の配信プロファイルに従って配信されます。このプロファイルは、Oracle BIプレゼンテーション・サービスの「マイ・アカウント」ダイアログで設定されたものです。
String sendMessage(String[] recipient, String[] group, String subject, String body, String priority, String sessionID);
| 引数 | 説明 |
|---|---|
|
String[] recipient |
メッセージを送信するOracle BI EEユーザーのGUIDを指定します。この引数には、1つ以上のユーザーを含めることができます。 |
|
String[] group |
メッセージを送信するOracle BI EEグループのGUIDを指定します。この引数には、1つ以上のグループを含めることができます。 |
|
String subject |
メッセージの件名の行を指定します。 |
|
String body |
メッセージの本文に含めるテキストを指定します。 |
|
String priority |
メッセージの優先度を指定します。High、Normal、またはLowを指定できます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、公開されたエージェントに登録します。エージェントでカスタマイズが可能な場合、カスタマイズXMLも指定できます。
void subscribe(String path, String customizationXml, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内のエージェントのフルパスおよび名前を指定します。例: /users/jchan/iBots/BrandDollars |
|
String customizationXml |
カスタマイズXMLを指定します(エージェントがカスタマイズを許可している場合のみ)。このXMLは、orahome/bifoundation/web/schemas/analysis_customizationで使用可能なカスタマイズ・スキーマに対して検証されます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、マーケティング・セグメンテーションを実行し、生成機能をリストします。
表3-5は、サポートされるメソッドを示しています。
表3-5 JobManagementServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
|
マーケティング・ジョブの実行を取り消します。 |
|
第3.4.2項「deleteResultSet()メソッド」 |
保存されている結果セットを削除します。 |
|
|
セグメントまたはセグメント・ツリーのカウント数値を生成します。 |
|
|
マーケティング・ジョブのステータスと詳細情報を取得します。 |
|
第3.4.5項「getPromptedColumns()メソッド」 |
セグメントまたはセグメント・ツリーのプロンプト列を戻します。 |
|
|
リスト・エクスポートのためのセグメントまたはセグメント・ツリーをキャッシュします。 |
|
|
キャッシュ全体、セグメントのエントリ、またはセグメント・ツリーのエントリをパージします。 |
|
|
最近更新されたカウントに基づいてメンバーのリストを保存します。 |
|
|
リスト・エクスポート、セグメント・キャンペーン・ロード、またはセグメント・ツリー・キャンペーン・ロードのリストを生成します。 |
このメソッドを使用して、指定のセグメントに属するGUID値のリストによって識別されるターゲットレベルのオブジェクトの保存されている結果セットを、1つ以上削除します。
JobInfo deleteResultSet(String targetLevel, ArrayOfGUIDs guiDs, String segmentPath, String sessionID);
| 引数 | 説明 |
|---|---|
|
String targetLevel |
保存された結果セットのターゲット・レベルを指定します。 |
|
ArrayOfGUIDs guiDs |
保存された結果セットを表すGUIDのリストを指定します。ArrayOfGUIDs構造体の詳細は、第2.4項「ArrayofGUIDS構造体」を参照してください。 |
|
String segmentPath |
セグメントへのパスを指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、セグメントまたはセグメント・ツリーのカウント数値を生成します。
JobInfo getCounts(String segmentPath, String treePath, SegmentationOptions segmentationOptions, String sessionID);
| 引数 | 説明 |
|---|---|
|
String segmentPath |
セグメントへのパスを指定します。getCountsがセグメントで実行される際に使用されます。 |
|
String treePath |
セグメント・ツリーへのパスを指定します。getCountsがセグメント・ツリーで実行される際に使用されます。 |
|
Segmentation |
SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.24項「SegmentationOptions構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、セグメントまたはセグメント・ツリーのプロンプト列を戻します。
PromptedColumnInfo getPromptedColumns(String segmentPath, String treePath, String sessionID);
| 引数 | 説明 |
|---|---|
|
String segmentPath |
セグメントへのパスを指定します。getPromptedColumnsがセグメントで実行される際に使用されます。 |
|
String treePath |
セグメント・ツリーへのパスを指定します。gePromptedColumnsがセグメント・ツリーで実行される際に使用されます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、リスト・エクスポートのためのセグメントまたはセグメント・ツリーをキャッシュします。
JobInfo prepareCache(String segmentPath, String treePath, Boolean refresh, String sessionID);
| 引数 | 説明 |
|---|---|
|
String segmentPath |
セグメントへのパスを指定します。prepareCacheがセグメントで実行される際に使用されます。 |
|
String treePath |
セグメント・ツリーへのパスを指定します。prepareCacheがセグメント・ツリーで実行される際に使用されます。 |
|
Boolean refresh |
TRUEに設定されている場合、システムは、キャッシュ・ヒット時にキャッシュ・エントリにデータを移入し、さらにキャッシュ・ミス時にキャッシュ・エントリにデータを移入します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、キャッシュ全体のパージ、キャッシュからのセグメントのエントリのパージ、またはキャッシュからのセグメント・ツリーのエントリのパージを行います。
JobInfo purgeCache(String segmentPath, String treePath, Boolean ignoreCacheRef, String sessionID);
| 引数 | 説明 |
|---|---|
|
String segmentPath |
セグメントへのパスを指定します。 purgeCacheがセグメントで実行される際に使用されます。 |
|
String treePath |
セグメント・ツリーへのパスを指定します。purgeCacheがセグメント・ツリーで実行される際に使用されます。 |
|
Boolean ignoreCacheRef |
TRUEに設定されている場合、システムは、現在使用され、セグメント、セグメント・ツリー、期限切れキャッシュ・エントリ、および存在しないキャッシュ・エントリにより参照されているキャッシュ・エントリをパージします。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、最近更新されたカウントに基づき、セグメントまたはセグメント・ツリーに対して修飾するメンバーのリストを保存します。システムでは、メンバーを抽出し、指定のセグメント・パスに保存します。
JobInfo saveResultSet(String segmentPath, TreeNodePath treeNodePath, String savedSegmentPath, SegmentationOptions segmentationOptions, String srCustomLabel, Boolean appendStaticSegment, String sessionID);
| 引数 | 説明 |
|---|---|
|
String segmentPath |
セグメントへのパスを指定します。 |
|
TreeNodePath treeNodePath |
セグメント・ツリー・パスおよびブランチID番号を指定します。 |
|
String savedSegmentPath |
システムが生成されたメンバーを抽出し、保存する新しいセグメントのパスと名前を指定します。 |
|
Segmentation |
SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.24項「SegmentationOptions構造体」を参照してください。 |
|
String srCustomLabel |
静的セグメント作成のためのカスタム・ラベルを指定します。 |
|
Boolean appendStaticSegment |
保存された同じセグメント・パスの下に静的セグメント・エントリを作成するためのフラグを指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、リスト・エクスポート、セグメント・キャンペーン・ロード、またはセグメント・ツリー・キャンペーン・ロードのリストを生成します。
JobInfo writeListFiles(ReportRef report, ReportParams reportParams, String segmentPath, TreeNodePath treeNodePath, SegmentationOptions segmentationOptions, String filesystem, BigInteger timeout, String sessionID);
| 引数 | 説明 |
|---|---|
|
ReportRef report |
ReportRef構造体で提供される、分析の参照定義を指定します。ReportRef構造体の詳細は、第2.18項「ReportRef構造体」を参照してください。 |
|
ReportParams reportParams |
実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。ReportParams構造体の詳細は、第2.17項「ReportParams構造体」を参照してください。 |
|
String segmentPath |
セグメントへのパスを指定します。 |
|
TreeNodePath treeNodePath |
セグメント・ツリー・パスおよびブランチIDを指定します。 |
|
SegmentationOptions segmentationOptions |
SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.24項「SegmentationOptions構造体」を参照してください。 |
|
String filesystem |
リスト・ファイルを含む共有ディレクトリへのパスを指定します。 |
|
BigInteger timeout |
タイムアウト値を指定します。これは常に0に設定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、Oracle Business Intelligenceプレゼンテーション・サービスのスキーマ・オブジェクト(列、表、サブジェクト・エリアなど)の説明を取得します。
表3-6は、サポートされるメソッドを示しています。
表3-6 MetadataServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
第3.5.1項「clearQueryCache()メソッド」 |
問合せキャッシュを消去します。 |
|
|
指定したサブジェクト・エリアおよび表内の指定した列の列情報を取得します。 |
|
第3.5.3項「describeSubjectArea()メソッド」 |
指定したサブジェクト・エリアのサブジェクト・エリア情報を取得します。 |
|
|
指定したサブジェクト・エリア内の指定した表の表情報を取得します。 |
|
第3.5.5項「getSubjectAreas()メソッド」 |
使用可能なサブジェクト・エリアのリストを取得します。 |
このメソッドを使用して、指定したサブジェクト・エリアおよび表内の指定した列の列情報を取得します。
SAColumn describeColumn(String subjectAreaName, String tableName, String columnName, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
String tableName |
問い合せる表を指定します。 |
|
String columnName |
問い合せる列の名前を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定したサブジェクト・エリアのサブジェクト・エリア情報を取得します。
SASubjectArea describeSubjectArea (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
SASubjectAreaDetails detailsLevel |
取得するサブジェクト・エリアについての情報を指定します。SASubjectAreaDetails構造体の詳細は、第3.5.3.2項「SASubjectAreaDetailsの値」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、サブジェクト・エリアについてどのような情報を取得するのかを指定します。表3-7に、使用可能な値をリストします。
detailsLevelパラメータの値に応じて、戻されるオブジェクトには、表3-8に示される情報が含まれます。
表3-8 detailsLevelの値
| detailsLevelの値 | 説明 |
|---|---|
|
IncludeTables |
表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトはnullに設定された列フィールドを含みます。 |
|
InludeTablesAndColumns |
表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトに対し、列フィールドには対応する列のコレクションが含まれます。 |
|
Minimum |
表リストが使用できないことを指定します。結果のサブジェクト・エリア・オブジェクトの表フィールドはnullです。 |
このメソッドを使用して、指定したサブジェクト・エリアの指定した表の表情報を取得します。
SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sessionID);
| 引数 | 説明 |
|---|---|
|
String subjectAreaName |
問い合せるサブジェクト・エリアを指定します。 |
|
String tableName |
問い合せる表を指定します。 |
|
SATableDetails detailsLevel |
取得する表の情報を指定します。SATableDetails構造体の詳細は、第3.5.4.2項「SATablesDetailsの値」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
これを使用して、取得する表の情報を指定します。表3-9に、使用できる値をリストします。
このサービスを使用して、カタログ・レプリケーション・メソッドを提供します。
表3-10は、サポートされるメソッドを示しています。
表3-10 ReplicationServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
ログ・ファイルから変更内容をインポートします。 |
|
|
|
指定されたログ・ファイルにカタログの変更内容をエクスポートします。 |
|
第3.6.5項「markForReplication()メソッド」 |
指定されたフォルダとその子フォルダにおいて、レプリケーション可能フラグを変更します。 |
|
|
指定したログを消去します。 |
この列挙では、エクスポート・メソッドでエクスポートする変更内容を指定します。表3-11に、この列挙の値をリストします。
|
注意: ExportFlagsの1つのフィールドのみにデータを移入します。 |
表3-11 ExportFlagsの列挙値
| メソッド名 | 説明 |
|---|---|
|
String processAllChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、ローカル・コンピュータおよびリモート・コンピュータの指定のディレクトリで変更されたフラグをエクスポートすることを指定します(processLocalChangesとprocessRemoteChangesを組み合せます)。 |
|
String processAll_ForMerge |
すでに存在する項目で競合を管理する方法を指定します。 項目が存在し、エクスポート項目の最後に変更されたタイム・スタンプが既存の項目のタイムスタンプより大きい場合、既存の項目は置換されます。 項目が存在し、エクスポート項目の最後に変更されたタイム・スタンプが既存の項目のタイムスタンプより小さい場合、既存の項目は置換されません。 |
|
String processAll_ForReplace |
エクスポート項目と既存の項目の両方のタイムスタンプに関係なく、エクスポート項目を使用することを指定します。 |
|
String processAll_ForWriteIfNotExists |
エクスポートに含まれる項目が存在する場合、これらは置換されないことを指定します。 |
|
String processLocalChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、ローカル・コンピュータの指定のディレクトリで変更されたフラグをエクスポートすることを指定します。 |
|
String processRemoteChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、リモート・コンピュータの指定のディレクトリで変更されたフラグをエクスポートすることを指定します。 |
この列挙では、インポート・メソッドでインポートする変更内容を指定します。表3-12に、この列挙の値をリストします。
表3-12 ImportFlagsの列挙値
| メソッド名 | 説明 |
|---|---|
|
String processAllChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、ローカル・コンピュータおよびリモート・コンピュータの指定のディレクトリで変更されたフラグをインポートすることを指定します(processLocalChangesとprocessRemoteChangesを組み合せます)。 |
|
String processLocalChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、ローカル・コンピュータの指定のディレクトリで変更されたフラグをインポートすることを指定します。 |
|
String processRemoteChanges |
最初にレプリケーション・ログを参照してどのような変更が行われたのかを調べた後で、リモート・コンピュータの指定のディレクトリで変更されたフラグをインポートすることを指定します。 |
このメソッドを使用して、ログ・ファイルから変更内容をインポートします。
|
注意: Java環境では、インポート・メソッドを_import()として指定する必要があります。これにより、予約語importとの競合が回避されます。 |
List[] (String filename, ImportFlags flag, Calendar lastPurgedLog, boolean updateReplicationLog, boolean returnErrors, CatalogItemsFilter filter, PathMap pathMap, String sessionID);
| 引数 | 説明 |
|---|---|
|
String filename |
ログ・ファイルの名前を指定します。 |
|
ImportFlags flag |
インポートする変更内容のサブセット(ローカル、リモートなど)を指定します。詳細は、「ImportFlagsの列挙」を参照してください。 |
|
Calendar lastPurgedLog |
ログが最後に消去された日付と時間を指定します。この時間の後にエクスポート・ファイル内で変更が行われた場合、インポートではローカル・ログを使用して、これをリプレイするかどうかを判断します。変更が行われていない場合、インポートでは最後のアクセス時間を使用します。 |
|
boolean updateReplicationLog |
TRUEに設定されている場合、レプリケーション・ログは更新されます。FALSEに設定されている場合、レプリケーション・ログは更新されません。 |
|
boolean returnErrors |
TRUEに設定されている場合、この関数はImportErrorオブジェクトの配列を戻します。この配列には、フィルタ条件を満たすインポート・ファイルに記録された変更内容がリプレイされなかった場合について記述されます。 |
|
CatalogItemsFilter filter |
特定の期間内に行われた変更と、指定されたフォルダのカタログ項目に対して行われた変更をフィルタすることを指定します。nullに設定することができます。 |
|
PathMap pathMap |
インポートした変更内容のコピー先のディレクトリを指定します。この引数を使用して、あるディレクトリの項目を別のディレクトリにコピーします。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定されたログ・ファイルにカタログの変更内容をエクスポートします。
void export (String filename, CatalogItemsFilter filter, ExportFlags flag, boolean exportSecurity, String sessionID);
| 引数 | 説明 |
|---|---|
|
String filename |
ログ・ファイルの名前を指定します。 |
|
CatalogItemsFilter filter |
エクスポートする変更内容のサブセットを指定します。filter.itemsフィールドをnullに設定することはできません。 |
|
ExportImportFlags flag |
エクスポートする変更内容(ローカル、リモートなど)を指定します。詳細は、「ExportFlagsの列挙」を参照してください。 |
|
exportSecurity |
対応するオブジェクトのセキュリティ情報を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定されたフォルダとその子フォルダにおいて、レプリケーション可能フラグを変更します。
void markForReplication (String item, boolean replicate, String sessionID);
| 引数 | 説明 |
|---|---|
|
String item |
フォルダのパスを指定します。 |
|
boolean replicate |
TRUEに設定されている場合、フォルダをレプリケーション可能にマークします。FALSEに設定されている場合、レプリケーション可能フラグを削除します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
指定したログを消去します。
void purgeLog(List[] items, Calendar timestamp, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] items |
消去するフォルダ・パスのリスト。 |
|
Calendar timestamp |
最後に変更された時間がタイムスタンプより早いログ項目のみ消去します。 |
|
String sessionID |
SOAPセッションからログオフするセッションIDを含む文字列値。セッションIDは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、引数とOracle Business Intelligenceプレゼンテーション・サービス・データをマージし、結果を作成して戻します。
表3-13は、サポートされるメソッドを示しています。
表3-13 ReportEditingServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
第3.7.1項「applyReportDefaults()メソッド」 |
分析のデフォルトの引数を分析に適用し、結果を戻します。 |
|
第3.7.2項「applyReportParams()メソッド」 |
レポートの引数を分析オブジェクトに適用し、結果を戻します。 |
|
第3.7.3項「generateReportSQL()メソッド」 |
指定された分析に対するSQL問合せを取得します。 |
このメソッドを使用して、分析のデフォルトの引数を分析に適用し、結果を戻します。
String applyReportDefaults(ReportRef reportRefs, String sessionID);
| 引数 | 説明 |
|---|---|
|
ReportRef object |
ReportRef共通構造体で提供される、分析定義へのパスを指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、分析引数を分析に適用し、結果を戻します。
Object applyReportParams(ReportRef reportRef, ReportParams reportParams, boolean encodeInString, String sessionID);
| 引数 | 説明 |
|---|---|
|
ReportRef reportRef |
ReportRef共通構造体で提供される、分析定義へのパスを指定します。 |
|
ReportParams reportParams |
オプション。実行前に分析に適用するフィルタまたは変数を指定します。これはReportParams共通構造体で提供されます。詳細は、第3章「Oracle BI EE Webサービスにおけるサービスとメソッドについて」を参照してください。 |
|
boolean encodeInString |
TRUEに設定されている場合、戻される分析オブジェクトは、文字列としてエンコードされます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定した分析に対する論理SQL問合せを取得します。
String generateReportSQL(ReportRef reportRef, ReportParams reportParams, String sessionID);
| 引数 | 説明 |
|---|---|
|
ReportRef reportRef |
ReportRef共通構造体で提供される、分析定義へのパスを指定します。 |
|
ReportParams reportParams |
オプション。実行前に分析に適用するフィルタまたは変数へのパスを指定します。これはReportParams共通構造体で提供されます。詳細は、第3章「Oracle BI EE Webサービスにおけるサービスとメソッドについて」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、ログオンやログオフなどの認証メソッド、およびその他のセッション関連のメソッドを提供します。
表3-14は、サポートされるメソッドを示しています。
表3-14 SAWSessionServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
|
セッションの現行ユーザーIDを取得します。 |
|
第3.8.2項「GetSessionEnvironment()メソッド」 |
現行セッションの環境オブジェクトを取得します。 |
|
第3.8.3項「getSessionVariable()メソッド」 |
セッション変数のリストを取得します。 |
|
|
ログオンしてユーザーを偽装します。 |
|
|
ログオンしてユーザーを偽装します。impersonateメソッドと類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。 |
|
|
Oracle Business Intelligenceプレゼンテーション・サービスに、特定のセッションが非アクティブであっても終了させないよう指示します。 |
|
|
ユーザーをOracle Business Intelligenceプレゼンテーション・サービスからログオフさせます。 |
|
|
ユーザーを認証します。 |
|
|
ユーザーを認証します。logonメソッドと類似していますが、logonexではオプションのセッション・パラメータを指定できます。 |
このメソッドを使用して、セッションの現行ユーザー名を取得します。
String getCurUser(String sessionID);
| 引数 | 説明 |
|---|---|
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、現行セッションの環境オブジェクトを取得します。
SessionEnvironment getSessionEnvironment (String sessionID);
| 引数 | 説明 |
|---|---|
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、セッション変数のリストを取得します。
List[] getSessionVariables(List[] names, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] names |
セッション変数の名前を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonate()メソッドを使用する場合、logonメソッドを使用する必要はありません。
ユーザー認証または偽装に失敗した場合、例外がスローされます。
String impersonate(String name, String password, String impersonateID);
| 引数 | 説明 |
|---|---|
|
String name |
ログオンし、認証を行うユーザー名を指定します。 |
|
String password |
ユーザーのパスワードを指定します。ユーザーにパスワードがない場合、このフィールドは空(void)にします。 |
|
String impersonateID |
認証対象となるユーザーを偽装するユーザー名を指定します。 |
このメソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。impersonateメソッドに類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonateex()メソッドを使用する場合、logonメソッドを使用する必要はありません。
ユーザー認証または偽装に失敗した場合、例外がスローされます。
AuthResults impersonateex(String name, String password, String impersonateID, SAWSessionParameters sessionparams);
| 引数 | 説明 |
|---|---|
|
String name |
ログオンし、認証を行うユーザー名を指定します。 |
|
String password |
ユーザーのパスワードを指定します。ユーザーにパスワードがない場合、このフィールドは空(void)にします。 |
|
String impersonateID |
認証対象となるユーザーを偽装するユーザー名を指定します。 |
|
SAWSessionParameters sessionparams |
オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、第2.23項「SAWSessionParameters構造体」を参照してください。 |
このメソッドは、セッションIDを含むAuthResult構造体を戻し、HTTPセッションのCookieを設定します。セッションIDは、別のメソッドでOracle Business Intelligenceプレゼンテーション・サービス・セッションの識別に使用されます。詳細は、第2.5項「AuthResult構造体」を参照してください。
このメソッドを使用して、Oracle BI EEプレゼンテーション・サービスに、特定のWebユーザーが非アクティブであっても終了しないよう指示します。セッション存続期間におけるこのメソッドの効果は、ユーザーがブラウザでアクティビティを実行した(分析のクリック、メソッドの起動など)場合と同様です。
このメソッドを使用して、ユーザーを認証します。認証に失敗した場合、例外がスローされます。
String logon(String name, String password);
| 引数 | 説明 |
|---|---|
|
String name |
認証を行うユーザー名を指定します。 |
|
String password |
ユーザーのパスワードを指定します。パスワードがない場合、このフィールドは空(void)にします。 |
このメソッドを使用して、ユーザーを認証します。logonメソッドと類似していますが、logonexではオプションのセッション・パラメータを指定できます。認証に失敗した場合、例外がスローされます。
AuthResult logonex(String name, String password, SAWSessionParameters sessionparams);
| 引数 | 説明 |
|---|---|
|
String name |
認証を行うユーザー名を指定します。 |
|
String password |
ユーザーのパスワードを指定します。パスワードがない場合、このフィールドは空(void)にします。 |
|
SAWSessionParameters sessionparams |
オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、第2.23項「SAWSessionParameters構造体」を参照してください。 |
このサービスを使用して、アカウントと権限を識別するメソッドを提供します。表3-15に、サポートされるメソッドを示します。
表3-15 SecurityServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
|
アカウント名マッピングに対するOracle BI EEプレゼンテーション・サービスの内部IDを削除します。 |
|
|
Oracle BI EEのユーザー・アカウントを検索します。 |
|
第3.9.3項「getGlobalPrivilegeACL()メソッド」 |
グローバル権限のアクセス制御リストを取得します。 |
|
第3.9.4項「getGlobalPrivileges()メソッド」 |
すべてのグローバル権限のリストを取得します。 |
|
|
ユーザーやグループなど、アカウントのメンバーであるカタログ・グループのリストを取得します。 |
|
|
カタログ・グループの直接のメンバーを取得します。 |
|
|
指定したユーザーの権限のリストを取得します。 |
|
第3.9.8項「getPrivilegesStatus()メソッド」 |
すべての権限とそのステータスをリストします。 |
|
|
カタログ・グループがユーザーまたはグループのメンバーであるかどうかを確認します。 |
|
|
カタログ・グループにメンバーとしてユーザーを追加します。 |
|
|
グループからメンバーを削除します。 |
|
第3.9.12項「renameAccounts()メソッド」 |
ユーザー・アカウントの名前を変更します。 |
|
第3.9.13項「updateGlobalPrivilegeACL()メソッド」 |
グローバル権限のアクセス制御リストを更新します。 |
このメソッドを使用して、アカウント名マッピングに対するOracle BI EEプレゼンテーション・サービスの内部IDを削除します。このアクションは、アカウント・マッピングが誤って作成された場合(updateGlobalSAWPrivilegeACLメソッドでアカウント名のスペルを間違えた場合など)に便利です。
void forgetAccounts(List[], int cleanuplevel, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] |
削除するアカウントを指定します。これはAccount構造体で提供されます。Account構造体の詳細は、第2.3項「ACL構造体」を参照してください。 |
|
int cleanuplevel |
削除するマッピング情報の量を指定します。0に設定した場合、内部アカウントIDおよび、ユーザーまたはグループの名前からマッピングを削除します。1に設定した場合、アカウントがユーザーを参照していれば、ユーザー・ディレクトリを削除します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、Oracle BI EEのユーザー・アカウント(LDAPユーザー、カタログ・グループ、アプリケーション・ロールなど)を検索します。
このメソッドを使用して、指定のアクセス制御リストに基づき、指定したユーザーの権限のリストを取得します。
|
注意: また、このメソッドは、アクセス制御リストでグループの権限が指定されていない場合でも、ユーザーのセキュリティ・グループにより継承されるすべての権限を戻します。 |
List[] getPermissions(List[], Account account, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] |
Account accountで指定するユーザーのアクセス制御リストを指定します。 |
|
Account account |
ACLの権限を検索する対象となるユーザーの名前を指定します。ユーザーの名前またはGUIDを指定できます。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
AccessControlToken構造体のpermissionMaskフィールドにある権限情報を戻します(詳細は、第2.1項「AccessControlToken構造体」を参照してください)。
このメソッドを使用して、カタログ・グループがユーザーまたはグループのメンバーであるかを確認します。
boolean isMember(List[] group, List[] member, Boolean expandGroups, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] group |
ユーザー名、カタログ・グループ、またはアプリケーション・ロール名を指定します。 |
|
List[] member |
検証するメンバーの名前を指定します。たとえば、isMember(BIAdministrator, Administrator, false)という例を考えます。この例は、ユーザーAdministratorがBIAdministratorアプリケーション・ロールのメンバーであるかどうかを確認します。 |
|
Boolean expandGroups |
指定 .... |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ・グループにメンバーとして参加します。
void joinGroups(List[] group, List[] member, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] group |
参加する、またはメンバーとなるグループ名を指定します。たとえば、join(Marketing, UserA)という例を考えます。この例は、UserAがMarketingカタログ・グループに参加することを示しています。 |
|
List[] member |
ベースとなるメンバーの名前を指定します。詳細は、この前の引数の例を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ内のユーザー・アカウントの名前を変更します。
void renameAccounts(List[] from, List[] to, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] from |
アカウントの変更前の名前を指定します。 |
|
List[] to |
アカウントの新しい名前を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、グローバル権限のアクセス制御リストを更新します。
void updateGlobalPrivilegeACL(String privilegeName, ACL acl, UpdateACLParams updateACLParams, String sessionID);
| 引数 | 説明 |
|---|---|
|
String privilegeName |
更新する権限の名前を指定します。 |
|
ACL acl |
更新するアクセス制御リストを指定します。これはACL構造体で提供されます。ACL構造体の詳細は、第2.3項「ACL構造体」を参照してください。 |
|
UpdateACLParams updateACLParams |
更新するアクセス制御リストのパラメータを指定します。これはUpdateACLParams構造体で提供されます。UpdateACLParams構造体の詳細は、第2.28項「UpdateACLParams構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、カタログのナビゲートおよび管理を行うメソッドを提供し、XML形式でカタログ・オブジェクトを読み書きします。表3-16 に、サポートされるメソッドを示します。
表3-16 WebCatalogServiceのメソッド
| メソッド名 | 説明 |
|---|---|
|
|
カタログ内のある場所から別の場所へオブジェクトをコピーします。 |
|
|
カタログからアーカイブ・ファイルを生成します。 |
|
|
カタログに新しいフォルダを作成します。 |
|
|
カタログへのリンクを作成します。 |
|
|
カタログからオブジェクトを削除します。 |
|
|
オブジェクトのカタログ情報を取得します。 |
|
|
カタログ内のオブジェクトの子サブ項目のコレクションを取得します。 |
|
第3.10.10項「maintenanceMode()メソッド」 |
メンテナンスの間、カタログをロックします。 |
|
|
カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。 |
|
|
コピーした項目を貼り付けます。 |
|
|
カタログからオブジェクトを読み取ります。 |
|
|
カタログからフォルダを削除します。 |
|
第3.10.15項「setItemAttributes()メソッド」 |
指定したカタログ項目の属性フラグを設定します。 |
|
第3.10.16項「setItemProperty()メソッド」 |
カタログ内のオブジェクトのプロパティを設定します。 |
|
|
指定した項目の所有権を取得します。 |
|
第3.10.18項「updateCatalogItemACL()メソッド」 |
カタログ内の項目のアクセス制御リストを更新します。 |
|
|
オブジェクトのリストをカタログに書き込みます。 |
この列挙では、「WebCatalogServiceサービス」内のメソッドの有効な値のリストを指定します。表3-17に、この列挙の値をリストします。
|
注意: ErrorDetailsLevelの1つの値のみが選択されます。 |
この列挙では、「WebCatalogServiceサービス」内のメソッドの有効な値のリストを指定します。表3-18に、この列挙の値をリストします。
表3-18 ReadObjectsReturnOptionsの列挙値
| 値 | 説明 |
|---|---|
|
String NoObject |
catalogObjectフィールドおよびcatalogObjectBytesフィールドにデータを移入しないことを指定します。 |
|
String ObjectAsString |
catalogObjectフィールドにはデータを移入し、catalogObjectBytesフィールドにはデータを移入しないことを指定します。 |
|
String ObjectAsBinary |
catalogObjectフィールドにはデータを移入せず、catalogObjectBytesフィールドにはデータを移入することを指定します。 |
|
String ObjectAsBinaryUseMtom |
catalogObjectフィールドにはデータを移入せず、catalogObjectBytesにはデータを移入し、SOAPメッセージが戻すコンテンツをMTOMを使用してエンコードすることを指定します。 |
このメソッドを使用して、カタログ内のある場所からそのカタログ内の別の場所にオブジェクトをコピーします。
void copyItem(String pathSrc, String pathDest, int flagACL, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pathSrc |
カタログ内のオブジェクトへの現在のパスを指定します。 |
|
String pathDest |
カタログ内のオブジェクトをコピーする場所を指定します。 |
|
int flagACL |
セキュリティとともに項目をコピーするかどうかを指定します。0は、セキュリティなしで項目をコピーすることを示します。1は、セキュリティとともに項目をコピーすることを示します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログからアーカイブ・ファイルを生成します。
DataHandler copyItem2(List[] path, boolean recursive, boolean permissions, boolean timestamps, boolean useMtom, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] path |
カタログ内のアーカイブの作成元の場所を指定します。 |
|
boolean recursive |
子レベルのフォルダをアーカイブに含めるかどうかを指定します。 |
|
boolean permissions |
項目をセキュリティとともにコピーするかどうかを指定します。 |
|
boolean timestamps |
項目のタイムスタンプを保存するかどうかを指定します。 |
|
boolean useMtom |
SOAPメッセージにより戻されたコンテンツのエンコードにMTOMを使用するかどうかを指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログに新しいフォルダを作成します。
void createFolder(String path, boolean createIfNotExists, boolean createIntermediateDirs, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内のフォルダを作成する場所を、新しいフォルダ名を含めて指定します。 |
|
boolean createIfNotExists |
TRUEに設定されている場合、カタログ内にフォルダ・オブジェクトが存在しなければ、これを作成します。FALSEに設定されている場合、フォルダ・オブジェクトがすでに存在するならば、これを再作成しません。 |
|
boolean createIntermediateDirs |
TRUEに設定されている場合、中間ディレクトリが作成されます。FALSEに設定されている場合、中間ディレクトリは作成されません。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログへのリンクを作成します。
void createLink(String path, String pathTarget, boolean overwriteIfExists, String sessionID);
| 引数 | 説明 |
|---|---|
|
String Path |
カタログ内の親オブジェクトへのパスを指定します。 |
|
String TargetPath |
カタログ内で、作成するリンクが参照する場所を指定します。 |
|
boolean overwriteIfExists |
TRUEに設定されている場合、カタログ内にリンクがすでに存在するならば、これをオーバーライドします。FALSEに設定されている場合、カタログ内にリンクがすでに存在するならば、これをオーバーライドしません。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログからオブジェクトを削除します。フォルダを削除するには、第3.10.14項「removeFolder()メソッド」を参照してください。
このメソッドを使用して、オブジェクトのカタログ情報を取得します。
ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内のオブジェクトへのパスを指定します。 |
|
boolean resolveLinks |
TRUEに設定され、カタログ内のパスがリンクを参照する場合、Oracle Business Intelligenceは、リンクが指すオブジェクトの情報を取得します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ内のオブジェクトの子サブ項目のコレクションを取得します。
List[] getSubItems(String path, String mask, boolean resolveLinks, GetSubItemsParams options, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内の親オブジェクトへのパスを指定します。 |
|
String mask |
取得する子サブ項目を示すマスクを指定します。マスク文字はアスタリスク(*)です。すべての子サブ項目を取得するには、アスタリスク1つを使用します。 |
|
boolean resolveLinks |
TRUEに設定され、カタログ内のパスがリンクを参照する場合、リンクが指すオブジェクトの子サブ項目の情報が取得されます。 |
|
GetSubItemsParams options |
オプション。GetSubItemsParams構造体に提供するパラメータを指定します。GetSubItemsParams構造体の詳細は、第2.9項「GetSubItemsParams構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。
void moveItem(String pathSrc, String pathDest, int flagACL, String sessionID);
| 引数 | 説明 |
|---|---|
|
String pathSrc |
カタログ内のオブジェクトへの現在のパスを指定します。 |
|
String pathDest |
カタログ内のオブジェクトを移動する場所を指定します。 |
|
int flagACL |
セキュリティとともに項目を移動するかどうかを指定します。0は、セキュリティなしで項目を移動することを示します。1は、セキュリティとともに項目を移動することを示します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、コピーした項目を貼り付けます。
void pasteItem2(Binary stream DataHandler archive, String replacePath, int flagACL, int flagOverwrite, String sessionID);
| 引数 | 説明 |
|---|---|
|
Binary stream DataHandler archive |
戻される項目のコンテンツを文字列またはバイトとして指定します。このフィールドで何を指定するかは、readObjectsメソッドにより決定されます。 |
|
String replacePath |
コピーした項目を貼り付ける場所を指定します。 |
|
int flagACL |
セキュリティとともに項目を貼り付けるかどうかを指定します。0は、セキュリティなしで項目を貼り付けることを示します。1は、セキュリティとともに項目を貼り付けることを示します。 |
|
int flagOverwrite |
貼り付ける項目が既存の項目をオーバーライドするかどうかを指定します。0は、すべて置換することを示し、1は、古い項目を置換することを示し、2は、何も置換しないことを示し、3は、強制置換を示します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログからオブジェクトを読み込み、CatalogObject構造体を戻します。
List[] readObjects(List[] paths, boolean resolveLinks, ErrorDetailsLevel errorMode, ReadObjectsReturnOptions returnOptions, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] paths |
カタログ内のオブジェクトの場所を指定します。 |
|
boolean resolveLinks |
TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。 |
|
ErrorDetailsLevel errorMode |
CatalogObjects構造体のerrorInfoフィールドのエラー情報の量を指定します。詳細は、第2.7項「CatalogObject構造体」を参照してください。 |
|
ReadObjectsReturnOptions returnOptions |
有効な値のリストを指定します。詳細は、「ReadObjectsReturnOptionsの列挙」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、フォルダとそのコンテンツをカタログから削除します。フォルダとそのコンテンツ以外のオブジェクトを削除するには、 第3.10.7項「deleteItem()メソッド」を参照してください。
void removeFolder(String path, boolean recursive, String sessionID);
| 引数 | 説明 |
|---|---|
|
String path |
カタログ内のフォルダへのパスを指定します。 |
|
boolean recursive |
TRUEに設定されている場合、指定したフォルダとそのコンテンツを削除します。FALSEに設定されている場合は、指定したフォルダが空の場合のみそのフォルダを削除し、空でなければ、例外メッセージを表示します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定したカタログ項目の属性フラグを設定します。
void setItemAttributes (List[] path, int value, int valueOff, boolean recursive, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] path |
カタログ内のフォルダへのパスを指定します。 |
|
int attributes |
次のフラグの組合せを指定します。 1 = 読取りのみ 2 = アーカイブ 4 = 非表示 8 = システム |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ内のオブジェクトのプロパティを設定します。
void setItemProperty(List[] path, List[] name, List[] value, boolean recursive, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] path |
カタログ内のオブジェクトへのパスを指定します。 |
|
List[] name |
設定するプロパティの名前を指定します。 |
|
List[] value |
プロパティの新しい設定を指定します。 |
|
boolean recursive |
サブディレクトリ内の項目のプロパティを設定するかどうかを指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、指定した項目の所有権を取得します。
void setOwnership(List[]path, Account owner, boolean recursive, String sessionID);
| 引数 | 説明 |
|---|---|
|
List[] path |
カタログ内の所有権を取得するオブジェクトの場所を指定します。 |
|
Account owner |
所有者として割り当てるアカウントを指定します。 |
|
boolean recursive |
TRUEに設定されている場合、このアクションを指定したフォルダとそのコンテンツに適用します。FALSEに設定されている場合は、指定したフォルダが空の場合のみ、そのフォルダにこのアクションを適用し、空でなければ、例外メッセージを表示します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログ内の項目のアクセス制御リストを更新します。
void updateCatalogItemACL(List[] path, ACL acl, UpdateCatalogItemACLParams options, String sessionID);
| フィールド | 説明 |
|---|---|
|
List[] path |
カタログ内のオブジェクトへのパスを指定します。 |
|
ACL acl |
アクセス制御リストを指定します。詳細は、第2.3項「ACL構造体」を参照してください。 |
|
UpdateCatalogItemACLParams options |
追加パラメータを指定します。詳細は、第2.29項「UpdateCatalogItemACLParams構造体」を参照してください。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このメソッドを使用して、カタログにオブジェクトの配列を書き込みます。
List[] writeObjects(List[] catalogObjects, boolean allowOverwrite, boolean createIntermediateDirs, ErrorDetailsLevel errorMode, String sessionID);
| 引数 | 説明 |
|---|---|
|
List [] catalogObjects |
カタログに書き込むオブジェクトを指定します。これはCatalogObject構造体で提供されます。CatalogObject構造体の詳細は、第2.7項「CatalogObject構造体」を参照してください。 オブジェクトに適用される項目プロパティの配列を除く、object.itemInfoのすべてのフィールドが無視されます。生成されるドキュメントのシグネチャは常にCOXmlDocument1となります。 |
|
boolean allowOverwrite |
TRUEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされます。FALSEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされません。 |
|
boolean createIntermediateDirs |
TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。 |
|
ErrorDetailsLevel errorMode |
CatalogObjects構造体のerrorInfoフィールドのエラー情報の量を指定します。 |
|
String sessionID |
セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。 |
このサービスを使用して、Oracle BI EEプレゼンテーション・サービスから結果をXML形式で取得します。表3-19に、サポートされるメソッドを示します。
表3-19 XMLViewサービス・メソッド
| メソッド名 | 説明 |
|---|---|
|
|
現在の問合せを取り消します。 |
|
第3.11.3項「executeSQLQuery()メソッド」 |
SQL問合せを実行します。 |
|
第3.11.4項「executeXMLQuery()メソッド」 |
XML問合せを実行します。 |
|
|
データ行の次のページを戻します。 |
|
第3.11.6項「getPromptedFilters()メソッド」 |
プロンプト・フィルタのある分析の列のみを含むフィルタXML構造体を戻します。 |
|
|
リクエストしたオブジェクトのアップグレード・バージョンを戻します。 |
この列挙では、executeSQLQuery()メソッドおよびexecuteXMLQuery()メソッドの有効な値のリストを指定します。たとえば、データ行とメタデータ、あるいはデータ行のみを戻すことができます。表3-20に、この列挙の値をリストします。
|
注意: XMLQueryOutputFormatの1つの値のみを選択できます。 |
このメソッドを使用して、問合せを取り消し、その問合せに関連付けられたリソースをクリーンアップします。このメソッドは、問合せの行セットが、戻されたデータセットの最後の行までスクロールされない場合にのみ使用されます。
|
注意: 戻されたデータセットで、問合せ行セットが最後の行までスクロールされるときに、このメソッドを使用すると、問合せデータは、最後のfetchNextメソッドが起動される際にクリーンアップされます。 |
このメソッドを使用して、SQL問合せを実行し、その問合せの結果を戻します。
QueryResults executeSQLQuery(String sql, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, String sessionID);
| 引数 | 説明 |
|---|---|
|
String sql |
実行するSQLコードの文字列を指定します。 |
|
XMLQueryOutputFormat outputFormat |
出力形式を指定します(詳細は、第2.31項「XMLQueryExecutionOptions構造体」を参照してください)。 |
|
XMLQueryExecutionOptions executionOptions |
問合せ実行オプションを指定します(詳細は、第2.31項「XMLQueryExecutionOptions構造体」を参照してください)。 |
|
String sessionID |
セッションの一意のIDを指定します。 |
このメソッドを使用して、XML問合せを実行し、その問合せの結果を戻します。
QueryResults executeXMLQuery(ReportRef report, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, ReportParams reportParams, String sessionID);
| 引数 | 説明 |
|---|---|
|
ReportRef reportRef |
ReportRef共通構造体で提供される分析定義を指定します。 |
|
XMLQueryOutputFormat outputFormat |
出力形式を指定します(詳細は、第2.31項「XMLQueryExecutionOptions構造体」を参照してください)。 |
|
XMLQueryExecutionOptions executionOptions |
問合せ実行オプションを指定します(詳細は、第2.31項「XMLQueryExecutionOptions構造体」を参照してください)。 |
|
ReportParams reportParams |
オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。ReportParams構造体の詳細は、第2.17項「ReportParams構造体」を参照してください。 |
|
String sessionID |
セッションの一意のIDを指定します。 |
このメソッドを使用して、問合せで取得した行の次のページを戻します。
|
注意: 戻されたページには、行が含まれていない場合があります。完了フラグが設定されていない場合、残りの行は即座に使用できない場合があります。 |
QueryResults fetchNext(String queryID, String sessionID);
| 引数 | 説明 |
|---|---|
|
String queryID |
一意の問合せIDを指定します。これはQueryResultsオブジェクトで戻されます。 |
|
String sessionID |
セッションの一意のIDを指定します。 |
このメソッドを使用して、保存された分析のプロンプト列または、分析のXML定義からのプロンプト列を取得します。プロンプト列を含む分析を作成するには、これに isPrompted演算子を割り当てる必要があります。
このメソッドを使用して、カタログ外のOracle BI EEオブジェクトをアップグレードします。このメソッドでは、オブジェクトをOracle BI EE 10gからOracle BI EE 11gにアップグレードします。このメソッドは、主にOracle BIのMicrosoft Office用アドインに使用し、カタログではなくOracle BI Office内に保存されている分析をアップグレードします。Oracle BI Officeカタログ内のオブジェクトをアップグレードする場合のみ、このメソッドを使用する必要があります。
executeXmlQueryなどのメソッドを使用し、ReportRef引数によりOracle BI EE 10gレポート定義を渡す場合、そのレポートは問合せが実行される前にアップグレードされます。
