AS4Web Connector

Properties   Config Settings  

The AS4Web Component adds AS4 receive functionality to MuleSoft.

Remarks

The AS4Web Connector supports receiving files into BizTalk. 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.

AS4Web Receive Connector

The AS4Web Receive Connector handles incoming push requests (accepts files sent by your partner to you). The AS4Web Receive Connector requires another entity to listen for incoming HTTP requests and to send responses back to the client. An HTTP Listener may be used in conjunction with the AS4Web Receive Connector to create a fully-functional AS4Web server.

In order to use the AS4Web Receive Connector, you must set the TradingPartner and ReceivingPartner properties. It is recommended that you set an MDNSigningCert in order to provide non-repudiation for your AS2 response.

To decrypt incoming messages set DecryptionCert to your private key. To verify the signature of incoming message set SignerCert to your partner's public certificate. To sign receipts sent back to you partner set SigningCert. If a receipt should be sent, set SendReceipt to Yes.

Once the incoming AS4 request has been parsed and verified, the files are submitted to your flow as individual Mule events. Upon successful submission, the connector will generate a receipt as necessary.

Connector Attributes

Aside from generating the receipt, when AS4Web connector finishes processing it will also produce a group of AS4 attributes. AS4RecAttributes is a special attribute consisting of a collection of EDIData entities from the request.

Each item in the collection has its own set of attributes such as EDIProperties, EDISchemaLocation, EDISchemaNamespace, EDISchemaVersion, EDIType and Output. The 'For Each' Scope will allow you to iterate through the collection of EDIData entities and query these attributes. The sample XML configuration is as follows: <foreach collection="#[attributes.AS4RecAttributes]"> <logger message="#[payload.AS4FromId]"/> </foreach>

HTTP Listener Configuration

In a typical scenario a HTTP listener is used to receive the original request and send the response because the connector does not have a webserver of its own. The connector will process the request and generate the response, but will rely on the HTTP Listener to relay the response back to the client. In order to configure the HTTP Listener to relay the response to the client, follow the below steps.

In the Mule HTTP Listener's Responses section set the Body to #[attributes.ResponseBody]. Then, add a new header with value 'Content-Type' and value attributes.ResponseHeaders.'Content-Type'.

The corresponding Configuration XML may look like:

<http:response > <http:body ><![CDATA[#[attributes.ResponseBody]]]></http:body> <http:headers ><![CDATA[#[output applicaton/java --- { "Content-Type" : attributes.ResponseHeaders.'Content-Type' }]]]></http:headers> </http:response>

AgreementRef Property (AS4Web Connector)

The agreement reference.

Data Type

String

Default Value

""

Remarks

This property holds a value identifying the agreement between the two parties. The agreement is made outside the scope of the request and response and governs details about the interaction including reply mode, signing and encryption options, etc.

The value of this property should be set to a mutually agreed upon identifier. Both parties will use this value know what the expected requirements are for a particular request or response.

The format of this value is typically a URI, such as "http://mycompany.com/agreement_01" but can be any unique string that both parties are configured to accept. Another common format is the concatenation of the AS4From and AS4To values.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4FromId Property (AS4Web Connector)

The Id of the party. This value is required.

Data Type

String

Default Value

""

Remarks

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4FromIdType Property (AS4Web Connector)

The optional type of the Id. If specified this value should be the domain to which the Id belongs.

Data Type

String

Default Value

""

Remarks

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4FromRole Property (AS4Web Connector)

This field specifies the role of the party. This may be any value agreed upon by the trading partners.

Data Type

String

Default Value

"http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator"

Remarks

This field specifies the role of the party. This may be any value agreed upon by the trading partners.

In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".

In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4RecAttributes Property (AS4Web Connector)

TBD.

Data Type

Remarks

TBD.

This property is not available in the Sender.

AS4ToId Property (AS4Web Connector)

The Id of the party. This value is required.

Data Type

String

Default Value

""

Remarks

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4ToIdType Property (AS4Web Connector)

The optional type of the Id. If specified this value should be the domain to which the Id belongs.

Data Type

String

Default Value

""

Remarks

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

AS4ToRole Property (AS4Web Connector)

This field specifies the role of the party. This may be any value agreed upon by the trading partners.

Data Type

String

Default Value

"http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder"

Remarks

This field specifies the role of the party. This may be any value agreed upon by the trading partners.

In AS4From this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator".

In AS4To this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder".

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

ConversationId Property (AS4Web Connector)

The Conversation Id of the message.

Data Type

String

Default Value

""

Remarks

This property specifies an Id that may be used to identify a set of related messages. This is required and if a value is not specified one will automatically be created.

Note: When Profile is set to ebpfENTSOG this value will always be empty.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:ConversationId"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

DecryptionCert Property (AS4Web Connector)

The certificate with private key used to decrypt.

Data Type

Remarks

This property specifies the certificate with private key used to decrypt received data.

This property is not available in the Sender.

Firewall Property (AS4Web Connector)

A set of properties related to firewall access.

Data Type

Remarks

This is a Firewall type property which contains fields describing the firewall through which the connector will attempt to connect.

HTTPPassword Property (AS4Web Connector)

A password if authentication is to be used.

Data Type

Password

Default Value

""

Remarks

This property holds the password used for HTTP authentication.

This property is not available in the Receiver.

HTTPProxy Property (AS4Web Connector)

A set of properties related to proxy access.

Data Type

Remarks

This is a Proxy type property which contains fields describing the proxy through which the connector will attempt to connect.

HTTPUser Property (AS4Web Connector)

A user name if authentication is to be used.

Data Type

String

Default Value

""

Remarks

This property holds the user used for HTTP authentication.

This property is not available in the Receiver.

LogDirectory Property (AS4Web Connector)

The path to a directory for logging.

Data Type

String

Default Value

""

Remarks

The directory in which log files are created. The connector will create log files that detail each transmission.

The verbosity of the logs is controlled by LogLevel.

LogFile Property (AS4Web Connector)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

If LogDirectory is specified, log files will be written in the specified directory and LogFile will contain the path. A diagnostic log will be written with filename LogFile + ".log".

Since this log file is dynamically generated, this property can be read after the connector has processed the message to determine the exact name of the log file.

To write logging information to a file instead of using the connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (AS4Web Connector)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the connector logs. The possible values have the following affect on the connector's behavior:

LogType Property (AS4Web Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)

Default Value

1

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:

MessageId Property (AS4Web Connector)

The unique Id of the message.

Data Type

String

Default Value

""

Remarks

This property provided the MessageId of the message. This is returned for informational purposes.

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

MessageProperties Property (AS4Web Connector)

A collection of message properties.

Data Type

String

Default Value

""

Remarks

This property holds message level properties. The properties are specified one per line. The property type is optional. The syntax is a follows: [PropertyType]PropertyName=PropertyValue PropertyName=PropertyValue For instance, the value below includes two properties, the first property does not include a type. Prop1=Value1 [string]Prop2=Value2

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

Other Property (AS4Web Connector)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The connector accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Profile Property (AS4Web Connector)

The AS4 profile.

Data Type

Enumeration

Possible Values

Standard (0)
ENTSOG (1)
ESENS (2)

Default Value

0

Remarks

This property specifies the AS4 profile to use. Different profiles may have different requirements and default options. Setting this property to the correct value ensures that the right options are selected in order to conform to the profile. Possible values are:

When Profile is set to ebpfENTSOG the following settings are automatically applied:

When Profile is set to ebpfEDelivery the following settings are automatically applied:

ReceiptContent Property (AS4Web Connector)

The content of the receipt.

Data Type

String

Default Value

""

Remarks

This is the raw XML of the receipt.

When using the Send connector this is populated from the response received from the server.

When using the Receive connector this is informational only and is populated with the receipt that was sent by the connector.

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

ReceiptRefToMessageId Property (AS4Web Connector)

The Message Id to which this receipt applies.

Data Type

String

Default Value

""

Remarks

This is the original Message Id from the initial transmission of the file.

When using the Send connector this is populated from the response received from the server.

When using the Receive connector this is informational only and is populated with the receipt that was sent by the connector.

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

ReceivingPartner Property (AS4Web Connector)

The identity of AS4 receiving entity.

Data Type

String

Default Value

""

Remarks

This is the Id of the trading partner that will be receiving AS4 transmissions for this receive location. When data is received, this will value will be checked against the value supplied by the sending entity to ensure that the document received is intended for this receiver.

This property is not available in the Sender.

RequestHeaders Property (AS4Web Connector)

The headers included in the AS4 request.

Data Type

String

Default Value

"#[attributes.headers]"

Remarks

This property should be set to the AS4 headers from the request. If the request was received by an HTTP listener and passed to this connector, these headers are available through '#[attributes.headers]' (or '#[message.inboundProperties.headers]' in Mule 3.X). The headers can also be specified as a string.

This property is not available in the Sender.

ResponseBody Property (AS4Web Connector)

The response body to be sent to the client.

Data Type

String

Default Value

""

Remarks

This property holds the response body that may be assigned to the HTTP response.

In a typical scenario a HTTP listener is used to receive the original request and send the response because the connector does not have a webserver of its own. The connector will process the request and generate the response, but will rely on the HTTP Listener to relay the response back to the client. In order to configure the HTTP Listener to relay the response to the client, follow the below steps.

In the Mule HTTP Listener's Responses section set the Body to #[attributes.ResponseBody]. Then, add a new header with value 'Content-Type' and value attributes.ResponseHeaders.'Content-Type'.

The corresponding Configuration XML may look like:

<http:response > <http:body ><![CDATA[#[attributes.ResponseBody]]]></http:body> <http:headers ><![CDATA[#[output applicaton/java --- { "Content-Type" : attributes.ResponseHeaders.'Content-Type' }]]]></http:headers> </http:response>

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

This property is not available in the Sender.

ResponseHeaders Property (AS4Web Connector)

A collection of resposne headers.

Data Type

String

Default Value

""

Remarks

This property holds an object of response headers that may be assigned to the HTTP response.

In a typical scenario a HTTP listener is used to receive the original request and send the response because the connector does not have a webserver of its own. The connector will process the request and generate the response, but will rely on the HTTP Listener to relay the response back to the client. In order to configure the HTTP Listener to relay the response to the client, follow the below steps.

In the Mule HTTP Listener's Responses section set the Body to #[attributes.ResponseBody]. Then, add a new header with value 'Content-Type' and value attributes.ResponseHeaders.'Content-Type'.

The corresponding Configuration XML may look like:

<http:response > <http:body ><![CDATA[#[attributes.ResponseBody]]]></http:body> <http:headers ><![CDATA[#[output applicaton/java --- { "Content-Type" : attributes.ResponseHeaders.'Content-Type' }]]]></http:headers> </http:response>

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

This property is not available in the Sender.

RuntimeLicense Property (AS4Web Connector)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the connector license.

SendReceipt Property (AS4Web Connector)

Whether to send a receipt.

Data Type

Boolean

Default Value

true

Remarks

This property indicates whether a receipt should be sent after downloading files.

The connector will make multiple requests to download all outstanding files from the server. The receipt for the previous message will be bundled with the request for the next message.

This property is not available in the Sender.

Service Property (AS4Web Connector)

The service which acts on the message.

Data Type

String

Default Value

"http://docs.oasis-open.org/ebxml-msg/as4/200902/service"

Remarks

This property specifies the service which acts on the message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

ServiceAction Property (AS4Web Connector)

The action within a service that acts on the message.

Data Type

String

Default Value

"http://docs.oasis-open.org/ebxml-msg/as4/200902/action"

Remarks

This property defines the action within a service that acts upon a message. This should only be changed from the default value if there is a specific reason to do so.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action".

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

ServiceType Property (AS4Web Connector)

The type of service.

Data Type

String

Default Value

""

Remarks

This optionally specifies the type of the service. The semantics of this value should be agreed upon by both parties ahead of time. It may be used to tell the other party how to interpret the Service value.

This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service@type"

Note: This property is not available at design time in the receiver, but will be detected from the incoming AS4 message and made available as a message context attribute.

SignatureAlgorithm Property (AS4Web Connector)

Signature algorithm to be used in the message.

Data Type

String

Default Value

"sha256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

• SHA1
• MD5
• SHA-256 (or SHA256) (default)
• SHA-384 (or SHA384)
• SHA-512 (or SHA512)
• SHA-224 (or SHA224)
• ECDSA-SHA1
• ECDSA-SHA224
• ECDSA-SHA256
• ECDSA-SHA384
• ECDSA-SHA512

The default value is "SHA-256".

SignerCert Property (AS4Web Connector)

The public signing certificate of the partner.

Data Type

Remarks

This property specifies the public certificate of the partner that was used to sign the message. The connector will verify the signature with the public certificate specified here.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.

This property specifies the public certificate of the partner that was used to sign the message. The connector will verify the signature with the public certificate specified here.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.

SigningCert Property (AS4Web Connector)

The certificate used to sign the outgoing AS4 message.

Data Type

Remarks

This property specifies a certificate with private key used to sign the outgoing request and receipts.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

SSLAcceptServerCert Property (AS4Web Connector)

For sending HTTPS requests, a server certificate to unconditionally accept.

Data Type

Remarks

In the Send Connector, this property is used when communicating with trading partners via HTTPS to the URL specified in URL.

In the Receive Connector, this property is used when an asynchronous MDN is requested by your trading partner to the URL specified in MDNDeliveryOption.

When an HTTPS request is issued by the connector, a new secure connection is created with the trading partner. By default, the connector will reject self-signed certificates and any other server certificates not signed by a trusted Certificate Authority (CA).

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the connector to report the server's credentials to Location.

SSLCert Property (AS4Web Connector)

The certificate to use for client authentication during the SSL handshake.

Data Type

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

TempPath Property (AS4Web Connector)

A temporary local directory where data can be stored before the component processes it.

Data Type

String

Default Value

""

Remarks

This property indicates a temporary directory where the connector can store any data before the connector processes it. If TempPath is empty, the connector will receive all data to memory. If set, the connector will generate and write all inbound data to a temporary file in the specified directory.

Once the file is submitted, the connector will handle closing the file stream and deleting the temporary file. However, if the connector is shut down during a transfer some temporary files may be left in the directory. To ensure optimal performance, server administrators should check the directory regularly and remove old or extraneous files. Note: by default, this property is empty and the connector will use memory streams to store all inbound data before submitting it. It is recommended that you use a temporary directory when downloading large batches or batches containing large files to alleviate potential increased memory requirements.

This property is not available in the Sender.

Timeout Property (AS4Web Connector)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the connector will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the connector fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the connector may be changed to absolute timeouts, i.e. the connector will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

TokenPassword Property (AS4Web Connector)

The password used in UsernameToken authentication.

Data Type

Password

Default Value

""

Remarks

This property specifies the password used in UsernameToken authentication.

This property is not available in the Sender.

TokenUser Property (AS4Web Connector)

The user used in UsernameToken authentication.

Data Type

String

Default Value

""

Remarks

This property specifies the user used in UsernameToken authentication. If this is specified UsernameToken authentication will be included in the request.

This property is not available in the Sender.

TradingPartner Property (AS4Web Connector)

The trading partner that will be communicating with this receive location.

Data Type

String

Default Value

""

Remarks

This is the Id of the trading partner that will be communicating with this instance of the AS4 connector.

This property is not available in the Sender.

AS4WebAttr Type

TBD.

Remarks

TBD.

Fields

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

Config Settings (AS4Web Connector)

AS4Web Config Settings

<eb3:PartInfo href="cid:_de48eece-d1d8-4823-8a63-d3a8d14dc1a8@nsoftware">

<eb3:PartInfo href="cid:mypart@myhost">

AS4Component.Config("EDIDataPartId[0]=mypart@myhost");

SSL Config Settings

General Config Settings