付録H.11 共通設定ファイル
共通設定ファイルの詳細について説明します。
- 〈この項の構成〉
(1) 共通設定ファイルの概要
共通設定ファイルとは，ポーリング間隔などを設定するファイルを指します。
(2) 共通設定ファイルの設定個所
共通設定ファイルの設定個所について説明します。
共通設定ファイルは，次のパスに格納してください。
-
CSCIW_CONF_DIR環境変数が設定されていない場合
Windowsの場合
%CSCIW_HOME%\bpmn\conf\csciwbpmnconf.properties
UNIXの場合
${CSCIW_HOME}/bpmn/conf/csciwbpmnconf.properties -
CSCIW_CONF_DIR環境変数が設定されている場合
共通設定ファイルの格納先を，対応するシステムIDのセットアッププロパティファイル（csciwsetup.properties）と同じ格納先にしてください。
Windowsの場合
%CSCIW_CONF_DIR%\csciwbpmnconf.properties
UNIXの場合
${CSCIW_CONF_DIR}/csciwbpmnconf.properties
(3) 共通設定ファイルの読み込みタイミング
共通設定ファイルの読み込みタイミングについて説明します。
読み込みタイミングは，パラメタのカテゴリごとに異なります。各パラメタがどのカテゴリに属するかについては，「付録H.11(5) 共通設定ファイルに指定するパラメタ一覧および内容」を参照してください。
カテゴリごとの読み込みタイミングを次に示します。
-
パラメタのカテゴリが「共通」のとき
J2EEサーバを起動後，初めてアプリケーション呼び出しサービスを開始した時に読み込まれます（J2EEサーバを起動後，1回だけ読み込まれます）。
-
パラメタのカテゴリが「アプリケーション呼び出しサービス」のとき
アプリケーション呼び出しサービスを開始した時に読み込まれます。
一度読み込まれた共通設定ファイルのパラメタを変更する方法については，「6.2.8(1) ファイルに格納した設定情報を変更する」の，共通設定ファイルの内容を変更した場合についての記述を参照してください。
(4) 共通設定ファイルの記述規則
共通設定ファイルの記述時の規則について説明します。
共通設定ファイルは，Javaのプロパティファイルの仕様と同じです。値に「\」を記述する場合，「\」の前に「\」をエスケープ文字として記述してください。また，ファイルのエンコーディングはUTF-8とし，BOMを付けないで保存してください。
CSCIW 02-20以前で使用していた共通設定ファイル（Unicode形式のファイルを含む）を，そのまま使用することもできます。
(5) 共通設定ファイルに指定するパラメタ一覧および内容
共通設定ファイルに指定する内容について説明します。
- 指定するパラメタの一覧（共通設定ファイル）
-
共通設定ファイルに指定するパラメタの一覧を示します。
表H‒4 指定するパラメタの一覧（共通設定ファイル） 項番
パラメタ名
カテゴリ
指定内容
1
共通
ログ出力先ディレクトリ
2
共通
アプリケーション呼び出し情報ファイルの格納先ディレクトリ
3
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスのポーリング間隔
4
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスメッセージファイルの面数
5
アプリケーション呼び出しサービス
アプリケーション呼び出しサービストレースファイルの面数
6
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスメッセージファイルの出力サイズ
7
アプリケーション呼び出しサービス
アプリケーション呼び出しサービストレースファイルの出力サイズ
8
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスメッセージ出力レベル
9
アプリケーション呼び出しサービス
アプリケーション呼び出しサービストレース出力レベル
10
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスメッセージファイルを削除するまでの日数
11
アプリケーション呼び出しサービス
アプリケーション呼び出しサービストレースファイルを削除するまでの日数
12
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスのトランザクションタイムアウト値
13
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスとRESTアプリケーション間で送受信するボディデータのトレースファイル出力の有無
14
アプリケーション呼び出しサービス
アプリケーション呼び出しサービスの初回ポーリング間隔
(a) BpmnLogFileDir
共通設定ファイルに指定するBpmnLogFileDirパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
−
可
- ＜Windowsの場合＞
-
%CSCIW_HOME%\log
- ＜UNIXの場合＞
-
${CSCIW_HOME}/log
- （凡例）
-
−：指定できる値の範囲に，制限はありません。
- 説明
-
次のログファイルの出力先ディレクトリを指定します。
-
アプリケーション呼び出しサービストレースファイル
-
アプリケーション呼び出しサービスメッセージファイル
-
(b) BpmnCallInformationFileDir
共通設定ファイルに指定するBpmnCallInformationFileDirパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
−
可
- ＜Windowsの場合＞
-
%CSCIW_HOME%\bpmn\callinfo
- ＜UNIXの場合＞
-
${CSCIW_HOME}/bpmn/callinfo
- （凡例）
-
−：指定できる値の範囲に，制限はありません。
- 説明
-
アプリケーション呼び出しサービスが呼び出し処理を実行する際に読み込む「アプリケーション呼び出し情報ファイル」の格納先ディレクトリを指定します。
アプリケーション呼び出しサービスは，このパラメタで設定されたディレクトリ配下のopeフォルダに格納された各アプリケーション呼び出し情報ファイルを読み込みます。そのため，このパラメタで指定したディレクトリ直下に，opeフォルダが存在している必要があります。
(c) AppCallServicePollingInterval
共通設定ファイルに指定するAppCallServicePollingIntervalパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
1〜86,400の整数
可
60
- 説明
-
アプリケーション呼び出しサービスのポーリング間隔を秒単位で指定します。
このパラメタで指定した秒数ごとに，アプリケーション呼び出しサービスのプロセスを実行します。
このパラメタに短い秒数を指定した場合，データベースの検索が頻繁に発生するため，60以上の値を指定することを推奨します。
(d) AppCallServiceMsgFileNum
共通設定ファイルに指定するAppCallServiceMsgFileNumパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
1〜16の整数
可
2
- 説明
-
アプリケーション呼び出しサービスメッセージファイルの面数を指定します。
ラップアラウンドモードの場合，出力面数を指定してください。シフトモードの場合，バックアップ面数を指定してください。
(e) AppCallServiceTraceFileNum
共通設定ファイルに指定するAppCallServiceTraceFileNumパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
1〜16の整数
可
4
- 説明
-
アプリケーション呼び出しサービストレースファイルの面数を指定します。
ラップアラウンドモードの場合，出力面数を指定してください。シフトモードの場合，バックアップ面数を指定してください。
(f) AppCallServiceMsgFileSize
共通設定ファイルに指定するAppCallServiceMsgFileSizeパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
100,000〜2,147,483,647の整数
可
2097152
- 説明
-
アプリケーション呼び出しサービスメッセージファイルの出力サイズをバイト単位で指定します。
(g) AppCallServiceTraceFileSize
共通設定ファイルに指定するAppCallServiceTraceFileSizeパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
100,000〜2,147,483,647の整数
可
16777216
- 説明
-
アプリケーション呼び出しサービストレースファイルの出力サイズをバイト単位で指定します。
(h) AppCallServiceMsgOutputThreashold
共通設定ファイルに指定するAppCallServiceMsgOutputThreasholdパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
-1〜1,000の整数
可
20
- 説明
-
アプリケーション呼び出しサービスメッセージ出力レベルを指定します。
0以上の値を指定すると，指定した値以下のレベルのアプリケーション呼び出しサービスメッセージが出力されます。
-1を指定した場合，アプリケーション呼び出しサービスメッセージは出力されません。
(i) AppCallServiceTraceOutputThreashold
共通設定ファイルに指定するAppCallServiceTraceOutputThreasholdパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
-1〜1,000の整数
可
20
- 説明
-
アプリケーション呼び出しサービストレース出力レベルを指定します。
0以上の値を指定すると，指定した値以下のレベルのアプリケーション呼び出しサービストレースが出力されます。
-1を指定した場合，アプリケーション呼び出しサービストレースは出力されません。
(j) AppCallServiceMsgTimeToDelete
共通設定ファイルに指定するAppCallServiceMsgTimeToDeleteパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
-1〜24,855の整数
可
-1
- 説明
-
アプリケーション呼び出しサービスメッセージファイルを削除するまでの日数を指定します。
このパラメタは，ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合，出力されたアプリケーション呼び出しサービスメッセージファイルはすぐに削除されます。
-1を指定した場合，日数が経過してもファイルは削除されません。
(k) AppCallServiceTraceTimeToDelete
共通設定ファイルに指定するAppCallServiceTraceTimeToDeleteパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
-1〜24,855の整数
可
-1
- 説明
-
アプリケーション呼び出しサービストレースファイルを削除するまでの日数を指定します。
このパラメタは，ローテーション種別がラップアラウンドモードの場合だけ有効です。
0を指定した場合，出力されたアプリケーション呼び出しサービストレースファイルはすぐに削除されます。
-1を指定した場合，日数が経過してもファイルは削除されません。
(l) AppCallServiceTransactionTimeout
共通設定ファイルに指定するAppCallServiceTransactionTimeoutパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
0〜2,147,483,647の整数
可
0
- 説明
-
アプリケーション呼び出しサービスのトランザクションタイムアウト値を秒単位で指定します。
0を指定した場合，J2EEサーバの設定値（J2EEサーバ用ユーザプロパティファイルusrconf.propertiesのejbserver.jta.TransactionManager.defaultTimeOutの設定値）が指定されたと見なされます。
1以上の値を指定した場合，トランザクションタイムアウト値（秒）が指定されたと見なされます。
(m) AppCallServiceDebugRestBody
共通設定ファイルに指定するAppCallServiceDebugRestBodyパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
trueまたはfalse
可
false
- 説明
-
アプリケーション呼び出しサービスとRESTアプリケーションの間で送受信するボディデータ（リクエストボディとレスポンスボディ）の内容を，トレースファイルに出力するかどうかを指定します。
trueを指定した場合，ボディデータの内容をXML形式でトレースファイルに出力します。XSLTスタイルシートを使用してボディデータをスキーマ変換した場合は，変換前と変換後の両方の内容を出力します。
なお，trueを指定すると，アプリケーション呼び出しのスループットが低下するおそれがあります。
falseを指定した場合，ボディデータの内容をトレースファイルに出力しません。
(n) AppCallServiceInitialInterval
共通設定ファイルに指定するAppCallServiceInitialIntervalパラメタについて，説明します。
- ユーザ指定値
-
値の範囲
パラメタの指定の省略
指定を省略したときの仮定値
0〜86,400の整数
可
0
- 説明
-
アプリケーション呼び出しサービスの開始後，最初のポーリングを行うまでの時間を秒単位で指定します。指定された秒数の経過後，アプリケーション呼び出しを定期的に実行します。
このパラメタは，アプリケーション呼び出しサービスの開始後，一定時間経過後にアプリケーション呼び出しを実行したい場合だけ指定してください。