AS2 Adapter
Properties Configuration Settings
The AS2 Adapter adds AS2 send and receive capabilities to BizTalk Server.
Remarks
The AS2 Adapter adds AS2 send and receive capabilities to BizTalk Server. Built on top of the Drummond/eBusinessReady Certified IP*Works! EDI / 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.
By default, the adapter sets the required MessageSecurity on incoming AS2 requests to the highest level. If your messages require security, you must set an EncryptionCert and/or SignerCert. It is also recommended that you set an MDNSigningCert in order to provide non-repudiation for your AS2 response.
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 ensure 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 IP*Works! EDI / 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 adapter. |
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 adapter 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 adapter may consume. |
MDN | The MDN generated by the adapter. |
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 adapter. |
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 adapter. |
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 adapter. |
ReceiveMode | Controls whether the adapter is configured to process AS2 messages or MDN receipts. |
ReceivingPartner | The identity of AS2 receiving entity. |
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. |
RuntimeLicense | Specifies the adapter 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 adapter processes it. |
Timeout | A timeout for the adapter. |
TradingPartner | The trading partner that will be communicating with this receive location. |
TransportLog | Tells the adapter 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 adapter may consume. |
MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
MDN | The MDN generated by the adapter. |
MDNDeliveryOption | A URL indicating how the receipt is to be delivered. |
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 adapter. |
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. |
RuntimeLicense | Specifies the adapter 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 adapter. |
TransmitBatchMode | How the transmitter processes batches. |
TransportLog | Tells the adapter 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. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
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. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
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. |
UseManagedSecurityAPI | Tells the adapter whether or not to use the system security libraries or a managed implementation. |