5. IM-Propagation 受信側一覧¶
intra-mart Accel Platformが標準で提供している受信側の一覧と、その利用方法について説明します。
項目
受信側一覧の利用方法¶
この章では、受信側一覧を利用した連携機能の作成例と、一覧の参照方法について説明します。
データの送り方¶
データを送る場合の手順は以下の通りです。一例として、IMBox の ApplicationBox を利用して、特定のユーザへメッセージを送信する方法を説明します。
データを送りたい宛先を一覧からピックアップする
始めに、「受信側一覧 」から送りたいデータの項を参照して、以下の情報を取得してください。以下に、ApplicationBox を利用して watch ユーザ宛てにメッセージを送りたい場合の各項目値を例示します。
データ送信のための送受信モデル
例) jp.co.intra_mart.foundation.propagation.model.generic.GenericAccount処理内容に合致する データの操作種別
例) SEND_WATCH_MESSAGE (メッセージ単位の watch 通知を送信する)送受信モデルとデータの操作種別とのマッピングテーブル
例)詳細は、「Watch通知(メッセージ単位) 」を参照してください。一覧項目の詳細は、「受信側一覧の参照方法 」を参照してください。マッピング設定を作成する
次に、一覧の情報をもとにマッピング設定を作成します。以下に、ApplicationBox を利用して watch ユーザ宛てにメッセージを送りたい場合のマッピング設定を例示します。<?xml version="1.0" encoding="UTF-8"?> <propagation-senders-config xmlns="http://www.intra-mart.jp/propagation/senders-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.intra-mart.jp/propagation/senders-config propagation-senders-config.xsd"> <sender source="jp.co.intra_mart.sample.model.SampleOriginalModel" operationType="SEND_WATCH_MESSAGE"> <encoder class="jp.co.intra_mart.sample.encoder.SampleWatchMessageEncoder" /> </sender> </propagation-senders-config>各タグの設定についての説明は、以下の通りです。
sender タグ
source 属性には、送信用に作成した「独自モデル」の完全修飾子(FQCN)を指定します。なお、この属性に設定する値は、送り先に関わらず送信側が自由に設定可能です。詳細は「IM-Propagation プログラミングガイド」-「データを送る側の実装」を参照してください。operationType 属性には、一覧の中で「データの操作種別と処理内容」として定義されている表から必要とするものを選択し、指定します。アプリケーション通知(メッセージ単位)はデータの操作種別として SEND_WATCH_MESSAGE のみが定義されていますので、それを指定します。encoder タグ
class 属性には、「データ変換クラス」の完全修飾子(FQCN)を指定します。詳細は「IM-Propagation プログラミングガイド」-「データを送る側の実装」を参照してください。
受信側一覧の参照方法¶
受信側に記載されている各項目の詳細は、以下の通りです。
データ送信のための送受信モデル
受信側が受信したいデータを送信できるようにするための「送受信モデル(Generic)」の完全修飾子(FQCN)を表しています。詳細は「IM-Propagation プログラミングガイド」-「送受信モデル(Generic)を作成する」を参照してください。データの操作種別と処理内容
受信側が提供しているデータの操作種別と、その処理内容の紐付けを表しており、マッピング設定で使用します。詳細は「IM-Propagation 仕様書」-「処理仕様」を参照してください。「送受信モデルとデータの操作種別とのマッピングテーブル」の参照方法
項目 詳細 プロパティ データ送信のための送受信モデルが持つプロパティ名を表しています。 データの操作種別 各トリガにて提供されている「データの操作種別」を指定した際の、値を設定することについて必須/任意/入力不可のいずれかを表しています。詳細は、以下の通りです。
表記 説明 ◯ 必須 - 任意 × 入力不可(この表記があるプロパティについては、値の設定を行わないでください。処理実行時にエラーが発生します)説明 送受信モデルのプロパティに格納する値の説明を表しています。
受信側一覧¶
IMBox¶
IMBox が受け付ける処理要求についての受信側設定一覧です。コラム
IMBox への実際の送信機能の作成方法の詳細は「IMBox プログラミングガイド」を参照してください。
アプリケーション通知(スレッド単位)¶
概要
通知メッセージを ApplicationBox へ投稿します。(スレッド形式で表示)導入バージョン
2012 Autumn(Alba)データ送信のための送受信モデル
jp.co.intra_mart.foundation.propagation.model.generic.imbox.GenericSendNoticeThreadデータの操作種別と処理内容
データの操作種別 処理内容 SEND_NOTICE_THREAD スレッド単位のアプリケーション通知を送信する。 送受信モデルとデータの操作種別とのマッピングテーブル
プロパティ SEND_NOTICE_THREAD 説明threadId × スレッドIDapplicationCd ◯ 通知を行うアプリケーションの識別CDsendUserCd ◯ 通知を行うユーザのユーザコードmessageId × メッセージIDmessageText ◯ 通知内容uri - 投稿URI(通知内容と一緒に uri を表示したい場合に使用)uriTitle - 投稿URIタイトル(uri が入力されてない場合入力不可)uriAttachId - URI添付ID(uri が入力されてない場合入力不可)uriText - 投稿URI内容(uri が入力されてない場合入力不可)uriAttachPath - 投稿URI添付パス(uri が入力されてない場合入力不可)messageTypeCd ◯ メッセージ種別コードpostTypeCd × 投稿先種別コードattributes - 拡張項目threadSummarizeCd ◯ メッセージをスレッド単位にするための各アプリケーション一意のコードuserCds ◯ 送信先ユーザコード(複数指定可能)
アプリケーション通知(メッセージ単位)¶
概要
通知メッセージを ApplicationBox へ投稿します。(メッセージ形式で表示)導入バージョン
2012 Autumn(Alba)データ送信のための送受信モデル
jp.co.intra_mart.foundation.propagation.model.generic.imbox.GenericSendNoticeMessageデータの操作種別と処理内容
データの操作種別 処理内容 SEND_NOTICE_MESSAGE メッセージ単位のアプリケーション通知を送信する。 送受信モデルとデータの操作種別とのマッピングテーブル
プロパティ SEND_NOTICE_MESSAGE 説明threadId × スレッドIDapplicationCd ◯ 通知を行うアプリケーションの識別CDsendUserCd ◯ 通知を行うユーザのユーザコードmessageId × メッセージIDmessageText ◯ 通知内容uri - 投稿URI(通知内容と一緒に uri を表示したい場合に使用)uriTitle - 投稿URIタイトル(uri が入力されてない場合入力不可)uriAttachId - URI添付ID(uri が入力されてない場合入力不可)uriText - 投稿URI内容(uri が入力されてない場合入力不可)uriAttachPath - 投稿URI添付パス(uri が入力されてない場合入力不可)messageTypeCd ◯ メッセージ種別コードpostTypeCd × 投稿先種別コードattributes - 拡張項目userCds ◯ 送信先ユーザコード(複数指定可能)
Watch通知(スレッド単位)¶
概要
watch ユーザ宛てに ApplicationBox へ投稿します。(スレッド形式で表示)導入バージョン
2012 Autumn(Alba)データ送信のための送受信モデル
jp.co.intra_mart.foundation.propagation.model.generic.imbox.GenericSendWatchThreadデータの操作種別と処理内容
データの操作種別 処理内容 SEND_WATCH_THREAD スレッド単位のWatch通知を送信する。 送受信モデルとデータの操作種別とのマッピングテーブル
プロパティ SEND_WATCH_THREAD 説明threadId × スレッドIDapplicationCd ◯ ウォッチを行ったアプリケーションの識別CDsendUserCd ◯ 通知を行うユーザのユーザコードmessageId × メッセージIDmessageText ◯ 通知内容uri - 投稿URI(通知内容と一緒に uri を表示したい場合に使用)uriTitle - 投稿URIタイトル(uri が入力されてない場合入力不可)uriAttachId - URI添付ID(uri が入力されてない場合入力不可)uriText - 投稿URI内容(uri が入力されてない場合入力不可)uriAttachPath - 投稿URI添付パス(uri が入力されてない場合入力不可)messageTypeCd ◯ メッセージ種別コードpostTypeCd × 投稿先種別コードattributes - 拡張項目threadSummarizeCd ◯ メッセージをスレッド単位にするための各アプリケーション一意のコードtargetIds ◯ ウォッチ対象の識別CD(数指定可能)
Watch通知(メッセージ単位)¶
概要
watch ユーザ宛てに ApplicationBox へ投稿します。(メッセージ形式で表示)導入バージョン
2012 Autumn(Alba)データ送信のための送受信モデル
jp.co.intra_mart.foundation.propagation.model.generic.imbox.GenericSendWatchMessageデータの操作種別と処理内容
データの操作種別 処理内容 SEND_WATCH_MESSAGE メッセージ単位のWatch通知を送信する。 送受信モデルとデータの操作種別とのマッピングテーブル
プロパティ SEND_WATCH_MESSAGE 説明threadId × スレッドIDapplicationCd ◯ ウォッチを行ったアプリケーションの識別CDsendUserCd ◯ 通知を行うユーザのユーザコードmessageId × メッセージIDmessageText ◯ 通知内容uri - 投稿URI(通知内容と一緒に uri を表示したい場合に使用)uriTitle - 投稿URIタイトル(uri が入力されてない場合入力不可)uriAttachId - URI添付ID(uri が入力されてない場合入力不可)uriText - 投稿URI内容(uri が入力されてない場合入力不可)uriAttachPath - 投稿URI添付パス(uri が入力されてない場合入力不可)messageTypeCd ◯ メッセージ種別コードpostTypeCd × 投稿先種別コードattributes - 拡張項目targetIds ◯ ウォッチ対象の識別CD(複数指定可能)
ウォッチ¶
概要
アプリケーションのウォッチを行います。導入バージョン
2012 Autumn(Alba)データ送信のための送受信モデル
jp.co.intra_mart.foundation.propagation.model.generic.imbox.GenericWatchデータの操作種別と処理内容
データの操作種別 処理内容 WATCH ウォッチを行う 送受信モデルとデータの操作種別とのマッピングテーブル