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	ペイロードの長さです。送信アプリケーションが設定します。
PayloadFilePath	String	大容量ペイロード用ファイルを利用する際にペイロードファイル名をフルパスで表現した文字列を設定します。送信時には、送信するペイロードのファイル名を送信アプリケーションが設定します。受信時には、受信したペイロードを出力したファイル名をebMSが通知します。
ContentType	String	ebXMLメッセージ内で、ペイロードに対して付加されるMIME Header部分のContent-Type に設定する文字列です。送信時には、送信アプリケーションが設定します。受信時には、ebMS が、ebXMLメッセージ内でペイロードがどのような Content-Type で通知されたかを設定します。以下のいずれかの値を指定してください。(1) text/xml application/pdf image/jpeg (2) application/octet-stream (デフォルト)
RefToMessageId	String	ebXML メッセージ内の MessageData/RefToMessageId に対して指定する文字列を設定します。ebXML メッセージのレベルで関連付けを表現したい場合などに使用します。送信時には、送信アプリケーションが設定します。受信時には、ebMS が、ebXMLメッセージ内のMessageData/RefToMessageId の値を通知します。
MessageId	String	ebXML メッセージ内の MessageData/MessageId に対して指定する文字列を設定します。送信時には、一意性を持つMessageIdをebMS が自動的に設定するので、送信アプリケーションからは指定しないでください。受信時には、ebXMLメッセージ内のMessageData/MessageId の値をebMSが通知します。
Timestamp	String	ebXML メッセージ内の MessageData/Timestamp に対して指定する文字列を設定します。送信時には、ebMS が自動的に設定するので、送信アプリケーションからの指定は無視されます。受信時には、ebMS が、ebXMLメッセージ内のMessageData/Timestamp の値を通知します。
FromRole	String	ebXML メッセージ内の From/Role に設定される文字列を示します。送信アプリケーションが設定します。送信時には、通信パラメタCPAIdで特定されるCPA中にFromPartyId,ToPartyId,Service,Actionが同一になる記述が複数存在しており、それらが異なるRole名によって切り分けられている場合、CPA中のRole記述と整合する値を送信アプリケーションが指定する必要があります。CPA中のRole記述と整合しない値を指定した場合は送信エラーになります。ただし、FromRoleの指定を省略した場合には、他の通信パラメタ指定と整合するCPAが登録されている場合はそれを用いてメッセージを送信し、送信エラーにはなりません。受信時には、ebXMLメッセージ内にFrom/Roleが記述されている場合はその文字列をebMSが通知します。
ToRole	String	ebXML メッセージ内の To/Role に設定される文字列を示します。送信アプリケーションが設定します。送信時には、通信パラメタCPAIdで特定されるCPA中にFromPartyId,ToPartyId,Service,Actionが同一になる記述が複数存在しており、それらが異なるRole名によって切り分けられている場合、CPA中のRole記述と整合する値を送信アプリケーションが指定する必要があります。CPA中のRole記述と整合しない値を指定した場合は送信エラーになります。ただし、ToRoleの指定を省略した場合には、他の通信パラメタ指定と整合するCPAが登録されている場合はそれを用いてメッセージを送信し、送信エラーにはなりません。受信時には、ebXMLメッセージ内にTo/Roleが記述されている場合はその文字列をebMSが通知します。

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

使用禁止文字	文字参照
&	&
<	<
>	>
“	"
‘	'

(*1)
Content-Type の値にはさまざまな種類がありますが、ここに記述してあるType以外の値を指定した場合、ebMSの動作は保証しません。

(*2)
image/jpeg を使用する場合には、X Windowシステムのアプリケーションが動作する環境およびが必要です。

通信パラメタ入出力一覧

Property名	送信時	受信時
Eyecatch	ebMS	出力
Version	ebMS	出力
CodeType	入力	出力
CPAId	入力	出力
FromPartyId	入力	出力
ToPartyId	入力	出力
Service	入力	出力
ServiceType	入力	出力
Action	入力	出力
ConversationId	入力	出力
ConversationFlag	入力	出力
PayloadFlag	入力	出力
PayloadLength	入力	出力
PayloadFilePath	入力（省略可）	出力
ContentType	入力（省略可）	出力
RefToMessageId	入力（省略可）	出力
MessageId	ebMS	出力
Timestamp	ebMS	出力
FromRole	入力（省略可）	出力
ToRole	入力（省略可）	出力

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