1 BI PublisherのWebサービスの概要

この章では、Oracle BI PublisherのWebサービスの概要について説明します。

内容は次のとおりです。

第1.1項「BI Publisher Webサービスについて」
第1.2項「WSDLへのアクセス」
第1.3項「インセッション・メソッドについて」
第1.4項「Webサービス・アプリケーションのデバッグ」

1.1 BI Publisher Webサービスについて

Oracle BI Publisher Webサービスでは、データ型とサービスがサポートされています。データ型には、ベース・データ型と複合データ型があります。Oracle BI Publisher Webサービスでは、XMLデータ型とJavaデータ型とのマッピングもサポートされています。サポートされているデータ型とマッピングの詳細は、第2章「Oracle BI PublisherのWebサービスのデータ型」を参照してください。

Oracle BI Publisherでは、次のパブリックWebサービスが提供されます。

ScheduleService: レポート・ジョブのスケジュール作成、レポート出力の取得、レポート履歴の管理など、スケジューラのタスクを実行するメソッドが提供されます。第3章「ScheduleService」を参照してください。
ReportService: レポートの実行、レポートに関する情報の取得、レポートの定義および変更、レポート・テンプレートのアップロードなど、BI PublisherのReportオブジェクトとやり取りするメソッドが提供されます。第4章「ReportService」を参照してください。
SecurityService: 認証、偽装、ログイン、ログアウト、アカウント管理など、セキュリティ操作に対応するメソッドが提供されます。第5章「SecurityService」を参照してください。
CatalogService: フォルダ、レポート、データ型、スタイル・テンプレート、サブテンプレートなど、レポート・カタログ・オブジェクトを管理する(作成、コピー、アップロード、ダウンロード、削除)メソッドが提供されます。第6章「CatalogService」を参照してください。

これらのサービスの多くのメソッドは、ペアで提供されます。1番目のサービスでは、ログインの資格証明が必要なステートレス操作がサポートされます。2番目のサービスでは、既存ユーザーのセッションIDを使用するインセッション操作がサポートされています。セッションIDは、SecurityServiceのlogin()メソッドまたはimpersonate()メソッドを介して取得されます。詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

1.2 WSDLへのアクセス

Oracle BI Publisherのインストールやデプロイを行うと、BI PublisherのWebサービスに関連付けられた一意のURLがあります。BI PublisherサーバーのURLを入力して、次のように「/services」を追加します。

http://<host>:<port>/xmlpserver/services/

このページでは、各レポート・サービスに対するWSDLへのアクセスが提供されます。11g Webサービスの場合は次のWSDLを使用します。

ScheduleService - v2/ScheduleService

WSDL: http://<host>:<port>/xmlpserver/services/v2/ScheduleService?wsdl
ReportService- v2/ReportService

WSDL: http://<host>:<port>/xmlpserver/services/v2/ReportService?wsdl
SecurityService - v2/SecurityService

WSDL: http://<host>:<port>/xmlpserver/services/v2/SecurityService?wsdl
CatalogService - v2/CatalogService

WSDL: http://<host>:<port>/xmlpserver/services/v2/CatalogService?wsdl

1.3 インセッション・メソッドについて

Oracle BI Publisher Webサービスには、deliveryServiceInSession()メソッド、createReportInSession()メソッド、copyObjectInSession()メソッドなど、インセッション・メソッドが用意されています。インセッション・メソッドを使用すると、アクティブなユーザー・セッションに対する様々な操作を実行できます。そのため、これらのメソッドはbipSessionToken文字列に依存しています。この文字列は、専用トークンとして機能し、ユーザーのログイン時に生成されます。

インセッション・メソッドを活用するには、ユーザーはSecurityService login()メソッドまたはimpersonate()メソッドを介してログインする必要があります。SecurityServiceのユーザー認証が正常に完了すると、BI PublisherサーバーはbipSessionToken文字列を生成します。このbipSessionToken文字列を使用すると、このガイドに記載されているすべてのインセッション操作を実行できます。

1.4 Webサービス・アプリケーションのデバッグ

Webサービス開発者として、SOAPリクエスト・メッセージを表示する必要が発生する場合があります。SOAPリクエスト・メッセージは、これらのリクエスト・メッセージに対するSOAPレスポンスとともにWebサービスを起動するために使用されます。これを実行するには、Apache Axis TCP Monitorユーティリティを使用します。このユーティリティを使用すると、SOAPメッセージ・フローを監視できます。その際、特別な構成の実行、サーバーの再起動、BI Publisherが稼働しているコンピュータへのアクセス権の取得などは必要ありません。

TCP Monitorをインストールするには、Apache Webサイト(apache.org)にアクセスし、axis.jarをコンピュータにダウンロードします。

TCP Monitorを起動するには、コマンド・ウィンドウを開き、axis.jarをダウンロードしたディレクトリにcdコマンドで移動します。次に、コマンド・ラインから次のコマンドを入力します。

% java -classpath axis.jar org.apache.axis.utils.tcpmon

次の画面が表示されます。

図1-1 サンプルAxis TCP Monitorウィンドウ

「図1-1 サンプルAxis TCP Monitorウィンドウ」の説明

TCP Monitorを構成するには、次の手順を実行します。

「Listen Port #」フィールドに、コンピュータで使用されていないローカル・ポートを入力します。TCP Monitorはそれを使用して、メッセージをリスニングします。たとえば、7777などです。
「Target Hostname」フィールドに、BI Publisherを稼働しているサーバーのホスト名を入力します。たとえば、mypublisher.foobar.com.exampleなどです。
「Target Port #」フィールドに、BI Publisherサーバーに使用されるポートを入力します。たとえば、9704などです。
「追加」ボタンをクリックします。ローカル・コンピュータのリスニング・ポート番号をリスニングする新規モニターが記載された新しいタブが表示されます。

これで、ブラウザ、SOAPユーティリティまたはアプリケーションを起動して、ローカル・コンピュータのリスニング・ポート(例: localmachine:7777/xmlpserver)を使用して、ローカル・コンピュータに対するコマンドを実行できます。TCP Monitorは、これらのリクエストをターゲット・ホストおよびポートにルーティングします。ここには、SOAPリクエスト・メッセージとレスポンス・メッセージが表示されます。これによってデバッグが容易になります。