Interstage Application Server ebXML Message Service ユーザーズガイド

6.2.3 通信パラメタ一覧

　以下に通信パラメタの一覧を示します。

Property名	データ型	説明
Eyecatch	String	ebXMLのパラメタであることを示す文字列です。ebMSが設定します。
Version	String	ebXML Message Service Specificationのバージョンレベルです。ebMSが設定します。
CodeType	int	パラメタを記述しているコード系です。1を設定してください。
CPAId	String	通信に使用するcpaのIDです。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。
FromPartyId	String	送信元のpartyIdです。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。
ToPartyId	String	送信先のpartyIdです。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。
Service	String	送信先のService名です。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。
ServiceType	String	送信先のServiceTypeです。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。CPA内に定義していない場合には""を設定してください。
Action	String	送信先のAction名です。送信アプリケーションが設定します。CPA内部に定義している値を設定してください。
ConversationId	String	ConversationIdです。送信アプリケーションが設定します。ConversationIdは取引の単位ごとにアプリケーションが設定する値です。ebMSはConversationId単位にメッセージの順序を保証します。ConversationIdはCPAId単位でユニークになるように値を設定してください。以下のような値の方法などで、常にユニークになる値を設定することを推奨します。 　FromPartyId_ToPartyId_Service_Action_Timestamp_SerialNumber
ConversationFlag	int	会話の状態を示します。送信アプリケーションが1〜4のいずれかを設定します。受信アプリケーションには必ず-1が通知されます。
		値	意味	説明
		-1	UNKNOWN	会話状態は不明です。
		1	START_AND_END	会話はこのメッセージ一通で完結します。
		2	START	このメッセージで会話が開始されます。
		3	CONTINUE	会話は継続中です。
		4	END	このメッセージで会話が終了します。
PayloadFlag	int	ペイロードの状態を示します。送信アプリケーションが設定します。イベントデータで送るペイロードが最初のものかマルチペイロードの一部なのかを表します。STARTからENDまでのメッセージのペイロードをマルチペイロードとして扱い、通信路上では一通のebXMLメッセージとして送ります。受信側ではebMSがイベントチャネルに格納する際に元の形に分割します。マルチペイロードを一通のebXMLメッセージとして送る場合には、トランザクション機能を利用して、一度にイベントチャネルに送信してください。
		1	START_AND_END	ペイロードはこのメッセージ一通で完結します。
		2	START	マルチペイロードメッセージの開始です。
		3	CONTINUE	マルチペイロードメッセージは継続中です。
		4	END	このメッセージでマルチペイロードメッセージは終了します。
		5	NONE	このメッセージにはペイロードはありません。
PayloadLength	int	ペイロードの長さです。送信アプリケーションが設定します。

　通信パラメタの中にはXML文書に直接埋め込む文字列があります。したがって&などXML文書に直接記述できない文字列については、通信パラメタで指定するときに文字参照の形で記述してください。以下に代表的な文字参照を示します。

使用禁止文字	文字参照
&	&
<	&lt;
>	&gt;
"	&quot;
'	&apos;

[通信パラメタ入出力一覧]

Property名	送信時	受信時
Eyecatch	ebMS	出力
Version	ebMS	出力
CodeType	入力	出力
CPAId	入力	出力
FromPartyId	入力	出力
ToPartyId	入力	出力
Service	入力	出力
ServiceType	入力	出力
Action	入力	出力
ConversationId	入力	出力
ConversationFlag	入力	出力
PayloadFlag	入力	出力
PayloadLength	入力	出力

入力：ユーザが設定
出力：ebMSが設定（ユーザは参照）
ebMS：ebMSが設定