IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
Copyright © 2016 NTT DATA INTRAMART CORPORATION

↑Top

1

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01

目次
改訂情報
はじめに
対象読者
本書の構成
本書内の説明について

索引
IM-BPMIM-

for Accel

BPM/Elasticsearch

Platform

コネクタ

IM-

IM-BPM

BPM

Elasticsearch

設定

コネクタ設定

ファイ
ル
IMBPM
OAuth
認証機
能ク
ライア
ントの
アクセ
ス範囲
設定

索
引

2

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
改訂情報
変更年月
日

変更内容

2016-

初版

08-01
201612-01

第2版 下記を追加・変更しました「非同期ジョブ最大実行数の設定」を追加。
「遅延起動の設定」を追加。
201704-01

第3版 下記を追加・変更しました「非同期サービス起動の設定」を追加。
「システム変数の格納方式の設定」を追加。
201812-01

第4版 下記を追加・変更しました「概要」のインデックスパターンの初期設定を変更。
「インデックスの設定」のイン
デックスパターンの初期設定を変更。
「関係者権限のチェックを無効にする設定」を追加。
201904-01

第5版 下記を追加・変更しました「文字列型変数の最大文字数の設定」を追加。
202012-01

第6版 下記を追加・変更しました「IM-BPM OAuth認証機能 クライ

アントのアクセス範囲設定」を追加。
202310-01

第7版 下記を追加変更しました。
「対象ジョブエンティティ存在

チェック回数の設定」の初期値を3から6に変更。

3

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
はじめに
IM-BPM for Accel Platform
IM-BPM 設定ファイル

項目
対象読者
本書の構成
本書内の説明について項目概要
リファレンス
全テナントの初期値設定

対象読者

テナントごとの設定
履歴レベルの設定

次の利用を対象としています。

一度に実行するジョブ数の設定
IM-BPM for Accel Platform を利用したアプリケーション

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

開発

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

本書の構成

対象ジョブエンティティ存在チェック間隔の設定
ジョブ失敗時の再実行間隔の設定

本書は IM-BPM for Accel Platform で提供されている設

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

定ファイルに関する説明を行っています。

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

機能（モジュール）別の設定ファイルの種類

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

設定ファイル別の仕様説明

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

設定項目に対する設定内容および注意点の説明

非同期ジョブ最大実行数の設定
非同期サービス起動の設定

本書内の説明について

文字列型変数の最大文字数の設定
遅延起動の設定「デフォルト値」

起動判定処理の設定

該当の設定を省略した場合の値となります。製品出最大遅延時間（秒）荷時の値ではありません。

起動判定チェック間隔（ミリ秒）システム変数の格納方式の設定
関係者権限のチェックを無効にする設定

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

モジュール

IM-BPM for Accel Platform

フォーマットファ

WEB-INF/schema/im-bpm-config.xsd

イル(xsd)WEB-INF/conf/im-bpm-config.xml

設定場所

WEB-INF/conf/im-bpm-config/{任意のファイル名}.xml

4IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01<?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 タグを親とするタグ

設定する
内容

5

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
単位・型

なし

省略時の

なし

デフォル
ト値
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>

○

必須項目

6

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
×

複数設定
設定値・設定する

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>

7

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
必須項

○

目
複数設

×

定
設定

時間

値・設
定する
内容
単位・

ミリ秒・数値 (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-ofretry

対象ジョブエンティティ存在チェック回数を設定します。
非同期ジョブ実行時に、対象のジョブエンティティが存在するかどうかのチェックを、指定の回数行います。
【設定項目】<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>

8

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
必須項

○

目
複数設

×

定
設定

回数

値・設
定する
内容
単位・

数値 (0 - )

型
省略時

なし

のデ
フォル
ト値
親タグ

engine-default, engine

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

job-executor-retry-interval-inmillis

対象ジョブエンティティ存在チェック間隔を設定します。
非同期ジョブ実行時に、対象のジョブエンティティが存在するかどうかのチェックを、指定の間隔で行います。
【設定項目】<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-inseconds

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

9

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01<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-inseconds

非同期でのジョブ失敗時の再実行間隔を設定します。
【設定項目】<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

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

10

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01【設定項目】<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

名11

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
一度に変更するプロセスインスタンス数を設定します。
【設定項目】<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

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

12

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
タ

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

親タグ

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

13

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
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グ
名14IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
非同期ジョブの遅延起動の起動判定に関する設定を行います。
【設定項目】<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 非同

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

期
ジョ
ブの
遅延
起動
の起
動判
定処
理を
実装
した
クラ
スを
指定
しま
す。
必ず
FQCN
で指
定す
る必
要が
あり
ま
す。

最大遅延時間（秒）タ

max-delay-timeグ
名
非同期ジョブの遅延起動の最大遅延時間（秒）を設定します。
【設定項目】<im-bpm-config><async-delay-start enable="true"><max-delay-time>300</max-delay-time></async-delay-start></im-bpm-config>

×

必須項目

15

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
複数設定

×

設定値・設定する

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

内容

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

単位・型

数値 (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-asobject
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>

必須項目

×

複数設定

×

16

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
設定値・設定する

true

内容

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

false
単位・型

真偽値

省略時のデフォル

false

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

ト値
im-bpm-config

親タグ

コラム
システム変数
IM-BPMの標準機能がプロセスの実行に際して、プロセスインスタンスの変数に格納しているデータのことを指します。
(例) im_operation_users (Map<String, String>) : ユーザタスクを処理したユーザコードを持ちます。

関係者権限のチェックを無効にする設定
タグ名 disable-involved-authoritycheck
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 OAuth認証機能 クライアントのアクセス範囲設定

17

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
項目概要
リファレンス
アクセス範囲設定
アクセス範囲の詳細設定
標準表示名
アクセス範囲を表す国際化情報
アクセス範囲を表す各ロケールの情報
アクセス範囲を表す表示名
アクセス範囲の説明

概要
OAuth認証機能を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲を設定します。
本設定ファイルを修正することにより、クライアントアプリケーションがユーザ（リソースオーナー）にIM-BPMのリソースの使用許可を要求する際に提示されるスコープの名称や、説明などを変更できます。

モジュール

im_oauth_provider

フォーマットファイル

WEB-INF/schema/oauth-client-scopes-config.xsd(xsd)
WEB-INF/conf/oauth-client-scopes-config/oauth-client-scope_im_bpm.xml

設定場所<?xml version="1.0" encoding="UTF-8"?><oauth-client-scopes-config
xmlns="http://intra-mart.co.jp/system/oauth/provider/client/scope/config/oauth-client-scopes-config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://intra-mart.co.jp/system/oauth/provider/client/scope/config/oauth-client-scopesconfig oauth-client-scopes-config.xsd "><scopes><scope id="bpm"><default-subject>IM-BPM REST API</default-subject><localizations><localize locale="ja"><subject>IM-BPM REST API へのアクセス</subject><text>IM-BPM REST API へのアクセスを許可します。</text></localize><localize locale="en"><subject>Access to IM-BPM REST API</subject><text>Allow the access to IM-BPM REST API.</text></localize><localize locale="zh_CN"><subject> IM-BPM REST API</subject><text>允IM-BPM REST API。</text></localize></localizations></scope></scopes></oauth-client-scopes-config>

リファレンス
アクセス範囲設定
タ scopesグ
名OAuth認証を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲を設定します。
【設定項目】

18

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01<oauth-client-scopes-config><scopes><scope id="bpm">...
</scope></scopes></oauth-client-scopes-config>

必須項目

○

複数設定

×

設定値・設

scope

定する内容

ユーザに要求するアクセス範囲の設
定

単位・型

なし

省略時のデ

なし

フォルト値
親タグ

oauth-client-scopes-config

アクセス範囲の詳細設定
タ scopeグ
名OAuth認証を利用するクライアントアプリケーションがユーザ（リソースオーナー）に要求するアクセス範囲の詳細情報を設定します。
なお、本設定ファイルの対象アクセス範囲は「bpm」固定です。修正は行わないでください。
【設定項目】<scopes><scope id="bpm"><default-subject>IM-BPM REST API</default-subject></scope></scopes>

必須項目

○

複数設定

○

設定値・設定 ユーザの要求するアクセス範囲の詳細情報を設定します。
する内容
単位・型

なし

省略時のデ

なし

フォルト値
親タグ

scopes

【属性】
デ
フォ
属性

必 ルト

名

説明

須 値

id

「bpm」固定

○ なし

標準表示名
タ

default-subject

グ
名アクセス範囲を表す標準表示名を設定します。
標準表示名はログインユーザのロケールに一致する表示名が設定されていない場合に利用されます。
【設定項目】

19

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01<scope id="bpm"><default-subject>IM-BPM REST API</default-subject></scope>

必須項目

×

複数設定

×

設定値・設 アクセス範囲を表す標準表示名を設定します。
定する内容
単位・型

文字列

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

親タグ

注意
設定ファイル上では標準表示名は必須項目に指定されていませんがシステムの動作上では必須項目です。

アクセス範囲を表す国際化情報
タ localizations
グ
名アクセス範囲を表す国際化情報を設定します。
【設定項目】<scope id="sample"><localizations><localize locale="ja">...
</localize></localizations></scope>

必須項目

×

複数設定

×

設定値・設定localize アクセス範囲を表す各ロケールの情報設

する内容

定

単位・型

なし

省略時のデ

なし

フォルト値
親タグ

scope

アクセス範囲を表す各ロケールの情報
タ localize
グ
名アクセス範囲を表す各ロケール情報を設定します。
【設定項目】<localizations><localize locale="ja">...
</localize></localizations>

必須項目

○

複数設定

○

20

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
設定値・設定すsubject

アクセス範囲を表す表示名を設定します。

text

操作対象となるリソース等、アクセス範囲の説明を設定し

る内容
ます。
単位・型

なし

省略時のデフォなし

ルト値
localizations

親タグ
【属性】

デ
フォ
必 ルト
属性名

説明

須 値

locale ロケールID。

○ なし

アクセス範囲を表す表示名
タ subjectグ
名アクセス範囲を表す表示名を設定します。
【設定項目】<localize locale="ja"><subject>IM-BPM REST API へのアクセス</subject></localize>

必須項目

○

複数設定

×

設定値・

アクセス範囲を表す表示名を設定します。

設定する
内容
単位・型

文字列

省略時の

なし

デフォル
ト値
親タグ

localize

アクセス範囲の説明
タ textグ
名
操作対象となるリソース等、アクセス範囲の説明を設定します。
【設定項目】<localize locale="ja"><text>IM-BPM REST API へのアクセスを許可します。</text></localize>

必須項目

○

複数設定

×

設定値・設定操作対象となるリソース等、アクセス範囲の説明を設定します。

する内容
単位・型

文字列

省略時のデ

なし

フォルト値

21

IM-BPM for Accel Platform — IM-BPM 設定ファイルリファレンス 第7版 2023-10-01
親タグ

localize22