ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Business Intelligence Publisher開発者ガイド
11g リリース1 (11.1.1)
B66710-04
  目次へ移動
目次
索引へ移動
索引

前
前へ
 
次へ
次へ
 

3 ScheduleService

この章では、BI Publisherスケジューラとやり取りする際に使用できるScheduleServiceメソッドの詳細について説明します。ここでは、レポート・ジョブのスケジュール作成、レポート出力の取得、レポート履歴の管理に対応するメソッドについて述べます。

この章には次の項が含まれます:


注意:

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


3.1 cancelSchedule()メソッド

cancelSchedule()メソッドは、現在実行中のスケジュールされたジョブを取り消します。

シグネチャ

boolean cancelSchedule(String jobInstanceID, String userID, String password);

表3-1 cancelSchedule()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

取り消されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.2 cancelScheduleInSession()メソッド

指定されたユーザーのbipSessionToken文字列に関連付けられたスケジュールを取り消します。

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

シグネチャ

String cancelScheduleInSession(String jobInstanceID, String bipSessionToken);

表3-2 cancelScheduleInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.3 deleteJobHistory()メソッド

deleteJobHistory()メソッドは、レポート・ジョブに関する履歴情報の一時的削除を実行します。これに対して、purgeJobHistory()メソッドは永久削除を実行します。deleteJobHistory()メソッドはpurgeJobHistory()メソッドに優先している必要があります。

boolean deleteJobHistory(String instanceJobID, String userID, String password);

シグネチャ

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

パラメータ 説明

String instanceJobID

出力を生成したジョブのインスタンスに割り当てられたID。instanceJobIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.4 deleteJobHistoryInSession()メソッド

指定されたユーザーのbipSessionToken文字列に関連付けられたジョブの履歴を取り消します。

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

シグネチャ

boolean deleteJobHistoryInSession(String jobInstanceID, String bipSessionToken);

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

パラメータ 説明

String jobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.5 deleteSchedule()メソッド

deleteSchedule()メソッドは、スケジューラ・キューからスケジュールされたジョブを削除します。

シグネチャ

boolean deleteSchedule(String jobInstanceID, String userID, String password);

表3-5 deleteSchedule()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

削除されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.6 deleteScheduleInSession()メソッド

指定されたユーザーのbipSessionToken文字列に関連付けられたスケジュールを削除します。

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

シグネチャ

boolean deleteScheduleInSession(String jobInstanceID, String bipSessionToken);

表3-6 deleteScheduleInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.7 deliveryService()メソッド

deliveryService()メソッドは、指定された配信チャネルを経由してドキュメントをソースから配信先へ配信します。

シグネチャ

String deliveryService(DeliveryRequest deliveryRequest, String userID, String password);

表3-7 deliveryService()メソッドのパラメータ

パラメータ 説明

DeliveryRequest deliveryRequest

DeliveryRequestオブジェクト。第2.3.21項「DeliveryRequest」を参照してください。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.8 deliveryServiceInSession()メソッド

指定されたユーザーのdeliveryRequestとbipSessionToken文字列に関連付けられたドキュメントを配信します。

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

シグネチャ

String deliveryServiceInSession(String jobInstanceID, String bipSessionToken);

表3-8 deliveryServiceInSession()メソッドのパラメータ

パラメータ 説明

DeliveryRequest deliveryRequest

DeliveryRequestオブジェクト。第2.3.21項「DeliveryRequest」を参照してください。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.9 downloadDocumentData()メソッド

レポート・ドキュメントをBI Publisherサーバーのローカル一時ディレクトリに格納して、後でダウンロードできるようにユーザーのfileIDを返します。これは、レポートのデータ・サイズが大きな影響を与える場合に備えてパフォーマンスを考慮して実装されます。

シグネチャ

String downloadDocumentData(String JobOutputID, String userID, String password);

表3-9 downloadDocumentData()メソッドのパラメータ

パラメータ 説明

String jobOutputID

出力に割り当てられたID。jobOutputIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.10 downloadDocumentDataInSession()メソッド

指定されたユーザーのjobInstanceIDとbipSessionToken文字列に関連付けられたドキュメントのレポートをダウンロードします。

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

シグネチャ

String downloadDocumentDataInSession(String jobInstanceID, String bipSessionToken);

表3-10 downloadDocumentDataInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.11 downloadXMLData()メソッド

レポートのドキュメントを生成する際に使用されるXMLデータを返します。生データをXML形式で返します。

シグネチャ

downloadXMLData(String jobInstanceID, String userID, String password);

表3-11 downloadXMLData()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

XMLデータに割り当てられたID。jobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.12 downloadXMLDataInSession()メソッド

指定されたユーザーのbipSessionToken文字列に関連付けられたドキュメント・レポートのXMLデータをダウンロードします。

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

シグネチャ

String downloadXMLDataInSession(String jobInstanceID, String bipSessionToken);

表3-12 downloadXMLDataInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.13 getAllScheduledReport()メソッド

getAllScheduledReportInfo()メソッドは、JobFilterPropertiesオブジェクトを介して渡されるフィルタ条件に一致するスケジュール済レポート・ジョブすべてに関する情報を返します。

シグネチャ

JobInfosList getAllScheduledReportInfo(JobFilterProperties filter, int beginIdx, String userID, String password);

表3-13 getAllScheduledReport()メソッドのパラメータ

パラメータ 説明

JobFilterProperties filter

JobFilterPropertiesオブジェクトは、情報を返そうとするレポート・ジョブに対して特定の条件を指定します。第2.3.30項「JobFilterProperties」を参照してください。

int beginIdx

索引の開始ポイント(デフォルトは1)です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.14 getAllScheduledReportHistory()メソッド

getAllScheduledReportHistory()メソッドは、JobFilterPropertiesオブジェクトを介して渡されるフィルタ条件に一致するスケジュール済レポート履歴すべてに関する情報を返します。

シグネチャ

JobInfosList getAllScheduledReportHistory(JobFilterProperties filter, int beginIdx, String userID, String password);

表3-14 getAllScheduledReportHistory()メソッドのパラメータ

パラメータ 説明

JobFilterProperties filter

JobFilterPropertiesオブジェクトは、情報を返そうとするレポート・ジョブに対して特定の条件を指定します。第2.3.30項「JobFilterProperties」を参照してください。

int beginIdx

索引の開始ポイント(デフォルトは1)です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.15 getAllScheduledReportHistoryInSession()メソッド

getAllScheduledReportHistoryInSession()メソッドは、JobFilterPropertiesオブジェクトを介して渡されるフィルタ条件に一致し指定ユーザーのbipSessionToken文字列に基づいているスケジュール済レポート履歴すべてに関する情報を返します。

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

シグネチャ

JobInfosList getAllScheduledReportHistoryInSession(JobFilterProperties filter, int beginIdx, String bipSessionToken);

表3-15 getAllScheduledReportHistoryInSession()メソッドのパラメータ

パラメータ 説明

JobFilterProperties filter

JobFilterPropertiesオブジェクトは、情報を返そうとするレポート・ジョブに対して特定の条件を指定します。第2.3.30項「JobFilterProperties」を参照してください。

int beginIdx

索引の開始ポイント(デフォルトは1)です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.16 getAllScheduledReportInSession()メソッド

getAllScheduledReportInSession()メソッドは、JobFilterPropertiesオブジェクトを介して渡されるフィルタ条件に一致し指定ユーザーのbipSessionToken文字列に基づいているスケジュール済レポートすべてに関する情報を返します。

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

シグネチャ

JobInfosList getAllScheduledReportInSession(JobFilterProperties filter, int beginIdx, String bipSessionToken);

表3-16 getAllScheduledReportInSession()メソッドのパラメータ

パラメータ 説明

JobFilterProperties filter

JobFilterPropertiesオブジェクトは、情報を返そうとするレポート・ジョブに対して特定の条件を指定します。第2.3.30項「JobFilterProperties」を参照してください。

int beginIdx

索引の開始ポイント(デフォルトは1)です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.17 getDeliveryServiceDefinition()メソッド

getDeliveryServiceDefinition()メソッドは、指定ユーザーのIDとパスワードに対する配信サービスの定義を取得します。deliveryService()メソッドを参照してください。

シグネチャ

DeliveryServiceDefinition getDeliveryServiceDefinition(String userID, String password);

表3-17 getDeliveryServiceDefinition()メソッドのパラメータ

パラメータ 説明

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.18 getDeliveryServiceDefinitionInSession()メソッド

getDeliveryServiceDefinitionInSession()メソッドは、指定ユーザーのbipSessionTokenに基づいて配信サービスの定義を取得します。deliveryService()メソッドを参照してください。

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

シグネチャ

DeliveryServiceDefinition getDeliveryServiceDefinitionInSession(String bipSessionToken);

表3-18 getDeliveryServiceDefinitionInSession()メソッドのパラメータ

パラメータ 説明

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.19 getDocumentData()メソッド

getDocumentData()メソッドは、BI Publisherのスケジュールされたジョブにより生成されたドキュメントを返します。getDocumentData()メソッドは、jobOutputIDをパラメータとして取得し、適切なドキュメントを返します。

jobOutputIDを取得する方法: scheduleReport()メソッドからjobIDが返されます。この親jobIDを使用してgetAllScheduledReportHistory()をコールし、その子(スケジュール・ジョブ)のリストを取得します。適切な子jobIDを使用してgetScheduledOutputInfo()をコールし、この特定ジョブに対するoutputIDのリストを取得します。目的のジョブのoutputIDをgetDocumentData()メソッドへの入力(JobOutputIDパラメータ)として使用し、ドキュメント・データを取得します。

getDocumentData()メソッドはレポート・ドキュメントのbyte[]を返し、downloadDocumentData()メソッドはレポート・ドキュメントをBI Publisherサーバーにローカル・ファイルとして格納する点に注意してください。後のメソッドはファイルのIDを返し、それにより配信サービスを介してレポート・ドキュメントをダウンロードできます。これは、レポート・ドキュメントのサイズが大きい場合に備えてパフォーマンスを考慮したためです。

シグネチャ

byte[] getDocumentData(String jobOutputID, String userID, String password);

表3-19 getDocumentData()メソッドのパラメータ

パラメータ 説明

String jobOutputID

出力に割り当てられたジョブの出力。出力のIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.20 getDocumentDataInSession()メソッド

指定ユーザーのJobOutputIDとbipSessionTokenに基づいてレポート・ドキュメントのbyte[]を返します。

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

シグネチャ

byte[] getDocumentDataInSession(String jobOutputID, String bipSessionToken);

表3-20 getDocumentDataInSession()メソッドのパラメータ

パラメータ 説明

String jobOutputID

出力に割り当てられたID。jobOutputIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.21 getScheduledJobInfo()メソッド

getScheduledJobInfo()メソッドは、レポート・パラメータやその他のプロパティなど、発行済のジョブに関する詳細が含まれているJobDetailオブジェクトを返します。このメソッドは、指定されたjobInstanceID、userIDおよびパスワードのデータベースに格納されている情報をすべて取得します。

シグネチャ

JobInfo getScheduledJobInfo(int jobInstanceID, String userID, String password);

表3-21 getScheduledJobInfo()メソッドのパラメータ

パラメータ 説明

int jobInstanceID

ジョブ情報を返すジョブのIDです。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.22 getScheduledJobInfoInSession()メソッド

指定されたユーザーのjobInstanceIDとbipSessionTokenに関連付けられたジョブの詳細が含まれているJobDetailオブジェクトを返します。

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

シグネチャ

JobDetail getScheduledJobInfoInSession(String jobInstanceID, String bipSessionToken);

表3-22 getScheduledJobInfoInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

ジョブ・インスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.23 getScheduledReportDeliveryInfo()メソッド

getScheduledReportdeliveryInfo()メソッドは、スケジュールされたジョブ出力の配信に関する情報を取得します。各スケジュールされたジョブには、複数のoutputIDが存在することがあります。各outputIDには、複数の配信情報が存在することがあります。第2.3.35項「JobOutputDeliverysList」を参照してください。

シグネチャ

JobOutputDeliverysList getScheduledReportDeliveryInfo(String jobOutputID, String userID, String password);

表3-23 getScheduledReportDeliveryInfo()メソッドのパラメータ

パラメータ 説明

String jobOutputID

必要とする情報に対するジョブの出力に割り当てられたID。jobOutputIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.24 getScheduledReportDeliveryInfoInSession()メソッド

指定されたユーザーのjobOutputIDとbipSessionTokenに対する詳細が含まれているJobOutputDeliverysListオブジェクトを返します。

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

シグネチャ

JobOutputDeliverysList getScheduledReportDeliveryInfoInSession(String jobOutputID, String bipSessionToken);

表3-24 getScheduledReportDeliveryInfoInSession()メソッドのパラメータ

パラメータ 説明

String jobOutputID

ジョブ出力に割り当てられたID。jobOutputIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.25 getScheduledReportOutputInfo()メソッド

getScheduledReportOutputInfo()メソッドは、特定のスケジュールされたレポート出力に関する情報を返します。

シグネチャ

JobOutputsList getScheduledReportOutputInfo(String jobInstanceID, String userID, String password);

表3-25 getScheduledReportOutputInfo()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

ジョブ情報を返すジョブのIDです。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.26 getScheduledReportOutputInfoInSession()メソッド

getScheduledReportOutputInfo()メソッドは、特定のスケジュールされたレポート出力のjobInstanceIDと指定ユーザーのbipSessionTokenに基づいて、そのレポート出力に関する情報を返します。

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

シグネチャ

JobOutputsList getScheduledReportOutputInfoInSession(String jobInstanceID, String bipTokenSession);

表3-26 getScheduledReportOutputInfoInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

ジョブ情報を返すジョブのIDです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.27 getXMLData()メソッド

getXMLData()メソッドは、BI Publisherのスケジュールされたジョブにより生成されたデータ・ドキュメントをXML形式で返します。scheduleReport()メソッドから返されたJobOutputIDを使用して、生成済のXMLドキュメントを取得できます。

getXMLData()メソッドはレポート・ドキュメントのbyte[]を返し、downloadXMLData()メソッドはXMLデータをBI Publisherサーバーにローカル・ファイルとして格納する点に注意してください。後のメソッドはファイルのIDを返し、それにより配信サービスを介してXMLベースのドキュメントをダウンロードできます。これは、レポート・ドキュメントのサイズが非常に大きい場合に備えてパフォーマンスを考慮したためです。

シグネチャ

byte[] getXMLData(String JobInstanceID, String userID, String password);

表3-27 getXMLData()メソッドのパラメータ

パラメータ 説明

String JobInstanceID

出力を生成したジョブのインスタンスに割り当てられたID。JobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.28 getXMLDataInSession()メソッド

指定ユーザーのjobInstanceIDとbipSessionTokenに基づいてXMLデータのbyte[]を返します。

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

シグネチャ

byte[] getXMLDataInSession(String jobInstanceID, String bipSessionToken);

表3-28 getXMLDataInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

ジョブ・インスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.29 purgeJobHistory()メソッド

purgeHistory()メソッドは、レポート・ジョブに関する履歴情報の完全削除を実行します。つまり、情報をデータベースから永久的に消去します。

purgeJobHistory()メソッドよりdeleteJobHistory()を優先させる必要があります。そうしないと、次のSOAP障害がスローされます。

purgeJobHistory failed due to job is not deleted. You have to delete JobHistory first prior to purge.

シグネチャ

boolean purgeJobHistory(String instanceJobID, String userID, String password);

表3-29 purgeJobHistory()メソッドのパラメータ

パラメータ 説明

String instanceJobID

出力を生成したジョブのインスタンスに割り当てられたID。instanceJobIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.30 purgeJobHistoryInSession()メソッド

指定されたinstanceJobIDと指定されたユーザーのbipSessionTokenのデータベースからジョブ履歴を永久的に消去します。そのアクションより、deleteJobHistoryInSessionの方が優先している必要があります。

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

シグネチャ

boolean purgeJobHistoryInSession(String instanceJobID, String bipSessionToken);

表3-30 purgeJobHistoryInSession()メソッドのパラメータ

パラメータ 説明

String instanceJobID

ジョブ・インスタンスに割り当てられたID。instanceJobIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.31 resendScheduledReport()メソッド

resendScheduledReport()メソッドは、事前定義のスケジュールされたジョブを再送信します。再送信されたアクションは、それぞれoutputJobIDに送信されます。この再送信アクションを実行する際に使用されるのは事前定義された配信パラメータであるため、配信チャネルのオプションを定義する必要はありません。

シグネチャ

boolean resendScheduledReport(String outputJobID, String userID, String password);

表3-31 resendScheduledReport()メソッドのパラメータ

パラメータ 説明

String outputJobID

再送信するスケジュールされたジョブのIDです。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.32 resendScheduledReportInSession()メソッド

事前定義されたスケジュール・レポートのoutputJobIDと指定ユーザーのbipSessionTokenに基づいて、そのレポートを再送信します。

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

シグネチャ

boolean resendScheduledReportInSession(String outputJobID, String bipSessionToken);

表3-32 resendScheduledReportInSession()メソッドのパラメータ

パラメータ 説明

String outputJobID

再送信するスケジュールされたジョブのIDです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.33 resumeSchedule()メソッド

resumeSchedule()メソッドは、一時停止のスケジュール・ジョブを再開します。

シグネチャ

boolean resumeSchedule(String jobInstanceID, String userID, String password);

表3-33 resumeSchedule()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

再開されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.34 resumeScheduleInSession()メソッド

事前に一時停止されたスケジュール・ジョブを、そのジョブのjobInstanceIDと指定ユーザーのbipSessionTokenに基づいて再開します。

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

シグネチャ

boolean resumeScheduleInSession(String outputJobID, String bipSessionToken);

表3-34 resumeScheduleInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

再開されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.35 scheduleReport()メソッド

scheduleReport()メソッドは、BI Publisherカタログ内のレポートをスケジュールします。レポートを送信して即時に実行するか、またはレポートの実行をスケジュールするジョブを作成できます。レポートをスケジュールする場合、BI Publisher Enterpriseサーバーのインスタンスで設定されている任意の配信先にレポートを配信することもできます。

このメソッドは、スケジュールされたジョブのJobIDを返します。

シグネチャ

String scheduleReport(ScheduleRequest scheduleRequest, String userID, String password);

表3-35 scheduleReport()メソッドのパラメータ

パラメータ 説明

ScheduleRequest scheduleRequest

実行対象レポートのScheduleRequestオブジェクトを指定します。第2.3.48項「ScheduleRequest」を参照してください。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.36 scheduleReportInSession()メソッド

指定ユーザーのbipSessionToken、スケジュール・リクエストおよび配信チャネルに基づいてレポートをスケジュールします。

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

シグネチャ

String scheduleReportInSession(ScheduleRequest scheduleRequest, DeliveryChannel deliveryChannel, String bipSessionToken);

表3-36 scheduleReportInSession()メソッドのパラメータ

パラメータ 説明

ScheduleRequest scheduleRequest

実行対象レポートのScheduleRequestオブジェクトを指定します。第2.3.48項「ScheduleRequest」を参照してください。

DeliveryChannel deliveryChannel

レポートの配信に使用される配信チャネルを指定します。第2.3.20項「DeliveryChannels」を参照してください。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


3.37 suspendSchedule()メソッド

suspendSchedule()メソッドは、スケジュール・ジョブを一時停止します。

シグネチャ

boolean suspendschedule(String jobInstanceID, String userID, String password);

表3-37 suspendSchedule()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

一時停止されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


3.38 suspendScheduleInSession()メソッド

スケジュールされたレポートに関連付けられたjobInstanceIDと指定ユーザーのbipSessionTokenに基づいて、そのレポートを一時停止します。

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

シグネチャ

boolean suspendScheduleInSession(String jobInstanceID, String bipSessionToken);

表3-38 suspendScheduleInSession()メソッドのパラメータ

パラメータ 説明

String jobInstanceID

一時停止されるジョブのインスタンスに割り当てられたID。jobInstanceIDは整数の文字列です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。