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

5. 履歴・コメントモジュールの利用方法

この章では、スクリプト開発モデルで履歴・コメントモジュールを利用する手順や注意事項を説明します。

5.1. アプリケーションへの組み込み

5.1.1. スクリプト開発モデルで履歴・コメントモジュールを組み込む

埋め込みたいモジュールのHTMLファイルに、以下の記述を追加します。
ヘッダ部(<imart type=“head”> </imart>)に、以下を記述します。
  • <meta http-equiv="X-Intramart-Secure-Token" content="<imart type="imSecureToken" mode="value" />"> CSRF(クロスサイト・リクエスト・フォージェリ)対策用のSecureTokenを出力するmetaタグ
  • src="im_journal/bundles/js/journal.bundle.js" を指定したscriptタグ
script内で、window.ImJournal.Journal を実行します。
<imart type="head">
  <meta http-equiv="X-Intramart-Secure-Token" content="<imart type="imSecureToken" mode="value" />">
  <script type="text/javascript" src="im_journal/bundles/js/journal.bundle.js"></script>
</imart>
<!-- 埋め込むアプリケーションの記述 -->

<div id="im-journal"></div>

<!-- 埋め込むアプリケーションの記述 -->
<script>
    const elementId = 'im-journal';

    const eventGroupKey = { journalSampleId: '1' };

    const application = 'im-journal-sample';

    const options = { sortOrder: 'asc',  eventTypeIds: [ 'im_journal_comment', 'im_journal_sample_log' ] };

    new window.ImJournal.Journal(elementId, eventGroupKey, application, options);
</script>
引数については次の通りです。
引数名 必須/任意 説明 省略時の動作
elementId 必須 string 埋め込む場所に置いたdivタグのid属性を指定します。 なし
eventGroupKey 必須 object
イベントグループを一意に設定するためのキーです。
オブジェクトのKeyは任意の値を指定します。
なし
application 必須 string 埋め込むアプリケーションを指定します。 なし
options 任意 object
履歴情報の昇順および降順の切り替えや、履歴に表示するイベントの絞り込みを行います。
利用可能なオプションについては以下のとおりです。
sortOrder : string
履歴の昇順および降順を指定するオプションです。
昇順を asc、降順を desc で指定します。
eventTypeIds : Array<string>
履歴に表示するものを絞り込むためのオプションです。
showEventCount : boolean
履歴件数の表示非表示を制御するためのオプションです。
showAttachmentCount : boolean
取得した添付ファイルの件数の表示非表示を制御するためのオプションです。
indicatorStyle : string
履歴・コメントモジュール自体のインジケータの表示制御をするためのオプションです。
表示しない場合は hide、表示する場合は show で指定します。
sortOrder
降順で表示されます。
eventTypeIds
絞り込みは行われません。
showEventCount
履歴件数を表示します。
showAttachmentCount
添付ファイルの件数を表示します。
indicatorStyle
インジケータを表示します。

コラム

eventTypeIdsに指定できるイベントのIDは以下です。
  • im_journal_comment : コメント/添付ファイルイベント
  • im_journal_attachment_delete : 添付ファイル削除イベント
  • im_journal_not_supported : 表示用テンプレート がないイベント
  • および カスタムイベント で指定したイベントのeventTypeId
../../_images/function_01.png
図: 履歴・コメントモジュール