Systemwalker IT Change Manager V14g 管理者ガイド

3.2.2 アプリケーション実行機能の動作設定ファイルの定義

アプリケーション実行機能の動作設定ファイルの定義について説明します。

ポイント

アプリケーション実行機能の動作設定ファイルの設定を変更する場合は、Systemwalker IT Change Managerを停止してから変更してください。また、変更後には、Systemwalker IT Change Managerを再起動してください。
Systemwalker IT Change Managerの起動と停止については、"4.6 Systemwalker IT Change Managerの起動/停止"を参照してください。

格納場所

動作設定ファイル（ae.ini）は、以下の場所に格納されています。

【Windows版】

[Systemwalker IT Change Managerインストールディレクトリ]\itpm\base\ae\ae.ini

【Solaris/Linux版】

/opt/FJSVswpm/base/ae/ae.ini

設定項目

動作設定ファイルでは、以下の項目を設定します。

キー	説明	備考
logLevel	ログ出力レベルを指定します。以下のどれかの値を指定します。 0：なし 1：エラー（デフォルト） 2：エラー、ワーニング 3：エラー、ワーニング、トレース 4：すべて（エラー、ワーニング、トレース、詳細）	省略できます。 省略した場合、3が設定されます。
logFile	ログファイルのパス名を指定します。 デフォルトでは、以下のファイルが設定されています。 【Windows】 [Systemwalker IT Change Managerインストールディレクトリ]/itpm/base/ae/log/ae.log 【Solaris/Linux】 /opt/FJSVswpm/base/ae/log/ae.log	省略できます。 省略した場合、ログを出力しません。
logMaxFileSize	ログファイルの最大サイズ（Kbytes）を、1以上の数値で指定します。 ログファイルは、指定したサイズを超えると、1世代バックアップが保存されます。 例：logMaxFileSize=10240 注意 ログファイルの最大サイズは変更可能ですが、ディスクを圧迫する可能性がある為、初期値での運用を推奨します。	省略できます。 省略した場合、10240が設定されます。
＜アプリ論理名＞.path	実行するアプリケーションのパス名を指定します。 アプリ論理名には、運用フローの自動実行アクティビティで定義アプリ論理を指定します。 ＜アプリ論理名＞には、BPM Studioで自動実行アクティビティに設定した[アクティビティのプロパティ]の[説明]で指定した名前を使用してください。使用できる文字は、英数字、および「_」（アンダースコア）だけです。 例： 【Windows】 APL99.path=C:/itpm/bin/application.exe 【Solaris/Linux】 APL99.path=/usr/sbin/drms/application	必須です。
＜アプリ論理名＞.sync	アプリケーションを同期実行または非同期実行するかを指定します。 0: 非同期実行 0以外: 同期実行 例：APL99.sync=1	省略できます。 省略した場合、1が設定されます。
＜アプリ論理名＞.in	入力伝票のXMLドキュメントおよび入力伝票に添付されたファイルをアプリケーションに渡す際、それらを格納するディレクトリのパスを指定します。このディレクトリは実在し、書き込み可能なパスを指定してください。 例： 【Windows】 APL99.in=C:/temp 【Solaris/Linux】 APL99.in=/tmp	予約パラメタ"$in"が指定された場合にのみ、使用可能です。
＜アプリ論理名＞.out	入力伝票へ反映するXMLドキュメントを格納するディレクトリのパスです。 このディレクトリには、実在し、書き込み可能なパスを指定してください。 例： 【Windows】 APL99.out=C:/temp 【Solaris/Linux】 APL99.out=/tmp	予約パラメタ"$out"が指定された場合にのみ、使用可能です。
＜アプリ論理名＞.param	アプリケーションに渡すパラメタです。固定のパラメタの他に以下の予約パラメタを指定できます。 #<入力データ論理名>：入力伝票中のデータ項目 %<添付ファイル論理名>：入力伝票に添付されているファイル @1：起案者ID @2：自動実行アクティビティの、前のアクティビティの担当者ID @3：一貫伝票ID @4：プロセスID @5：親プロセスID (*1) *1)親プロセスが存在しない場合、"NONE"がパラメタとして渡されます。 例：APL99.param=-a #arg1 -f %att1 -u @1 $in ポイント 上記の”#”、”%”は予約語で、後述の＜入力データ論理名＞、＜添付ファイル論理名＞にそれぞれ対応します。 また、”@”で始まるパラメタも予約されています。 注意 予約パラメタを指定する場合は、スペースで区切られた独立した語句である必要があります。以下のような場合は、予約パラメタとして解釈されません。 例：APL99.param=-id=@1 -piid=@4	省略できます。 省略した場合、パラメタなしで起動します。
＜アプリ論理名＞.＜入力データ論理名＞.name	伝票中に含まれるデータ項目のタグ名を指定します。 このタグ名は電子フォームのデザイン時に定義したタグ名を指定してください。 タグ名は大文字・小文字が区別されます。 データ内に改行が含まれる場合は削除されて自動実行アプリケーションに渡されます。 ＜入力データ論理名＞には、アプリ論理名ごとにユニークな名前を指定してください。 また、「arg」のあとに、1以上の数値（Integerの範囲内）を指定してください。 例：APL99.arg1.name=field01	アプリケーション起動パラメタに入力データ論理名を指定した場合は必須です。
＜アプリ論理名＞.＜添付ファイル論理名＞.name	伝票中に含まれる添付ファイルの項目名を指定します。項目名の大文字・小文字は区別されます。項目名は、電子フォームの添付ファイルをアップロードするためのフィールドにつけた名称です。 自動実行アプリケーションには、内部的に命名されたユニークなファイル名のフルパスがパラメタとして渡されます。伝票に指定の添付ファイルが存在しない場合は、パラメタは渡されますが、実ファイルは存在しません。 ＜添付ファイル論理名＞には、アプリ論理名ごとにユニークな名前を指定してください。 また、「att」のあとに、1以上の数値（Integerの範囲内）を指定してください。 例：APL99.att1.name=report	アプリケーション起動パラメタに添付ファイル論理名を指定した場合は必須です。
＜アプリ論理名＞.timeout	実行アプリケーションの完了待ち合わせ時間（秒）を指定します。アプリケーションを同期実行する場合に有効です。 1～86,400（1日)の範囲で指定が可能です。 例：APL99.timeout=30	省略できます。 省略した場合や不正な値を指定した場合、1,800（30分）が設定されます。
＜アプリ論理名＞.retry	実行アプリケーションの起動リトライ回数を指定します。アプリケーションを同期実行する場合に有効です。 0～5の範囲で指定が可能です。 同期アプリケーションが完了待ち合わせ時間内に終了しない場合、ここで指定した回数を最大に、起動処理を行います。 例：APL99.retry=3	省略した場合や不正な値（マイナス値）を指定した場合、0が設定されます。
＜アプリ論理名＞.abort.rcode （※注）	特定の動作をさせる場合の判断基準となる、実行アプリケーションの復帰値を指定します。 例：APL99.abort.rcode=1	省略した場合、実行アプリケーションの復帰値による特定の動作は行いません。
＜アプリ論理名＞.abort.condition （※注）	実行アプリケーションの復帰値が、＜アプリ論理名＞.abort.rcodeの値を基準に、どのような場合に特定の動作をさせるかの条件です。 指定できる値は、以下の通りです。 equal：復帰値が、＜アプリ論理名＞.abort.rcodeと「等しい」場合に真となります。 notequal：復帰値が、＜アプリ論理名＞.abort.rcodeと「等しくない」場合に真となります。 under：復帰値が、＜アプリ論理名＞.abort.rcode「以下」の場合に真となります。 over：復帰値が、＜アプリ論理名＞.abort.rcode「以上」の場合に真となります。 例：APL99.abort.condition=over	省略した場合や、指定可能な条件以外の値を指定した場合は、実行アプリケーションの復帰値による特定の動作は行いません。
＜アプリ論理名＞.abort.errorstop （※注）	実行アプリケーションの復帰値が条件一致した場合に、実行中のプロセスインスタンスを停止させるかどうかを指定します。 指定できる値は、以下の通りです。 TRUE：自動実行アクティビティが終了した時点でエラー状態になって停止されます。 TRUE以外：プロセスインスタンスが継続されます。	省略した場合、プロセスインスタンスは継続されます。
＜アプリ論理名＞.abort.message （※注）	実行中のプロセスインスタンスを停止させる場合の、例外に埋め込むメッセージを指定します。 このメッセージは、BPM運用管理画面の、プロセスインスタンスの履歴で確認することができます。	省略した場合、例外にメッセージは埋め込まれません。
＜アプリ論理名＞.abort.path （※注）	特定の条件を満たしたときに実行するアプリケーションのパスを指定します。このアプリケーションは非同期で実行されます。 例： 【Windows】 APL99.abort.path=C:/swpm/bin/swpm_sendmail.cmd 【Solaris/Linux】 APL99.abort.path=/opt/FJSVswpm/bin/swpm_sendmail	省略できます。
＜アプリ論理名＞.abort.param （※注）	特定の条件を満たしたときに実行するアプリケーションに渡すパラメタです。固定パラメタの他に以下の予約パラメタを指定できます。 @1：起案者ID @2：自動実行アクティビティの、前のアクティビティの担当者ID @3：一貫伝票ID @4：プロセスID 例：-to [e-mail] -subject "エラー通知" -text APL99_ErrorMail.txt -piid @4	省略した場合、パラメタなしで起動します。

※注：
この定義は、実行アプリケーションの復帰値によって、特定の動作をさせるための定義です。
この定義は、実行アプリケーションが同期で実行され、かつ完了待ち合わせ時間内に完了した場合
のみ有効になります。
この機能を利用しない場合は、「＜アプリ論理名＞.abort」で始まる定義は省略できます。

注意

• ファイルデリミタは、OSに関係なく、「/」を指定してください。

• 以下の"$"から始まる予約パラメタは、サブプロセス伝票反映コマンドなど、Systemwalker IT Change Managerのコマンドにのみ使用することができます。

  • $in：入力伝票のXMLドキュメント

    入力伝票がXMLドキュメント形式のファイルとして出力されます。
    ファイル名はプロセスIDと現在日時から、以下の形式で作成されます。

    [プロセスID]-YYYYMMDDHHMMSS.xml

  • $out：入力伝票へ反映するXMLドキュメント

    入力伝票へ反映するXMLドキュメント形式のファイルのパスが出力されます。
    ファイル名はプロセスIDと現在日時から、以下の形式で作成されます。

    [プロセスID]-YYYYMMDDHHMMSS.xml

  • $notifypiid

    サブ運用フローの待ち合わせ機能を利用する際の、終了通知を行ったサブ運用フローのプロセスIDが出力されます。

• 「SWPM_」で始まるアプリ論理名は予約語であるため、使用しないでください。

• このファイルを編集した場合は、設定内容を反映させるためにサービスの再起動が必要です。サービスの再起動には、停止コマンドおよび起動コマンドを使用します。コマンドの詳細については、"4.6 Systemwalker IT Change Managerの起動/停止"を参照してください。

設定例

動作設定ファイルの例を、以下に示します。

ae.ini

【Windows】

[LOG]
logLevel=4
logFile=C:/itpm/base/ae/log/ae.log
logMaxFileSize=10240

APM99.sync=1
APL99.path=C:/itpm/bin/myapp
APL99.in=C:/temp
APL99.param=-a #arg1 -f %att1 -u @1
APL99.arg1.name=field01
APL99.att1.name=report

【Solaris/Linux】

[LOG]
logLevel=4
logFile=/var/log/ae.log
logMaxFileSize=10240

APM99.sync=1
APL99.path=/usr/bin/myapp
APL99.in=/tmp
APL99.param=-a #arg1 -f %att1 -u @1
APL99.arg1.name=field01
APL99.att1.name=report