intra-mart Accel Platform 履歴・コメントモジュールプログラミングガイド 第3版 2023-10-01

3. 概要

3.1. 履歴・コメントモジュール とは

履歴・コメントモジュールは、タイムライン形式で履歴の表示やコメントの投稿を行う機能です。
  • 履歴・コメントモジュールを利用することで、業務画面に履歴・コメント機能を簡単に追加できます。
  • カスタムイベント」を作成することで、独自のレイアウトで履歴・コメントを表示できます。
  • イベントハンドラ」を作成することで、コメントやカスタムイベントの登録を検知して、任意の処理を行うことができます。

注意

履歴・コメントモジュールは、アプリケーションに組み込んで利用するモジュールであり、単体では機能しません。

3.2. 用語

履歴・コメントモジュールには、以下のような構成要素があります。

3.2.1. アプリケーション

履歴・コメントモジュールを組み込む対象のアプリケーションを指します。
  • intra-mart Accel Platformが提供するアプリケーションでは、「 チケットモジュール」「 IM-BPM for Accel Platform」などが挙げられます。

3.2.2. イベントグループ

履歴・コメントモジュールの個々のタイムラインを指します。
  • 1つのイベントグループに対して1つのアプリケーションが紐付きます。
  • 1つのイベントグループ(タイムライン)に対して複数のイベント(履歴)が所属します。

3.2.3. イベント

履歴・コメントモジュールのタイムラインに表示される個々のイベント(履歴)データを指します。
イベントは、以下の情報から構成されます。
  • イベント操作日時
  • イベント操作ユーザ
  • イベントタイプ
  • アクション

3.2.4. イベントタイプ

イベントの種類を指します。
  • イベントタイプは、イベントをタイムラインに表示する際のテンプレートを定義します。
  • 履歴・コメントモジュールで提供されるイベントタイプは、「コメント/添付ファイルイベント」と「添付ファイル削除イベント」の2種類です。
  • カスタムイベントを用意することで、独自のテンプレートを持ったイベントをタイムライン上に表示することが可能です。

3.2.5. アクション

イベント内で行った操作を表すデータを指します。
  • 1つのイベントデータに対して複数のアクションを所属させることが可能です。
  • 例えば、「コメント/添付ファイルイベント」では、添付ファイルを登録した場合に「コメント」と「添付ファイル」の2つのアクションのデータが登録されます。