AS3 Adapter
Properties Configuration Settings
The AS3 Adapter adds AS3 send and receive capabilities to BizTalk Server.
Remarks
The AS3 Adapter adds AS3 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 AS3 Messages
Outgoing AS3 Messages are managed with both a Send adapter for message delivery and a Receive adapter for MDN retrieval. To send an AS3 message, begin by specifying the AS3From, AS3To, FTPServer, FTPUser and FTPPassword properties to specify where the message is sent to and from and to log into the server for delivery. Set the DeliveryPath property to the directory on the server where you want AS3 messages to be delivered to, and set Filename to the filename that you wish your AS3 messages to be written to. If you have an SSL FTPServer, you can specify the SSLStartMode, SSLAcceptServerCert, and SSLCert properties for additional server configuration.
The payload of the AS3 message will be the same as the payload of received message, but you may set the AS3MessageId, 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 AS3 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 AS3MessageId 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 send messages, set the ReceiveMode property to rMDN to indicate that you wish to process MDN's, and the FTPServer, FTPUser, and FTPPassword properties of the Receive adapter to the FTP server where you expect MDN messages to arrive, specifying the MDNPath if you expect MDN's to arrive in a specific directory, and AS3_p_Filemask if you wish to filter the entries. If you have an SSL FTPServer, you can specify the SSLStartMode, SSLAcceptServerCert, and SSLCert 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 AS3MessageId 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 AS3 transmission the response is for. Finally, check the value of the MDNDisposition and MDNSignatureStatus to determine the overall status of the transmission.
Incoming AS3 Messages
To process incoming AS3 transmissions, set the ReceiveMode property to rAS3Message to indicate that you wish to process incoming AS3 messages, and the FTPServer, FTPUser, and FTPPassword properties of the Receive adapter to the FTP server where you expect AS3 messages to arrive, specifying the ReceivePath if you expect AS3 files to arrive in a specific directory, and AS3_p_Filemask if you wish to filter the entries. If you have an SSL FTPServer, you can specify the SSLStartMode, SSLAcceptServerCert, and SSLCert 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 navigate to the path specified in MDNPath for MDN delivery (if you use a different server for MDN delivery, you can specify it in the MDNServer and related properties.
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.
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTP server. |
| AfterGet | A set of FTP commands to be executed after AS3 Messages are downloaded. |
| AfterPut | A set of FTP commands to be executed after the files are uploaded to the server. |
| AS3From | The identity of the sending system. |
| AS3MessageId | The Id of the AS3 Message. |
| AS3To | The identity of the receiving system. |
| BeforeGet | A set of FTP commands to be executed before AS3 Messages are downloaded. |
| BeforePut | A set of FTP commands to be executed before the files are uploaded to the server. |
| DeleteMode | Controls if and when the remote files are deleted after processing. |
| 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. |
| Filemask | A filemask used to filter incoming messages for processing. |
| Firewall | A set of properties related to firewall access. |
| FTPPassword | The password to log into the FTP server with. |
| FTPPort | The port of the FTP server (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| FTPUser | The user id to log into the FTP server. |
| 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. |
| MDNFilename | The file name of the MDN receipt generated by the adapter. |
| MDNMICValue | The Message Integrity Check(s) (one-way hash) of the EDI payload. |
| MDNPath | The remote path on the FTP server where MDN's are sent or received. |
| MDNSignatureStatus | The validity of the signature in the MDN receipt. |
| MDNSigningCert | The digital id to be used to sign the MDN (optional). |
| MDNTo | The system to which an MDN should be directed. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceiveMode | Controls whether the adapter is configured to process AS3 messages or MDN receipts. |
| ReceivePath | The remote path on the FTP server where incoming AS3 files are processed. |
| 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. |
| SSLAcceptServerCert | When connecting to the FTP server, a server certificate to unconditionally accept. |
| SSLCert | The certificate to use for client authentication during the SSL handshake to the FTP server, if required. |
| SSLStartMode | Determines how the adapter starts the SSL negotiation with the FTP 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. |
| UseSimpleDirList | Instructs the adapter to issue the NLST command instead of LIST. |
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.
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTP server. |
| AfterPut | A set of FTP commands to be executed after the files are uploaded to the server. |
| AS3From | The identity of the sending system. |
| AS3MessageId | The Id of the AS3 Message. |
| AS3To | The identity of the receiving system. |
| BeforePut | A set of FTP commands to be executed before the files are uploaded to the server. |
| CompressionFormat | The compression format (if any) to use. |
| DeliveryPath | The remote path on the FTP server where outgoing AS3 messages are delivered. |
| EDIFileName | The name to be used in the Content-Disposition MIME header of the outbound request. |
| EDIType | The MIME type of the data. |
| Filename | The file name of the AS3 message to generate. |
| Firewall | A set of properties related to firewall access. |
| FTPPassword | The password to log into the FTP server with. |
| FTPPort | The port of the FTP server (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| FTPUser | The user id to log into the FTP server. |
| 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. |
| MDNTo | The system to which an MDN should be directed. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| RecipientCert | The certificate of the recipient. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| SigningCert | The certificate used to sign the outgoing AS3 request. |
| SSLAcceptServerCert | When connecting to the FTP server, a server certificate to unconditionally accept. |
| SSLCert | The certificate to use for client authentication during the SSL handshake to the FTP server, if required. |
| SSLStartMode | Determines how the adapter starts the SSL negotiation with the FTP Server. |
| 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. |
| 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. |
| MDNServer | A separate FTP server to use for MDN's. |
| MDNUser | A user id to login to the MDN FTP server. |
| MDNPassword | A password id to login to the MDN FTP 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. |