| ドキュメントのダウンロード | サイト マップ | 用語集 | |
|
|||
| BEA ホーム | 製品 | デベロッパ・センタ | support | askBEA |
|
|
|
|||||||
 |
| e-docs > WebLogic Integration > BPM トピック > BPM クライアント アプリケーション プログラミング > 実行時ワークフロー インスタンスのモニタ |
|
BPM クライアント アプリケーション プログラミング
|
実行時ワークフロー インスタンスのモニタ
この章では、実行時ワークフロー インスタンスをモニタする方法について説明します。内容は以下のとおりです。
WebLogic Integration Studio を使用して実行時ワークフロー インスタンスをモニタする方法の詳細については、『WebLogic Integration Studio ユーザーズ ガイド』の「ワークフローのモニタリング」を参照してください。
ワークフロー インスタンスの取得
オーガニゼーション内のテンプレート インスタンスおよびテンプレート定義インスタンスのリストを取得するには、以下の com.bea.wlpi.server.admin.Admin メソッドを使用してください。
メソッド 1
public java.util.List getTemplateInstances(
java.lang.String templateId,
java.lang.String orgId,
boolean bStarted,
java.util.Date from,
java.util.Date to,
int state,
int max
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
メソッド 2
public java.util.List getTemplateDefinitionInstances(
java.lang.String templateDefinitionId,
java.lang.String orgId,
boolean bStarted,
java.util.Date from,
java.util.Date to,
int state,
int max
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
getTemplateInstances() メソッドおよびgetTemplateDefinitionInstances() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
これらのメソッドは、それぞれテンプレート インスタンスおよびテンプレート定義インスタンスに関連した com.bea.wlpi.common.InstanceInfo オブジェクトのリストを返します。各タスクについての情報にアクセスするには、InstanceInfo オブジェクトに記載の InstanceInfo オブジェクト メソッドを使用します。 たとえば、次のコードでは、activeOrgId 変数の値で指定されたオーガニゼーションのための特定の ID に関連する、すべてのテンプレートおよびテンプレート定義インスタンスがそれぞれ取得されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。 この例では、以下のパラメータを設定します。
List tempinst = admin.getTemplateInstances(templateId,
activeOrgId, true, dateFrom, dateTo, 20, 20);List tempdefinst = admin.getTemplateDefinitionInstances(
templatedefId, activeOrgId, true, dateFrom,
dateTo, 20, 20);
getTemplateInstances() および getTemplateDefinitionInstances() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
ワークフロー インスタンスの確認
この節では、ワークフロー テンプレートまたはテンプレート定義インスタンスの確認を行うために使用するメソッドについて説明します。
ワークフロー テンプレート インスタンスの確認
ワークフロー テンプレート インスタンスが現在実行中かどうかを確認するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public boolean checkForTemplateInstances(
java.lang.String templateId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
checkForTemplateInstances() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
このメソッドは、テンプレート インスタンスが存在するかどうかを示すブール値を返します。
たとえば、次のコードでは、指定した ID の値に関連するテンプレート インスタンスが現在実行中かどうかが確認されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。
boolean tempexists = admin.checkForTemplateInstances(templateId);
checkForTemplateInstances() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
ワークフロー テンプレート定義の確認
ワークフロー テンプレート定義インスタンスを取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public java.util.List checkForTemplateDefinitionInstances(
java.lang.String templateDefinitionId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
checkForTemplateDefinitionInstances() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
このメソッドは、テンプレートまたはテンプレート定義インスタンスが存在するかどうかを示すブール値を返します。 たとえば、次のコードでは、指定した ID の値に関連するテンプレート定義インスタンスが存在するかどうかが確認されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。 checkForTemplateDefinitionInstances() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
boolean tempexists = admin.checkForTemplateInstances(templateId);
boolean tempdefexists = admin.checkForTemplateDefinitionInstances(
templateDefinitionId);
ワークフロー インスタンス タスクの取得
ワークフロー インスタンスに関連したタスクのリストを取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用してください。
public java.util.List getInstanceTasks(
java.lang.String instanceId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
getInstanceTasks() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
このメソッドは、com.bea.wlpi.common.TaskInfo オブジェクトのリストを返します。各タスクについての情報にアクセスするには、TaskInfo オブジェクトに記載の TaskInfo オブジェクト メソッドを使用します。
たとえば、次のコードでは、instanceId 変数の値で指定されたワークフロー インスタンスのタスクが取得されます。このコード例では、admin は、Admin EJB への EJBObject 参照を表します。
List tasks = admin.getInstanceTasks(instanceId);
getInstanceTasks() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
ワークフロー インスタンス情報の取得
ワークフロー インスタンス情報を取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public com.bea.wlpi.common.InstanceInfo getInstanceInfo(
java.lang.String instanceId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
getInstanceInfo() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
このメソッドは、com.bea.wlpi.common.InstanceInfo オブジェクトを返します。ワークフロー インスタンスについての情報にアクセスするには、InstanceInfo オブジェクトに記載の InstanceInfo オブジェクト メソッドを使用します。
たとえば、次のコードでは、instanceId 変数の値で指定されたワークフロー インスタンスの情報が取得されます。このコード例では、admin は、Admin EJB への EJBObject 参照を表します。
InstanceInfo = admin.getInstanceInfo(instanceId);
getInstanceInfo() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
ワークフロー インスタンスのアカウントの取得
ワークフロー インスタンスの数や完了したワークフロー インスタンスの数を取得するには、それぞれ、以下の com.bea.wlpi.server.admin.Admin メソッドを使用してください。
メソッド 1
public int getInstanceCount(
java.lang.String templateId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
メソッド 2
public int getInstanceCount(
java.lang.String templateI,
boolean completed
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
getInstanceCount() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
各メソッドは、指定された基準に基づいてカウントしたワークフロー インスタンスの数に対応する整数値を戻します。 たとえば、次のコードは、すべてのワークフロー インスタンスの数と完了したすべてのワークフロー インスタンスの数を、指定された ID 値に対応してそれぞれ取得します。このコード例では、admin は Admin EJB への EJBObject 参照を表します。 getInstanceCount() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
int count = admin.getInstanceCount(templateId);
int completeCount = admin.getInstanceCount(templateId, true);
ワークフロー インスタンスの削除
この節で説明しているメソッドを使用して、ワークフロー インスタンスを削除できます。
特定のワークフロー インスタンスの削除
特定のワークフロー インスタンスを削除するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public void deleteInstance(
java.lang.String instanceId
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
deleteInstance() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
たとえば、次のコードでは、instanceId で指定されたインスタンスが削除されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。
admin.deleteInstance(instanceId);
ワークフロー テンプレートまたはテンプレート定義のすべてのインスタンスの削除
オーガニゼーション内のテンプレート インスタンスおよびテンプレート定義のインスタンスを削除するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用してください。
メソッド 1
public void deleteTemplateInstances(
java.lang.String templateId,
java.lang.String orgId,
boolean bStarted,
java.util.Date from,
java.util.Date to
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
メソッド 2
public void deleteTemplateDefinitionInstances(
java.lang.String templateDefinitionId,
java.lang.String orgId,
boolean bStarted,
java.util.Date from,
java.util.Date to
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
deleteTemplateInstances() および deleteTemplateDefinitionInstances() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
たとえば、次のコードでは、activeOrgId 変数の値で指定されたオーガニゼーションのための特定の ID に関連する、すべてのテンプレート インスタンスまたはテンプレート定義インスタンスを削除します。この例では、以下のように設定します。
このコード例では、admin は Admin EJB への EJBObject 参照を表します。
admin.deleteTemplateInstances(templateId, activeOrgId, true,
dateFrom, dateTo);
admin.deleteTemplateDefinitionInstances(
templatedefId, activeOrgId, true, dateFrom, dateTo);
deleteInstance()、deleteTemplateInstances() および deleteTemplateDefinitionInstances() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
実行時ワークロードのクエリ
実行時のワークロードをクエリするために、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public java.util.List workloadQuery(
java.lang.String xml
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
workloadQuery() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
|
パラメータ |
説明 |
有効な値 |
|---|---|---|
|
xml |
実行時ワークロードのクエリ要求 |
ワークロード要求 DTDに記載の Workload Request DTD に準拠する XML ドキュメント。 |
このメソッドは、ワークロード応答 DTDで説明されているように、Workload Response DTD に準拠するXML フォーマットでワークロード レポートを返します。
たとえば、次のコードでは、Workload Request DTD に準拠する workloadReq XML ドキュメントに基づいて実行時ワークロードに対するクエリが開始されます。
String workloadresp = workloadQuery(workloadReq);
このメソッドは、Workload Response DTD に準拠するフォーマットで workloadresp ファイルにその応答を書き込みます。workloadQuery() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
実行時統計のクエリ
実行時統計をクエリするために、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。
public java.util.List statisticsQuery(
java.lang.String xml
) throws java.rmi.RemoteException,
com.bea.wlpi.common.WorkflowException
statisticsQuery() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。
|
パラメータ |
説明 |
有効な値 |
|---|---|---|
|
xml |
実行時統計のクエリ要求 |
統計要求 DTDに記載の Workload Request DTD に準拠する XML ドキュメント。 |
このメソッドは、統計応答 DTDで説明されているように、Statistics Response DTD に準拠する XML フォーマットで統計レポートを返します。
たとえば、次のコードでは、Statistics Request DTD に準拠する statisticsReq XML ドキュメントに基づいて実行時統計に対するクエリが開始されます。
java.lang.String statisticsresp = statisticsQuery(statisticsReq);
このメソッドは、Statistics Response DTD に準拠するフォーマットで statisticsresp ファイルにその応答を書き込みます。statisticsQuery() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。
|
|
|
|
||
 |
|
|
 |
 |
 |
|
||
