2.1.1 BPMN連携機能を使用する場合のciwchgapwork
形式
-
形式1(作業(タイマーイベントの作業を除く)の一覧を表示する場合)
ciwchgapwork -sid <system_id> -list {-ope|-msg|-err} [-ref <ref_identifier>] [-bpn <process_definition_name> [-bpv <process_definition_version>]] [-s <work_item_state>]
-
形式2(タイマーイベントの作業の一覧を表示する場合)
ciwchgapwork -sid <system_id> -list -tim [-bpn <process_definition_name> [-bpv <process_definition_version>]] [-s <work_item_state>]
-
形式3(作業の状態を変更する場合)
ciwchgapwork -sid <system_id> -chg -f <input_file> -s <work_item_state>
-
形式4(オプションファイルを指定して実行する場合)※
ciwchgapwork -file <option_file_name> [-encoding <character_set>]
-
形式5(コマンドの形式を表示する場合)※
ciwchgapwork -h
- 注※
-
すべてのコマンドで同じ形式で指定します。詳細は,「1.5 コマンド共通のオプション」を参照してください。
機能
アプリケーション呼び出しサービスの呼び出し対象となる作業の一覧を取得します。また,一覧取得した情報を基に作業の状態を変更します。
- 作業状態変更用入力ファイルフォーマット
-
作業の状態を変更する場合(形式3)の入力用ファイルのフォーマットを次に示します。
<案件ID>,<作業ID>
表2‒1 入力用ファイルの項目 項番
項目名
説明
1
案件ID
状態を変更させる作業が所属する案件のID
2
作業ID
状態を変更させる作業のID
- データの区切り文字には,「,」(半角コンマ)を指定します。
- <作業ID>の後ろに区切り文字がない場合,行末までの値が<作業ID>として扱われます。
- <案件ID>,および<作業ID>に0~2,147,483,647以外の整数を指定した場合,エラーになります。
- <案件ID>,および<作業ID>を指定していない場合,エラーになります。
- <作業ID>から後ろの項目は読み込まれません。
- <案件ID>と<作業ID>の前後に半角スペース,タブ文字が含まれていた場合は,それらを取り除いた値として扱われます。
- 次の行はコメント行として扱われるため,読み込まれません。
- 「#」から始まる行
- 「KDIW」から始まる行
- 改行だけの行
- SQLを実行して入力用ファイルを作成する方法
-
入力用ファイルは,「作業状態変更用入力ファイルフォーマット」に従った内容であれば,コマンド以外の方法で作成したファイルが利用できます。SQLを利用して,ワーク管理データベースの情報から入力用ファイルを作成できます。
SQLを利用したファイル作成の実行例および実行結果例を次に示します。この例では,「作業者実行」状態の作業を入力用ファイルのフォーマットで出力しています。
実行例
SELECT PROCESSINSTANCEID ||','|| ID from <SYSTEMID>_WORK_ITEM WHERE STATECODE = 'f';
実行結果例
27,212 (改行) 28,214 (改行) 76,390 (改行) 5003,10003 (改行)
出力結果に,コンマ以外の区切り文字や,囲み文字が出力されないようにしてください。
実行条件
このコマンドを実行できるコンポーネントの稼働状態を次に示します。
コンポーネント |
稼働状態 |
|
---|---|---|
起動中 |
停止中 |
|
CSCIWManagementServer |
○ |
○ |
案件運用操作 |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(J2EEアプリケーション) |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(Javaアプリケーション) |
○ |
○ |
アプリケーション呼び出しサービス |
○ |
○ |
RESTサービス |
○ |
○ |
運用管理RESTサービス |
○ |
○ |
同一マシンでの他のコマンド |
× |
○ |
異なるマシンでの同一コマンド |
× |
○ |
異なるマシンでの他のコマンド |
× |
○ |
DBMS |
○ |
× |
- (凡例)
-
○:コマンドを実行できます。
×:コマンドを実行できません。
引数
- -sid <system_id>
-
システムIDを指定します。指定したシステムIDに対応する作業の一覧取得と状態変更をします。
- -list
-
指定された条件の作業の一覧を標準出力に表示する場合に指定します。
作業の一覧の表示フォーマットを次に示します。
#PIID,WIID,TYPE,REFID,PINAME,WDNAME,PDID,PDNAME,PDVR,CREATIONDATE,STATE,DEADLINE,STARTDATE <案件ID>,<作業ID>,<種別>,<ref識別子>,<案件名>,<作業定義名>,<ビジネスプロセス定義ID>,<ビジネスプロセス定義名>,<ビジネスプロセス定義バージョン>,<発生日時>,<状態>,<処理期限>,<開始日時>
1行目にはヘッダ情報が表示され,2行目以降には各ヘッダ情報に対応する項目が表示されます。表示項目の意味とヘッダとの対応を次の表に示します。
表2‒2 表示項目(作業の一覧) 列番号
ヘッダ表記
2行目以降の表示内容
意味
1
PIID
案件ID
作業が所属する案件のIDです。
2
WIID
作業ID
作業のIDです。
3
TYPE
種別
作業が対応する,次のどれかのBPMN要素です。
msg:メッセージイベントの場合
ope:サービスタスクまたはビジネスルールタスクの場合
err:エラーイベントの場合
tim:タイマーイベントの場合
4
REFID
ref識別子
作業のref識別子です。タイマーイベントの場合は空文字です。
5
PINAME
案件名
作業が所属する案件の名称です。
6
WDNAME
作業定義名
作業が所属する作業定義の名称です。
7
PDID
ビジネスプロセス定義ID
作業が所属するビジネスプロセス定義のIDです。
8
PDNAME
ビジネスプロセス定義名
作業が所属するビジネスプロセス定義の名称です。
9
PDVR
ビジネスプロセス定義バージョン
作業が所属するビジネスプロセス定義のバージョンです。
10
CREATIONDATE
発生日時
作業の発生日時です。
11
STATE
状態
作業の状態です。
12
DEADLINE
処理期限
作業の処理期限です。
13
STARTDATE
開始日時
作業の開始日時です。
- 1行目のヘッダ情報は,行頭に「#」が書かれた状態(コメントアウトされた状態)で出力されます。
- 一覧表示の出力結果を,作業の状態変更(形式3)の入力ファイルとして使用できます。
- 値がnullの項目は空文字として出力されます。
- 発生日時,処理期限,および開始日時の項目については,「YYYY/MM/DD hh:mm:ss」の形式で出力されます。
作業の一覧表示の出力例(ciwchgapwork -sid CIW01 -list -ope -s PERFORMINGを指定した場合)を次に示します。
#PIID,WIID,TYPE,REFID,PINAME,WDNAME,PDID,PDNAME,PDVR,CREATIONDATE,STATE,DEADLINE,STARTDATE 1,1001,ope,ref01,Proc1,hoge_STask1,6,hogePD,1,2017/12/29 12:44:59,PERFORMING(f),,2017/12/29 12:54:59 1,1002,ope,ref02,Proc1,foo_STask2,6,hogePD,1,2017/12/29 10:00:00,PERFORMING(f),,2017/12/29 10:10:00 2,1003,ope,ref02,Proc3,foo_STask1,8,fugaPD,1,2017/12/29 10:05:00,PERFORMING(f),,2017/12/29 10:15:00 3,1004,ope,ref04,Proc4,bar_STask2,8,fugaPD,1,2017/12/28 12:00:00,PERFORMING(f),,2017/12/28 12:10:00
作業の一覧表示の出力例(ciwchgapwork -sid CIW01 -list -ope -s READYを指定した場合)を次に示します。
#PIID,WIID,TYPE,REFID,PINAME,WDNAME,PDID,PDNAME,PDVR,CREATIONDATE,STATE,DEADLINE,STARTDATE 4,1005,ope,ref01,Proc5,hoge,6,hogePD,1,2021/10/28 12:34:56,READY(j),, 5,1006,ope,ref02,Proc6,foo,8,fugaPD,1,2021/10/29 10:05:00,READY(j),2021/10/29 10:10:00,
- -ope
-
サービスタスクまたはビジネスルールタスクの作業一覧を表示します。このオプションは-listオプションを指定した場合だけ指定できます。
- -msg
-
メッセージイベントの作業一覧を表示します。このオプションは-listオプションを指定した場合だけ指定できます。
- -err
-
エラーイベントの作業一覧を表示します。このオプションは-listオプションを指定した場合だけ指定できます。
- -tim
-
タイマーイベントの作業一覧を表示します。このオプションは-listオプションを指定した場合だけ指定できます。
- -ref <ref_identifier>
-
一覧表示する作業をref識別子で絞り込む場合に,ref識別子を指定します。このオプションを指定した場合,オプション引数に指定されたref識別子を作業者IDに持つ作業だけを表示します。ref識別子は完全一致で検索されます。
- -bpn <process_definition_name>
-
一覧表示する作業をビジネスプロセス定義によって絞り込む場合に,ビジネスプロセス定義名を指定します。
指定するビジネスプロセス定義名の長さは,<SYSTEMID>_PROCESS_DEFテーブルのNameカラムのバイト数以内にしてください。
このオプションを指定した場合,オプション引数に指定されたビジネスプロセス定義名のビジネスプロセス定義に所属する作業だけを表示します。
- -bpv <process_definition_version>
-
一覧表示する作業をビジネスプロセス定義バージョンによって絞り込む場合に,ビジネスプロセス定義バージョンを指定します。
指定できる値は,-32,768~32,767の整数です。ただし,有効な値は,ビジネスプロセス定義作成時に指定できる0~9,999の整数となります。
-bpnに指定されたビジネスプロセス定義名かつ-bpvに指定されたビジネスプロセス定義バージョンのビジネスプロセス定義に所属する作業だけを表示します。このオプションは-bpnオプションを指定した場合だけ指定できます。このオプションを省略した場合,-bpnで指定したビジネスプロセス定義名のすべてのバージョンが対象になります。
- -s <work_item_state>
-
- 形式1または形式2の場合
-
一覧表示する作業の状態を指定します。
指定できる値と,それぞれの意味を次に示します。
-
READY:実行開始可能
-
PERFORMING:作業者実行
このオプションが省略された場合,またはオプション引数だけが省略された場合は,「PERFORMING」が指定されたものとして動作します。
-
- 形式3の場合
-
状態変更後の作業状態を指定します。
指定できる値と,それぞれの意味を次に示します。
-
READY:実行開始可能
-
PERFORMING:作業者実行
-
EXECUTED:実行済
現在の作業の状態と,形式3で指定できる-sに指定するオプション引数の組み合わせを次の表に示します。ただし,タイマーイベントの作業は「実行済」(EXECUTED)状態に変更できません。
表2‒3 オプション引数と作業状態の組み合わせ 項番
変更前の状態
-sに指定するオプション引数
変更後の状態
1
実行開始可能(READY)
PERFORMING
作業者実行(PERFORMING)
2
作業者実行(PERFORMING)
READY
実行開始可能(READY)
3
作業者実行(PERFORMING)
EXECUTED
実行済(EXECUTED)
4
実行開始可能(READY)
EXECUTED
実行済(EXECUTED)
-
- -chg
-
対象作業の状態を変更する場合に指定します。-fのオプション引数で指定された入力ファイルの内容に従って,-sのオプション引数で指定された状態に作業状態を変更します。
- -f <input_file>
-
案件IDと作業IDを記載した入力ファイルを指定します。入力ファイルには状態を変更させる作業を指定します。入力ファイルフォーマットの詳細は,「機能」の「作業状態変更用入力ファイルフォーマット」を参照してください。入力ファイルには,作業の一覧表示(形式1,または形式2)の出力結果をリダイレクトしたファイルを使用できます。
戻り値
項番 |
リターンコード |
内容 |
---|---|---|
1 |
0 |
正常終了 |
2 |
1 |
致命的なエラー |
3 |
9※ |
実行権限エラー |
4 |
10 |
条件に指定した作業が1件も存在しない |
5 |
51 |
パラメーター不正 |
6 |
150 |
入力ファイルのアクセスエラー |
7 |
254 |
異常終了 |
- 注※
-
Windowsの場合だけ発生します。
注意事項
- タイマーイベントの作業は実行済(EXECUTED)に状態を変更できません。
- 作業の状態変更の実行結果に警告の件数が表示された場合は,警告メッセージを確認して,必要に応じて対処してください。
- -chgオプションを指定して状態変更する場合,このコマンドの実行ユーザ名がユーザ記述子として設定されます。そのため,ユーザ名の長さは,<SYSTEMID>_PROCESS_INSTANCEテーブルのCreatorカラムのバイト数以内にしてください。