2.9.1 BPMN連携機能を使用する場合のciwmngapgrp
形式
-
形式1(アプリケーション呼び出しグループ定義を一覧で表示する場合)
ciwmngapgrp -sid <system_id> -list
-
形式2(入力用ファイルの内容に従ってアプリケーション呼び出しグループ定義を更新する場合)
ciwmngapgrp -sid <system_id> -chg -apgf <application_call_group_file>
-
形式3(オプションファイルを指定して実行する場合)※
ciwmngapgrp -file <option_file_name> [-encoding <character_set>]
-
形式4(コマンドの形式を表示する場合)※
ciwmngapgrp -h
- 注※
-
すべてのコマンドで同じ形式で指定します。詳細は,「1.5 コマンド共通のオプション」を参照してください。
機能
アプリケーション呼び出しグループを管理します。
このコマンドで実行できることを次に示します。
-
アプリケーション呼び出しグループ定義の,次の情報更新の操作
-
アプリケーション呼び出しグループにref識別子を登録
-
アプリケーション呼び出しグループからref識別子を削除
-
-
アプリケーション呼び出しグループ定義の一覧表示
なお,個別にアプリケーション呼び出し制御情報を設定しているref識別子は,アプリケーション呼び出しグループに登録できません。
- アプリケーション呼び出しグループ定義ファイルのフォーマット
-
アプリケーション呼び出しグループ定義ファイルのフォーマットを次に示します。
<更新オプション>,<種別>,<ref識別子>,<所属グループ>
「#」から始まる行はコメント行として扱われるため,読み込まれません。
改行だけの行は無視されます。
「KDIW」から始まる行は無視されます。そのため,-listオプションでリダイレクトして作成したファイルから,「KDIW」から始まるメッセージの行を削除する必要はありません。
コメント行の場合,およびref識別子の記述がない場合は,指定内容は反映されません。
表2‒19 アプリケーション呼び出しグループ定義の項目 列番号
項目名
説明
値域
更新オプション(UPDATEOPTION)ごとの項目要否
U(更新)の場合
D(削除)の場合
1
UPDATEOPTION
更新オプション
情報の更新方法を示すオプション識別子です。この指定に従って情報を更新します。次のどちらかを指定してください。
U:更新
D:削除
UまたはD
○
○
2
TYPE
種別
次のどれかの種別です。
msg:メッセージイベントの場合
ope:サービスタスクまたはビジネスルールタスクの場合
err:エラーイベントの場合
次のどれかの文字列
-
msg
-
ope
-
err
○
○
3
ID
ref識別子
更新の対象となるref識別子です。
次の条件を両方満たす値
-
半角英数字とアンダースコア(_)から構成されている
-
((<SYSTEMID>_<APPLICATION_LOCK_INFOテーブルのLockNameのカラムサイズ) - 7)バイト以内
○
○
4
GROUPNAME
所属グループ
ref識別子が所属するグループ名です。アプリケーション呼び出し制御情報に指定するグループ名と一致させてください。
次の条件を両方満たす値
-
半角英数字とアンダースコア(_)から構成されている
-
((<SYSTEMID>_<APPLICATION_LOCK_INFOテーブルのLockNameのカラムサイズ) - 7)バイト以内
○
―
- (凡例)
-
○:必須
―:不要(読み込まない)
更新オプション(UPDATEOPTION)の指定によって実施される処理を次に示します。
-
更新オプション(UPDATEOPTION)がUの場合
種別(TYPE)と,ref識別子(ID)の組み合わせが重複している行がある場合,最後の行が有効となります。
また,IDに指定したref識別子がアプリケーション呼び出し制御情報に存在するとエラーになります。
アプリケーション呼び出しグループ定義を更新する場合は,アプリケーション呼び出しグループ定義のすべての項目を記入します。
-
更新オプション(UPDATEOPTION)がDの場合
所属グループ(GROUPNAME)は省略できます。記載した場合もエラーにはなりません。
アプリケーション呼び出しグループ定義ファイルの記述例を次に示します。
U,err,ref002,Group01 U,msg,ref002,Group01 U,msg,ref003,Group01 U,ope,ref002,Group01 U,ope,ref003,Group01 U,err,ref003,Group02
なお,アプリケーション呼び出し制御情報の更新については,「2.8.1 BPMN連携機能を使用する場合のciwmngap」を参照してください。
-
実行条件
このコマンドを実行できるコンポーネントの稼働状態を次に示します。
コンポーネント |
稼働状態 |
|
---|---|---|
起動中 |
停止中 |
|
CSCIWManagementServer |
○ |
○ |
案件運用操作 |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(J2EEアプリケーション) |
○ |
○ |
CSCIWライブラリを使用した業務アプリケーション(Javaアプリケーション) |
○ |
○ |
アプリケーション呼び出しサービス |
×※ |
○ |
RESTサービス |
○ |
○ |
運用管理RESTサービス |
○ |
○ |
同一マシンでのほかのコマンド |
× |
○ |
異なるマシンでの同一コマンド |
× |
○ |
異なるマシンでのほかのコマンド |
× |
○ |
DBMS |
○ |
× |
- (凡例)
-
○:コマンドを実行できます。
×:コマンドを実行できません。
- 注※
-
-
-listオプションを指定する場合は,アプリケーション呼び出しサービスの起動中でもコマンドを実行できます。
-
-chgオプションを指定する場合は,「アプリケーション呼び出しサービス起動中に実行できる操作」を参照してください。
-
- アプリケーション呼び出しサービス起動中に実行できる操作
-
アプリケーション呼び出しサービスが起動中の場合,次の操作ができます。
-
アプリケーション呼び出しグループ定義の表示
-
アプリケーション呼び出しグループ定義の追加,変更,または削除
ただし,追加,変更,または削除できるのは,対象のref識別子を持つ作業が生成されていない場合だけです。例を次に示します。
-
追加または変更対象のref識別子を使用しているビジネスプロセス定義が未登録の場合,対象のref識別子のアプリケーション呼び出しグループ定義を追加または変更できます。
-
削除対象のref識別子を使用しているビジネスプロセス定義をすべて削除したあとに,対象のref識別子のアプリケーション呼び出しグループ定義を削除できます。
-
-
引数
- -sid <system_id>
-
環境構築時に設定したシステムIDを指定します。指定したシステムIDに対応するアプリケーション呼び出しグループ定義が対象になります。
指定できる値は,半角英大文字と半角数字で5文字以内です。ただし,先頭には半角英大文字を指定してください。
- -list
-
アプリケーション呼び出しグループ定義を標準出力に表示する場合に指定します。
アプリケーション呼び出しグループ定義ファイルのフォーマットに従って,行頭に「#」が書かれた状態(コメントアウトされた状態)で出力されます。出力結果をリダイレクトしてファイルに保存し,変更したい行を編集したり,-apgfオプションに指定したりできます。
アプリケーション呼び出しグループ定義の出力例を次に示します。
#UPDATEOPTION,TYPE,ID,GROUPNAME #,err,ref002,Group01 #,msg,ref002,Group01 #,msg,ref003,Group01 #,ope,ref002,Group01 #,ope,ref003,Group01 #,err,ref003,Group02
所属グループ(GROUPNAME),種別(TYPE),ref識別子(ID)の順でソートして表示されます。
- -chg
-
アプリケーション呼び出しグループ定義を変更する場合に指定します。-chgオプションを指定すると,アプリケーション呼び出しグループ定義ファイルの内容がチェックされます。チェック結果に問題がなければ,アプリケーション呼び出しグループ定義が更新されます。アプリケーション呼び出しグループ定義ファイルの最後の行までチェックが実施され,エラーがあればコマンドが終了します。
- -apgf <application_call_group_file>
-
-chgオプションを指定してアプリケーション呼び出しグループ定義を変更する場合に,変更内容が書かれたアプリケーション呼び出しグループ定義ファイルのファイル名を指定します。
戻り値
戻り値 |
内容 |
---|---|
0 |
正常終了 |
1 |
致命的なエラー |
9※ |
実行権限エラー |
51 |
パラメーター不正 |
100 |
アプリケーション呼び出しグループ定義ファイルの内容の不正 |
150 |
アプリケーション呼び出しグループ定義ファイルのアクセスエラー |
254 |
異常終了 |
- 注※
-
Windowsの場合だけ発生します。
注意事項
アプリケーション呼び出しグループ定義に登録したグループは,アプリケーション呼び出し制御情報に登録する必要があります。登録しなかった場合,そのグループに登録したref識別子が呼び出されません。