4.2.3.33. AS4 Gateway OUT – Babelway

The AS4 gateway out will allow you to push messages to another AS4 endpoint. Note that these parameters are tied to the PMode (Processing Mode) specification you and your partner should share.

Url	URL of your partner's AS4 endpoint. This gateway pushes content to another AS4 enpoint.
SERVICE NAME*	The name of the service used in the AS4 exchange (typically agreed upon by partners).
SERVICE TYPE	The service type used by the in the AS4 exchange.
ACTION NAME*	Name of the action you are targeting in this service.
FROM ID*	AS4 ID of the sender (your ID, or that of the party on who's behalf you are sending the message.
FROM TYPE*	Type of the party sending the message.
FROM ROLE	Role of the party sending the message.
TO ID*	AS4 ID of the partner you are sending the message to.
TO TYPE*	Type of your AS4 party you are sending the message to.
TO ROLE	Role of the AS4 party you are sending the message to.
MESSAGE ID	Identifies the message within a conversation. If not set, will default to an id using the message key. CONTENT ID - Content ID for the part containing the message data. If not set, the default is 'message'.
PAYLOAD NAME	Payload name for the part containing the message data. If empty, none will be included in the message.
MIME TYPE	Payload mime type. If none is provided, it will be 'application/xml'.
AS4 PROPERTIES	AS4 supports attaching custom properties to the message. These can be added as name/values pairs.
AS4 ATTACHMENTS	AS4 supports attaching additional messages to a communication. This is done by adding attachments with a given name (id) and using the data contained in a metadata. (you will find examples at the end of this topic)
CONVERSATION ID	Identifies an exchange of AS4 messages all related to the same transaction (message and replies).
REFERENCE TO MESSAGE ID	If the message you are sending out is a response to another original message, then this should contain the ID of the original message. If not set, no RefToMessageId tag will be added to AS4 MessageInfo.
GATEWAY TO RECEIVE RECEIPT	Sends the return receipt from your message into an internal gateway for independent processing.
USE COMPRESSION*	Enable compression of AS4 body and attachments
SENDER CERTIFICATE	The key you wish to use to sign your messages.
KEY IDENTIFIER TYPE	Your partner's security policy establishes which key identifier type is supported in this PMODE. If you don't know, just leave this blank.
RECEIVER CERTIFICATE	Trusted certificate of the partner you are sending this message to. Note that this means that per AS4 gateway is tied to a single partner. Thus, if you wish to send to multiple parties, you will have to create as many gateways as partners you wish to issue the message to.

AS4 attachments examples:

The above configuration will add an attachment called "myattachment" with the content of the metadata called "mymetadata" to your AS4 message.

Note that these fields support regular expressions. So the following name/value combination:

will attach all metadata prefixed with att- and will use the non "att-" part of the metadata as the id of the attachment (first group in the regular expression as referenced by '$1'). Note that AS4 allows to configure the payload mime type (defaults to application/octet-stream), its name, and its charset. All of these are configurable using the matching metadata with the suffixes "_mime", "_payloadname", and "_charset" respectively. Using the sample configuration above, you can see how to configure two attachments and their properties:

Babelway metadata


att-mydata="Hello World"
att-mydata_mime="text/plain"
att-mydata_payloadname="helloworld.txt"
att-mydata_charset="UTF-8"
att-myadata2="Hello to you too"

AS4 Attachments

Attachment 1

id: mydata
payload name: helloworld.txt
mime-type: text/plain
charset: UTF-8
content: Hello World

Attachment 2

id: mydata2
mime-type: application/octet-stream
content: Hello to you too