Setting Up AS2 Partnerships¶
Partnership ID¶
| Description | The unique identifier of an AS2 partnership in Hermes. The value of this field has no restrictions but it is RECOMMENDED to be unique between sender and recipient. This field is mandatory and its maximum length is 255 characters. |
AS2 From¶
| Description | Identifier of the sending party in a data exchange. The values may be company specific, such as Data Universal Numbering System (DUNS) numbers, or they may simply be identification strings agreed upon between trading partners. [AS2 RFC4130 6.2] This parameter is used as the This field is mandatory and it is RECOMMENDED that the length of this value be less than 255 characters. See note below. |
AS2 To¶
| Description | Identifier of the receiving party in a data exchange. The values may be company specific, such as Data Universal Numbering System (DUNS) numbers, or they may simply be identification strings agreed upon between trading partners. [AS2 RFC4130 6.2] This parameter is used as the This field is mandatory and it is RECOMMENDED that the length of this value be less than 255 characters. See note below. |
Note
AS2 From and AS2 To form a pair that identify the send and recieve partnerships (i.e. they form a composite key that identifies the parties involved in the data exchange).
The values of [AS2 From, AS2 To] are reversed in the receive partnership with respect to the send partnership. For example:
Send: [CompanyA, CompanyB] –> Receive: [CompanyB, CompanyA].
Disabled¶
| Description | This boolean option indicates whether the partnership is disabled or not. Disabled partnerships do not deliver/receive any outgoing/incoming messages. |
| Options | [ true = disabled ], [ false = enabled ] |
Subject¶
| Description | The subject of the partnership. This parameter is used as the This field is only applicable to send partnerships. |
Recipient Address¶
| Description | The endpoint URL of the receiving messaging gateway. If the receiving messaging gateway is Hermes, the endpoint URL is
This field is mandatory and it must be an HTTP/HTTPS URL. |
Hostname Verified in SSL?¶
| Description | This boolean flag indicates whether HTTP SSL/TLS protocol is used to verify the recipient hostname. This is relevant only if HTTPS transport protocol is used in Recipient Address. This field is only applicable to send partnerships. |
| Options | [ true = hostname verified using SSL ], [ false = no verification using SSL ] |
Request Receipt¶
| Description | Indicates whether the sender has requested the recipient to reply with an AS2 receipt (acknowledgement). How the receipt is sent depends on the value of Asynchronous Receipt. If it is disabled, the receipt will be sent immediately using the same HTTP connection as the received message. Otherwise, if the recipient is using Hermes, the receipt will be placed in an outgoing queue until it is delivered to the sender. It is RECOMMENDED to set this parameter to This field is only applicable to send partnerships. |
| Options | [ true = receipt requested ], [ false = receipt is not requested ] |
Signed Receipt¶
| Description | Indicates whether the sender has requested the recipient to digitally sign the AS2 receipt with their private key before delivering it. The format of the private key should be in PKCS12 and the created signatures should conform to IETF S/MIME. The send partnership must enable Request Receipt for this feature to function properly. The recipient is required to provide a Certificate for Verification so the source of the receipt can be verified. This field is only applicable to send partnerships. |
| Dependencies | [ Request Receipt = true ] , [ Certificate for Verification REQUIRED ] |
| Options | [ [ |
Asynchronous Receipt¶
| Description | Indicates whether the recipient should reply to incoming AS2 messages using the same HTTP/HTTPS connection that the sender is using for delivery. This field is only applicable to send partnerships. |
| Dependencies | [ Request Receipt = true ] |
| Options | [ true = asynchronous reply ], [ false = synchronous reply ] |
Synchronous reply
AS2 message receipts are encapsulated in the HTTP response.
Asynchronous reply
AS2 message receipts will be delivered through another HTTP connection from recipient to sender.
Receipt Return URL¶
| Description | This is the endpoint URL of Hermes or another compatible messaging gateway for receiving receipts. It is always the inbound endpoint URL of the send partnership. For example:
This field is only applicable to send partnerships. |
| Dependencies | [ Request Receipt = true ],
[ Asynchronous Receipt = true ] |
Message Compression Required¶
| Description | Indicates whether the sender must compress outgoing AS2 messages in this partnership. This field is only applicable for send partnerships. |
| Options | [ [ |
Message Signing Required¶
| Description | Indicates whether the sender must digitally sign AS2 messages using their private key. This field is only applicable for send partnerships. |
| Options | [ [ |
Signing Algorithm¶
| Description | The algorithm used to digitally sign outgoing AS2 messages in this partnership. |
| Options | [ SHA1 ], [ MD5 ] |
Message Encryption Required¶
| Description | Indicates whether the sender must encrypt AS2 messages using the recipient’s public certificate defined in Certificate for Encryption. The encryption method is based on the S/MIME standard. This field is only applicable for send partnerships. |
| Dependencies | [ Certificate for Encryption REQUIRED ] |
| Options | [ [ |
Encryption Algorithm¶
| Description | The algorithm used to encrypt outgoing AS2 messages in this partnership. |
| Options | [ 3DES ], [ RC2 ] |
Certificate for Encryption¶
| Description | The certificate ( The recipient should use the keystore in the AS2 plugin to export the public certificate for the sender. AS2 default keystore location: The keystore must be in PKCS12 format. See Message Encryption Required for details. |
MIC Algorithm¶
| Description | The algorithm used to create message digests/hashes for outgoing AS2 messages in this partnership. |
| Options | [ SHA1 ], [ MD5 ] |
Maximum Retries¶
| Description | The maximum number of retries allowed for the sender to attempt delivering an AS2 message. Hermes tries to deliver the AS2 message under the specification of reliable messaging until exceeding the maximum number of retries. There will be a time interval between each attempt, which is defined in Retry Interval (ms). It is RECOMMENDED that the value of this field be between |
Retry Interval (ms)¶
| Description | The time interval (milleseconds) between each consecutive attempt to deliver an AS2 message. It is RECOMMENDED that the value of this field be between |
Message Signature Enforced¶
| Description | Indicates whether incoming AS2 messages must be digitally signed. If enabled, AS2 messages in this partnership must be digitally signed by the sender before the message is received by the recipient. This field is only applicable to recieve partnerships. |
| Options | [ [ |
Message Encryption Enforced¶
| Description | Indicates whether incoming AS2 messages must be encrypted. It enforced, AS2 message in this partnership must be encrypted by the sender before the message is received by the recipient. This field is only applicable to recieve partnerships. |
| Options | [ [ |
Certificate for Verification¶
| Description | The certificate ( The sender should use the keystore in the AS2 plugin to export the public certificate for the recipient. AS2 default keystore location: The keystore must be in PKCS12 format. See Message Signing Required for details. |