Oracle Business Intelligence Publisher管理者および開発者ガイド

ヘッダーをスキップ

概要

PublicReportServiceは、Oracle BI PublisherのパブリックAPIをラップするWebサービスです。以下の一般的なカテゴリの操作がサポートされています。

権限の検証
レポートおよびリポジトリに関する情報の取得
レポートの実行
スケジュールされたレポートとその履歴の管理
レポートの作成と管理
レポート・サーバーに関する情報の取得

注意: Webサービスの詳細は、http://ws.apache.org/axis/java/user-guide.htmlを参照してください。

PublicReportServiceのWSDL定義

Oracle BI Publisherをインストールまたはデプロイすると、次のような一意のURLがPublicReportServiceに関連付けられます。

http://<host>:<port>/xmlpserver/services/PublicReportService?wsdl

このURLのホストおよびポート番号を適切な値に置き換えてブラウザに入力すると、BI Publisherで公式にサポートされているWebサービス用のWSDL（Webサービス記述言語）定義がすべて表示されます。

Oracle BI PublisherのWebサービスのデータ型

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

基本データ型
XMLデータ型とJavaデータ型のマッピング
複合型

基本データ型

Oracle BI PublisherのWebサービスでは、次の基本データ型が使用されます。


基本データ型	説明	例
xsd:boolean	ブール値	true、false
xsd:dateTime	日付と時刻	2007-10-26T21:32:52
xsd:int	整数	23
xsd:string	文字列	/Home/Shared/HR Reports/Salary Report
xsd:base64Binary	64ビットのバイナリ値	PDFまたはHTMLレポートなどのドキュメント

XMLデータ型とJavaデータ型のマッピング

BI PublisherのWebサービスでは、ドキュメント/リテラル形式が使用されます。WebサービスのXMLスキーマ・データ型とJavaデータ型のマッピングは、SOAP開発環境によって異なります。次の表は、Oracle JDeveloper環境用におけるマッピングを示しています。


基本データ型	Oracle JDeveloper
xsd:boolean	java.lang.Boolean
xsd:dateTime	java.util.Date
xsd:int	java.lang.Integer
xsd:string	java.lang.String
xsd:base64Binary	java.lang.Byte

複合型

Oracle BI PublisherのWebサービスでは、次の複合型が定義されて使用されます。

AccessDeniedException

<complexType name="AccessDeniedException">
 <sequence />
</complexType>

説明: 操作を実行するための適切な権限がユーザーの資格証明に付与されていない場合に返されるメッセージ。

ArrayOfItemData

<complexType name="ArrayOfItemData">
   <complexContent>
      <restriction base="soapenc:Array">
      <attribute ref="soapenc:arrayType"
wsdl:arrayType="impl:ItemData[]" />
      </restriction>
   </complexContent>
</complexType>

説明: ItemDataの配列 - レポート・リポジトリに格納されているオブジェクト。

ArrayOfParamNameValue

<complexType name="ArrayOfParamNameValue">
   <complexContent>
      <restriction base="soapenc:Array">
      <attribute ref="soapenc:arrayType" wsdl:arrayType="impl:ParamNameValue[]" />
      </restriction>
   </complexContent>
</complexType>

説明: ParamNameValueの配列。

ArrayOf_xsd_string

<complexType name="ArrayOf_xsd_string">
  <complexContent>
    <restriction base="soapenc:Array">
    <attribute ref="soapenc:arrayType" wsdl:arrayType="xsd:string[]"/>
    </restriction>
  </complexContent>
</complexType>

説明: 他の複合型で使用される文字列の配列。

DeliveryRequest

<complexType name="DeliveryRequest">
  <sequence>
    <element name="emailOption" nillable="true" type="impl:EMailDeliveryOption"/>
    <element name="faxOption" nillable="true" type="impl:FaxDeliveryOption"/>
    <element name="ftpOption" nillable="true" type="impl:FTPDeliveryOption"/>
    <element name="localOption" nillable="true" type="impl:LocalDeliveryOption"/>
    <element name="printOption" nillable="true" type="impl:PrintDeliveryOption"/>
    <element name="webDAVOption" nillable="true"
type="impl:WebDAVDeliveryOption"/>
  </sequence>
</complexType>

説明: 1つのレポートを複数の宛先に配信するためのオプションを提供するオブジェクト。この型は、次の複合型構造体で使用されます。

JobInfo

ScheduleRequest


パラメータ	型	説明
emailOption	EMailDeliveryOption	「EMailDeliveryOption」を参照してください。
faxOption	FaxDeliveryOption	「FaxDeliveryOption」を参照してください。
ftpOption	FTPDeliveryOption	「FTPDeliveryOption」を参照してください。
localOption	LocalDeliveryOption	「LocalDeliveryOption」を参照してください。
printOption	PrintDeliveryOption	「PrintDeliveryOption」を参照してください。
webDAVOption	WebDAVDeliveryOption	「WebDAVDeliveryOption」を参照してください。

EMailDeliveryOption

<complexType name="EMailDeliveryOption">
  <sequence>
    <element name="emailBCC" nillable="true" type="xsd:string"/>
    <element name="emailBody" nillable="true" type="xsd:string"/>
    <element name="emailCC" nillable="true" type="xsd:string"/>
    <element name="emailFrom" nillable="false" type="xsd:string"/>
    <element name="emailReplyTo" nillable="true" type="xsd:string"/>
    <element name="emailSubject" nillable="false" type="xsd:string"/>
    <element name="emailTo" nillable="false" type="xsd:string"/>
  </sequence>
</complexType>

説明: レポートを電子メールで配信するために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。


パラメータ	型	説明
emailBCC	string	電子メールのブラインド・カーボン・コピーを受信するための電子メール・アドレス。
emailBody	string	電子メールの本文として表示されるテキスト文字列。
emailCC	string	電子メールのカーボン・コピーを受信するための電子メール・アドレス。
emailFrom	string	送信者アドレスとして表示される電子メール・アドレス。
emailReplyTo	string	返信先フィールドに表示するための電子メール・アドレス。
emailSubject	string	電子メールの件名行。
emailTo	string	電子メールの送信先アドレス。

FaxDeliveryOption

<complexType name="FaxDeliveryOption">
  <sequence>
    <element name="faxNumber" nillable="false" type="xsd:string"/>
    <element name="faxServer" nillable="false" type="xsd:string"/>
  </sequence>
</complexType>

説明: レポートをFAXで配信するために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。


パラメータ	型	説明
faxNumber	string	FAXの送信先番号（例: 916505069560）。
faxServer	string	FAXの送信先FAXサーバー（例: ipp://mycupsserver:631/printers/fax2）。

FTPDeliveryOption

<complexType name="FTPDeliveryOption">
  <sequence>
    <element name="ftpServerName" nillable="false" type="xsd:string"/>
    <element name="ftpUserName" nillable="false" type="xsd:string"/>
    <element name="ftpUserPassword" nillable="false" type="xsd:string"/>
    <element name="remoteFile" nillable="false" type="xsd:string"/>
    <element name="sftpOption" type="xsd:boolean"/>
  </sequence>
</complexType>

説明: レポートをFTPで配信するために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。


パラメータ	型	説明
ftpServerName	string	FTPサーバーの名前（例: myftpserver.mycompany.com）。
ftpUserName	string	FTPサーバーのユーザー名。
ftpUserPassword	string	入力されたユーザーのパスワード。
remoteFile	string	サーバー上のファイルに割り当てる名前（例: report.pdf）。
sftpOption	boolean	trueは、セキュアなFTPオプションを使用することを意味します。

InvalidParametersException

<complexType name="InvalidParametersException">
 <sequence />
</complexType>

説明: 無効なパラメータがWebサービス操作に渡された場合に返されるメッセージ。

ItemData

<complexType name="ItemData">
  <sequence>
    <element name="absolutePath" nillable="true" type="xsd:string"/>
    <element name="creationDate" nillable="true" type="xsd:dateTime"/>
    <element name="displayName" nillable="true" type="xsd:string"/>
    <element name="fileName" nillable="true" type="xsd:string"/>
    <element name="lastModified" nillable="true" type="xsd:dateTime"/>
    <element name="lastModifier" nillable="true" type="xsd:string"/>
    <element name="owner" nillable="true" type="xsd:string"/>
    <element name="parentAbsolutePath" nillable="true" type="xsd:string"/>
    <element name="type" nillable="true" type="xsd:string" />
  </sequence>
</complexType>

説明: レポート・リポジトリに格納されているオブジェクトの説明。


パラメータ	型	説明
absolutePath	string	レポート・オブジェクトのパス（例: /HR Manager/HR Reports/Employee Listing.xdo）。
creationDate	dateTime	レポート・オブジェクトの作成日。
displayName	string	レポート・オブジェクトの表示名（例: Employee Listing）。
fileName	string	レポート・オブジェクトのファイル名（例: Employee Listing.xdo）。
lastModified	dateTime	レポート・オブジェクトの最終更新日。
lastModifier	string	レポートを最後に変更したユーザー名。
owner	string	レポート所有者のユーザー名。
parentAbsolutePath	string	親フォルダの絶対パス。たとえば、絶対パスが/HR Manager/HR Reports/Employee Listing.xdoであるレポートのparentAbsolutePathは、/HR Manager/HR Reportsです。
type	string	アイテムのタイプ。設定可能な値は、reportまたはfolderです。

JobHistoryInfo

<complexType name="JobHistoryInfo">
  <sequence>
     <element name="createdDate" nillable="true" type="xsd:dateTime"/>
     <element name="documentDataAvailable" type="xsd:boolean"/>
     <element name="documentDataContentType" nillable="true" type="xsd:string"/>
     <element name="documentOutput" nillable="true" type="xsd:base64Binary"/>
     <element name="jobID" type="xsd:int"/>
     <element name="jobMessage" nillable="true" type="xsd:string"/>
     <element name="jobName" nillable="true" type="xsd:string"/>
     <element name="outputID" type="xsd:int"/>
     <element name="reportData" nillable="true" type="xsd:base64Binary"/>
     <element name="reportDataAvailable" type="xsd:boolean"/>
     <element name="reportDataContentType" nillable="true" type="xsd:string"/>
     <element name="reportName" nillable="true" type="xsd:string"/>
     <element name="reportURL" nillable="true" type="xsd:string"/>
     <element name="status" nillable="true" type="xsd:string"/>
     <element name="statusDetail" nillable="true" type="xsd:string"/>
     <element name="userName" nillable="true" type="xsd:string"/>
     <element name="username" nillable="true" type="xsd:string"/>
    </sequence>
</complexType>

説明: ジョブ履歴に関するパラメータを列挙します。


パラメータ	型	説明
createdDate	dateTime	レポート・ジョブが作成された日付。
documentDataAvailable	boolean	trueは、レポートのスケジュール時に「出力の保存」オプションが選択されたことを意味します。
documentDataConentType	string	生成されたドキュメントのコンテンツ・タイプ。設定可能な値は次のとおりです。 text/html;charset=UTF-8 text/plain;charset=UTF-8 application/pdf application/vnd.ms-powerpoint application/vnd.ms-excel application/msword application/x-shockwave-flash text/xml message/rfc822
documentOutput	base64binary	出力ドキュメント。
jobID	integer	BI Publisherによってジョブに割り当てられた識別番号。
jobMessage	string	スケジュールされたレポートが実行されると、スケジューラによって、そのジョブに関連付けられたプレーンテキスト・メッセージが生成されます。これは、次のような詳細情報を含むサーバー・メッセージです。 {pstatus=success, job_tz=America/Dawson, job_cal=GREGORIAN, job_locale=en_US, dstatus=success, dstatus4=nstarted, dstatus3=nstarted, dstatus2=nstarted, dstatus1=nstarted, dstatus0=nstarted} ... また、エラーの場合は次のようなエラー・メッセージも表示されます。 {pstatus=success, job_tz=Asia/Chongqing, job_cal=GREGORIAN, job_locale=zh_CN, dstatus=success, dstatus4=nstarted, dstatus3=nstarted, dstatus2=nstarted, dstatus1=nstarted, dstatus0=failed, ...
jobName	string	ユーザーによって割り当てられたジョブ名。
outputID	integer	履歴内のレポートの識別番号。1つのスケジュールされたJobIDを複数のoutputIDまたはhistoryIDに関連付けることができます。これは、1つのスケジュールされたレポートを何回も実行または再公開できるためです。
reportData	base64binary	レポート・データ・モデルによって生成されたXMLデータ。
reportDataAvailable	boolean	trueは、レポートのスケジュール時に「再公開用にデータを保存」が選択されたことを意味します。
reportDataContentType	string	BI Publisherがレポートを生成するために使用するXMLデータのコンテンツ・タイプの値。この値は、text/xmlです。
reportName	string	レポートの名前。
reportURL	string	レポートの絶対パスURL（例: /HR Manager/HR Reports/Employee Listing.xdo）。
status	string	有効な値は、Completed、Error、Running、Scheduled、SuspendedおよびUnknownです。
statusDetail	string	BI Publisherサーバーからの詳細なステータス情報。
username	string	レポートをスケジュールしたユーザー（例: Administrator）。

JobInfo

<complexType name="JobInfo">
   <sequence>
     <element name="burstingOption" type="xsd:boolean"/>
     <element name="createdDate" nillable="true" type="xsd:dateTime"/>
     <element name="deliveryDescription" nillable="true" type="xsd:string"/>
     <element name="deliveryParameters" nillable="true" type="impl:DeliveryRequest"/>
     <element name="endDate" nillable="true" type="xsd:dateTime"/>
     <element name="jobGroup" nillable="true" type="xsd:string"/>
     <element name="jobID" type="xsd:int"/>
     <element name="jobName" nillable="true" type="xsd:string"/>
     <element name="locale" nillable="true" type="xsd:string"/>
     <element name="reportName" nillable="true" type="xsd:string"/>
     <element name="reportParameters" nillable="true" type="impl:ArrayOfParamNameValue"/>
     <element name="reportSet" type="xsd:boolean"/>
     <element name="reportURL" nillable="true" type="xsd:string"/>
     <element name="runType" nillable="true" type="xsd:string"/>
     <element name="scheduleDescription" nillable="true" type="xsd:string"/>
     <element name="scheduleParameters" nillable="true" type="xsd:string"/>
     <element name="startDate" nillable="true" type="xsd:dateTime"/>
     <element name="status" nillable="true" type="xsd:string"/>
     <element name="username" nillable="true" type="xsd:string"/>
    </sequence>
</complexType>

説明: ジョブ・リクエストに関する情報の集合。


パラメータ	型	説明
burstingOption	boolean	trueは、バースト・オプションがオンになっていることを意味します。
createdDate	dateTime	ジョブが作成された日付。
deliveryDescription	string	スケジュールされた配信の説明。現在の実装では、このパラメータはNULLを返します。
deliveryParameters	DeliveryRequest	「DeliveryRequest」を参照してください。
endDate	dateTime	ジョブが終了した日付。
jobGroup	string	現在の実装では、このパラメータはuserIDを返します。特定ユーザーのスケジュールされたリクエストを問い合せると、jobGroupによって、そのユーザーに属しているスケジュールされたリクエストのグループが参照されます。
jobID	integer	BI Publisherによってジョブ・リクエストに割り当てられた識別番号。
jobName	string	ユーザーによって割り当てられたジョブ名。
locale	string	スケジュールされたレポートに対してユーザーが選択したロケール。
reportName	string	レポートの名前。
reportParameters	ArrayOfParamNameValue	「ArrayOfParamNameValue」を参照してください。
reportSet	boolean	trueは、そのレポートが特定のレポート・セットのメンバであることを意味します。現在の実装では常にfalseが返されます。
reportURL	string	レポートの絶対パスURL（例: /HR Manager/Employee Reports/Employee Salary Report.xdo）。
runType	string	設定可能な値は、Run Once OnlyまたはRun Recurringです。
scheduleDescription	string	レポートのスケジュールに関する説明。現在の実装では、このパラメータはNULLを返します。
scheduleParameters	string	「ScheduleRequest」を参照してください。
startDate	dateTime	スケジュールの開始日。
status	string	スケジュールされたジョブ・リクエストのステータス。有効な値は、Canceled、Done、Scheduled、SuspendedおよびUnknownです。
username	string	ジョブ・リクエストを発行したユーザー名。

JobStatus

<complexType name="JobStatus">
    <sequence>
     <element name="jobID" nillable="true" type="xsd:string"/>
     <element name="jobStatus" nillable="true" type="xsd:string"/>
     <element name="message" nillable="true" type="xsd:string"/>
    </sequence>
   </complexType>

説明: スケジュールされたジョブのステータスに関する説明。


パラメータ	型	説明
jobID	string	BI Publisherによってジョブ・リクエストに割り当てられた識別番号。
jobStatus	string	ジョブ・リクエストのステータス。設定可能な値は、Completed、Error、Running、Scheduled、SuspendedおよびUnknownです。
message	string	BIPスケジューラのサーバー・メッセージ文字列。

LocalDeliveryOption

<complexType name="LocalDeliveryOption">
  <sequence>
    <element name="destination" nillable="false" type="xsd:string"/>
  </sequence>
</complexType>

説明: BI Publisherリポジトリにレポートを配信するために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。


パラメータ	型	説明
destination	string	ローカル・サーバー上のBI Publisherリポジトリのファイル・パス。

OperationFailedException

<complexType name="OperationFailedException">
  <sequence />
</complexType>

説明: 操作が失敗したときに返されるメッセージ。

ParamNameValue

<complexType name="ParamNameValue">
   <sequence>
      <element name="multiValuesAllowed" type="xsd:boolean" />
      <element name="name" nillable="true" type="xsd:string" />
      <element name="values" nillable="true" type="impl:ArrayOf_xsd_string" />
   </sequence>
</complexType>

説明: パラメータ名と、パラメータ値の配列。


パラメータ	型	説明
multiValuesAllowed	boolean	trueは、パラメータに複数の値が含まれている可能性があることを意味します。
name	string	パラメータの名前。
values	ArrayOf_xsd_string	「ArrayOf_xsd_string」を参照してください。

PrintDeliveryOption

<complexType name="PrintDeliveryOption">
  <sequence>
    <element name="printNumberOfCopy" nillable="true" type="xsd:string"/>
    <element name="printRange" nillable="true" type="xsd:string"/>
    <element name="printSide" nillable="true" type="xsd:string"/>
    <element name="printTray" nillable="true" type="xsd:string"/>
     <element name="printerName" nillable="false" type="xsd:string"/>
  </sequence>
</complexType>

説明: レポートをプリンタに配信するために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。


パラメータ	型	説明
printNumberOfCopy	string	印刷するコピー部数。
printRange	string	印刷するページの範囲。複数の範囲はカンマで区切ります（例: 1,3-5,8-10）。
printSide	string	有効な値は、Single sided、Double Sided Long Edge (Duplex)、およびDouble Sided Short Edge (Tumble)です。
printTray	string	有効な値は、Default、Tray 1、Tray 2およびTray 3です。
printerName	string	レポートの送信先プリンタの名前。

ReportDataChunk

<complexType name="ReportDataChunk">
   <sequence>
      <element name="reportDataChunk" nillable="true" type="xsd:base64Binary"/>
      <element name="reportDataFileID" nillable="true" type="xsd:string"/>
      <element name="reportDataOffset" type="xsd:long"/>
   </sequence>
</complexType>


パラメータ	型	説明
reportDataChunk	xsd64binary	レポート・データ。
reportDataFileID	string	レポート・ファイルの識別子。
reportDataOffset	long	チャンクのデータ部分までのオフセット。

ReportDefinition

<complexType name="ReportDefinition">
   <sequence>
      <element name="autoRun" type="xsd:boolean"/>
      <element name="cacheDocument" type="xsd:boolean"/>
      <element name="defaultOutputFormat" nillable="true" type="xsd:string" />
      <element name="defaultTemplateId" nillable="true" type="xsd:string" />
      <element name="diagnostics" type="xsd:boolean"/>
      <element name="listOfTemplateFormatsLabelValues" nillable="true" type="impl:ArrayOfTemplateFormatsLabelValues"/>
      <element name="onLine" type="xsd:boolean"/>
      <element name="openLinkInNewWindow" type="xsd:boolean"/>
      <element name="parameterColumns" type="xsd:int"/>
      <element name="parameterNames" nillable="true"
        type="impl:ArrayOf_xsd_string" />
      <element name="reportParameterNameValues" nillable="true"
        type="impl:ArrayOfParamNameValue" />
      <element name="reportDefnTitle" nillable="true" type="xsd:string"/>
      <element name="reportDescription" nillable="true" type="xsd:string"/>
      <element name="reportName" nillable="true" type="xsd:string"/>
      <element name="reportParameterNameValues" nillable="true" type="impl:ArrayOfParamNameValue"/>
      <element name="reportType" nillable="true" type="xsd:string"/>
      <element name="showControls" type="xsd:boolean"/>
      <element name="showReportLinks" type="xsd:boolean"/>
      <element name="templateIds" nillable="true" type="impl:ArrayOf_xsd_string" />
      <element name="useExcelProcessor" type="xsd:boolean"/>
   </sequence>
</complexType>

説明: getReportDefinitionから返されるオブジェクト。


パラメータ	型	説明
autoRun	boolean	trueは、レポート・プロパティの「オートラン」がオンになっていることを意味します。
cacheDocument	boolean	trueは、レポート・プロパティの「ドキュメント・キャッシュの有効化」がオンになっていることを意味します。
defaultOutputFormat	string	デフォルトの出力フォーマット。有効な値は、pdf、rtf、html、flash、csv、data、mhtml、excel、excel2000およびpowerpointです。
defaultTemplateId	string	そのレポートに対して特定されたデフォルトのテンプレート。
diagnostics	boolean	trueは、そのレポートに対して診断がオンになっていることを意味します。
listOfTemplateFormatsLabelValues	ArrayOfTemplateFormatsLabelValues	ArrayOfTemplateFormatsLabelValues構造体経由でテンプレート・フォーマット・ラベルのリストを渡します。
onLine	boolean	trueは、レポート・プロパティの「レポート・オンラインの実行」がオンになっていることを意味します。
openLinkInNewWindow	boolean	trueは、レポート・プロパティの「新規ウィンドウでリンクを開く」がオンになっていることを意味します。
parameterColumns	integer	レポート・プロパティの「行当たりのパラメータ数」の値。
parameterNames	ArrayOf_xsd_string	ArrayOf_xsd_string構造体経由でレポートに対して定義されたパラメータ名を渡します。
reportParameterNameValues	ArrayOfParamNameValue	ArrayOfParamNameValue構造体経由でレポート名と値のペアを渡します。
reportType	string	現在はNULLを返します。
showControls	boolean	trueは、レポート・プロパティの「コントロールの表示」がオンになっていることを意味します。
showReportLinks	boolean	trueは、レポート・プロパティの「レポート・リンクの表示」がオンになっていることを意味します。
templateIds	ArrayOf_xsd_string	ArrayOf_xsd_string構造体経由でレポート・テンプレートのレイアウト名を渡します。
useExcelProcessor	boolean	trueは、レポート・プロパティの「Analyzer for Excelからのクライアント・アクセスを無効化」がオンになっていないことを意味します。

ReportRequest

<complexType name="ReportRequest">
   <sequence>
      <element name="attributeFormat" nillable="true" type="xsd:string"/>
      <element name="attributeLocale" nillable="true" type="xsd:string"/>
      <element name="attributeTemplate" nillable="true" type="xsd:string"/>
      <element name="flattenXML" type="xsd:boolean"/>
      <element name="parameterNameValues" nillable="true"
type="impl:ArrayOfParamNameValue"/>
       <element name="reportAbsolutePath" nillable="false" type="xsd:string"/>
       <element name="reportData" nillable="true" type="xsd:base64Binary"/>
      <element name="reportDataFileName" nillable="true" type="xsd:string"/>
      <element name="sizeOfDataChunkDownload" type="xsd:int"/>
   </sequence>
</complexType>

説明: レポートを実行するために必要な設定の集合。attributeFormatの許容可能な値は、使用されているテンプレートのタイプによって異なることに注意してください（たとえば、PDFテンプレートはPDF出力しか生成できません）。


パラメータ	型	説明
attributeFormat	string	要求されたレポートの出力フォーマット。有効な値は、pdf、rtf、html、excel、excel2000、mhtml、csv、data、flashおよびpowerpointです。
attributeLocale	string	レポートのロケール選択（例: fr-FR）。
attributeTemplate	string	レポートに適用するテンプレート（例: Employeelisting.rtf）。
flattenXML	boolean	trueは、XMLがフラット化されることを意味します。ExcelではXMLデータ構造をフラット化する必要があるため、このフラグはAnalyzer for Microsoft Excelに対して使用されます。
parameterNameValues	ArrayOfParamNameValue	ArrayOfParamNameValue構造体経由で渡される、このレポート・リクエストの発行に使用されるパラメータ名と値のペア。
reportAbsolutePath	string	BI Publisherリポジトリ内のレポートの絶対パス（例: /HR Manager/HR Reports/Employee Listing.xdo）。
reportData	base64binary	レポートに直接データを入力する場合は、この要素を使用してデータを渡します。
reportDataFileName	string	レポートを作成するためにデータ・ファイルを使用する場合は、そのデータ・ファイル名を入力します。
sizeOfDataChunkDownload	integer	flattenXMLをtrueに設定した場合、またはデータをチャンクしない場合は、このパラメータを-1に設定して、すべてのデータをクライアントに返します。

ReportResponse

<complexType name="ReportResponse">
   <sequence>
      <element name="reportBytes" nillable="true" type="xsd:base64Binary" />
      <element name="reportContentType" nillable="true" type="xsd:string" />
      <element name="reportLocale" nillable="true" type="xsd:string" />
   </sequence>
</complexType>

説明: runReport操作から返されるドキュメント（ReportRequest内でattributeFormatに設定されているファイル形式）、ドキュメント・タイプ、およびドキュメント・ロケール。


パラメータ	型	説明
reportBytes	base64binary	レポートのバイナリ・データ出力。
reportContentType	string	レポートのコンテンツ・タイプ。設定可能な値は次のとおりです。 text/html;charset=UTF-8 text/plain;charset=UTF-8 application/pdf application/vnd.ms-powerpoint application/vnd.ms-excel application/msword application/x-shockwave-flash text/xml message/rfc822
reportLocale	string	レポートに対して選択されたロケール（例: fr-FR）。

ScheduleRequest

<complexType name="ScheduleRequest">
  <sequence>
    <element name="cronExpression" nillable="true" type="xsd:string"/>
    <element name="deliveryRequest" nillable="false"
type="impl:DeliveryRequest"/>
    <element name="endDate" nillable="true" type="xsd:dateTime"/>
    <element name="jobCalendar" nillable="true" type="xsd:string"/>
    <element name="jobLocale" nillable="true" type="xsd:string"/>
    <element name="jobTZ" nillable="true" type="xsd:string"/>
    <element name="notificationTo" nillable="true" type="xsd:string"/>
    <element name="notifyWhenFailed" type="xsd:boolean" />
    <element name="notifyWhenSuccess" type="xsd:boolean" />
    <element name="notifyWhenWarning" type="xsd:boolean" />
    <element name="repeatCount" type="xsd:int"/>
    <element name="repeatInterval" type="xsd:int"/>
    <element name="reportRequest" nillable="false" type="impl:ReportRequest"/>
    <element name="saveDataOption" type="xsd:boolean" />
    <element name="saveOutputOption" type="xsd:boolean" />
    <element name="scheduleBurstingOption" type="xsd:boolean" />
    <element name="schedulePublicOption" type="xsd:boolean" />
    <element name="startDate" nillable="true" type="xsd:dateTime"/>
    <element name="useUTF8Option" type="xsd:boolean" />
    <element name="userJobName" nillable="true" type="xsd:string"/>
  </sequence>
</complexType>

説明: レポートをスケジュールするためのオプション。


パラメータ	型	説明
cronExpression	string	反復スケジュールを定義するCron式。
deliveryRequest	DeliveryRequest	必須。スケジュールされたリクエストに関する、DeliveryRequest構造体経由の配信情報を格納します。
endDate	dateTime	スケジュールの終了日。
jobCalendar	string	スケジュールされたリクエストに使用するレポート・フォーマット・カレンダ。有効な値は、Gregorian、Arabic Hijrah、English Hijrah、Japanese Imperial、Tha BuddhaおよびROC Officialです。
jobLocale	string	スケジュールされたリクエストに使用するロケール（例: fr-FR）。
jobTZ	string	スケジュールされたリクエストに使用するタイム・ゾーン。
notificationTo	string	通知の送信先電子メール・アドレス。
notifyWhenFailed	boolean	trueは、ジョブ・リクエストが失敗した場合に通知を送信することを意味します。
notifyWhenSuccess	boolean	trueは、ジョブ・リクエストが成功した場合に通知を送信することを意味します。
notifyWhenWarning	boolean	trueは、ジョブが警告を伴って終了したときに通知を送信することを意味します。
repeatCount	integer	スケジュールを繰り返す回数。レポートの反復スケジュールでは、startDateをNULL以外の値に設定し、すべての意味のあるスケジュールに対して、repeatCountとrepeatIntervalを0より大きい値に設定する必要があります。endDateにはNULLを設定できます。
repeatInterval	integer	2つのスケジュールされたジョブ間の秒単位の間隔。
reportRequest	ReportRequest	ReportRequest構造体経由で格納されるリクエストに関する情報。
saveDataOption	boolean	trueは、スケジュールされたリクエスト実行のレポート・データが保存されることを意味します。
saveOutputOption	boolean	trueは、スケジュールされたリクエスト実行のレポート出力が保存されることを意味します。
scheduleBurstingOption	boolean	trueは、スケジュールされたリクエストがバーストされることを意味します。
schedulePublicOption	boolean	trueは、スケジュールされたリクエストが公開されることを意味します。
startDate	dateTime	スケジュールが開始される日付。
useUTF8Option	boolean	trueは、「Unicode（UTF8）を使用」オプションが有効になっていることを意味します。
userJobName	string	スケジュールされたジョブに対してユーザーが入力した名前。

WebDAVDeliveryOption

<complexType name="WebDAVDeliveryOption">
  <sequence>
    <element name="deliveryAuthType" nillable="true" type="xsd:string"/>
    <element name="deliveryAuthTypeBasic" nillable="true" type="xsd:string"/>
    <element name="deliveryAuthTypeDigest" nillable="true" type="xsd:string"/>
    <element name="password" nillable="true" type="xsd:string"/>
    <element name="remoteFilePath" nillable="false" type="xsd:string"/>
    <element name="server" nillable="false" type="xsd:string"/>
    <element name="userName" nillable="true" type="xsd:string"/>
  </sequence>
</complexType>


パラメータ	型	説明
deliveryAuthType	string	認証タイプ。有効な値は、None、Basic、Digestです。
deliveryAuthTypeBasic	string	Basic認証タイプを説明するための要素。
deliveryAuthTypeDigest	string	Digest認証タイプを説明するための要素。
password	string	プロキシ・サーバーが設定されている場合に、プロキシ・サーバーへのアクセスに必要なパスワード。
remoteFilePath	string	レポート・ファイルの配信先リモート・サーバー上のディレクトリのパス。
server	string	webDAVサーバー名（例: myserver）。
userName	string	プロキシ・サーバーが設定されている場合に、プロキシ・サーバーへのアクセスに必要なユーザー名。

説明: レポートのWebDAV（Web-based Distributed Authoring and Versioning）配信のために設定するオプション。

この型は、DeliveryRequest複合型構造体で使用されます。

BI PublisherのWebサービス操作

Oracle BI PublisherのWebサービスで使用可能な操作を、以下のカテゴリごとに説明します。

権限の検証
レポートおよびリポジトリに関する情報の取得
レポートの実行
スケジュールされたレポートとその履歴の管理
レポートの作成と管理
レポート・サーバーに関する情報の取得

この項では、入力メッセージ、出力メッセージ、および発生する可能性のある例外メッセージについて説明し、各操作のサンプル・コードについても記載します。

権限の検証

権限を検証するための操作には、以下が含まれます。

validateLogin
hasReportAccess

validateLogin

validateLoginは、userIDとpasswordにOracle BI Publisherのレポート・サーバーにアクセスするための権限が付与されていることを検証します。

入力メッセージ: validateLoginRequest
パラメータ	型	Nullを許容（Nillable）	説明
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: validateLoginResponse
パラメータ	型	Nullを許容（Nillable）	説明
validateLoginReturn	boolean	N/A	trueは、要求された権限がログインIDに付与されていることを意味します。

hasReportAccess

hasReportAccessは、userIDとpasswordに特定のレポートにアクセスするための権限が付与されていることを検証します。

入力メッセージ: hasReportAccessRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	レポートのディレクトリ・パス（例: /HR Manager/Employee Reports/Employee Listing.xdo）。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: hasReportAccessResponse
パラメータ	型	Nullを許容（Nillable）	説明
hasReportAccessReturn	boolean	N/A	trueは、要求された権限がユーザーに付与されていることを意味します。

発生する可能性のある例外

InvalidParametersException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

レポートおよびリポジトリに関する情報の取得

レポートおよびリポジトリに関する情報を取得するための操作には、以下が含まれます。

getFolderContents
getReportDefinition
getReportParameters

getFolderContents

getFolderContentsは、フォルダ内のすべてのアイテムを取得します。この操作では、指定されたフォルダ内のすべてのレポートとフォルダが返されます。これらのアイテムを使用して、実行するレポートや、さらに検索を行ってレポートを特定するフォルダを決定できます。

入力メッセージ: getFolderContentsRequest
パラメータ	型	Nullを許容（Nillable）	説明
folderAbsolutePath	string	いいえ	内容を取得したいフォルダのパス（例: /HR Manager/Employee Reports/）。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: getFolderContentsResponse
パラメータ	型	Nullを許容（Nillable）	説明
getFolderContentsReturn	ItemData	N/A	「ItemData」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

使用上の注意

folderAbsolutePathの値（例: <folderAbsolutePath xsi:type="xsd:string"></folderAbsolutePath>）を渡さなかった場合は、Shared Foldersの内容および入力したユーザーのMy Foldersの内容が返されます。
folderAbsolutePathとして$HOME（例: <folderAbsolutePath xsi:type="xsd:string">$HOME</folderAbsolutePath>）を渡した場合は、Usersフォルダの下のすべての内容が返されます。

getReportDefinition

getReportDefinitionは、デフォルトのテンプレート、出力タイプ、テンプレートIDのリストなど、レポートに関する情報を取得します。テンプレートIDのリストを取得すれば、デフォルト以外のテンプレートを使ってレポートを作成できます。

入力メッセージ: getReportDefinitionRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	レポート定義を取得したいレポートのパス（例: /HR Manager/Employee Reports/Employee Listing.xdo）。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: getReportDefinitionResponse
パラメータ	型	Nullを許容（Nillable）	説明
getReportDefinitionReturn	ReportDefinition	N/A	「ReportDefinition」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

getReportParameters

getReportParametersは、レポート・パラメータとそのデフォルト値の配列を取得します。パラメータのリストを取得すれば、そのパラメータに値を設定してレポートを実行またはスケジュールできます。

入力メッセージ: getReportParametersRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportRequest	ReportRequest	N/A	「ReportRequest」を参照してください。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: getReportParametersResponse
パラメータ	型	Nullを許容（Nillable）	説明
getReportParametersReturn	ParamNameValue	N/A	「ParamNameValue」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

レポートの実行

レポートを実行するための操作には、以下が含まれます。

runReport
uploadReportDataChunk
downloadReportDataChunk

runReport

runReportは、レポートを実行し、生成されたドキュメントを返します。ドキュメントは指定したファイル形式で返されることに注意してください。

入力メッセージ: runReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportRequest	ReportRequest	N/A	「ReportRequest」を参照してください。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: runReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
runReportReturn	ReportResponse	N/A	「ReportResponse」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

uploadReportDataChunk

入力メッセージ: uploadReportDataChunkRequest
パラメータ	型	Nullを許容（Nillable）	説明
fileID	string	いいえ	最初のコールではfileIDを指定する必要がありません。最初のXMLデータのチャンクのアップロードが成功すると、ファイル名などのfileIDが返されます。その後のコールでは、同じfileIDを指定して同じファイルにその後のデータ・チャンクを追加できます。
reportDataChunk	base64binary	N/A	XMLデータ。

出力メッセージ: uploadReportDataChunkResponse
パラメータ	型	Nullを許容（Nillable）	説明
uploadReportDataChunkReturn	string	いいえ	返されるレスポンス。

downloadReportDataChunk

入力メッセージ: downloadReportDataChunkRequest
パラメータ	型	Nullを許容（Nillable）	説明
fileID	string	いいえ	最初のコールではfileIDを指定する必要がありません。最初のXMLデータのチャンクのアップロードが成功すると、ファイル名などのfileIDが返されます。その後のコールでは、同じfileIDを指定して同じファイルにその後のデータ・チャンクを追加できます。
beginIdx	integer	N/A	オフセット。
size	integer	N/A	KB単位のファイルのサイズ。

出力メッセージ: downloadReportDataChunkResponse
パラメータ	型	Nullを許容（Nillable）	説明
downloadReportDataChunkReturn	ReportDataChunk	いいえ	「ReportDataChunk」を参照してください。

スケジュールされたレポートとその履歴の管理

スケジュールされたレポートとその履歴を管理するための操作には、以下が含まれます。

scheduleReport
suspendScheduledReport
resumeScheduledReport
deleteScheduledReport
getScheduledReportInfo
getScheduledReportHistoryInfo
deleteScheduledReportHistory
getScheduledReportStatus

scheduleReport

scheduleReportは、レポートをスケジュールして実行し、プリンタ、FAX、電子メール、WebDAV、FTPのいずれかに配信したり、単にレポート・リポジトリに保存したりします。ジョブは、すぐに実行するようにスケジュールしたり、一度だけ実行するか反復実行するようにスケジュールでき、反復実行ではジョブを中止する終了日を設定できます。この操作では、レポート・ジョブのスケジューリングが成功したときにJobIDが返されます。

入力メッセージ: scheduleReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduleRequest	ScheduleRequest	N/A	「ScheduleRequest」を参照してください。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: scheduleReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
scheduleReportReturn	string	いいえ	返されるレスポンス。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

suspendScheduledReport

suspendScheduledReportは、スケジュールされたレポートを一時停止します。

入力メッセージ: suspendScheduledReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: suspendScheduledReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
suspendScheduledReportReturn	boolean	N/A	trueは、レポートが一時停止していることを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

resumeScheduledReport

resumeScheduledReportは、一時停止されたスケジュール・レポートを再開します。

入力メッセージ: resumeScheduledReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたジョブのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: resumeScheduledReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
resumeScheduledReportReturn	boolean	N/A	trueは、スケジュールが再開されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

deleteScheduledReport

deleteScheduledReportは、スケジュールされたレポートを削除します。

入力メッセージ: deleteScheduledReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: deleteScheduledReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
deleteScheduledReportReturn	boolean	N/A	trueは、スケジュールが削除されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

getScheduledReportInfo

getScheduledReportInfoは、スケジュールされたレポートに関する情報を取得します。

入力メッセージ: getScheduledReportInfoRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。
viewByFilter	string	いいえ	選択された表示方法のカテゴリ。有効な値は、My History、Public HistoryまたはAllです。

出力メッセージ: getScheduledReportInfoResponse
パラメータ	型	Nullを許容（Nillable）	説明
getScheduledReportInfoReturn	JobInfo	N/A	「JobInfo」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

getScheduledReportHistoryInfo

getScheduledReportHistoryInfoは、スケジュールされたレポートに関する履歴情報を取得します。

入力メッセージ: getScheduledReportHistoryInfoRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。
viewByFilter	string	いいえ	選択された表示方法のカテゴリ。有効な値は、My History、Public HistoryまたはAllです。
DownloadReport	boolean	いいえ	trueは、レポートのダウンロードを指定します。

出力メッセージ: getScheduledReportHistoryInfoResponse
パラメータ	型	Nullを許容（Nillable）	説明
getScheduledReportHistoryInfoReturn	JobHistoryInfo	N/A	「JobHistoryInfo」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

deleteScheduledReportHistory

deleteScheduledReportHistoryは、スケジュールされたレポートに関する履歴情報を削除します。

入力メッセージ: deleteScheduledReportHistoryRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: deleteScheduledReportHistoryResponse
パラメータ	型	Nullを許容（Nillable）	説明
deleteScheduledReportHistoryReturn	boolean	N/A	trueは、レポートが履歴から削除されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

getScheduledReportStatus

getScheduledReportStatusは、スケジュールされたレポートに関するステータス情報を取得します。

入力メッセージ: getScheduledReportStatusRequest
パラメータ	型	Nullを許容（Nillable）	説明
scheduledJobID	string	いいえ	スケジュールされたレポートのジョブID。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: getScheduledReportStatusResponse
パラメータ	型	Nullを許容（Nillable）	説明
getScheduledReportStatusReturn	JobStatus	N/A	「JobStatus」を参照してください。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

レポートの作成と管理

レポートを作成および管理するための操作には、以下が含まれます。

createReport
deleteReport
updateReportDefinition
createReportFolder
uploadTemplateForReport
removeTemplateForReport
removeTemplateForReport
uploadReport
downloadReport

createReport

createReportは、空のレポート定義を使用して、BI Publisherレポート・リポジトリ内に新しいレポートを作成します。

入力メッセージ: createReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportName	string	いいえ	サフィックスに.xdoを付けて作成するレポート名（例: myreport.xdo）。
reportAbsolutePathURL	string	いいえ	作成したレポートを配置するフォルダのパス（例: xmlp/Reports/financials）。
templateFileName	string	はい	適用するテンプレートのファイル名。
templateData	base64Binary	はい	テンプレートを直接含める場合のテンプレート・データ。
XLIFFFileName	string	はい	適用するXLIFFファイルのファイル名。
XLIFFData	base64binary	はい	XLIFFファイルを直接含める場合のXLIFFデータ。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: createReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
createReportReturn	string	いいえ	新しく作成したレポートのパスを返します。レポート・パスの構文は、<folder_path>/<report_name>/report_name.xdoであることに注意してください。例: xmlp/Reports/financials/my report/myreport.xdo ここで、xmlp/Reports/financialsはレポートが格納されるフォルダであり、my reportはフォルダではなくレポート・コンテナを示します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

deleteReport

このAPIは、レポート定義ファイルとその他のサポートされているレポート・ファイルが格納されたレポート・フォルダを削除します。.xdoで終わるreportAbsolutePathを指定するか、レポート・フォルダ名を指定します。

入力メッセージ: deleteReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	レポート・フォルダまたはレポート.xdoファイルの絶対パス（例: C:\OraHome\xmlp\XMLP\Reports\Executive\Revenue by Region\Revenue by Region.xdo）。
userID	string	いいえ	有効なBI Publisher管理者のユーザー名。
password	string	いいえ	BI Publisher管理者ユーザーのパスワード。

出力メッセージ: deleteReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
deleteReportReturn	boolean	N/A	trueは、レポートが削除されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

updateReportDefinition

updateReportDefinitionは、レポート定義ファイル（.xdo）の属性を更新してから、そのファイルをBI Publisherレポート・リポジトリに格納します。

入力メッセージ: updateReportDefinitionRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsPath	string	いいえ	レポート・ファイルのパス（例: C:\OraHome\xmlp\XMLP\Reports\Executive\Revenue by Region\Revenue by Region.xdo）。
newReportDefn	ReportDefinition	いいえ	「ReportDefinition」を参照してください。
userID	string	いいえ	有効なBI Publisher管理者のユーザー名。
password	string	いいえ	BI Publisher管理者ユーザーのパスワード。

出力メッセージ: updateReportDefinitionResponse
パラメータ	型	Nullを許容（Nillable）	説明
updateReportDefinitionReturn	boolean	いいえ	trueは、レポート定義が更新されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

createReportFolder

createReportFolderは、BI Publisherレポート・リポジトリ内に新しいフォルダを作成します。

入力メッセージ: createReportFolderRequest
パラメータ	型	Nullを許容（Nillable）	説明
folderAbsolutePath	string	いいえ	BI Publisherリポジトリ内に作成するフォルダの絶対パス。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: createReportFolderResponse
パラメータ	型	Nullを許容（Nillable）	説明
createReportFolderReturn	string	いいえ	trueは、レポート・フォルダが作成されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

uploadTemplateForReport

uploadTemplateForReportは、BI Publisherレポート・リポジトリにテンプレートをアップロードします。

入力メッセージ: uploadTemplateForReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	テンプレートをアップロードするレポートのパス。
templateFileName	string	いいえ	テンプレートのファイル名。
templateData	base64Binary	いいえ	テンプレート・データ。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: uploadTemplateForReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
uploadTemplateForReportReturn	boolean	N/A	trueは、テンプレートが正常にアップロードされたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

removeTemplateForReport

removeTemplateForReportは、BI Publisherレポート・リポジトリからテンプレートを削除します。

入力メッセージ: removeTemplateForReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	レポート・ディレクトリのパス。
templateFileName	string	いいえ	削除するテンプレート・ファイルの名前。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: removeTemplateForReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
removeTemplateForReportReturn	boolean	N/A	trueは、テンプレートが削除されたことを意味します。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

uploadReport

uploadReportは、完成したレポート定義ファイルをBI Publisherレポート・リポジトリにアップロードします。アップロードするレポートは圧縮ファイル形式（zip）である必要があります。このAPIは、最初にreportAbsolutePathURL: /Report Folder/reportName.xdoを使用して新しいレポートを作成し、圧縮データを解凍してreportName.xdoファイルを復元し、そのファイルに含まれるその他のデータを解凍します。

入力メッセージ: uploadReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportName	string	いいえ	レポート名（例: reportname.xdo）。
reportAbsolutePathURL	string	いいえ	レポートのパス（例: /Report Folder/report name）。
reportZippedData	base64binary	いいえ	圧縮形式のレポート・データ。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: uploadReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
uploadReportReturn	string	いいえ	レスポンス。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

downloadReport

このAPIは、BI Publisherのレポート定義ディレクトリを圧縮形式でダウンロードします。これには、レポート.XDOファイルとそのレポートに関連付けられたその他のファイルが含まれます。

入力メッセージ: downloadReportRequest
パラメータ	型	Nullを許容（Nillable）	説明
reportAbsolutePath	string	いいえ	ダウンロードするレポートのパス。
userID	string	いいえ	BI Publisherのユーザー名。
password	string	いいえ	入力されたユーザー名のパスワード。

出力メッセージ: downloadReportResponse
パラメータ	型	Nullを許容（Nillable）	説明
downloadReportReturn	base64binary	いいえ	ダウンロードしたレポート・フォルダのzipファイル。

発生する可能性のある例外

InvalidParametersException
AccessDeniedException
OperationFailedException

発生する可能性のある例外の詳細は、「エラーに関するメッセージ」を参照してください。

レポート・サーバーに関する操作

レポート・サーバーに関する操作には、以下が含まれます。

getSecurityModel
getHTTPSessionInterval

getSecurityModel

このサービスは、BI Publisherサーバーのセキュリティ・モデルを返します。サポートされている設定は次のとおりです。

入力メッセージ: getSecurityModelRequest
パラメータ	型	Nullを許容（Nillable）	説明
なし

出力メッセージ: getSecurityModelResponse
パラメータ	型	Nullを許容（Nillable）	説明
getSecurityModelReturn	string	いいえ	可能性のある戻り値は次のとおりです。 XDO - XDO_SECURITY_MODEL FND - FND_SECURITY_MODEL LDAP - LDAP_SECURITY_MODEL BI_SERVER - BI_SERVER_SECURITY_MODEL ORACLE_DB - ORACLE_DB_SECURITY_MODEL HYPERION_CSS - CSS_SECURITY_MODEL

getBIPHTTPSessionInterval

BI PublisherサーバーのHTTPセッションの間隔を分単位で返します。

入力メッセージ: getBIPHTTPSessionIntervalRequest
パラメータ	型	Nullを許容（Nillable）	説明
なし

出力メッセージ: getBIPHTTPSessionIntervaResponse
パラメータ	型	Nullを許容（Nillable）	説明
getBIPHTTPSessionIntervalReturn	int	いいえ	BI PublisherサーバーのHTTPセッションの分単位の間隔。

エラーに関するメッセージ

操作の実行中にエラーが発生した場合、次のいずれかのメッセージが操作に対して返されます。

OperationFailedException

<wsdl:message name="OperationFailedException">
   <wsdl:part name="fault" type="impl:OperationFailedException"/>
</wsdl:message>

AccessDeniedException

<wsdl:message name="AccessDeniedException">
   <wsdl:part name="fault" type="impl:AccessDeniedException"/>
</wsdl:message>

InvalidParametersException

<wsdl:message name="InvalidParametersException">
  <wsdl:part name="fault" type="impl:InvalidParametersException"/>
</wsdl:message>

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

Webサービス開発者は、Webサービスを起動するために使用されるSOAPリクエスト・メッセージと、そのメッセージに対するSOAPレスポンスを確認しなければならない場合があります。Oracle BI Publisherには、特別な構成やサーバーの再起動を必要としない、SOAPメッセージ・フローを監視するためのApache Axis SOAP Monitorユーティリティがバンドルされています。

クライアントのサンプル・コードでSOAPリクエストがリスニング・ポート8888に送信されると、Axis TCPMonitorを利用して、SOAPリクエストがPublicReportServiceの稼動するポート8080にルーティングされます。これは、Webサービス開発者にとって便利なデバッグ・ツールです。

コマンドラインからAxis TCPMonitor（tcpmon）を起動するには、次のコマンドを入力します。

% java org.apache.axis.utils.tcpmon

これにより「TCPMonitor」ウィンドウが表示されます。オプションの引数が設定されていないウィンドウの例を次の図に示します。

テキストで説明されている画像

このプログラムを使用するには、tcpmonが着信接続要求を監視するローカル・ポート、接続要求の転送先となるターゲット・ホスト、およびトンネリング先（転送先）として使用するターゲット・マシンのポート番号を選択します。「Add」をクリックすると、別のタブに新しくトンネリングされた接続が表示されます。このタブには、デバッグに役立つSOAPリクエスト・メッセージとレスポンス・メッセージが表示されます。

TCPMonitorを実行するには、次のコマンドを入力します。

set CLASSPATH=.
set CLASSPATH=%CLASSPATH%;%WEB_HOME%\PORTAL\WEB-INF\lib\axis.jar
set TCPMON_PORT=8081
if not %1.==. TCPMON_PORT=%1
java org.apache.axis.utils.tcpmon %TCPMON_PORT% %ADMINSERVER_HOSTNAME%
%ADMINSERVER_PORT%

BI PublisherのWebサービスの使用

概要

PublicReportServiceのWSDL定義

Oracle BI PublisherのWebサービスのデータ型

基本データ型

XMLデータ型とJavaデータ型のマッピング

複合型

AccessDeniedException

ArrayOfItemData

ArrayOfParamNameValue

ArrayOf_xsd_string

DeliveryRequest

EMailDeliveryOption

FaxDeliveryOption

FTPDeliveryOption

InvalidParametersException

ItemData

JobHistoryInfo

JobInfo

JobStatus

LocalDeliveryOption

OperationFailedException

ParamNameValue

PrintDeliveryOption

ReportDataChunk

ReportDefinition

ReportRequest

ReportResponse

ScheduleRequest

WebDAVDeliveryOption

BI PublisherのWebサービス操作

権限の検証

validateLogin

hasReportAccess

レポートおよびリポジトリに関する情報の取得

getFolderContents

getReportDefinition

getReportParameters

レポートの実行

runReport

uploadReportDataChunk

downloadReportDataChunk

スケジュールされたレポートとその履歴の管理

scheduleReport

suspendScheduledReport

resumeScheduledReport

deleteScheduledReport

getScheduledReportInfo

getScheduledReportHistoryInfo

deleteScheduledReportHistory

getScheduledReportStatus

レポートの作成と管理

createReport

deleteReport

updateReportDefinition

createReportFolder

uploadTemplateForReport

removeTemplateForReport

uploadReport

downloadReport

レポート・サーバーに関する操作

getSecurityModel

getBIPHTTPSessionInterval

エラーに関するメッセージ

OperationFailedException

AccessDeniedException

InvalidParametersException

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