AS4Web Adapter
The AS4Web Component adds AS4 receive functionality to BizTalk Server.
Remarks
The AS4Web Adapter supports receiving files into BizTalk. Using a simple application-like design, the adapter allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.
AS4Web Receive Adapter
The AS4Web Receive Adapter implements an AS4 server that can communicate with your BizTalk Server. This accepts files sent by your partner to you (handling incoming push requests).
In order to use the AS4Web Receiver, you must set the AS4SiteURL where your AS4 server is hosted, as well as the TradingPartner and ReceivingPartner AS4 identifiers. The AS4Web Receiver will read all incoming requests and check them against these values to ensure that the request comes from a known sender and is actually intended for the receiving entity.
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 contents are submitted to your BizTalk Server to be processed. Upon successful submission, the adapter will generate and send a receipt if SendReceipt is true.
The AS4Web Receiver is an isolated adapter, meaning that it is hosted by a separate application outside of the BizTalk Server. The adapter uses the incoming HTTP POST URL as the key for storing and retrieving its property set within BizTalk's database. Thus a single page can host multiple trading partner configurations.
Receiver Property List
The following is the full list of the properties of the receiver Adapter with short descriptions. Click on the links for further details.
| AgreementRef | The agreement reference. |
| AS4FromId | The Id of the party. This value is required. |
| AS4FromIdType | The optional type of the Id. If specified this value should be the domain to which the Id belongs. |
| AS4FromRole | This field specifies the role of the party. This may be any value agreed upon by the trading partners. |
| AS4SiteURL | The path to the website hosting the AS4 component. |
| AS4ToId | The Id of the party. This value is required. |
| AS4ToIdType | The optional type of the Id. If specified this value should be the domain to which the Id belongs. |
| AS4ToRole | This field specifies the role of the party. This may be any value agreed upon by the trading partners. |
| DecryptionCert | The certificate with private key used to decrypt. |
| EDIProperties | A collection of file properties. |
| EDIType | The Content-Type of the EDI message. |
| ErrorThreshold | The maximum number of errors before the component shuts down. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| LogDirectory | The path to a directory for logging. |
| LogFile | The log file written. |
| MaxThreads | The maximum number of threads that the component may consume. |
| Other | Defines a set of configuration settings to be used by the component. |
| Profile | The AS4 profile. |
| ReceivedFileName | The name of the file received by the AS4 component. |
| ReceivingPartner | The identity of AS4 receiving entity. |
| RegisterIsolatedReceiverTimeout | This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the component runtime license key. |
| SendReceipt | Whether to send a receipt. |
| SignatureAlgorithm | Signature algorithm to be used in the message. |
| SignerCert | The public signing certificate of the partner. |
| SigningCert | The certificate used to sign the outgoing AS4 message. |
| SSLAcceptServerCert | For sending HTTPS requests, a server certificate to unconditionally accept. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| TempPath | A temporary local directory where data can be stored before the component processes it. |
| Timeout | A timeout for the component. |
| TokenPassword | The password used in UsernameToken authentication. |
| TokenUser | The user used in UsernameToken authentication. |
| TradingPartner | The trading partner that will be communicating with this receive location. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Config Settings
The following is a list of config settings for the Adapter with short descriptions. Click on the links for further details.
| AllowWarnings | Whether warnings are interpreted as fatal errors. |
| ContentTransferEncoding | The content encoding of the payload data. |
| DetectDuplicates | Whether to detect duplicate messages when receiving. |
| EncryptionSecurityTokenFormat | The format to use for the security token when encryption. |
| FilenameProperty | Defines a part property to hold the filename. |
| ForceSigningCert | Whether to force only the SigningCert to be used for signing. |
| FromId[i] | The Id of the party specified by AS4From. |
| FromIdCount | The number of Ids for the party specified by AS4From. |
| FromIdType[i] | The Id type of the party specified by AS4From. |
| KeyEncryptionAlgorithm | The algorithm used to encrypt the key. |
| LogLevel | The level of information to log. |
| LogOptions | The information to be written to log files. |
| OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used when encrypting a key. |
| OAEPParams | The hex encoded OAEP parameters to be used when encrypting a key. |
| OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
| ReceiptURL | The URL to which receipts are sent. |
| ReferenceHashAlgorithm | The hash algorithm used to has the data specified in the reference of a signature. |
| RequireEncryption | Whether encryption is required when processing received messages. |
| RequireSignature | Whether a signature is required when processing received messages. |
| SignerCACert | The CA certificates that issued the signer certificate. |
| SigningSecurityTokenFormat | The format to use for the security token when signing. |
| TempPath | Where temporary files are optionally written. |
| ToId[i] | The Id of the party specified by AS4To. |
| ToIdCount | The number of Ids for the party specified by AS4To. |
| ToIdType[i] | The Id type of the party specified by AS4To. |
| TokenPasswordType | The password type used in UsernameToken authentication. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
AS4Web Receiver
How to Configure a AS4Web Receive Location with the BizTalk Server Administration Console
To configure the receive location by using the BizTalk Server Administration console, use the following procedure:
NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.
To configure receive location variables for a AS4Web receive location:
- In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
- In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
- In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
- In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.AS4Web 2022 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
-
In the nsoftware.AS4Web 2022 Transport Properties dialog box, you will find the following properties:
AgreementRef The agreement reference.
Type: xs:string Default Value: ""
AS4FromId The Id of the party. This value is required.
Type: xs:string Default Value: ""
NOTE: This property must have a value.AS4FromIdType The optional type of the Id. If specified this value should be the domain to which the Id belongs.
Type: xs:string Default Value: ""
AS4FromRole This field specifies the role of the party. This may be any value agreed upon by the trading partners.
Type: xs:string Default Value: "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator"
AS4SiteURL The path to the website hosting the AS4 component.
Type: xs:string Default Value: ""
NOTE: This property must have a value.AS4ToId The Id of the party. This value is required.
Type: xs:string Default Value: ""
NOTE: This property must have a value.AS4ToIdType The optional type of the Id. If specified this value should be the domain to which the Id belongs.
Type: xs:string Default Value: ""
AS4ToRole This field specifies the role of the party. This may be any value agreed upon by the trading partners.
Type: xs:string Default Value: "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder"
DecryptionCert The certificate with private key used to decrypt.
Type: Certificate Default Value: null
NOTE: The digital id must have a private key associated with it.EDIProperties A collection of file properties.
Type: xs:string Default Value: ""
EDIType The Content-Type of the EDI message.
Type: xs:string Default Value: "application/edi-x12"
ErrorThreshold The maximum number of errors before the component shuts down.
Type: xs:int Default Value: 5
Firewall A set of properties related to firewall access.
Type: Firewall Default Value: null
HTTPProxy A set of properties related to proxy access.
Type: Proxy Default Value: null
LogDirectory The path to a directory for logging.
Type: xs:string Default Value: ""
LogFile The log file written.
Type: xs:string Default Value: ""
MaxThreads The maximum number of threads that the component may consume.
Type: xs:int Default Value: 20
Other Defines a set of configuration settings to be used by the component.
Type: xs:string Default Value: ""
Profile The AS4 profile.
Type: xs:int Default Value: 0
ReceivedFileName The name of the file received by the AS4 component.
Type: xs:string Default Value: ""
ReceivingPartner The identity of AS4 receiving entity.
Type: xs:string Default Value: ""
NOTE: This property must have a value.RegisterIsolatedReceiverTimeout This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.
Type: xs:int Default Value: 15
RequeueEndpoints Whether to requeue receive endpoints if the polling interval has not been reached.
Type: bool Default Value: false
RuntimeLicense Specifies the component runtime license key.
Type: xs:string Default Value: ""
SendReceipt Whether to send a receipt.
Type: bool Default Value: true
SignatureAlgorithm Signature algorithm to be used in the message.
Type: xs:string Default Value: "sha256"
SignerCert The public signing certificate of the partner.
Type: Certificate Default Value: null
SigningCert The certificate used to sign the outgoing AS4 message.
Type: Certificate Default Value: null
NOTE: The digital id must have a private key associated with it.SSLAcceptServerCert For sending HTTPS requests, a server certificate to unconditionally accept.
Type: Certificate Default Value: null
SSLCert The certificate to use for client authentication during the SSL handshake.
Type: Certificate Default Value: null
NOTE: The digital id must have a private key associated with it.TempPath A temporary local directory where data can be stored before the component processes it.
Type: xs:string Default Value: ""
Timeout A timeout for the component.
Type: xs:int Default Value: 60
TokenPassword The password used in UsernameToken authentication.
Type: baf:Password Default Value: ""
TokenUser The user used in UsernameToken authentication.
Type: xs:string Default Value: ""
TradingPartner The trading partner that will be communicating with this receive location.
Type: xs:string Default Value: ""
NOTE: This property must have a value.TransportLog Tells the component where and how to report information about its operations.
Type: Log Default Value: null
URI The Uniform Resource Identifier (URI) of the send port or receive location.
Type: xs:string Default Value: ""
- Click OK.
- Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.
AgreementRef Property (AS4Web Adapter)
The agreement reference.
Data Type
StringDefault 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.
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 property.
AS4FromId Property (AS4Web Adapter)
The Id of the party. This value is required.
Data Type
StringDefault 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.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"
AS4FromIdType Property (AS4Web Adapter)
The optional type of the Id. If specified this value should be the domain to which the Id belongs.
Data Type
StringDefault 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.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"
AS4FromRole Property (AS4Web Adapter)
This field specifies the role of the party. This may be any value agreed upon by the trading partners.
Data Type
StringDefault 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.
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"
AS4SiteURL Property (AS4Web Adapter)
The path to the website hosting the AS4 component.
Data Type
StringDefault Value
""Remarks
This is the virtual path of the application that will host the instance of the AS4 adapter. It is not necessary to include the schema ("http") or host information: the adapter will ignore everything other than the path information. For example, if the URL you would post to is "http://localhost/AS4Receiver/AS4Server.aspx", you only need to set "/AS4Receiver/AS4Server.aspx".
It is possible to set up a single web page to process requests received from more than one TradingPartner, as well as to host more than one ReceivingPartner.
This property is not available in the Sender.
AS4ToId Property (AS4Web Adapter)
The Id of the party. This value is required.
Data Type
StringDefault 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.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId"
AS4ToIdType Property (AS4Web Adapter)
The optional type of the Id. If specified this value should be the domain to which the Id belongs.
Data Type
StringDefault 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.
This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type"
AS4ToRole Property (AS4Web Adapter)
This field specifies the role of the party. This may be any value agreed upon by the trading partners.
Data Type
StringDefault 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.
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"
DecryptionCert Property (AS4Web Adapter)
The certificate with private key used to decrypt.
Data Type
CertificateRemarks
This property specifies the certificate with private key used to decrypt received data.
This property is not available in the Sender.
EDIProperties Property (AS4Web Adapter)
A collection of file properties.
Data Type
StringDefault Value
""Remarks
This property holds file level properties.
The properties are specified one per line. The syntax is a follows:
PropertyName=PropertyValue
For instance, the value below includes two properties.
Prop1=Value1
Prop2=Value2
EDIType Property (AS4Web Adapter)
The Content-Type of the EDI message.
Data Type
StringDefault Value
"application/edi-x12"Remarks
The Content-Type of the EDI message. Sample values are "application/edi-x12", "application/edifact" or "application/xml".
ErrorThreshold Property (AS4Web Adapter)
The maximum number of errors before the component shuts down.
Data Type
IntegerDefault Value
5Remarks
This property limits the number of errors that the adapter can incur before it shuts down and stops processing messages.
If set to 0 the adapter will never shutdown.
Note that if the operation completes successfully the current error count will be reset.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
This property is not available in the Sender.
Firewall Property (AS4Web Adapter)
A set of properties related to firewall access.
Data Type
FirewallRemarks
This is a Firewall type property which contains fields describing the firewall through which the adapter will attempt to connect.
HTTPPassword Property (AS4Web Adapter)
A password if authentication is to be used.
Data Type
PasswordDefault Value
""Remarks
This property holds the password used for HTTP authentication.
This property is not available in the Receiver.
HTTPProxy Property (AS4Web Adapter)
A set of properties related to proxy access.
Data Type
ProxyRemarks
This is a Proxy type property which contains fields describing the proxy through which the adapter will attempt to connect.
HTTPUser Property (AS4Web Adapter)
A user name if authentication is to be used.
Data Type
StringDefault Value
""Remarks
This property holds the user used for HTTP authentication.
This property is not available in the Receiver.
LogDirectory Property (AS4Web Adapter)
The path to a directory for logging.
Data Type
StringDefault Value
""Remarks
The directory in which log files are created. The adapter will create log files that detail each transmission.
The verbosity of the logs is controlled by LogLevel.
LogFile Property (AS4Web Adapter)
The log file written.
Data Type
StringDefault 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 adapter has processed the message to determine the exact name of the log file.
MaxThreads Property (AS4Web Adapter)
The maximum number of threads that the component may consume.
Data Type
IntegerDefault Value
20Remarks
This property limits the number of concurrent threads that the adapter may consume while completing its work.
This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.
MaxTransmissionBatchSize Property (AS4Web Adapter)
The maximum number of messages that can be sent in a single batch.
Data Type
IntegerDefault Value
1Remarks
This property controls the maximum size of an outbound message batch.
Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.
Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.
This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.
This property is not available in the Receiver.
Other Property (AS4Web Adapter)
Defines a set of configuration settings to be used by the component.
Data Type
StringDefault Value
""Remarks
The adapter 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 adapter, 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 Adapter)
The AS4 profile.
Data Type
EnumerationPossible Values
Standard (0)ENTSOG (1)
ESENS (2)
Default Value
0Remarks
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:
| 0 (ebfStandard - default) | The AS4 Profile of ebMS 3.0 Version 1.0 OASIS Standard |
| 1 (ebfENTSOG) | The ENTSOG AS4 Profile |
| 2 (ebpfEDelivery) | The eDelivery AS4 Profile |
When Profile is set to ebpfENTSOG the following settings are automatically applied:
| Property | Value |
| CompressionFormat | ebcfGZIP |
| EncryptionAlgorithm | "AES128GCM" |
| ConversationId | Remains empty |
| SignatureAlgorithm | "SHA256" |
| OAEPRSAHashAlgorithm | "SHA256" |
| OAEPMGF1HashAlgorithm | "SHA256" |
When Profile is set to ebpfEDelivery the following settings are automatically applied:
| Property | Value |
| CompressionFormat | ebcfGZIP |
| EncryptionAlgorithm | "AES128GCM" |
| RequireEncryption | True |
| RequireSignature | True |
| SignatureAlgorithm | "SHA256" |
| OAEPRSAHashAlgorithm | "SHA256" |
| OAEPMGF1HashAlgorithm | "SHA256" |
| EncryptionSecurityTokenFormat | 1 (Binary) |
| SigningSecurityTokenFormat | 1 (Binary) |
ReceivedFileName Property (AS4Web Adapter)
The name of the file received by the AS4 component.
Data Type
StringDefault Value
""Remarks
If a file name is included in the AS4 request's message headers, it will be written to this context property.
Note: this value is also placed in the File.ReceivedFileName and the FTP.ReceivedFileName context properties. This is to ensure compatibility with other adapters that poll those context properties to fill out macros such as %SourceFileName%.
This property is not available in the Sender.
ReceivingPartner Property (AS4Web Adapter)
The identity of AS4 receiving entity.
Data Type
StringDefault 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.
RegisterIsolatedReceiverTimeout Property (AS4Web Adapter)
This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.
Data Type
IntegerDefault Value
15Remarks
When processing an incoming request from the HTTP endpoints the adapter will look for the URI of a receive location which matches the incoming request. This process communicates with BizTalk and in high load scenarios this operation may require additional time to complete. The default value is 15 seconds. If an intermittent "Timeout while waiting for endpoint configuration" error is seen, set this to a larger value.
This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.
This property is not available in the Sender.
RequeueEndpoints Property (AS4Web Adapter)
Whether to requeue receive endpoints if the polling interval has not been reached.
Data Type
BooleanDefault Value
falseRemarks
This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.
When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.
If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.
The default value is No.
This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.
This property is not available in the Sender.
RuntimeLicense Property (AS4Web Adapter)
Specifies the component runtime license key.
Data Type
StringDefault Value
""Remarks
You can use the RuntimeLicense property to set the runtime key for the adapter license.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
SendReceipt Property (AS4Web Adapter)
Whether to send a receipt.
Data Type
BooleanDefault Value
trueRemarks
This property indicates whether a receipt should be sent after downloading files.
The adapter 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.
SignatureAlgorithm Property (AS4Web Adapter)
Signature algorithm to be used in the message.
Data Type
StringDefault 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)
The default value is "sha-256".
SignerCert Property (AS4Web Adapter)
The public signing certificate of the partner.
Data Type
CertificateRemarks
This property specifies the public certificate of the partner that was used to sign the message. The adapter 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 adapter 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. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.
Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.
Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.
SigningCert Property (AS4Web Adapter)
The certificate used to sign the outgoing AS4 message.
Data Type
CertificateRemarks
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. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.
To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.
Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.
SSLAcceptServerCert Property (AS4Web Adapter)
For sending HTTPS requests, a server certificate to unconditionally accept.
Data Type
CertificateRemarks
In the Send Adapter, this property is used when communicating with trading partners via HTTPS to the URL specified in URL.
In the Receive Adapter, 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 adapter, a new secure connection is created with the trading partner. By default, the adapter 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 adapter 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. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.
Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.
Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.
Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter 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 adapter to report the server's credentials to Location.
SSLCert Property (AS4Web Adapter)
The certificate to use for client authentication during the SSL handshake.
Data Type
CertificateRemarks
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. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.
To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.
Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.
TempPath Property (AS4Web Adapter)
A temporary local directory where data can be stored before the component processes it.
Data Type
StringDefault Value
""Remarks
This property indicates a temporary directory where the adapter can store any data before the adapter processes it. If TempPath is empty, the adapter will receive all data to memory. If set, the adapter will generate and write all inbound data to a temporary file in the specified directory.
Once the file is submitted, the adapter will handle closing the file stream and deleting the temporary file. However, if the adapter 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.
This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime. Note: by default, this property is empty and the adapter 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 Adapter)
A timeout for the component.
Data Type
IntegerDefault Value
60Remarks
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 adapter will wait for the operation to complete before returning control.
If Timeout expires, and the operation is not yet complete, the adapter 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 adapter may be changed to absolute timeouts, i.e. the adapter 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 Adapter)
The password used in UsernameToken authentication.
Data Type
PasswordDefault Value
""Remarks
This property specifies the password used in UsernameToken authentication.
This property is not available in the Sender.
TokenUser Property (AS4Web Adapter)
The user used in UsernameToken authentication.
Data Type
StringDefault 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 Adapter)
The trading partner that will be communicating with this receive location.
Data Type
StringDefault Value
""Remarks
This is the Id of the trading partner that will be communicating with this instance of the AS4 adapter.
This property is not available in the Sender.
TransmitBatchMode Property (AS4Web Adapter)
How the transmitter processes batches.
Data Type
EnumerationPossible Values
Parallel (0)Serial (1)
Default Value
0Remarks
This property controls how the transmitter processes message batches:
| Parallel | The adapter will process however many batches the BizTalk Message Engine sends it.
The number of maximum concurrent batches may be controlled by the MaxThreads property. |
| Serial | The adapter will queue batches from the BizTalk Message Engine and process them one at a time. |
This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.
This property is not available in the Receiver.
TransportLog Property (AS4Web Adapter)
Tells the component where and how to report information about its operations.
Data Type
LogRemarks
This is a Log type property which contains fields describing how and where the adapter will record information about its execution.
This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.
URI Property (AS4Web Adapter)
The Uniform Resource Identifier (URI) of the send port or receive location.
Data Type
StringDefault Value
""Remarks
This property specifies a URI for the send port or receive location. Setting this property is optional.
By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.
If this value is specified it must begin with the correct prefix, as seen in the default value.
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
|
Store String |
The name of the certificate store for the client certificate. The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword. Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
StorePassword String |
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
StoreType CertStoreTypes |
The type of certificate store for this certificate. The adapter supports both public and private keys in a variety of formats. When the cstAuto value is used the adapter will automatically determine the type. This field can take one of the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The subject of the certificate used for client authentication. When this property is set, a search is performed in the current certificate store certificate with matching subject. If an exact match is not found, the store is searched for subjects containing the value of the property. When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US Example (Searching with partial subject)
If a match is not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. If a matching certificate is found, Subject is set to the full subject of the matching certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Thumbprint String |
The thumbprint of the certificate. This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Certificate();
Creates a Certificate instance whose properties can be set.
public Certificate(string certificateFile);
Opens CertificateFile and reads out the contents as an X509 public key.
public Certificate(byte[] certificateData);
Parses CertificateData as an X509 public key.
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.
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
|
AutoDetect Boolean |
Tells the adapter whether or not to automatically detect and use firewall system settings, if available. |
||||||||
|
FirewallType FirewallTypes |
Determines the type of firewall to connect through. The applicable values are the following:
|
||||||||
|
Host String |
Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting. If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
|
Password String |
A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired. |
||||||||
|
Port Integer |
The TCP port for the firewall Host. See the description of the Host field for details. Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details. |
||||||||
|
User String |
A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Firewall();
Log Type
A log where the component will record information about its operations.
Remarks
This describes how and where the adapter will record information describing its execution.
Fields
|
Location String |
This field describes the location where the logging information is to be written. If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter. If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system. The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log. |
||||||||||
|
LogMode LogModes |
This field controls what information the adapter logs. The possible values have the following affect on the adapter's behavior:
|
||||||||||
|
LogType LogTypes |
This property controls where the adapter will log the information. The possible values have the following affect on the adapter's behavior:
|
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Log();
public Log(LogTypes logType, string location, LogModes logMode);
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
|
AuthScheme ProxyAuthSchemes |
Use the AuthScheme field to tell the adapter which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set. AuthScheme should be set to authNone (3) when no authentication is expected. By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead. If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the adapter. Look at the configuration file for the adapter being used to find more information about manually setting this token. If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package. For security reasons, setting this property will clear the values of User and Password. |
||||||||
|
AutoDetect Boolean |
Tells the adapter whether or not to automatically detect and use proxy system settings, if available. |
||||||||
|
Password String |
A password if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
||||||||
|
Port Integer |
The TCP port for the proxy Server (default 80). See the description of the Server field for details. |
||||||||
|
Server String |
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned. |
||||||||
|
SSL ProxySSLTypes |
Determines when to use SSL for the connection to the proxy. The applicable values are the following:
|
||||||||
|
User String |
A user name, if authentication is to be used for the proxy. If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]". If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server. If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation. |
Constructors
Constructors are only relevant when configuring adapters in orchestrations.
public Proxy();
public Proxy(string server, int port);
public Proxy(string server, int port, string user, string password);
Config Settings (AS4Web Adapter)
The adapter accepts one or more of the following 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 adapter, access to these internal properties is provided through the Other property.AS4Web Config Settings | ||||||||||||||||||||||||
| AllowWarnings: Whether warnings are interpreted as fatal errors.When set to False (default) any ebMS level error returned by the other party will be considered an error and cause an exception. When set to True the severity of the ebMS error will be inspected. If the severity is "warning" it will not cause an exception. In this case Errors will still be populated with the error details. | ||||||||||||||||||||||||
ContentTransferEncoding:
The content encoding of the payload data.This setting can be used to specify the content encoding of the payload data of the AS4 message. This is
set to binary (4) by default. Possible values for the this field are:
|
||||||||||||||||||||||||
| DetectDuplicates:
Whether to detect duplicate messages when receiving.Whether to detect duplicate messages. If set to True LogDirectory must be set. When a file is received
the adapter will store a file containing the MessageId of the received file. When additional files are
received the adapter will scan the LogDirectory to see if a file with the same MessageId has already
been received. If a duplicate is detected an entry is added to the .log file and Log fires.
The default value depends on the Profile. For the Standard profile the default value is False. When Profile is set to ENTSOG this value is set to True. |
||||||||||||||||||||||||
EncryptionSecurityTokenFormat:
The format to use for the security token when encryption.This setting specifies the security token format that is included in the message when encrypting.
This setting should only be set if there is a specific reason to do so. This specifies the reference
type in the SecurityTokenReference element applicable to the encrypted data. Possible values
are:
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when Profile is set to eDelivery is 1 (Binary). |
||||||||||||||||||||||||
| FilenameProperty:
Defines a part property to hold the filename.This setting specifies the PropertyName that will hold the name of the file. This may be used
to preserve filenames. Both the client and server must agree on the name of the property that will be
used to hold the filename.
This is helpful in the case where Profile is set to ebpfStandard and the first file being sent is of type "text/xml" or "application/xml". In that case the file content is included in the SOAP body and there is no standard mechanism for preserving the filename. When set the adapter will automatically populate the property when sending files and will read the filename from this property when receiving files. By default this is not specified. Note: The filenames will always be preserved within the MIME header attributes whenever possible regardless of whether this setting is specified. |
||||||||||||||||||||||||
| ForceSigningCert:
Whether to force only the SigningCert to be used for signing.When set to False the adapter will first check SigningCert for a certificate to use
for signing operations. If SigningCert is not specified it will use the certificate specified in Certificate.
If set to True (default) the adapter will only attempt to use the certificate specified by SigningCert. If SigningCert is not specified signing will not be attempted. |
||||||||||||||||||||||||
| FromId[i]: The Id of the party specified by AS4From.This setting sets the Id of the party specified by AS4From at the index specified here. This is only used when multiple Ids are set. See FromIdCount for more details. | ||||||||||||||||||||||||
FromIdCount:
The number of Ids for the party specified by AS4From.Multiple Ids may be specified for the AS4From party. This setting defines the total number of Ids.
This is used in conjunction with FromId and FromIdType. For instance:
component.Config("FromIdCount=2");
component.Config("FromId[0]=id1");
component.Config("FromIdType[0]=mytype");
component.Config("FromId[1]=id2");
When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the Id field of AS4From. |
||||||||||||||||||||||||
| FromIdType[i]: The Id type of the party specified by AS4From.This setting sets the Id type of the party specified by AS4From at the index specified here. This is only used when multiple Ids are set. See FromIdCount for more details. | ||||||||||||||||||||||||
KeyEncryptionAlgorithm:
The algorithm used to encrypt the key.This setting specifies the algorithm used to encrypt the key for this message. In most cases
this should not be changed. Only change this value if there is a specific reason to do so.
Possible values are:
|
||||||||||||||||||||||||
LogLevel:
The level of information to log.This setting specifies the level of detail that is logged to the Log event and to any log files on disk.
Possible value are:
|
||||||||||||||||||||||||
LogOptions:
The information to be written to log files.When LogDirectory is set, several pieces of information are written to log files in the specified directory. Set
LogOptions to one or more of the following values to control what information is written to file. When specifying
multiple values, include them in the same string (i.e. "LogOptions=Incoming, Outgoing, Log"). The default value is All.
Possible values are:
|
||||||||||||||||||||||||
OAEPMGF1HashAlgorithm:
The MGF1 hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP.
Possible values are:
Note: If Profile is set to ENTSOG the MGF1HashAlgorithm will be set to "SHA256" by default. |
||||||||||||||||||||||||
| OAEPParams: The hex encoded OAEP parameters to be used when encrypting a key.This setting is optional and should only be specified if OAEP parameters need to be explicitly set. The value specified should be a hex string. By default this setting is unspecified. | ||||||||||||||||||||||||
OAEPRSAHashAlgorithm:
The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key.
This may differ from the hash algorithm used to sign the AS4 message content. Possible values are:
|
||||||||||||||||||||||||
| ReceiptURL:
The URL to which receipts are sent.This property specifies the URL to which receipts are sent if different than URL. This property
should only be set if receipts must be sent to an alternate URL.
This setting is only applicable to the Receive adapter |
||||||||||||||||||||||||
ReferenceHashAlgorithm:
The hash algorithm used to has the data specified in the reference of a signature.When signing the content being signed is referred to by a reference in the Signature element. This setting
specifies the hash algorithm used when computing the reference digest. Possible values are:
|
||||||||||||||||||||||||
| RequireEncryption: Whether encryption is required when processing received messages.This setting may be set to True to require that received messages are encrypted. When True if a message is received that is not encrypted the adapter will throw an exception. The default value is False. | ||||||||||||||||||||||||
| RequireSignature: Whether a signature is required when processing received messages.This setting may be set to True to require that received messages are signed. When True if a message is received that is not signed the adapter will throw an exception. The default value is False. | ||||||||||||||||||||||||
| SignerCACert:
The CA certificates that issued the signer certificate.This setting may be set prior to signature verification when receiving messages that are signed using a certificate
specified in the message itself as a BinarySecurityToken.
If this setting is specified, the adapter will verify the chain of the signer certificate against the CA
list set in this setting. To specify one or more CA certificate prior to signature verification set
this to the base64 encoded public certificate of each CA certificate. Each additional certificate can be
added by prepending the data with a + character. If the value begins with a + the adapter
will add the following value to an internal store of CA certificates. For instance:
If the chain validation fails during signature verification the adapter throws an exception. If this setting is not specified no chain validation is performed. |
||||||||||||||||||||||||
SigningSecurityTokenFormat:
The format to use for the security token when signing.This setting specifies the security token format that is included in the message when signing.
This setting should only be set if there is a specific reason to do so. This specifies the reference
type in the SecurityTokenReference element applicable to the signed data. Possible values
are:
The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when Profile is set to eDelivery is 1 (Binary). |
||||||||||||||||||||||||
| TempPath: Where temporary files are optionally written.When processing large files an excessive amount of memory may be used, leading to out-of-memory exceptions. To reduce the amount of memory used, partially encoded files can be written to a temporary directory. Set this to a folder on disk where temporary files may be written. | ||||||||||||||||||||||||
| ToId[i]: The Id of the party specified by AS4To.This setting sets the Id of the party specified by AS4To at the index specified here. This is only used when multiple Ids are set. See ToIdCount for more details. | ||||||||||||||||||||||||
ToIdCount:
The number of Ids for the party specified by AS4To.Multiple Ids may be specified for the AS4To party. This setting defines the total number of Ids.
This is used in conjunction with ToId and ToIdType. For instance:
component.Config("ToIdCount=2");
component.Config("ToId[0]=id1");
component.Config("ToIdType[0]=mytype");
component.Config("ToId[1]=id2");
When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the Id field of AS4To. |
||||||||||||||||||||||||
| ToIdType[i]: The Id type of the party specified by AS4To.This setting sets the Id type of the party specified by AS4To at the index specified here. This is only used when multiple Ids are set. See ToIdCount for more details. | ||||||||||||||||||||||||
TokenPasswordType:
The password type used in UsernameToken authentication.This setting specifies the type of password specified when TokenUser and TokenPassword are set.
TokenPassword should normally be set to the plaintext password that both the client and server know.
The adapter will automatically use SHA-1 to create a hash of the password when TokenPasswordType is set to
Digest (default). The hashed password is sent in the request, along with a creation date and nonce.
The server will validate these values when receiving the request. Possible values are:
This setting is only applicable to the Receive adapter |
||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||
| ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the adapter will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||
| SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. |
||||||||||||||||||||||||
| SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the adapter will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when UseInternalSecurityAPI is False (default):
// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA
Possible values when UseInternalSecurityAPI is True include:
If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||
| SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7. Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True. |
||||||||||||||||||||||||
| SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.
If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider. |
||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
|
||||||||||||||||||||||||
| TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is
True and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the adapter will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the adapter will fail with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||
| TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||
| TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||
| TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||
General Config Settings | ||||||||||||||||||||||||
| AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. | ||||||||||||||||||||||||
| LocalHost:
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the adapter initiate connections (or accept in the case of server adapters) only through that interface. If the adapter is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||
| TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the adapter whether or not to use the system security libraries or an internal implementation.
By default the adapter will use the system security libraries to perform cryptographic functions where applicable.
When set to False calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to True.
Setting this to True tells the adapter to use the internal implementation
instead of using the system's security API.
Note: This setting is static. The value set is applicable to all adapters used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |
Supported Macros
The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.
| Temp | This is resolved to the full path to the system's temporary directory. |
| MessageID | Globally unique identifier (GUID) of the message in BizTalk Server. |
| SourceFileName | The original file name. This includes the extension and excludes the file path, for example, Sample.xml |
| SourceFileNameNoExt | The original file name without the extension or file path, for example, Sample |
| RemoteFileName | The name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. |
| DestinationParty | Name of the destination party. |
| DestinationPartyQualifier | Qualifier of the destination party. |
| SourceParty | Name of the source party. |
| SourcePartyQualifier | Qualifier of the source party. |
| DateTime:CustomFormat | This special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. |
| Date | The date format yyyy-MM-dd. |
| DateTime | The date format yyyy-MM-ddThhmmss. |
| Time | The date format hhmmss. |
| DateTime_BTS2000 | The date format yyyyMMddhhmmssf. |
| DateTime.TZ | The date format yyyy-MM-ddThhmmsszzz. |
| Time.TZ | The date format hhmmsszzz. |
| Property#<Schema>#<Name> | This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message. |