4 ReportService

この章では、BI Publisherレポートのオブジェクトとやり取りする際に使用できるReportServiceメソッドの詳細について説明します。ここでは、レポート、レポート・テンプレート、ランタイムの操作およびパラメータの設計と定義に対するメソッドについて述べます。

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

• 第4.1項「createReport()メソッド」

• 第4.2項「createReportInSession()メソッド」

• 第4.3項「downloadReportDataChunk()メソッド」

• 第4.4項「downloadReportDataChunkInSession()メソッド」

• 第4.5項「getReportDefinition()メソッド」

• 第4.6項「getReportDefinitionInSession()メソッド」

• 第4.7項「getReportParameters()メソッド」

• 第4.8項「getReportParametersInSession()メソッド」

• 第4.9項「getReportSampleData()メソッド」

• 第4.10項「getReportSampleDataInSession()メソッド」

• 第4.11項「getTemplate()メソッド」

• 第4.12項「getTemplateInSession()メソッド」

• 第4.13項「getTemplateParameters()メソッド」

• 第4.14項「getTemplateParameterInSession()メソッド」

• 第4.15項「getXDOSchema()メソッド」

• 第4.16項「getXDOSchemaInSession()メソッド」

• 第4.17項「removeTemplateForReport()メソッド」

• 第4.18項「removeTemplateForReportInSession()メソッド」

• 第4.19項「runReport()メソッド」

• 第4.20項「runReportInSession()メソッド」

• 第4.21項「updateReportDefinition()メソッド」

• 第4.22項「updateReportDefinitionInSession()メソッド」

• 第4.23項「updateTemplateForReport()メソッド」

• 第4.24項「updateTemplateForReportInSession()メソッド」

• 第4.25項「updateXLIFFForReport()メソッド」

• 第4.26項「updateXLIFFForReportInSession()メソッド」

• 第4.27項「uploadReportDataChunk()メソッド」

• 第4.28項「uploadReportDataChunkInSession()メソッド」

• 第4.29項「uploadTemplateForReport()メソッド」

• 第4.30項「uploadTemplateForReportInSession()メソッド」

• 第4.31項「uploadXLIFFForReport()メソッド」

• 第4.32項「uploadXLIFFForReportInSession()メソッド」

注意: BI Publisher Webサービスを使用して作成されたアプリケーションをデバッグする方法の詳細は、第1.4項「Webサービス・アプリケーションのデバッグ」を参照してください。

4.1 createReport()メソッド

createReport()メソッドを使用して、BI Publisherカタログ内にレポートを作成します。このメソッドによって、データ・モデルにパスを設定し、テンプレート・ファイルと翻訳(XLIFF)ファイルをレポート定義に指定できます。

シグネチャ

String createReport(String reportName, String folderAbsolutePathURL, String dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String userID, String password);

表4-1 createReport()メソッドのパラメータ

パラメータ	説明
String reportName	サフィックスに.xdoを付けて作成するレポート名(例: myreport.xdo)。
String folderAbsolutePathURL	作成したレポートを配置するフォルダのパス(例: xmlp/Reports/financials)。
String dataModelURL	このレポートのデータソースとして使用されるデータ・モデルへのパス。(例: xmlp/Reports/financials/Data Models/my data model.xdm)。
String templateFileName	レポート定義に追加するテンプレートのファイル名。
byte[] templateData	テンプレート・ファイル。
String XLIFFFileName	XLIFFファイルのファイル名。XLIFFファイル名にロケールを次のように追加する必要があります。 template_<language code>_<country code>.xlf 説明: <language_code>は、2文字のISO 639言語コードです。 <country_code>は、2文字のISO 639言語コードです。 例: template_en_us.xlf
byte[] XLIFFData	XLIFFファイル。
boolean updateFlag	trueの場合、既存のレポートが上書きされます。falseの場合、レポートが存在すればエラーがスローされます。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.2 createReportInSession()メソッド

createReport()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内にレポートを作成します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

String createReport(String reportName, String folderAbsolutePathURL, String dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String bipSessionToken);

表4-2 createReportInSession()メソッドのパラメータ

パラメータ	説明
String reportName	サフィックスに.xdoを付けて作成するレポート名(例: myreport.xdo)。
String folderAbsolutePathURL	作成したレポートを配置するフォルダのパス(例: xmlp/Reports/financials)。
String dataModelURL	このレポートのデータソースとして使用されるデータ・モデルへのパス。(例: xmlp/Reports/financials/Data Models/my data model.xdm)。
String templateFileName	レポート定義に追加するテンプレートのファイル名。
byte[] templateData	テンプレート・ファイル。
String XLIFFFileName	XLIFFファイルのファイル名。XLIFFファイル名にロケールを次のように追加する必要があります。 template_<language code>_<country code>.xlf 説明: <language_code>は、2文字のISO 639言語コードです。 <country_code>は、2文字のISO 639言語コードです。 例: template_en_us.xlf
byte[] XLIFFData	XLIFFファイル。
boolean updateFlag	trueの場合、既存のレポートが上書きされます。falseの場合、レポートが存在すればエラーがスローされます。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.3 downloadReportDataChunk()メソッド

downloadReportDataChunk()メソッドは、非常に大きいドキュメントのダウンロードの際に、すべてのドキュメントのコンテンツがダウンロードされるまでコール元がこのメソッドを複数回コールできるようにします。このメソッドをコールするたびにドキュメントのチャンクがダウンロードされます。この場合、beginIdxパラメータはファイルのダウンロードの開始ポイントを参照します。

第2.3.44項「ReportDataChunk」を参照してください。

注意: uploadReportDataChunk()やdownloadReportDataChunk()をクラスタ環境で使用する際、クラスタ内にあるすべてのサーバーでアクセスできる共有ディレクトリに「システム一時ディレクトリ」を設定する必要があります。「システム一時ディレクトリ」を設定するには: BI Publisherに管理者権限でサインインします。 「管理」リンクをクリックします。 「システム・メンテナンス」で「サーバー構成」を選択します。 「システム一時ディレクトリ」プロパティの「一般プロパティ」の下で、クラスタ内にあるすべてのサーバーでアクセスできるディレクトリの絶対パスを入力します。 たとえば、ディレクトリが${xdo.server.config.dir}/tempの下にある場合でも/net/subfoldera/scratch/subfolderb/bicat/tempのように絶対パスを入力する必要があります 「システム一時ディレクトリ」で同じ値を入力して、クラスタ内にあるすべてのサーバーでこの手順を繰り返します。

シグネチャ

ReportDataChunk downloadReportDataChunk(String fileID, int beginIdx, int size);

表4-3 downloadReportDataChunk()メソッドのパラメータ

パラメータ	説明
String fileID	fileIDはReportResponse内部に返されます。これは、runReport()メソッドをコールすると返されます。
int beginIdx	索引の開始ポイント(デフォルトは1)です。
int size	ダウンロードするファイルのサイズ(KB単位)です。

4.4 downloadReportDataChunkInSession()メソッド

downloadReportDataChunk()メソッドは、指定ユーザーのbipSessionTokenを使用して非常に大きいドキュメントをダウンロードします。すべてのドキュメントのコンテンツがダウンロードされるまで、コール元がこのメソッドを複数回コールします。このメソッドをコールするたびにドキュメントのチャンクがダウンロードされます。この場合、beginIdxパラメータはファイルのダウンロードの開始ポイントを参照します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

ReportDataChunk downloadReportDataChunkInSession(String fileID, int beginIdx, int size, String bipSessionToken);

表4-4 downloadReportDataChunkInSession()メソッドのパラメータ

パラメータ	説明
String fileID	fileIDはReportRequest内部に返されます。これは、runReport()メソッドをコールすると返されます。
int beginIdx	索引の開始ポイント(デフォルトは1)です。
int size	ダウンロードするファイルのサイズ(KB単位)です。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.5 getReportDefinition()メソッド

getReportDefinition()メソッドは、デフォルトのテンプレート、出力タイプ、テンプレートIDのリストなど、レポートに関する情報を取得します。テンプレートIDのリストを使用して、デフォルト以外のテンプレートでレポートを生成できます。

第2.3.45項「ReportDefinition」を参照してください。

シグネチャ

ReportDefinition getReportDefinition(String reportAbsolutePath, String userID, String password);

表4-5 getReportDefinition()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート定義を取得するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.6 getReportDefinitionInSession()メソッド

getReportDefinitionInSession()メソッドは、指定ユーザーのbipSessionTokenを使用してレポートに関する情報を取得します。このメソッドは、デフォルトのテンプレート、出力タイプ、テンプレートIDのリストなど、レポートの詳細を返します。テンプレートIDのリストを使用して、デフォルト以外のテンプレートでレポートを生成できます。

第2.3.45項「ReportDefinition」を参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

ReportDefinition getReportDefinitionInSession(String reportAbsolutePath, String bipSessionToken);

表4-6 getReportDefinitionInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート定義を取得するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.7 getReportParameters()メソッド

getReportParameters()メソッドは、レポート・パラメータとそのデフォルト値の配列を取得します。パラメータのリストを使用して、レポートの実行やスケジュールを行う前にパラメータ値を設定できます。

第2.3.42項「ParamNameValue」を参照してください。

シグネチャ

ParamNameValues getReportParameters(ReportRequest reportRequest, String userID, String password);

表4-7 getReportParameters()メソッドのパラメータ

パラメータ	説明
ReportRequest reportRequest	第2.3.46項「ReportRequest」を参照してください。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.8 getReportParametersInSession()メソッド

getReportParameters()メソッドは、指定ユーザーのbipSessionTokenに基づいてレポート・パラメータとそのデフォルト値の配列を取得します。パラメータのリストを使用して、レポートの実行やスケジュールを行う前にパラメータ値を設定できます。

第2.3.42項「ParamNameValue」を参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

ParamNameValues getReportParametersInSession(ReportRequest reportRequest, String bipSessionToken);

表4-8 getReportParametersInSession()メソッドのパラメータ

パラメータ	説明
ReportRequest reportRequest	第2.3.46項「ReportRequest」を参照してください。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.9 getReportSampleData()メソッド

getReportSampleData()メソッドは、レポート・データ・モデルを使用して格納されたサンプル・データ・ファイルを取得します。

シグネチャ

byte[] getReportSampleData(String reportAbsolutePath, String userID, String password);

表4-9 getReportSampleData()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート・データ・モデルのサンプル・データの取得元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.10 getReportSampleDataInSession()メソッド

getReportSampleDataInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてレポート・データ・モデルを使用して格納されたサンプル・データ・ファイルを取得します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] getReportSampleData(String reportAbsolutePath, String bipSessionToken);

表4-10 getReportSampleDataInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート・データ・モデルのサンプル・データの取得元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.11 getTemplate()メソッド

getTemplate()メソッドは、BI Publisherカタログ内のレポート定義からテンプレートを取得します。

シグネチャ

byte[] getTemplate(String reportAbsolutePath, String templateID, String locale, String userID, String password);

表4-11 getTemplate()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートを関連付けるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateID	テンプレートのID(例:Chart Layout)。
String locale	取得するテンプレートのロケール(例: en_US)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.12 getTemplateInSession()メソッド

getTemplateInSession()メソッドは、指定ユーザーのbipTokenSessionに基づいてBI Publisherカタログ内にレポート定義からテンプレートを取得します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] getTemplateInSession(String reportAbsolutePath, String templateID, String locale, String bipSessionToken);

表4-12 getTemplateInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートを関連付けるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateID	テンプレートのID(例:Chart Layout)。
String locale	取得するテンプレートのロケール(例: en_US)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.13 getTemplateParameters()メソッド

getReportParameters()メソッドは、テンプレートのパラメータを取得します。

第2.3.41項「ParamNameValue」を参照してください。

シグネチャ

ParamNameValue[] getTemplateParameters(String reportAbsolutePath, String templateID, String userID, String password);

表4-13 getTemplateParameters()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート定義を取得するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateID	テンプレートに割当てられたID(例: "Chart Layout")。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.14 getTemplateParameterInSession()メソッド

getReportParametersInSession()メソッドは、テンプレートのパラメータを取得します。

第2.3.41項「ParamNameValue」を参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

ParamNameValue[] getTemplateParameters(String reportAbsolutePath, String templateID, String bipSessionToken);

表4-14 getTemplateParameterInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	レポート定義を取得するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateID	テンプレートに割当てられたID(例: "Chart Layout")。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.15 getXDOSchema()メソッド

getXDOSchema()メソッドは、BI Publisherカタログ内のレポート定義に対応するXDOスキーマを取得します。

シグネチャ

byte[] getXDOSchema(String reportAbsolutePath, String locale, String userID, String password);

表4-15 getXDOSchema()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	XDOスキーマの取得元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String locale	取得するテンプレートのロケール(例: en_US)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.16 getXDOSchemaInSession()メソッド

getXDOSchemaInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内にレポート定義に対応するXDOスキーマを取得します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] getXDOSchemaInSession(String reportAbsolutePath, String locale, String bipSessionToken);

表4-16 getXDOSchemaInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	XDOスキーマの取得元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String locale	取得するテンプレートのロケール(例: en_US)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.17 removeTemplateForReport()メソッド

removeTemplateForReport()メソッドは、BI Publisherカタログ内のレポート定義からテンプレートを削除します。

シグネチャ

boolean removeTemplateForReport(String reportAbsolutePath, String templateFileName, String userID, String password);

表4-17 removeTemplateForReport()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートの削除元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateFileName	削除するテンプレートのファイル名。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.18 removeTemplateForReportInSession()メソッド

removeTemplateForReportInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内にレポート定義からテンプレートを削除します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean removeTemplateForReportInSession(String reportAbsolutePath, String templateFileName, String bipSessionToken);

表4-18 removeTemplateForReportInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートの削除元となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateFileName	削除するテンプレートのファイル名。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.19 runReport()メソッド

runReport()メソッドは、BI Publisherサーバーにリクエストを送信して特定のレポートを実行します。

第2.3.46項「ReportRequest」および第2.3.47項「ReportResponse」を参照してください。

シグネチャ

ReportResponse runReport(ReportRequest reportRequest, String userID, String password);

表4-19 runReport()メソッドのパラメータ

パラメータ	説明
ReportRequest reportRequest	第2.3.46項「ReportRequest」を参照してください。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.20 runReportInSession()メソッド

runReportInSession()メソッドは、BI Publisherサーバーにリクエストを送信して、指定ユーザーのbipSessionTokenに基づいて特定のレポートを実行します。

第2.3.46項「ReportRequest」および第2.3.47項「ReportResponse」を参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

ReportResponse runReportInSession(ReportRequest reportRequest, String bipSessionToken);

表4-20 runReportInSession()メソッドのパラメータ

パラメータ	説明
ReportRequest reportRequest	第2.3.46項「ReportRequest」を参照してください。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.21 updateReportDefinition()メソッド

updateReportDefinition()は、レポート定義ファイル(.xdo)の属性を更新して、そのファイルをBI Publisheカタログに書き戻します。

シグネチャ

boolean updateReportDefinition(String reportAbsPath, ReportDefinition newReportDefn, String userID, String password);

表4-21 updateReportDefinition()メソッドのパラメータ

パラメータ	説明
String reportAbsPath	レポート定義を更新するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
ReportDefinition newReportDefn	第2.3.45項「ReportDefinition」を参照してください。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.22 updateReportDefinitionInSession()メソッド

updateReportDefinitionInSession()メソッドは、指定ユーザーのbipTokenSessionに基づいてレポート定義ファイル(.xdo)の属性を更新してから、そのファイルをBI Publisherカタログに書き戻します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean updateReportDefinitionInSession(String reportAbsPath, ReportDefinition newReportDefn, String bipSessionToken);

表4-22 updateReportDefinitionInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsPath	レポート定義を更新するレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
ReportDefinition newReportDefn	第2.3.45項「ReportDefinition」を参照してください。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.23 updateTemplateForReport()メソッド

updateTemplateForReport()メソッドは、BI Publisherカタログ内の特定レポートのテンプレートを更新します。

シグネチャ

boolean updateTemplateForReport(String reportAbsolutePath, String templateName, String locale, byte[] templateData, String userID, String password);

表4-23 updateTemplateForReport()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	更新するテンプレートが含まれるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateName	更新するテンプレートの名前(例: Chart Layout)。
String locale	更新するテンプレートのロケール(例: en_US)。
byte[] templateData	テンプレート・ファイル。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.24 updateTemplateForReportInSession()メソッド

updateTemplateForReportInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内の特定レポートのテンプレートを更新します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean updateTemplateForReportInSession(String reportAbsolutePath, String templateName, String locale, byte[] templateData, String bipSessionToken);

表4-24 updateTemplateForReportInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	更新するテンプレートが含まれるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateName	更新するテンプレートの名前(例: Chart Layout)。
String locale	更新するテンプレートのロケール(例: en_US)。
byte[] templateData	テンプレート・ファイル。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.25 updateXLIFFForReport()メソッド

updateXLIFFForReport()メソッドは、BI Publisherカタログ内のレイアウト定義に関連付けられた翻訳ファイル(XLIFF)を更新します。

シグネチャ

boolean updateXLIFFForReport(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String userID, String password);

表4-25 updateXLIFFForReport()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	更新するXLIFFファイルが含まれるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
byte[] xliffData	アップロードするXLIFFファイルです。
String layoutFileName	XLIFFファイルを更新対象とするレイアウトのファイル名。たとえば、employee_listing.rtfです。
String locale	XLIFFに割り当てられるロケールです(en_USなど)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.26 updateXLIFFForReportInSession()メソッド

updateXLIFFForReportInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内のレイアウト定義に関連付けられた翻訳ファイル(XLIFF)を更新します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean updateXLIFFForReportInSession(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String bipSessionToken);

表4-26 updateXLIFFForReportInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	更新するXLIFFファイルが含まれるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
byte[] xliffData	アップロードするXLIFFファイルです。
String layoutFileName	XLIFFファイルを更新対象とするレイアウトのファイル名。たとえば、employee_listing.rtfです。
String locale	XLIFFに割り当てられるロケールです(en_USなど)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.27 uploadReportDataChunk()メソッド

uploadReportDataChunk()メソッドは、レポート・データ・チャンクをアップロードします。

注意: uploadReportDataChunk()やdownloadReportDataChunk()をクラスタ環境で使用する際、クラスタ内にあるすべてのサーバーでアクセスできる共有ディレクトリに「システム一時ディレクトリ」を設定する必要があります。「システム一時ディレクトリ」を設定するには: BI Publisherに管理者権限でサインインします。 「管理」リンクをクリックします。 「システム・メンテナンス」で「サーバー構成」を選択します。 「システム一時ディレクトリ」プロパティの「一般プロパティ」の下で、クラスタ内にあるすべてのサーバーでアクセスできるディレクトリの絶対パスを入力します。 たとえば、ディレクトリが${xdo.server.config.dir}/tempの下にある場合でも/net/subfoldera/scratch/subfolderb/bicat/tempのように絶対パスを入力する必要があります 「システム一時ディレクトリ」で同じ値を入力して、クラスタ内にあるすべてのサーバーでこの手順を繰り返します。

シグネチャ

uploadReportDataChunk(String fileID, byte[] reportDataChunk, String reportRawDataChunk, String userID, String password);

表4-27 uploadReportDataChunk()メソッドのパラメータ

パラメータ	説明
String fileID	最初のコールではfileIDを指定する必要がありません。最初のXMLデータのチャンクのアップロードが成功すると、ファイル名などのfileIDが返されます。その後のコールでは、同じfileIDを指定して同じファイルにその後のデータ・チャンクを追加できます。
byte[] reportDataChunk	アップロードするXMLデータ。
String reportRawDataChunk	XMLデータをreportRawDataChunkと表す文字列。これは、reportDataChunk byte[]の代用です。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.28 uploadReportDataChunkInSession()メソッド

uploadReportDataChunkInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてレポート・データ・チャンクをアップロードします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

uploadReportDataChunkInSession(String fileID, byte[] reportDataChunk, String reportRawDataChunk, String bipSessionToken);

表4-28 uploadReportDataChunkInSession()メソッドのパラメータ

パラメータ	説明
byte[] reportDataChunk	アップロードするXMLデータ。
String reportRawDataChunk	XMLデータをreportRawDataChunkと表す文字列。これは、reportDataChunk byte[]の代用です。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.29 uploadTemplateForReport()メソッド

uploadTemplateForReport()メソッドは、BI Publisherカタログ内のレポート定義にテンプレートをアップロードします。

シグネチャ

boolean uploadTemplateForReport(String reportAbsolutePath, String templateName, String templateType, String locale, byte[] templateData, String userID, String password);

表4-29 uploadTemplateForReport()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートのアップロード先となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateName	アップロードするテンプレートのファイル名。
String templateType	テンプレート・タイプ。有効な値は次のとおりです。 csv (CSV) eText (eTextのテンプレート) excel (Microsoft Excel) excel2000 (Microsoft Excel 2000) flash (Adobe Flash) html (HTML) mhtml (MIME HTML) pdf (Adobe PDF) pdfz (eBook) ppt (Microsoft PowerPoint) rtf (リッチ・テキスト形式) text (テキスト) txml (変換されたXML) xml (XML) xpa (Analyzerテンプレート) xpt (BI Publisherテンプレート) xslfo (XSL-FOスタイル・シート)
String locale	テンプレートに割り当てられるロケール(例: en_US)。
byte[] templateData	アップロードするテンプレート・ファイルのコンテンツ。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.30 uploadTemplateForReportInSession()メソッド

uploadTemplateForReportInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内のレポート定義にテンプレートをアップロードします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean uploadTemplateForReportInSession(String reportAbsolutePath, String templateName, String templateType, String locale, byte[] templateData, String bipSessionToken);

表4-30 uploadTemplateForReportInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	テンプレートのアップロード先となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
String templateFileName	アップロードするテンプレートのファイル名。
String templateName	アップロードするテンプレートの名前。
String locale	テンプレートに割り当てられるロケール(例: en_US)。
byte[] templateData	アップロードするテンプレート・ファイルのコンテンツ。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。

4.31 uploadXLIFFForReport()メソッド

uploadXLIFFForReport()メソッドは、BI Publisherカタログ内のレイアウト定義に翻訳ファイル(XLIFF)をアップロードします。

シグネチャ

boolean uploadXLIFFForReport(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String userID, String password);

表4-31 uploadXLIFFForReport()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	XLIFFのアップロード先となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
byte[] xliffData	アップロードするXLIFFファイルです。
String layoutFileName	XLIFFファイルに関連したレイアウトのファイル名。たとえば、employee_listing.rtfです。
String locale	XLIFFに割り当てられるロケールです(en_USなど)。
String userID	BI Publisherユーザー名を指定します。
String password	ユーザー名のパスワードを指定します。

4.32 uploadXLIFFForReportInSession()メソッド

uploadXLIFFForReport()メソッドは、指定ユーザーのbipSessionTokenに基づいてBI Publisherカタログ内のレイアウト定義に翻訳ファイル(XLIFF)をアップロードします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean uploadXLIFFForReportInSession(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String bipSessionToken);

表4-32 uploadXLIFFForReportInSession()メソッドのパラメータ

パラメータ	説明
String reportAbsolutePath	XLIFFのアップロード先となるレポートへのパス。(例: /HR Manager/Employee Reports/Employee Listing.xdo)。
byte[] xliffData	アップロードするXLIFFファイルです。
String layoutFileName	XLIFFファイルに関連したレイアウトのファイル名。たとえば、employee_listing.rtfです。
String locale	XLIFFに割り当てられるロケールです(en_USなど)。
String bipSessionToken	BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。