AS2 Egress Connector
Version: 17.01
Supported Since: 17.01
What is AS2 Egress Connector?
AS2 Egress connector can be used to send messages to AS2 destinations from the UltraESB. AS2 Egress connector is compliant to RFC 4130 written by Drummond & Moberg.
Note: This connector element only supports single AS2 station, single AS2 partner setup. If the requirement is to have multiple AS2 Stations and/or multiple AS2 partners please refer the AS2Gateway Egress Connector reference.
Sample Use Case
Prerequisite
In order to use the AS2 Egress 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.
Also you will need to have the required information about the trading partner in-order to configure the AS2 Egress Connector properly. The information includes the AS2 identifier of the trading partner, AS2 message receipt URL of the trading partner and the S/MIME certificate of the trading partner that will be used for signing and encryption purposes of AS2 message. To obtain these information you should contact your trading partner over a different medium.
1. Sending an invoice to trading partner over AS2
This is a simple scenario which is simulating the use case of sending an invoice document to remote partner over AS2 protocol. The invoice file that is going to be sent is stored inside a local directory. It will be injected to the UltraESB to send it to the remote trading partner over AS2 requesting a sync MDN. Upon the receipt of the AS2 message that contains the invoice file, the remote trading partner will send a sync MDN message which acknowledge the message receipt. The received MDN will be save into a defined local file to successfully end the AS2 message flow.
For the above scenario it is required to have three elements for the AS2 message flow which will be the configuration for the UltraESB. 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 second element is the AS2 Egress Connector element for AS2 communication. The third element is a File Egress Connector which is responsible for saving the content of the receiving synchronous MDN into a local file.
In-order to understand the use of File Ingress Connector element and the File Egress Connector element please refer to following resources.
For this sample use case the configuration of the File Ingress Connector is as follows.
For this sample use case the configuration of the AS2 Egress Connector is as follows.
For this sample use case the configuration of the File Egress Connector is as follows.
In Ports
Input |
The message comes through this port will be processed and prepared as a AS2 message and will be sent to an external http endpoint (AS2 service) comes through this port. |
Side Ports
Connector Operation |
This port is used to connect operational elements to the Egress Connector. By-default, user does not have to connect any operational element and the default connector operation will be used. However if there are any trading partner specific operations to be done user can utilize the connector operation. |
Out Ports
On Exception |
The message will be sent to this outport if the processing element failed to prepare the AS2 message using the provided payload due to some reason |
Response Processor |
The response message/synchronous MDN message received will be directed to this port. You can use this port to connect any precessing element or connector that is supposed to process/consume the response/sync MDN. |
Parameters
* marked fields are mandatory
The AS2 Egress Connector uses the HTTP as the underlying transport protocol which makes it inherit the properties of HTTP Egress 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 Egress Connector reference.
Station Identifier * |
Basic |
AS2 Identifier of the trading station |
Partner Identifier * |
Basic |
AS2 Identifier of the trading partner |
Partner URL * |
Basic |
AS2 Message receiving URL of the trading partner |
Email * |
Basic |
Email address of the user |
Message Subject |
Basic |
Subject of the AS2 Message |
Keystore Type |
Security |
Type of the Identity Keystore that will be used for AS2 message signing and encrypting (S/MIME), possible values are "JKS" and "PKCS12" |
Keystore Path * |
Security |
Path of the Identity Keystore which stores the certificate that will be used for AS2 message signing and encryption (S/MIME) |
Keystore Password * |
Security |
Password of the Identity Keystore which stores the certificate that will be used for AS2 message signing and encryption (S/MIME) |
Key Alias * |
Security |
Alias of the certificate that will be used for AS2 message signing and encrypting (S/MIME) |
Key Password * |
Security |
Key password of the certificate that will be used for AS2 message signing and encrypting (S/MIME) |
Truststore Type |
Security |
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* |
Security |
Path of the Trust Keystore that will be used for storing the trading partner’s (S/MIME) certificates |
Truststore Password* |
Security |
Password of the Trust Keystore that will be used storing the trading partner’s (S/MIME) certificates |
Partner Certificate Alias* |
Security |
Alias of the certificate that will be used for processing AS2 messages from partner |
Async URL* |
MDN |
HTTP URL of the trading station which will be receiving Asynchronous MDNs |
Request MDN |
MDN |
For the sent AS2 messages request a Message Disposition Notification (MDN) from the receiving trading partners |
Request MDN Signed |
MDN |
Request for the MDN sending party to send a signed MDN |
Request Async MDN |
MDN |
Request the MDN sending party to send a asynchronous MDN to the defined Async MDN URL endpoint |
Compress Message Before |
Advanced |
Compress the message payload before starting the AS2 processing |
Compress Message After |
Advanced |
Compress the message payload after starting the AS2 processing |
Signature Digest Algorithm |
Advanced |
Digest algorithm to sign the message |
Signature Encryption Algorithm |
Advanced |
Encryption algorithm to sign the message |
Encryption Algorithm |
Advanced |
Algorithm to encrypt the message |
Egress Timeout |
Advanced |
Timeout value in milliseconds for the egress message |
Weight |
Advanced |
Weight for the Egress Connector if Egress Load Balancer element is used with Weighted/Weighted with Failover algorithm is used |
In this topic
In this topic