IM-BPM 設定ファイル¶

項目

概要
リファレンス

概要 ¶

IM-BPM for Accel Platform に関する設定です。

モジュール	IM-BPM for Accel Platform
フォーマットファイル(xsd)	WEB-INF/schema/im-bpm-config.xsd
設定場所	WEB-INF/conf/im-bpm-config.xml WEB-INF/conf/im-bpm-config/{任意のファイル名}.xml

<?xml version="1.0" encoding="UTF-8"?>
<im-bpm-config
    xmlns="http://www.intra-mart.jp/im-bpm-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/im-bpm/im-bpm-config ../../schema/im-bpm-config.xsd">

  <engine-default>
    <history-level>audit</history-level>
    <max-jobs-per-acquisition>1</max-jobs-per-acquisition>
    <job-wait-time-in-millis>5000</job-wait-time-in-millis>
    <job-lock-time-in-millis>300000</job-lock-time-in-millis>
    <job-executor-maximum-number-of-retry>6</job-executor-maximum-number-of-retry>
    <job-executor-retry-interval-in-millis>50</job-executor-retry-interval-in-millis>
    <default-failed-job-wait-time-in-seconds>10</default-failed-job-wait-time-in-seconds>
    <async-failed-job-wait-time-in-seconds>10</async-failed-job-wait-time-in-seconds>
    <process-definition-cache-limit>-1</process-definition-cache-limit>
    <knowledge-base-cache-limit>-1</knowledge-base-cache-limit>
    <batch-size-process-instances>25</batch-size-process-instances>
    <batch-size-tasks>25</batch-size-tasks>
    <max-async-job-size>20</max-async-job-size>
    <async-executor-activate>true</async-executor-activate>
    <max-length-string-variable-type>-1</max-length-string-variable-type>
  </engine-default>

  <engine tenantId="default">
    <history-level>audit</history-level>
    <max-jobs-per-acquisition>1</max-jobs-per-acquisition>
    <job-wait-time-in-millis>5000</job-wait-time-in-millis>
    <job-lock-time-in-millis>300000</job-lock-time-in-millis>
    <job-executor-maximum-number-of-retry>10</job-executor-maximum-number-of-retry>
    <job-executor-retry-interval-in-millis>200</job-executor-retry-interval-in-millis>
    <default-failed-job-wait-time-in-seconds>10</default-failed-job-wait-time-in-seconds>
    <async-failed-job-wait-time-in-seconds>10</async-failed-job-wait-time-in-seconds>
    <process-definition-cache-limit>-1</process-definition-cache-limit>
    <knowledge-base-cache-limit>-1</knowledge-base-cache-limit>
    <batch-size-process-instances>25</batch-size-process-instances>
    <batch-size-tasks>25</batch-size-tasks>
    <max-async-job-size>20</max-async-job-size>
    <async-executor-activate>true</async-executor-activate>
    <max-length-string-variable-type>-1</max-length-string-variable-type>
  </engine>

  <async-delay-start enable="true">
    <strategy class="jp.co.intra_mart.activiti.engine.impl.asyncexecutor.DependentOnWelcomeServlet" />
    <max-delay-time>300</max-delay-time>
    <check-interval>10</check-interval>
  </async-delay-start>
  <is-system-variable-save-as-object>true</is-system-variable-save-as-object>
  <disable-involved-authority-check>false</disable-involved-authority-check>
</im-bpm-config>

リファレンス ¶

全テナントの初期値設定 ¶

タグ名 engine-default

全テナントで初期値となる設定を定義します。

【設定項目】
<im-bpm-config>
  <engine-default>
    ：
  </engine-default>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容 engine-default タグを親とするタグ

単位・型なし

省略時のデフォルト値なし

親タグ im-bpm-config

テナントごとの設定 ¶

タグ名 engine

テナントIDを指定して、初期値となる設定を定義します。

【設定項目】
<im-bpm-config>
  <engine tenantId="default">
    ：
  </engine>
</im-bpm-config>
必須項目 ×

複数設定 ○

設定値・設定する内容 engine タグを親とするタグ

単位・型なし

省略時のデフォルト値なし

親タグ im-bpm-config

【属性】

属性名説明必須デフォルト値

tenantId

テナントID

○ なし

履歴レベルの設定 ¶

タグ名 history-level

履歴レベルを設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <history-level>audit</history-level>
  </engine-default>
  <engine tenantId="default">
    <history-level>audit</history-level>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容

none 履歴を出力しません

activity プロセスの開始・終了などの情報を履歴として保管します

audit 上記とともに、プロセスに含まれるアクティビティの情報も履歴として保管します

full 上記とともに、変数に対する操作を含めた、全ての操作の履歴を保管します

単位・型文字列

省略時のデフォルト値なし

親タグ engine-default, engine

一度に実行するジョブ数の設定 ¶

タグ名 max-jobs-per-acquisition

一度に実行するジョブ数を設定します。

この設定値は手動ジョブ実行時に参照され、ポーリングしているジョブに対しては無効です。

【設定項目】
<im-bpm-config>
  <engine-default>
    <max-jobs-per-acquisition>1</max-jobs-per-acquisition>
  </engine-default>
  <engine tenantId="default">
    <max-jobs-per-acquisition>1</max-jobs-per-acquisition>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容ジョブ数

単位・型数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

ジョブのポーリング間隔の設定 ¶

タグ名 job-wait-time-in-millis

ジョブのポーリング間隔を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <job-wait-time-in-millis>5000</job-wait-time-in-millis>
  </engine-default>
  <engine tenantId="default">
    <job-wait-time-in-millis>5000</job-wait-time-in-millis>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容時間

単位・型ミリ秒・数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

ジョブのロック時間の設定 ¶

タグ名 job-lock-time-in-millis

ジョブのロック時間を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <job-lock-time-in-millis>300000</job-lock-time-in-millis>
  </engine-default>
  <engine tenantId="default">
    <job-lock-time-in-millis>300000</job-lock-time-in-millis>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容時間

単位・型ミリ秒・数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

対象ジョブエンティティ存在チェック回数の設定 ¶

タグ名 job-executor-maximum-number-of-retry

対象ジョブエンティティ存在チェック回数を設定します。

非同期ジョブ実行時に、対象のジョブエンティティが存在するかどうかのチェックを、指定の回数行います。

【設定項目】
<im-bpm-config>
  <engine-default>
    <job-executor-maximum-number-of-retry>6</job-executor-maximum-number-of-retry>
  </engine-default>
  <engine tenantId="default">
    <job-executor-maximum-number-of-retry>6</job-executor-maximum-number-of-retry>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容回数

単位・型数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

対象ジョブエンティティ存在チェック間隔の設定 ¶

タグ名 job-executor-retry-interval-in-millis

対象ジョブエンティティ存在チェック間隔を設定します。

非同期ジョブ実行時に、対象のジョブエンティティが存在するかどうかのチェックを、指定の間隔で行います。

【設定項目】
<im-bpm-config>
  <engine-default>
    <job-executor-retry-interval-in-millis>50</job-executor-retry-interval-in-millis>
  </engine-default>
  <engine tenantId="default">
    <job-executor-retry-interval-in-millis>50</job-executor-retry-interval-in-millis>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容時間

単位・型ミリ秒・数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

ジョブ失敗時の再実行間隔の設定 ¶

タグ名 default-failed-job-wait-time-in-seconds

ジョブ失敗時の再実行間隔を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <default-failed-job-wait-time-in-seconds>10</default-failed-job-wait-time-in-seconds>
  </engine-default>
  <engine tenantId="default">
    <default-failed-job-wait-time-in-seconds>10</default-failed-job-wait-time-in-seconds>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容時間

単位・型秒・数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

非同期ジョブ失敗時の再実行間隔の設定 ¶

タグ名 async-failed-job-wait-time-in-seconds

非同期でのジョブ失敗時の再実行間隔を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <async-failed-job-wait-time-in-seconds>10</async-failed-job-wait-time-in-seconds>
  </engine-default>
  <engine tenantId="default">
    <async-failed-job-wait-time-in-seconds>10</async-failed-job-wait-time-in-seconds>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容時間

単位・型秒・数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

メモリにキャッシュするプロセス定義の最大数の設定 ¶

タグ名 process-definition-cache-limit

メモリにキャッシュするプロセス定義の最大数を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <process-definition-cache-limit>-1</process-definition-cache-limit>
  </engine-default>
  <engine tenantId="default">
    <process-definition-cache-limit>-1</process-definition-cache-limit>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容

プロセス数

-1 を指定した場合は、上限なし

単位・型数値 (-1 - )

省略時のデフォルト値なし

親タグ engine-default, engine

メモリにキャッシュするプロセス定義以外の最大数の設定 ¶

タグ名 knowledge-base-cache-limit

メモリにキャッシュするプロセス定義以外の最大数を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <knowledge-base-cache-limit>-1</knowledge-base-cache-limit>
  </engine-default>
  <engine tenantId="default">
    <knowledge-base-cache-limit>-1</knowledge-base-cache-limit>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容

プロセス定義以外の数

-1 を指定した場合は、上限なし

単位・型数値 (-1 - )

省略時のデフォルト値なし

親タグ engine-default, engine

一度に変更するプロセスインスタンス数の設定 ¶

タグ名 batch-size-process-instances

一度に変更するプロセスインスタンス数を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <batch-size-process-instances>25</batch-size-process-instances>
  </engine-default>
  <engine tenantId="default">
    <batch-size-process-instances>25</batch-size-process-instances>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容プロセスインスタンス数

単位・型数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

一度に変更するタスク数の設定 ¶

タグ名 batch-size-tasks

一度に変更するタスク数を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <batch-size-tasks>25</batch-size-tasks>
  </engine-default>
  <engine tenantId="default">
    <batch-size-tasks>25</batch-size-tasks>
  </engine>
</im-bpm-config>
必須項目 ○

複数設定 ×

設定値・設定する内容タスク数

単位・型数値 (0 - )

省略時のデフォルト値なし

親タグ engine-default, engine

非同期ジョブ最大実行数の設定 ¶

タグ名 max-async-job-size

非同期ジョブ最大実行数を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <max-async-job-size>20</max-async-job-size>
  </engine-default>
  <engine tenantId="default">
    <max-async-job-size>20</max-async-job-size>
  </engine>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容実行数

単位・型数値 (1 - )

省略時のデフォルト値 20

親タグ engine-default, engine

非同期サービス起動の設定 ¶

タグ名 async-executor-activate

非同期サービス起動を設定します。

【設定項目】
<im-bpm-config>
  <engine-default>
    <async-executor-activate>true</async-executor-activate>
  </engine-default>
  <engine tenantId="default">
    <async-executor-activate>true</async-executor-activate>
  </engine>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

true 非同期ジョブの監視スレッドとタイマーの監視スレッドを起動して、非同期処理を実行します。

false 非同期ジョブの監視スレッドとタイマーの監視スレッドを起動しないため、非同期処理は実行されません。

単位・型真偽値

省略時のデフォルト値 true

親タグ engine-default, engine

文字列型変数の最大文字数の設定 ¶

タグ名 max-length-string-variable-type

文字列型変数をデータベースへ登録する際の最大文字数を設定できます。

最大文字数を超えた場合は、バイナリのデータで保存されます。

【設定項目】
<im-bpm-config>
  <engine-default>
    <max-length-string-variable-type>-1</max-length-string-variable-type>
  </engine-default>
  <engine tenantId="default">
    <max-length-string-variable-type>-1</max-length-string-variable-type>
  </engine>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容最大文字数

単位・型数値 (-1 - )

省略時のデフォルト値

-1を設定した場合は、省略時と同様の値が設定されます。

oracleデータベースの場合、最大文字数が2000に設定されます。

それ以外のデータベースの場合、最大文字数が4000に設定されます。

親タグ engine-default, engine

遅延起動の設定 ¶

タグ名 async-delay-start

非同期ジョブの遅延起動に関する設定を行います。

【設定項目】
<im-bpm-config>
  <async-delay-start enable="true">
    ....
  </async-delay-start>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容非同期ジョブの遅延起動に関する設定を指定します。

単位・型なし

省略時のデフォルト値なし

親タグ im-bpm-config
【属性】

属性名説明必須デフォルト値

enable

遅延起動する場合はtrue、しない場合はfalseを設定してください。

○ true

起動判定処理の設定 ¶

タグ名 strategy

非同期ジョブの遅延起動の起動判定に関する設定を行います。

【設定項目】
<im-bpm-config>
  <async-delay-start enable="true">
    <strategy class="jp.co.intra_mart.activiti.engine.impl.asyncexecutor.DependentOnWelcomeServlet" />
  </async-delay-start>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

非同期ジョブの遅延起動の起動判定に関する設定を指定します。

単位・型なし

省略時のデフォルト値なし

親タグ async-delay-start
【属性】

属性名説明必須デフォルト値

class

非同期ジョブの遅延起動の起動判定処理を実装したクラスを指定します。

必ずFQCNで指定する必要があります。

○ jp.co.intra_mart.activiti.engine.impl.asyncexecutor.DependentOnWelcomeServlet

最大遅延時間（秒）¶

タグ名 max-delay-time

非同期ジョブの遅延起動の最大遅延時間（秒）を設定します。

【設定項目】
<im-bpm-config>
  <async-delay-start enable="true">
    <max-delay-time>300</max-delay-time>
  </async-delay-start>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

非同期ジョブの遅延起動の最大遅延時間（単位：秒）を指定します。

この時間を過ぎても非同期ジョブを起動できなかった場合は、起動処理を強制的に終了します。

単位・型数値 (0 - )

省略時のデフォルト値 300

親タグ async-delay-start

起動判定チェック間隔（ミリ秒）¶

タグ名 check-interval

非同期ジョブの起動判定チェックの間隔（ミリ秒）を設定します。

【設定項目】
<im-bpm-config>
  <async-delay-start enable="true">
    <check-interval>10</check-interval>
  </async-delay-start>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

非同期ジョブの起動判定チェック間隔（単位：ミリ秒）を指定します。

単位・型数値 (0 - )

省略時のデフォルト値 10

親タグ async-delay-start

システム変数の格納方式の設定 ¶

タグ名 is-system-variable-save-as-object

IM-BPMのシステム変数の格納方式を設定します。

trueが設定されている場合は、システム変数全体を1つのオブジェクトに集約してプロセスインスタンスの変数に格納します。

上記のオブジェクトを格納するプロセスインスタンスの変数名は、「im_bpm_system_variables」です。

この場合は、システム変数全体に対してデータベースのレコードが1件作成されます。

falseが設定されている場合は、各システム変数を個別のプロセスインスタンスの変数に格納します。

この場合は、各システム変数に対してデータベースのレコードが1件作成されます。

trueが設定されている場合と比較してレコード数が相対的に増えるため、パフォーマンスに影響を与える可能性があります。

注意

システムの運用開始後に、本設定を変更することはできません。

本設定を変更すると、変更前に開始したプロセスインスタンスの実行時や履歴画面の表示時などにエラーが発生する可能性があります。

【設定項目】
<im-bpm-config>
  <is-system-variable-save-as-object>true</is-system-variable-save-as-object>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

true システム変数全体を1つのオブジェクトに集約してプロセスインスタンスの変数に格納します。

false 各システム変数を個別のプロセスインスタンスの変数に格納します。

単位・型真偽値

省略時のデフォルト値 false

親タグ im-bpm-config

コラム

システム変数

IM-BPMの標準機能がプロセスの実行に際して、プロセスインスタンスの変数に格納しているデータのことを指します。

(例) im_operation_users (Map<String, String>) : ユーザタスクを処理したユーザコードを持ちます。

関係者権限のチェックを無効にする設定 ¶

タグ名 disable-involved-authority-check

IM-BPMの関係者権限のチェックを無効にする設定をします。

trueが設定されている場合は、プロセスインスタンスや、タスクに対する関係者権限のチェックを無効にします。

falseが設定されている場合は、プロセスインスタンスや、タスクに対する関係者権限のチェックを実行します。

チェックでエラーになった場合は、プロセスインスタンス情報の取得や、タスクの実行等を行えません。

注意

IM-BPM for Accel Platform 2018 Summer(Tiffany) 以前より行われている関係者権限のチェックは、本設定を無効にしても実行されます。

本設定の適用範囲は、IM-BPM for Accel Platform 2018 Winter(Urara) 以降に追加された権限チェックです。

【設定項目】
<im-bpm-config>
  <disable-involved-authority-check>true</disable-involved-authority-check>
</im-bpm-config>
必須項目 ×

複数設定 ×

設定値・設定する内容

true プロセスインスタンスや、タスクに対する関係者権限のチェックを無効にします。

false プロセスインスタンスや、タスクに対する関係者権限のチェックを実行します。

単位・型真偽値

省略時のデフォルト値 false

親タグ im-bpm-config

目次

IM-BPM 設定ファイル¶

概要 ¶

リファレンス ¶

全テナントの初期値設定 ¶

テナントごとの設定 ¶

履歴レベルの設定 ¶

一度に実行するジョブ数の設定 ¶

ジョブのポーリング間隔の設定 ¶

ジョブのロック時間の設定 ¶

対象ジョブエンティティ存在チェック回数の設定 ¶

対象ジョブエンティティ存在チェック間隔の設定 ¶

ジョブ失敗時の再実行間隔の設定 ¶

非同期ジョブ失敗時の再実行間隔の設定 ¶

メモリにキャッシュするプロセス定義の最大数の設定 ¶

メモリにキャッシュするプロセス定義以外の最大数の設定 ¶

一度に変更するプロセスインスタンス数の設定 ¶

一度に変更するタスク数の設定 ¶

非同期ジョブ最大実行数の設定 ¶

非同期サービス起動の設定 ¶

文字列型変数の最大文字数の設定 ¶

遅延起動の設定 ¶

起動判定処理の設定 ¶

最大遅延時間（秒）¶

起動判定チェック間隔（ミリ秒）¶

システム変数の格納方式の設定 ¶

関係者権限のチェックを無効にする設定 ¶

目次

必須項目	○
複数設定	×
設定値・設定する内容	engine-default タグを親とするタグ
単位・型	なし
省略時のデフォルト値	なし
親タグ	im-bpm-config