AS1 Adapter
Properties Configuration Settings
The AS1 Adapter adds AS1 send and receive capabilities to BizTalk Server.
Remarks
The AS1 Adapter adds AS1 send and receive capabilities to BizTalk Server. Using a simple application-like design, the adapter allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.
Outgoing AS1 Messages
Outgoing AS1 Messages are managed with both a Send adapter for message delivery and a Receive adapter for MDN retrieval. To send an AS1 message, begin by specifying the MyEmail, PartnerEmail, SMTPServer, and Subject properties to specify where the message is sent to and from and the server for delivery. If you have an SSL SMTPServer, you can specify the SMTPSSLStartMode, SMTPSSLAcceptServerCert, and SMTPSSLCert properties for additional server configuration.
The payload of the AS1 message will be the same as the payload of receive message, but you may set the AS1MessageId, EDIFileName, and EDIType properties to further customize the EDI payload sent to your trading partner. You can apply additional security to the message by setting RecipientCert to your trading partner's public key certificate for encryption, SigningCert to your private key certificate for signing, and CompressionFormat if you wish to apply compression to the message for larger transmissions.
The AS1 Send adapter is a two way Solicit-Response adapter, and the resulting message will contain the information you need to match the MDN receipt to the sent message if you wish to do so. The response message will contain AS1MessageId and MDNMICValue properties that contain the adapter-generated MessageId of the sent message and the MIC value calculated over the transmitted payload, respectively.
To retrieve MDN's for your sent messages, set the ReceiveMode property to rMDN to indicate that you wish to process MDN's, and the POPServer, POPUser, and POPPassword properties of the Receive adapter to the POP server where you expect MDN messages to arrive, applying the MessageFilter property if you wish to filter the messages processed. If you have an SSL POPServer, you can specify the POPSSLStartMode, POPSSLAcceptServerCert, and POPSSLCert properties for additional server configuration.
To verify the signatures on incoming MDN receipts, set the SignerCert property to your trading partner's public key.
Messages received by the adapter will be returned with AS1MessageId and MDNMICValue properties containing the MessageId of the message that the receipt is for, and the MIC value calculated by the receiver and reported in the receipt. These properties can then be matched against the properties of the original transmission through a correlation in your orchestration so you can determine which AS1 transmission the response is for. Finally, check the value of the MDNDisposition and MDNSignatureStatus to determine the overall status of the transmission.
Incoming AS1 Messages
To process incoming AS1 transmissions, set the ReceiveMode property to rAS1Message to indicate that you wish to process incoming AS1 messages, and the POPServer, POPUser, and POPPassword properties of the Receive adapter to the POP server where you expect AS1 messages to arrive, applying the MessageFilter property if you wish to filter the messages processed. If you have an SSL POPServer, you can specify the POPSSLStartMode, POPSSLAcceptServerCert, and POPSSLCert properties for additional server configuration.
Incoming messages will be decrypted using the your private key certificate, as specified in the EncryptionCert property, and incoming signatures will be verified using your trading partner's public key, as specified in SignerCert. After the message is successfully processed, the message will be submitted to BizTalk.
If your trading partner requests an MDN receipt, the adapter will attempt to deliver it using the server specified in SMTPServer from the address specified in MyEmail. Again, if you have an SSL SMTPServer, you can specify the SMTPSSLStartMode, SMTPSSLAcceptServerCert, and SMTPSSLCert properties for additional server configuration.
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.
| AS1MessageId | The Id of the message. |
| DeleteMode | Controls if and when the remote messages are deleted after processing. |
| EDIFileName | The name to be used in the Content-Disposition MIME header of the outbound request. |
| EDIType | The MIME type of the data. |
| EncryptionCert | The digital id to be used for decryption. |
| ErrorThreshold | The maximum number of errors before the adapter shuts down. |
| Firewall | A set of properties related to firewall access. |
| LogDirectory | The path to a directory for logging. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MDNDisposition | The Disposition header in the MDN receipt. |
| MDNMICValue | The Message Integrity Check(s) (one-way hash) of the EDI payload. |
| MDNSignatureStatus | The validity of the signature in the MDN receipt. |
| MDNSigningCert | The digital id to be used to sign the MDN (optional). |
| MDNTo | The address to which an MDN was requested. |
| MessageFilter | A message filter used to filter incoming messages for processing. |
| MyEmail | The local email address of the profile being configured. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| POPPassword | The password for your incoming (POP) mail server. |
| POPPort | The port for the POP server (default is 110). |
| POPServer | The email server (POP) used to receive incoming messages. |
| POPSSLAcceptServerCert | If connecting to a secure POP server for message retrieval, a server certificate to unconditionally accept. |
| POPSSLCert | The certificate to use for client authentication during the SSL handshake to the POP server, if required. |
| POPSSLStartMode | Determines how the adapter starts the SSL negotiation with the POP Server. |
| POPUser | The username for your incoming (POP) mail server. |
| ReceiveMode | Controls whether the adapter is configured to process AS1 messages or MDN receipts. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| SignerCert | The signing certificate of the trading partner. |
| SMTPPort | The port for the SMTP server (default is 25). |
| SMTPServer | The email server used to deliver outgoing messages. |
| SMTPSSLAcceptServerCert | If connecting to a secure SMTP server for message delivery, a server certificate to unconditionally accept. |
| SMTPSSLCert | The certificate to use for client authentication during the SSL handshake to the SMTP server, if required. |
| SMTPSSLStartMode | Determines how the adapter starts the SSL negotiation with the SMTP Server. |
| Timeout | A timeout for the adapter. |
| 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.
| AS1MessageId | The Id of the message. |
| 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. |
| Firewall | A set of properties related to firewall access. |
| LogDirectory | The path to a directory for logging. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| 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. |
| MDNMICValue | The Message Integrity Check(s) (one-way hash) of the EDI payload. |
| MyEmail | The local email address of the profile being configured. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| PartnerEmail | The email address of the trading partner. |
| RecipientCert | The certificate of the recipient. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| SigningCert | The certificate used to sign the outgoing AS1 request. |
| SMTPPort | The port for the SMTP server (default is 25). |
| SMTPServer | The email server used to deliver outgoing messages. |
| SMTPSSLAcceptServerCert | If connecting to a secure SMTP server for message delivery, a server certificate to unconditionally accept. |
| SMTPSSLCert | The certificate to use for client authentication during the SSL handshake to the SMTP server, if required. |
| SMTPSSLStartMode | Determines how the adapter starts the SSL negotiation with the SMTP Server. |
| Subject | The subject of the AS1 message. |
| 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. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| DeleteOnSuspend | Specifies whether files may be deleted from server when message is suspended. |
| MDNTo | Allows the Send adapter to specify a separate email for MDN delivery. |
| MDNOptions | Used to indicate the options requested for the MDN receipt. |
| MessageSecurity | Required security level for incoming messages. |
| EncryptionAlgorithm | The algorithm, if any, used to encrypt the EDI data. |
| SMTPUser | A user id to login the SMTP server. |
| SMTPPassword | A login password id to login as in the SMTP server. |
| SMTPAuthMechanism | The authentication mechanism used to connect to the SMTP server. |
| 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. |