IM-BPM for Accel Platform IM-BPM 設定ファイルリファレンス 第5版 2019-04-01

IM-BPM for Accel Platform IM-BPM 設定ファイルリファレンス 第5版 2019-04-01

目次 ≪  IM-BPM/Elasticsearch コネクタ

IM-BPM Elasticsearch コネクタ設定

概要

IM-BPM for Accel Platform と ElasticSearch を連携するための設定です。

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

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

  <elasticsearch-default>
    <endpoint>http://127.0.0.1:9200</endpoint>
    <index>im_bpm-${tenantId}-${yyyy}</index>
    <type>im_bpm</type>
    <monitor-events>
      <activity_started>true</activity_started>
      <activity_completed>true</activity_completed>
      <activity_cancelled>true</activity_cancelled>
      <activity_signaled>true</activity_signaled>
      <activity_compensate>true</activity_compensate>
      <activity_message_received>true</activity_message_received>
      <activity_error_received>true</activity_error_received>
      <sequenceflow_taken>true</sequenceflow_taken>
      <task_created>true</task_created>
      <task_assigned>true</task_assigned>
      <task_completed>true</task_completed>
      <process_started>true</process_started>
      <process_completed>true</process_completed>
      <process_completed_with_error_end_event>true</process_completed_with_error_end_event>
      <process_cancelled>true</process_cancelled>
    </monitor-events>
  </elasticsearch-default>

  <elasticsearch tenantId="default">
    <endpoint>http://127.0.0.1:9200</endpoint>
    <index>im_bpm-${tenantId}-${yyyy}</index>
    <type>im_bpm</type>
    <monitor-events>
      <activity_started>true</activity_started>
      <activity_completed>true</activity_completed>
      <activity_cancelled>true</activity_cancelled>
      <activity_signaled>true</activity_signaled>
      <activity_compensate>true</activity_compensate>
      <activity_message_received>true</activity_message_received>
      <activity_error_received>true</activity_error_received>
      <sequenceflow_taken>true</sequenceflow_taken>
      <task_created>true</task_created>
      <task_assigned>true</task_assigned>
      <task_completed>true</task_completed>
      <process_started>true</process_started>
      <process_completed>true</process_completed>
      <process_completed_with_error_end_event>true</process_completed_with_error_end_event>
      <process_cancelled>true</process_cancelled>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

リファレンス

全テナントの初期値設定

タグ名 elasticsearch-default
全テナントで初期値となる設定を定義します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    ：
  </elasticsearch-default>
</im-bpm-elasticsearch-config>

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

テナントごとの設定

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

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch tenantId="default">
    ：
  </elasticsearch>
</im-bpm-elasticsearch-config>

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

【属性】

属性名 説明 必須 デフォルト値
tenantId
テナントID
 ○ なし

エンドポイントの設定

タグ名 endpoint
ElasticSearch のエンドポイントを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <endpoint>http://127.0.0.1:9200</endpoint>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <endpoint>http://127.0.0.1:9200</endpoint>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容 エンドポイント
単位・型 文字列
省略時のデフォルト値 なし
親タグ elasticsearch-default, elasticsearch

インデックスの設定

タグ名 index
ElasticSearch にドキュメントを保存する際の、インデックスとなるパターンを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <index>im_bpm-${tenantId}-${yyyy}</index>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <index>im_bpm-${tenantId}-${yyyy}</index>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容

パターン文字列内で使用可能な変数の一覧は、以下の通りです。

${tenantId} テナントID
${yyyyMMdd} 現在日付の年4桁＋月2桁＋日2桁
${yyyyMM} 現在日付の年4桁＋月2桁
${yyyy} 現在日付の年4桁
単位・型 文字列
省略時のデフォルト値 なし
親タグ elasticsearch-default, elasticsearch

タイプの設定

タグ名 type
ElasticSearch にドキュメントを保存する際の、タイプを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <type>im_bpm</type>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <type>im_bpm</type>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容 タイプ
単位・型 文字列
省略時のデフォルト値 なし
親タグ elasticsearch-default, elasticsearch

収集イベントの設定

タグ名 monitor-events
収集するイベントの種類を設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      ：
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      ：
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

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

アクティビティ処理開始の収集フラグの設定

タグ名 activity_started
アクティビティの処理が開始したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_started>true</activity_started>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_started>true</activity_started>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理成功の収集フラグの設定

タグ名 activity_completed
アクティビティの処理が成功したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_completed>true</activity_completed>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_completed>true</activity_completed>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理中断の収集フラグの設定

タグ名 activity_cancelled
アクティビティの処理が中断したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_cancelled>true</activity_cancelled>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_cancelled>true</activity_cancelled>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理中シグナル受信の収集フラグの設定

タグ名 activity_signaled
アクティビティの処理中に、シグナルを受け取ったときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_signaled>true</activity_signaled>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_signaled>true</activity_signaled>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理補正の収集フラグの設定

タグ名 activity_compensate
アクティビティの処理結果を戻す（補正する）必要が生じたときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_compensate>true</activity_compensate>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_compensate>true</activity_compensate>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理中メッセージ受信の収集フラグの設定

タグ名 activity_started
アクティビティの処理中に、メッセージを受け取ったときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_message_received>true</activity_message_received>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_message_received>true</activity_message_received>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理中エラーイベント受信の収集フラグの設定

タグ名 activity_error_received
アクティビティの処理中に、エラーイベントを受け取ったときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <activity_error_received>true</activity_error_received>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <activity_error_received>true</activity_error_received>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

アクティビティ処理遷移の収集フラグの設定

タグ名 sequenceflow_taken
アクティビティに処理が遷移するタイミングのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <sequenceflow_taken>true</sequenceflow_taken>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <sequenceflow_taken>true</sequenceflow_taken>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

タスク作成の収集フラグの設定

タグ名 task_created
プロセスの実行中に、タスクが作成されたときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <task_created>true</task_created>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <task_created>true</task_created>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

タスク担当者割り当ての収集フラグの設定

タグ名 task_assigned
プロセスの実行中に、タスクに担当者が割り当てられたときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <task_assigned>true</task_assigned>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <task_assigned>true</task_assigned>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

タスク成功の収集フラグの設定

タグ名 task_completed
プロセスの実行中に、タスクが成功したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <task_completed>true</task_completed>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <task_completed>true</task_completed>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

プロセス実行開始の収集フラグの設定

タグ名 process_started
プロセスの実行が開始したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <process_started>true</process_started>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <process_started>true</process_started>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

プロセス実行正常終了の収集フラグの設定

タグ名 process_completed
プロセスの実行が正常終了したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <process_completed>true</process_completed>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <process_completed>true</process_completed>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

プロセス実行エラー終了の収集フラグの設定

タグ名 process_completed_with_error_end_event
プロセスの実行がエラー終了したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <process_completed_with_error_end_event>true</process_completed_with_error_end_event>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <process_completed_with_error_end_event>true</process_completed_with_error_end_event>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

プロセス実行中断の収集フラグの設定

タグ名 activity_started
プロセスの実行が中断したときのイベントを収集するかどうかを設定します。

【設定項目】

<im-bpm-elasticsearch-config>
  <elasticsearch-default>
    <monitor-events>
      <process_cancelled>true</process_cancelled>
    </monitor-events>
  </elasticsearch-default>
  <elasticsearch tenantId="default">
    <monitor-events>
      <process_cancelled>true</process_cancelled>
    </monitor-events>
  </elasticsearch>
</im-bpm-elasticsearch-config>

必須項目 ○
複数設定 ×
設定値・設定する内容
false イベントを収集しない
true イベントを収集する
単位・型 真偽値
省略時のデフォルト値 なし
親タグ monitor-events

目次 ≪  IM-BPM/Elasticsearch コネクタ

Copyright © 2016 NTT DATA INTRAMART CORPORATION

⇄ Sidebar ↑Top