| Oracle® Fusion Middleware Oracle Business Intelligence Publisher開発者ガイド 12c (12.2.1) E70034-01 |
|
 前へ |
 次へ |
| Oracle® Fusion Middleware Oracle Business Intelligence Publisher開発者ガイド 12c (12.2.1) E70034-01 |
|
前へ |
次へ |
この章では、Oracle BI PublisherのWebサービスが使用または定義するデータ型の詳細について説明します。
この章には次の項目があります。
Oracle BI PublisherのWebサービスでは、次のベース・データ型が使用されます。
BI PublisherのWebサービスでは、ドキュメント/リテラル形式が使用されます。WebサービスのXMLスキーマ・データ型とJavaデータ型のマッピングは、SOAP開発環境によって異なります。次の表に、Oracle JDeveloper環境におけるマッピングを示します。
Oracle BI PublisherのWebサービスは、次の複合データ型を定義して使用します。
このデータ型は、カタログ内に含まれるオブジェクトなどの文字列の配列を保持します。
このデータ型は、EMailDeliveryOptionオブジェクトの配列を保持します。
表2-4 ArrayOfEMailDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
EMailDeliveryOption[] item |
第2.3.23項「EMailDeliveryOption」を参照してください。 |
このデータ型は、FaxDeliveryOptionオブジェクトの配列を保持します。
表2-5 ArrayOfFaxDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
FaxDeliveryOption[] item |
第2.3.24項「FaxDeliveryOption」を参照してください。 |
このデータ型は、FTPDeliveryOptionオブジェクトの配列を保持します。
表2-6 ArrayOfFTPDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
FTPDeliveryOption[] item |
第2.3.26項「FTPDeliveryOption」を参照してください。 |
このデータ型は、カタログ内に含まれるオブジェクトの文字列の配列を保持します。
このデータ型は、JobInfoオブジェクトの配列を保持します。
このデータ型は、JobOutputオブジェクトの配列を保持します。
このデータ型は、JobOutputDeliveryオブジェクトの配列を保持します。
表2-10 ArrayOfJobOutputDeliveryにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
JobOutputDelivery[] item |
第2.3.34項「JobOutputDelivery」を参照してください。 |
このデータ型は、LocalDeliveryOptionオブジェクトの配列を保持します。
表2-11 ArrayOfLocalDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
LocalDeliveryOption[] item |
第2.3.38項「LocalDeliveryOption」を参照してください。 |
このデータ型は、MetaDataオブジェクトの配列を保持します。
このデータ型は、ParamNameValueオブジェクト(フィールド名と値のペア)の配列を保持します。
表2-13 ArrayOfParamNameValueにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ParamNameValue[] item |
第2.3.41項「ParamNameValue」を参照してください。 |
このデータ型は、PrintDeliveryOptionオブジェクトの配列を保持します。
表2-14 ArrayOfPrintDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
PrintDeliveryOption[] item |
第2.3.43項「PrintDeliveryOption」を参照してください。 |
このデータ型は、文字列の配置を保持します。
このデータ型は、TemplateFormatLabelValueオブジェクト(テンプレート・ラベルと値のペア)の配列を保持します。
表2-16 ArrayOfTemplateFormatLabelValueにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
TemplateFormatLabelValue[] item |
第2.3.49項「TemplateFormatLabelValue」を参照してください。 |
このデータ型は、TemplateFormatsLabelValuesオブジェクトの配列を保持します。ArrayOfTemplateFormatsLabelValuesは、ReportDefinition複合データ・タイプの一部として、使用可能なテンプレート・フォーマットを記述する特定のフィールドを格納します。
表2-17 ArrayOfTemplateFormatLabelValueにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
TemplateFormatsLabelValues[] item |
第2.3.50項「TemplateFormatsLabelValues」を参照してください。 |
このデータ型は、WebDAVDeliveryOptionオブジェクトの配列を保持します。
表2-18 ArrayOfWebDAVDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
WebDAVDeliveryOption[] item |
第2.3.51項「WebDAVDeliveryOption」を参照してください。 |
このデータ型は、runReport()メソッド使用時にデータソースを動的に指定します。第4.19項「runReport()メソッド」を参照してください。
BIPDataSourceはReportRequest複合データ型により使用されます。
次の表にフィールドを示します。
表2-19 BIPDataSourceにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
JDBCDataSource JDBCDataSource |
JDBCデータソースを指定する要素が格納されています。第2.3.28項「JDBCDataSource」を参照してください。 |
|
FileDataSource fileDataSource |
ファイル・データソースを指定する要素が格納されています。第2.3.25項「FileDataSource」を参照してください。 |
このデータ型は、カタログ内に含まれるオブジェクトを保持します。
表2-20 CatalogContentsにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfItemData catalogContents |
第2.3.5項「ArrayOfItemData」を参照してください。 |
このデータ型は、カタログ内のオブジェクに関する情報を戻します。このデータ型は、次のメソッドにより戻されます。
表2-21 CatalogObjectInfoにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String accessPermissions |
カタログ・オブジェクトにアクセスする際に必要な権限。 |
|
String[] availableLocales |
カタログ・オブジェクトで使用できるロケールの配列。 |
|
long creationDate |
カタログ・オブジェクトの作成日。 |
|
String description |
カタログ・オブジェクトの説明。 |
|
String displayName |
カタログ・オブジェクトの表示名。 |
|
long lastModifiedDate |
カタログ・オブジェクトが最後に変更された日付。 |
|
String objectAbsolutePath |
カタログ・オブジェクトへの絶対パス。 |
|
String objectName |
カタログ・オブジェクトの名前。 |
|
String objectSubType |
カタログ・オブジェクトのサブタイプ。 Folderオブジェクトの場合、オブジェクトのタイプとサブタイプはFolder。 Reportオブジェクトの場合、オブジェクトのタイプはReportItem、サブタイプはxdo。 Data Modelオブジェクトの場合、オブジェクトのタイプはReportItem、サブタイプはxdm。 Style Templateオブジェクトの場合、オブジェクトのタイプはStyleTemplate、サブタイプはRTFまたはXSL。 Sub Templateオブジェクトの場合、オブジェクトのタイプはSubTemplate、サブタイプはRTFまたはXSL。 |
|
String objectType |
カタログ・オブジェクトのタイプです。有効な値は次のとおりです。
|
|
String owner |
カタログ・オブジェクトの所有者。 |
このデータ型は、レポートを複数の配信先に配信するための仕様を定義します。
このデータ型を使用するのは、DeliveryRequest複合データ型とScheduleRequest複合データ型です。
次の表にフィールドを示します。
表2-22 DeliveryChannelsにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfEMailDeliveryOption emailOptions |
第2.3.2項「ArrayOfEMailDeliveryOption」を参照してください。 |
|
ArrayOfFaxDeliveryOption faxOptions |
第2.3.3項「ArrayOfFaxDeliveryOption」を参照してください。 |
|
ArrayOfFTPDeliveryOption ftpOptions |
第2.3.4項「ArrayOfFTPDeliveryOption」を参照してください。 |
|
ArrayOfLocalDeliveryOption localOptions |
第2.3.9項「ArrayOfLocalDeliveryOption」を参照してください。 |
|
ArrayOfPrintDeliveryOption printOptions |
第2.3.12項「ArrayOfPrintDeliveryOption」を参照してください。 |
|
ArrayOfWebDAVDeliveryOption webDAVOption |
第2.3.16項「ArrayOfWebDAVDeliveryOption」を参照してください。 |
このデータ型は、レポートを複数の配信先に配信するための仕様を定義します。
次の表にフィールドを示します。
表2-23 DeliveryRequestにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String contentType |
生成されるドキュメントのコンテンツ・タイプです。指定可能な値: "text/html;charset=UTF-8" "text/plain;charset=UTF-8" "application/pdf" "application/vnd.ms-powerpoint" "application/vnd.ms-powerpoint" "application/vnd.ms-excel" "application/msword" "application/x-shockwave-flash" "text/xml" "message/rfc822" |
|
DeliveryChannels deliveryChannels |
第2.3.20項「DeliveryChannels」を参照してください。 |
|
byte[] documentData |
出力されるドキュメント。 |
|
BIPDataSource dynamicDataSource |
第2.3.17項「BIPDataSource」を参照してください。 |
このデータ型は、getDeliveryServiceDefinition()メソッドに対するレスポンスでデータを戻します。このメソッドを使用して、BI Publisher用に設定された配信サーバーに関する情報を取得します。
次の表にフィールドを示します。
表2-24 DeliveryServiceDefinitionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOf_xsd_String EMailServerNames |
ArrayOf_xsd_stringデータ型で返された電子メール・サーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String FTPServerNames |
ArrayOf_xsd_stringデータ型で返されたFTPサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String HTTPServerNames |
ArrayOf_xsd_stringデータ型で返されたHTTPサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String SFTPServerNames |
ArrayOf_xsd_stringデータ型で返されたSFTPサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String defaultServerNames |
ArrayOf_xsd_stringデータ型で返され、各定義済タイプに対応するデフォルトのサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String faxServerNames |
ArrayOf_xsd_stringデータ型で返されたFAXサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_String printerNames |
ArrayOf_xsd_stringデータ型で返されたプリンタ名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
|
ArrayOf_xsd_Stringg webDAVServerNames |
ArrayOf_xsd_stringデータ型で返されたWebDAVサーバー名のリスト。第2.3.1項「ArrayOf_xsd_string」を参照してください。 |
このデータ型は、レポートを電子メールで配信するための仕様を定義します。
このデータ型を使用するのは、ArrayOfEMailDeliveryOption複合データ型です。
次の表にフィールドを示します。
表2-25 EMailDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String emailBCC |
電子メールのブラインド・カーボン・コピーを受信するための電子メール・アドレス。 |
|
String emailBody |
電子メールの本文として表示されるテキスト文字列。 |
|
String emailCC |
電子メールのカーボン・コピーを受信するための電子メール・アドレス。 |
|
String emailFrom |
必須。送信者アドレスとして表示される電子メール・アドレス。このフィールドが空白の場合、次のメッセージとともにSOAP障害がスローされます。
|
|
String emailReplyTo |
返信先フィールドに表示するための電子メール・アドレス。 |
|
String emailServerName |
電子メール・サーバーの名前です。例: "Oracle Mail" |
|
String emailSubject |
電子メールの件名行。 |
|
String emailTo |
必須。電子メールの送信先アドレス。このフィールドが空白の場合、次のメッセージとともにSOAP障害がスローされます。
|
このデータ型は、レポートをFAXで配信するために設定するオプションを定義します。
このデータ型は、ArrayOfFaxDeliveryOption複合データ型で使用されます。
表2-26 FaxDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String faxNumber |
必須。FAXの送信先の番号です(例:
|
|
String faxServer |
必須。FAXの送信先のFAXサーバー(BI Publisherの「管理」ページで定義)(
|
このデータ型は、レポート実行時にファイル・データソースへの接続を動的に作成します。サーバー上の場所への直接パスを指定することも、ファイルを一時ディレクトリ内に置くことを指定することもできます。
このデータ型は、BIPDataSource複合データ型で使用されます。
次の表にフィールドを示します。
表2-27 FileDataSourceにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String dynamicDataSourcePath |
特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。例: "D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml" ファイルがシステムの一時ディレクトリに存在する場合は、temporaryDataSourceをtrueに設定し、ここでファイル名を指定します。例: "Balance.xml"。 |
|
boolean temporaryDataSource |
ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。 |
このデータ型は、レポートをFTPで配信するために設定するオプションを定義します。最初にFTPサーバーをBI Publisherの「管理」ページで設定する必要があります。FTPサーバーを設定するには、『Oracle Fusion Middleware Oracle Business Intelligence Publisher管理者ガイド』の「配信先の設定」を参照してください。
このデータ型は、ArrayOfFTPDeliveryOption複合データ型で使用されます。
表2-28 FTPDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String ftpServerName |
必須。BI Publisherの「管理」ページで定義されたFTPサーバー名。このフィールドが空白の場合、次のメッセージとともにSOAP障害がスローされます。
|
|
String ftpUserName |
FTPサーバーのユーザー名(SFTPでのみ必須)。 |
|
String ftpUserPassword |
入力されたユーザーのパスワード(SFTPでのみ必須)。 |
|
String remoteFile |
サーバー上のファイルに割り当てる名前(例: report.pdf)。 |
|
boolean sftpOption |
Secure FTP (SFTP)を使用する場合はtrueに設定します。FTPを使用する場合はfalseに設定します。 |
このデータ型は、カタログ内に保存されているオブジェクトのオブジェクト・メタデータを戻します。
表2-29 ItemDataにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String absolutePath |
カタログ・オブジェクトへのパス。(例: /HR Manager/HR Reports/Employee Listing.xdo)。 |
|
dateTime creationDate |
カタログ・オブジェクトの作成日。 |
|
String displayName |
カタログ・オブジェクトの表示名。(例: Employee Listing)。 |
|
String fileName |
カタログ・オブジェクトのファイル名(例: Employee Listing.xdo)。 |
|
dateTime lastModified |
カタログ・オブジェクトの最終更新日。 |
|
String lastModifier |
オブジェクトを最後に変更したユーザー名。 |
|
String owner |
オブジェクト所有者のユーザー名。 |
|
String parentAbsolutePath |
親フォルダの絶対パス。たとえば、絶対パスが/HR Manager/HR Reports/Employee Listing.xdoであるレポートのparentAbsolutePathは、/HR Manager/HR Reportsです。 |
|
String type |
アイテムのタイプ。設定可能な値は、reportまたはfolderです。 |
|
String description |
オブジェクトの説明。例: "このレポートには、部門別のすべての従業員が表示され、マネージャおよび給与の範囲のパラメータ選択肢が含まれます。" |
このデータ型は、レポート実行時にJDBCデータソースへの接続を動的に作成します。
このデータ型は、BIPDataSource複合データ型によって使用されます。
次の表にフィールドを示します。
表2-30 JDBCDataSourceにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String JDBCDriverClass |
データソースのJDBCドライバ・クラスです(例: oracle.jdbc.OracleDriver)。 |
|
String JDBCDriverType |
BI Publisherデータソース定義ページで定義されているドライバのタイプです(例: Oracle10g/11g/12c)。 |
|
String JDBCPassword |
BI Publisherデータソース定義ページで定義されている、データソースのパスワードです。 |
|
String JDBCURL |
データソースの接続文字列です(例: jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl)。 |
|
String JDBCUserName |
BI Publisherデータソース定義ページで定義されている、データソースのユーザー名です。 |
|
String dataSourceName |
BI Publisherデータソース定義ページでデータソースに割り当てられたデータソース名です(例: Oracle)。 |
ジョブ・リクエストに関する情報の集合です。
表2-31 JobDetailにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
boolean bursting |
|
|
String burstingParameters |
バースト・エンジンのパラメータ。 |
|
dateTime created |
ジョブが作成された日付。 |
|
String dataLocator |
storageTypeがDBの場合、dataLocatorはデータベースからデータを取得するための主キーです。 |
|
boolean deleted |
|
|
String deliveryDescription |
ジョブ配信についての説明。 |
|
String deliveryParameters |
配信チャネルのパラメータ。 |
|
dateTime endDate |
ジョブの終了予定日。 |
|
int instanceId |
ジョブのインスタンスの識別番号。 |
|
String issuer |
ジョブの発行者。 |
|
String jobGroup |
ジョブが属するグループ。 |
|
int jobId |
ジョブのインスタンスの識別番号。 |
|
int jobSetId |
非アクティブ。使用しないでください。 |
|
String jobType |
ジョブのタイプ。 |
|
dateTime lastUpdated |
ジョブが最後に更新された日時。 |
|
String locale |
ジョブが属するロケール。 |
|
String notificationParameters |
ジョブの通知パラメータ。 |
|
String owner |
ジョブ所有者の名前。 |
|
int parentJobId |
ジョブの親に対応する識別番号。 |
|
boolean public |
他のユーザーがジョブを確認できる(true)かできない(false)かを指定します。 |
|
String reportParameters |
レポートのパラメータ。 |
|
String reportUrl |
ジョブ出力先のURL。 |
|
String runType |
ジョブのタイプ(単一または繰返し)。 |
|
String scheduleContext |
外部アプリケーションがレポートを実行する場合のジョブ・スケジュールに対応するコンテキスト。 |
|
String scheduleDescription |
ジョブ・スケジュールの説明。 |
|
String scheduleParameters |
ジョブ・スケジュールのパラメータ。 |
|
String scheduleSource |
ジョブ・スケジュールのソース。これは、外部アプリケーションに関する情報を提供するscheduleContextとともに使用されます。 |
|
dateTime startDate |
ジョブの開始予定日または開始日。 |
|
String status |
ジョブのステータス。 |
|
String statusDetail |
ジョブのステータスの詳細。 |
|
String storageType |
ジョブの格納タイプ。サポートされる値は |
|
String userDescription |
ジョブに対してユーザーが割り当てた説明。 |
|
String userJobName |
ジョブに対してユーザーが割り当てた名前。 |
|
boolean xmlDataAvailable |
ジョブのXMLデータが使用できる(true)かできない(false)かを指定します。 |
|
boolean xmlDataCompressed |
trueは、ジョブのXMLデータが圧縮されることを意味しています。 |
|
String xmlDataContentType |
XMLデータのコンテンツ・タイプ。 |
|
String xschurl |
レポートのURL。 |
このデータ型は、次のメソッドによって使用され、特定のレポート・ジョブに対するフィルタの条件を定義します。
このデータ型のフィールドで、必要とする情報について特定のレポート・ジョブまたはジョブを指定します。
表2-32 JobFilterPropertiesにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String endTime |
ジョブの終了予定時間または終了時間。 |
|
String endTimeOperator |
endTimeの演算子。有効な値は、"Equals or Earlier Than"、"Equals"または"Earlier Than"です。 |
|
long jobID |
BI Publisherによってジョブ・リクエストに割り当てられた識別番号。 |
|
String jobName |
ユーザーによって割り当てられたジョブ名。有効な値は"Contains"または"Equals"です。 |
|
String jobNameOperator |
jobNameの演算子。 |
|
String owner |
ジョブ所有者の名前。 |
|
String ownerOperator |
ownerの演算子。有効な値は"Contains"または"Equals"です。 |
|
String reportName |
ジョブに対してユーザーが割り当てた名前。 |
|
String reportNameOperator |
reportNameの演算子。有効な値は"Contains"または"Equals"です。 |
|
String scope |
ジョブの範囲。有効な値は、"All"、"Private"または"Public"です。 |
|
String startTime |
ジョブの開始予定時刻または開始時刻。 |
|
String startTimeOperator |
startTimeの演算子。有効な値は、"Equals or Later Than"、"Equals"または"Later Than"です。 |
|
String status |
ジョブの現行のステータス。 |
ジョブ・リクエストに関する情報の集合です。
表2-33 JobInfoにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
boolean burstingJob |
|
|
dateTime created |
ジョブが作成された日付。 |
|
boolean deleted |
|
|
dateTime endDate |
ジョブの終了予定日または終了日。 |
|
long instanceId |
スケジュールされたジョブ・リクエストの識別番号。 |
|
long jobID |
BI Publisherによってジョブ・リクエストに割り当てられた識別番号。 |
|
String jobType |
ジョブのタイプ。 |
|
dateTime lastUpdated |
ジョブが最後に更新された日時。 |
|
String owner |
ジョブの所有者。 |
|
long parentJobId |
スケジュールされたジョブ・リクエストの親に対応する識別番号。 |
|
boolean public |
trueは、そのレポートが特定のレポート・セットのメンバーであることを意味します。現在の実装では常にfalseが返されます。 |
|
String reportUrl |
レポートの絶対パスURL(例: /HR Manager/Employee Reports/Employee Salary Report.xdo)。 |
|
dateTime startDate |
ジョブの開始予定日または開始日。 |
|
String status |
スケジュールされたジョブ・リクエストのステータス。有効な値は、Canceled、Done、Scheduled、SuspendedおよびUnknownです。 |
|
String statusDetail |
ステータスに対するその他の詳細。 |
|
String userJobName |
ジョブ・リクエストを発行したユーザー名。 |
このデータ型は、JobInfoオブジェクトの配列を返します。
表2-34 JobInfoListにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfJobInfo jobInfoList |
JobInfoオブジェクトの配列。第2.3.6項「ArrayOfJobInfo」を参照してください。 |
このデータ型は、ジョブ出力の説明を返します。
表2-35 JobOutputにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String burstKey |
バーストされた各ジョブのデータを分割する際に使用するキー。 |
|
dateTime created |
レポート・ジョブが作成された日付。 |
|
boolean deleted |
trueは、ジョブ出力が削除されたことを意味します。 |
|
boolean documentDataAvailable |
trueは、レポートのスケジュール時に「出力の保存」オプションが選択されたことを意味します。 |
|
boolean documentDataCompressed |
trueは、ドキュメントのデータが圧縮されていること意味します。 |
|
String documentDataConentType |
生成されるドキュメントのコンテンツ・タイプです。可能な値は次のとおりです。 "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" |
|
long jobID |
BI Publisherによってジョブに割り当てられた識別番号。 |
|
String jobName |
ユーザーによって割り当てられたジョブ名。 |
|
dateTime lastUpdated |
ジョブが最後に更新された日時。 |
|
long outputID |
履歴内のレポートの識別番号。1つのスケジュールされたJobIDを複数のoutputIDまたはhistoryIDに関連付けることができます。これは、1つのスケジュールされたレポートを何回も実行または再公開できるためです。 |
|
String outputName |
出力に割り当てられた名前。 |
|
long parentOutputId |
親リクエストの出力ID。 |
|
String status |
有効な値は、Completed、Error、Running、Scheduled、SuspendedおよびUnknownです。 |
|
String statusDetail |
BI Publisherサーバーからの詳細なステータス情報。 |
このデータ型は、ジョブ出力の説明を返します。
表2-36 JobOutputDeliveryにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
dateTime created |
レポート・ジョブが作成された日付。 |
|
long deliveryID |
ジョブの配信を識別する主キー。 |
|
byte[] deliveryParameters |
配信チャネルのパラメータ。 |
|
dateTime lastUpdated |
ジョブが最後に更新された日時。 |
|
long outputID |
履歴内のレポートの識別番号。1つのスケジュールされたJobIDを複数のoutputIDまたはhistoryIDに関連付けることができます。これは、1つのスケジュールされたレポートを何回も実行または再公開できるためです。 |
|
long parentDeliveryID |
親リクエストの配信ID。 |
|
String status |
有効な値は、Completed、Error、Running、Scheduled、SuspendedおよびUnknownです。 |
|
String statusDetail |
BI Publisherサーバーからの詳細なステータス情報。 |
このデータ型は、JobOutputDeliveryオブジェクトの配列を返すように実装されたラッパー・クラスです。
表2-37 JobOutputDeliverysListにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfJobOutputDelivery jobOutputDeliveryList |
第2.3.8項「ArrayOfJobOutputDelivery」を参照してください。 |
このデータ型は、JobOutputオブジェクトの配列を返します。
表2-38 JobOutputsListにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfJobOutput jobOutputList |
第2.3.7項「ArrayOfJobOutput」を参照してください。 |
このデータ型は、ジョブ・リクエストのステータスを返します。
BI Publisherリポジトリにレポートを配信するために設定するオプション。
このデータ型は、ArrayOfLocalDeliveryOption複合データ型で使用されます。
このデータ型は、MetaDataオブジェクトの名前と値のペアを設定します。
このデータ型は、MetaDataオブジェクトのリストを返します。
表2-42 MetaDataListにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfMetaData metaDataList |
第2.3.10項「ArrayOfMetaData」を参照してください。 |
このデータ型は、BI Publisherのレポートとテンプレートに対して定義されているパラメータを記述します。
ParamNameValueデータ型はArrayOfParamNameValue内で使用されます。このデータ型はReportRequestデータ型、ReportDefinitionデータ型およびJobInfoデータ型に含まれています。また、ParamNameValueはgetTemplateParameters()メソッドとgetReportParameters()メソッドによって返されます。
表2-43 ParamNameValueにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String UIType |
BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。 有効な値は次のとおりです。
|
|
String dataType |
有効な値は次のとおりです。
|
|
String dateFormatString |
UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。 |
|
String dateFrom |
UITypeがDateの場合は、日付の開始値を指定します。 |
|
String dateTo |
UITypeがDateの場合は、日付の終了値を指定します。 |
|
String defaultValue |
パラメータのデフォルト値を指定します。 |
|
String fieldSize |
パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。 |
|
String label |
パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。 |
|
ArrayOfString lovLabels |
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。 |
|
boolean multiValuesAllowed |
|
|
String name |
パラメータ名。 |
|
boolean refreshParamOnChange |
パラメータ・タイプが"Text"または"Menu"で、このパラメータの値が |
|
boolean selectAll |
パラメータ・タイプが"Menu"の場合、 |
|
boolean templateParam |
|
|
boolean useNullForAll |
パラメータ・タイプが"Menu"の場合、 |
|
ArrayOfString values |
第2.3.13項「ArrayOfString」を参照してください。 |
このデータ型は、ParamNameValueオブジェクトの配列を返すラッパー・クラスです。
表2-44 ParamNameValuesにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
ArrayOfParamNameValue listOfParamNameValues |
第2.3.11項「ArrayOfParamNameValue」を参照してください。 |
このデータ型は、レポートをプリンタに配信するオプションを設定します。
このデータ型は、ArrayOfPrintDeliveryOption複合データ型で使用されます。
表2-45 PrintDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String printNumberOfCopy |
印刷するコピー部数。 |
|
String printOrientation |
有効な値は"portrait"または"landscape"です。 |
|
String printRange |
印刷するページの範囲。たとえば、「3」と入力すると3ページが、「2-5」と入力すると2から5ページが、「1,3-5」と入力すると1ページおよび3から5ページが印刷されます。 |
|
String printSide |
有効な値は次のとおりです。
パラメータを指定しない場合は、片面が使用されます。 |
|
String printTray |
有効な値は次のとおりです。
指定しない場合は、プリンタのデフォルトが使用されます。 |
|
String printerName |
必須。レポートの送信先プリンタのサーバー名(BI Publisherの「管理」ページで設定)。このフィールドが空白の場合、次のメッセージとともにSOAP障害がスローされます。
|
このデータ型は、大型レポート・データ・セットを処理したり、小さいデータ・チャンク内のレポート・データをアップロードおよびダウンロードします。
このデータ型は、レポート・オブジェクトを定義します。これはgetReportDefinition()メソッドで返されたオブジェクトです。
表2-47 ReportDefinitionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
boolean autoRun |
trueは、レポート・プロパティの「オートラン」がオンになっていることを意味します。 |
|
boolean cacheDocument |
trueは、レポート・プロパティの「ドキュメント・キャッシュの有効化」がオンになっていることを意味します。 |
|
boolean controledByExtApp |
レポートの定義を外部アプリケーションで制御する(true)かまたはしない(false)かを示します。 |
|
String dataModelURL |
データ・モデルの定義を取得する.xdmファイルの場所。 |
|
String defaultOutputFormat |
デフォルトの出力フォーマット。 有効な値は次のとおりです。
|
|
String defaultTemplateId |
そのレポートに対して特定されたデフォルトのテンプレート。 |
|
boolean diagnostics |
trueは、そのレポートに対して診断がオンになっていることを意味します。 |
|
String ESSJobName |
ESSジョブ名。 |
|
String ESSPackageName |
ESSパッケージ名。ESSJobNameと併用。 |
|
ArrayOfTemplateFormatsLabelValues listOfTemplateFormatsLabelValues |
ArrayOfTemplateFormatsLabelValuesデータ型経由でテンプレート・フォーマット・ラベルのリストを渡します。第2.3.15項「ArrayOfTemplateFormatLabelValues」を参照してください。 |
|
boolean onLine |
trueは、レポート・プロパティの「レポート・オンラインの実行」がオンになっていることを意味します。 |
|
boolean openLinkInNewWindow |
trueは、レポート・プロパティの「新規ウィンドウでリンクを開く」がオンになっていることを意味します。 |
|
integer parameterColumns |
レポート・プロパティの「行当たりのパラメータ数」の値。 |
|
ArrayOfString parameterNames |
レポートの定義済パラメータ名をArrayOfStringデータ型経由で渡します。第2.3.13項「ArrayOfString」を参照してください。 |
|
String reportDefnTitle |
非アクティブ。使用しないでください。 |
|
String reportDescription |
ユーザーがレポートに割当てた説明。 |
|
String reportName |
ユーザーがレポートに割当てた名前。 |
|
ArrayOfParamNameValue reportParameterNameValues |
レポートの名前と値のペアをArrayOfParamNameValueデータ型経由で渡します。第2.3.11項「ArrayOfParamNameValue」を参照してください。 |
|
String reportType |
非アクティブ。使用しないでください。 |
|
boolean showControls |
trueは、レポート・プロパティの「コントロールの表示」がオンになっていることを意味します。 |
|
boolean showReportLinks |
trueは、レポート・プロパティの「レポート・リンクの表示」がオンになっていることを意味します。 |
|
ArrayOfString templateIds |
レポート・テンプレートのレイアウト名をArrayOfStringデータ型経由で渡します。第2.3.13項「ArrayOfString」を参照してください。 |
このデータ型は、レポートを実行するのに必要な設定を定義します。attributeFormatの許容値は、使用されるテンプレートのタイプによって異なります(たとえば、PDFテンプレートではPDF出力の生成のみ可能)。
表2-48 ReportRequestにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String attributeCalendar |
レポート・リクエストに対して使用するフォーマット・カレンダです。有効な値: "Gregorian"、"Arabic Hijrah"、"English Hijrah"、"Japanese Imperial"、"Thai Buddha"、"ROC Official" |
|
String attributeFormat |
要求されたレポートの出力フォーマット。第2.3.46.1項「attributeFormatの値」を参照してください。 |
|
String attributeLocale |
レポートのロケール選択例: fr-FR |
|
String attributeUILocale |
ユーザー・インタフェースのロケール選択。例: fr-FR。ユーザー・インタフェースからのパラメータ入力が英語でないときは必須。 |
|
String attributeTemplate |
レポートに適用するテンプレート(例: Employeelisting.rtf)。 |
|
String attributeTimeZone |
リクエストに対して使用するタイムゾーンを、サポートされているJavaタイムゾーンIDを使用して指定します。例: "America/Los_Angeles" |
|
boolean byPassCache |
trueは、ドキュメント・キャッシュをバイパスすることを示します。 |
|
BIPDataSource dynamicDataSource |
レポートのデータソースが定義されていない場合は、動的に定義できます。第2.3.17項「BIPDataSource」を参照してください。 |
|
boolean flattenXML |
trueは、XMLがフラット化されることを意味します。ExcelではXMLデータ型をフラット化する必要があるため、このフラグはAnalyzer for Microsoft Excelに対して使用されます。 |
|
ParamNameValues parameterNameValues |
ParamNameValuesデータ型経由で渡される、このレポート・リクエストの発行に使用されるパラメータ名と値のペア。第2.3.42項「ParamNameValues」を参照してください。 |
|
String reportAbsolutePath |
BI Publisherリポジトリ内のレポートの絶対パス(例: /HR Manager/HR Reports/Employee Listing.xdo)。 |
|
byte[] reportData |
レポートに直接データを入力する場合は、この要素を使用してデータを渡します。 |
|
String reportOutputPath |
生成されるレポートの出力パスを指定します。 |
|
String reportRawData |
レポートに生のXMLデータを使用する場合は、この要素にそのXMLデータが格納されます。 |
|
integer sizeOfDataChunkDownload |
flattenXMLをtrueに設定した場合、またはデータをチャンクしない場合は、このパラメータを-1に設定して、すべてのデータをクライアントに返します。 |
|
MetaDataList XDOPropertyList |
第2.3.40項「MetaDataList」を参照してください。 |
次の表に、attributeFormatの有効値と、出力フォーマットの各タイプをサポートしているテンプレート・タイプを示します。
表2-49 attributeFormatの有効値
| 出力フォーマット | attributeFormatフィールドに入力する値 | この出力形式を生成できるテンプレートのタイプ |
|---|---|---|
|
インタラクティブ |
インタラクティブ |
BI Publisher |
|
HTML |
html |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
|
|
BI Publisher、RTF、PDF、Flash、XSLスタイルシート(FO) |
|
RTF |
rtf |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
Excel (mhtml) |
excel |
BI Publisher、RTF、Excel、XSLスタイルシート(FO) |
|
Excel (html) |
excel2000 |
BI Publisher、RTF、Excel、XSLスタイルシート(FO) |
|
Excel (*.xlsx) |
xlsx |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
PowerPoint (mhtml) |
ppt |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
PowerPoint (.*pptx) |
pptx |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
MHTML |
mhtml |
BI Publisher、RTF、Flash、XSLスタイルシート(FO) |
|
PDF/A |
pdfa |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
PDF/X |
pdfx |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
圧縮PDF |
pdfz |
BI Publisher、RTF、PDF、XSLスタイルシート(FO) |
|
FO形式のXML |
xslfo |
BI Publisher、RTF、XSLスタイルシート(FO) |
|
データ(XML) |
xml |
BI Publisher、RTF、PDF、Excel、Flash、XSLスタイルシート(FO)、Etext、XSLスタイルシート(HTML XML/テキスト) |
|
データ(CSV) |
csv |
BI Publisher、RTF、PDF、Excel、Flash、XSLスタイルシート(FO)、XSLスタイルシート(HTML XML/テキスト)、Etext |
|
XML |
xml |
XSLスタイルシート(HTML XML/テキスト) |
|
Text |
text |
XSLスタイルシート(HTML XML/テキスト)、Etext |
|
Flash |
flash |
Flash |
ReportResponseはrunReportから返されるオブジェクトです。
表2-50 ReportResponseにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
MetaDataList metaDataList |
第2.3.40項「MetaDataList」を参照してください。 |
|
byte[] reportBytes |
レポートのバイナリ・データ出力。 |
|
String reportContentType |
レポートのコンテンツ・タイプ。次の値を指定できます。 "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" |
|
String reportFileID |
レポート・ファイルの識別番号。 |
|
String reportLocale |
レポートに対して選択されたロケール( |
レポートをスケジュールするためのオプションです。
表2-51 ScheduleRequestにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
boolean bookBindingOutputOption |
製本出力が有効(true)か無効(false)かを指定します。 |
|
String dataModelUrl |
データ・モデルの定義を取得する.xdmファイルの場所。 |
|
DeliveryChannels deliveryChannels |
第2.3.20項「DeliveryChannels」を参照してください。 |
|
String endDate |
スケジュールの終了日。 |
|
String jobLocale |
スケジュールされたリクエストに使用するロケール例: fr-FR。スケジュールされたジョブに発行されたパラメータ値が英語でないときは必須。 |
|
String jobTZ |
スケジュールされたリクエストに使用するタイム・ゾーン。 |
|
boolean mergeOutputOption |
マージ出力オプションが有効(true)か無効(false)かを指定します。 |
|
String notificationPassword |
HTTPサーバー経由で通知をスケジュールする際に使用するHTTP通知サーバー・パスワード。 |
|
String notificationServer |
通知に使用するHTTPサーバーの名前。 |
|
String notificationTo |
通知送信先の電子メール・アドレス。 |
|
String notificationUserName |
通知に使用するHTTPサーバーのユーザー名。 |
|
boolean notifyHttpWhenFailed |
trueは、ジョブ・リクエストが失敗した場合に通知を送信することを意味します。 |
|
boolean notifyHttpWhenSuccess |
trueは、ジョブ・リクエストが成功した場合に通知を送信することを意味します。 |
|
boolean notifyHttpWhenWarning |
trueは、ジョブが警告を伴って終了したときに通知を送信することを意味します。 |
|
boolean notifyWhenFailed |
trueは、ジョブ・リクエストが失敗した場合に通知を送信することを意味します。 |
|
boolean notifyWhenSuccess |
trueは、ジョブ・リクエストが成功した場合に通知を送信することを意味します。 |
|
boolean notifyWhenWarning |
trueは、ジョブが警告を伴って終了したときに通知を送信することを意味します。 |
|
String recurrenceExpression |
反復スケジュールを定義する式。 |
|
String recurrenceExpressionType |
反復スケジュールに対して定義された式のタイプ。有効な値は |
|
integer repeatCount |
スケジュールを繰り返す回数。レポートの反復スケジュールでは、startDateをNULL以外の値に設定し、すべての意味のあるスケジュールに対して、repeatCountとrepeatIntervalを0より大きい値に設定する必要があります。endDateにはNULLを設定できます。 |
|
integer repeatInterval |
2つのスケジュールされたジョブ間の秒単位の間隔。 |
|
ReportRequest reportRequest |
ReportRequestデータ型経由で格納されるリクエストに関する情報。第2.3.46項「ReportRequest」を参照してください。 |
|
boolean saveDataOption |
trueは、スケジュールされたリクエスト実行のレポート・データが保存されることを意味します。 |
|
boolean scheduleBurstingOption |
trueは、スケジュールされたリクエストがバーストされることを意味します。 |
|
boolean schedulePublicOption |
trueは、スケジュールされたリクエストが公開されることを意味します。 |
|
String startDate |
スケジュールが開始される日付。 |
|
boolean useUTF8Option |
trueは、Unicode(UTF8)を使用オプションが有効になっていることを意味します。 |
|
String userJobDesc |
スケジュールされたジョブに対してユーザーが入力した説明。 |
|
String userJobName |
スケジュールされたジョブに対してユーザーが入力した名前。 |
レポートに対応するテンプレート・フォーマットのラベルと値を指定します。TemplateFormatLabelValueは、ArrayOfTemplateFormatLabelValue複合データ型に含まれています。TemplateFormatLabelValueを構成する要素は次のとおりです。
BI Publisherリポジトリに格納されたテンプレート・フォーマットに関する詳細です。TemplateFormatLabelValueは、ArrayOfTemplateFormatLabelValues複合データ型に含まれています。
表2-53 TemplateFormatsLabelValuesにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
boolean active |
テンプレートがアクティブ(true)またはアクティブでない(false)かを示します。 |
|
boolean applyStyleTemplate |
スタイル・テンプレートを適用する(true)か適用しない(false)かを示します。 |
|
boolean default |
テンプレートがデフォルト・テンプレート(true)かデフォルト・テンプレートでない(false)かを示します。 |
|
ArrayOfTemplateFormatLabelValue listOfTemplateFormatLabelValue |
TemplateFormatLabelValueのラベルと値のペアが格納されます。第2.3.14項「ArrayOfTemplateFormatLabelValue」を参照してください。 |
|
ArrayOfString templateAvailableLocales |
ArrayOfStringデータ型に渡されるテンプレートに対して定義されている使用可能なロケール・オプション。第2.3.13項「ArrayOfString」を参照してください。 |
|
String templateBaseLocale |
テンプレートに対して定義されているベース・ロケール・オプション。 |
|
String templateDefaultLocale |
テンプレートに対して定義されているデフォルト・ロケール・オプション。 |
|
String templateID |
BI Publisherでテンプレートに割り当てられている名前です。例: "Employee Listing" |
|
String templateType |
テンプレートのタイプです。例: "rtf"、"pdf" |
|
String templateURL |
BI Publisherリポジトリ内のテンプレート・ファイル名です。例: "Employee Listing.rtf" |
|
boolean viewOnline |
テンプレートがオンラインで表示できる(true)か表示できない(false)かを示します。 |
レポートをWeb-based Distributed Authoring and Versioning(WebDAV)で配信するための設定オプション。
このデータ型は、ArrayOfWebDAVDeliveryOption複合データ型で使用されます。
表2-54 WebDAVDeliveryOptionにより使用可能になるフィールド
| フィールド | 説明 |
|---|---|
|
String deliveryAuthType |
認証タイプ。有効な値は、None、Basic、Digestです。 |
|
String password |
プロキシ・サーバーが設定されている場合に、プロキシ・サーバーへのアクセスに必要なパスワード。 |
|
String remoteFilePath |
レポート・ファイルの配信先リモート・サーバー上のディレクトリのパス。 |
|
String server |
必須。WebDAVサーバー名です(例:
|
|
String userName |
プロキシ・サーバーが設定されている場合に、プロキシ・サーバーへのアクセスに必要なユーザー名。 |
