AS2 Adapter

The AS2 Component adds AS2 send and receive capabilities to BizTalk Server.

Remarks

The AS2 Adapter adds AS2 send and receive capabilities to your BizTalk Server. Built on top of the Drummond/eBusinessReady Certified EDI Integrator / AS2 Engine, the adapter allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.

AS2 Receive Adapter

The AS2 Receive Adapter implements a fully-functional AS2 server that can communicate with your BizTalk Server. In order to use the AS2 Receiver, you must set the AS2SiteURL where your AS2 server is hosted, as well as the TradingPartner and ReceivingPartner AS2 identifiers. The AS2 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.

Once the incoming AS2 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 an MDN receipt to your trading partner. If you wish to replace the default message generated by the adapter with your own message, you may set the ReceiptMessage property when configuring a receive location.

The AS2 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.

AS2 Send Adapter

The AS2 Send Adapter adds a complete AS2 client within your BizTalk Server. In order to use it, you must set a minimum of three required properties: AS2To, AS2From and URL. It is also recommended that you set MDNTo, RecipientCert, ReceiptSignerCert, and SigningCert in order to make use of security, reliability, and non-repudiation.

The AS2 Send Adapter has support for SSL transport layer security. This may be enabled by setting the SSLCert and SSLAcceptServerCert to appropriate values.

Certification and Interoperability

The AS2 Adapter for BizTalk Server has been built on top of the EDI Integrator / AS2 Engine which has successfully completed the latest Drummond/eBusinessReady Certified program for AS2 interoperability. The product has undergone rigorous compliance testing and QA, demonstrating successful interoperability with all other DGI (UCC) AS2 certified products.

The eBusinessReady program provides neutral third party testing of solutions for interoperability and compliance. eBusinessReady is a joint partnership of the UCC (Uniform Code Council, Inc) and DGI (Drummond Group, Inc).

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

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.


AS2From	The identity of the sending system.
AS2RequestFrom	The identity of the sending system.
AS2RequestSubject	The subject of the received message.
AS2SiteURL	The path to the website hosting the AS2 component.
AS2Subject	The subject of the message.
AS2To	The identity of the receiving system.
EDIType	The MIME type of the data.
EncryptionCert	The digital id to be used for decryption.
EncryptionType	The MIME type of the encrypted data.
ErrorProcessingFlags	Flags controlling request processing errors.
ErrorReportingFlags	Flags controlling how errors affect the MDN.
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.
MDN	The MDN generated by the component.
MDNDisposition	The Disposition header in the MDN receipt.
MDNMICAlgorithm	The algorithm used to sign the outgoing MDN.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message.
MDNReceipt	The MDN-based receipt generated by the component.
MDNReportingUA	The name of the user agent performing the disposition.
MDNSendingMode	The level of end user interaction involved in sending the MDN.
MDNSignatureStatus	The validity of the signature in the MDN receipt.
MDNSigningCert	The digital id to be used to sign the MDN (optional).
MDNWarning	A warning to appear in the MDN.
MessageSecurity	Required security level for incoming messages.
Other	Defines a set of configuration settings to be used by the component.
ReceiptDeliveryOption	A URL indicating how the receipt is to be delivered.
ReceiptHeaders	The AS2 headers that are returned with the receipt.
ReceiptMessage	The textual message that is included in the receipt.
ReceiptSigningProtocol	The protocol used to sign the outgoing MDN receipt.
ReceivedFileName	The name of the file received by the AS2 component.
ReceiveMode	Controls whether the component is configured to process AS2 messages or MDN receipts.
ReceivingPartner	The identity of AS2 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.
RestartDirectory	The directory to log cached files when using AS2 restart functionality.
RolloverCertificate	The rollover decryption and receipt signing certificate.
RuntimeLicense	Specifies the component runtime license key.
ScanResult	The result of parsing the request.
SignerCert	The signing certificate of the trading partner.
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.
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.

Sender Property List

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


AS2From	The identity of the sending system.
AS2MessageId	The Id of the message.
AS2Subject	The subject of the message.
AS2To	The identity of the receiving system.
AS2Version	The version of AS2 being used.
CompressionFormat	The compression format (if any) to use.
EDIFileName	The name to be used in the Content-Disposition MIME header of the outbound request.
EDIType	The MIME type of the data.
EncryptionAlgorithm	The algorithm, if any, used to encrypt the EDI data.
Etag	The etag of the file.
Firewall	A set of properties related to firewall access.
From	The email address of the HTTP agent (optional).
HTTPPassword	A password if authentication is to be used.
HTTPProxy	A set of properties related to proxy access.
HTTPUser	A user name if authentication is to be used.
LogDirectory	The path to a directory for logging.
LogFile	The log file written.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
MDN	The MDN generated by the component.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message.
MDNOptions	Used to indicate the options requested for the MDN receipt.
MDNTo	Used to indicate that a message disposition notification is requested.
Other	Defines a set of configuration settings to be used by the component.
ReceiptHeaders	The AS2 headers that are returned with the receipt.
ReceiptMessage	The textual message that is included in the receipt.
ReceiptSignerCert	The certificate of the receipt signer.
RecipientCert	The certificate of the recipient.
RestartDirectory	The directory to log cached files when using AS2 restart functionality.
RolloverSigningCert	An additional certificate used to sign the outgoing AS2 request when transitioning certificates.
RuntimeLicense	Specifies the component runtime license key.
SigningCert	The certificate used to sign the outgoing AS2 request.
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.
TransmitBatchMode	How the transmitter processes batches.
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.
URL	The URL to post to.
UserAgent	Information about the user agent.

Config Settings

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


AcceptAnySignerCert	Used to accept trust any signing certificate unconditionally.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
IgnoreLoggingErrors	Whether to ignore errors that occur when writing to the log.
LogDebug	Whether to log debug data.
MDNDeliveryOption	A URL indicating how the receipt is to be delivered.
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.
OtherHeaders	Other headers as determined by the user.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
SMTPFrom	The senders address for asynchronous MDN delivery.
SMTPServer	The SMTP server for asynchronous MDN delivery.
SMTPSubject	The SMTP message subject for asynchronous MDN delivery.
UseChunkedEncoding	Whether to chunk outgoing posts.
UseOAEP	Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA.
UsePSS	Whether to use RSA-PSS when signing.
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	Whether or not to use the system security libraries or an internal implementation.

AS2 Receiver

How to Configure a AS2 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 AS2 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.AS2 2024 from the drop-down list, and then click Configure to configure the transport properties for the receive location.

In the nsoftware.AS2 2024 Transport Properties dialog box, you will find the following properties:


AS2From	The identity of the sending system. Type: xs:string Default Value: "" NOTE: This property must have a value.
AS2RequestFrom	The identity of the sending system. Type: xs:string Default Value: ""
AS2RequestSubject	The subject of the received message. Type: xs:string Default Value: ""
AS2SiteURL	The path to the website hosting the AS2 component. Type: xs:string Default Value: "" NOTE: This property must have a value.
AS2Subject	The subject of the message. Type: xs:string Default Value: ""
AS2To	The identity of the receiving system. Type: xs:string Default Value: "" NOTE: This property must have a value.
EDIType	The MIME type of the data. Type: xs:string Default Value: "application/edi-x12"
EncryptionCert	The digital id to be used for decryption. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
EncryptionType	The MIME type of the encrypted data. Type: xs:string Default Value: ""
ErrorProcessingFlags	Flags controlling request processing errors. Type: xs:int Default Value: 0
ErrorReportingFlags	Flags controlling how errors affect the MDN. Type: xs:int Default Value: 0
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
MDN	The MDN generated by the component. Type: xs:string Default Value: ""
MDNDisposition	The Disposition header in the MDN receipt. Type: xs:string Default Value: ""
MDNMICAlgorithm	The algorithm used to sign the outgoing MDN. Type: xs:int Default Value: 0
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message. Type: xs:string Default Value: ""
MDNReceipt	The MDN-based receipt generated by the component. Type: xs:string Default Value: ""
MDNReportingUA	The name of the user agent performing the disposition. Type: xs:string Default Value: ""
MDNSendingMode	The level of end user interaction involved in sending the MDN. Type: xs:int Default Value: 0
MDNSignatureStatus	The validity of the signature in the MDN receipt. Type: xs:string Default Value: "Valid"
MDNSigningCert	The digital id to be used to sign the MDN (optional). Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
MDNWarning	A warning to appear in the MDN. Type: xs:string Default Value: ""
MessageSecurity	Required security level for incoming messages. Type: xs:int Default Value: 3
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
ReceiptDeliveryOption	A URL indicating how the receipt is to be delivered. Type: xs:string Default Value: ""
ReceiptHeaders	The AS2 headers that are returned with the receipt. Type: xs:string Default Value: ""
ReceiptMessage	The textual message that is included in the receipt. Type: xs:string Default Value: ""
ReceiptSigningProtocol	The protocol used to sign the outgoing MDN receipt. Type: xs:int Default Value: 0
ReceivedFileName	The name of the file received by the AS2 component. Type: xs:string Default Value: ""
ReceiveMode	Controls whether the component is configured to process AS2 messages or MDN receipts. Type: xs:int Default Value: 0
ReceivingPartner	The identity of AS2 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
RestartDirectory	The directory to log cached files when using AS2 restart functionality. Type: xs:string Default Value: ""
RolloverCertificate	The rollover decryption and receipt signing certificate. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
ScanResult	The result of parsing the request. Type: xs:int Default Value: 0
SignerCert	The signing certificate of the trading partner. Type: Certificate Default Value: null
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
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.

AS2 Transmitter

Setting the AS2 Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

Add a Construct Message shape to your orchestration.
Configure the Construct Message shape to construct a new message. (for example Message_2)
Add a Message Assignment shape to the Construct Message shape.
Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the AS2 Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a AS2 send port:

In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.AS2 2024 for the Type option in the Transport section of the General tab.
On the General tab, in the Transport section, click the Configure button next to Type.

In the nsoftware.AS2 2024 Transport Properties dialog box, use the following properties to:


AS2From	The identity of the sending system. Type: xs:string Default Value: "" NOTE: This property must be specified.
AS2MessageId	The Id of the message. Type: xs:string Default Value: "@%MessageId%"
AS2Subject	The subject of the message. Type: xs:string Default Value: ""
AS2To	The identity of the receiving system. Type: xs:string Default Value: "" NOTE: This property must be specified.
AS2Version	The version of AS2 being used. Type: xs:string Default Value: "1.1"
CompressionFormat	The compression format (if any) to use. Type: xs:int Default Value: 0
EDIFileName	The name to be used in the Content-Disposition MIME header of the outbound request. Type: xs:string Default Value: "rfc1767.edi"
EDIType	The MIME type of the data. Type: xs:string Default Value: "application/edi-x12"
EncryptionAlgorithm	The algorithm, if any, used to encrypt the EDI data. Type: xs:string Default Value: "3DES"
Etag	The etag of the file. Type: xs:string Default Value: ""
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
From	The email address of the HTTP agent (optional). Type: xs:string Default Value: ""
HTTPPassword	A password if authentication is to be used. Type: baf:Password Default Value: ""
HTTPProxy	A set of properties related to proxy access. Type: Proxy Default Value: null
HTTPUser	A user name if authentication is to be used. Type: xs:string Default Value: ""
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
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int Default Value: 1
MDN	The MDN generated by the component. Type: xs:string Default Value: ""
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message. Type: xs:string Default Value: ""
MDNOptions	Used to indicate the options requested for the MDN receipt. Type: xs:string Default Value: "signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256, sha1"
MDNTo	Used to indicate that a message disposition notification is requested. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
ReceiptHeaders	The AS2 headers that are returned with the receipt. Type: xs:string Default Value: ""
ReceiptMessage	The textual message that is included in the receipt. Type: xs:string Default Value: ""
ReceiptSignerCert	The certificate of the receipt signer. Type: Certificate Default Value: null
RecipientCert	The certificate of the recipient. Type: Certificate Default Value: null
RestartDirectory	The directory to log cached files when using AS2 restart functionality. Type: xs:string Default Value: ""
RolloverSigningCert	An additional certificate used to sign the outgoing AS2 request when transitioning certificates. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SigningCert	The certificate used to sign the outgoing AS2 request. 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.
Timeout	A timeout for the component. Type: xs:int Default Value: 60
TransmitBatchMode	How the transmitter processes batches. Type: xs:int Default Value: 0
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: ""
URL	The URL to post to. Type: xs:string Default Value: "" NOTE: This property must be specified.
UserAgent	Information about the user agent. Type: xs:string Default Value: *"IPWorks! AS2 Transmitter - www.nsoftware.com"**

Click OK and OK again to save settings.

AS2From Property (AS2 Adapter)

The identity of the sending system.

Data Type

String

Default Value

Remarks

In the AS2Receiver this is your partner's AS2 identifier, and in the AS2Sender this is your AS2 identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

AS2MessageId Property (AS2 Adapter)

The Id of the message.

Data Type

String

Default Value

"@%MessageId%"

Remarks

The Id format is as in RFC 2822: id-left@id-right .

If you set MessageId to a string of the form "@(id-right)" a unique id-left will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same id-right.

You may insert the keyword "%MessageId%" anywhere in the value to have the adapter generate and insert a globally unique identifier.

This property is not available in the Receiver.

AS2RequestFrom Property (AS2 Adapter)

The identity of the sending system.

Data Type

String

Default Value

Remarks

This is your partner's AS2 Identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

This property is not available in the Sender.

AS2RequestSubject Property (AS2 Adapter)

The subject of the received message.

Data Type

String

Default Value

Remarks

The optional human-readable subject of the received message.

This property is not available in the Sender.

AS2SiteURL Property (AS2 Adapter)

The path to the website hosting the AS2 component.

Data Type

String

Default Value

Remarks

This is the virtual path of the application that will host the instance of the AS2 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/AS2Receiver/AS2Server.aspx", you only need to set "/AS2Receiver/AS2Server.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.

AS2Subject Property (AS2 Adapter)

The subject of the message.

Data Type

String

Default Value

Remarks

The optional human-readable subject of the message.

AS2To Property (AS2 Adapter)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

In the AS2Receiver this is your AS2 identifier, and in the AS2Sender this is your partner's AS2 identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

AS2Version Property (AS2 Adapter)

The version of AS2 being used.

Data Type

String

Default Value

"1.1"

Remarks

The version of AS2 being used.

This property is not available in the Receiver.

CompressionFormat Property (AS2 Adapter)

The compression format (if any) to use.

Data Type

Enumeration

Possible Values

None (0)
ZLIB (1)

Default Value

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the adapter to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

This property is not available in the Receiver.

EDIFileName Property (AS2 Adapter)

The name to be used in the Content-Disposition MIME header of the outbound request.

Data Type

String

Default Value

"rfc1767.edi"

Remarks

If set, the value specified will be used when creating the outbound request's Content-Disposition MIME header of the EDI payload.

You may use the macro %SourceFileName% to read and use the value of the ReceivedFileName property in the message context (for compatibility with other adapters that set this context property).

This property is not available in the Receiver.

EDIType Property (AS2 Adapter)

The MIME type of the data.

Data Type

String

Default Value

"application/edi-x12"

Remarks

This property corresponds to the Content-Type header in the AS2 request. This is often used to determine how the message is processed. Suitable MIME types include "application/edi-x12", "application/edifact", or "application/xml".

EncryptionAlgorithm Property (AS2 Adapter)

The algorithm, if any, used to encrypt the EDI data.

Data Type

String

Default Value

"3DES"

Remarks

If RecipientCert is set to a valid certificate, the data will be encrypted using this certificate, with the algorithm specified. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The adapter supports "3DES", or industry-standard 168-bit Triple-DES encryption. Use of this algorithm is strongly recommended.

The adapter supports "RC2", with a default keysize of 128 bits. You may also set "RC2CBC40" or "RC2CBC64" for 40- or 64-bit keysizes.

The adapter also supports single "DES".

In addition, the adapter supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

This property is not available in the Receiver.

EncryptionCert Property (AS2 Adapter)

The digital id to be used for decryption.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for processing encrypted messages. If MDNSigningCert is not set and a digital signature is required by the incoming AS2 request, EncryptionCert will also be used to generate the digital signature.

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.

This property is not available in the Sender.

EncryptionType Property (AS2 Adapter)

The MIME type of the encrypted data.

Data Type

String

Default Value

Remarks

If the data is encrypted, EncryptionType will contain the MIME type of the encrypted data; i.e., "application/pkcs7-mime". If the data is not encrypted EncryptionType will contain an empty string.

At present only "application/pkcs7-mime" is supported for decryption.

This property is not available in the Sender.

ErrorProcessingFlags Property (AS2 Adapter)

Flags controlling request processing errors.

Data Type

Integer

Default Value

Remarks

ErrorReportingFlags is bitmask of values controlling how the errors are reported in the MDN. The adapter can be configured to not halt for certain types of errors by setting ErrorProcessingFlags to the OR of one or more of the following values:


0x04	Unable to validate integrity of data, or unsupported signing protocol used.
0x08	Unable to authenticate the sender.
0x10	Client requested unsupported signature type.
0x20	Client requested unsupported MIC algorithm.

This property is not available in the Sender.

ErrorReportingFlags Property (AS2 Adapter)

Flags controlling how errors affect the MDN.

Data Type

Integer

Default Value

Remarks

By default, the MDN will report an error if any of the conditions below occur. The MIC will not be calculated and the data will be reported as unprocessed. However, the MDN may be configured to permit one or more of the errors below. A warning will be reported if MDNWarning is set; otherwise the error will silently be ignored.

Multiple errors may be permitted by setting ErrorReportingFlags to the OR of one or more of the following values:


0x04 (4)	Unable to validate integrity of data, or unsupported signing protocol used.
0x08 (8)	Unable to authenticate the sender.
0x10 (16)	Client requested unsupported signature type.
0x20 (32)	Client requested unsupported MIC algorithm.

Note: errors should be ignored only with extreme caution, and only by agreement of both trading parties.

This property is not available in the Sender.

ErrorThreshold Property (AS2 Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

Remarks

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.

Etag Property (AS2 Adapter)

The etag of the file.

Data Type

String

Default Value

Remarks

This property is only applicable when RestartDirectory is set. This holds the etag of the file which uniquely identifies it. In most cases you will not need to set or check this value. The adapter will handle the generation and management of this value.

This property is only available at runtime by reading it from the context of a message generated by the adapter.

This property is not available in the Receiver.

Firewall Property (AS2 Adapter)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

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

Note: the Firewall property is only applicable in the Receive Adapter when sending asynchronous MDNs.

From Property (AS2 Adapter)

The email address of the HTTP agent (optional).

Data Type

String

Default Value

Remarks

If the From property contains a non-empty string, an HTTP From: header is added to the request.

This property is not available in the Receiver.

HTTPPassword Property (AS2 Adapter)

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 (AS2 Adapter)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

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

HTTPUser Property (AS2 Adapter)

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 (AS2 Adapter)

The path to a directory for logging.

Data Type

String

Default Value

Remarks

Setting LogDirectory will instruct the adapter to log the details of each transmission to unique files in the specified directory.

In the Send Adapter, the adapter will write a single file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files.

In the Receive Adapter, two files will be written for each transmission. The diagnostic log will have the extension ".log" and will log the complete text of the incoming request, the EDI data (if it could to be determined), and the outgoing response. The data file will have the extension ".dat" and will store the EDI data only. In the event of an error, an additional file with extension ".err" file will be written, and the error information will also be written to the ".log" file.

In both cases, the filenames will be chosen automatically by the adapter. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM. The extensions "-2", "-3", etc. will be used in the case of a file conflict.

If either log cannot be written, an error will be reported in the event log. The BizTalk Server administrator should ensure that the appropriate write permissions are available.

LogFile Property (AS2 Adapter)

The log file written.

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". In case of an error, an additional file will be written with filename LogFile + ".err". In the Receive Adapter, the EDI data will be written with filename LogFile + ".dat".

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 (AS2 Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

Remarks

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 (AS2 Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

Remarks

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.

MDN Property (AS2 Adapter)

The MDN generated by the component.

Data Type

String

Default Value

Remarks

In the Send Adapter, this property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

In the Receive Adapter, MDN will contain the entire text of the Message Disposition Notification generated by the adapter, not including the MIME content-type header. The MDN will be a list of fields in "Field-Name: Field-Value" format, separated by newlines. It will report either success or failure depending on the value of ScanResult.

A variety of properties may be used to customize the outgoing MDN. The MIC algorithm used in the MDN may be set with MDNMICAlgorithm. MDNReportingUA specifies the reporting agent and MDNSendingMode may be used to specify the level of interaction with the user.

The property will be generated and the MDN will be delivered to the sender before it is exposed in the adapter.

MDNDisposition Property (AS2 Adapter)

The Disposition header in the MDN receipt.

Data Type

String

Default Value

Remarks

This property is returned in the message context to determine the reported status of the AS2 message delivery. If the message was processed successfully, you should expect a disposition of

automatic-action/MDN-sent-automatically; processed

Other possible, but less likely, successful dispositions include:

manual-action/MDN-sent-automatically; processed manual-action/MDN-sent-manually; processed

Otherwise, the disposition will report the error encountered by the AS2 receiver when the message was processed. It is recommended that you read this values in your orchestration to determine the overall status of the AS2 message delivery.

This property is not available in the Sender.

MDNMICAlgorithm Property (AS2 Adapter)

The algorithm used to sign the outgoing MDN.

Data Type

Enumeration

Possible Values

As Requested (0)
As Requested Or SHA1 (1)
SHA1 (2)
MD5 (3)
None (4)
SHA256 (5)
SHA384 (6)
SHA512 (7)
SHA224 (8)
As Requested Or SHA256 (9)

Default Value

Remarks

By default, the adapter will honor the request of the client, if possible. The MIC will be calculated using the requested algorithm and reported in the outgoing MDN. If it is not possible to honor the client request, the MDN will not be signed and an error will be generated, unless ErrorProcessingFlags has been configured to prevent this.

The property may be configured in a variety of other ways as well. If set to AsRequestedOrSHA256, the adapter will honor requests for a signed receipt as with AsRequested. If unable to comply, or if a signature was not explicitly requested, the MIC will still be calculated using the SHA256 algorithm. The ReceiptSigningProtocol property may then be set to return a signed receipt. Use extreme caution when doing this; it will result in a non-RFC compliant server.

The following options are supported:


0	As Requested
1	As Requested Or SHA1
2	SHA1
3	MD5
4	None
5	SHA-256
6	SHA-384
7	SHA-512
8	SHA-224
9	As Requested Or SHA-256

This property is not available in the Sender.

MDNMICValue Property (AS2 Adapter)

The Message Integrity Check(s) (one-way hash) of the EDI message.

Data Type

String

Default Value

Remarks

In the Send Adapter, the MDNMICValue is computed using the algorithm expected in the Received-Content-MIC of the signed receipt. This will be the same as the signature algorithm used for signed messages, or SHA1 otherwise.

In the Receive Adapter, the MDNMICValue is calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".

MDNOptions Property (AS2 Adapter)

Used to indicate the options requested for the MDN receipt.

Data Type

String

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256, sha1"

Remarks

By default, the adapter will request that the MDN be signed with a PKCS#7 signature over an SHA1, SHA-256, or MD5 hash (if these algorithms are supported by the server).

Set MDNOptions to an empty string to request an unsigned receipt.

The string format is that of the Disposition-notification-options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

This property is not available in the Receiver.

MDNReceipt Property (AS2 Adapter)

The MDN-based receipt generated by the component.

Data Type

String

Default Value

Remarks

In the Send Adapter, this property will contain the receipt after it is received by the server.

In the Receive Adapter, this property will contain the receipt that was generated by the adapter and delivered to the sender.

The receipt will be a signed or unsigned multipart/report in MIME format. The MDNReceipt will consist of the MDN itself, the human-readable ReceiptMessage, MIME headers and footers, and a signature if applicable. The MDN will automatically be parsed out and stored in the MDN property. It will report either success or failure depending on ScanResult.

The signature, if any, will use the protocol specified by ReceiptSigningProtocol, and the certificate specified.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDN to report a failure to process the message. Either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error. Setting ErrorReportingFlags will cause the MDN to overlook the chosen types of errors. If all errors are overlooked, the MDN will report success and calculate a MIC on the original message as usual. A warning may be reported by setting MDNWarning;.

This property is not available in the Sender.

MDNReportingUA Property (AS2 Adapter)

The name of the user agent performing the disposition.

Data Type

String

Default Value

Remarks

The name of the user agent performing the disposition. The RFC 2298 recommendation is to use the DNS name of the user agent and the name of the software performing the disposition, for example, "edi-server.nsoftware.com; /n software AS2 Adapter".

This property is not available in the Sender.

MDNSendingMode Property (AS2 Adapter)

The level of end user interaction involved in sending the MDN.

Data Type

Enumeration

Possible Values

Automatic (0)
User Configurable (1)
Manual (2)

Default Value

Remarks

MDNSendingMode allows the server software to describe the level of user interaction in sending the MDN. MDNSendingMode corresponds to the "disposition-mode" field in the Disposition Header, as described further in RFC 3335.

By default, the disposition-mode value will be "automatic-action/MDN-sent-automatically".

This property is not available in the Sender.

MDNSignatureStatus Property (AS2 Adapter)

The validity of the signature in the MDN receipt.

Data Type

String

Default Value

"Valid"

Remarks

This property contains the status of the signature verification attempted by the adapter. The following values may be returned:


Valid	A valid signature was included in the MDN Receipt.
Invalid	A signature was included in the MDN Receipt, but was either invalid or could not be verified with the provided certificate.
None	No signature was included in the MDN Receipt.

It is recommended that you check this values in your orchestration to ensure that the MDN is signed as expected and contains a valid signature. Ordinarily, only "Valid" results indicate a successful MDN, but if you have requested an unsigned MDN by setting the MDNOptions configuration setting, "None" is also an acceptable value.

This property is not available in the Sender.

MDNSigningCert Property (AS2 Adapter)

The digital id to be used to sign the MDN (optional).

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for generating digital signatures. If MDNSigningCert is not set and a digital signature is required by the incoming AS2 request, EncryptionCert will be used in its place.

This field is used to set a Private Key Certificate.

This property is not available in the Sender.

MDNTo Property (AS2 Adapter)

Used to indicate that a message disposition notification is requested.

Data Type

String

Default Value

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. The value may be an email address, URL, etc., and while the presence of this header is necessary for an MDN to be returned, typically the value of the header will be ignored by the server.

By default, the adapter will request a PKCS#7 signature and synchronous delivery. You may set MDNDeliveryOption to request an asynchronous MDN, and you may set MDNOptions to request a different type of signature, or no signature at all.

This property is not available in the Receiver.

MDNWarning Property (AS2 Adapter)

A warning to appear in the MDN.

Data Type

String

Default Value

Remarks

MDNWarning defines a warning to appear in the outgoing MDN. If any errors are found and not explicitly allowed in ErrorReportingFlags, the errors will take precedence and the warning will not be reported.

MDNWarning should be assigned when allowing errors to be ignored via the ErrorReportingFlags property. The MDN will indicate successful processing of the request, but will contain a warning field. The following warning is defined by the AS2 specifications:

"authentication-failed, processing continued"

Any other warnings are not defined by the specifications and may or may not be understood by the client.

This property is not available in the Sender.

MessageSecurity Property (AS2 Adapter)

Required security level for incoming messages.

Data Type

Enumeration

Possible Values

None (0)
Signed (1)
Encrypted (2)
Signed And Encrypted (3)

Default Value

Remarks

The default value is "Signed And Encrypted", in which case both a valid signature and encryption are required for incoming messages.

Other values include "Signed" and "Encrypted", in which case only a valid signature and/or encryption is required.

Finally, there is a fourth level, "None", which allows all messages. CAUTION: this level is included for debugging purposes only. There is no security with this level.

This property is not available in the Sender.

Other Property (AS2 Adapter)

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

Data Type

String

Default 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

ReceiptDeliveryOption Property (AS2 Adapter)

A URL indicating how the receipt is to be delivered.

Data Type

String

Default Value

Remarks

This property corresponds to the Receipt-delivery-option header in the AS2 request. If nonempty, the client has requested that the receipt be sent asynchronously to the URL specified. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case, the receipt is delivered once the response message has been prepared and returned to the adapter.

ReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in MDNTo.

This property is not available in the Sender.

ReceiptHeaders Property (AS2 Adapter)

The AS2 headers that are returned with the receipt.

Data Type

String

Default Value

Remarks

ReceiptHeaders should include headers such as AS2-From, AS2-To, Date, Content-Type, etc.

In the Send Adapter, this property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

In the Receive Adapter, these will be added to the HTTP headers when returning a synchronous reply, or to the SMTP headers when returning an asynchronous reply via email. If any additional headers are supplied in ReceiptHeaders, they will be prepended to the headers generated by the adapter.

ReceiptMessage Property (AS2 Adapter)

The textual message that is included in the receipt.

Data Type

String

Default Value

Remarks

The human-readable portion of the receipt generated in MDN.

In the Send Adapter, this property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

In the Receive Adapter, if ReceiptMessage is not set, an appropriate message will automatically be generated and added to the receipt. The message will differ depending on whether the message was processed successfully, whether the sender's signature was authenticated, etc. If set, the value of ReceiptMessage will override what is generated by the adapter. If set to ".", a blank message will be generated.

ReceiptSignerCert Property (AS2 Adapter)

The certificate of the receipt signer.

Data Type

Certificate

Remarks

If your trading partner uses different certificates for signing and encryption, it may be necessary to set this property to the signing certificate. However, if your trading partner uses the same certificate for both, it suffices to set RecipientCert.

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.

This property is not available in the Receiver.

ReceiptSigningProtocol Property (AS2 Adapter)

The protocol used to sign the outgoing MDN receipt.

Data Type

Enumeration

Possible Values

As Requested (0)
PKCS7 (1)
None (2)

Default Value

Remarks

The protocol used to sign the outgoing MDN. By default, the adapter will honor the request of the client, if possible. If it is not possible to honor the client request, the MDN will not be signed and an error will be generated, unless ErrorProcessingFlags has been configured to prevent this.

If the client does not request a signature, one will not be provided by default; however, the server may provide one by setting ReceiptSigningProtocol to spPKCS7. If the client requests a signature and the signature protocol is supported by the adapter, the request must be honored, per RFC specifications.

This property is not available in the Sender.

ReceivedFileName Property (AS2 Adapter)

The name of the file received by the AS2 component.

Data Type

String

Default Value

Remarks

If a file name is included in the AS2 request's message headers, it will be written to this context property.

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 when filling out macros such as %SourceFileName%.

This property is not available in the Sender.

ReceiveMode Property (AS2 Adapter)

Controls whether the component is configured to process AS2 messages or MDN receipts.

Data Type

Enumeration

Possible Values

AS2Message (0)
MDN (1)

Default Value

Remarks

The possible values and their meanings are as follows:


AS2 Message	The adapter attempts to process messages as AS2 messages and will attempt to deliver MDN receipts if requested.
MDN	The adapter attempts to process messages as MDN receipts and verify their signatures.

This property is not available in the Sender.

ReceivingPartner Property (AS2 Adapter)

The identity of AS2 receiving entity.

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be receiving AS2 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.

RecipientCert Property (AS2 Adapter)

The certificate of the recipient.

Data Type

Certificate

Remarks

The encryption certificate of the recipient. If this property is specified, the EDI message will be encrypted using the algorithm given by EncryptionAlgorithm.

This property is also used when verifying signed receipts, in cases where the receipt signature does not include the signer's certificate. In case your trading partner uses different certificates for signing and encryption, you should set RecipientCert to the encryption certificate, and ReceiptSignerCert to the signing certificate.

If the adapter is unable to verify a signature, make sure RecipientCert is set appropriately.

This property is used to set a Public Key Certificate.

This property is not available in the Receiver.

RegisterIsolatedReceiverTimeout Property (AS2 Adapter)

This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.

Data Type

Integer

Default Value

Remarks

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 (AS2 Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

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.

RestartDirectory Property (AS2 Adapter)

The directory to log cached files when using AS2 restart functionality.

Data Type

String

Default Value

Remarks

This property specifies the directory on disk to which temporary data will be saved when AS2 restart is used. If this property is set AS2 restart functionality is enabled for the adapter.

The adapter will store information about the transmission in this directory while processing the request. If the transmission is interrupted when the file is re-transmitted data in this directory will be used automatically to restart the transmission at the appropriate offset.

Only this property is required to support AS2 restart.

RolloverCertificate Property (AS2 Adapter)

The rollover decryption and receipt signing certificate.

Data Type

Certificate

Remarks

The rollover digital certificate that the adapter will use to decrypt incoming transmissions and sign the MDN receipt (if requested). This may be used to specify an additional decryption and receipt signing certificate during a period of transition between private certificates in the application.

When specified the adapter will be able to decrypt messages that were encrypted with the corresponding public certificate of either Certificate or RolloverCertificate. MDNs will be signed with both the certificate in Certificate and RolloverCertificate.

If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling ParseRequest, then set the rollover certificate before calling CreateMDNReceipt. RolloverCertificate must be set to a private key certificate.

This property is not available in the Sender.

RolloverSigningCert Property (AS2 Adapter)

An additional certificate used to sign the outgoing AS2 request when transitioning certificates.

Data Type

Certificate

Remarks

This property specifies a certificate in addition to SigningCert that will be used to sign the AS2 request. This should only be used during a certificate transition when both the old and new certificate need to be supported for the transitional phase.

This property is not available in the Receiver.

RuntimeLicense Property (AS2 Adapter)

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 adapter license.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

ScanResult Property (AS2 Adapter)

The result of parsing the request.

Data Type

Integer

Default Value

Remarks

ScanResult will contain information about any errors that occurred while parsing the incoming AS2 request. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.


0x01	Unable to decrypt data.
0x02	Unable to decompress data.
0x04	Unable to validate integrity of data.
0x08	Unable to verify the signature.
0x10	Client requested unsupported signature type.
0x20	Client requested unsupported MIC algorithm.
0x40	Insufficient message security, as determined by the MessageSecurity property.

This property is not available in the Sender.

SignerCert Property (AS2 Adapter)

The signing certificate of the trading partner.

Data Type

Certificate

Remarks

You must set your trading partner's certificate before processing any signed messages.

This property is used to set a Public Key Certificate.

This property is not available in the Sender.

SigningCert Property (AS2 Adapter)

The certificate used to sign the outgoing AS2 request.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate to be used for digitally signing the outgoing AS2 request.

This field is used to set a Private Key Certificate.

This property is not available in the Receiver.

SSLAcceptServerCert Property (AS2 Adapter)

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

Data Type

Certificate

Remarks

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.

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 (AS2 Adapter)

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

Data Type

Certificate

Remarks

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

This field is used to set a Private Key Certificate.

TempPath Property (AS2 Adapter)

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 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 (AS2 Adapter)

A timeout for the component.

Data Type

Integer

Default Value

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 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).

TradingPartner Property (AS2 Adapter)

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

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be communicating with this instance of the AS2 adapter.

This property is not available in the Sender.

TransmitBatchMode Property (AS2 Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

Remarks

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 (AS2 Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

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 (AS2 Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default 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.

URL Property (AS2 Adapter)

The URL to post to.

Data Type

String

Default Value

Remarks

SSL will be used if and only if the URL scheme is "https". Note that, in general, signed and unencrypted messages would be sent using SSL, as encrypting the message over an SSL channel would be redundant.

This property is not available in the Receiver.

UserAgent Property (AS2 Adapter)

Information about the user agent.

Data Type

String

Default Value

"IP*Works! AS2 Transmitter - www.nsoftware.com"

Remarks

Override the default with the name and version of your software.

This property is not available in the Receiver.

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
Default Value: "MY"

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:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

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
Default Value: ""

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
Default Value: 0

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:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR adapter. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String
Default Value: ""

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)

Control.CertSubject = "Test"

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 (read-only)
Default Value: ""

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 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 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);

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 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.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

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
Default Value: False

Tells the adapter whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes
Default Value: 0

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String
Default Value: ""

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
Default Value: ""

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
Default Value: 0

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
Default Value: ""

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
Default Value: "Application"

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
Default Value: 3

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


Verbose	The adapter will report all information regarding the transport.
Info	The adapter will report all major operations, as well as all warnings and errors.
Warning	The adapter will report any conditions that could result in unpredictable behavior as well as errors.
Error	The adapter will report all errors that prevent normal operations from completing.
Fatal	The adapter will report only serious errors that cause the adapter to completely stop functioning.

LogType
LogTypes
Default Value: 1

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


None	The adapter will not report any logging information.
EventLog	The adapter will report all logging information to the event log. The specific event log must be defined in the Location field when this type is selected.
File	The adapter will report all logging information to a file. The desired file must be specified in the Location field when this type has been selected.

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
Default Value: 0

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
Default Value: False

Tells the adapter whether or not to automatically detect and use proxy system settings, if available.

Password
String
Default Value: ""

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
Default Value: 80

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

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
Default Value: 0

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String
Default Value: ""

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 (AS2 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.

AS2 Config Settings

AcceptAnySignerCert: Used to accept trust any signing certificate unconditionally.

If AcceptAnySignerCert is set to true, the adapter will accept any signer certificate for the incoming signature. Use of this setting in production is discouraged, as failing to authenticate the sender poses a security risk.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

IgnoreLoggingErrors: Whether to ignore errors that occur when writing to the log.

When this setting is enabled (default False), any errors that occur while writing to log files will be ignored, and no exception will be thrown. Note that this may cause logs to be incomplete or missing without any indication that an issue occurred.

LogDebug: Whether to log debug data.

This setting specifies whether to log debug data. When set to True the adapter will create additional files in the LogDirectory. The default value is False.

When sending, files with extensions ".input", ".sign", ".compress", and ".encrypt" may be created. When receiving, files with extensions ".input", ".verify", ".decompress", and ".decrypt" may be created.

MDNDeliveryOption: A URL indicating how the receipt is to be delivered.

The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "mailto", "http", or "https".

If this is set to an empty string (default), the receipt will be returned synchronously, and will be processed automatically by the adapter. Clients requesting asynchronous delivery should provide their own processing for reading receipts. This is applicable to the send adapter only.

OAEPMGF1HashAlgorithm: The MGF1 hash algorithm used when encrypting a key.

When UseOAEP is True, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP. Possible values are:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

Note: An empty string value indicates that the algorithm specified by OAEPRSAHashAlgorithm is used as the RSA hash algorithm as well.

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 UseOAEP is True, 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:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

OtherHeaders: Other headers as determined by the user.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n"). Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the adapter beyond what is provided. This is applicable to the transmitter adapter only.

SignatureAlgorithm: Signature algorithm to be used in outgoing messages.

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

sha1
md5
sha-224
sha-256 (default)
sha-384
sha-512

The default value is "sha1". MDNOptions will need to be updated to reflect the selected algorithm if the MDN receipt is to be signed with the same algorithm. For example:

 signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256

This is applicable to the send adapter only.

SMTPFrom: The senders address for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the sender. This is applicable to the receive adapter only.

SMTPServer: The SMTP server for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the server. This is applicable to the receive adapter only.

SMTPSubject: The SMTP message subject for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the subject. This is applicable to the receive adapter only.

UseChunkedEncoding: Whether to chunk outgoing posts.

When sending, this setting controls whether data is chunked. Chunking allows data to be streamed as it is available instead of preparing the entire message first. It is recommended to set this to True if sending very large files. The default value is False.

UseOAEP: Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA.

If set to true, OAEP will be used when encrypting the key. By default this value is False and the component will use PKCS1. Only applicable when sending AS2 messages. The following optional settings apply when this is set to True:

OAEPParams
OAEPMGF1HashAlgorithm
OAEPRSAHashAlgorithm

UsePSS: Whether to use RSA-PSS when signing.

If set to true, RSA-PSS will be used when signing messages. The default value is False. Note that the certificate used to sign does not itself need to be signed with RSA-PSS; any valid RSA certificate may be used with this setting.

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:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the adapter is the same.

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=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// 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:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

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:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

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:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

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: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

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:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

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:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

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:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

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 set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the adapter will use the system security libraries by default to perform cryptographic functions where applicable. In this case, 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 configuration setting to True tells the adapter to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

If using the .NET Standard Library, this setting will be True on all platforms. The .NET Standard library does not support using the system security libraries.

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 dynamic link library (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%.

TempThis is resolved to the full path to the system's temporary directory. MessageIDGlobally unique identifier (GUID) of the message in BizTalk Server. SourceFileNameThe original file name. This includes the extension and excludes the file path, for example, Sample.xml SourceFileNameNoExtThe original file name without the extension or file path, for example, Sample RemoteFileNameThe 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. DestinationPartyName of the destination party. DestinationPartyQualifierQualifier of the destination party. SourcePartyName of the source party. SourcePartyQualifierQualifier of the source party. DateTime:CustomFormatThis special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. DateThe date format yyyy-MM-dd. DateTimeThe date format yyyy-MM-ddThhmmss. TimeThe date format hhmmss. DateTime_BTS2000The date format yyyyMMddhhmmssf. DateTime.TZThe date format yyyy-MM-ddThhmmsszzz. Time.TZThe 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.