2.2 プロパティファイル(config_user.properties)
ログ,タスク,JP1イベントなどJP1/AOの各種設定をするための定義ファイルです。
形式
指定キー名=設定値
格納先フォルダ
- 非クラスタシステムの場合
-
JP1/AOのインストール先フォルダ¥confまたは/opt/jp1ao/conf
- クラスタシステムの場合
-
共有フォルダ名¥jp1ao¥confまたは共有フォルダ名/jp1ao/conf
定義の反映契機
サービス(HAutomation Engine Web Service)の再起動
記述内容
指定キー名と設定値を1行に1つずつ指定します。プロパティファイルを記述するときは,次の点に注意してください。
-
「#」で始まる行はコメント行として扱われます。
-
空白行は無視されます。
-
エンコーディングはISO8859-1です。
-
大文字と小文字は区別されます。
-
指定する文字列内に「¥」が含まれる場合は,「¥¥」と記述する必要があります。
この場合,「¥¥」で1バイトとしてサイズを計算してください。
-
設定値が有効な値ではない場合,メッセージKNAE02022-Wが統合トレースログおよび公開ログに出力され,デフォルト値が設定されます。
-
同一の指定キーをファイル内に複数指定した場合は,あとに指定したものが有効となります。
設定項目
分類 |
キー名 |
設定項目 |
設定できる値 |
デフォルト値 |
---|---|---|---|---|
ログ※1 |
logger.message.server.MaxBackupIndex |
サーバ用ログバックアップファイルの最大面数を指定する。 |
1〜16 |
7 |
logger.message.server.MaxFileSize |
サーバ用ログファイルサイズの最大値(単位:KB)を指定する。 |
4〜2097151 |
1024 |
|
logger.message.command.MaxBackupIndex |
コマンド用ログバックアップファイルの最大面数を指定する。 |
1〜16 |
7 |
|
logger.message.command.MaxFileSize |
コマンド用ログファイルサイズの最大値(単位:KB)を指定する。 |
4〜2097151 |
1024 |
|
logger.TA.MaxFileSize |
タスク用ログファイルサイズの最大値(単位:KB)を指定する。 |
4〜2097151 |
10240 |
|
タスク管理 |
task.ajs.IPBindhost |
JP1/Baseの通信方式をIPバインド方式にしている場合に,JP1/AOのホスト名またはIPアドレスを0〜255バイトで指定する。 |
ホスト名またはIPアドレスに指定できる文字列 |
" "(空文字) |
tasklist.autoarchive.taskRemainingPeriod |
実行が終了したタスクをタスク一覧に保持する期間(単位:日)を指定する。 |
1〜90 |
7 |
|
tasklist.autoarchive.executeTime |
次の処理を実行する時刻を指定する。
この時刻に,データベースの無効領域の解放も実施されます。 |
00:00:00〜23:59:59 |
04:00:00 |
|
tasklist.autoarchive.maxTasks |
タスク一覧に保持するタスクおよびデバッグタスク一覧に保持するデバッグタスクの合計の最大数を指定する。 |
100〜5000 |
5000 |
|
tasklist.autodelete.maxHistories |
保持する履歴の最大数を指定する。 |
100〜30000 |
30000 |
|
task.details.jobnet.status.visible |
[タスク詳細]ダイアログボックスでのステップ一覧の表示内容を,タスク処理エンジンでの状態にするか,ステップの状態にするかを指定する。 |
|
false |
|
部品のローカル実行 |
plugin.localMode |
ローカル実行機能を使用するかどうかを指定する。 |
|
false |
サービス管理 |
packagemanager.extraPresets.maxFiles |
1つのサービステンプレートに追加できるプリセットプロパティ定義ファイルの最大数を指定する。 |
5〜100 |
5 |
JP1イベントの通知 |
notification.jp1event |
通知機能としてJP1イベントを送信するかどうかを指定する。 |
|
true |
部品実行 |
plugin.threadPoolSize |
通常のタスクに含まれる部品の同時実行数を指定する。 |
|
10 |
繰り返し |
foreach.max_value |
繰り返し実行部品で同時実行できる最大数を指定する。 |
1〜99 |
3 |
リモート接続ポート番号 |
ssh.port.number |
操作対象機器のSSHポート番号を指定する。 |
0〜65535 |
22 |
telnet.port.number |
操作対象機器のTelnetポート番号を指定する。 |
0〜65535 |
23 |
|
ターミナル接続 |
plugin.terminal.prompt.account |
ユーザーIDの入力待ち状態であることを検知するための,正規表現パターンを1〜1,024文字で指定する。操作対象の機器にTelnetで接続する場合,ターミナル接続部品は,標準出力および標準エラー出力が指定した正規表現パターンと合致したときに,ユーザーIDの入力待ち状態であると検知し,ユーザーIDを入力する。 |
正規表現パターンで使用できる文字列 |
login|Login Name|Username|UserName |
plugin.terminal.prompt.password |
パスワードの入力待ち状態であることを検知するための,正規表現パターンを1〜1,024文字で指定する。操作対象の機器にTelnetで接続する場合,ターミナル接続部品は,標準出力および標準エラー出力が指定した正規表現パターンと合致したときに,パスワードの入力待ち状態であると検知し,パスワードを入力する。 |
正規表現パターンで使用できる文字列 |
password|Password|PassWord |
|
telnet.connect.wait |
操作対象機器にTelnet接続したあと,標準出力が返るまでの待ち時間(単位:秒)を指定する。 |
1〜600 |
60 |
|
ssh.privateKeyFile |
SSH接続で公開鍵認証を使用する場合に,秘密鍵ファイルの絶対パスを指定する。 |
0〜255文字の文字列 |
" "(空文字) |
|
リモートコマンド |
plugin.remoteCommand.executionDirectory.wmi |
操作対象機器のOSがWindowsの場合,コンテンツ部品を実行するための実行ディレクトリのパスを指定する。なお,実行ディレクトリは事前に作成しておく必要がある。 コンテンツ部品の「実行モード」が「スクリプト」の場合,ここで指定した値と,スクリプトファイル名の合計の文字列長が140文字以下になるようにする必要がある。140文字を超える場合,スクリプトファイルの転送に失敗することがある。なお,スクリプトファイル名は90文字以内で指定するため,ここで指定する値は,50文字以内とすることをお勧めする。 |
0〜128文字の文字列 |
" "(空文字) |
plugin.remoteCommand.executionDirectory.ssh |
操作対象機器のOSがUNIXの場合,コンテンツ部品を実行するための実行ディレクトリのパスを指定する。なお,実行ディレクトリは事前に作成しておく必要がある。 |
0〜128文字の文字列 |
" "(空文字) |
|
plugin.remoteCommand.workDirectory.ssh※2 |
操作対象の機器のOSがUNIXの場合,ファイル転送部品またはコンテンツ部品を実行したときに使用する作業用フォルダ※3を指定する。絶対パス(1〜128文字)で,フォルダまたはシンボリックリンクを入力する。なお,シンボリックリンクをパスの階層に含めることもできる。 |
半角英数字,および次の記号です。 「/」(パスの区切り文字として指定できる),「-」,「_」,「.」 |
/tmp/Hitachi_AO |
|
リモートホスト接続リトライ |
ssh.connect.retry.times |
操作対象機器へのSSH接続に失敗した場合のリトライ回数を指定する。 |
0〜100 |
3 |
ssh.connect.retry.interval |
操作対象機器へのSSH接続に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1〜600 |
10 |
|
wmi.connect.retry.times |
操作対象機器へのWMI接続に失敗した場合のリトライ回数を指定する。 |
0〜100 |
3 |
|
wmi.connect.retry.interval |
操作対象機器へのWMI接続に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1〜600 |
10 |
|
telnet.connect.retry.times |
操作対象機器へのTelnet接続に失敗した場合のリトライ回数を指定する。 |
0〜100 |
3 |
|
telnet.connect.retry.interval |
操作対象機器へのTelnet接続に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1〜600 |
10 |
|
リモートファイル操作リトライ |
plugin.remoteFileAccess.retry.times |
コンテンツ部品とファイル転送部品が内部で実行するファイルを操作するコマンドのリトライ回数を指定する。なお,リトライの間隔は100ms固定である。 一時的なファイルアクセスのエラーが発生した場合でも,リトライを行うことで成功する場合がある。しかし,ファイルアクセスのエラーが回復しない場合は,部品の終了までに,リトライを行う時間分だけ余分に時間がかかる。このプロパティは,ディスクなどに問題がないにも関わらず,ファイルアクセスのエラーが発生する環境で設定する。 |
0〜100 |
0 |
メール送信リトライ |
mail.notify.retry.times |
通知機能でメール送信に失敗した場合のリトライ回数を指定する。 |
0〜100 |
3 |
mail.notify.retry.interval |
通知機能でメール送信に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1〜600 |
10 |
|
mail.plugin.retry.times |
メール通知部品でメール送信に失敗した場合のリトライ回数を指定する。 |
0〜100 |
3 |
|
mail.plugin.retry.interval |
メール通知部品でメール送信に失敗した場合のリトライ間隔(単位:秒)を指定する。 |
1〜600 |
10 |
|
監査ログ |
logger.Audit.enable |
監査ログを出力するかどうかを指定する。 |
|
0 |
logger.Audit.path |
監査ログの出力先パスを1〜244バイトで指定する。 |
半角英数字,半角スペース,および次の記号です。 「!」,「#」,「$」,「&」,「(」,「)」,「+」,「,」,「-」,「.」,「;」,「=」,「@」,「[」,「]」,「?」,「_」,「`」,「{」,「}」,「~」 |
|
|
logger.Audit.MaxBackupIndex |
監査ログ用ログバックアップファイルの最大面数を指定する。 |
1〜16 |
7 |
|
logger.Audit.MaxFileSize |
監査ログ用ログファイルサイズの最大値(単位:KB)を指定する。 |
4〜2097151 |
1024 |
|
logger.Audit.command.useLoginUserID※5 |
コマンド実行時の監査ログのサブジェクト識別情報に出力するユーザーIDを,JP1/AOのログインユーザーIDに切り替えるかどうかを指定する。 |
|
false |
|
画面更新 |
client.events.refreshinterval |
イベントの更新間隔(単位:秒)を指定する。 |
0〜65535 |
5 |
Link&Launch機能 |
linkandlaunch.hcs.enabled |
Hitachi Command Suite製品へのリンクを[ツール]メニューに表示するかどうかを指定する。 |
|
false |
エディタ |
client.editor.upload.maxfilesize |
[エディタ]画面から,次のファイルをアップロードする場合に,指定できるそれぞれのファイルサイズの最大値(単位:MB)を指定する。
|
1〜10 |
3 |
server.editor.step.perTemplate.maxnum※6 |
1サービステンプレートあたりの最大ステップ数を指定する。 |
320〜40000 ※7 |
320 |
|
server.editor.step.perLayer.maxnum※6 |
1階層あたりの最大ステップ数を指定する。 |
80〜10000 ※7 |
80 |
|
client.editor.canvas.maxwidth※6 |
[フロー]ビューの操作領域の最大横幅サイズ(単位:px)を指定する。 見積もり式は,次のとおりです。 横幅サイズ(px) = (横1列に配置したいステップ数 + 1) × 90(px) |
3600〜10000 |
3600 |
|
client.editor.canvas.maxhigh※6 |
[フロー]ビューの操作領域の最大縦幅サイズ(単位:px)を指定する。 見積もり式は,次のとおりです。 縦幅サイズ(px) = 縦1列に配置したいステップ数 × 300(px) |
2400〜30000 |
2400 |
|
デバッグ |
tasklist.debugger.autodelete.taskRemainingPeriod |
実行が終了したデバッグタスクをデバッグタスク一覧に保持する期間(単位:日)を指定する。 |
1〜90 |
7 |
client.debugger.tasklog.maxfilesize |
[タスクログ]タブに表示するタスクログのサイズ(単位:KB)を指定する。 |
4〜10240 |
1024 |
|
logger.debugger.TA.MaxFileSize |
デバッグタスク用ログファイルサイズの最大値(単位:KB)を指定する。 |
4〜2097151 |
10240 |
|
タスクモニタ |
client.monitor.tasklog.maxfilesize |
[タスクログ]ダイアログに表示するタスクログのサイズ(単位:KB)を指定する。 |
4〜10240 |
1024 |
client.monitor.tasklog.refresh.interval |
[タスクログ]ダイアログの自動更新間隔(単位:秒)を指定する。 |
30〜300 |
30 |
|
client.monitor.status.interval |
タスクモニタの自動更新間隔(単位:秒)を指定する。 |
30〜300 |
30 |
- 注※1
-
タスク用ログの出力しきい値は,サービス共有プロパティで設定できます。
- 注※2
-
このプロパティで指定したパスや親フォルダのパスを,ファイル転送部品の送信先フォルダや受信元フォルダに指定しないでください。指定した場合は,製品サポートの対象外となります。
- 注※3
-
-
作業用フォルダには,接続ユーザーに対する読み込み権限,書き込み権限,および実行権限が必要となります。
-
ファイル転送部品またはコンテンツ部品を実行した際に,作業用フォルダのアクセス権を777(すべてのユーザーにアクセス権を設定)に変更します。作業用フォルダに指定したパスが存在しない場合,部品の実行時に作業用フォルダが作成されます。なお,フォルダの作成に失敗した場合,部品の実行は異常終了します。
-
- 注※4
-
出力するファイル名は「Audit[n].log」です。[n]には面数の整数値が入ります。
- 注※5
-
監査ログのサブジェクト識別情報に出力されるユーザーIDが切り替わるコマンドを次に示します。
-
deleteservicetemplateコマンド
-
importservicetemplateコマンド
-
listservicesコマンド
-
listtasksコマンド
-
stoptaskコマンド
-
submittaskコマンド
-
- 注※6
-
これらの定義は,JP1/AO 10-02以前との互換用プロパティです。
- 注※7
-
これらの定義は,次の条件すべてに合致する場合だけ編集してください。これらの条件に合致しない場合は,定義を編集する必要はありません。なお,定義を編集する場合は,サービステンプレートの複製および編集をする前に実施してください。
-
10-02以前のJP1/AOで作成したサービステンプレートを編集する場合
-
編集するサービステンプレートのステップの合計が320を超えている,または1階層あたりのステップ数が80を超えている場合
-
定義例
logger.message.server.MaxBackupIndex = 7 logger.message.server.MaxFileSize = 1024 logger.message.command.MaxBackupIndex = 7 logger.message.command.MaxFileSize = 1024 logger.TA.MaxFileSize = 10240 task.ajs.IPBindhost = tasklist.autoarchive.taskRemainingPeriod = 7 tasklist.autoarchive.executeTime = 04:00:00 tasklist.autoarchive.maxTasks = 5000 tasklist.autodelete.maxHistories = 30000 task.details.jobnet.status.visible = false plugin.localMode = false packagemanager.extraPresets.maxFiles = 5 plugin.remoteCommand.workDirectory.ssh = /tmp/Hitachi_AO notification.jp1event = true plugin.threadPoolSize = 10 foreach.max_value = 3 ssh.port.number = 22 telnet.port.number = 23 plugin.terminal.prompt.account = login|Login Name|Username|UserName plugin.terminal.prompt.password = password|Password|PassWord telnet.connect.wait = 60 ssh.connect.retry.times = 3 ssh.connect.retry.interval = 10 wmi.connect.retry.times = 3 wmi.connect.retry.interval = 10 telnet.connect.retry.times = 3 telnet.connect.retry.interval = 10 mail.notify.retry.times = 3 mail.notify.retry.interval = 10 mail.plugin.retry.times = 3 mail.plugin.retry.interval = 10 logger.Audit.enable = 0 logger.Audit.path = C:\\Program Files (x86)\\Hitachi\\JP1AO\\logs logger.Audit.MaxBackupIndex = 7 logger.Audit.MaxFileSize = 1024 logger.Audit.command.useLoginUserID = false client.events.refreshinterval = 5 linkandlaunch.hcs.enabled = false client.editor.upload.maxfilesize = 3 server.editor.step.perTemplate.maxnum = 320 server.editor.step.perLayer.maxnum = 80 client.editor.canvas.maxwidth = 3600 client.editor.canvas.maxhigh = 2400 tasklist.debugger.autodelete.taskRemainingPeriod = 7 client.debugger.tasklog.maxfilesize = 1024 logger.debugger.TA.MaxFileSize = 10240 client.monitor.tasklog.maxfilesize = 1024 client.monitor.tasklog.refresh.interval = 30 client.monitor.status.interval = 30
関連トピック