設定ファイルの編集(アップデートによる設定項目のメンテナンス)¶
これは、IM-BPM for Accel Platform のアップデートによる設定項目のメンテナンスです。他の製品をご利用の方は、他の製品のアップデートによる設定項目のメンテナンスを参照してください。アップデート版を適用前に環境を構築している場合、次の作業が必要です。アップデート前のバージョン別に必要な作業が異なります。注意
たとえば、アップデート前のバージョンが 2016 Summer(8.0.0)、 アップデート後のバージョンが 2017 Spring(8.0.2) の場合、以下のとおり各アップデートの作業が必要です。
- 「IM-BPM for Accel Platform 2016 Winter(8.0.1) からアップデート」
項目
IM-BPM for Accel Platform 2016 Winter(8.0.1) からアップデート¶
【IM-BPM 設定ファイル (im-bpm-config.xml) を出力していない場合】¶
アップデート版の適用前のJugglingプロジェクトにim-bpm-config.xmlを出力していない場合は、次の作業が必要です。
IM-BPM 設定ファイルの編集¶
IM-Juggling より「設定ファイル」タブをクリックします。
一覧より「IM-BPM for Accel Platform」 を選択します。IM-BPM 設定ファイル (im-bpm-config.xml)を選択して、「出力」をクリックします。「ProjectNavigator」内の「 <(プロジェクト名)/conf/im-bpm-config.xml> ファイル」をダブルクリックで開き、「ソース」を選択してください。
<is-system-variable-save-as-object> を「false」に変更します。
<is-system-variable-save-as-object>false</is-system-variable-save-as-object>
コラム
システム変数の格納方式の設定(is-system-variable-save-as-object)
システム変数の格納方式の設定の詳細については、「 IM-BPM 設定ファイルリファレンス 」-「 システム変数の格納方式の設定 」を参照してください。
【IM-FormaDesigner連携時に一時保存機能を利用する場合】¶
アップデート前の環境で作成したIM-FormaDesignerアプリケーションにて一時保存機能を利用する場合は、次の作業が必要です。
後処理ユーザプログラムの登録¶
IM-FormaDesignerアプリケーションに対して、以下の後処理ユーザプログラムを登録してください。
ユーザプログラム種別 後処理プログラム 実行処理種別 一時保存 プログラム種別 JavaEE開発モデル プログラムパス jp.co.intra_mart.activiti.extension.forma.BPMPostProcessExecutor プログラム名 BPM連携用プログラム コラム
ユーザプログラムの登録
後処理ユーザプログラムの登録方法については、「IM-FormaDesigner 作成者操作ガイド」-「アプリケーションにユーザプログラムを登録する」を参照してください。
IM-BPM for Accel Platform 2017 Summer(8.0.3) からアップデート¶
【独自アプリケーションからIM-BPM REST APIを利用している場合】¶
IM-BPM for Accel Platform 2017 Winter(8.0.4) より、REST APIの処理においてセキュアトークンチェックを行うようになりました。独自アプリケーションで以下の条件の両方を満たすREST APIを利用している場合、アップデート後はそのままでは呼び出しに失敗します。この場合は、次項のどちらかの作業を行ってください。
- Cookie認証を利用するREST APIであること
- URLが「api/basic/bpm/」から始まるREST APIは、Basic認証を利用するため対象外です。
- 更新系のREST APIであること
- REST APIが更新系であるかどうかは、以下のようにHTTPメソッドにて判断可能です。
- HTTPメソッドがPUTまたはDELETEであること
- HTTPメソッドがPOSTであり、かつ処理内容が更新処理であること
セキュアトークンの送信¶
独自アプリケーション内のREST APIを呼び出している箇所について、セキュアトークンを送信するように修正します。以下のページを参考に、リクエストパラメータにセキュアトークンを含めてください。
スクリプト開発の場合
「AjaxでSecureTokenを使う(バージョン 8.0.8 以降)」JavaEE開発の場合
「AjaxでSecureTokenを使う(バージョン 8.0.8 以降)」コラム
REST APIの呼び出し元のソースコードに修正が必要ですが、安全な対応です。
セキュアトークンフィルタの無効化¶
Web API Makerセキュアトークンフィルタ設定を行い、利用するREST APIのセキュアトークンチェックを無効化します。安全な対応ではありませんが、ソースコードに修正は必要なく、設定変更のみで対応可能です。
次のリンクより、Web API Makerセキュアトークンフィルタ設定ファイルをダウンロードします。 IM-Juggling にて、 「ProjectNavigator」で次のようにフォルダを作成し、ダウンロードしたファイルを配置します。
フォルダ conf/web-api-maker-secure-token-filtering-config ファイル conf/web-api-maker-secure-token-filtering-config/im_bpm_rest.xml このファイルをダブルクリックで開き、「ソース」タブを選択してください。 IM-BPMの更新系REST APIのURLがコメントアウト状態で記述されています。その中から、セキュアトークンチェックを無効化したいREST APIのコメントアウト状態を解除してください。コラム
Web API Makerセキュアトークンフィルタ設定の詳細
設定ファイルの詳細については、「設定ファイルリファレンス」-「Web API Makerセキュアトークンフィルタ設定」を参照してください。また、URLが「api/basic/bpm/」から始まるREST APIは、このファイルでセキュアトークンチェックを無効化する設定を行っています。この設定を変更しないでください。注意
この設定により、当該REST APIの実行にセキュアトークンが必要ではなくなり、セキュリティ上の懸念が生じます。可能であれば、「セキュアトークンの送信」作業を行ってください。
IM-BPM for Accel Platform 2018 Summer(8.0.6) からアップデート¶
【関係者権限チェック処理を行いたくない場合】¶
IM-BPM for Accel Platform 2018 Winter(8.0.7) より、IM-BPMプロセス参照ユーザ向けの特定の画面において、プロセスインスタンス関係者権限のチェック処理を行うようになりました。権限を持たないユーザで以下の画面にアクセスした場合、エラーが発生します。
- 履歴画面(タスク一覧から遷移する、プロセスインスタンスの処理履歴画面)
- プロセス参照画面
また、IM-BPMユーザ/IM-BPMプロセス参照ユーザ向けのREST APIにおいても、関係者権限のチェック処理を行うようになりました。該当するREST APIは、操作対象への関係者権限を持たないユーザでの実行に対しては、エラーを返却します。IM-BPM for Accel Platform 2018 Summer(8.0.6) までと同様に、これらの画面・RESTにおける関係者権限チェック処理を行わないようにしたい場合、以下の手順で設定変更を行ってチェック処理を無効化してください。
- IM-Juggling より、「ProjectNavigator」内の「 <(プロジェクト名)/conf/im-bpm-config.xml> ファイル」をダブルクリックで開き、「ソース」を選択してください。
- <disable-involved-authority-check> を「true」に変更します。
<disable-involved-authority-check>true</disable-involved-authority-check>
コラム
関係者権限のチェックを無効にする設定(disable-involved-authority-check)
関係者権限のチェックを無効にする設定の詳細については、「 IM-BPM 設定ファイルリファレンス 」-「 関係者権限のチェックを無効にする設定 」を参照してください。
IM-BPM for Accel Platform 2020 Summer(8.0.12) からアップデート¶
【独自アプリケーションからIM-BPM REST API「タスク登録」を利用している場合】¶
IM-BPM for Accel Platform 2020 Winter(8.0.13) より、REST API「タスク登録」(POST /api/bpm/runtime/tasks/{taskId})のアクション「complete」処理においてリクエストパラメータ「variables」の「scope」フィールドにLOCALを指定することで、タスクローカル変数を更新できます。すでに独自アプリケーションからのREST APIの呼び出しで「variables」の「scope」フィールドにLOCAL(大文字小文字を問いません)を指定していた場合、これまでプロセスの変数として登録されていた変数が、アップデート後はタスクローカル変数として登録されます。これまでどおりプロセスの変数として登録を行いたい場合は、Java VM引数に以下のシステムプロパティを追記します。-Djp.co.intra_mart.activiti.engine.SystemPropertyJudge.enableTaskCompleteRestVariableScope=falseコラム
コラム
各環境におけるJava VM引数の設定については下記を参照してください。Resinの場合「intra-mart Accel Platform セットアップガイド 」-「Resinの設定 」を参照してください。Oracle WebLogic Server の場合「intra-mart Accel Platform セットアップガイド (WebLogic編) 」-「intra-mart Accel Platform セットアップガイド (WebLogic編) Java VM引数の設定 」を参照してください。Payaraの場合「intra-mart Accel Platform セットアップガイド (Payara編) 」-「JVM Options の設定 」を参照してください。WebSphere Application Serverの場合「intra-mart Accel Platform セットアップガイド (WebSphere編) 」-「Java VM引数の設定 」を参照してください。
【アップデート前のプロセスインスタンスの履歴を履歴・コメントモジュールを利用して表示したい場合】¶
IM-BPM for Accel Platform 2020 Winter(8.0.13) より、プロセスインスタンスのアクティビティの実行履歴を履歴・コメントモジュールに登録します。アップデート前のプロセスインスタンスの履歴は履歴・コメントモジュールに履歴として登録されていません。アップデート前のプロセスインスタンスの履歴を履歴・コメントモジュールを利用して表示したい場合は、ジョブネットを実行して、アップデート前のプロセスインスタンスのアクティビティの実行時の履歴を登録してください。ジョブネットの実行方法は以下のとおりです。
- 「サイトマップ」→「テナント管理」→「ジョブ管理」→「ジョブネット設定」から「ジョブネット管理」画面を開きます。
- ジョブネット一覧から、「IM-BPM」カテゴリの「履歴・コメントモジュールのデータ登録(プロセスインスタンスのアクティビティ履歴)」のジョブネットを即時実行します。
コラム
履歴はプロセスインスタンスの状態(実行中、完了)を問わず登録されます。コラム
ケースインスタンスに関しては、アップデート前より履歴・コメントモジュールに履歴を登録しているため本ジョブの対象外です。注意
「履歴・コメントモジュールのデータ登録(プロセスインスタンスのアクティビティ履歴)」のジョブネットは、プロセスインスタンスの件数により非常に時間を要する場合があります。進捗状況を確認する場合はログを参照してください。