ワークフロー テンプレート定義の作成および管理

ワークフロー テンプレート定義は、ビジネス プロセスのオペレーションを指定します。各ワークフロー テンプレートに対して、任意の数の定義を作成できます。

この章では、ワークフロー テンプレート定義の作成および管理方法について説明します。内容は以下のとおりです。

• テンプレート定義の作成

• テンプレート定義情報の取得

• テンプレートの定義の取得

• テンプレート定義のコンテンツの取得

• テンプレート定義のコンテンツの設定

• テンプレート定義オーナの取得

• 呼び出し可能なワークフローの取得

• 呼び出し可能なワークフローの検索

• テンプレート定義のロックおよびロック解除

• テンプレート定義の削除

この章に記載するメソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。WebLogic Integration Studio を使用してワークフロー テンプレート定義を管理する方法については、『WebLogic Integration Studio ユーザーズ ガイド』の「ワークフロー テンプレートの定義」を参照してください。

 

---

テンプレート定義の作成

ワークフロー テンプレート定義を作成するには、以下のいずれかの com.bea.wlpi.server.admin.Admin メソッドを使用します。

メソッド 1

public java.lang.String createTemplateDefinition(
  java.lang.String templateId,
  java.lang.String name, 
  java.lang.String xml
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

メソッド 2

public java.lang.String createTemplateDefinition(
  java.lang.String templateId,
  java.lang.String name, 
  java.lang.String xml,
  java.lang.Object transactionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

第 1 のメソッドは、非クラスタ化環境で使用できます。クラスタ化環境では第 2 のメソッドを使用することをお勧めします。この場合、トランザクションがコミットされた後、またはサーバ クラッシュやフェイルオーバーが発生した後に、メソッドが再発行されないよう、指定された ID を使用してメソッドの実行状態が追跡されます。

createTemplateDefinition() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-1 createTemplateDefinition() メソッドのパラメータ

パラメータ	説明	有効な値
templateId	テンプレート定義を作成するテンプレートの ID	有効なテンプレート ID を指定する文字列。 テンプレート ID を取得するには、次の com.bea.wlpi.common.TemplateInfo メソッドを使用する。 public final java.lang.String getId() TemplateInfo オブジェクトを取得する方法については、テンプレートの取得を参照。TemplateInfo オブジェクトで選択可能なメソッドの詳細については、TemplateInfo オブジェクトを参照。
name	新しいテンプレート定義の名前。	非ヌル文字列。
xml	テンプレート定義を定義し、テンプレート定義 DTDに記載の Template Definition DTD に準拠する XML ドキュメント名	非ヌル文字列。
transactionId	トランザクションの ID 注意: このパラメータは、クラスタ化環境においてのみ必要です。	ユニークなトランザクション ID を指定するオブジェクト。 ユニークなトランザクション ID を生成するには、次のコンストラクタを使用して新しい com.bea.wlpi.client.common.GUID オブジェクトを作成する。 GUID transactionId = new GUID(); GUID クラスの詳細については、Javadoc の com.bea.wlpi.client.common.GUID を参照。

 

このメソッドは、新しいテンプレート定義の ID を返します。

たとえば、次のコードは、orderprocessing.xml ファイルに基づき Order Processing という名の新しいテンプレート定義を作成します。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

String id = admin.createTemplateDefinition(
  template.getId(),”Order Processing”, “orderprocessing.xml”);

テンプレート ID は、com.bea.wlpi.common.TemplateInfo オブジェクトである template と関連付けられたメソッドを使用して取得されます。template オブジェクトは、テンプレートの取得に記載のメソッドを使用して取得されます。

createTemplateDefinition() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義情報の取得

ワークフロー テンプレート定義を取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public com.bea.wlpi.common.TemplateDefinitionInfo getTemplateDefinition(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

値getTemplateDefinitions() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-2 getTemplateDefinition() メソッドのパラメータ

パラメータ	説明	有効な値
templateDefinitionId	検索を行うテンプレート定義の ID	有効なテンプレート定義 ID を指定する文字列。

 

このメソッドは、com.bea.wlpi.common.TemplateDefinitionInfo オブジェクトを返します。テンプレート定義についての情報にアクセスするには、TemplateDefinitionInfo オブジェクトに記載の TemplateDefinitionInfo オブジェクト メソッドを使用します。

たとえば、次のコードでは、指定されたインスタンス ID に対応するワークフロー インスタンスに対する変数が取得されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

TemplateDefinitionInfo info =
  admin.getTemplateDefinitions(templateDefinitionID);

getTemplateDefinition() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレートの定義の取得

特定のワークフロー テンプレート定義を取得するには、以下の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public java.util.List getTemplateDefinitions(
  java.lang.String templateId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

getTemplateDefinitions() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

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

パラメータ	説明	有効な値
templateId	テンプレート定義を検索するテンプレートの ID	有効なテンプレート ID を指定する文字列。 テンプレート ID を取得するには、次の com.bea.wlpi.common.TemplateInfo メソッドを使用する。 public final java.lang.String getId() TemplateInfo オブジェクトを取得する方法については、テンプレートの取得を参照。TemplateInfo オブジェクトで選択可能なメソッドの詳細については、TemplateInfo オブジェクトを参照。

 

このメソッドは、com.bea.wlpi.common.TemplateDefinitionInfo オブジェクトのリストを返します。各テンプレートについての情報にアクセスするには、TemplateDefinitionInfo オブジェクトに記載の TemplateDefinitinoInfo オブジェクト メソッドを使用します。

たとえば、次のコードでは Order Processing テンプレートと関連するすべてのテンプレートが取得されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

List tempdefs = admin.getTemplateDefinitions(“Order Processing”);

getTemplateDefinitions() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義のコンテンツの取得

テンプレート定義のコンテンツを取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public java.lang.String getTemplateDefinitionContent(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

getTemplateDefinitionContent() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

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

パラメータ	説明	有効な値
templateDefinitionId	取得するコンテンツのテンプレート定義の ID	有効なテンプレート定義 ID を指定する文字列。 テンプレート定義 ID を取得するには、次の com.bea.wlpi.common.TemplateDefinitionInfo メソッドを使用する。 public final java.lang.String getId() TemplateDefinitionInfo オブジェクトを取得する方法については、テンプレートの定義の取得を参照。TemplateDefinitionInfo オブジェクトで選択可能なメソッドの詳細については、TemplateDefinitionInfo オブジェクトを参照。

 

このメソッドは、テンプレート定義 DTDに記載の Template Definition DTD に準拠する XML ドキュメントを返します。

たとえば、次のコードでは、指定されたテンプレート定義のコンテンツが取得されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

String content = 
  admin.getTemplateDefinitionContent(tempDef.getId());

テンプレート定義 ID は、com.bea.wlpi.common.TemplateDefinitionInfo オブジェクトである definition と関連付けられたメソッドを使用して取得されます。definition オブジェクトは、テンプレートの定義の取得に記載のメソッドを使用して取得されます。

getTemplateDefinitionContent() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義のコンテンツの設定

テンプレート定義のコンテンツを設定するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public void setTemplateDefinitionContent(
  java.lang.String templateDefinitionId,
  java.lang.String xml
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

setTemplateDefinitionContent() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-5 setTemplateDefinition() メソッドのパラメータ

パラメータ	説明	有効な値
templateDefinitionId	コンテンツを設定するテンプレート定義の ID	有効なテンプレート定義 ID を指定する文字列。 テンプレート定義 ID を取得するには、次の com.bea.wlpi.common.TemplateDefinitionInfo メソッドを使用する。 public final java.lang.String getId() TemplateDefinitionInfo オブジェクトを取得する方法については、テンプレートの定義の取得を参照。TemplateDefinitionInfo オブジェクトで選択可能なメソッドの詳細については、TemplateDefinitionInfo オブジェクトを参照。
xml	新しいテンプレート定義のコンテンツ	テンプレート定義 DTDに記載の Template Definition DTD に準拠する XML ファイル。

 

たとえば、次のコードでは、指定された XML ファイル、 new.xml を使用して、指定されたテンプレート定義のコンテンツが設定されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

admin.setTemplateDefinitionContent(tempDef.getId(), “new.xml”);

テンプレート定義 ID は、com.bea.wlpi.common.TemplateDefinitionInfo オブジェクトである definition と関連付けられたメソッドを使用して取得されます。definition オブジェクトは、テンプレートの定義の取得に記載のメソッドを使用して取得されます。

setTemplateDefinitionContent() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義オーナの取得

ワークフロー テンプレート定義の現在のオーナを取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public java.lang.String getTemplateOwner(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

getTemplates() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-6 getTemplateOwner() メソッドのパラメータ

パラメータ	説明	有効な値
templateDefinitionId	取得するオーナのテンプレート定義に対応する ID	有効なテンプレート定義 ID を指定する文字列。 テンプレート定義 ID を取得するには、次の com.bea.wlpi.common.TemplateDefinitionInfo メソッドを使用する。 public final java.lang.String getId() TemplateDefinitionInfo オブジェクトを取得する方法については、テンプレートの定義の取得を参照。TemplateDefinitionInfo オブジェクトで選択可能なメソッドの詳細については、TemplateDefinitionInfo オブジェクトを参照。

 

このメソッドは、現在のテンプレート定義オーナの ID を返します。

たとえば、次のコードはテンプレート定義オーナ ID を取得し、その結果を owner 文字列に割り当てます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

String owner = admin.getTemplateOwner(templateDef.getId());

getTemplateOwner() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

呼び出し可能なワークフローの取得

呼び出し可能なワークフローのリストを取得するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public java.util.List getCallableWorkflows(
  java.lang.String orgId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

getCallableWorkflows() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

パラメータ	説明	有効な値
orgId	呼び出し可能なワークフローの名前を取得するオーガニゼーションの ID	有効なオーガニゼーション ID を指定する文字列。 すべてのオーガニゼーション ID のリストの取得方法については、すべてのオーガニゼーション名を取得するを参照。

 

このメソッドは、呼び出し可能なワークフローのリストを返します。

たとえば、次のコードを使用すると OrgID 変数の値で指定したオーガニゼーションの呼び出し可能ワークフローのリストを取得できます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

List callablewf = admin.getCallableWorkflows(orgId);

getCallableWorkflows() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Adm を参照してください。

 

---

呼び出し可能なワークフローの検索

次の com.bea.wlpi.server.admin.Admin メソッドは、最適な（アクティブでしかも効果的な）呼び出し可能なワークフローのリストを返します。

public java.util.List findCallableWorkflows(
  java.lang.String templateName
  java.lang.String templateID
  java.lang.String orgId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

getTemplateOwner() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

パラメータ	説明	有効な値
templateName	テンプレート名。このテンプレートに対して、呼び出し可能なワークフローを検索する。	有効なテンプレート名 テンプレート名を取得するには、次の com.bea.wlpi.common.TemplateInfo メソッドを使用する。 public final java.lang.String getId() TemplateInfo オブジェクトを取得する方法については、テンプレートの取得を参照。TemplateInfo オブジェクトで選択可能なメソッドの詳細については、TemplateInfo オブジェクトを参照。
templateID	呼び出し可能なワークフローを検索するテンプレートの ID	有効なテンプレート ID を指定する文字列。 テンプレート ID を取得するには、次の com.bea.wlpi.common.TemplateInfo メソッドを使用する。 public final java.lang.String getId() TemplateInfo オブジェクトを取得する方法については、テンプレートの取得を参照。TemplateInfo オブジェクトで選択可能なメソッドの詳細については、TemplateInfo オブジェクトを参照。
orgId	オーガニゼーションのID。このオーガニゼーションを対象にして、呼び出し可能なワークフローを検索する。	有効なオーガニゼーション ID。 すべてのオーガニゼーション ID のリストの取得方法については、すべてのオーガニゼーション名を取得するを参照。

 

このメソッドは、呼び出し可能なワークフローのリストを返す。

たとえば、次のコードを使用すると、指定したテンプレートについて最適な呼び出し可能ワークフローのリストを検索できる。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

List callablewf = admin.findCallableWorkflows(templateName, templateID, orgId);

findCallableWorkflows() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義のロックおよびロック解除

不要な編集をなくすために、ワークフロー テンプレート定義に占有書き込みロックをかけることができます。テンプレート定義のロックおよびロック解除には、それぞれ以下の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public void lockTemplate(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

public void unlockTemplate(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

注意: 現在のテンプレート定義オーナを取得するには、テンプレート定義オーナの取得で説明する getTemplateOwner() メソッドを使用します。

lockTemplate() および unlockTemplate() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-7 lockTemplate() および unlockTemplate() メソッドのパラメータ

パラメータ	説明	有効な値
templateDefinitionId	ロックまたはロック解除するテンプレート定義に対応する ID	有効なテンプレート定義 ID を指定する文字列。 テンプレート定義 ID を取得するには、次の com.bea.wlpi.common.TemplateDefinitionInfo メソッドを使用する。 public final java.lang.String getId() TemplateDefinitionInfo オブジェクトを取得する方法については、テンプレートの定義の取得を参照。TemplateDefinitionInfo オブジェクトで選択可能なメソッドの詳細については、TemplateDefinitionInfo オブジェクトを参照。

 

たとえば、次のコードでは、指定されたテンプレート定義がロックされます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

admin.lockTemplate(templateDef.getId());

以下のコードは、指定されたテンプレート定義のロックを解除します。

admin.unlockTemplate(templateDef.getId());

lockTemplate() および unlockTemplate() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。

 

---

テンプレート定義の削除

テンプレート定義を削除するには、次の com.bea.wlpi.server.admin.Admin メソッドを使用します。

public void deleteTemplateDefinition(
  java.lang.String templateDefinitionId
) throws java.rmi.RemoteException, 
  com.bea.wlpi.common.WorkflowException

deleteTemplateDefinition() メソッドのパラメータを次の表に示します。パラメータには値を指定する必要があります。

表14-8 getTemplateDefinition() メソッドのパラメータ

パラメータ	説明	有効な値
templateDefinitionId	削除するテンプレート定義の ID	有効なテンプレート定義 ID を指定する文字列。 テンプレート定義 ID を取得するには、次の com.bea.wlpi.common.TemplateDefinitionInfo メソッドを使用する。 public final java.lang.String getId() TemplateDefinitionInfo オブジェクトを取得する方法については、テンプレートの定義の取得を参照。TemplateDefinitionInfo オブジェクトで選択可能なメソッドの詳細については、TemplateDefinitionInfo オブジェクトを参照。

 

たとえば、次のコードでは、指定されたテンプレート定義が削除されます。このコード例では、admin は Admin EJB への EJBObject 参照を表します。

admin.deleteTemplateDefinition(definition.getId());

テンプレート定義 ID は、com.bea.wlpi.common.TemplateDefinitionInfo オブジェクトである definition と関連付けられたメソッドを使用して取得されます。definition オブジェクトは、テンプレートの定義の取得に記載のメソッドを使用して取得されます。

deleteTemplateDefinition() メソッドの詳細については、Javadoc の com.bea.wlpi.server.admin.Admin を参照してください。