intra-mart Accel Platform IM-MessageHub プログラミングガイド 第2版 2015-12-01

6.3. イベント設定

IM-MessageHub では、イベントに関する詳細情報 や イベントをカテゴライズするための情報を定義することが可能です。

  • アプリケーション - イベントを発生させているアプリケーションに関する情報
  • イベントカテゴリ - イベントをカテゴライズするための情報
  • イベント - メッセージ配信処理の起因となるイベントに関する情報
IM-MessageHub では、これらの情報を利用して「 メッセージ通知設定画面 」におけるチェック状態の初期設定などを制御しています。
この章では、アプリケーション、イベントカテゴリ、および、イベントの設定に関する詳細を説明します。

6.3.1. アプリケーションの設定

イベントを発生させているアプリケーションに関する情報です。
プラグイン形式で設定を行います。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.Applications">
            <application
                    id       = "sampleapplication"
                    name-key = "CAP.Z.SAMPLE.APPLICATION.NAME"
                    name     = "SampleApplication"
                    version  = "8.0.0"
                    rank     = "900" >
                <description message-cd="CAP.Z.SAMPLE.APPLICATION.DESCRIPTION">The Sample Application.</description>
            </application>
        </extension>
    </plugin>
    
表:タグおよび属性の詳細
設定項目 説明
拡張ポイント jp.co.intra_mart.message_hub.Applications 固定です。
id このアプリケーションを一意に表すユニークなIDを指定します。
name-key アプリケーション名を定義したメッセージファイルのプロパティキー名を指定します。
name
アプリケーション名がメッセージファイルより解決できなかった場合の代替アプリケーション名を指定します。
英語で指定することを推奨します。
version この定義のバージョン情報を指定します。
rank
この定義の順序を指定します。
「メッセージ通知設定」画面の表示順に利用されます。
message-cd アプリケーションに関する説明を定義したメッセージファイルのプロパティキー名を指定します。
description
アプリケーションに関する説明がメッセージファイルより解決できなかった場合の代替文を指定します。
英語で指定することを推奨します。

注意

アプリケーションIDに指定可能な文字は「英数字」、および、「_(アンダースコア)」のみです。
ただし、先頭は「英字」としてください。

コラム

アプリケーション名ついて

  • アプリケーション名は、サイトマップ、または、グローバルナビに表示している名称と同じ名称とすることを推奨します。
  • アプリケーション名は、「メッセージ通知設定」画面のタブ名として利用されます。
    タブ名が長すぎるとアプリケーションが多くなった場合に複数行表示されてしまうため、短めの名称を推奨します。

コラム

アプリケーションの設定では、visible や initial-check-state などの詳細な配信設定を行うことはできません。

コラム

アプリケーションに設定するランクについて

アプリケーションに設定するランクは、サイトマップと同じ順序となることを推奨します。
具体的には、サイトマップに関するソート番号と同じ値に設定することを推奨します。

6.3.2. イベントカテゴリの設定

イベントをカテゴライズするための情報です。プラグイン形式で設定を行います。
なお、イベントカテゴリは作成しなくても構いません。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.EventCategories">
            <event-category
                id        = "sample.event.category"
                name-key  = "CAP.Z.SAMPLE.EVENT.CATEGORY.NAME"
                name      = "Sample Event Category"
                parent-id = "sampleapplication"
                version   = "8.0.0"
                rank      = "800" >
                <description message-cd="CAP.Z.SAMPLE.EVENT.CATEGORY.DESCRIPTION">The Sample Event Category.</description>
            </event-category>
        </extension>
    </plugin>
    
表:タグおよび属性の詳細
設定項目 説明
拡張ポイント jp.co.intra_mart.message_hub.EventCategories 固定です。
id このイベントカテゴリを一意に表すユニークなIDを指定します。
name-key イベントカテゴリ名を定義したメッセージファイルのプロパティキー名を指定します。
name
イベントカテゴリ名がメッセージファイルより解決できなかった場合の代替イベントカテゴリ名を指定します。
英語で指定することを推奨します。
parent-id このイベントカテゴリが所属する アプリケーション のID、 または、 イベントカテゴリ のIDを指定します。
version この定義のバージョン情報を指定します。
rank
この定義の順序を指定します。
「メッセージ通知設定」画面の表示順に利用されます。
message-cd イベントカテゴリに関する説明を定義したメッセージファイルのプロパティキー名を指定します。
description
イベントカテゴリに関する説明がメッセージファイルより解決できなかった場合の代替文を指定します。
英語で指定することを推奨します。

コラム

イベントカテゴリ名・説明について

  • イベントカテゴリはオプションですが、アプリケーションのメニューが機能ごとフォルダわけされている場合、同じようにイベントカテゴリを作成することを推奨します。
  • イベントカテゴリの説明は、「メッセージ通知設定」画面上でツールチップとして表示されます。
    「メッセージ通知設定」画面上のツールチップ表示サイズは固定となっているため、スクロールが発生しない適切な文字数としてください。

コラム

イベントカテゴリの設定では、visible や initial-check-state などの詳細な配信設定を行うことはできません。

6.3.3. イベントの設定

メッセージ配信処理の起因となるイベントに関する情報です。
プラグイン形式で設定を行います。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.Events">
            <event
                id        = "sample.message_hub.event.SampleEvent"
                name-key  = "CAP.Z.SAMPLE.EVENT.NAME"
                name      = "Sample Event"
                parent-id = "sampleapplication"
                version   = "8.0.0"
                rank      = "700">
                <description message-cd="CAP.Z.SAMPLE.EVENT.DESCRIPTION">Sample Event active.</description>
            </event>
        </extension>
    </plugin>
    
表:タグおよび属性の詳細
設定項目 説明
拡張ポイント jp.co.intra_mart.message_hub.Events 固定です
id このイベントを一意に表すユニークなIDを指定します。
name-key イベント名を定義したメッセージファイルのプロパティキー名を指定します。
name
イベント名がメッセージファイルより解決できなかった場合の代替イベント名を指定します。
英語で指定することを推奨します。
parent-id このイベントが所属するアプリケーションのアプリケーションID、または、イベントカテゴリのイベントカテゴリIDを指定します。
version この定義のバージョン情報を指定します。
rank
この定義の順序を指定します。
「メッセージ通知設定」画面の表示順に利用されます。
message-cd イベントに関する説明を定義したメッセージファイルのプロパティキー名を指定します。
description
イベントに関する説明がメッセージファイルより解決できなかった場合の代替文を指定します。
英語で指定することを推奨します。

コラム

イベント名・説明について

イベントの発生タイミングをわかりやすく記述してください。記述例は以下の通りです。
表:イベント名・説明の記述例
  記述書式 備考
イベント名
~したとき
例:「スケジュールが登録されたとき」
  • 「メッセージ通知設定」画面上で表示可能な文字数としてください。
イベント説明
~が~されたときに通知します。
例:「あなたが参加者に含まれるスケジュールが登録されたときに通知します。」
  • 通知に関して条件がある場合は、合わせて記述します。
  • ただし、条件や内容は、配信処理の実装に依存して変更される可能性があるため、影響がないような記述にしてください。
  • イベントの説明は、「メッセージ通知設定」画面上でツールチップとして表示されます。
    「メッセージ通知設定」画面上のツールチップ表示サイズが固定となっているため、できるだけ スクロールが発生しない文字数としてください。

6.3.3.1. イベントに紐づく詳細な配信設定

イベントの設定では、イベントに紐づく詳細な配信設定を行うことが可能です。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.Events">
            <event>
                <description>...</description>
    
                <display-setting
                    visible             = "true" 
                    initial-check-state = "unchecked" 
                    allow-user-settings = "false" >
                </display-setting>
            </event>
        </extension>
    </plugin>
    
表:属性の詳細
設定項目 説明
visible
イベントに紐づく配信設定をユーザに対して表示するか否かを設定します。
設定可能な値は以下の通りです。
  • true - 表示する
  • false - 表示しない
未設定の場合は「 配信先メディア定義 」で設定された値が有効となります。
詳しくは「 配信先メディアを定義する 」、および、「 配信設定の表示可否(visible)の優先順位 」を参照してください。
initial-check-state
イベントに紐づく配信可否の初期値を設定します。
この設定値は、ユーザが「メッセージ通知設定」画面でイベントに紐づく配信設定を行っていない場合に利用されます。
設定可能な値は以下の通りです。
  • checked - 配信する
  • unchecked - 配信しない
未設定の場合は「 配信先メディア定義 」で設定された値が有効となります。
詳しくは「 配信先メディアを定義する 」、および、「 配信可否の初期設定(initial-check-state)の優先順位 」を参照してください。
allow-user-settings
イベントに紐づく配信設定の変更をユーザに対して許可するか否かを設定します。
設定可能な値は以下の通りです。
  • true - ユーザ変更可能
  • false - ユーザ変更不可能
未設定の場合は「 配信先メディア定義 」で設定された値が有効となります。
詳しくは「 配信先メディアを定義する 」、および、「 配信設定の変更可否(allow-user-settings)の優先順位 」を参照してください。

6.3.3.2. イベントと配信先メディアに紐づく詳細な配信設定

イベントに紐づく詳細な配信設定は、配信先メディアを指定して 設定することも可能です。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.Events">
            <event>
                <description>...</description>
    
                <display-setting>
                    <delivery-media
                        id                  ="immh.imbox.appbox" 
                        initial-check-state ="unchecked" 
                        allow-user-settings ="false" />
                </display-setting>
            </event>
        </extension>
    </plugin>
    
表:属性の詳細
設定項目 説明
id
設定を行いたい配信先メディアの配信先メディアIDを指定します。
intra-mart Accel Platform が提供している配信先メディアについては「 配信先メディア一覧 」を参照してください。
initial-check-state
イベントに紐づく配信可否の初期値を、配信先メディア単位で設定します。
この設定値は、ユーザが「メッセージ通知設定」画面でイベントに紐づく配信設定を行っていない場合に利用されます。
設定可能な値は以下の通りです。
  • checked - 配信する
  • unchecked - 配信しない
未設定の場合は「 イベントに紐づく詳細な配信設定 」で定義された設定が有効となります。
詳しくは「 配信可否の初期設定(initial-check-state)の優先順位 」を参照してください。
allow-user-settings
イベントに紐づく配信設定の変更をユーザに対して許可するか否かに関して、配信先メディア単位で設定します。
設定可能な値は以下の通りです。
  • true - ユーザ変更可能
  • false - ユーザ変更不可能
未設定の場合は「 イベントに紐づく詳細な配信設定 」で定義された設定が有効となります。
詳しくは「 配信設定の変更可否(allow-user-settings)の優先順位 」を参照してください。

コラム

イベントと配信先メディアに紐づく詳細な配信設定 」に 配信設定の表示可否設定(visible) はありません。

6.3.4. 詳細な配信設定の優先順位

詳細な配信設定の優先順位は以下の通りです。

6.3.4.1. 配信可否の初期設定(initial-check-state)の優先順位

  1. イベントに紐づく詳細な配信設定 」 の initial-check-state の 値
  2. 配信先メディア定義 」で設定された initial-check-state の 値
全て未設定の場合、配信可否の初期設定は 配信する となります。

6.3.4.2. 配信設定の表示可否(visible)の優先順位

  1. 配信先メディア定義 」で設定された visible の 値
全て未設定の場合、配信設定は 表示 されます。

6.3.4.3. 配信設定の変更可否(allow-user-settings)の優先順位

  1. イベントに紐づく詳細な配信設定 」 の allow-user-settings の 値
  2. 配信先メディア定義 」で設定された allow-user-settings の 値
全て未設定の場合、配信設定は 変更可能 となります。