Worklist の使い方

ワークリスト コントロールの使用

Java コントロールは、Workshop フレームワークで管理されているサーバサイド コンポーネントです。コントロールは、ビジネス プロセスから直接呼び出し可能な Java インタフェースをエクスポーズします。つまり、コントロールは、ビジネス プロセスと他のリソース間のインタフェースです。

この節では、ビジネス ユーザとビジネス プロセスの統合をサポートするワークリストに装備されている組み込みコントロールについて説明します。内容は以下のとおりです。

ワークリスト コントロールについて

ワークリストには、TaskControl および TaskBatchControl の 2 つの Java コントロールが用意されています。JPD とこれらのワークリスト コントロールを使用すると、ヒューマン アクターと自動アクターの統合をサポートできます。自動アクターは JDP と対話し、ヒューマン アクターは Worklist User Portal と対話します。

このコントロールは、Workshop for WebLogic Platform の他の組み込みコントロールと同様に、コントロールのインスタンスをビジネス プロセスに追加して使用します。その後、ビジネス ユーザ ロジックを統合するビジネス プロセス内の箇所で、コントロールに対する操作を呼び出します。

基底のコントロールの実装で、対話の詳細の大部分を処理します。ビジネス プロセスは、Control Send ノードと Control Send with Return ノードを使用して、コントロールに対する操作を呼び出します。ビジネス プロセスは、コントロールからイベントが返されるのを待機している Control Receive ノードをブロックできます。つまり、Control Receive ノードは、コントロール コールバックによってトリガされます。ビジネス プロセスは、TaskControl または TaskBatchControl を使用してタスクを変更したり、(TaskControl を介して) ヒューマン アクターがタスクを変更するのを待機したりできます。ワークリスト コントロールは、Java 注釈によって拡張可能です。一般的な拡張には、コールバック機能の実装とシステム クエリの実行があります。

ワークリストは以下のコントロールを提供します。

これらのコントロールは、ワークリスト API リソースの構築と初期化を簡素化します。これらのコントロールは拡張可能なコントロールです。一般的なコントロール インタフェースの機能を超える、新しいメソッドを含んだ拡張インタフェースを定義できます。これらのコントロールの新しいメソッドにアノテーションを付けて、それらのメソッドにワークリストの動作を付加することができます。

TaskBaseControl

TaskControl および TaskBatchControl は、TaskControl および TaskBatchControl の両方に共通する組み込みコントロール メソッドとアノテーションを提供する TaskBaseControl から拡張されます。以下の組み込みメソッドを提供します。

TaskBaseControl では、コントロールレベルのアノテーションは使用できません。ただし、次のメソッドレベルのアノテーションを使用できます。これらのアノテーションを使用すると、コントロール拡張のメソッドに 1 つまたは複数のワークリストの動作を割り当てることができます。

TaskBaseControl のメソッドレベルのアノテーション

以下のさまざまなアノテーションがあります。

タスク コントロール

TaskControl は、ライフサイクルを通して、単一のタスク インスタンスへの低レベルのアクセスをカプセル化します。タスクのユーザ定義プロパティとシステム プロパティを設定するためのメソッドを提供し、タスクでアクションを実行します。

『Beehive Controls Development Guide』で説明しているとおり、TaskControl はプログラム イベント サービスと宣言型イベント サービスを提供します。TaskControl のコントロール拡張では、独自のイベント メソッドを定義し、アノテーションを使用してこれらのイベント メソッドにリスナ コンフィグレーション属性を付加できます。

TaskControl は TaskBaseControl を拡張したものです (したがって、そのメソッドをすべて提供します) 。TaskControl は次のメソッドも提供します。

TaskControl のメソッドレベルのアノテーション

TaskControl コントロール インタフェースは、ワークリスト API の機能を完全に置き換えるものではありません。タスクの管理ニーズを満たすために、ユーザが適切なメソッドを追加して、TaskControl の拡張を定義する必要があります。

TaskControl 拡張では、任意の数のメソッドを正式な Java 名で定義できます。ワークリストは、メソッド名に特別な意味を割り当てません。代わりに、TaskControl 拡張のメソッドに追加されたアノテーションにより、それらのメソッドに動作を付加します。特定のメソッドでは複数のアノテーションを定義できるため、1 回のメソッド呼び出しで複数の操作をタスク上で実行できます。さらに、アノテーションは、拡張のすべてのメソッドの (デフォルトまたはその他の) 動作を設定するコントロール拡張の最上位 (インタフェース宣言の前) に配置できます。

TaskControl 拡張に次のアノテーションを付けることができます。

TaskControl は、TaskBaseControl のメソッドレベルのアノテーションをすべて許可します。

TaskControl は、以下のメソッドレベルのアノテーションを追加で定義します。

TaskBatch コントロール

TaskBatchControl では、タスク インスタンスのバッチへの低レベルのアクセスをカプセル化します。イベント サービスは提供しません (イベント サービスには、TaskControl を使用する必要があります)。TaskBatchControl のコントロール拡張のメソッドでは、メソッドが動作するバッチ、つまりタスク インスタンスのグループを定義する、カスタムのタスク セレクタを定義できます。

TaskBatchControl は TaskBaseControl の拡張であるため、TaskBaseControl のすべてのシステム メソッドを提供します。追加のシステム メソッドを定義するものではありません。

TaskBatchControl のコントロールレベルのアノテーション

TaskBatchControl は select コントロールレベルのアノテーションをサポートします。コントロール拡張で、メソッドのデフォルト セレクタとして動作します。

TaskBatchControl のメソッドレベルのアノテーション

TaskBatchControl は、以下のメソッドレベルのアノテーションをサポートします。

パラメータ値とアノテーション値の結合

一部のアノテーションは、アノテーション内でパラメータ markers をサポートするため、実行時にメソッドの呼び出しに指定されているパラメータ値で置換できます。これにより、動的データをアノテーションの静的データに結合できます。

実行時のパラメータ マーカをサポートするアノテーションは、@SupportsParameters アノテーションでマークされます。

public @interface @SupportsParameters {

    String markerBegin() default "{";

    String markerEnd() default "}";

}

String 型のすべてのアノテーション フィールドに @SupportsParameters アノテーションを付けることができます。アノテーションの文字列値のアンエスケープ パラメータ マーカは置き換え可能なパラメータとして解釈されます。以下に例を示します。

public @interface TestAnno {

    @SupportsParameters

    String hasParams();

    String noParams();

}

および

public interface MyTest {

    @TestAnno(hasParams="Param1 has value {param1} and param2 = {param2}")

    public void testHasParams(int param1, String param2);

    @TestAnno(noParams="Param1 has value {param1} and param2 = {param2}")

    public void testNoParams(int param1, String param2);

}

この場合、param1=1 と param2="Two" を持つ testHasParams を呼び出すことで、次の hasParams の有効な実行時の値が生成されます。

Param1 has value 1 and param2 = Two

一方、param1=1 および param2="Two" を持つ noParams を呼び出すことで、次の noParams の有効な実行時の値が生成されます。

Param1 has value {param1} and param2 = {param2}

ワークリスト コントロールの作成

タスク コントロールとタスク バッチ コントロールを作成して、ビジネス プロセスで使用することができます。

タスク コントロールの作成

タスク コントロールを作成するには、次のいずれかの方法を使用します。

[ウィザードを選択] ダイアログを使用したタスク コントロールの作成

タスク インスタンスの作成をトリガするタスク コントロールを作成するには、以下の手順を実行します。

選択したタスク プランに基づいてタスク コントロールが作成されます。[パッケージ・エクスプローラー] ビューに <タスク コントロール名>.java ファイルが表示されます。

プロセス パースペクティブのデータ パレットを使用したタスク コントロールの作成

タスク コントロールを作成するには、以下の手順を実行します。

選択したタスク プランに基づいてタスク コントロールが作成されます。[パッケージ・エクスプローラー] ビューに <タスク コントロール名>.java ファイルが表示されます。[データ パレット] ビューにも新しいコントロールが表示されます。

タスク バッチ コントロールの作成

タスク バッチ コントロールを作成するには、次のいずれかの方法を使用します。

[ウィザードを選択] ダイアログを使用したタスク バッチ コントロールの作成

タスク バッチ コントロールを作成するには、以下の手順を実行します。

タスク バッチ コントロールが作成されます。[パッケージ・エクスプローラー] ビューに <タスク バッチ コントロール名>.java ファイルが表示されます。

プロセス パースペクティブのデータ パレットを使用したタスク バッチ コントロールの作成

タスク バッチ コントロールを作成するには、以下の手順を実行します。

選択したタスク プランに基づいてタスク バッチ コントロールが作成されます。[パッケージ・エクスプローラー] ビューに <タスク コントロール名>.java ファイルが表示されます。[データ パレット] ビューにも新しいコントロールが表示されます。

タスク コントロール ジェネレータを使用したワークリスト コントロールの作成

タスク コントロール ジェネレータ TaskControlGenTask を使用すると、タスク プランに Apache Beehive コントロールを作成できます。生成されたコントロールでは TaskControl を使用します。必要に応じて、開発者は生成されたコントロールのアノテーションを変更できます。

カスタム コントロールの一般的な情報については、Workshop for WebLogic Platform プログラマーズ ガイドの「カスタム コントロールの開発」を参照してください。

生成されたコントロールによって、タスク プランに定義されたコンストラクタ、手順、およびアクションが考慮されます。コントロールには、タスクの作成、タスクでのアクションの実行、タスク上のイベントへの応答、およびタスクに関するシステム プロパティ情報とユーザ定義プロパティ情報の取得と設定を行うための適切なメソッドが含まれます。

次の内容が確実に含まれるように、コントロール インタフェースを設計します。

タスク コントロール ジェネレータの実行

タスク コントロール ジェネレータは次の方法で実行できます。

Java クライアントまたはコマンド ラインからのタスク コントロール ジェネレータの実行

Java クラス名は WL_HOME/integration/lib/worklist-client.jar ファイルの com.bea.wli.worklist.build.TaskControlGen です。

コマンドラインの Java クライアントからジェネレータを実行するには、次のように入力します。

java com.bea.wli.worklist.build.TaskControlGen <options>

次の表にオプションを示します。

Ant からのタスク コントロール ジェネレータの実行

Ant のタスク クラス名は WL_HOME/integration/lib/worklist-client.jar ファイルの com.bea.wli.worklist.build.TaskControlGenTask です。

次の Ant スクリプトで TaskControlGenTask の使用方法について説明します。

<!-- 最初のプロパティを設定します -->

<property environment="env"/>

<property name="wl.home" value="${env.WL_HOME}"/> 

<property name="worklist-client.jar"

location="${wl.home}/integration/lib/worklist-client.jar"/>

<property name="build.dir" value="<some dir to hold build output>"/>

<!-- Ant にタスクを定義します -->

<taskdef name="task-control-gen"

classname="com.bea.wli.worklist.build.TaskControlGenTask"

classpath="${worklist-client.jar}"/>

<!-- コントロール ソース ファイルを構築する場所を指定してください -->

<mkdir dir="${build.dir}/controlsrc"/>

<task-control-gen

taskPlanFile="<see command-line section -taskPlan arg>"

outputDir="${build.dir}/controlsrc"

hostAppRootDir="<see command-line section -hostAppRootDir arg>"

packageName="<see command-line section -packageName arg">

interfaceName="<see command-line section -interfaceName arg">

<classpath>

<!-- TaskControlGen が必要なクラスを参照できるよう、これを追加してください。独自のクラスも追加できます (必要に応じて XMLBean クラスなど) -->

<pathelement location="${worklist-client.jar}"/>

</classpath>

</task-control-gen>

タスク コントロールおよびタスク バッチ コントロールの手動作成

タスク コントロール ジェネレータ ウィザードとワークリスト コントロール ウィザードは、ユーザが一般に必要とする方法で、[ワークリスト コントロールの作成] へのショートカットとして表示する必要があります。ただし、必要に応じて、TaskControl 拡張および TaskBatchControl 拡張を手動で作成できます。これらの拡張の要件は、これらの拡張が TaskControl または TaskBatchControl の拡張であり、インタフェース レベルで @ControlExtension でマークされていることだけです。

これらのコントロール拡張に任意の数のメソッドを追加し、特定のタイプのコントロールでサポートされているアノテーションを使用してマーク付けできます。以下のような場合には、カスタムのコントロール拡張を作成するのが適切です。

これらのいずれの場合でも、ワークリスト ツールでコントロールの生成を開始し、必要に応じてコントロール インタフェースを手動で更新できます。

ビジネス プロセスでのタスク コントロールおよびタスク バッチ コントロールの使用

この節では、ビジネス プロセス ファイル (JPD) とワークリスト コントロールを使用して、ヒューマン アクターと自動アクターの統合をサポートする方法について説明します。自動アクターは JPD と対話し、ヒューマン アクターは Worklist User Portal と対話します。

このコントロールは、Workshop for WebLogic Platform の他の組み込みコントロールと同様に、コントロールのインスタンスをビジネス プロセスに追加して使用します。その後、ビジネス ユーザ ロジックを統合するビジネス プロセス内の箇所で、コントロールに対する操作を呼び出します。

タスク コントロールまたはタスク バッチ コントロールとビジネス プロセス間の対話を設計するには、ビジネス ロジックをサポートするためにビジネス プロセスから呼び出す、コントロールのメソッドを決める必要があります。

WebLogic Workshop の他のコントロールとビジネス プロセスの間の対話を設計するのと同じ方法で、ワークリスト コントロール メソッドをビジネス プロセスの適切なコントロール ノード (Control Send、Control Receive、および Control Send with Return) にバインドできます。その場合、データ パレットのコントロール メソッドを、デザイン ビュー上でロジックを設計するビジネス プロセス内の箇所までドラッグ アンド ドロップするだけでバインドできます。タスク コントロールまたはタスク バッチ コントロールのインスタンスを作成したら、ビジネス プロセスからメソッドを呼び出してタスク インスタンスを操作できます。ビジネス プロセスでは、タスク インスタンスからコールバックを受け取るのを待つこともできます。タスク コントロールおよびタスク バッチ コントロールを拡張すると、カスタマイズしたメソッドとコールバックを追加できます。

JPD のタスク コントロールまたはタスク バッチ コントロールを使用して、タスク インスタンスを作成できます。このプロセスで、ビジネス プロセス ファイル、およびタスク コントロールまたはタスク バッチ コントロールを作成し、プロセスをデプロイする必要があります。必要に応じて、サンプル タスクを作成して、タスク インスタンスの作成を検証できます。

以下の方法で、ビジネス プロセスでワークリスト コントロールを使用できます。

ビジネス プロセスの作成

ワークリスト コントロールを使用するビジネス プロセスを作成するには、以下の手順を実行します。

ビジネス プロセスからのタスク プラン コンストラクタの呼び出し

ビジネス プロセスにタスク インスタンス作成コンストラクタを呼び出すには、以下の手順を実行します。

ビジネス プロセスのデプロイおよび検証

ビジネス プロセスをデプロイおよび検証するには、以下の手順を実行します。

[担当タスク] ポートレット ボックスに、コントロールを使用して JPD で作成されたタスク インスタンスが表示されます。