3 Oracle BI EE Webサービスで使用するサービスとメソッドについて

この章では、Oracle Business IntelligenceのセッションベースWebサービスで使用するサービスおよびメソッドについて説明します。

このドキュメントでは、JavaScriptに類似した構文を使用して構造体を表現します。正確な構文および実装は、アプリケーション開発環境で使用されるSOAPコード生成ツールおよびターゲット言語により異なります。

この章の内容は次のとおりです。

AnalysisExportViewsサービス
ConditionServiceサービス
HtmlViewServiceサービス
iBotServiceサービス
JobManagementServiceサービス
KPIAssessmentServiceサービス
MetadataServiceサービス
ReportEditingServiceサービス
SAWSessionServiceサービス
SchedulerServiceサービス
ScorecardAssessmentServiceサービス
ScorecardMetadataServiceサービス
SecurityServiceサービス
UserPersonalizationServiceサービス
WebCatalogServiceサービス
XMLViewServiceサービス

3.1 AnalysisExportViewsサービス

このサービスを使用して分析レポートのエクスポートを開始し、PDF、MHTML、Excel 2007およびCSV形式でエクスポートされたファイルを取得します。

表3-1は、サポートされるメソッドを示しています。

表3-1 AnalysisExportViewsのメソッド

メソッド名	説明
第3.1.1項「initiateAnalysisExport ()メソッド」	分析のエクスポートされたファイルを開始および取得します。
第3.1.2項「completeAnalysisExport ()メソッド」	エクスポートされたファイルを取得します

3.1.1 initiateAnalysisExport ()メソッド

このメソッドを使用して、形式 - PDF、MHTML、Excel 2007、CSVで分析のエクスポートされたファイルを開始および取得します。

3.1.1.1 シグネチャ

initiateAnalysisExport(ReportRef reportRef, AnalysisExportOutputFormat outputFormat, AnalysisExportExecutionOptions executionOptions, ReportParams reportParams, String reportViewName, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
AnalysisExportOutputFormat outputFormat	選択できる次の出力形式のいずれかを指定します。 String PDF - PDF形式を指定します String MHTML - MHTML形式を指定します String Excel 2007 - Excel 2007形式を指定します String CSV - CSV形式を指定します
AnalysisExportExecutionOptions executionOptions	AnalysisExportExecutionOptions構造体の実行オプションを指定します。詳細は、次を参照してください。
ReportParams reportParams	実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。
String reportViewName	エクスポートするビューを指定します。このパラメータがnullの場合、分析のデフォルトのビューが使用されます。ビュー名は、分析XML定義でビューの識別に使用するビュー名と一致している必要があります。
String sessionID	セッションIDを指定します。

3.1.1.2 戻り値

AnalysisExportResult構造体で定義されている出力を返します。AnalysisExportResult構造体の詳細は、第2.7項「AnalysisExportResult構造体」を参照してください。

3.1.2 completeAnalysisExport ()メソッド

このメソッドを使用して、PDF、MHTML、Excel 2007またはCSV形式でエクスポートされたファイルを取得します。

3.1.2.1 シグネチャ

completeAnalysisExport(String queryID, String sessionID);

引数	説明
String queryID	initiateAnalysisExportメソッドによって戻された問合せIDを指定します。詳細は、第3.1.1項「initiateAnalysisExport ()メソッド」を参照してください。
String SessionID	一意のセッションIDを指定します。

3.1.2.2 戻り値

AnalysisExportResult構造体で定義されている出力を返します。AnalysisExportResult構造体の詳細は、第2.7項「AnalysisExportResult構造体」を参照してください。

3.2 ConditionServiceサービス

このサービスは、Oracle BI EEの条件をプログラムで評価するために使用します。このサービスでは、条件で使用できるカスタマイズ可能なフィルタを取得することもできます。

表3-2は、サポートされるメソッドを示しています。

表3-2 ConditionServiceのメソッド

メソッド名	説明
第3.2.1項「evaluateCondition()メソッド」	カタログに保存されている条件を評価します。
第3.2.2項「evaluateInlineCondition()メソッド」	パラメータとして指定された条件を評価します。
第3.2.3項「getConditionCustomizableReportElements()メソッド」	カタログに保存されている条件のカスタマイズ可能なフィルタを取得します。

3.2.1 evaluateCondition()メソッド

このメソッドを使用して、カタログに保存されている条件を評価します。このメソッドは、条件の結果(trueまたはfalse)を含むXML文字列を戻します。

3.2.1.1 シグネチャ

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に設定することができます。

3.2.2 evaluateInlineCondition()メソッド

このメソッドを使用して、Oracle BI EEプレゼンテーション・サービス外で定義された条件を評価します。条件XMLは、conditionXMLパラメータで指定されます。このメソッドは、条件評価の結果(trueまたはfalse)を含むXML文字列を戻します。

3.2.2.1 シグネチャ

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に設定することができます。

3.2.3 getConditionCustomizableReportElements()メソッド

このメソッドを使用して、カタログに格納されている条件で使用できるカスタマイズ可能なフィルタを判断します。このメソッドは、条件内で使用できるカスタマイズ可能なフィルタの定義を含むXML文字列を戻します。XMLは、orahome/bifoundation/web/schemas/analysis_customization.xsdで使用可能なカスタマイズ・スキーマに定義された形式です。

3.2.3.1 シグネチャ

String[] getConditionCustomizableReportElements(String path, String sessionID);

引数	説明
String path	カタログ内の条件のフルパスおよび名前を指定します。例: /users/jchan/Conditions/IsRegionUnderBudget
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.3 HtmlViewServiceサービス

このサービスを使用して、Oracle BI EE HTMLの結果をサード・パーティの動的Webページ(Active Server Pages (ASP)、JavaServer Pages (JSP)など)やポータル・フレームワークに埋め込みます。この埋込みプロセスにより、Oracle BI EEのWebサービス・コンテンツとサード・パーティのWebページのコンテンツがマージされます。

表3-3に、サポートされるメソッドを示します。

表3-3 HtmlViewServiceのメソッド

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

HTMLViewServiceサービスのメソッドは、サード・パーティのWebページに挿入できるHTMLコード部分を抽出します。表3-4では、HTMLコードの抜粋と適切なページ位置について説明します。

表3-4 HtmlViewServiceサービスのHTMLコード部分とページ位置

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

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

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

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

アクティブなドリルダウン・リンクを持つ分析を埋め込むため、HtmlViewServiceサービスでは、埋め込まれた分析からOracle BI EE Presentation Servicesサーバーへのコールバック・リクエストをWebブラウザが発行できます。リクエストを直接Oracle BI EEプレゼンテーション・サービス・サーバーにルーティングすることも可能ですが、多くの場合、当初サード・パーティのページを処理していたOracle BI EEインスタンスを介してリクエストをルーティングすることをお薦めします。また、Oracle BI EE Presentation Servicesとサード・パーティのWebサーバーが同じDomain Name Service (DNS)ドメインに属していない状況では、クロスドメイン・スクリプトに対するブラウザのセキュリティ制約に関連するJavaScriptエラーが生じる場合があります。

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

3.3.2 addReportToPage()メソッド

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

3.3.2.1 シグネチャ

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

引数	説明
String pageID	startPage()メソッドにより戻された文字列ページIDを指定します。startPage()メソッドの詳細は、第3.3.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.41項「QueryResults構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.3.3 endPage()メソッド

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

3.3.3.1 シグネチャ

void endpage(String pageID, String sessionID);

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

3.3.4 getCommonBodyHTML()メソッド

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

3.3.4.1 シグネチャ

String getCommonBodyHTML(String pageID, String sessionID);

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

3.3.4.2 戻り値

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

3.3.5 getHeadersHTML()メソッド

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

3.3.5.1 シグネチャ

String getHeadersHTML(String pageID, String sessionID);

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

3.3.5.2 戻り値

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

3.3.6 getHtmlforPageWithOneReport()メソッド

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

3.3.6.1 シグネチャ

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

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

3.3.7 getHTMLForReport()メソッド

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

3.3.7.1 シグネチャ

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

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

3.3.7.2 戻り値

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

3.3.8 setBridge()メソッド

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

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

3.3.8.1 シグネチャ

setBridge(String bridge, String sessionID);

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

3.3.8.2 使用方法

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

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

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

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

新しいコールバック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

3.3.9 startPage()メソッド

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

3.3.9.1 シグネチャ

String startPage(StartPageParams options, String sessionID);

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

3.3.9.2 戻り値

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

3.4 iBotServiceサービス

このサービスを使用して、Oracle BI EEエージェントの保存、編集、削除、登録、登録解除、カスタマイズ、および実行を行います。Oracle Business Intelligence 11g (11.1.1) リリース以降、iBotsという名前はエージェントに変更されました。

表3-5は、サポートされるメソッドを示しています。

表3-5 iBotServiceのメソッド

メソッド名	説明
第3.4.1項「writeIBot()メソッド」	新しいエージェントをカタログに書き込み、これをOracle BIスケジューラに登録します。
第3.4.2項「deleteIBot()メソッド」	エージェントをカタログから削除し、Oracle BIスケジューラから登録解除します。
第3.4.3項「executeIBotNow()メソッド」	カタログに保存されているエージェントを実行します。
第3.4.4項「moveIBot()メソッド」	エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。
第3.4.5項「sendMessage()メソッド」	Oracle BI EEのユーザー、グループ、またはその両方に、メッセージを送信します。
第3.4.6項「subscribe()メソッド」	公開されているエージェントに登録します。登録のカスタマイズも行います。
第3.4.7項「unsubscribe()メソッド」	エージェントから登録解除します。

3.4.1 writeIBot()メソッド

このメソッドを使用して、新しいエージェントをカタログに書き込み、これをOracle BIスケジューラに登録します。このメソッドは、カタログへの書込みのみを行う、WebCatalogServiceサービスの「writeObjects()メソッド」とは異なります。

3.4.1.1 シグネチャ

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に設定することができます。

3.4.2 deleteIBot()メソッド

このメソッドを使用して、保存されているエージェントを削除します。エージェントを削除すると、カタログからこれ(オブジェクト)が削除されるだけでなく、Oracle BIスケジューラからエージェントが登録解除されます。このメソッドは、「WebCatalogServiceサービス」のdeleteitemメソッドとは異なります。deleteitemメソッドの場合、エージェントはOracle BIスケジューラから登録解除されません。

3.4.2.1 シグネチャ

void deleteIBot (String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。例: /users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.4.3 executeIBotNow()メソッド

このメソッドを使用して、カタログに保存されているエージェントを実行します。このメソッドでは、エージェントの元のスケジュールは変更されません。

3.4.3.1 シグネチャ

void executeIBotNow(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。例: /users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.4.4 moveIBot()メソッド

このメソッドを使用して、エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。このメソッドは、「WebCatalogServiceサービス」のmoveItemメソッドとは異なります。moveItemメソッドの場合、カタログ・オブジェクトを移動し、さらにOracle BIスケジューラにオブジェクトが移動されたことを通知します。

3.4.4.1 シグネチャ

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に設定することができます。

3.4.5 sendMessage()メソッド

このメソッドを使用して、Oracle BI EEのユーザー、グループ、またはその両方にメッセージを送信します。メッセージは、対応する受信者の配信プロファイルに従って配信されます。このプロファイルは、Oracle BIプレゼンテーション・サービスの「マイ・アカウント」ダイアログで設定されたものです。

3.4.5.1 シグネチャ

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を指定します。この引数には、複数のグループを含めることができます。
String subject	メッセージの件名の行を指定します。
String body	メッセージの本文に含めるテキストを指定します。
String priority	メッセージの優先度を指定します。High、Normal、またはLowを指定できます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.4.6 subscribe()メソッド

このメソッドを使用して、公開されたエージェントに登録します。エージェントでカスタマイズが可能な場合、カスタマイズXMLも指定できます。

3.4.6.1 シグネチャ

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.4.7 unsubscribe()メソッド

このメソッドを使用して、エージェントから登録解除します。このメソッドでは、ユーザーのカスタマイズの削除も行います。

3.4.7.1 シグネチャ

void unsubscribe(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。例: /users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5 JobManagementServiceサービス

このサービスを使用して、マーケティング・セグメンテーションを実行し、生成機能をリストします。

表3-6は、サポートされるメソッドを示しています。

表3-6 JobManagementServiceのメソッド

メソッド名	説明
第3.5.1項「cancelJob()メソッド」	マーケティング・ジョブの実行を取り消します。
第3.5.2項「deleteResultSet()メソッド」	保存されている結果セットを削除します。
第3.5.3項「getCounts()メソッド」	セグメントまたはセグメント・ツリーのカウント数値を生成します。
第3.5.4項「getJobInfo()メソッド」	マーケティング・ジョブのステータスと詳細情報を取得します。
第3.5.5項「getPromptedColumns()メソッド」	セグメントまたはセグメント・ツリーのプロンプト列を戻します。
第3.5.6項「prepareCache()メソッド」	リスト・エクスポートのためのセグメントまたはセグメント・ツリーをキャッシュします。
第3.5.7項「purgeCache()メソッド」	キャッシュ全体、セグメントのエントリ、またはセグメント・ツリーのエントリをパージします。
第3.5.8項「saveResultSet()メソッド」	最近更新されたカウントに基づいてメンバーのリストを保存します。
第3.5.9項「writeListFiles()メソッド」	リスト・エクスポート、セグメント・キャンペーン・ロード、またはセグメント・ツリー・キャンペーン・ロードのリストを生成します。

3.5.1 cancelJob()メソッド

このメソッドを使用して、マーケット・ジョブの実行を取り消します。

3.5.1.1 シグネチャ

JobInfo cancelJob(BigInteger jobID, String sessionID);

引数	説明
BiInteger jobID	マーケティング・ジョブIDを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.2 deleteResultSet()メソッド

このメソッドを使用して、指定のセグメントに属するGUID値のリストによって識別されるターゲットレベルのオブジェクトの保存されている結果セットを、1つ以上削除します。

3.5.2.1 シグネチャ

JobInfo deleteResultSet(String targetLevel, ArrayOfGUIDs guiDs, String segmentPath, String sessionID);

引数	説明
String targetLevel	保存された結果セットのターゲット・レベルを指定します。
ArrayOfGUIDs guiDs	保存された結果セットを表すGUIDのリストを指定します。ArrayOfGUIDs構造体の詳細は、表2-8「ArrayofGUIDS構造体のフィールド」を参照してください。
String segmentPath	セグメントへのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.3 getCounts()メソッド

このメソッドを使用して、セグメントまたはセグメント・ツリーのカウント数値を生成します。

3.5.3.1 シグネチャ

JobInfo getCounts(String segmentPath, String treePath, SegmentationOptions segmentationOptions, String sessionID);

引数	説明
String segmentPath	セグメントへのパスを指定します。getCountsがセグメントで実行される際に使用されます。
String treePath	セグメント・ツリーへのパスを指定します。getCountsがセグメント・ツリーで実行される際に使用されます。
Segmentation Options	SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.56項「SegmentationOptions構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.4 getJobInfo()メソッド

このメソッドを使用して、マーケティング・ジョブのステータスと詳細なジョブ情報を取得します。

3.5.4.1 シグネチャ

JobInfo getJobInfo(BigInteger jobID, String sessionID);

引数	説明
BigInteger jobID	マーケティング・ジョブIDを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.5 getPromptedColumns()メソッド

このメソッドを使用して、セグメントまたはセグメント・ツリーのプロンプト列を戻します。

3.5.5.1 シグネチャ

PromptedColumnInfo getPromptedColumns(String segmentPath, String treePath, String sessionID);

引数	説明
String segmentPath	セグメントへのパスを指定します。getPromptedColumnsがセグメントで実行される際に使用されます。
String treePath	セグメント・ツリーへのパスを指定します。gePromptedColumnsがセグメント・ツリーで実行される際に使用されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.6 prepareCache()メソッド

このメソッドを使用して、リスト・エクスポートのためのセグメントまたはセグメント・ツリーをキャッシュします。

3.5.6.1 シグネチャ

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に設定することができます。

3.5.7 purgeCache()メソッド

このメソッドを使用して、キャッシュ全体のパージ、キャッシュからのセグメントのエントリのパージ、またはキャッシュからのセグメント・ツリーのエントリのパージを行います。

3.5.7.1 シグネチャ

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に設定することができます。

3.5.8 saveResultSet()メソッド

このメソッドを使用して、最近更新されたカウントに基づき、セグメントまたはセグメント・ツリーに対して修飾するメンバーのリストを保存します。システムでは、メンバーを抽出し、指定のセグメント・パスに保存します。

3.5.8.1 シグネチャ

JobInfo saveResultSet(String segmentPath, TreeNodePath treeNodePath, String savedSegmentPath, SegmentationOptions segmentationOptions, String srCustomLabel, Boolean appendStaticSegment, String sessionID);

引数	説明
String segmentPath	セグメントへのパスを指定します。
TreeNodePath treeNodePath	セグメント・ツリー・パスおよびブランチID番号を指定します。
String savedSegmentPath	システムが生成されたメンバーを抽出し、保存する新しいセグメントのパスと名前を指定します。
Segmentation Options segmentation Options	SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.56項「SegmentationOptions構造体」を参照してください。
String srCustomLabel	静的セグメント作成のためのカスタム・ラベルを指定します。
Boolean appendStaticSegment	保存された同じセグメント・パスの下に静的セグメント・エントリを作成するためのフラグを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.5.9 writeListFiles()メソッド

このメソッドを使用して、リスト・エクスポート、セグメント・キャンペーン・ロード、またはセグメント・ツリー・キャンペーン・ロードのリストを生成します。

3.5.9.1 シグネチャ

JobInfo writeListFiles(ReportRef report, ReportParams reportParams, String segmentPath, TreeNodePath treeNodePath, SegmentationOptions segmentationOptions, String filesystem, BigInteger timeout, String sessionID);

引数	説明
ReportRef report	ReportRef構造体で提供される、分析の参照定義を指定します。ReportRef構造体の詳細は、第2.50項「ReportRef構造体」を参照してください。
ReportParams reportParams	実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。ReportParams構造体の詳細は、第2.47項「ReportParams構造体」を参照してください。
String segmentPath	セグメントへのパスを指定します。
TreeNodePath treeNodePath	セグメント・ツリー・パスおよびブランチIDを指定します。
SegmentationOptions segmentationOptions	SegmentationOptions構造体で提供される、セグメントおよびセグメント・ツリーのオーバーライド・オプションを指定します。これらのオプションは、Oracle Marketing Analyticsのユーザー・インタフェースで指定したとおり、セグメントまたはセグメント・ツリーのデフォルトのかわりに使用されます。SegmentationOptions構造体の詳細は、第2.56項「SegmentationOptions構造体」を参照してください。
String filesystem	リスト・ファイルを含む共有ディレクトリへのパスを指定します。
BigInteger timeout	タイムアウト値を指定します。これは常に0に設定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.6 KPIAssessmentServiceサービス

このサービスを使用して、KPIを評価するメソッドを提供します。表3-7に、サポートされるメソッドを示します。

表3-7 KPIAssessmentServiceのメソッド

メソッド名	説明
第3.6.1項「executeKPI()メソッド」	指定したKPIのアセスメントをリクエストします。
第3.6.2項「executeKPIDimensionLOVQuery()メソッド」	指定したKPIのディメンションについて値のリストを取得します。
第3.6.3項「generateDrillTo()メソッド」	指定したKPIの詳細レポートが含まれるOracle Business Intelligenceレポートを生成します。
第3.6.4項「getKPIWatchlistDimensions()メソッド」	ウォッチリストのKPIで使用されるディメンションのリストを戻します。

3.6.1 executeKPI()メソッド

このメソッドを使用して、指定したKPIのアセスメントをリクエストします。

3.6.1.1 シグネチャ

KPIResultSet executeKPI(Array KPIRequests, Array KPIColumnNames, Array Variables, Boolean UseAsyncService, Boolean Fresh, String sessionID);

引数	説明
KPIRequest[] KPIRequests	アセスメントが必要なKPIを定義するKPIRequest構造体オブジェクトを指定します。詳細は、第2.30項「KPIRequest構造体」を参照してください。
String[] KPIColumnNames	KPIColumnName列挙からの文字列の配列を指定します。詳細は、第2.28項「KPIColumnName列挙」を参照してください。
Variable[] Variables	(オプション)問合せで適用するVariableオブジェクトの配列を指定します。詳細は、第2.64項「Variable構造体」を参照してください。
Boolean UseAsyncService	非同期バージョンのKPIアセスメント・サービスを使用するか(true)、否か(false)を指定します。
Boolean Fresh	(オプション)アセスメントを新たに取得するか(true)、キャッシュされた値で十分か(false)を指定します。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.6.2 executeKPIDimensionLOVQuery()メソッド

このメソッドを使用して、指定したKPIのディメンションについて値のリストを取得します。

3.6.2.1 シグネチャ

KPIDimensionLOVQueryResult KPIDimensionLOVQuery(Integer RowsPerFetch, String KPIPath, String DimensionID, String SessionID);

引数	説明
Integer RowsPerFetch	取得する値の最大数を指定します。
String KPIPath	関心のあるKPIへのカタログ・パスを指定します。
String DimensionID	関心のあるディメンションのIDを指定します。
String SessionID	SOAPリクエストで使用するSessionIDを指定します。 SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.6.3 generateDrillTo()メソッド

このメソッドを使用して、指定したKPIの詳細レポートが含まれるOracle Business Intelligenceレポートの生成を担うKPIエンジンのgenerateDrillTo Webサービス・メソッドをコールします。

3.6.3.1 シグネチャ

DrillToReportURLResult generateDrillTo(Object KpiRequest, String ReportPath, Array Variables, String sessionID);

引数	説明
Object KPIRequest	固定が含まれるKPIRequest構造体オブジェクトを指定します。詳細は、第2.30項「KPIRequest構造体」を参照してください。
String ReportPath	生成されたレポートの保存先となるプレゼンテーション・カタログ・パスを指定します。
Variable[] Variables	問合せで適用するVariableオブジェクトの配列を指定します。詳細は、第2.64項「Variable構造体」を参照してください。
String sessionID	SAWセッションIDを指定します。このパラメータは通常、セッションIDがCookieに格納されるため、省略できます。

3.6.4 getKPIWatchlistDimensions()メソッド

このメソッドを使用して、指定したKPIウォッチリストのKPIで使用されるディメンションのスーパーセットを取得します。

3.6.4.1 シグネチャ

KPIWatchlistDimensions KPIWatchlistDimensions(String WatchlistPath, String WatchListXML, Boolean GetFresh, Session sessionID);

引数	説明
String WatchlistPath	関心のあるKPIウォッチリストへのカタログ・パスを指定します。
String WatchListXML	保存されていないメタデータが含まれるKPIウォッチリスト・カタログXMLを指定します。
Session sessionID	(オプション) SAWセッションIDを指定します。このパラメータは通常、セッションIDがCookieに格納されるため、省略できます。

3.7 MetadataServiceサービス

このサービスを使用して、Oracle Business Intelligenceプレゼンテーション・サービスのスキーマ・オブジェクト(列、表、サブジェクト・エリアなど)の説明を取得します。

表3-8に、サポートされるメソッドを示します。

表3-8 MetadataServiceのメソッド

メソッド名	説明
第3.7.1項「clearQueryCache()メソッド」	問合せキャッシュを消去します。
第3.7.2項「describeColumn()メソッド」	指定したサブジェクト・エリアおよび表内の指定した列の列情報を取得します。
第3.7.3項「describeSubjectArea()メソッド」	指定したサブジェクト・エリアのサブジェクト・エリア情報を取得します。
第3.7.4項「describeSubjectAreaWithSort()メソッド」	指定したサブジェクト・エリアのサブジェクト・エリア情報を指定のソート順で取得します。
第3.7.5項「describeTable()メソッド」	指定したサブジェクト・エリア内の指定した表の表情報を取得します。
第3.7.6項「describeTableWithSort()メソッド」	指定したサブジェクト・エリア内の指定した表の表情報を指定の(名前の)ソート順で取得します。
第3.7.7項「getSubjectAreas()メソッド」	使用可能なサブジェクト・エリアのリストを取得します。
第3.7.8項「getSubjectAreasWithSort()メソッド」	使用可能なサブジェクト・エリアのリストを指定のソート順で取得します。
第3.7.9項「reloadLogConfiguration()メソッド」	Oracle BIプレゼンテーション・サービスを手動で再起動せずに、ロギング構成に対する変更を強制的に有効にします。
第3.7.10項「reloadMetadata()メソッド」	XMLメッセージ・ファイルを再ロードし、サーバー・メタデータをリフレッシュし、キャッシュをクリアします。

3.7.1 clearQueryCache()メソッド

このメソッドを使用して、問合せキャッシュを消去します。

3.7.1.1 シグネチャ

boolean clearQueryCache(String sessionID);

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

3.7.2 describeColumn()メソッド

このメソッドを使用して、指定したサブジェクト・エリアおよび表内の指定した列の列情報を取得します。

3.7.2.1 シグネチャ

SAColumn describeColumn(String subjectAreaName, String tableName, String columnName, String sessionID);

引数	説明
String subjectAreaName	問い合せるサブジェクト・エリアを指定します。
String tableName	問い合せる表を指定します。
String columnName	問い合せる列の名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.2.2 戻り値

SAColumnオブジェクトを戻します。SAColumn構造体の詳細は、第2.51項「SAColumn構造体」を参照してください。

3.7.3 describeSubjectArea()メソッド

このメソッドを使用して、指定したサブジェクト・エリアのサブジェクト・エリア情報を取得します。

3.7.3.1 シグネチャ

SASubjectArea describeSubjectArea (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);

引数	説明
String subjectAreaName	問い合せるサブジェクト・エリアを指定します。
SASubjectAreaDetails detailsLevel	取得するサブジェクト・エリアについての情報を指定します。SASubjectAreaDetails構造体の詳細は、第3.7.3.2項「SASubjectAreaDetailsの値」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.3.2 SASubjectAreaDetailsの値

このメソッドを使用して、サブジェクト・エリアについてどのような情報を取得するのかを指定します。表3-9に、使用できる値をリストします。

表3-9 SASubjectAreaDetailsの値

値	説明
IncludeTables	各表についての最小限の情報を記載した表リストを含めます。
IncludeTablesAndColumns	表および列の全情報を含めます。
Minimum	表および列の情報を含めません。

3.7.3.3 戻り値

SASubjectAreaオブジェクトを戻します(詳細は、第2.52項「SASubjectArea構造体」を参照してください)。

3.7.3.4 使用方法

detailsLevelパラメータの値に応じて、戻されるオブジェクトには、表3-10に示される情報が含まれます。

表3-10 detailsLevelの値

detailsLevelの値	説明
IncludeTables	表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトはnullに設定された列フィールドを含みます。
InludeTablesAndColumns	表フィールドがnullではなく、このサブジェクト・エリアの表のコレクションを含むことを指定します。各表オブジェクトに対し、列フィールドには対応する列のコレクションが含まれます。
Minimum	表リストが使用できないことを指定します。結果のサブジェクト・エリア・オブジェクトの表フィールドはnullです。

3.7.4 describeSubjectAreaWithSort()メソッド

このメソッドを使用して、指定したサブジェクト・エリアのサブジェクト・エリア情報を指定のソート順で取得します。

3.7.4.1 シグネチャ

SASubjectArea describeSubjectAreaWithSort (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);

引数	説明
String subjectAreaName	問い合せるサブジェクト・エリアを指定します。
SASubjectAreaDetails detailsLevel	取得するサブジェクト・エリアについての情報を指定します。SASubjectAreaDetails構造体の詳細は、第3.7.3.2項「SASubjectAreaDetailsの値」を参照してください。
String sortOrder	どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。
String sortOrderCaseSensitive	値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.4.2 戻り値

表が指定のソート順で戻されたSASubjectAreaオブジェクト(詳細は、第2.52項「SASubjectArea構造体」を参照)を戻します。

3.7.5 describeTable()メソッド

このメソッドを使用して、指定したサブジェクト・エリアの指定した表の表情報を取得します。

3.7.5.1 シグネチャ

SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sessionID);

引数	説明
String subjectAreaName	問い合せるサブジェクト・エリアを指定します。
String tableName	問い合せる表を指定します。
SATableDetails detailsLevel	取得する表の情報を指定します。SATableDetails構造体の詳細は、第3.7.5.2項「SATablesDetailsの値」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.5.2 SATablesDetailsの値

これを使用して、取得する表の情報を指定します。表3-11に、使用できる値をリストします。

表3-11 SATableDetailsの値

値	説明
IncludeColumns	SATableオブジェクトの列フィールドにデータを移入します。
Minimum	列情報は含まれません。SATableオブジェクトの列フィールドはnullに設定されます。

3.7.5.3 戻り値

SATableオブジェクトを戻します。SATable構造体の詳細は、第2.53項「SATable構造体」を参照してください。

3.7.6 describeTableWithSort()メソッド

このメソッドを使用して、指定した表の表情報を指定の(名前の)ソート順で取得します。

3.7.6.1 シグネチャ

SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);

引数	説明
String subjectAreaName	問い合せるサブジェクト・エリアを指定します。
String tableName	問い合せる表を指定します。
SATableDetails detailsLevel	取得する表の情報を指定します。SATableDetails構造体の詳細は、第3.7.5.2項「SATablesDetailsの値」を参照してください。
String sortOrder	どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。
String sortOrderCaseSensitive	値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.6.2 戻り値

列が指定のソート順のSATableオブジェクトを戻します。SATable構造体の詳細は、第2.53項「SATable構造体」を参照してください。

列タイプに対して固定の順序があります。この固定ソート順は次のとおりです。

ネストされたフォルダ
メジャー
属性
階層

3.7.7 getSubjectAreas()メソッド

このメソッドを使用して、使用可能なサブジェクト・エリアのリストを取得します。

3.7.7.1 シグネチャ

List[] getSubjectAreas(String sessionID);

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

3.7.7.2 戻り値

SASubjectAreaオブジェクトの配列を戻します。SASubjectArea構造体の詳細は、第2.52項「SASubjectArea構造体」を参照してください。

3.7.7.3 使用方法

このメソッドで戻されるSASubjectAreaには、使用できる表情報がありません。表フィールドはnullです。すべてのレベルで問合せを行うアプローチは、getSubjectAreas()を使用してサブジェクト・エリアのリストを取得した後、describeSubjectArea()を使用して表のリストを取得するものです。そして、describeTable()を使用して指定の表の列のリストを取得し、最後にdescribeColumn()を使用して指定の列の情報を取得します。

3.7.8 getSubjectAreasWithSort()メソッド

このメソッドを使用して、使用可能なサブジェクト・エリアのリストを指定のソート順で取得します。

3.7.8.1 シグネチャ

List[] getSubjectAreasWithSort(String sortOrder, String sortOrderCaseSensitive, String sessionID);

引数	説明
String sortOrder	どのソート順で結果を戻すかを指定します。指定可能な値は'asc'または'desc'です。'asc'はユーザーの現在の言語の昇順(たとえば、英語の場合はAからZ)で値を戻し、反対に'desc'は逆の順序(たとえば、英語の場合はZからA)で戻します。
String sortOrderCaseSensitive	値の大/小文字をソート時に考慮に入れる必要があるかどうかを指定します。指定可能な値は'caseSensitive'または'caseInsensitive'です。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.7.8.2 戻り値

指定のソート順で戻されたSASubjectAreaオブジェクトの配列を戻します。SASubjectArea構造体の詳細は、第2.52項「SASubjectArea構造体」を参照してください。

3.7.8.3 使用方法

このメソッドで戻されるSASubjectAreaには、使用できる表情報がありません。表フィールドはnullです。すべてのレベルで問合せを実行する方法では、getSubjectAreasWithSort()を使用してサブジェクト・エリアのリストを取得した後、describeSubjectAreaWithSort()を使用して表のリストを取得します。次にdescribeTableWithSort()を使用して指定の表の列のリストを取得し、最後にdescribeColumn()を使用して指定の列の情報を取得します。

3.7.9 reloadLogConfiguration()メソッド

このメソッドを使用して、Oracle BIプレゼンテーション・サービスを手動で再起動せずに、ロギング構成に対する変更を強制的に有効にします。

3.7.9.1 シグネチャ

boolean reloadLogConfiguration(String sessionID);

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

3.7.10 reloadMetadata()メソッド

このメソッドを使用して、XMLメッセージ・ファイルを再ロードし、サーバー・メタデータをリフレッシュし、キャッシュをクリアします。

3.7.10.1 シグネチャ

boolean reloadMetadata(String sessionID);

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

3.7.10.2 戻り値

操作が成功しているかどうかを示すブール値を返します。

3.8 ReportEditingServiceサービス

このサービスを使用して、引数とOracle Business Intelligenceプレゼンテーション・サービス・データをマージし、結果を作成して戻します。

表3-12に、サポートされるメソッドを示します。

表3-12 ReportEditingServiceのメソッド

メソッド名	説明
第3.8.1項「applyReportDefaults()メソッド」	分析のデフォルトの引数を分析に適用し、結果を戻します。
第3.8.2項「applyReportParams()メソッド」	レポートの引数を分析オブジェクトに適用し、結果を戻します。
第3.8.3項「getPromptElementsメソッド」	特定の分析の基準プロンプト列定義のリストおよび現在の実行時状態を取得します。
第3.8.4項「generateReportSQL()メソッド」	指定された分析に対するSQL問合せを取得します。
第3.8.5項「getReportColumnsメソッド」	分析の基準列のリストを取得します。
第3.8.6項「getReportElementsメソッド」	プロンプトのリスト、保護されていないフィルタおよび特定のレポートの参照されたプレゼンテーション変数を取得します。

3.8.1 applyReportDefaults()メソッド

このメソッドを使用して、分析のデフォルトの引数を分析に適用し、結果を戻します。

3.8.1.1 シグネチャ

String applyReportDefaults(ReportRef reportRefs, String sessionID);

引数	説明
ReportRef object	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.8.1.2 戻り値

デフォルトの分析引数を指定した分析オブジェクトに適用した結果を戻します。

3.8.2 applyReportParams()メソッド

このメソッドを使用して、分析引数を分析に適用し、結果を戻します。

3.8.2.1 シグネチャ

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に設定することができます。

3.8.2.2 戻り値

分析引数を指定した分析オブジェクトに適用した結果を戻します。encodeInStringをtrueに設定した場合、結果は文字列としてエンコードされます。

3.8.3 getPromptElementsメソッド

このメソッドを使用して、特定の分析の基準プロンプト列定義のリストおよび現在の実行時状態を取得します。

3.8.3.1 シグネチャ

getPromptElements(ReportRef promptRef, String viewState, String viewID, String portalPath, String page, NameValuePair optionalParams, String sessionID);

引数	説明
ReportRef promptRef	必須です。保存されたレポートまたはレポートXMLドキュメントへのカタログ・パスを指定します。
String viewState	オプション。実行時のviewStateを指定します。実行時プロンプト定義は、ビューのviewStateを設定する他のプロンプトに基づいて変更される場合があります。
String viewID	オプション: ビューIDを指定します
String portalPath	オプション: レポートが存在するダッシュボード・カタログ・パスを指定します。
String page	オプション: レポートが存在するダッシュボード・ページ名を指定します。
NameValuePair optionalParams	オプション: 通常デバッグ目的で使用される追加パラメータの名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.8.3.2 戻り値

レポート・プロンプト列のセット。「PromptsObjectModel構造体」を参照してください。

3.8.4 generateReportSQL()メソッド

このメソッドを使用して、指定した分析に対する論理SQL問合せを取得します。

3.8.4.1 シグネチャ

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.8.4.2 戻り値

指定した分析のSQL問合せを含む文字列。

3.8.5 getReportColumnsメソッド

このメソッドを使用して、特定の分析の基準列のリストを取得します。

3.8.5.1 シグネチャ

ReportColumn[] getReportElements(String reportPath, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.8.5.2 戻り値

ReportColumn[] - レポートの列の配列。第2.48項「ReportHierarchicalColumn」および第2.49項「ReportRegularColumn」を参照してください。

3.8.6 getReportElementsメソッド

このメソッドを使用して、すべてのレポート・プロンプトのリスト、保護されていないフィルタおよび特定のレポートの参照されたプレゼンテーション変数を取得します。

3.8.6.1 シグネチャ

String getReportElements(String reportPath, String sessionID);

引数	説明
String reportPath	必須です。レポートのレポート・カタログ・パスを指定します。
String sessionID	オプション。セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.8.6.2 戻り値

存在する場合、次にリストされた順序で次のオブジェクトのADFパラメータをレポートします。

プロンプト
保護されていないフィルタ
レポートで参照されたプレゼンテーション変数
Oracle Business Intelligenceプレゼンテーション・サービスで参照されたコンテキスト変数

「ReportADFParameters構造体」も参照してください。

3.9 SAWSessionServiceサービス

このサービスを使用して、ログオンやログオフなどの認証メソッド、およびその他のセッション関連のメソッドを提供します。

表3-13は、サポートされるメソッドを示しています。

表3-13 SAWSessionServiceのメソッド

メソッド名	説明
第3.9.1項「getCurUser()メソッド」	セッションの現行ユーザーIDを取得します。
第3.9.2項「GetSessionEnvironment()メソッド」	現行セッションの環境オブジェクトを取得します。
第3.9.3項「getSessionVariable()メソッド」	セッション変数のリストを取得します。
第3.9.4項「impersonate()メソッド」	ログオンしてユーザーを偽装します。
第3.9.5項「impersonateex()メソッド」	ログオンしてユーザーを偽装します。impersonateメソッドと類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。
第3.9.6項「keepAlive()メソッド」	Oracle Business Intelligenceプレゼンテーション・サービスに、特定のセッションが非アクティブであっても終了させないよう指示します。
第3.9.7項「logoff()メソッド」	ユーザーをOracle Business Intelligenceプレゼンテーション・サービスからログオフさせます。
第3.9.8項「logon()メソッド」	ユーザーを認証します。
第3.9.9項「logonex()メソッド」	ユーザーを認証します。logonメソッドと類似していますが、logonexではオプションのセッション・パラメータを指定できます。

3.9.1 getCurUser()メソッド

このメソッドを使用して、セッションの現行ユーザー名を取得します。

3.9.1.1 シグネチャ

String getCurUser(String sessionID);

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

3.9.1.2 戻り値

セッションの現行ユーザー名を示す文字列を戻します。

3.9.2 GetSessionEnvironment()メソッド

このメソッドを使用して、現行セッションの環境オブジェクトを取得します。

3.9.2.1 シグネチャ

SessionEnvironment getSessionEnvironment (String sessionID);

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

3.9.2.2 戻り値

このメソッドは、セッション環境オブジェクトを戻します(詳細は、第2.57項「SessionEnvironment構造体」を参照してください)。

3.9.3 getSessionVariable()メソッド

このメソッドを使用して、セッション変数のリストを取得します。

3.9.3.1 シグネチャ

List[] getSessionVariables(List[] names, String sessionID);

引数	説明
List[] names	セッション変数の名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.9.3.2 戻り値

このメソッドは、現行セッションに関連付けられたOracle BI EE変数の値を戻します。

3.9.4 impersonate()メソッド

このメソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonate()メソッドを使用する場合、logonメソッドを使用する必要はありません。

ユーザー認証または偽装に失敗した場合、例外がスローされます。

3.9.4.1 シグネチャ

String impersonate(String name, String password, String impersonateID);

引数	説明
String name	ログオンし、認証を行うユーザー名を指定します。
String password	ユーザーのパスワードを指定します。ユーザーにパスワードがない場合、このフィールドは空(void)にします。
String impersonateID	認証対象となるユーザーを偽装するユーザー名を指定します。

3.9.4.2 戻り値

このメソッドは、セッションIDを戻し、HTTPセッションのCookieを設定します。セッションIDは、別のメソッドでOracle Business Intelligence Webサービスのセッションの識別に使用されます。

3.9.5 impersonateex()メソッド

このメソッドを使用し、SAWSessionServiceサービス中にログオンしてユーザーを偽装します。impersonateメソッドに類似していますが、impersonateexではオプションのセッション・パラメータを指定できます。このメソッドは、管理者の名前とパスワードのみを持っていて、複数のユーザーのセッションを作成する必要がある場合に便利です。impersonateex()メソッドを使用する場合、logonメソッドを使用する必要はありません。

ユーザー認証または偽装に失敗した場合、例外がスローされます。

3.9.5.1 シグネチャ

AuthResults impersonateex(String name, String password, String impersonateID, SAWSessionParameters sessionparams);

引数	説明
String name	ログオンし、認証を行うユーザー名を指定します。
String password	ユーザーのパスワードを指定します。ユーザーにパスワードがない場合、このフィールドは空(void)にします。
String impersonateID	認証対象となるユーザーを偽装するユーザー名を指定します。
SAWSessionParameters sessionparams	オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、第2.55項「SAWSessionParameters構造体」を参照してください。

3.9.5.2 戻り値

このメソッドは、セッションIDを含むAuthResult構造体を戻し、HTTPセッションのCookieを設定します。セッションIDは、別のメソッドでOracle Business Intelligenceプレゼンテーション・サービス・セッションの識別に使用されます。詳細は、第2.10項「AuthResult構造体」を参照してください。

3.9.6 keepAlive()メソッド

このメソッドを使用して、Oracle BI EE Presentation Servicesに、特定のWebユーザーが非アクティブであっても終了しないよう指示します。セッション存続期間におけるこのメソッドの効果は、ユーザーがブラウザでアクティビティを実行した(分析のクリック、メソッドの起動など)場合と同様です。

3.9.6.1 シグネチャ

void keepAlive(String[] sessionID);

引数	説明
String[] sessionID	ログオン状態のままにするセッションIDを指定します。

3.9.7 logoff()メソッド

このメソッドを使用して、ユーザーをOracle BI EEプレゼンテーション・サービスからログオフさせます。

3.9.7.1 シグネチャ

void logoff(String sessionID);

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

3.9.8 logon()メソッド

このメソッドを使用して、ユーザーを認証します。認証に失敗した場合、例外がスローされます。

3.9.8.1 シグネチャ

String logon(String name, String password);

引数	説明
String name	認証を行うユーザー名を指定します。
String password	ユーザーのパスワードを指定します。パスワードがない場合、このフィールドは空(void)にします。

3.9.8.2 戻り値

このメソッドは、セッションIDを戻し、HTTPセッションのCookieを設定します。セッションIDは、別のメソッドでOracle BI EEプレゼンテーション・サービスのセッションの識別に使用されます。

3.9.9 logonex()メソッド

このメソッドを使用して、ユーザーを認証します。logonメソッドと類似していますが、logonexではオプションのセッション・パラメータを指定できます。認証に失敗した場合、例外がスローされます。

3.9.9.1 シグネチャ

AuthResult logonex(String name, String password, SAWSessionParameters sessionparams);

引数	説明
String name	認証を行うユーザー名を指定します。
String password	ユーザーのパスワードを指定します。パスワードがない場合、このフィールドは空(void)にします。
SAWSessionParameters sessionparams	オプション。使用するセッション・パラメータを指定します。これはSAWSessionParameters構造体で提供されます。SAWSessionParameters構造体の詳細は、第2.55項「SAWSessionParameters構造体」を参照してください。

3.9.9.2 戻り値

このメソッドは、セッションIDを含むAuthResult構造体を戻し、HTTPセッションのCookieを設定します。セッションIDは、別のメソッドでOracle Business Intelligenceプレゼンテーション・サービスのセッションの識別に使用されます。

3.10 SchedulerServiceサービス

次の語が、SchedulerServiceサービスに関連付けられています。

エージェント (またはiBot) - プレゼンテーション・サービス・カタログ・オブジェクトです。
Job - スケジューラ・オブジェクトです。エージェントには、BI_PLATFORMスキーマ内に格納された少なくとも1つのジョブがあります。
JobInstances - アクティブまたは完了したジョブを表すスケジューラ・オブジェクトです。BI_PLATFORMスキーマ内に格納されます。

このサービスを使用すると、スケジューラ・オブジェクトおよびジョブ・インスタンスの詳細の一覧を表示できます。また、ジョブ・インスタンスをパージおよび削除できます(ジョブを削除するとジョブ・インスタンスが自動的にパージされます)。エージェントを削除すると、自動的にジョブが削除されます。

このサービスを使用するには、ユーザー・セッションIDを取得する必要があります。これにより、ジョブまたはジョブ・インスタンスの参照IDの一覧が戻され、ジョブの詳細を取得または削除するために使用します。SAWセッション・サービスのlogon()メソッドを使用して、ユーザー・セッションIDを取得してください(詳細は、第3.9.8項「logon() Method」を参照)。次に、フィルタを適用して、個別のジョブ参照IDおよびジョブ・インスタンスIDを指定します。

SchedulerServiceサービス・メソッドの使用方法の例は、第3.10.8項「SchedulerService APIの使用方法の例」を参照してください。

クライアントには、Access SOAP権限およびAccess SchedulerService Service権限が付与されている必要があります。これにより、SchedulerServiceサービスAPI内のメソッドをコールできます。これらの権限は、デフォルトでBIConsumerアプリケーション・ロールに付与されます。これらの権限は、プレゼンテーション・サービスの「管理」にある「権限の管理」ページを使用して管理します。詳細は、『Oracle Fusion Middleware Oracle Business Intelligence Enterprise Editionセキュリティ・ガイド』内のプレゼンテーション・サービス管理の使用に関する項を参照してください。

この項で説明するメソッドは、特に明記のないかぎり、同期します。

表3-5は、サポートされるメソッドを示しています。

表3-14 SchedulerServiceのメソッド

メソッド名	説明
第3.10.1項「getJobReferences()メソッド」	指定されたフィルタ引数内の選択基準に一致するジョブの一覧が戻されます。
第3.10.2項「getJobInstanceReferences()メソッド」	指定されたフィルタ引数内の選択基準に一致するジョブ・インスタンスの一覧を戻します。
第3.10.3項「getJob()メソッド」	指定されたジョブ参照のジョブ定義を戻します。
第3.10.4項「getJobInstance()メソッド」	指定されたジョブ参照のジョブ・インスタンスの詳細を戻します。
第3.10.5項「cancelJobInstance()メソッド」	指定されたジョブ参照のジョブ・インスタンスの実行の取消をリクエストします。
第3.10.6項「removeJobs()メソッド」	指定されたジョブ参照のジョブ定義の削除をリクエストします。
第3.10.7項「purgeJobInstances()メソッド」	指定されたジョブ参照の既存のジョブ・インスタンスのパージをリクエストします。

3.10.1 getJobReferences()メソッド

このメソッドを使用して、フィルタに基づきジョブ参照のリストを取得します。

戻された参照はライブではなく、ジョブまたはジョブ参照が削除されると無効化します。

3.10.1.1 シグネチャ

JobReference[] getJobReferences(List[] JobFilter, String SessionID);

引数

説明

List[] JobFilter

一致するジョブ参照を戻す選択基準です。空のJobFilterが、ジョブ参照のすべての結果に戻されます。フィルタは、ユーザーがコールするコンテキストに適用されます。つまり、ユーザーは、テナント内でジョブのリスニングに制限され、ジョブに対応するエージェントのプレゼンテーション・サービス・カタログ許可が必要ありません。

詳細は、第2.23項「JobFilter構造体」および第2.27項「JobReferenceAndInstanceReferences構造体」を参照してください。

String SessionID

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

3.10.2 getJobInstanceReferences()メソッド

このメソッドを使用して、ジョブ・インスタンスのリストを取得します。これは、実行中、取消済または完了済のジョブに対応しています。JobInstanceFilterには、1つ以上のジョブ参照が含まれている必要があります(不明なジョブ参照は無視されます)。

フィルタを満たすジョブ・インスタンスに関連付けられた各ジョブの一覧に構造体が戻されます。たとえば、メソッドが3つのジョブ参照を指定するJobInstanceFilterで起動され、2つのジョブがジョブ・インスタンスに関連付けられていることが判明した場合、2つのJobReferenceAndInstanceReferences構造体がリストに戻されます。

戻される構造体およびジョブ・インスタンスの数に制限はありません。このメソッドは高いパフォーマンスが必要なため、ジョブ・ステータスを効率的に呼び出すように最適化する必要があります。

参照はライブではなく、ジョブまたはジョブ参照が削除または取り消されると無効になります。

次に示すプロパティは、ジョブ・インスタンス参照を一覧表示する場合に適用されます。

JobReferenceの一覧 [必須]。詳細は、第2.27項「JobReferenceAndInstanceReferences構造体」を参照してください。
JobInstanceStatus [オプション]。詳細は、第2.26項「JobInstanceStatusの列挙」を参照してください。
JobFilter、JobInstanceFilterおよびPurgeJobInstancesFilterプロパティは、選択条件です。次のように使用します。
- フィルタは、常に現在のユーザーのコンテクストに適用されます。
- フィルタ内のプロパティは選択条件です。
- フィルタおよびそのプロパティは、スキーマに基づいて移入される必要があります。
- 選択条件が有効だが、現在のユーザーに表示されないジョブが戻される場合、ジョブは正常に実行されます。
- フィルタ内のすべてのプロパティは、選択条件(論理和)として使用されます。
- フィルタ条件は、レクエストが処理されたときにサーバーにより適用されます。
詳細は、第2.23項「JobFilter構造体」、第2.25項「JobInstanceFilter構造体」および第2.40項「PurgeJobInstancesFilter構造体」を参照してください。

3.10.2.1 シグネチャ

JobReferenceAndInstanceReferences[] getJobInstanceReferences(Array JobInstanceFilter, String SessionID);

引数	説明
JobInstanceFilterフィルタ	どのJobInstanceReferencesを戻するかを決定する選択基準を指定します。詳細は、第2.25項「JobInstanceFilter構造体」および第2.27項「JobReferenceAndInstanceReferences構造体」を参照してください。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.3 getJob()メソッド

このメソッドを使用して、指定されたジョブ参照のジョブ定義を取得します。存在しないジョブの取得を試みると、「ジョブが見つかりません。」エラーが発生します。

3.10.3.1 シグネチャ

Job[] getJob(String JobReference, String SessionID);

引数	説明
String JobReference	一意のジョブ識別子を指定します。詳細は、第2.22項「Job構造体」を参照してください。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.4 getJobInstance()メソッド

このメソッドを使用して、指定されたジョブ・インスタンス参照のジョブ・インスタンス詳細を取得します。存在しないジョブの取得を試みると、「ジョブ・インスタンスが見つかりません。」エラーが発生します。

3.10.4.1 シグネチャ

JobInstance[] getJobInstance(String JobReference, String JobInstanceReference, String SessionID);

引数	説明
String JobReference	一意のジョブ識別子を指定します。詳細は、第2.24項「JobInstance構造体」を参照してください。
String JobInstanceReference	一意のジョブ・インスタンス識別子を指定します。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.5 cancelJobInstance()メソッド

このメソッドを使用して、既存のジョブ・インスタンスへの参照が指定された場合、ジョブ・インスタンスの実行の取消をリクエストします。

正常に戻されると、取消のリクエストが受け入れられたことを示します。getJobInstanceReferences操作(ジョブ参照または状態などの適切なフィルタを使用)またはgetJobInstance操作(JobInstanceStatusプロパティのチェックも含む)を使用して、取消が完了したかどうか確認する必要があります。

実行中ではないジョブ・インスタンスの取消には効果がありません。存在しないジョブを取り消すと、「ジョブ・インスタンスが見つかりません。」エラーが発生します。

3.10.5.1 シグネチャ

Boolean cancelJobInstance(String JobReference, String JobInstanceReference, String SessionID);

引数	説明
String JobReference	一意のジョブ識別子を指定します。
String JobInstanceReference	一意のジョブ・インスタンス識別子を指定します。詳細は、第2.27項「JobReferenceAndInstanceReferences構造体」を参照してください。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.6 removeJobs()メソッド

このメソッドを使用して、ジョブ参照の一覧で与えられた関連付けられたジョブを削除します。存在しないジョブの削除を試みると、その操作は無視されログに記載されます。実際に削除されたジョブ数が返されます。

3.10.6.1 シグネチャ

Unsigned Integer removeJobs(List JobReference[], String SessionID);

引数	説明
List JobReference[]	削除されたジョブのジョブIDを指定します。詳細は、第2.27項「JobReferenceAndInstanceReferences構造体」を参照してください。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.7 purgeJobInstances()メソッド

このメソッドを使用して、フィルタに基づきジョブ・インスタンスをパージします。purgeJobInstancesFilteでは、ジョブ参照またはユーザーIDの移入済リストを保持している必要があります。これが保持されていない場合、「選択が無効です」 SOAPエラーが発生します。存在しないジョブ参照またはユーザーIDのパージを試みると、その操作は無視されログに記載されます。

次に示すプロパティは、ジョブ・インスタンスをパージする場合に適用されます。

次のいずれかを選択します。[必須]
- ジョブ参照の一覧[オプション]。
- ユーザーIDの一覧[オプション]。

3.10.7.1 シグネチャ

Void purgeJobinstances(List[] PurgeJobInstancesFilter, String SessionID);

引数	説明
List[] PurgeJobInstancesFilter	パージするジョブ参照で使用するフィルタ・プロパティを指定します。詳細は、第2.40項「PurgeJobInstancesFilter構造体」を参照してください。
String SessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.10.8 SchedulerService APIの使用方法の例

この項は、読者にJavaおよびSOAPベースのWebサービスの知識があることを前提としています。次のJavaコードは、APIの使用方法について説明します。

第3.10.8.1項「例 - セッションおよびスケジューラ・サービスの作成」
第3.10.8.2項「例 - ユーザーのジョブ参照の検索およびジョブ名の表示」
第3.10.8.3項「例 - 指定された2つのジョブ参照のジョブ・インスタンスの検索」
第3.10.8.4項「例 - ジョブ参照に関連付けられたすべてのジョブ・インスタンスの取消」
第3.10.8.5項「例 - WebCatalogServiceのすべてのエージェントの検索および表示」

3.10.8.1 例 - セッションおよびスケジューラ・サービスの作成

ここで説明するすべてのサービスと同様に、スケジューラ・サービスを使用する前にSAWSessionを確立する必要があります。次に、サービス・エンドポイントへのハンドルをインスタンス化します。

SAWSessionService sessionService = new SAWSessionService();

SAWSessionServiceSoap sessionServiceSoap = sessionService.getSAWSessionServiceSoap();

String sessionId = sessionServiceSoap.logon("<USER_NAME>", "<PASSWORD>");
 
SchedulerService schedulerService = new SchedulerService();

SchedulerServiceSoap schedulerServiceSoap = schedulerService.getSchedulerServiceSoap();

3.10.8.2 例 - ユーザーのジョブ参照の検索およびジョブ名の表示

次の例では、第3.10.8.1項「例 - セッションおよびスケジューラ・サービスの作成」に記載されているコードに基づいて、セッションおよびサービスを作成します。

JobFilter jobFilter = new JobFilter();
 
jobFilter.getUserID().add("<USER_ID>");
 
List<Long> jobRefs = schedulerServiceSoap.getJobReferences(jobFilter, sessionId);
 
for (long jobRef : jobRefs) 
   {
    Job job = schedulerServiceSoap.getJob(jobRef, sessionId);
    System.out.println("Name = " + job.getName());
   }

3.10.8.3 例 - 指定された2つのジョブ参照のジョブ・インスタンスの検索

// Create Job Instance Filter
JobInstanceFilter jobInstanceFilter = new JobInstanceFilter(); 
jobInstanceFilter.getJobReference().add(<JOB_REFERENCE_1>);
jobInstanceFilter.getJobReference().add(<JOB_REFERENCE_2>);
jobInstanceFilter.setJobInstanceStatus(null);

List<JobReferenceAndInstanceReferences> listJobRefAndInstanceRefs = schedulerServiceSoap.getJobInstanceReferences(jobInstanceFilter, sessionId);

System.out.println("Number of Jobs with Instances found: " + listJobRefAndInstanceRefs.size());
for (JobReferenceAndInstanceReferences jobRefAndInstanceRefs : listJobRefAndInstanceRefs) 
   {
    System.out.println("Job Ref = " + 
    jobRefAndInstanceRefs.getJobReference() + ", Job Instance Refs = " +
    jobRefAndInstanceRefs.getJobInstanceReference());
   }

3.10.8.4 例 - ジョブ参照に関連付けられたすべてのジョブ・インスタンスの取消

この例では、指定されたジョブ参照のジョブのすべてのジョブ・インスタンスを取り消します。次の例も、第3.10.8.1項「例 - セッションおよびスケジューラ・サービスの作成」に記載されているコードに基づいて、セッションおよびサービスを作成します。

// Create Job Instance Filter
JobInstanceFilter jobInstanceFilter = new JobInstanceFilter();
jobInstanceFilter.getJobReference().add(<JOB_REFERENCE>);

// Get JobInstance References
List<JobReferenceAndInstanceReferences> listJobRefAndInstanceRefs = schedulerServiceSoap.getJobInstanceReferences(jobInstanceFilter, sessionId);

// Cancel all the obtained Job Instances
for (JobReferenceAndInstanceReferences jobRefAndInstanceRefs : listJobRefAndInstanceRefs) 
{
for (BigInteger jobInstanceRef : jobRefAndInstanceRefs.getJobInstanceReference()) 
   {
    System.out.println("Cancelling Job = " + jobRefAndInstanceRefs.getJobReference() + ", Job Instance = " + jobInstanceRef);
    boolean result = schedulerServiceSoap.cancelJobInstance(jobRef, jobInstanceRef, sessionId);
    System.out.println("Result = " + result);
   }
}

3.10.8.5 例 - WebCatalogServiceのすべてのエージェントの検索および表示

WebCatalogServiceを反復する方法および検出されたすべてのエージェントのパスを表示する方法は、次のとおりです。次の例も、第3.10.8.1項「例 - セッションおよびスケジューラ・サービスの作成」に記載されているコードに基づいて、セッションおよびサービスを作成します。

この例を拡大して使用できます。エージェントが見つかったら、それを使用してiBot Webサービス・メソッドをコールできます(たとえば、見つかったエージェント・パスを使用してエージェントを有効化)。第3.4項「iBotServiceサービス」

WebCatalogService webCatalogService = new WebCatalogService();
WebCatalogServiceSoap webCatalogServiceSoap = webCatalogService.getWebCatalogServiceSoap();

void outputAgentsInFolder(String path) {   List<ItemInfo> items = null;   try {       // Get folder items       items = webCatalogServiceSoap.getSubItems(path, "*", false, null, sessionId);       for (ItemInfo itemInfo : items) {            // If item is Agent then display Agent path       if (itemInfo.getSignature().equals("coibot1")) {             System.out.println("Agent Path = " + itemInfo.getPath());       }      // If item is a folder then recurse       if (itemInfo.getType() == ItemInfoType.FOLDER) {             outputAgentsInFolder (itemInfo.getPath());       }    }} catch (SOAPFaultException soapFault){         System.out.println("SOAP Fault for path: " + path);} catch (Exception e) {         e.printStackTrace();   }}

3.11 ScorecardAssessmentServiceサービス

このサービスを使用して、スコアカード・アセスメント・エンジンWebサービスのメソッドを提供します。表3-15に、サポートされるメソッドを示します。

表3-15 ScorecardAssessmentServiceのメソッド

メソッド名	説明
第3.11.1項「executeScorecard()メソッド」	スコアカード・アセスメント・エンジンWebサービスのexecuteScorecardメソッドを公開します。
第3.11.2項「executeScorecardTree()メソッド」	1つ以上のスコアカードのツリー全体に対するアセスメントを取得します。
第3.11.3項「generateKPIDrillTo()メソッド」	指定したKPIの詳細レポートが含まれるOracle Business Intelligenceレポートを生成します。
第3.11.4項「getScorecardKPIDimensions()メソッド」	戦略ツリーおよびイニシアティブ・ツリーで現在使用されているKPIに関連するディメンションのセットを戻します。

3.11.1 executeScorecard()メソッド

このサービスを使用して、スコアカード・アセスメント・エンジンWebサービスのexecuteScorecardメソッドを公開します。

3.11.1.1 シグネチャ

AssessmentResult[] executeScorecard(String ScorecardPath, Array NodeInfos, Array Variables, Boolean GetFresh, Session sessionID);

AssessmentResult[]の詳細は、第2.9項「AssessmentResult構造体」を参照してください。

引数	説明
String ScorecardPath	評価するスコアカードが格納されているフォルダを識別するプレゼンテーション・サービス・カタログ・パスを指定します。
Array NodeInfos	アセスメントが必要なノードの配列を指定します。詳細は、第2.34.1項「NodeTypes列挙」を参照してください。
Variable[] Variables	問合せで適用するVariableオブジェクトの配列を指定します。詳細は、第2.64項「Variable構造体」を参照してください。
Boolean GetFresh	(オプション)サーバー側のプレゼンテーション・サービス・キャッシュにヒットする必要があるか(true)、否か(false)を指定します。デフォルトはfalseです。
Session sessionID	(オプション) SAWセッションIDを指定します。このパラメータは通常、セッションIDがCookieとして格納されるため、省略できます。

3.11.2 executeScorecardTree()メソッド

このメソッドを使用して、1つ以上のスコアカードのツリー全体に対するアセスメントを取得します。

3.11.2.1 シグネチャ

AssessmentResult[] executeScorecardTree(String ScorecardPath, Integer TreesFlag, Array Variables, Boolean GetFresh, Session sessionID);

引数	説明
String ScorecardPath	評価するスコアカードが格納されているフォルダを識別するプレゼンテーション・サービス・カタログ・パスを指定します。
Integer TreesFlag	関心のあるツリーを示す整数を指定します。必要な整数値に達するには、"bitwise or"演算子(\|)を関心のあるツリーに対応するTreeFlagsの値をとともに使用します。詳細は、第2.59項「TreeFlags列挙」を参照してください。
Variable[] Variables	問合せで適用するVariableオブジェクトの配列を指定します。詳細は、第2.64項「Variable構造体」を参照してください。
String sessionID	(オプション) SAWセッションIDを指定します。このパラメータは通常、セッションIDがCookieとして格納されるため、省略できます。

3.11.3 generateKPIDrillTo()メソッド

このメソッドを使用して、指定したKPIの詳細レポートが含まれるOracle Business Intelligenceレポートを生成します。

3.11.3.1 シグネチャ

DrillToReportURLResult generateKPIDrillTo(String ScorecardPath, String NodeID, String NodeType, String ReportPath, Array Variables, Boolean IsDrillToReport, chartHeight, chartWidth, Session sessionID);

引数	説明
String ScorecardPath	指定したKPIが固定されている戦略ツリーまたはイニシアティブ・ツリーが格納されているスコアカード・フォルダへのパスを指定します。
String NodeID	戦略ツリーまたはイニシアティブ・ツリーに固定されたKPIのノードのGUIDを指定します。
String NodeType	ノードが属するツリーのタイプを指定します。有効な値の詳細は、第2.34.1項「NodeTypes列挙」を参照してください。
String ReportPath	生成されたレポートの保存先となるWebカタログ・パスを指定します。
Array Variables	レポートの生成時に使用する必要があるVariable構造体オブジェクトの配列を指定します。詳細は、第2.64項「Variable構造体」を参照してください。
Boolean IsDrillToReport	ドリル・レポートであるか(true)、詳細レポートであるか(false)を指定します。
chartHeight	チャートの高さを指定します。
chartWidth	チャートの幅を指定します。
String sessionID	(オプション) SAWセッションIDを指定します。このパラメータは通常、セッションIDがCookieに格納されるため、省略できます。

3.11.4 getScorecardKPIDimensions()メソッド

このメソッドを使用して、戦略ツリーおよびイニシアティブ・ツリーで現在使用されているKPIに関連するディメンションのセットを戻します。

3.11.4.1 シグネチャ

ScorecardDimensionReference[] getScorecardKPIDimensions(Boolean GetFresh, Session sessionID);

引数	説明
Boolean GetFresh	(オプション)結果を中間層から新たに取得する必要があるか(true)、キャッシュされたリストで十分であるか(false)を指定します。デフォルト: false。
Session sessionID	(オプション)リクエストの作成に使用する必要があるHTTPセッションIDを指定します。デフォルト: 現行HTTPセッション(セッションCookieによって識別)。

3.12 ScorecardMetadataServiceサービス

このサービスを使用して、Oracle BIプレゼンテーション・サービス・カタログでスコアカード・メタデータを作成、更新および削除するScorecardMetadataService SOAP APIのメソッドを提供します。表3-16 に、サポートされるメソッドを示します。

表3-16 ScorecardMetadataServiceのメソッド

メソッド名	説明
第3.12.1項「createScorecard()メソッド」	スコアカードを作成します。
第3.12.2項「openScorecard()メソッド」	スコアカードを(読取り専用モードで)開きます。
第3.12.3項「closeScorecard()メソッド」	スコアカードを閉じます。
第3.12.4項「editScorecard()メソッド」	スコアカードを編集します(読取り/書込みモードで開きます)。
第3.12.5項「getScorecardDetails()メソッド」	スコアカード詳細を取得します。
第3.12.6項「updateScorecardSettings()メソッド」	スコアカードの設定を更新します。
第3.12.7項「addStrategyNode()メソッド」	指定したスコアカードに戦略ノードを追加します。
第3.12.8項「deleteStrategyNode()メソッド」	指定したスコアカードから戦略ノードを削除します。
第3.12.9項「updateStrategyNode()メソッド」	指定したスコアカードの戦略ノードを更新します。
第3.12.10項「moveStrategyNode()メソッド」	指定したスコアカードの新しい親ノードに戦略ノードを移動します。
第3.12.11項「addInitiativeNode()メソッド」	指定したスコアカードにイニシアティブ・ノードを追加します。
第3.12.12項「deleteInitiativeNode()メソッド」	指定したスコアカードからイニシアティブ・ノードを削除します。
第3.12.13項「moveInitiativeNode()メソッド」	指定したスコアカードの新しい親ノードにイニシアティブ・ノードを移動します。
第3.12.14項「openTreeNode()メソッド」	特定のスコアカードの範囲内で個別の戦略またはイニシアティブ・ノードの情報を読み取ります。
第3.12.15項「addPerspective()メソッド」	指定したスコアカードにパースペクティブを追加します。
第3.12.16項「deletePerspective()メソッド」	指定したスコアカードからパースペクティブを削除します。
第3.12.17項「updatePerspective()メソッド」	指定したスコアカードのパースペクティブを更新します。
第3.12.18項「addScorecardView()メソッド」	指定したスコアカードにスコアカード・ビューを追加します。
第3.12.19項「updateScorecardView()メソッド」	指定したスコアカードのスコアカード・ビューを更新します。
第3.12.20項「deleteScorecardView()メソッド」	指定したスコアカードからスコアカード・ビューを削除します。
第3.12.21項「updateCausalLinkages()メソッド」	指定したスコアカードの因果関係を更新します。
第3.12.22項「updateScorecardItemACL()メソッド」	指定したスコアカードの項目のアクセス制御リスト(ACL)を更新します。

3.12.1 createScorecard()メソッド

このメソッドを使用して、スコアカードを作成します。

3.12.1.1 シグネチャ

CreateScorecardResult createScorecard(String Name, String Description, String Path, String RootNodeName, Boolean UseDefaultPerspectives, String SessionID);

引数	説明
String Name	新しいスコアカードに付ける名前を指定します。
String Description	新しいスコアカードに設定する説明を指定します。
String Path	新しいスコアカードの保存先となるカタログ・パスを指定します。
String RootNodeName	新しいスコアカードの戦略ツリーのルート・ノードに付ける名前を指定します。
Boolean UseDefaultPerspectives	スコアカードにデフォルトのパースペクティブを事前に移入する必要があるか(true)、否か(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.2 openScorecard()メソッド

このメソッドを使用して、スコアカードを開きます。

3.12.2.1 シグネチャ

OpenScorecardResult openScorecard(String Path, Boolean RequestedReadWrite, Object RetryOrigResult, String SessionID);

引数	説明
String Path	開くスコアカードのカタログ・パスを指定します。
Boolean RequestedReadWrite	編集モードでスコアカードを開くか(true)、表示モードで開くか(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.3 closeScorecard()メソッド

このメソッドを使用して、スコアカードを閉じます。

3.12.3.1 シグネチャ

CloseScorecardResult closeScorecard(String ScorecardID, String ErrorCode, String ErrorMessage);

引数	説明
String ScorecardID	閉じるスコアカードのIDを指定します。
Boolean Unlock	スコアカードのロックを解除するか(true)、否か(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.4 editScorecard()メソッド

このメソッドを使用して、スコアカードを編集します。

3.12.4.1 シグネチャ

OpenScorecardResult editScorecard(String Path, String ScorecardID, Boolean Edit, String SessionID);

引数	説明
String Path	開くスコアカードのカタログ・パスを指定します。
String ScorecardID	閉じるスコアカードのIDを指定します。
Boolean Edit	編集モードでスコアカードを開くか(true)、表示モードで開くか(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.5 getScorecardDetails()メソッド

このメソッドを使用して、スコアカード詳細を取得します。

3.12.5.1 シグネチャ

GetScorecardDetailsResult getScorecardDetails(String ScorecardID, Boolean GetSettings, Boolean GetPerspectives, Boolean GetStrategyTree, Boolean GetInitiativeTree, Boolean GetCausalLinkages, Boolean GetViews, Boolean IncludeCatalogObjects, String SessionID);

引数	説明
String ScorecardID	関心のあるスコアカードのID。
Boolean GetSettings	結果にスコアカードの設定が含まれるようにするか(true)、否か(false)を指定します。
Boolean GetPerspectives	結果にスコアカードのパースペクティブが含まれるようにするか(true)、否か(false)を指定します。
Boolean GetStrategyTree	結果にスコアカードの戦略ツリーが含まれるようにするか(true)、否か(false)を指定します。
Boolean GetInitiativeTree	結果にスコアカードのイニシアティブ・ツリーが含まれるようにするか(true)、否か(false)を指定します。
Boolean GetCausalLinkages	結果にスコアカードの因果関係が含まれるようにするか(true)、否か(false)を指定します。
Boolean GetViews	結果にスコアカードのビューが含まれるようにするか(true)、否か(false)を指定します。
Boolean IncludeCatalogObjects	結果にスコアカードのカタログ・オブジェクトが含まれるようにするか(true)、否か(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.6 updateScorecardSettings()メソッド

このメソッドを使用して、スコアカードの設定を更新します。

3.12.6.1 シグネチャ

void updateScorecardSettings(String ScorecardID, Object ScorecardSettings, String SessionID);

引数	説明
String ScorecardID	更新するスコアカードのIDを指定します。
Object ScorecardSettings	適用する新しいスコアカードの設定を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.7 addStrategyNode()メソッド

このメソッドを使用して、指定したスコアカードに戦略ノードを追加します。

3.12.7.1 シグネチャ

ObjectiveNode (or PinnedKPINode) addStrategyNode(String ScorecardID, Object StrategyNode, String SessionID);

引数	説明
String ScorecardID	戦略ノードの追加先となるスコアカードのIDを指定します。
Object StrategyNode	追加する戦略ノードを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.8 deleteStrategyNode()メソッド

このメソッドを使用して、指定したスコアカードから戦略ノードを削除します。

3.12.8.1 シグネチャ

DeleteNodeResult deleteStrategyNode(String ScorecardID, String NodeID, Boolean RemoveLinkedObjective, Boolean Recursive, String SessionID);

引数	説明
String ScorecardID	戦略ノードの削除元となるスコアカードのIDを指定します。
String NodeID	削除するノードのIDを指定します。
Boolean RemoveLinkedObjective	指定したノードにリンクされているノードをすべて削除するか(true)、否か(false)を指定します。
Boolean Recursive	指定したノード直下のノードをすべて削除するか(true)、否か(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.9 updateStrategyNode()メソッド

このメソッドを使用して、指定したスコアカードの戦略ノードを更新します。

3.12.9.1 シグネチャ

ObjectiveNode (or PinnedKPINode) updateStrategyNode(String ScorecardID, Object StrategyNode, String SessionID);

引数	説明
String ScorecardID	更新する戦略ノードが含まれるスコアカードのIDを指定します。
Object StrategyNode	更新する戦略ノードを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.10 moveStrategyNode()メソッド

このメソッドを使用して、指定したスコアカードの新しい親ノードに戦略ノードを移動します。

3.12.10.1 シグネチャ

MoveNodeResult moveStrategyNode(String ScorecardID, String NodeToBeMovedGuid, String OriginalParentGuid, String ReferenceNodeGuid, String NewParentGuid, String Operation, String SessionID);

引数	説明
String ScorecardID	移動する戦略ノードが含まれるスコアカードのIDを指定します。
String NodeToBeMovedGuid	移動するノードのIDを指定します。
String OriginalParentGuid	古い親ノードのIDを指定します。
String ReferenceNodeGuid	参照ノードのIDを指定します(これは、移動されたノードの最終停止場所を特定するために指定の操作に関して使用されます)。
String NewParentGuid	新しい親ノードのIDを指定します。
String Operation	適用する移動操作を指定します。操作ADD、UPDATEまたはDELETEを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.11 addInitiativeNode()メソッド

このメソッドを使用して、指定したスコアカードにイニシアティブ・ノードを追加します。

3.12.11.1 シグネチャ

InitiativeNode (or PinnedKPINode) addInitiativeNode(String ScorecardID, Object InitiativeNode, String SessionID);

引数	説明
String ScorecardID	イニシアティブ・ノードの追加先となるスコアカードのIDを指定します。
Object InitiativeNode	追加するイニシアティブ・ノードを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.12 deleteInitiativeNode()メソッド

このメソッドを使用して、指定したスコアカードからイニシアティブ・ノードを削除します。

3.12.12.1 シグネチャ

DeleteNodeResult deleteInitiativeNode(String ScorecardID, String NodeID, Boolean RemoveLinkedInitiative, Boolean Recursive, String SessionID);

引数	説明
String ScorecardID	イニシアティブ・ノードの削除元となるスコアカードのIDを指定します。
String NodeID	削除するノードのIDを指定します。
Boolean RemoveLinkedInitiative	指定したノードにリンクされているノードをすべて削除するか(true)、否か(false)を指定します。
Boolean Recursive	指定したノード直下のノードをすべて削除するか(true)、否か(false)を指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.13 moveInitiativeNode()メソッド

このメソッドを使用して、指定したスコアカードの新しい親ノードにイニシアティブ・ノードを移動します。

3.12.13.1 シグネチャ

MoveNodeResult moveInitiativeNode(String ScorecardID, String NodeToBeMovedGuid, String OriginalParentGuid, String ReferenceNodeGuid, String NewParentGuid, String Operation, String SessionID);

引数	説明
String ScorecardID	移動する戦略ノードが含まれるスコアカードのIDを指定します。
String NodeToBeMovedGuid	移動するノードのIDを指定します。
String OriginalParentGuid	古い親ノードのIDを指定します。
String ReferenceNodeGuid	参照ノードのIDを指定します(これは、移動されたノードの最終停止場所を特定するために指定の操作に関して使用されます)。
String NewParentGuid	新しい親ノードのIDを指定します。
String Operation	適用する移動操作を指定します。操作ADD、UPDATEまたはDELETEを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.14 openTreeNode()メソッド

特定のスコアカードの範囲内で個別の戦略またはイニシアティブ・ノードの情報を読み取るには、このメソッドを使用します。

3.12.14.1 シグネチャ

openTreeNode(String scorecardID, String nodeID, String type, String sessionID);

引数	説明
String scorecardID	開くスコアカード・ノードのIDを指定します。
String nodeID	戦略またはイニシアティブ・ノードのIDを指定します。
String type	ノードのタイプ("OBJECTIVE_NODE"または"INITIATIVE_NODE")を指定します。
String sessionID	(オプション) HTTPセッションIDを指定します。

3.12.15 addPerspective()メソッド

このメソッドを使用して、スコアカードにパースペクティブを追加します。

3.12.15.1 シグネチャ

Perspective addPerspective(String ScorecardID, Object InitiativeNode, String SessionID);

引数	説明
String ScorecardID	パースペクティブの追加先となるスコアカードのIDを指定します。
Object Perspective	追加するパースペクティブを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.16 deletePerspective()メソッド

このメソッドを使用して、指定したスコアカードからパースペクティブを削除します。

3.12.16.1 シグネチャ

DeletePerspectiveResult deleteInitiativeNode(String ScorecardID, String PerspectiveID, String SessionID);

引数	説明
String ScorecardID	パースペクティブの削除元となるスコアカードのIDを指定します。
String PerspectiveID	削除するパースペクティブのIDを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.17 updatePerspective()メソッド

このメソッドを使用して、指定したスコアカードのパースペクティブを更新します。

3.12.17.1 シグネチャ

Perspective updatePerspective(String ScorecardID, Object Perspective, String SessionID);

引数	説明
String ScorecardID	更新するパースペクティブが含まれるスコアカードのIDを指定します。
Object Perspective	更新するパースペクティブを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.18 addScorecardView()メソッド

このメソッドを使用して、指定したスコアカードにスコアカード・ビューを追加します。

3.12.18.1 シグネチャ

ItemInfo addScorecardView(String ScorecardID, Object XMLDocumentInfo, String SessionID);

引数	説明
String ScorecardID	スコアカード・ビューの追加先となるスコアカードのIDを指定します。
Object XMLDocumentInfo	新しいビューのメタデータが含まれているオブジェクトを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.19 updateScorecardView()メソッド

このメソッドを使用して、指定したスコアカードのスコアカード・ビューを更新します。

3.12.19.1 シグネチャ

ItemInfo updateScorecardView(String ScorecardID, Object XMLDocumentInfo, String SessionID);

引数	説明
String ScorecardID	更新するビューが含まれるスコアカードのIDを指定します。
Object XMLDocumentInfo	更新されたビューのメタデータが含まれているオブジェクトを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.20 deleteScorecardView()メソッド

このメソッドを使用して、指定したスコアカードからスコアカード・ビューを削除します。

3.12.20.1 シグネチャ

DeleteScorecardViewResult deleteScorecardView(String ScorecardID, String Path, String SessionID);

引数	説明
String ScorecardID	削除するビューが含まれるスコアカードのIDを指定します。
String Path	削除するビューのカタログ・パスを指定します。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.21 updateCausalLinkages()メソッド

このメソッドを使用して、指定したスコアカードの因果関係を更新します。

3.12.21.1 シグネチャ

UpdateCausalLinkageResult updateCausalLinkages(String Name, Array CausalLinkage, String SessionID);

引数	説明
String ScorecardID	更新する因果関係が含まれるスコアカードのIDを指定します。
Array CausalLinkage[]	更新するCausalLinkage構造体オブジェクトの配列を指定します。詳細は、第2.13項「CausalLinkage構造体」を参照してください。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.12.22 updateScorecardItemACL()メソッド

このメソッドを使用して、指定したスコアカードの項目のアクセス制御リスト(ACL)を更新します。

3.12.22.1 シグネチャ

UpdateScorecardItemACLResult updateScorecardItemACL(String ScorecardID, Enumeration Type, String Path, String id, ACL acl, UpdateCatalogItemACLParams options, String SessionID);

引数	説明
String ScorecardID	ACLを更新する項目が含まれるスコアカードのIDを指定します。
Enumeration Type	ACLを更新するオブジェクトのタイプを指定します。 Typeフィールドの有効な値は、SCORECARDタイプ、STRATEGY_NODEタイプおよびINITIATIVE_NODEタイプです。
String id	スコアカード・ツリー・ノードのGUIDを指定します。これは、戦略ツリーまたはイニシアティブ・ツリーのACL(TypeがSTRATEGY_NODEまたはINITIATIVE_NODEの場合)にのみ必要です。他のカタログ・タイプの場合、nullにできます。
String Path	ACLを更新するオブジェクトへのパスを指定します。
ACL acl	新しいACLを指定します。詳細は、第2.3項「ACL構造体」を参照してください。
UpdateCatalogItemACLParams options	'options' UpdateCatalogItemACLParams構造体には、UpdateACLModeフラグとRecursiveフラグが含まれ、タイプがUpdateCatalogItemACLParamsです。詳細は、第2.62項「UpdateCatalogItemACLParams構造体」を参照してください。
String SessionID	(オプション) HTTPセッションIDを指定します。

3.13 SecurityServiceサービス

このサービスを使用して、アカウントと権限を識別するメソッドを提供します。表3-17に、サポートされるメソッドを示します。

表3-17 SecurityServiceのメソッド

メソッド名	説明
第3.13.1項「forgetAccountsEx()メソッド」	カタログからアカウントを削除します。
第3.13.2項「getAccounts()メソッド」	Oracle BI EEのユーザー・アカウントを検索します。
第3.13.3項「getAccountTenantID()メソッド」	特定のアカウントのテナントIDを取得します。
第3.13.4項「getGlobalPrivilegeACL()メソッド」	グローバル権限のアクセス制御リストを取得します。
第3.13.5項「getGlobalPrivileges()メソッド」	すべてのグローバル権限のリストを取得します。
第3.13.6項「getGroups()メソッド」	ユーザーやグループなど、アカウントのメンバーであるカタログ・グループのリストを取得します。
第3.13.7項「getMembers()メソッド」	カタログ・グループの直接のメンバーを取得します。
第3.13.8項「getPermissions()メソッド」	指定したユーザーの権限のリストを取得します。
第3.13.9項「getPermissionsEx()メソッド」	指定したユーザーの権限のリストを取得します。
第3.13.10項「getPrivilegesStatus()メソッド」	すべての権限とそのステータスをリストします。
第3.13.11項「isMember()メソッド」	カタログ・グループがユーザーまたはグループのメンバーであるかどうかを確認します。
第3.13.12項「joinGroups()メソッド」	カタログ・グループにメンバーとしてユーザーを追加します。
第3.13.13項「leaveGroups()メソッド」	グループからメンバーを削除します。
第3.13.14項「renameAccountsEx()メソッド」	ユーザー・アカウントの名前を変更します。
第3.13.15項「updateGlobalPrivilegeACL()メソッド」	グローバル権限のアクセス制御リストを更新します。

3.13.1 forgetAccountsEx()メソッド

このメソッドを使用して、カタログからアカウントを削除します。

3.13.1.1 シグネチャ

forgetAccountsStatus(ForgetAccount forgetAccountsList, String sessionID);

引数	説明
ForgetAccount forgetAccountsList	削除するアカウントを指定します。これはForgetAccount構造体で提供されます。ForgetAccount構造体の詳細は、第2.17項「ForgetAccount構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.1.2 戻り値

ForgetAccountsStatus構造体のforgetAccounts操作のステータスとともにアカウント名のリストを返します。詳細は、第2.19項「ForgetAccountsStatus構造体」を参照してください。

3.13.2 getAccounts()メソッド

このメソッドを使用して、Oracle BI EEのユーザー・アカウント(LDAPユーザー、カタログ・グループ、アプリケーション・ロールなど)を検索します。

3.13.2.1 シグネチャ

List[] getAccounts(List[], String sessionID);

引数	説明
List[]	ユーザー名、カタログ・グループ名、およびアプリケーション・ロール名を指定します。フラグは、その名前がユーザー、グループ、またはアプリケーション・ロールであるかどうかを示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

ｊ3.13.3 getAccountTenantID()メソッド

このメソッドを使用して、特定のアカウントのテナントIDを取得します。

3.13.3.1 シグネチャ

List[] getAccountTenantID(List[], String sessionID);

引数	説明
Account account	テナントIDが必要なアカウントを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.3.2 戻り値

テナントIDを戻します。

3.13.4 getGlobalPrivilegeACL()メソッド

このメソッドを使用して、グローバル権限のアクセス制御リストを取得します。

3.13.4.1 シグネチャ

ACL getGlobalPrivilegeACL(String privilegeName, String sessionID);

引数	説明
String privilegeName	取得する権限の名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.5 getGlobalPrivileges()メソッド

このメソッドを使用して、グローバル権限のリストを取得します。

3.13.5.1 シグネチャ

List[] getGlobalPrivileges(String sessionID);

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

3.13.6 getGroups()メソッド

このメソッドを使用して、ユーザーやグループなど、アカウントのメンバーであるカタログ・グループのリストを取得します。

3.13.6.1 シグネチャ

List[] getGroups(List[], Boolean expandGroups, String sessionID);

引数	説明
List[]	ユーザーまたはグループを指定します。
Boolean expandGroups	メンバーが所属するグループを開くことを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.7 getMembers()メソッド

このメソッドを使用して、カタログ・グループの直接のメンバーを取得します。

3.13.7.1 シグネチャ

List[] getMembers(List[] group, Boolean expandGroups, String sessionID);

引数	説明
List[]	メンバーのリストが必要なカタログ・グループを指定します。
Boolean expandGroups	メンバーが所属するグループを開くことを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.8 getPermissions()メソッド

このメソッドを使用して、指定のアクセス制御リストに基づき、指定したユーザーの権限のリストを取得します。

注意:

また、このメソッドは、アクセス制御リストでグループの権限が指定されていない場合でも、ユーザーのセキュリティ・グループにより継承されるすべての権限を戻します。

3.13.8.1 シグネチャ

List[] getPermissions(List[], Account account, String sessionID);

引数	説明
List[]	Account accountで指定するユーザーのアクセス制御リストを指定します。
Account account	ACLの権限を検索する対象となるユーザーの名前を指定します。ユーザーの名前またはGUIDを指定できます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.8.2 戻り値

AccessControlToken構造体のpermissionMaskフィールドにある権限情報を戻します(詳細は、第2.1項「AccessControlToken構造体」を参照してください)。

3.13.9 getPermissionsEx()メソッド

このメソッドを使用して、指定のアクセス制御リストに基づき、指定したユーザー、所有者または作成者の権限のリストを取得します。

3.13.9.1 シグネチャ

List[] getPermissionsEx(List[], Account account, Owner owner, Creator creator, String sessionID);

引数	説明
List[]	Account accountで指定するユーザーのアクセス制御リストを指定します。
Account account	ACLの権限を検索する対象となるユーザーの名前を指定します。ユーザーの名前またはGUIDを指定できます。
Owner owner	ACLの権限を検索する対象となる所有者の名前を指定します。所有者のユーザー名またはGUIDを指定できます。
Creator creator	ACLの権限を検索する対象となる作成者の名前を指定します。作成者のユーザー名またはGUIDを指定できます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.9.2 戻り値

AccessControlToken構造体のpermissionMaskフィールドにある権限情報を戻します(詳細は、第2.1項「AccessControlToken構造体」を参照してください)。

3.13.10 getPrivilegesStatus()メソッド

このメソッドを使用して、すべての権限とそのステータスをリストします。

3.13.10.1 シグネチャ

List[] getPrivilegesStatus(List[] privileges, String sessionID);

引数	説明
List[] privileges	権限のリストを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.11 isMember()メソッド

このメソッドを使用して、カタログ・グループがユーザーまたはグループのメンバーであるかを確認します。

3.13.11.1 シグネチャ

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に設定することができます。

3.13.12 joinGroups()メソッド

このメソッドを使用して、カタログ・グループにメンバーとして参加します。

3.13.12.1 シグネチャ

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に設定することができます。

3.13.13 leaveGroups()メソッド

このメソッドを使用して、グループからメンバーを削除します。

3.13.13.1 シグネチャ

void leaveGroups(List[] group, List[] member, String sessionID);

引数	説明
List[] group	メンバーを削除するグループを指定します。
List[] member	グループから削除するメンバーを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.14 renameAccountsEx()メソッド

このメソッドを使用して、アカウントの名前を変更します。

3.13.14.1 シグネチャ

renameAccountsStatus(RenameAccount renameAccountsList, String sessionID);

引数	説明
RenameAccount renameAccountsList	RenameAccount構造体のアカウント・タイプとともに古い名前と新しい名前のリストを指定します。RenameAccount構造体の詳細は、「RenameAccountsStatus構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.13.14.2 戻り値

RenameAccountsStatus構造体のrenameAccounts操作のステータスとともにアカウント名のリストを返します。詳細は、「RenameAccountsStatus構造体」を参照してください。

3.13.15 updateGlobalPrivilegeACL()メソッド

このメソッドを使用して、グローバル権限のアクセス制御リストを更新します。

3.13.15.1 シグネチャ

void updateGlobalPrivilegeACL(String privilegeName, ACL acl, UpdateACLParams updateACLParams, String sessionID);

引数	説明
String privilegeName	更新する権限の名前を指定します。
ACL acl	更新するアクセス制御リストを指定します。これはACL構造体で提供されます。ACL構造体の詳細は、第2.3項「ACL構造体」を参照してください。
UpdateACLParams updateACLParams	更新するアクセス制御リストのパラメータを指定します。これはUpdateACLParams構造体で提供されます。UpdateACLParams構造体の詳細は、第2.61項「UpdateACLParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14 UserPersonalizationServiceサービス

このサービスを使用して、お気に入りおよびお気に入りカテゴリを管理します。表3-18に、サポートされるメソッドを示します。

表3-18 UserPersonalizationServiceのメソッド

メソッド名	説明
第3.14.1項「addFavorite()メソッド」	カタログ・オブジェクトをお気に入りとしてお気に入りリストに追加します。
第3.14.2項「addFavoriteCategory()メソッド」	カテゴリ・オブジェクトをお気に入りマネージャに追加します。
第3.14.3項「deleteFavorite()メソッド」	既存のお気に入り項目をお気に入りマネージャから削除します。
第3.14.4項「deleteFavoriteCategory()メソッド」	既存のお気に入りカテゴリをお気に入りマネージャから削除します。
第3.14.5項「getFavorites()メソッド」	すべての既存のお気に入り項目およびカテゴリを戻します。
第3.14.6項「updateFavorites()メソッド」	すべての既存のお気に入り項目およびカテゴリを削除し、すべてのお気に入りマネージャ項目を指定のお気に入り項目のリストを使用して再生成します。
第3.14.7項「getMostRecents()メソッド」	すべての最近使用した項目を戻します。

3.14.1 addFavorite()メソッド

このメソッドを使用して、カタログ・オブジェクトをお気に入りとしてお気に入りリストに追加します。

3.14.1.1 シグネチャ

void addFavorite(String catalogObjectPath, String categoryPath, String sessionID);

引数	説明
String catalogObjectPath	お気に入りとして追加するカタログ・オブジェクト・パスを指定します。
String categoryPath	お気に入り項目を作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空白の場合、お気に入り項目はお気に入りマネージャにルート要素として追加されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14.2 addFavoriteCategory()メソッド

このメソッドを使用して、カテゴリ・オブジェクトをお気に入りマネージャに追加します。

3.14.2.1 シグネチャ

void addFavoriteCategory(String categoryName, String categoryPath, String sessionID);

引数	説明
String categoryName	お気に入りとして追加するカタログ・オブジェクト・パスを指定します。
String categoryPath	新しいカテゴリを作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空の場合、新しいカテゴリはお気に入りマネージャのルートに追加されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14.3 deleteFavorite()メソッド

このメソッドを使用して、既存のお気に入り項目をお気に入りマネージャから削除します。

3.14.3.1 シグネチャ

void deleteFavorite(String catalogObjectPath, String categoryPath, String sessionID);

引数	説明
String catalogObjectPath	お気に入り項目を削除するカテゴリ・オブジェクト・パスを指定します。
String categoryPath	お気に入り項目を削除する必要がある(お気に入りマネージャでの)カテゴリの場所を指定します。空の場合、カテゴリ・オブジェクトはすべてのカテゴリから削除されます。つまり、非お気に入りオブジェクトとマークされます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14.4 deleteFavoriteCategory()メソッド

このメソッドを使用して、既存のお気に入りカテゴリをお気に入りマネージャから削除します。

3.14.4.1 シグネチャ

void deleteFavoriteCategory(String categoryPath, String sessionID);

引数	説明
String categoryPath	削除する必要がある(お気に入りマネージャでの)カテゴリの完全パスを指定します。このパスは/rootで始まります。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14.5 getFavorites()メソッド

このメソッドを使用して、すべての既存のお気に入り項目およびカテゴリを戻します。

3.14.5.1 シグネチャ

List[] getFavorites(String categoryPath, boolean recursive, boolean categoryOnly, String sessionID);

引数	説明
String categoryPath	お気に入り項目を作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空白の場合、お気に入り項目はお気に入りマネージャにルート要素として追加されます。
Boolean recursive	子レベルのカテゴリを結果に含めるかどうかを指定します。
Boolean categoryOnly	すべてのお気に入り項目を除外してカテゴリのみを結果に含めるか、否かを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.14.5.2 戻り値

すべての既存のお気に入り項目およびカテゴリ。

3.14.6 updateFavorites()メソッド

このメソッドを使用して、すべての既存のお気に入り項目およびカテゴリを削除し、すべてのお気に入りマネージャ項目を指定のお気に入り項目のリストを使用して再生成します。

3.14.6.1 シグネチャ

void updateFavorites(List [] favoriteItems, String sessionID);

引数

説明

List [] favoriteItems

FavoriteItem構造体(詳細は、第2.17項「ForgetAccount構造体」を参照)のリストを指定します。このFavoriteItem構造体では、ItemInfo構造体(第2.21項「ItemInfo構造体」を参照)を入力する必要はなく、name、pathおよびtypeの各パラメータのみが必須です。catalogPath引数は、お気に入りマネージャにカタログ・オブジェクトを追加する場合に必要です。さらに、オプションのsubItemsについては、ネストしたFavoriteItemリストを含めることができます。

String sessionID

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

3.14.7 getMostRecents()メソッド

このメソッドを使用して、すべての最近使用した項目を戻します。

3.14.7.1 シグネチャ

List[] getMostRecents(UnsignedShort listType, String sessionID);

引数

説明

UnsignedShort listType

listType値は次のフラグのいずれかです。

1 = 最近更新

2 = 最近表示

3 = 頻繁に表示

4 = 最近

5 = 候補

String sessionID

3.14.7.2 戻り値

MRUItemのリスト。詳細は、「MRUItem構造体」を参照してください。

3.15 WebCatalogServiceサービス

このサービスを使用して、カタログのナビゲートおよび管理を行うメソッドを提供し、XML形式でカタログ・オブジェクトを読み書きします。表3-19に、サポートされる列挙およびメソッドを示します。

表3-19 WebCatalogServiceの列挙およびメソッド

列挙およびメソッドの名前	説明
第3.15.1項「ErrorDetailsLevelの列挙」	メソッドの有効な値のリストを指定します。
第3.15.2項「ReadObjectsReturnOptionsの列挙」	メソッドの有効な値のリストを指定します。
第3.15.3項「copyItem()メソッド」	カタログ内のある場所から別の場所へオブジェクトをコピーします。
第3.15.4項「copyItem2()メソッド」	カタログからアーカイブ・ファイルを生成します。
第3.15.5項「createFolder()メソッド」	カタログに新しいフォルダを作成します。
第3.15.6項「createLink()メソッド」	カタログへのリンクを作成します。
第3.15.7項「deleteItem()メソッド」	カタログからオブジェクトを削除します。
第3.15.8項「getItemInfo()メソッド」	オブジェクトのカタログ情報を取得します。
第3.15.9項「getMaintenanceMode()メソッド」	メンテナンス・モード・ステータスを取得します。
第3.15.10項「getObjectCategories()メソッド」	サポートされているカテゴリをすべて取得します。
第3.15.11項「getObjectCreateList()メソッド」	作成可能なオブジェクトをすべて取得します。
第3.15.12項「getObjectTypes()メソッド」	サポートされているカテゴリ・オブジェクト・タイプをすべて取得します。
第3.15.13項「getSubItems()メソッド」	カタログ内のオブジェクトの子サブ項目のコレクションを取得します。
第3.15.14項「getUserHomeDirPath()メソッド」	ユーザーのホーム・ディレクトリ・パスを取得します。
第3.15.15項「maintenanceMode()メソッド」	メンテナンスの間、カタログをロックします。
第3.15.16項「moveItem()メソッド」	カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。
第3.15.17項「pasteItem2()メソッド」	コピーした項目を貼り付けます。
第3.15.18項「readObjects()メソッド」	カタログからオブジェクトを読み取ります。
第3.15.19項「removeFolder()メソッド」	カタログからフォルダを削除します。
第3.15.20項「setItemAttributes()メソッド」	指定したカタログ項目の属性フラグを設定します。
第3.15.21項「setItemProperty()メソッド」	カタログ内のオブジェクトのプロパティを設定します。
第3.15.22項「setOwnership()メソッド」	指定した項目の所有権を取得します。
第3.15.23項「updateCatalogItemACL()メソッド」	カタログ内の項目のアクセス制御リストを更新します。
第3.15.24項「writeObjects()メソッド」	オブジェクトのリストをカタログに書き込みます。

3.15.1 ErrorDetailsLevelの列挙

この列挙では、「WebCatalogServiceサービス」内のメソッドの有効な値のリストを指定します。表3-20に、この列挙の値をリストします。

注意:

ErrorDetailsLevelの1つの値のみが選択されます。

表3-20 ErrorDetailsLevelの列挙値

値	説明
String ErrorCode	ErrorInfo.errorCodeフィールドにデータを移入することを指定します。
String ErrorCodeAndText	ErrorInfo.errorCodeフィールドおよびErrorInfo.messageフィールドにデータを移入することを指定します。
String FullDetails	すべてのErrorInfoフィールドにデータを移入することを指定します。

3.15.2 ReadObjectsReturnOptionsの列挙

この列挙では、「WebCatalogServiceサービス」内のメソッドの有効な値のリストを指定します。表3-21に、この列挙の値をリストします。

表3-21 ReadObjectsReturnOptionsの列挙値

値	説明
String NoObject	catalogObjectフィールドおよびcatalogObjectBytesフィールドにデータを移入しないことを指定します。
String ObjectAsString	catalogObjectフィールドにはデータを移入し、catalogObjectBytesフィールドにはデータを移入しないことを指定します。
String ObjectAsBinary	catalogObjectフィールドにはデータを移入せず、catalogObjectBytesフィールドにはデータを移入することを指定します。
String ObjectAsBinaryUseMtom	catalogObjectフィールドにはデータを移入せず、catalogObjectBytesにはデータを移入し、SOAPメッセージが戻すコンテンツをMTOMを使用してエンコードすることを指定します。

3.15.3 copyItem()メソッド

このメソッドを使用して、カタログ内のある場所からそのカタログ内の別の場所にオブジェクトをコピーします。

3.15.3.1 シグネチャ

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に設定することができます。

3.15.4 copyItem2()メソッド

このメソッドを使用して、カタログからアーカイブ・ファイルを生成します。

3.15.4.1 シグネチャ

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に設定することができます。

3.15.5 createFolder()メソッド

このメソッドを使用して、カタログにフォルダを作成します。

3.15.5.1 シグネチャ

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に設定することができます。

3.15.6 createLink()メソッド

このメソッドを使用して、カタログへのリンクを作成します。

3.15.6.1 シグネチャ

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.15.7 deleteItem()メソッド

このメソッドを使用して、カタログからオブジェクトを削除します。フォルダを削除するには、第3.15.19項「removeFolder()メソッド」を参照してください。

3.15.7.1 シグネチャ

void deleteItem(String path, String sessionID);

引数	説明
String path	カタログ内のオブジェクトへのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.8 getItemInfo()メソッド

このメソッドを使用して、オブジェクトのカタログ情報を取得します。

3.15.8.1 シグネチャ

ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);

引数	説明
String path	カタログ内のオブジェクトへのパスを指定します。
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、Oracle Business Intelligenceは、リンクが指すオブジェクトの情報を取得します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.8.2 戻り値

ItemInfo構造体のオブジェクトのカタログ情報を戻します。詳細は、第2.21項「ItemInfo構造体」を参照してください。

3.15.9 getMaintenanceMode()メソッド

このメソッドを使用して、メンテナンス・モード・ステータスを取得します。

3.15.9.1 シグネチャ

Boolean getMaintenanceMode(String sessionID);

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

3.15.9.2 戻り値

現在のメンテナンス・モード・ステータスを示すtrueまたはfalseの値を戻します。詳細は、第3.15.15項「maintenanceMode()メソッド」を参照してください。

3.15.10 getObjectCategories()メソッド

このメソッドを使用して、サポートされているカテゴリを取得します。

3.15.10.1 シグネチャ

Boolean getObjectCategories(String sessionID);

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

3.15.10.2 戻り値

サポートされているカテゴリのリストを戻します。

3.15.11 getObjectCreateList()メソッド

このメソッドを使用して、すべての作成可能なオブジェクトのリストを取得します。

3.15.11.1 シグネチャ

Boolean getObjectCreateList(String sessionID);

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

3.15.11.2 戻り値

作成可能なオブジェクトのリストを戻します。

3.15.12 getObjectTypes()メソッド

このメソッドを使用して、サポートされているすべてカテゴリ・オブジェクト・タイプのリストを取得します。

3.15.12.1 シグネチャ

Boolean getObjectTypes(String sessionID);

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

3.15.12.2 戻り値

サポートされているオブジェクト・タイプのリストを戻します。

3.15.13 getSubItems()メソッド

このメソッドを使用して、カタログ内のオブジェクトの子サブ項目のコレクションを取得します。

3.15.13.1 シグネチャ

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.20項「GetSubItemsParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.13.2 戻り値

ItemInfo構造体の子サブ項目のコレクションを戻します。詳細は、第2.21項「ItemInfo構造体」を参照してください。

3.15.14 getUserHomeDirPath()メソッド

このメソッドを使用して、ユーザーのホーム・ディレクトリ・パスを取得します。

3.15.14.1 シグネチャ

String(String user name, String sessionID);

引数	説明
String user name	ユーザーの名前を指定します
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.14.2 戻り値

指定されたユーザーのホーム・ディレクトリのパスを返します。

3.15.15 maintenanceMode()メソッド

このメソッドを使用して、メンテナンスの間、カタログをロックします。

3.15.15.1 シグネチャ

void maintenanceMode(boolean flag, String sessionID);

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

3.15.16 moveItem()メソッド

このメソッドを使用して、カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。

3.15.16.1 シグネチャ

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に設定することができます。

3.15.17 pasteItem2()メソッド

このメソッドを使用して、コピーした項目を貼り付けます。

3.15.17.1 シグネチャ

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は、強制置換を示します。
int flagReplaceReferences	xmlオブジェクトのパス参照を置換するかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.18 readObjects()メソッド

このメソッドを使用して、カタログからオブジェクトを読み込み、CatalogObject構造体を戻します。

3.15.18.1 シグネチャ

List[] readObjects(List[] paths, boolean resolveLinks, ErrorDetailsLevel errorMode, ReadObjectsReturnOptions returnOptions, String sessionID);

引数	説明
List[] paths	カタログ内のオブジェクトの場所を指定します。
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。
ErrorDetailsLevel errorMode	CatalogObjects構造体のerrorInfoフィールドのエラー情報の量を指定します。詳細は、第2.12項「CatalogObject構造体」を参照してください。
ReadObjectsReturnOptions returnOptions	有効な値のリストを指定します。詳細は、「ReadObjectsReturnOptionsの列挙」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.18.2 戻り値

CatalogObject構造体オブジェクトの配列を戻します。

注意:

(無効なパスや権限が不十分であることなどにより)カタログ・オブジェクトに対する読取り操作に失敗した場合、そのオブジェクトのerrorInfoフィールドには、エラーの説明が含まれます。

3.15.19 removeFolder()メソッド

このメソッドを使用して、フォルダとそのコンテンツをカタログから削除します。フォルダとそのコンテンツ以外のオブジェクトを削除するには、第3.15.7項「deleteItem()メソッド」を参照してください。

3.15.19.1 シグネチャ

void removeFolder(String path, boolean recursive, String sessionID);

引数	説明
String path	カタログ内のフォルダへのパスを指定します。
boolean recursive	TRUEに設定されている場合、指定したフォルダとそのコンテンツを削除します。FALSEに設定されている場合は、指定したフォルダが空の場合のみそのフォルダを削除し、空でなければ、例外メッセージを表示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.20 setItemAttributes()メソッド

このメソッドを使用して、指定したカタログ項目の属性フラグを設定します。

3.15.20.1 シグネチャ

void setItemAttributes (List[] path, int value, int valueOff, boolean recursive, String sessionID);

引数	説明
List[] path	カタログ内のフォルダへのパスを指定します。
int value	追加する属性を指定します。次のフラグの組合せを指定します。 1 = 読取りのみ 2 = アーカイブ 4 = 非表示 8 = システム
int valueOff	削除する属性を指定します。フラグについては、前述のint valueの説明を参照してください。
boolean recursive	サブディレクトリ内の項目のプロパティを設定するかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.21 setItemProperty()メソッド

このメソッドを使用して、カタログ内のオブジェクトのプロパティを設定します。

3.15.21.1 シグネチャ

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に設定することができます。

3.15.22 setOwnership()メソッド

このメソッドを使用して、指定した項目の所有権を取得します。

3.15.22.1 シグネチャ

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に設定することができます。

3.15.23 updateCatalogItemACL()メソッド

このメソッドを使用して、カタログ内の項目のアクセス制御リストを更新します。

3.15.23.1 シグネチャ

void updateCatalogItemACL(List[] path, ACL acl, UpdateCatalogItemACLParams options, String sessionID);

フィールド	説明
List[] path	カタログ内のオブジェクトへのパスを指定します。
ACL acl	アクセス制御リストを指定します。詳細は、第2.3項「ACL構造体」を参照してください。
UpdateCatalogItemACLParams options	追加パラメータを指定します。詳細は、第2.62項「UpdateCatalogItemACLParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.24 writeObjects()メソッド

このメソッドを使用して、カタログにオブジェクトの配列を書き込みます。

3.15.24.1 シグネチャ

List[] writeObjects(List[] catalogObjects, boolean allowOverwrite, boolean createIntermediateDirs, ErrorDetailsLevel errorMode, String sessionID);

引数	説明
List [] catalogObjects	カタログに書き込むオブジェクトを指定します。これはCatalogObject構造体で提供されます。CatalogObject構造体の詳細は、第2.12項「CatalogObject構造体」を参照してください。オブジェクトに適用される項目プロパティの配列を除く、object.itemInfoのすべてのフィールドが無視されます。生成されるドキュメントのシグネチャは常にCOXmlDocument1となります。
boolean allowOverwrite	TRUEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされます。FALSEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされません。
boolean createIntermediateDirs	TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。
ErrorDetailsLevel errorMode	CatalogObject構造体のerrorInfoフィールドのエラー情報量を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

3.15.24.2 戻り値

ErrorInfo構造体オブジェクトの配列。

3.16 XMLViewServiceサービス

このサービスを使用して、Oracle BI EEプレゼンテーション・サービスから結果をXML形式で取得します。表3-22に、サポートされる列挙およびメソッドを示します。

表3-22 XMLViewサービスの列挙およびメソッド

列挙およびメソッドの名前	説明
第3.16.1項「XMLQueryOutputFormatの列挙」	有効な値のリストを指定します。
第3.16.2項「cancelQuery()メソッド」	現在の問合せを取り消します。
第3.16.3項「executeSQLQuery()メソッド」	SQL問合せを実行します。
第3.16.4項「executeXMLQuery()メソッド」	XML問合せを実行します。
第3.16.5項「fetchNext()メソッド」	データ行の次のページを戻します。
第3.16.6項「getDocumentData()メソッド」	プロンプト・フィルタのある分析の列のみを含むフィルタXML構造体を戻します。
第3.16.7項「upgradeXML()メソッド」	リクエストしたオブジェクトのアップグレード・バージョンを戻します。

3.16.1 XMLQueryOutputFormatの列挙

この列挙では、executeSQLQuery()メソッドおよびexecuteXMLQuery()メソッドの有効な値のリストを指定します。たとえば、データ行とメタデータ、あるいはデータ行のみを戻すことができます。表3-23に、この列挙の値をリストします。

注意:

XMLQueryOutputFormatの1つの値のみを選択できます。

表3-23 XMLQueryOutputFormatの列挙値

値	説明
String SAWRowsetData	問合せでデータ行のみを戻すことを指定します。
String SAWRowsetSchema	問合せでメタデータのみを戻すことを指定します。
String SAWRowsetSchemaAndData	問合せでメタデータとデータ行の両方を戻すことを指定します。

3.16.2 cancelQuery()メソッド

このメソッドを使用して、問合せを取り消し、その問合せに関連付けられたリソースをクリーンアップします。このメソッドは、問合せの行セットが、戻されたデータセットの最後の行までスクロールされない場合にのみ使用されます。

注意:

戻されたデータセットで、問合せ行セットが最後の行までスクロールされるときに、このメソッドを使用すると、問合せデータは、最後のfetchNextメソッドが起動される際にクリーンアップされます。

3.16.2.1 シグネチャ

void cancelQuery(String queryID, String sessionID);

引数	説明
String queryID	問合せの一意のIDを指定します。
String sessionID	セッションの一意のIDを指定します。

3.16.3 executeSQLQuery()メソッド

このメソッドを使用して、SQL問合せを実行し、その問合せの結果を戻します。

注意:

戻される結果が1ページを超える場合、fetchNext()メソッドを使用して、行の次のページを戻す必要があります。

3.16.3.1 シグネチャ

QueryResults executeSQLQuery(String sql, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, String sessionID);

引数	説明
String sql	実行するSQLコードの文字列を指定します。
XMLQueryOutputFormat outputFormat	出力形式を指定します(詳細は、第2.65項「XMLQueryExecutionOptions構造体」を参照してください)。
XMLQueryExecutionOptions executionOptions	問合せ実行オプションを指定します(詳細は、第2.65項「XMLQueryExecutionOptions構造体」を参照してください)。
String sessionID	セッションの一意のIDを指定します。

3.16.3.2 戻り値

QueryResults構造体の1行以上のデータとして、問合せの結果を戻します(詳細は、第2.41項「QueryResults構造体」を参照してください)。

3.16.4 executeXMLQuery()メソッド

このメソッドを使用して、XML問合せを実行し、その問合せの結果を戻します。

注意:

戻される結果が1ページを超える場合、fetchNext()メソッドを使用して、行の次のページを戻す必要があります。

3.16.4.1 シグネチャ

QueryResults executeXMLQuery(ReportRef report, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, ReportParams reportParams, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される分析定義を指定します。
XMLQueryOutputFormat outputFormat	出力形式を指定します(詳細は、第2.65項「XMLQueryExecutionOptions構造体」を参照してください)。
XMLQueryExecutionOptions executionOptions	問合せ実行オプションを指定します(詳細は、第2.65項「XMLQueryExecutionOptions構造体」を参照してください)。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。ReportParams構造体の詳細は、第2.47項「ReportParams構造体」を参照してください。
String sessionID	セッションの一意のIDを指定します。

3.16.4.2 戻り値

QueryResults構造体の1行以上のデータとして、問合せの結果を戻します(詳細は、第2.41項「QueryResults構造体」を参照してください)。

3.16.5 fetchNext()メソッド

このメソッドを使用して、問合せで取得した行の次のページを戻します。

注意:

戻されたページには、行が含まれていない場合があります。完了フラグが設定されていない場合、残りの行は即座に使用できない場合があります。

3.16.5.1 シグネチャ

QueryResults fetchNext(String queryID, String sessionID);

引数	説明
String queryID	一意の問合せIDを指定します。これはQueryResultsオブジェクトで戻されます。
String sessionID	セッションの一意のIDを指定します。

3.16.5.2 戻り値

QueryResults構造体(詳細は、第2.41項「QueryResults構造体」を参照)の1行以上のデータとして、問合せ結果の次のページを戻します。

3.16.6 getPromptedFilters()メソッド

このメソッドを使用して、保存された分析のプロンプト列または、分析のXML定義からのプロンプト列を取得します。プロンプト列を含む分析を作成するには、これにisPrompted演算子を割り当てる必要があります。

3.16.6.1 シグネチャ

List[] getPromptedFilters(ReportRef report, String sessionID);

引数	説明
ReportRef report	分析のreportPathまたはreportXml (レポート定義)を指定します。
String sessionID	セッションの一意のIDを指定します。

3.16.7 upgradeXML()メソッド

このメソッドを使用して、プレゼンテーション・サービス・カタログの外に存在する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レポート定義を渡す場合、そのレポートは問合せが実行される前にアップグレードされます。

3.16.7.1 シグネチャ

String upgradeXML(String xml, String sessionID);

引数	説明
String xml	カタログ・オブジェクトのXMLを指定します。
String sessionID	セッションの一意のIDを指定します。