AS2 Async MDN Ingress Connector
Version: 17.07
Supported Since: 17.01
What is AS2 Async MDN Ingress Connector?
According to the AS2 protocol upon the receipt of an AS2 Message it is required to send a Message Disposition Notifications (MDN) to the AS2 message sending party declaring the processing status of the AS2 message. With the AS2 message, the sending party should declare their preferred method of receiving the MDN. There are two methods,
-
Synchronous MDN (Request MDN with the HTTP response for the AS2 message)
-
Asynchronous MDN (Request MDN as a different HTTP request)
AS2 Async MDN Ingress Connector can be used to receive asynchronous MDNs when remote AS2 trading party sends an async MDN in response to the AS2 message that you sent. AS2 Async MDN Ingress connector is compliant with the RFC 4130 written by Drummond & Moberg.
Sample Use Case
Prerequisite
In order to use the AS2 Async MDN Ingress Connector you must first select the "AS2 Connector" dependency from the connector list when you are creating an empty Ultra project. If you have already created a project, you can add the "AS2 Connector" dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list, select the "AS2 Connector" dependency.
Note: AS2 Async MDN Ingress Connector should be used in a flow where you are using a AS2Gateway Egress Connector to send AS2 messages. As a prerequisite to use the AS2 Async MDN Ingress Connector it is required to prepare a resource configuration which contains required AS2 trading station/partner information.
1. Preparing the AS2 Trading information resource
To create a resource with required information, you should open the project.xpml file in Design mode. Then select AS2 Trading under Custom Templates menu. This will open a list of input parameter where you need to enter the relevant information in input fields inorder to configure the AS2 Trading information resource.
Resource Parameters
* marked fields are mandatory
The AS2 Async MDN Ingress Connector uses the HTTP as the underlying transport protocol which makes it inherit the properties of HTTP Ingress Connector. Therefore it is possible to view and customize those HTTP transport specific properties defined under the Transport Configuration category. To understand them please refer to NIO HTTP Ingress Connector reference.
Resource ID * |
Identifier for the resource to identify within the XML configuration of project.xpml |
Station AS2 ID * |
AS2 Identifier of the trading station |
User Email ID * |
Email address of the user |
Station Keystore Type |
Type of the Identity Keystore that will be used for AS2 message signing and encrypting (S/MIME), possible values are "JKS" and "PKCS12" |
Station Keystore Path * |
Path of the Identity Keystore which stores the certificate that will be used for AS2 message signing and encryption (S/MIME) |
Station Keystore Password * |
Password of the Identity Keystore which stores the certificate that will be used for AS2 message signing and encryption (S/MIME) |
Station Certificate Alias * |
Alias of the certificate that will be used for AS2 message signing and encrypting (S/MIME) |
Key Password * |
Key password of the certificate that will be used for AS2 message signing and encrypting (S/MIME) |
Station Truststore Type |
Type of the Trust Keystore that will be used storing the trading partner’s (S/MIME) certificates, possible values are "JKS" and "PKCS12" |
Truststore Path* |
Path of the Trust Keystore that will be used for storing the trading partner’s (S/MIME) certificates |
Truststore Password* |
Password of the Trust Keystore that will be used storing the trading partner’s (S/MIME) certificates |
Organization ID* |
Unique integer identifier to recognize the organization |
Partner AS2 ID * |
AS2 Identifier of the trading partner |
Partner URL * |
AS2 Message receiving URL of the trading partner |
Station Async MDN URL* |
HTTP URL of the trading station which will be receiving Asynchronous MDNs |
Partner Certificate Alias* |
Alias of the certificate that will be used for processing AS2 messages from partner |
Sign AS2 Message* |
Sign AS2 Message for partner |
Encrypt AS2 Message* |
Encrypt AS2 Message for partner |
Compress Message Before |
Compress the message payload before starting the AS2 processing |
Compress Message After |
Compress the message payload after starting the AS2 processing |
AS2 Message Encrypt Algorithm |
Algorithm to be used in AS2 message encryption process |
AS2 Message Sign Algorithm |
Algorithm to be used in AS2 message signing process |
AS2 Message Signature Encrypt Algorithm |
Algorithm to be used in AS2 message signature encryption process |
Request MDN |
For the sent AS2 messages request a Message Disposition Notification (MDN) from the receiving trading partners |
Request MDN Signed |
Request for the MDN sending party to send a signed MDN |
Request Async MDN |
Request the MDN sending party to send a asynchronous MDN to the defined Async MDN URL endpoint. This property must be marked as true in order to use the AS2 Async MDN Ingress Connector |
Message Subject |
Subject of the AS2 Message |
2. Confirming the receipt of an invoice over AS2
Inorder-to utilize the AS2 Async MDN Ingress Connector there should be a established AS2 connectivity between you and your remote AS2 trading partner.
This is a simple scenario simulating the use case of receiving an async MDN upon sending an AS2 message containing an invoice document to a remote AS2 trading partner. Here it is assumed that the you will always request an async MDN when sending AS2 messages to your AS2 trading partners. Here the received MDN file will be store into a predefined local directory.
For the above scenario it is required to configure an AS2 message sending flow. You can configure using four elements. The first element is a File Ingress Connector which is responsible for picking up the invoice file from the local directory and injecting it to the UltraESB. The next two elements are Add Transport Header elements which will add the AS2-From and AS2-To headers with AS2 identifiers of relevant trading station and trading partner. The fourth element is the AS2Gateway Egress Connector element for send out the AS2 message containing the invoice file. The final element of the flow is a Successful Flow End element to end the sending message flow.
You should configure another message flow inorder to receive the asynchronous MDN message. There you need to have two elements. The first element is a AS2 Async MDN Ingress Connector which is responsible for receiving the AS2 message, parsing it to extract the MDN file, set the extracted invoice as a attachment of the message and finally preparing the HTTP response for the received MDN. The second element is a Attachment Saver element which is responsible for saving the MDN file into a user defined local directory.
In-order to understand the use of File Ingress Connector element, Add Transport Header element, Successful Flow End element and the Attachment Saver element please refer to their respective references.
Out Ports
Processor |
The response message for the received Async MDN message with received MDN files as attachments will be forwarded to this port. You can use this port to connect any precessing element or connector that is supposed to follow as the next processing element of the message flow. |
On Exception |
The message will be sent to this outport if the processing element failed to process the received Async MDN message |
Input |
The response message to be sent to the remote AS2 trading party comes through this port. |
Parameters
* marked fields are mandatory
The AS2 Async MDN Ingress Connector uses the HTTP as the underlying transport protocol which makes it inherit the properties of HTTP Ingress Connector. Therefore it is possible to view and customize those HTTP transport specific properties defined under the Transport Configuration category. To understand them please refer to NIO HTTP Ingress Connector reference.
HTTP Port * |
Basic |
Port to keep listening for the incoming AS2 messages |
Service Path * |
Basic |
The path which the Ingress Connector can be reached |
AS2 Gateway Configuration |
Basic |
The Resource ID of the resource created in project.xpml |
Egress Timeout |
Advanced |
Timeout value in milliseconds for the egress message |
In this topic
In this topic