2.6.2 BPMN連携機能を使用しない場合のciweditbp
形式
-
形式1(変更内容をファイルに出力する場合)
ciweditbp -sid <system_id> -bpf <process_definition_file> -o <output_file_name> [-encoding <character_set>]
-
形式2(変更したビジネスプロセス定義を登録する場合)
ciweditbp -sid <system_id> -edt -bpf <process_definition_file> -bk <old_process_definition_file> -o <output_file_name> [-encoding <character_set>]
-
形式3(オプションファイルを指定して実行する場合)※
ciweditbp -file <option_file_name> [-encoding <character_set>]
-
形式4(コマンドの形式を表示する場合)※
ciweditbp -h
- 注※
-
すべてのコマンドで同じ形式で指定します。詳細は,「1.5 コマンド共通のオプション」を参照してください。
機能
ビジネスプロセス定義の一部を変更します。すでに案件が存在しているビジネスプロセス定義を,バージョンはそのままで変更できます。ただし,既存の案件,業務ステップおよび作業の情報は変更できません。
また,指定したファイルに,変更内容をCSV形式で出力します。
-
変更内容の出力フォーマットについて
-oオプションを指定して変更内容を出力した場合の出力フォーマットを次に示します。
-
1行目
ヘッダ情報として,製品名,バージョン,ファイル名,日時などが出力されます。
-
2行目
ビジネスプロセス定義の識別情報が出力されます。
出力される情報を次の表に示します。
表2‒15 変更内容出力ファイル(ビジネスプロセス定義の識別情報) 行
カラム
内容
1
1
ビジネスプロセス定義名が出力されます。
2
ビジネスプロセス定義のバージョンが出力されます。
-
3行目以降
変更内容が追加情報,変更情報,削除情報の順に出力されます。CSCIW-Definerで,新規作成した定義は追加情報に,削除した定義は削除情報に,属性を変更した定義は変更情報に情報を出力されます。属性が同じでも,削除および新規作成の操作を実行した場合は,削除情報と追加情報に情報が出力されます。
出力される情報を次の表に示します。
表2‒16 変更内容出力ファイル(追加情報) 行
カラム
内容
1
1
追加を示す固定文字列の「[Addition]」が出力されます。
2以降
1以降
各種別の属性値が出力されます。※
- 注※
-
各種別の属性値については,「表2‒19 変更内容出力ファイル(ビジネスプロセス属性値)」〜「表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合)」を参照してください。
表2‒17 変更内容出力ファイル(変更情報) 行
カラム
内容
1
1
変更を示す固定文字列の「[Modification]」が出力されます。
2N※1
1
変更前を示す固定文字列の「Before」が出力されます。
2以降
各種別の属性値が出力されます。※2
2N※1+1
1
変更後を示す固定文字列の「After」が出力されます。
2以降
各種別の属性値が出力されます。※2
- 注※1
-
N=1,2,3…
- 注※2
-
各種別の属性値については,「表2‒19 変更内容出力ファイル(ビジネスプロセス属性値)」〜「表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合)」を参照してください。
表2‒18 変更内容出力ファイル(削除情報) 行
カラム
内容
1
1
[Deletion](削除を示す固定文字列)
2以降
1以降
各種別の属性値※
- 注※
-
各種別の属性値については,「表2‒19 変更内容出力ファイル(ビジネスプロセス属性値)」〜「表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合)」を参照してください。
各種別の属性値の出力内容を「表2‒19 変更内容出力ファイル(ビジネスプロセス属性値)」〜「表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合)」に示します。
特に記載のないかぎり,未設定の属性値は空文字が表示されます。
表2‒19 変更内容出力ファイル(ビジネスプロセス属性値) 列
出力内容
備考
1
種別
ビジネスプロセスを示す固定文字列の「BusinessProcess」が出力されます。
2
ビジネスプロセス名
−
3
バージョン
4
ビジネスプロセスID
5
処理期限ルール名
6
管理者名
7
案件投入可能期間開始
日付が出力されます。
日付の形式はJavaVMに依存します。
なお,案件投入可能期間開始日が未設定の場合は「ORIGIN」,
案件投入可能期間終了日が未設定の場合は「BEYOND」が出力されます。
8
案件投入可能期間終了
9
説明
−
10
アドホックAPIの使用
アドホックAPIを使用する場合は「true」,アドホックAPIを使用しない場合は「false」が出力されます。
- (凡例)
-
−:ありません。
表2‒20 変更内容出力ファイル(業務ステップ属性値) 列
出力内容
備考
1
種別
業務ステップを示す固定文字列の「Activity」が出力されます。
2
業務ステップ名
−
3
業務ステップ定義ID
4
処理期限ルール名
5
事前生成フラグ
「true」(事前生成する),または「false」(事前生成しない)が出力されます。
6
完了条件名
−
7
説明
- (凡例)
-
−:ありません。
表2‒21 変更内容出力ファイル(一般作業属性値) 列
出力内容
備考
1
種別
一般作業を示す固定文字列の「NormalWork」が出力されます。
2
作業名
−
3
作業定義ID
4
振り分けルール名
5
発生条件名
6
完了条件名
7
条件再評価フラグ
「true」(条件を再評価する),または「false」(条件を再評価しない)が出力されます。
8
説明
−
9
作業アプリケーション定義名
- (凡例)
-
−:ありません。
表2‒22 変更内容出力ファイル(並列作業属性値) 列
出力内容
備考
1
種別
並列作業を示す固定文字列の「ParallelWork」が出力されます。
2
作業名
−
3
作業定義ID
4
子作業名
5
子作業生成ルール名
6
発生条件名
7
完了条件名
8
条件再評価フラグ
「true」(条件を再評価する),または「false」(条件を再評価しない)が出力されます。
9
説明
−
- (凡例)
-
−:ありません。
表2‒23 変更内容出力ファイル(分岐ノード,分業ノード,先着ノード,待合ノード,ソースノード,およびシンクノードの属性値) 列
出力内容
備考
1
種別
対象種別を示す固定文字列が出力されます。出力される固定文字列を次に示します。
-
「XOR-Split」:分岐ノードを示します。
-
「AND-Split」:分業ノードを示します。
-
「OR-Join」:先着ノードを示します。
-
「AND-Join」:待合ノードを示します。
-
「Source」:ソースノードを示します。
-
「Sink」:シンクノードを示します。
2
定義名
−
3
制御ノードID
- (凡例)
-
−:ありません。
表2‒24 変更内容出力ファイル(遷移定義属性値) 列
出力内容
備考
1
種別
遷移定義を示す固定文字列の「Flow」が出力されます。
2
遷移定義ID
−
3
遷移元ノード名
次に示す定義種別のどれかが出力されます。
-
業務ステップ
-
各種制御ノード
-
階層定義
-
ソースノード
-
シンクノード
4
遷移先ノード名
5
優先順位
デフォルトの分岐先の場合,「Default」が出力されます。
6
分岐条件名
−
- (凡例)
-
−:ありません。
表2‒25 変更内容出力ファイル(階層定義属性値) 列
出力内容
備考
1
種別
階層定義を示す固定文字列の「Hierarchy」が出力されます。
2
階層名
−
3
階層ID
- (凡例)
-
−:ありません。
表2‒26 変更内容出力ファイル(条件属性値:RDB検索の場合) 列
出力内容
備考
1
種別
条件を示す固定文字列の「Condition」が出力されます。
2
定義名
−
3
条件ID
4
条件種別
「SQL」が出力されます。
5
説明
−
6
DB識別子
7
SQL文
8
NOTフラグ
「true」(NOT指定あり),または「false」(NOT指定なし)が出力されます。
- (凡例)
-
−:ありません。
表2‒27 変更内容出力ファイル(条件属性値:Javaオブジェクト呼び出しの場合) 列
出力内容
備考
1
種別
条件を示す固定文字列の「Condition」が出力されます。
2
定義名
−
3
条件ID
4
条件種別
「Java」が出力されます。
5
説明
−
6
Javaクラス名
7
補助定数パラメタ
- (凡例)
-
−:ありません。
表2‒28 変更内容出力ファイル(生成ルール属性値:RDB検索の場合) 列
出力内容
備考
1
種別
生成ルールを示す固定文字列の「CreationRule」が出力されます。
2
定義名
−
3
ルールID
4
生成ルール種別
「SQL」が出力されます。
5
説明
−
6
DB識別子
7
SQL文
- (凡例)
-
−:ありません。
表2‒29 変更内容出力ファイル(生成ルール属性値:Javaオブジェクト呼び出しの場合) 列
出力内容
備考
1
種別
条件を示す固定文字列の「CreationRule」が出力されます。
2
定義名
−
3
ルールID
4
生成ルール種別
「Java」が出力されます。
5
説明
−
6
Javaクラス名
7
補助定数パラメタ
- (凡例)
-
−:ありません。
表2‒30 変更内容出力ファイル(時間取得ルール属性値) 列
出力内容
備考
1
種別
時間取得ルールを示す固定文字列の「TimeRule」が出力されます。
2
定義名
−
3
ルールID
4
時間取得ルール種別
「DATE」が出力されます。
5
説明
−
6
相対日数
- (凡例)
-
−:ありません。
表2‒31 変更内容出力ファイル(作業アプリケーション定義属性値:Javaオブジェクト呼び出しの場合) 列
出力内容
備考
1
種別
条件を示す固定文字列の「Application」が出力されます。
2
作業アプリケーション定義名
−
3
作業アプリケーション定義ID
4
作業アプリケーション種別
「Java」が出力されます。
5
説明
−
6
Javaクラス名
7
補助定数パラメタ
- (凡例)
-
−:ありません。
表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合) 列
出力内容
備考
1
種別
条件を示す固定文字列の「Application」が出力されます。
2
作業アプリケーション定義名
−
3
作業アプリケーション定義ID
4
作業アプリケーション種別
「REST」が出力されます。
5
説明
−
6
ref識別子
- (凡例)
-
−:ありません。
-
-
ビジネスプロセス定義の変更について
このコマンドで変更できるビジネスプロセス定義の範囲を次の表に示します。
表に示すビジネスプロセス定義の項目を変更した場合,項目以外(例えば,業務ステップ定義などの座標情報やアイコン種別といったCSCIW-Definerの描画情報など)のビジネスプロセス定義の内容についても変更されます。
また,表に示した項目が変更内容に1つも含まれない場合は,ビジネスプロセス定義の変更は実行されません。
表2‒33 ciweditbpコマンドで変更できるビジネスプロセス定義の範囲 変更対象
変更内容
備考
ビジネスプロセス
属性変更
変更できる属性
-
処理期限ルール名
-
管理者
-
案件投入可能期間
-
説明
変更できない属性
-
ビジネスプロセス定義名
-
バージョン
-
アドホックAPIの使用
業務ステップ
追加または削除
追加または削除できる位置
遷移元ノード種別
-
ソースノード
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
待合ノード
-
先着ノード
遷移先ノード種別
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
先着ノード(後続停止なし)
-
シンクノード
属性変更
変更できる属性
-
業務ステップ名
-
完了条件名
-
処理期限ルール名
-
説明
変更できない属性
-
事前生成
作業
-
一般作業
-
並列作業
追加または削除
−
属性変更
変更できる属性
-
作業名
-
振り分けルール名(一般作業の場合)
-
発生条件名
-
完了条件名
-
条件再評価
-
説明
-
子作業名(並列作業の場合)
-
子作業生成ルール名(並列作業の場合)
-
作業アプリケーション定義名(一般作業の場合)
制御ノード
-
分岐ノード
-
先着ノード(後続停止なし)
追加または削除
追加または削除できる位置
遷移元ノード種別
-
ソースノード
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
待合ノード
-
先着ノード
遷移先ノード種別
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
先着ノード(後続停止なし)
-
シンクノード
属性変更
変更できる属性
-
定義名
変更できない属性
-
後続停止
制御ノード
-
分業ノード
-
待合ノード
-
先着ノード(後続停止あり)
追加または削除
追加または削除できない
属性変更
変更できる属性
-
定義名
変更できない属性
-
後続停止
遷移定義
追加または削除
次に示すノードへの遷移定義の追加または削除はできない
-
待合ノード
-
先着ノード(後続停止あり)
属性変更
変更できる属性(分岐条件の場合)
-
優先順位(有無を含む)
-
分岐条件名
遷移元および遷移先も変更できる(ただし,待合ノードおよび先着ノード(後続停止あり)の遷移元が変更になってはいけない)
階層定義
追加または削除
追加または削除できるかどうかは,含まれる定義に依存する
追加または削除できる位置
遷移元ノード種別
-
ソースノード
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
待合ノード
-
先着ノード
遷移先ノード種別
-
業務ステップ
-
階層定義
-
分業ノード
-
分岐ノード
-
先着ノード(後続停止なし)
-
シンクノード
属性変更
変更できる属性
-
階層名
条件(RDB検索,Java)
追加または削除
−
属性変更
変更できる属性
-
定義名
-
条件の種別
-
SQL文(RDB検索の場合)
-
NOTフラグ(RDB検索の場合)
-
Javaクラス名(Javaオブジェクト呼び出しの場合)
-
補助定数パラメタ(Javaオブジェクト呼び出しの場合)
-
説明
ルール
-
生成ルール(RDB検索,Java)
-
時間取得ルール(相対時間だけ)
追加または削除
−
属性変更
変更できる属性
-
定義名
-
生成ルールの種別
-
説明
-
SQL文(生成ルール(RDB検索)の場合)
-
Javaクラス名(生成ルール(Javaオブジェクト呼び出し)の場合)
-
補助定数パラメタ(生成ルール(Javaオブジェクト呼び出し)の場合)
-
相対日数(時間取得ルール(相対時間)の場合)
作業アプリケーション定義(Java,REST)
追加
−
属性変更
変更できる属性
-
作業アプリケーション定義名
-
作業アプリケーションの種別
-
補助定数パラメタ(Javaオブジェクト呼び出しの場合)
-
説明
-
Javaクラス名(Javaオブジェクト呼び出しの場合)
-
ref識別子(RESTアプリケーション呼び出しの場合)
- (凡例)
-
−:制限はありません。
-
実行条件
このコマンドを実行できるコンポーネントの稼働状態を次に示します。
コンポーネント |
稼働状態 |
|
---|---|---|
起動中 |
停止中 |
|
CSCIWManagementServer |
×※ |
○ |
案件運用操作 |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(J2EEアプリケーション) |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(Javaアプリケーション) |
×※ |
○ |
アプリケーション呼び出しサービス |
○ |
○ |
RESTサービス |
○ |
○ |
運用管理RESTサービス |
○ |
○ |
同一マシンでのほかのコマンド |
× |
○ |
異なるマシンでの同一コマンド |
× |
○ |
異なるマシンでのほかのコマンド |
× |
○ |
DBMS |
○ |
× |
- (凡例)
-
○:コマンドを実行できます。
×:コマンドを実行できません。
- 注※
-
変更内容をファイルに出力するだけの場合は,起動中でもコマンドを実行できます。
また,定義を登録する場合は,起動中でもコマンドを実行できます。ただし,コマンド実行後は定義を反映するために必ず再起動してください。
使用手順
このコマンドの使用手順を次に示します。なお,手順2.および3.のCSCIW-Definerの操作の詳細は,マニュアル「uCosminexus Service Coordinator Interactive Workflow ビジネスプロセス開発ガイド」を参照してください。
-
ciwmngbpコマンドで変更対象のビジネスプロセス定義を取得します。
編集するビジネスプロセス定義と登録済みのビジネスプロセス定義との間に差異が発生しないように,編集する直前にビジネスプロセス定義を取得してください。または,CSCIW-Definerを使用し,ビジネスプロセス定義を取得してください。
ciwmngbpコマンドの例を次に示します。
- 例
-
ciwmngbp -sid SID1 -get -bpn SampleBP -bpv 1 -bpf SampleBp.hbx
なお,ciwmngbpコマンドの詳細は,「2.10 ciwmngbp(ビジネスプロセス定義の管理)」を参照してください。
-
CSCIW-Definerを使用し,手順1.で取得したビジネスプロセス定義を変更します。
ビジネスプロセス定義を変更する場合の注意事項を次に示します。
-
定義を追加するときは,コピー([Ctrl]+[C])および貼り付け([Ctrl]+[V])機能を使用しないでください。
-
業務ステップ間では,作業の移動をしないでください。
-
ビジネスプロセスと階層または階層と階層での業務ステップ,制御ノード,階層の移動には,切り取り([Ctrl]+[X])および貼り付け([Ctrl]+[V])機能を使用してください。
-
ビジネスプロセス遷移ビューから業務ステップ,分業ノード,分岐ノード,待合ノード,先着ノードまたは階層定義を削除するときは,[オブジェクトの削除]を選択してください。[削除]を選択しても,定義情報は削除されません。定義情報が削除されたかどうかは,ビジネスプロセスツリービューで確認できます。
-
-
CSCIW-Definerで,変更したビジネスプロセス定義をチェックします。
-
ciweditbpコマンドで変更内容をファイルに出力し,ビジネスプロセス定義の変更個所を確認します。
変更内容によっては,変更内容出力ファイルだけではわかりにくいことがあるため,ビジネスプロセス定義と対応させて確認してください。
ciweditbpコマンドの例を次に示します。
- 例
-
ciweditbp -sid SID1 -bpf SampleBp.hbx -o diff.csv
-
CSCIWシステムのバックアップを取得します。
-
ciweditbpコマンドで変更したビジネスプロセス定義を登録します。
ciweditbpコマンドの例を次に示します。
- 例
-
ciweditbp -edt -sid SID1 -bpf SampleBp.hbx -bk SampleBp_old.hbx -o diff.csv
引数
- -sid <system_id>
-
環境構築時に設定したシステムIDを指定します。指定したシステムIDに対応するワーク管理システム上のビジネスプロセス定義が対象になります。
指定できる値は,半角英大文字と半角数字で5文字以内です。ただし,先頭には半角英大文字を指定してください。
- -edt
-
変更したビジネスプロセス定義を登録する場合に指定します。
登録したビジネスプロセス定義の作成者は,このコマンドを実行したユーザになります。
このため,ユーザ名の長さは,<SYSTEMID>_PROCESS_DEFテーブルのAuthorカラムのバイト数以内にしてください。
- -bpf <process_definition_file>
-
変更後のビジネスプロセス定義ファイル名を指定します。
変更後のビジネスプロセス定義ファイル名には,CSCIW-Definerで変更したビジネスプロセス定義ファイルの名称を指定してください。
なお,変更後にCSCIW-Definerでチェックを実施し,エラーのなしを確認したビジネスプロセス定義ファイルを指定してください。チェックを実施していないファイルを指定した場合,動作の保証はできません。
また,変更後の定義に含まれている条件定義,生成ルール定義,作業アプリケーション定義のSQL文,Javaクラス名,およびref識別子がデフォルト値から変更されていない場合はエラーになります。
- -bk <old_process_definition_file>
-
変更前のビジネスプロセス定義情報を保存するファイルの名称を指定します。
変更前のビジネスプロセス定義ファイル名には,一意な名称を指定してください。
- -o <output_file_name>
-
変更内容を出力するファイルの名称を指定します。
変更内容は,指定したファイルにCSV形式で出力されます。出力内容を次に示します。
-
1行目
ヘッダ情報として,製品名,バージョン,ファイル名,日時などが出力されます。
-
2行目
ビジネスプロセス定義の識別情報が出力されます。
なお,変更内容の出力フォーマットについては,「表2‒15 変更内容出力ファイル(ビジネスプロセス定義の識別情報)」〜「表2‒32 変更内容出力ファイル(作業アプリケーション定義属性値:RESTアプリケーション呼び出しの場合)」を参照してください。
-
- -file <option_file_name>
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -encoding <character_set>
-
このオプションは,-oオプションまたは-fileオプションを指定した場合だけ指定できます。文字コードには,Javaでサポートされているエンコーディングの正準名を指定してください。また,このオプションを省略した場合は,Javaのデフォルトの文字コードが指定されます。
- -oオプションを指定した場合
-
-oオプションに指定した出力ファイルの文字コードを指定します。
文字コードには,Javaでサポートされているエンコーディングの正準名を指定してください。
- -fileオプションを指定した場合
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -h
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.2 -hオプション」を参照してください。
戻り値
戻り値 |
内容 |
---|---|
0 |
正常終了 |
1 |
致命的なエラー |
9※ |
実行権限エラー |
10 |
ビジネスプロセス定義の変更なし |
51 |
パラメーター不正 |
100 |
ビジネスプロセス定義不正 |
110 |
ビジネスプロセス定義以外のデータ不正 |
150 |
ファイルアクセスエラー |
254 |
異常終了 |
- 注※
-
Windowsの場合だけ発生します。
注意事項
-
オプション引数に,文字列を指定する場合の注意事項については,「1.2 コマンドの入力形式」を参照してください。
-
ビジネスプロセス定義を変更する場合は,このコマンドを実行する前に,CSCIWシステムのバックアップを取得することを推奨します。
-
マルチマシン構成の場合,どれか1つのマシンでこのコマンドを実行してください。
-
このコマンドは,CSCIWManagementServerおよびCSCIWを使用しているJavaアプリケーションが起動中でも実行できます。ただし,コマンド実行後に,必ずCSCIWManagementServerおよびCSCIWを使用しているJavaアプリケーションを再起動してください。再起動しないと,ビジネスプロセス定義の変更が反映されません。
-
ビジネスプロセス定義から定義済みの業務ステップを削除する場合,削除対象に実行中の業務ステップがあると,ビジネスプロセス定義を変更できません。
また,定義済みの作業を削除する場合,その作業が属する業務ステップに実行中のものがあると,ビジネスプロセス定義を変更できません。
-
CSCIW-Definerで新規に作成したビジネスプロセス定義ファイルは使用できません。
-
ビジネスプロセス定義の変更によって,変更前に生成された業務ステップや作業が持つ情報と,変更後に生成された業務ステップや作業が持つ情報が異なることがあります。例えば,業務ステップ定義名や作業定義名などが該当します。そのため,必要に応じて業務プログラムや運用手順を見直してください。
-
作業アプリケーション定義を変更した場合でも,呼び出し済みの作業アプリケーションの情報は変更されません。
-
条件およびルールを変更する場合,業務プログラムや運用手順を見直す必要があります。