2.10.2 BPMN連携機能を使用しない場合のciwmngbp
形式
-
形式1(ビジネスプロセス定義を登録する場合)
ciwmngbp -sid <system_id> -reg -bpf <process_definition_file> [-force]
-
形式2(ビジネスプロセス定義を取得する場合)
ciwmngbp -sid <system_id> -get -bpn <process_definition_name> -bpv <process_definition_version> -bpf <process_definition_file> [-force]
-
形式3(ビジネスプロセス定義の属性を変更する場合)
ciwmngbp -sid <system_id> -chg -bpn <process_definition_name> -bpv <process_definition_version> (-s {ACTIVE|INACTIVE} |-pfd {<process_from_date>|ORIGIN} |-ptd {<process_to_date>|BEYOND} |-bpa <responsible>)
-
形式4(ビジネスプロセス定義を削除する場合)
ciwmngbp -sid <system_id> -del -bpn <process_definition_name> -bpv <process_definition_version>
-
形式5(ワーク管理データベースに登録されているビジネスプロセス定義を一覧表示する場合)
ciwmngbp -sid <system_id> -list
-
形式6(オプションファイルを指定して実行する場合)※
ciwmngbp -file <option_file_name> [-encoding <character_set> ]
-
形式7(コマンドの形式を表示する場合)※
ciwmngbp -h
- 注※
-
すべてのコマンドで同じ形式で指定します。詳細は,「1.5 コマンド共通のオプション」を参照してください。
機能
ビジネスプロセス定義を管理します。
このコマンドで実行できることを次に示します。
-
ビジネスプロセス定義の登録
-
ビジネスプロセス定義の取得
-
ビジネスプロセス定義の属性変更
-
ビジネスプロセス定義の削除
-
ビジネスプロセス定義の一覧表示
実行条件
このコマンドを実行できるコンポーネントの稼働状態を次に示します。
コンポーネント |
稼働状態 |
|
---|---|---|
起動中 |
停止中 |
|
CSCIWManagementServer |
×※ |
○ |
案件運用操作 |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(J2EEアプリケーション) |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(Javaアプリケーション) |
×※ |
○ |
アプリケーション呼び出しサービス |
○ |
○ |
RESTサービス |
○ |
○ |
運用管理RESTサービス |
○ |
○ |
同一マシンでのほかのコマンド |
× |
○ |
異なるマシンでの同一コマンド |
× |
○ |
異なるマシンでのほかのコマンド |
× |
○ |
DBMS |
○ |
× |
- (凡例)
-
○:コマンドを実行できます。
×:コマンドを実行できません。
- 注※
-
-getオプションまたは-listオプション指定時は,起動中でもコマンドを実行できます。
また,-regオプション,-chgオプション,または-delオプション指定時は,起動中でもコマンドを実行できます。ただし,コマンド実行後は変更を反映するために再起動してください。
引数
- -sid <system_id>
-
環境構築時に設定したシステムIDを指定します。指定したシステムIDに対応するワーク管理システム上のビジネスプロセス定義が対象になります。
指定できる値は,半角英大文字と半角数字で5文字以内です。ただし,先頭には半角英大文字を指定してください。
- -reg
-
ビジネスプロセス定義を登録する場合に指定します。
登録対象のビジネスプロセス定義に管理者の指定がない場合は,このコマンドを実行したユーザがビジネスプロセス定義の管理者として設定されます。また,登録するビジネスプロセス定義の作成者は,このコマンドを実行したユーザになります。このため,ユーザ名の長さは,<SYSTEMID>_PROCESS_DEFテーブルのAuthorカラムのバイト数以内にしてください。
また,そのほかの注意事項について次に示します。
-
登録するビジネスプロセス定義ファイルには,CSCIW-Definerでチェックを実施し,エラーのなしを確認したファイルを指定してください。チェックを実施していないファイルを指定した場合,動作の保証はできません。
-
登録するビジネスプロセス定義ファイルは,CSCIW-Definerで編集してください。CSCIW-Definer以外のプログラム(文書エディタなど)で編集した場合,動作の保証はできません。
-
登録するビジネスプロセス定義で使用する振り分けルール定義が必要です。振り分けルール定義がない場合,CSCIWManagementServer,案件運用操作およびCSCIWライブラリを使用した業務アプリケーションで,例外が発生することがあります。
-
登録するビジネスプロセス定義に含まれている条件定義,生成ルール定義,作業アプリケーション定義のSQL文,およびJavaクラス名がデフォルト値から変更されていないとエラーになります。
-
- -get
-
ビジネスプロセス定義ファイルを取得する場合に指定します。
- -chg
-
ビジネスプロセス定義の属性を変更する場合に指定します。
このオプションを指定した場合,次に示すオプションをどれかを1つ以上指定する必要があります。
-
-sオプション
-
-pfdオプション
-
-ptdオプション
-
-bpaオプション
-
- -del
-
ビジネスプロセス定義を削除する場合に指定します。ただし,削除対象のビジネスプロセス定義が「活性」状態のとき,または削除対象のビジネスプロセス定義に案件が存在するときは,ビジネスプロセス定義を削除できません。
- -list
-
ワーク管理データベースに登録されているビジネスプロセス定義の一覧を,CSV形式で表示する場合に指定します。
ビジネスプロセス定義一覧の表示フォーマットを次に示します。
Name,Version,StateCode,ValidFromDate,ValidToDate,Author,Responsible ORSplitJoin1,1,ACTIVE(b),ORIGIN,BEYOND,csciw1,"csciw""1" ORSplitJoin1,2,ACTIVE(b),ORIGIN,BEYOND,csciw1,"csci,w1" ORSplitJoin2,1,INACTIVE(a),Thu Dec 14 00:00:00 JST 2006,Thu Dec 14 23:59:59 JST 2006,csciw1,csciw1
ビジネスプロセス定義一覧の1行目にはヘッダ情報が表示され,2行目以降には各ヘッダ情報に対応する値が表示されます。
表示項目の意味を次の表に示します。
表2‒22 表示項目(ビジネスプロセス定義一覧) 表示項目
意味
Name
ビジネスプロセス定義名を示します。
Version
ビジネスプロセス定義のバージョンを示します。
StateCode
ビジネスプロセス定義の状態を示します。
ビジネスプロセス定義の状態には,次に示す値が表示されます。
「ACTIVE」:「活性」状態を示します。
「INACTIVE」:「非活性」状態を示します。
ValidFromDate
案件投入可能開始日を示します。
案件投入可能開始日には,実行環境のタイムゾーンに依存した日付が表示されます。ただし,無限遠の過去の場合は「ORIGIN」が表示されます。
ValidToDate
案件投入可能終了日を示します。
案件投入可能終了日には,実行環境のタイムゾーンに依存した日付が表示されます。ただし,無限遠の未来の場合は「BEYOND」が表示されます。
Author
ビジネスプロセス定義の作成者を示します。
Responsible
ビジネスプロセス定義の管理者を示します。
- -bpn <process_definition_name>
-
ビジネスプロセス定義名を指定します。指定したビジネスプロセス定義が,取得,属性変更,または削除の対象になります。
ビジネスプロセス定義名は,<SYSTEMID>_PROCESS_DEFテーブルのNameカラムのバイト数以内で指定してください。
- -bpv <process_definition_version>
-
ビジネスプロセス定義のバージョンを指定します。-bpnオプションに指定したビジネスプロセス定義名,かつこのオプションに指定したバージョンのビジネスプロセス定義が,取得,属性変更,または削除の対象になります。
指定できる値は,-32,768〜32,767です。ただし,有効な値はビジネスプロセス定義作成時に指定できる0〜9,999となります。
- -s {ACTIVE|INACTIVE}
-
このオプションは,-chgオプションを指定した場合だけ指定できます。
ビジネスプロセス定義の状態を変更する場合に,変更後の状態を指定します。
指定できる値は,「ACTIVE」または「INACTIVE」です。値の意味を次に示します。
-
「ACTIVE」:「活性」状態に変更します。
-
「INACTIVE」:「非活性」状態に変更します。
-
- -pfd {<process_from_date>|ORIGIN}
-
このオプションは,-chgオプションを指定した場合だけ指定できます。
案件投入可能開始日を変更する場合に,変更後の案件投入可能開始日または「ORIGIN」を指定します。
案件投入可能開始日は,YYYYMMDD(YYYY:西暦,MM:月,DD:日)の形式で指定してください。例えば,20070510を指定した場合,2007/05/10の0時0分0秒を意味します。指定できる日付の範囲は,1970/01/03〜9999/12/30です。
ORIGINを指定した場合,無限遠の過去を意味します。
- -ptd {<process_to_date>|BEYOND}
-
このオプションは,-chgオプションを指定した場合だけ指定できます。
案件投入可能終了日を変更する場合に,変更後の案件投入可能終了日または「BEYOND」を指定します。
案件投入可能終了日は,YYYYMMDD(YYYY:西暦,MM:月,DD:日)の形式で指定してください。例えば,20070610を指定した場合,2007/06/10の23時59分59秒を意味します。指定できる日付の範囲は,1970/01/03〜9999/12/30です。
BEYONDを指定した場合,無限遠の未来を意味します。
- -bpa <responsible>
-
このオプションは,-chgオプションを指定した場合だけ指定できます。
ビジネスプロセス定義の管理者名を指定します。
ビジネスプロセス定義の管理者名は,<SYSTEMID>_PROCESS_DEFテーブルのResponsibleカラムのバイト数以内で指定してください。
- -bpf <process_definition_file>
-
- -regオプションを指定してビジネスプロセス定義を登録する場合
-
CSCIW-Definerで作成したビジネスプロセス定義を指定します。
なお,-forceオプションを同時に指定すると,同一名で同一バージョンのビジネスプロセス定義があったときに,強制的に上書きできます。
- -getオプションを指定してビジネスプロセス定義を取得する場合
-
ワーク管理システムから取得したビジネスプロセス定義の内容を保存するビジネスプロセス定義ファイル名を指定します。
-forceオプションを同時に指定すると,同一名のビジネスプロセス定義ファイルがあったときに,強制的に上書きできます。
- -force
-
- -regオプションを指定してビジネスプロセス定義を登録する場合
-
ワーク管理システムに同一名で同一バージョンのビジネスプロセス定義が登録されていたときに,-bpfオプションに指定したビジネスプロセス定義を登録します(強制的に上書きします)。ただし,次に示すときは,ビジネスプロセス定義を登録できません。
-
登録対象のビジネスプロセス定義が「活性」状態のとき
-
登録対象のビジネスプロセス定義に案件が存在するとき
このオプションを省略すると,同一名で同一バージョンのビジネスプロセス定義が登録されていたときに,ビジネスプロセス定義を登録できません。
-
- -getオプションを指定してビジネスプロセス定義を取得する場合
-
-bpfオプションに指定したビジネスプロセス定義ファイルと同一名のファイルが存在したときに,そのファイルに指定したビジネスプロセス定義を取得します(強制的に上書きします)。
このオプションを省略すると,同一名のビジネスプロセス定義ファイルが存在したときに,ビジネスプロセス定義を取得できません。
- -file <option_file_name>
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -encoding <character_set>
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.1 -fileオプション」を参照してください。
- -h
-
このオプションは,すべてのコマンドで指定できます。詳細は,「1.5.2 -hオプション」を参照してください。
戻り値
戻り値 |
内容 |
---|---|
0 |
正常終了 |
1 |
致命的なエラー |
9※ |
実行権限エラー |
50 |
指定した状態に変更済みである |
51 |
パラメーター不正 |
100 |
ビジネスプロセス定義の内容不正 |
110 |
定義登録ユーザ名の不正 |
150 |
ビジネスプロセス定義ファイルのアクセスエラー |
254 |
異常終了 |
- 注※
-
Windowsの場合だけ発生します。
注意事項
-
オプション引数に,文字列を指定する場合の注意事項については,「1.2 コマンドの入力形式」を参照してください。
-
マルチマシン構成の場合,どれか1つのマシンでこのコマンドを実行してください。
-
このコマンドは,CSCIWManagementServerおよびCSCIWを使用しているJavaアプリケーションが起動中でも実行できます。ただし,コマンド実行後に,必ずCSCIWManagementServerおよびCSCIWを使用しているJavaアプリケーションを再起動してください。再起動しないと,ビジネスプロセス定義の変更が反映されません。