ワークフローオブジェクトとプロパティ

ドキュメントのダウンロード

サイトマップ

用語集

検索

e-docs > WebLogic Integration > BPM トピック > BPM ユーザーズガイド > ワークフローオブジェクトとプロパティ

BPM ユーザーズガイド

ワークフローオブジェクトとプロパティ

注意: Worklist クライアントアプリケーションは WebLogic Integration リリース 7.0 より非推奨となりました。代替機能に関する詳細については、『WebLogic Integration リリースノート』を参照してください。

この節では、Order Processing Trigger ワークフローを説明しながらチュートリアルを進めます。ワークフローの概要を説明した後にワークフローのオブジェクトを詳しく調べて、以下の項目について理解を深めます。

テンプレート定義プロパティ
変数のプロパティ
開始ノードのプロパティ
タスクノードのプロパティ
ワークフローの式

最後に、Studio のいくつかの機能を使って慣れるために、以下を実行します。

ポストする XML ドキュメントの編集
リポジトリへの XML ドキュメントのエクスポート
テンプレート定義の保存

チュートリアルのこの節では、以下の手順が完了しているものとします。

WebLogic Integration Studio の起動の説明に従って、Studio にログオンしていること。
ワークフローオブジェクトのインポート : チュートリアルパッケージファイルのインポートとワークフローの表示 : Order Processing Trigger のテンプレート定義の表示の説明に従って、Order Processing Trigger のテンプレート定義をインポートして開いていること。

Order Processing Trigger ワークフロー

Order Processing Trigger ワークフローは、Order Processing ワークフローを通常トリガするプロセスをシミュレートします。実際のアプリケーションでは、多くの場合、これは XML ドキュメントを JMS キューに送信するサーブレットによって実行されます。次の図に示すように、XML メッセージがキューに着信することにより Order Processing ワークフローの開始がトリガされます。

図3-1 Order Processing 開始のシミュレーション

このチュートリアルでは、Worklist ユーザに XML ドキュメントをポストするプロセスを開始させて、このプロセスをシミュレートします。Order Processing Trigger ワークフローの詳細を次の図に示します。図で番号が振られている手順については、図の下の表で説明します。この図は、実際のプロセスと実装を、サンプルワークフロー内の実際の実装にマップしています。

図3-2 Order Processing Trigger ワークフロー : 詳細表示

表3-1 Order Processing Trigger ワークフローの概要

プロセス	実装
顧客が CDExpress という音楽メディア小売店にブラウザベースの発注フォームなどのオンラインメカニズムを使用して商品を発注します。その顧客は、氏名、連絡用 E メールアドレス、出荷先の国または州名、希望商品（ID および商品）、発注数量を指定します。実際のアプリケーションでは、ワークフローに渡される外部 JMS キューに対して XML ドキュメントを転送するサーブレットにより受注が処理される。	1. 開始ノードが手動に設定されているので、ワークフローは Worklist ユーザによって開始される。
2. 最初のタスクは、ワークフローを開始する Worklist ユーザに割り当てられる。タスクが実行されると、<neworder> XML ドキュメントが内部 JMS キューにポストされる。XML ドキュメントには、受注のステータス、受注 ID、顧客 ID、顧客名、E メール、住所、電話番号、国名、商品名、数量が含まれる。

プロセス

実装

顧客が CDExpress という音楽メディア小売店にブラウザベースの発注フォームなどのオンラインメカニズムを使用して商品を発注します。その顧客は、氏名、連絡用 E メールアドレス、出荷先の国または州名、希望商品（ID および商品）、発注数量を指定します。

実際のアプリケーションでは、ワークフローに渡される外部 JMS キューに対して XML ドキュメントを転送するサーブレットにより受注が処理される。

1. 開始ノードが手動に設定されているので、ワークフローは Worklist ユーザによって開始される。

2. 最初のタスクは、ワークフローを開始する Worklist ユーザに割り当てられる。タスクが実行されると、<neworder> XML ドキュメントが内部 JMS キューにポストされる。XML ドキュメントには、受注のステータス、受注 ID、顧客 ID、顧客名、E メール、住所、電話番号、国名、商品名、数量が含まれる。

注意: このワークフローには完了ノードがありません。つまり、このワークフローは無限に繰り返されることを意味します。後ほどチュートリアルで説明するように、ワークフローを実行する場合、このメカニズムを使用すると、Worklist アプリケーションのタスク一覧ウィンドウ内からワークフローを開始できるようになります。

テンプレート定義のプロパティ

Order Processing Trigger テンプレート定義を開いた状態でテンプレート定義のプロパティを表示するには、フォルダツリーか、[ワークフロー設計] ウィンドウ内の任意の場所を右クリックし、表示されるポップアップメニューから [プロパティ] を選択します。[テンプレート定義 Order Processing Trigger] ダイアログボックスが表示されます。

図3-3 [テンプレート定義 Order Processing Trigger] ダイアログボックス

複数のテンプレート定義で同じ有効開始日付と終了日付を指定できますが、アクティブな定義にはそれぞれユニークな日付または時刻を指定する必要があります。実行時において、あるワークフローに複数のテンプレート定義が存在する場合、処理エンジンは、その有効開始日時/終了日時を基に現在に最も近いアクティブなテンプレート定義を選択します。

この Order Processing Trigger テンプレート定義をインポートプロセス中にアクティブ化したため、ダイアログボックスでは、すでにアクティブ化された状態で表示されます。この図のテンプレート定義のワークフローは、2001 年 5 月 2 日から有効であり、使用期限は指定されていません。

このワークフローにはラベルを使用していません。

変数プロパティ : OrderID 変数の表示

変数プロパティを表示するには、フォルダツリーに移動し、[変数] フォルダの下の OrderID 変数をダブルクリックします。[変数プロパティ] ダイアログボックスが表示されます。

図3-4 OrderID 変数 : [変数プロパティ] ダイアログボックス

変数は、ほかのテンプレート定義、XML ドキュメント、EJB および Java クラスメソッドにパラメータとして渡すことができます。入力パラメータは、変数がその値を呼出し側、つまり親ワークフローから受け取ることを示します。出力パラメータは、呼び出し元のワークフローに返された値を変数が持つことを示します。

Order Processing Trigger テンプレートでは、OrderID 変数には入力パラメータまたは出力パラメータのマークが付いていません。図3-4 を参照してください。後で説明しますが、Order Processing と Order Fulfillment ワークフローテンプレートでは、変数にはほかのワークフローから渡されたことを示す input パラメータのマークが付いています。OrderID 変数は、ワークフローの各インスタンスで受注番号のトラッキングに使用されるため、Order Processing ワークフローと Order Fulfillment ワークフローの両方に渡されます。

変数はスコープ内でグローバルです。つまりワークフロー全体に適用されます。現在のワークフローで変数が使用されているノードやアクションの概要を表示することができます。

OrderID 変数の使い方を表示するには、フォルダツリーに移動し、[変数] フォルダの下の OrderID 変数を右クリックして表示されるポップアップメニューから [使用] を選択します。[変数の使用場所] ウィンドウが表示されます。

図3-5 OrderID 変数 : [変数の使用場所] ウィンドウ

上の図に示されているように、OrderID 変数は、Start Order Processing タスクのワークフロー変数を設定というアクションで使用されています。このアクションについては、ワークフローの式 : ワークフロー変数を設定とユーザにタスクを割り当てアクションの表示で詳しく説明します。

変数は、ワークフローラベルの追加とワークフローのノードの定義全体を通して作成します。

開始ノードのプロパティ

Order Processing Trigger には開始ノードが 1 つしかないため、開始ノードにはノード名がありません。ただし、複数の開始ノードを含むワークフローを定義し、並列実行する複数の処理パスを規定することも可能です。また、開始ノードを使用して、任意のワークフロー変数を初期化することもできます。

開始ノードのプロパティを表示するには、[ワークフロー設計] ウィンドウに移動して [開始] ノードをダブルクリックします。[開始のプロパティ] ダイアログボックスが表示されます。

図3-6 [開始のプロパティ] ダイアログボックス

ダイアログボックスに表示されるように、ワークフローの開始方法には、以下の 4 種類があります。

時限－ワークフローは、指定日の指定時刻に自動的に開始します。このチュートリアルではタイマーでの開始は使用しません。
手動－ワークフローは Worklist ユーザが開始します。Order Processing Trigger ワークフローを手動による開始に定義し、チュートリアルサンプル全体を起動できるようにします。
呼び出し－ワークフローが別のワークフローに呼び出されます。サンプルの Order Fulfillment ワークフローは、呼び出しによって開始します。
イベント－ワークフローは XML ドキュメントの JMS キューの着信によってトリガされます。Order Processing ワークフローのイベントトリガ開始ノードをワークフローのノードの定義で作成し、その節の後半で、このワークフローのトリガとして動作する XML ドキュメントを使用します。

更に、この開始ノード内では、ワークフロー実行のたびに加算される OrderID 変数が初期化され、0 (ゼロ) になります。この変数の詳細は、変数プロパティ : OrderID 変数の表示を参照してください。

タスクノードのプロパティ : Start Order Processing タスクノードの表示

タスクノードのプロパティを表示するには、[ワークフロー設計] ウィンドウに移動して Start Order Processing タスクノードをダブルクリックします。[タスクのプロパティ] ダイアログボックスが表示されます。

図3-7 Start Order Processing タスク : [タスクのプロパティ] ダイアログボックス

[次] タブの下で、このタスクのサクセサがそのタスク自身であり（[ワークフロー設計] ウィンドウ内でループ矢印によって指示）、リスト内に [完了] ノードはありません。つまり、ワークフローは実際には終了することがなく、Start Order Processing タスクが実行されるたびに、このタスク自身の別のインスタンスを作成します。サンプルワークフローの実行とモニタでは、ワークフローを実行する時にこのプロセスが動作する様子を示します。

タスクの状態とアクション

ダイアログボックスの左側のタブは、実行時の各状態を示します。所定のタスクに対して状態を指定するタブに割り当てられたアクションは、指定の状態になったときに実行されます。以下の 4 種類の状態があります。

作成時－このタブ内に含まれるアクションは、ワークフローの開始直後に実行されます。
アクティブ時－フローがこの特定のタスクに到達した場合に、ここにリストされたアクションが実行されます。一般的には、自動起動するアクションのすべてをこのタブの下に指定します。
実行時－ここに含まれるアクションは、あるアクションが Worklist 内で手動で実行された場合、または実行タスクの API でプログラムにより実行された場合、あるいは Execute Task アクションを使用して実行された場合、のいずれかの方法で実行された場合のみ実行されます。これ以外の場合は、[実行時] タブに指定されたアクションは実行されません。
完了マーク－タスクを、タスクに完了マークを付けるアクションまたは対応する API が、完了とマークします。通常、このタブは、タスクに完了マークを付けるアクションがそのタスク内に指定されてはいませんが、フロー内のほかのノードによって指定されている場合に使用されます。一般に、監査情報をログに書き込むなどのクリーンアップアクションの指定に使用されます。

タスクの状態の詳細は、『WebLogic Integration Studio ユーザーズガイド』の「ワークフローテンプレートの定義」の中の「タスクプロパティの定義」を参照してください。

アクションは、次のようなカテゴリにグループ化されます。

タスク アクション－特定のタスクの動作を指定
ワークフロー アクション－ワークフロー全体の動作を指定
統合アクション－外部コンポーネントに対するインタフェースの起動
例外処理 アクション－カスタム例外ハンドラを呼び出し
その他の アクション－ E メールの送信や監査エントリの作成など、その他の動作

[タスクのプロパティ] ダイアログボックス (またはフォルダツリー) の表示で分かるように、ワークフロー変数を設定タスクには以下のアクションが含まれています。

アクティブ時
- ワークフロー変数を設定－ワークフローの OrderID 変数を設定するワークフロー アクションです。詳細については、ワークフローの式 : ワークフロー変数を設定とユーザにタスクを割り当てアクションの表示を参照してください。
- ユーザにタスクを割り当て－手動タスクをワークフローのユーザに割り当てるタスク アクションです。詳細については、ワークフローの式 : ワークフロー変数を設定とユーザにタスクを割り当てアクションの表示を参照してください。
実行時
- Post initial XML event － Order Processing ワークフローで使用される XML メッセージをパブリッシュする統合アクション。詳細については、内部 XML イベントのポスティング : Neworder XML ドキュメントの編集を参照してください。
- タスクに完了マークを付ける－次のノードにフローの進行を許可するタスク アクションです。すべてのタスクノードに対して、フローの進行を指示するこのアクションを指定する必要があります。

ワークフローのノードの定義で、アクションの定義方法を詳しく説明します。

タスクパーミッションについて

最後に、[パーミッション] タブを使用すると、Worklist ユーザがこのタスクに対して実行できるアクションのタイプを設定できます。デフォルトでは何も設定されません。このシナリオ用のデフォルト設定を、次の図に示します。

図3-8 Start Order Processing タスク : [パーミッション] タブ

タスクパーミッションの詳細は、WebLogic Integration Studio ユーザーズガイドの「ワークフローテンプレートの定義」の「タスクパーミッションの定義」と、『WebLogic Integration Worklist ユーザーズガイド』の「タスクの処理」を参照してください。

ワークフローの式 : ワークフロー変数を設定とユーザにタスクを割り当てアクションの表示

[タスクのプロパティ] ダイアログボックスの [アクション] リストの下にあるスクロールバーを使用して、[アクティブ時] タブ内の全アクション定義を表示します。アクション定義を以下に示します。

ワークフロー変数 "OrderID"を式に設定します。$OrderID + 1
"Start Order Processing"タスクをユーザ WorkflowAttribute ("Initiator") に割り当てます。

これらのアクションの定義の詳細を表示するには、各アクションをダブルクリックします。各アクションのプロパティのダイアログボックスが表示されます。

図3-9 [ワークフロー変数を設定] ダイアログボックス

図3-10 [ユーザにタスクを割り当て] ダイアログボックス

図に示すように、この 2 つのアクションは式を使用して定義します。ノードをワークフローの基本単位、アクションをノードの基本単位と考えれば、式はアクションの基本単位と考えることができます。式とは、値の計算と入力を行うために実行時に評価される文です。式には、変数、定数、リテラル、演算子、定義済み関数を組み合わせることができます。ユーザが定義する最も一般的なタイプの式では、XML ドキュメントから値を抽出する XPath 関数を使用します。

ユーザが知っておく必要のあるワークフロー式の言語の基本的なルールを以下に示します。

文字列リテラルはクォーテーション (" ") で囲みます。
変数名には、ドル記号 ($) またはコロン (:) を前に付けます。
異なる要素のタイプを、プラス記号 (+) 演算子で連結できます。

このように、最初のアクションの式では、OrderID 変数の値に対しワークフローの実行のたびに 1 が加算されるように指定します。サンプルワークフローの実行とモニタでは、ワークフロー実行時のアクション内でこのプロセスを確認します。

2 番目のアクションの式は、組み込み関数を使用して Start Order Processing タスクが、ワークフローを開始する Worklist ユーザに割り当てられるように指定します。

ワークフローのノードの定義で、Expression Builder と XPath Wizard を使用して式を作成します。

ワークフロー式の言語と関数の詳細は、『WebLogic Integration Studio ユーザーズガイド』の「ワークフロー式の使い方」を参照してください。

内部 XML イベントのポスティング : Neworder XML ドキュメントの編集

XMLイベントをポストアクションを表示する手順は次のとおりです。

[Start Order Processing タスクプロパティ] ダイアログボックスで、[実行時] タブを選択します。
XMLイベントをポストアクションを選択し、[更新] をクリックします。定義済みの XML ドキュメントが表示されている [XMLイベントをポスト] ダイアログボックスが表示されます。
図3-11 [XMLイベントをポスト] ダイアログボックス

XML イベントをポストする場合、以下のようにさまざまなオプションを指定できます。

Destination －内部 JMS キュー、外部 JMS トピックまたはキュー。デフォルトのポスト先は内部キューです。
Transaction Mode －トランザクションのコミット時、または直ちにメッセージを送信します。デフォルトのトランザクションモードは、トランザクションのコミット時です。
XML Message － XML 変数内に格納されたドキュメント、またはアクションのダイアログボックスで、XML エディタだけを使用して作成したドキュメント。デフォルトの設定は、新規ドキュメントの作成です。

このサンプルでは、デフォルトの設定を使用します。プロダクション環境によっては、種々の JMS メッセージや XML イベントのポスト用のオプションの利用をお勧めします。XMLイベントをポストアクションのオプション全体の詳細は、『WebLogic Integration Studio ユーザーズガイド』の「アクションの定義」の「JMS トピックまたはキューに対する XML メッセージのポスト」を参照してください。

XML ドキュメントの構造を編集する

このアクションによってポストされる XML ドキュメントは、サーブレットによってワークフローに送信される XML ドキュメントをシミュレートします。このドキュメントには、受注に関する情報が含まれ、以下に示すような構造となっています。

コードリスト 3-1 Neworder XML ドキュメント

<neworder>
   <id>$OrderID</id>
   <shiptostate>KK</shiptostate>
   <status>new</status>
   <customer>
       <id>6831</id>
       <name>John Doe</name>
       <address>3126 Blue Street Anytown CA 96822</address>
       <phone>408 534 9567</phone>
       <email>jdoe@bea.com</email>
   </customer>
   <item>
       <id>236</id>
       <name>CD storage rack</name>
	<quantity>2</quantity>
   </item>
</neworder>

この XML ドキュメント内の各要素の値は、Order Processing ワークフローの開始ノードによって抽出され、ワークフローの各変数内に格納されます。これらの値は、Order Processing ワークフローと Order Fulfillment ワークフロー全体を通して使用されます。変数、ワークフロー内での変数の使用法、対応する XML 要素などについて、その使用方法を、次の表で説明します。

表3-2 Neworder の XML 要素

XML 要素	対応するワークフロー変数	ワークフローにおける使用法
<status>	OrderStatus	ワークフローのさまざまなポイントで変更できる。
<id>	OrderID	ワークフローから値を受け取り、Worklist 内ではワークフローラベルとなってワークフローが実行されるたびに加算される。
<shiptostate>	ShipToState	POBean の calculate() メソッドに渡される。初期値は例外ハンドラによって捕らえられる。
<customer> <id>	CustomerID	信用チェックタスクに使用される。
<customer> <name>	CustomerName	カスタマ通知タスクに使用され、さらに出荷タスク用に Order Fulfillment ワークフローに渡される。
<customer> <address>	CustomerAddress	出荷タスク用に Order Fulfillment ワークフローに渡される。
<customer> <phone>	CustomerPhone	カスタマ通知タスクで使用される。
<customer> <email>	CustomerEmail	受注確認タスクで使用される場合がある。
<item> <id>	ItemID	checkInventory() メソッドと calculate() メソッドに渡される。
<item> <name>	ItemName	使用されない。
<item> <quantity>	ItemQuantity	checkInventory() メソッドと calculate() メソッドに渡される。

各要素には、デフォルト値が入力されています。 <shiptostate> 要素に、誤った国名の省略形 KK が入力されています。これは無効なデータが Order Fulfillment ワークフローの POBean EJB に渡される場合をシミュレートして、カスタマ例外ハンドラを呼び出するためです (詳細は、カスタム例外ハンドラの使い方を参照してください)。

電子メールメッセージの送信 : Confirm Order Fulfillment タスクの定義で、電子メールを送信するアクションを定義します。アクションの定義をする場合、メールアドレスにはこの XMLイベントをポストアクションによって送信された XML ドキュメント内の値を使用します。サンプルワークフローの実行とモニタでワークフローを実行する際に、プロセスの最後に受注の確認用に送信される E メールを受信したい場合には、XML ドキュメントを編集して、実際に使用しているユーザのアドレスを指定できます。

注意: このプロシージャが実行時に動作するようにするには、ユーザの E メールサーバを、ユーザのサーバドメインに適切にコンフィグレーションする必要があります。詳細については、『WebLogic Integration の起動、停止およびカスタマイズ』の「WebLogic Integration のカスタマイズ」の「メールセッションプロパティのカスタマイズ」を参照してください。

ユーザ自身のデータを指定するには、XML ドキュメントを次の手順で編集します。

[XMLイベントをポスト] ダイアログボックスの [XML ドキュメント構造] 領域内で、Element ノードを展開してその値を表示します。スクロールバーを使用してほかのフィールドを表示します。
図3-12 Neworder XML ドキュメントの構造
顧客の [e-mail] 要素値フィールドに、ユーザのメールアドレスをクォーテーションマークで囲んで入力します。〔Enter〕を押して値を入力します。

注意: 電子メールメッセージの送信 : Confirm Order Fulfillment タスクの定義で電子メールメッセージを送信アクションを指定する場合は、必ず有効なメールアドレスを入力してください。
また、ほかの [customer] の値と [item] の属性値を編集し、そこにユーザ独自の情報も入力できます。

注意: [shiptostate] 要素値フィールドの間違っているデータは編集しないでください。この値は、実行時に Order Fulfillment ワークフローで例外ハンドラを呼び出すために使用します。
完了したら、[OK] をクリックして変更を保存し、[XMLイベントをポスト] ダイアログボックスを終了します。

XML リポジトリの使い方 : Neworder XML ドキュメントのエクスポート

Studio で XML ドキュメントの作成や編集を行った場合、その結果をディスク上のファイルに保存するか、XML リポジトリにエクスポートできます。リポジトリは、XML ドキュメント、DTD、スキーマ、スタイルシート、ほかのエンティティをその後のアクセスに備えて格納し、他のノードやワークフローまたはオーガニゼーションで再利用するために定義済みの XML ドキュメントをエクスポートまたはインポートする便利な方法を説明します。

Order Processing ワークフローは、Start Order Processing タスクの XML ドキュメントに格納されているデータを参照する XML ドキュメントをリポジトリに格納することによって、XPath 文を定義するの、ドキュメントからデータを抽出するための XPath 式の定義タスクを簡素化します。

ドキュメントをリポジトリへ保存する手順は次のとおりです。