/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

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.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTP server.
AfterGetA set of FTP commands to be executed after AS3 Messages are downloaded.
AfterPutA set of FTP commands to be executed after the files are uploaded to the server.
AS3FromThe identity of the sending system.
AS3MessageIdThe Id of the AS3 Message.
AS3ToThe identity of the receiving system.
BeforeGetA set of FTP commands to be executed before AS3 Messages are downloaded.
BeforePutA set of FTP commands to be executed before the files are uploaded to the server.
DeleteModeControls if and when the remote files are deleted after processing.
EDITypeThe MIME type of the data.
EncryptionCertThe digital id to be used for decryption.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FilemaskA filemask used to filter incoming messages for processing.
FirewallA set of properties related to firewall access.
FTPPasswordThe password to log into the FTP server with.
FTPPortThe port of the FTP server (default is 21).
FTPServerThe domain name or IP address of the FTP server.
FTPUserThe user id to log into the FTP server.
LogDirectoryThe path to a directory for logging.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
MDNDispositionThe Disposition header in the MDN receipt.
MDNFilenameThe file name of the MDN receipt generated by the adapter.
MDNMICValueThe Message Integrity Check(s) (one-way hash) of the EDI payload.
MDNPathThe remote path on the FTP server where MDN's are sent or received.
MDNSignatureStatusThe validity of the signature in the MDN receipt.
MDNSigningCertThe digital id to be used to sign the MDN (optional).
MDNToThe system to which an MDN should be directed.
OtherDefines a set of configuration settings to be used by the adapter.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceiveModeControls whether the adapter is configured to process AS3 messages or MDN receipts.
ReceivePathThe remote path on the FTP server where incoming AS3 files are processed.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
SignerCertThe signing certificate of the trading partner.
SSLAcceptServerCertWhen connecting to the FTP server, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake to the FTP server, if required.
SSLStartModeDetermines how the adapter starts the SSL negotiation with the FTP Server.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseSimpleDirListInstructs 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.

AfterConnectA set of FTP commands to be executed immediately after connecting to the FTP server.
AfterPutA set of FTP commands to be executed after the files are uploaded to the server.
AS3FromThe identity of the sending system.
AS3MessageIdThe Id of the AS3 Message.
AS3ToThe identity of the receiving system.
BeforePutA set of FTP commands to be executed before the files are uploaded to the server.
CompressionFormatThe compression format (if any) to use.
DeliveryPathThe remote path on the FTP server where outgoing AS3 messages are delivered.
EDIFileNameThe name to be used in the Content-Disposition MIME header of the outbound request.
EDITypeThe MIME type of the data.
FilenameThe file name of the AS3 message to generate.
FirewallA set of properties related to firewall access.
FTPPasswordThe password to log into the FTP server with.
FTPPortThe port of the FTP server (default is 21).
FTPServerThe domain name or IP address of the FTP server.
FTPUserThe user id to log into the FTP server.
LogDirectoryThe path to a directory for logging.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MDNMICValueThe Message Integrity Check(s) (one-way hash) of the EDI payload.
MDNToThe system to which an MDN should be directed.
OtherDefines a set of configuration settings to be used by the adapter.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
RecipientCertThe certificate of the recipient.
SigningCertThe certificate used to sign the outgoing AS3 request.
SSLAcceptServerCertWhen connecting to the FTP server, a server certificate to unconditionally accept.
SSLCertThe certificate to use for client authentication during the SSL handshake to the FTP server, if required.
SSLStartModeDetermines how the adapter starts the SSL negotiation with the FTP Server.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe 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.

DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
MDNOptionsUsed to indicate the options requested for the MDN receipt.
MessageSecurityRequired security level for incoming messages.
EncryptionAlgorithmThe algorithm, if any, used to encrypt the EDI data.
MDNServerA separate FTP server to use for MDN's.
MDNUserA user id to login to the MDN FTP server.
MDNPasswordA password id to login to the MDN FTP server.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]