15.2.5 共通設定ファイルに指定する内容
共通設定ファイルに指定する内容について説明します。
指定するパラメタの一覧(共通設定ファイル)
共通設定ファイルに指定するパラメタの一覧を示します。
項番 |
パラメタ名 |
カテゴリ |
指定内容 |
---|---|---|---|
1 |
BPMN連携機能共通 |
ログ出力先ディレクトリ |
|
2 |
REST API |
BPMNビジネスプロセス定義ファイル格納先ディレクトリ |
|
3 |
BPMN連携機能共通 |
アプリケーション呼び出し情報ファイルの格納先ディレクトリおよびコールアクティビティ情報ファイルの格納先ディレクトリ |
|
4 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスのポーリング間隔 |
|
5 |
REST API |
デフォルト最大取得数 |
|
6 |
REST API |
デフォルトユーザ記述子 |
|
7 |
REST API |
RESTサービスのAPIが呼び出される際のトランザクションタイムアウト値 |
|
8 |
REST API |
REST APIのフィルター条件とソート条件に指定された内容に,キーワードが含まれるかチェックするかどうかの値 |
|
9 |
REST API |
REST APIのフィルター条件とソート条件に指定された内容に,含まれているかチェックするキーワード |
|
10 |
REST API |
RESTサービスメッセージファイルの面数 |
|
11 |
REST API |
RESTサービストレースファイルの面数 |
|
12 |
REST API |
RESTサービスメッセージファイルの出力サイズ |
|
13 |
REST API |
RESTサービストレースファイルの出力サイズ |
|
14 |
REST API |
RESTサービスメッセージ出力レベル |
|
15 |
REST API |
RESTサービストレース出力レベル |
|
16 |
REST API |
RESTサービスメッセージファイルを削除するまでの日数 |
|
17 |
REST API |
RESTサービストレースファイルを削除するまでの日数 |
|
18 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスメッセージファイルの面数 |
|
19 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービストレースファイルの面数 |
|
20 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスメッセージファイルの出力サイズ |
|
21 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービストレースファイルの出力サイズ |
|
22 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスメッセージ出力レベル |
|
23 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービストレース出力レベル |
|
24 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスメッセージファイルを削除するまでの日数 |
|
25 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービストレースファイルを削除するまでの日数 |
|
26 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスのトランザクションタイムアウト値 |
|
27 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスとRESTアプリケーション間で送受信するボディデータのトレースファイル出力の有無 |
|
28 |
アプリケーション呼び出しサービス |
アプリケーション呼び出しサービスの初回ポーリング間隔 |
|
29 |
BPMN連携機能共通 |
強制終了イベントに遷移した際の動作について,CSCIWのバージョン03-10までとの互換性の有無 |
- 〈この項の構成〉
(1) BpmnLogFileDir
共通設定ファイルに指定するBpmnLogFileDirパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
- |
可 |
|
(凡例):
-:指定できる値の範囲に,制限はありません。
説明
次のログファイルの出力先ディレクトリを指定します。
-
RESTサービストレースファイル
-
RESTサービスメッセージファイル
-
アプリケーション呼び出しサービストレースファイル
-
アプリケーション呼び出しサービスメッセージファイル
(2) BpmnDefinitionFileDir
共通設定ファイルに指定するBpmnDefinitionFileDirパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
- |
可 |
|
(凡例):
-:指定できる値の範囲に,制限はありません。
説明
BPMNビジネスプロセス定義ファイルを格納するディレクトリを指定します。
(3) BpmnCallInformationFileDir
共通設定ファイルに指定するBpmnCallInformationFileDirパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
- |
可 |
|
(凡例):
-:指定できる値の範囲に,制限はありません。
説明
アプリケーション呼び出しサービスが呼び出し処理を実行する際に読み込む「アプリケーション呼び出し情報ファイル」と,BPMN連携機能がコールアクティビティに関して処理する際に読み込む「コールアクティビティ情報ファイル」の格納先ディレクトリを指定します。
アプリケーション呼び出しサービスは,このパラメタで設定されたディレクトリ配下のmsgフォルダ,opeフォルダ,sigフォルダ,およびerrフォルダに格納された各アプリケーション呼び出し情報ファイルを読み込みます。また,BPMN連携機能は,設定されたディレクトリ配下のcallフォルダに格納されたコールアクティビティ情報ファイルを読み込みます。そのため,このパラメタで指定したディレクトリ直下に,次のフォルダがすべて存在している必要があります。
-
call
-
err
-
msg
-
ope
-
sig
(4) AppCallServicePollingInterval
共通設定ファイルに指定するAppCallServicePollingIntervalパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~86,400の整数 |
可 |
60 |
説明
アプリケーション呼び出しサービスのポーリング間隔を秒単位で指定します。
このパラメタで指定した秒数ごとに,アプリケーション呼び出しサービスのプロセスを実行します。
このパラメタに短い秒数を指定した場合,データベースの検索が頻繁に発生するため,60以上の値を指定することを推奨します。
(5) RestServiceResponseMaxCount
共通設定ファイルに指定するRestServiceResponseMaxCountパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~2,147,483,647の整数 |
可 |
100 |
説明
デフォルト最大取得数を指定します。
RESTサービスの一覧取得APIが呼び出される際に最大取得数が指定されていない場合,このパラメタで指定した値がデフォルト値として使用されます。
-1を指定した場合,すべてのデータを取得します。
(6) RestServiceUserDescription
共通設定ファイルに指定するRestServiceUserDescriptionパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~32バイトの文字列 |
可 |
csciwws |
説明
デフォルトユーザ記述子を指定します。
RESTサービスのAPIが呼び出される際にユーザ記述子が指定されていない場合,このパラメタで指定した値がデフォルト値として使用されます。
(7) RestServiceTransactionTimeout
共通設定ファイルに指定するRestServiceTransactionTimeoutパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
0~2,147,483,647の整数 |
可 |
0 |
説明
RESTサービスのAPIが呼び出される際のトランザクションタイムアウト値を秒単位で指定します。
0を指定した場合,J2EEサーバの設定値(J2EEサーバ用ユーザプロパティファイルusrconf.propertiesのejbserver.jta.TransactionManager.defaultTimeOutの設定値)が指定されたと見なされます。
(8) RestServiceParamStatementCheck
共通設定ファイルに指定するRestServiceParamStatementCheckパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
trueまたはfalse |
可 |
false |
説明
REST APIのフィルター条件とソート条件に指定された内容に,「RestServiceParamPreventStatements」で指定したキーワードが含まれているか,チェックするかどうかを指定します。
trueを指定した場合,キーワードが含まれているかチェックします。フィルター条件またはソート条件にキーワードが含まれていると,エラーになります。
falseを指定した場合,キーワードのチェックはしません。
共通設定ファイルの初期値には,trueが設定されています。
(9) RestServiceParamPreventStatements
共通設定ファイルに指定するRestServiceParamPreventStatementsパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
半角英数字,アンダースコア,およびコンマ |
可 |
空文字 |
説明
「RestServiceParamStatementCheck」にtrueが指定されている場合,フィルター条件とソート条件に指定された内容に含まれているかチェックするキーワードを指定します。
キーワードを複数指定する場合はコンマ区切りで指定してください。大文字と小文字は区別しません。
共通設定ファイルの初期値には,SELECTが設定されています。
(10) RestServiceMsgFileNum
共通設定ファイルに指定するRestServiceMsgFileNumパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~16の整数 |
可 |
2 |
説明
RESTサービスメッセージファイルの面数を指定します。
ラップアラウンドモードの場合,出力面数を指定してください。シフトモードの場合,バックアップ面数を指定してください。
(11) RestServiceTraceFileNum
共通設定ファイルに指定するRestServiceTraceFileNumパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~16の整数 |
可 |
4 |
説明
RESTサービストレースファイルの面数を指定します。
ラップアラウンドモードの場合,出力面数を指定してください。シフトモードの場合,バックアップ面数を指定してください。
(12) RestServiceMsgFileSize
共通設定ファイルに指定するRestServiceMsgFileSizeパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
100,000~2,147,483,647の整数 |
可 |
2097152 |
説明
RESTサービスメッセージファイルの出力サイズをバイト単位で指定します。
(13) RestServiceTraceFileSize
共通設定ファイルに指定するRestServiceTraceFileSizeパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
100,000~2,147,483,647の整数 |
可 |
16777216 |
説明
RESTサービストレースファイルの出力サイズをバイト単位で指定します。
(14) RestServiceMsgOutputThreashold
共通設定ファイルに指定するRestServiceMsgOutputThreasholdパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~1,000の整数 |
可 |
20 |
説明
RESTサービスメッセージ出力レベルを指定します。
0以上の値を指定すると,指定した値以下のレベルのRESTサービスメッセージが出力されます。
-1を指定した場合,RESTサービスメッセージは出力されません。
(15) RestServiceTraceOutputThreashold
共通設定ファイルに指定するRestServiceTraceOutputThreasholdパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~1,000の整数 |
可 |
20 |
説明
RESTサービストレース出力レベルを指定します。
0以上の値を指定すると,指定した値以下のレベルのRESTサービストレースが出力されます。
-1を指定した場合,RESTサービストレースは出力されません。
(16) RestServiceMsgTimeToDelete
共通設定ファイルに指定するRestServiceMsgTimeToDeleteパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~24,855の整数 |
可 |
-1 |
説明
RESTサービスメッセージファイルを削除するまでの日数を指定します。
このパラメタは,ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合,出力されたRESTサービスメッセージファイルはすぐに削除されます。
-1を指定した場合,日数が経過してもファイルは削除されません。
(17) RestServiceTraceTimeToDelete
共通設定ファイルに指定するRestServiceTraceTimeToDeleteパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~24,855の整数 |
可 |
-1 |
説明
RESTサービストレースファイルを削除するまでの日数を指定します。
このパラメタは,ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合,出力されたRESTサービストレースファイルはすぐに削除されます。
-1を指定した場合,日数が経過してもファイルは削除されません。
(18) AppCallServiceMsgFileNum
共通設定ファイルに指定するAppCallServiceMsgFileNumパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~16の整数 |
可 |
2 |
説明
アプリケーション呼び出しサービスメッセージファイルの面数を指定します。
ラップアラウンドモードの場合,出力面数を指定してください。シフトモードの場合,バックアップ面数を指定してください。
(19) AppCallServiceTraceFileNum
共通設定ファイルに指定するAppCallServiceTraceFileNumパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
1~16の整数 |
可 |
4 |
説明
アプリケーション呼び出しサービストレースファイルの面数を指定します。
ラップアラウンドモードの場合,出力面数を指定してください。シフトモードの場合,バックアップ面数を指定してください。
(20) AppCallServiceMsgFileSize
共通設定ファイルに指定するAppCallServiceMsgFileSizeパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
100,000~2,147,483,647の整数 |
可 |
2097152 |
説明
アプリケーション呼び出しサービスメッセージファイルの出力サイズをバイト単位で指定します。
(21) AppCallServiceTraceFileSize
共通設定ファイルに指定するAppCallServiceTraceFileSizeパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
100,000~2,147,483,647の整数 |
可 |
16777216 |
説明
アプリケーション呼び出しサービストレースファイルの出力サイズをバイト単位で指定します。
(22) AppCallServiceMsgOutputThreashold
共通設定ファイルに指定するAppCallServiceMsgOutputThreasholdパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~1,000の整数 |
可 |
20 |
説明
アプリケーション呼び出しサービスメッセージ出力レベルを指定します。
0以上の値を指定すると,指定した値以下のレベルのアプリケーション呼び出しサービスメッセージが出力されます。
-1を指定した場合,アプリケーション呼び出しサービスメッセージは出力されません。
(23) AppCallServiceTraceOutputThreashold
共通設定ファイルに指定するAppCallServiceTraceOutputThreasholdパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~1,000の整数 |
可 |
20 |
説明
アプリケーション呼び出しサービストレース出力レベルを指定します。
0以上の値を指定すると,指定した値以下のレベルのアプリケーション呼び出しサービストレースが出力されます。
-1を指定した場合,アプリケーション呼び出しサービストレースは出力されません。
(24) AppCallServiceMsgTimeToDelete
共通設定ファイルに指定するAppCallServiceMsgTimeToDeleteパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~24,855の整数 |
可 |
-1 |
説明
アプリケーション呼び出しサービスメッセージファイルを削除するまでの日数を指定します。
このパラメタは,ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合,出力されたアプリケーション呼び出しサービスメッセージファイルはすぐに削除されます。
-1を指定した場合,日数が経過してもファイルは削除されません。
(25) AppCallServiceTraceTimeToDelete
共通設定ファイルに指定するAppCallServiceTraceTimeToDeleteパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
-1~24,855の整数 |
可 |
-1 |
説明
アプリケーション呼び出しサービストレースファイルを削除するまでの日数を指定します。
このパラメタは,ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合,出力されたアプリケーション呼び出しサービストレースファイルはすぐに削除されます。
-1を指定した場合,日数が経過してもファイルは削除されません。
(26) AppCallServiceTransactionTimeout
共通設定ファイルに指定するAppCallServiceTransactionTimeoutパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
0~2,147,483,647の整数 |
可 |
0 |
説明
アプリケーション呼び出しサービスのトランザクションタイムアウト値を秒単位で指定します。
0を指定した場合,J2EEサーバの設定値(J2EEサーバ用ユーザプロパティファイルusrconf.propertiesのejbserver.jta.TransactionManager.defaultTimeOutの設定値)が指定されたと見なされます。
1以上の値を指定した場合,トランザクションタイムアウト値(秒)が指定されたと見なされます。
(27) AppCallServiceDebugRestBody
共通設定ファイルに指定するAppCallServiceDebugRestBodyパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
trueまたはfalse |
可 |
false |
説明
アプリケーション呼び出しサービスとRESTアプリケーションの間で送受信するボディデータ(リクエストボディとレスポンスボディ)の内容を,トレースファイルに出力するかどうかを指定します。
trueを指定した場合,ボディデータの内容をXML形式でトレースファイルに出力します。XSLTスタイルシートを使用してボディデータをスキーマ変換した場合は,変換前と変換後の両方の内容を出力します。なお,trueを指定すると,アプリケーション呼び出しのスループットが低下するおそれがあります。
falseを指定した場合,ボディデータの内容をトレースファイルに出力しません。
(28) AppCallServiceInitialInterval
共通設定ファイルに指定するAppCallServiceInitialIntervalパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
0~86,400の整数 |
可 |
0 |
説明
アプリケーション呼び出しサービスの開始後,最初のポーリングを行うまでの時間を秒単位で指定します。指定された秒数の経過後,アプリケーション呼び出しを定期的に実行します。
このパラメタは,アプリケーション呼び出しサービスの開始後,一定時間経過後にアプリケーション呼び出しを実行したい場合だけ指定してください。
(29) TerminateCompatMode
共通設定ファイルに指定するTerminateCompatModeパラメタについて,説明します。
ユーザ指定値
値の範囲 |
パラメタの指定の省略 |
指定を省略したときの仮定値 |
---|---|---|
trueまたはfalse |
可 |
true |
説明
強制終了イベントに遷移した際の動作をCSCIWのバージョン03-10までと互換性を持たせるかどうかを指定します。
true(03-10までと同じ動作)を指定した場合,サブプロセス内およびイベントサブプロセス内の強制終了イベントに遷移した際に,案件自体を強制終了します。
falseを指定した場合,サブプロセス内およびイベントサブプロセス内の強制終了イベントに遷移した際に,サブプロセス内だけを強制終了します。