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