/n software Connectors for MuleSoft

Questions / Feedback?

AS4 Connector

Properties   Configuration Settings  

The AS4 Connector adds AS4 send and receive capabilities to MuleSoft.

Remarks

The AS4 Connector adds AS4 send and receive capabilities to Mule Project. Using a simple application-like design, the connector allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.

Sending AS4 Messages

Outgoing AS4 messages are managed with the Send connector. In order to use the connector, you must specify AS4FromId, AS4ToId, and a URL. Optionally set the SigningCert and RecipientCert to enable signing and encryption. Optionally specify a SignerCert to verify the signature on the response.

Additional properties such as EDIFileName, EDIType, Profile, and more, may also be set.

HTTP/2 is supported on Windows 8.1/Server 2012 R2 or later. If HTTP/2 is used on a version of Windows prior to these versions the connector throws an exception.

Note: HTTP/2 is currently only supported on Windows.

The AS4 Send connector is a Solicit-Response connector and the resulting Mule event will contain the receipt returned by the server if RequireReceipt is True (default).

AS4 Send Example

To get started, add a File Read connector to your flow and configure it to read a target EDI file. Behind the File Read connector, add an AS4 Send module. There is no need to transform the output of the File Read connector before passing it to the AS4 Send module.

All that is left is to configure the connection settings and certificates. The connector will handle sending the AS4 message and receiving a synchronous receipt. The MessageId and ReceiptContent is available in the output attributes.MessageId and attributes.ReceiptContent fields respectively.

Receiving AS4 Messages

The AS4 Receive connector will establish a connection to a server and request messages to download from the specified MPC. If SendReceipt is True (default) the connector will automatically generate a receipt and send it with the next request.

To decrypt the incoming files, set the DecryptionCert property. The SignerCert property specifies the public certificate to use when verifying the signature of received files. Receipts will be signed using the certificate specified by SigningCert.

The connector works by polling the server for files available to download. The polling settings can be found in the "General" tab of the Mule properties page for the connector. During each polling interval the connector will attempt to download all files present in a MPC. Each file will generate a Mule event.

AS4 Receive Example

Add an AS4 Receive source connector to your flow and configure the connection settings and certificates. That is all that is required to get started. The connector will handle connecting to the server and requesting files to download from the specified MPC. One Mule event is generated for each file downloaded.

Behind the AS4 Receive connector you can add a File Write connector to write each file to disk. You will need to dynamically set the Path property on the File Write connector to accomplish this. Click the Mule expression indicator on the Path property and set the value to:


'C:\\temp\\' ++ attributes.ReceivedFileName

The received filename will then be used as the same filename on disk. The content of each file will be present in the payload of the Mule Message. That is all that is required to write an incoming file to disk. Additional properties about the EDI data are also available in the attributes collection.

Receiver Property List


The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.

AgreementRefThe agreement reference.
AS4FromIdThe Id of the party. This value is required.
AS4FromIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4FromRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
AS4ToIdThe Id of the party. This value is required.
AS4ToIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4ToRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
ConversationIdThe Conversation Id of the message.
DecryptionCertThe certificate with private key used to decrypt.
EDIPropertiesA collection of file properties.
EDISchemaLocationThe EDISchemaLocation , EDISchemaNamespace , and EDISchemaVersion optionally define the schema that applies to this particular file. This may be used by the receiving party to properly interpret the file data.
EDISchemaNamespaceThe namespace of the schema. This property is optional. Refer to EDISchemaLocation for details.
EDISchemaVersionThe version of the schema. This property is optional. Refer to EDISchemaLocation for details.
EDITypeThe Content-Type of the EDI message.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
LogDirectoryThe path to a directory for logging.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
MessageIdThe unique Id of the message.
MessagePropertiesA collection of message properties.
MPCThe MPC (Message Partition Channel) from which to receive files.
OtherDefines a set of configuration settings to be used by the connector.
ProfileThe AS4 profile.
ReceiptContentThe content of the receipt.
ReceiptRefToMessageIdThe Message Id to which this receipt applies.
ReceivedFileNameThe name of the file received by the AS4 connector.
RuntimeLicenseSpecifies the connector runtime license key.
SendReceiptWhether to send a receipt.
ServiceThe service which acts on the message.
ServiceActionThe action within a service that acts on the message.
ServiceTypeThe type of service.
SignatureAlgorithmSignature algorithm to be used in the message.
SignerCertThe public signing certificate of the partner.
SigningCertThe certificate used to sign the outgoing AS4 message.
SSLAcceptServerCertFor sending HTTPS requests, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TempPathA temporary local directory where data can be stored before the connector processes it.
TimeoutA timeout for the connector.
TokenPasswordThe password used in UsernameToken authentication.
TokenUserThe user used in UsernameToken authentication.
URLThe URL to which the request is made.

Sender Property List


The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.

AgreementRefThe agreement reference.
AS4FromIdThe Id of the party. This value is required.
AS4FromIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4FromRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
AS4ToIdThe Id of the party. This value is required.
AS4ToIdTypeThe optional type of the Id. If specified this value should be the domain to which the Id belongs.
AS4ToRoleThis field specifies the role of the party. This may be any value agreed upon by the trading partners.
CompressionFormatThe compression format (if any) to use.
ConversationIdThe Conversation Id of the message.
EDIFileNameThe file name to be used in outbound request.
EDIPropertiesA collection of file properties.
EDITypeThe Content-Type of the EDI message.
EncryptionAlgorithmThe algorithm, if any, used to encrypt the EDI data.
FirewallA set of properties related to firewall access.
HTTPPasswordA password if authentication is to be used.
HTTPProxyA set of properties related to proxy access.
HTTPUserA user name if authentication is to be used.
LogDirectoryThe path to a directory for logging.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
MessageIdThe unique Id of the message.
MessagePropertiesA collection of message properties.
OtherDefines a set of configuration settings to be used by the connector.
ProfileThe AS4 profile.
ReceiptContentThe content of the receipt.
ReceiptRefToMessageIdThe Message Id to which this receipt applies.
RecipientCertThe public certificate used to encrypt files when sending.
RefToMessageIdSpecifies the RefToMessageId in the message.
RequireReceiptWhether to require a receipt.
RuntimeLicenseSpecifies the connector runtime license key.
ServiceThe service which acts on the message.
ServiceActionThe action within a service that acts on the message.
ServiceTypeThe type of service.
SignatureAlgorithmSignature algorithm to be used in the message.
SignerCertThe public signing certificate of the partner.
SigningCertThe certificate used to sign the outgoing AS4 message.
SSLAcceptServerCertFor sending HTTPS requests, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the connector.
URLThe URL to which the request is made.

Configuration Settings


The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.

AgreementRefPModeAgreementRef PMode of message.
AgreementRefTypeThe type of AgreementRef.
AllowWarningsWhether warnings are interpreted as fatal errors.
AttachXMLFilesWhether to send XML files as attachments or within the SOAP body.
CloseStreamAfterProcessingWhether to close the input or output stream after processing.
CompressXMLPayloadsWhether to compress XML data.
ContentTransferEncodingThe content encoding of the payload data.
DetectDuplicatesWhether to detect duplicate messages when receiving.
EBPrefixSpecifies the prefix to use for messaging.
EDIDataPartId[i]Specified the part Id at the given index.
EncryptionSecurityTokenFormatThe format to use for the security token when encryption.
FilenamePropertyDefines a part property to hold the filename.
ForceSigningCertWhether to force only the SigningCert to be used for signing.
FromId[i]The Id of the party specified by AS4From.
FromIdCountThe number of Ids for the party specified by AS4From.
FromIdType[i]The Id type of the party specified by AS4From.
IdRightA custom Id for the right side of the MessageId.
KeyEncryptionAlgorithmThe algorithm used to encrypt the key.
LogLevelThe level of information to log.
LogOptionsThe information to be written to log files.
MaxDownloadsThe maximum number of downloads to perform in each polling interval.
MessageTypeIndicates the type of message received.
NormalizeIssuerSubjectWhether to normalize the certificate subject within the X509Data element.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used when encrypting a key.
OAEPParamsThe hex encoded OAEP parameters to be used when encrypting a key.
OAEPRSAHashAlgorithmThe RSA hash algorithm used when encrypting a key.
ReceiptURLThe URL to which receipts are sent.
ReferenceHashAlgorithmThe hash algorithm used to has the data specified in the reference of a signature.
RequireEncryptionWhether encryption is required when processing received messages.
RequireSignatureWhether a signature is required when processing received messages.
ResponseFileA file from which to read the response.
SignerCACertThe CA certificates that issued the signer certificate.
SigningSecurityTokenFormatThe format to use for the security token when signing.
ToId[i]The Id of the party specified by AS4To.
ToIdCountThe number of Ids for the party specified by AS4To.
ToIdType[i]The Id type of the party specified by AS4To.
TokenPasswordTypeThe password type used in UsernameToken authentication.
TransformReceiptWhether to canonicalize the received receipt.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the connector whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]