Search this site

Workflow Sample

Workflow Sample
Workflow Sample

Contact

タスクの実行

Contents

  1. 1 処理一覧
    1. 1.1 タスクの実行のためのフォーム情報の取得
    2. 1.2 タスクの実行

処理一覧

プロセス実行APIで実行可能な処理は以下のとおりです。URL中の<ContextRoot>は接続先のQuestetra BPM Suiteのコンテキストルートを代入してください。
操作 URL
タスクの実行のためのフォーム情報の取得 <ContextRoot>/API/PE/Workitem/Form/viewXml
タスクの実行 <ContextRoot>/API/PE/Workitem/Form/save

タスクの実行のためのフォーム情報の取得

タスクを実行するための、入力フォームに関する情報を取得します。ユーザ認証に失敗した場合にはHTTPレスポンスコード401(Unauthorized)を返します。

パラメータ

 パラメータ名  説明
workitemId * 実行するタスクのID

応答

例:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workitem-form xmlns:ns2="process-data-definition-detail">
	<title-accessibility>3</title-accessibility>
	<title-description>&lt;font color="red"&gt;タイトルはきちんと入力しましょう&lt;/font&gt;</title-description>
	<title-columns>1</title-columns>
	<form-data number="4" id="56213">
		<accessibility>3</accessibility>
		<data-type>12</data-type>
		<name>数値型</name>
		<data-instance-id>75774</data-instance-id>
		<process-instance-id>845</process-instance-id>
		<view-order>5</view-order>
		<ns2:decimal-detail>
			<ns2:required>false</ns2:required>
			<ns2:prefix>＄</ns2:prefix>
			<ns2:suffix>ユーロ</ns2:suffix>
			<ns2:minimum>100.00</ns2:minimum>
			<ns2:maximum>200.00</ns2:maximum>
			<ns2:operation></ns2:operation>
			<ns2:summary></ns2:summary>
			<ns2:decimal-separator>.</ns2:decimal-separator>
			<ns2:grouping-separator>,</ns2:grouping-separator>
			<ns2:ref-summary>false</ns2:ref-summary>
			<ns2:scale>10</ns2:scale>
		</ns2:decimal-detail>
		<description>値は 100.0000000000 以上 200.0000000000 以下にしてください。</description>
		<columns>1</columns>
		<required>false</required>
	</form-data>
	<node-number>0</node-number>
	<task-name>入力</task-name>
	<user-selects />
	<workitem-id>75778</workitem-id>
</workitem-form>

 要素名 / 属性名 (XPath式)
 説明
/workitem-form
応答XMLのルート要素。
以下、/workitem-form を省略。
title 文字列 件名の値。
title-accessibility 数値 件名の読み書き権限設定。
3：読み書き、1：読み込み
title-description 文字列 件名に関する説明。入力フォームに付与されるメッセージ。
title-columns 数値 件名の段組み設定。 
form-data
タイトル以外のプロセスデータ項目 
form-data/@number 数値 プロセスデータ項目の定義番号 
form-data/@id 数値 プロセスデータ項目の定義ID
form-data/accessibility 数値 プロセスデータ項目の読み書き権限設定。
3:読み書き、1:読み込み、0:なし 
form-data/data-type 数値 プロセスデータ項目のデータ型。
0:文字型、5:日付型、8:ユーザ型、9:掲示板型、10:日時型、
11:選択型、12:数値型、13:テーブル型、14:ファイル型、15:HTMLパネル
form-data/name 文字列  プロセスデータ項目の名前。
form-data/data-instance-id 数値  プロセスデータ項目のID 
form-data/process-instance-id 数値  プロセスID。
form-data/view-order 数値  プロセスデータ項目の表示順。
form-data/description 文字列  プロセスデータ項目に関する説明。入力フォームに付与されるメッセージ。 
form-data/columns 数値 プロセスデータ項目の段組み設定。 
form-data/required boolean  プロセスデータ項目が必須かどうか。 
form-data/button-direction 数値 選択型データ項目でのみ使用。チェックボックス・ラジオボタンで、ボタンを配置する方向。
1: 横、2: 縦 
form-data/button-rows 数値 選択型データ項目でのみ使用。1行または1列に配置する、ボタン数。 
form-data/items   選択型データ項目でのみ使用。選択肢の情報。
form-data/items/process-data-definition-detail:item
選択型データ項目でのみ使用。選択肢１つ１つの情報。 
form-data/items/process-data-definition-detail:item/process-data-definition-detail:value 文字列  選択型データ項目でのみ使用。選択肢の値。 
form-data/items/process-data-definition-detail:item/process-data-definition-detail:display
 文字列  選択型データ項目でのみ使用。選択肢の表示文字列。 
form-data/process-data-definition-detail:string-detail   文字型データ項目でのみ使用。
文字型に関する定義の詳細。詳細は「文字型データ項目で含まれる設定」参照。
form-data/process-data-definition-detail:decimal-detail
数値型データ項目でのみ使用。
数値型に関する定義の詳細。詳細は「数値型データ項目で含まれる設定」参照。
form-data/process-data-definition-detail:list-detail   テーブル型データ項目で使用。
テーブル型に関する定義の詳細。詳細は「テーブル型データ項目で含まれる設定」参照。 
node-number 数値 ノード番号。
task-name 文字列 タスクの名前。
swimlane-type 数値 ノーマルタスクか、チームタスクかを表す。
0:ノーマルタスク、1:チームタスク 
user-selects
ユーザ選択分岐に関する設定。
user-selects/user-select   ユーザ選択分岐の1つのボタンに相当。 
user-selects/user-select/flow-id 数値 ボタンを選択した場合にトークンがたどる、フローのID。
user-selects/user-select/name 文字列 ボタンに表示するテキスト。
executing-roles   タスク実行時の立場の選択が必要な場合の情報。
必要無い場合、唯一に特定されている場合には含まれない。
executing-roles/executing-role   選択可能な立場１つ１つを表す。 
executing-roles/executing-role/quser-id 数値 ユーザID。
タスクを実行しているユーザのIDと同じになる。 
executing-roles/executing-role/quser-name 文字列  ユーザ名。
タスクを実行しているユーザの名前と同じになる。 
executing-roles/executing-role/qgroup-id  数値 選択可能な立場、組織のID。 
executing-roles/executing-role/qgroup-name 文字列 選択可能な立場、組織の名前。 
workitem-id 数値  タスクのID。 

文字型データ項目で含まれる設定

 要素名 / 属性名 (XPath式)
 説明
process-data-definition:string-detail
文字型データ項目に関する設定。
以下、/workitem-form/form-data/process-data-definition:string-detail を省略。
required boolean 必須かどうか。
/workitem-form/form-data/required と同じ。
textarea-rows 数値 複数行タイプの場合に、何行入力フォームを表示させるかの指定。

数値型データ項目で含まれる設定

 要素名 / 属性名 (XPath式)
 説明
process-data-definition:decimal-detail
数値型データ項目に関する設定。
以下、ネームスペースprocess-data-definitionを省略。
required boolean 必須かどうか。
/workitem-form/form-data/required と同じ。
prefix 文字列 接頭辞
suffix 文字列 接尾辞
minimum 文字列 最小値
maximum 文字列 最大値
operation 文字列 テーブル型項目内の数値型項目にて使用。ここでは使用しない。
summary 文字列 テーブル型項目内の数値型項目にて使用。ここでは使用しない。
decimal-separator 文字列 小数点 
grouping-separator 文字列 桁区切り文字
ref-summary 文字列  テーブル型項目内の数値型項目の合計値を、コピーする数値型データ項目で使用。
scale 数値  小数点以下の桁数

テーブル型データ項目で含まれる設定

 要素名 / 属性名 (XPath式)
 説明
process-data-definition:list-detail
テーブル型データ項目に関する設定。
以下、ネームスペースprocess-data-definitionを省略。
sub-data-defs テーブル内のデータ項目に関する定義。
sub-data-defs/sub-data-def
テーブル内のデータ項目１つに関する定義。
sub-data-defs/sub-data-def/name 文字列 項目名。
sub-data-defs/sub-data-def/data-type 数値 データ型。0:文字型、12:数値型
sub-data-defs/sub-data-def/string-detail
文字型に関する定義の詳細。詳細は「文字型データ項目で含まれる設定」参照。
sub-data-defs/sub-data-def/decimal-detail
数値型に関する定義の詳細。詳細は「数値型データ項目で含まれる設定」参照。

タスクの実行

タスクを実行します。
ユーザ認証に失敗した場合にはHTTPレスポンスコード401(Unauthorized)を返します。
それ以外の点については、メッセージ受信中間イベントに類似しています。

パラメータ
 パラメータ名  説明
 workitemId * 実行するタスクのID
 title 件名
 プロセスデータ項目ごとのパラメータ パラメータ名や指定する値は、メッセージ開始イベント・メッセージ受信中間イベントと同じ。詳細はこちらから。
 flow フローID。
ユーザ選択分岐の場合、いずれのフローを選択するかどうか指定。フローの候補は、フォーム情報の取得APIによって取得できた、応答XMLの中の /workitem-form/user-selects 内にある。
ユーザ選択分岐でない場合、送信しなくて良い。
 saveOnly 値を保存するだけで、タスクを終了しない場合、trueを指定。
タスクを終了する場合は、falseを指定。 パラメータを指定しない場合、falseになるので、タスクは終了する。
 qgroupId 組織ID。
タスクを実行する際の立場を指定する必要がある場合に、どの立場で実行するか指定。立場の候補は、フォーム情報の取得APIによって取得できた、応答XMLの中の /workitem-form/executing-roles内にある。
指定する必要がない場合、送信しなくて良い。 

応答

失敗時の応答については、メッセージ開始イベント・メッセージ受信中間イベントに類似しています。こちらも参照してください。

 要素名 / 属性名 (XPath式)
 説明
/result
応答のルート要素。
以下 /result を省略。
@success boolean 成功時したかどうか。成功時はtrue、失敗時はfalse。
process-data-validation-errors
プロセスデータの入力チェックに失敗した場合に含まれる。
process-data-validation-errors/error
1つ1つのエラーを表す。
process-data-validation-errors/error/key 文字列 どの入力でエラーが発生したのか表す。パラメータ名に対応。
process-data-validation-errors/error/detail 文字列 エラーメッセージ。
errors   プロセスデータの入力チェック以外が原因で失敗した場合に含まれる。 
errors/error
1つ1つのエラーを表す。 
errors/error/key 文字列 エラーの種類を表すキー。 
errors/error/detail 文字列 エラーメッセージ。 

例 (成功時):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result success="true" />

例 (失敗時):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result success="false">
	<process-data-validation-errors>
		<error>
			<key>data[4].input</key>
			<detail>値は 100.0000000000 以上にしてください。</detail>
		</error>
	</process-data-validation-errors>
</result>