AS3 Adapter

The AS3 Component 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 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 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 component 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 component may consume.
MDNDisposition	The Disposition header in the MDN receipt.
MDNFileName	The file name of the MDN receipt generated by the component.
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 component.
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 component 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 component 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 component starts the SSL negotiation with the FTP Server.
Timeout	A timeout for the component.
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.
UseSimpleDirList	Instructs the component 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 component 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 component.
Passive	Controls whether to direct the server into passive mode. Recommended if behind a firewall.
RecipientCert	The certificate of the recipient.
RuntimeLicense	Specifies the component 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 component starts the SSL negotiation with the FTP Server.
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.

Config Settings

The following is a list of config 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.
EncryptionAlgorithm	The algorithm, if any, used to encrypt the EDI data.
MDNOptions	Used to indicate the options requested for the MDN receipt.
MDNPassword	A password id to login to the MDN FTP server.
MDNServer	A separate FTP server to use for MDN's.
MDNUser	A user id to login to the MDN FTP server.
MessageSecurity	Required security level for incoming messages.
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.

AS3 Receiver

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

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


AfterConnect	A set of FTP commands to be executed immediately after connecting to the FTP server. Type: xs:string Default Value: ""
AfterGet	A set of FTP commands to be executed after AS3 Messages are downloaded. Type: xs:string Default Value: ""
AfterPut	A set of FTP commands to be executed after the files are uploaded to the server. Type: xs:string Default Value: ""
AS3From	The identity of the sending system. Type: xs:string Default Value: ""
AS3MessageId	The Id of the AS3 Message. Type: xs:string Default Value: ""
AS3To	The identity of the receiving system. Type: xs:string Default Value: ""
BeforeGet	A set of FTP commands to be executed before AS3 Messages are downloaded. Type: xs:string Default Value: ""
BeforePut	A set of FTP commands to be executed before the files are uploaded to the server. Type: xs:string Default Value: ""
DeleteMode	Controls if and when the remote files are deleted after processing. Type: xs:int Default Value: 0
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.
ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int Default Value: 5
Filemask	A filemask used to filter incoming messages for processing. Type: xs:string Default Value: ""
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
FTPPassword	The password to log into the FTP server with. Type: baf:Password Default Value: "" NOTE: This property must have a value.
FTPPort	The port of the FTP server (default is 21). Type: xs:int Default Value: 21 NOTE: This property must have a value.
FTPServer	The domain name or IP address of the FTP server. Type: xs:string Default Value: "" NOTE: This property must have a value.
FTPUser	The user id to log into the FTP server. Type: xs:string Default Value: "" NOTE: This property must have a value.
LogDirectory	The path to a directory for logging. Type: xs:string Default Value: ""
MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit). Type: xs:int Default Value: 0
MaxFileCount	The maximum number of files in the current batch (0 indicates no limit). Type: xs:int Default Value: 10
MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit). Type: xs:int Default Value: 0
MaxThreads	The maximum number of threads that the component may consume. Type: xs:int Default Value: 20
MDNDisposition	The Disposition header in the MDN receipt. Type: xs:string Default Value: ""
MDNFileName	The file name of the MDN receipt generated by the component. Type: xs:string Default Value: ""
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI payload. Type: xs:string Default Value: ""
MDNPath	The remote path on the FTP server where MDN's are sent or received. Type: xs:string Default Value: ""
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.
MDNTo	The system to which an MDN should be directed. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
Passive	Controls whether to direct the server into passive mode. Recommended if behind a firewall. Type: bool Default Value: true
PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int Default Value: 60
ReceiveMode	Controls whether the component is configured to process AS3 messages or MDN receipts. Type: xs:int Default Value: 0
ReceivePath	The remote path on the FTP server where incoming AS3 files are processed. Type: xs:string Default Value: ""
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool Default Value: false
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SignerCert	The signing certificate of the trading partner. Type: Certificate Default Value: null
SSLAcceptServerCert	When connecting to the FTP server, a server certificate to unconditionally accept. Type: Certificate Default Value: null
SSLCert	The certificate to use for client authentication during the SSL handshake to the FTP server, if required. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
SSLStartMode	Determines how the component starts the SSL negotiation with the FTP Server. Type: xs:int Default Value: 3
Timeout	A timeout for the component. Type: xs:int Default Value: 60
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: ""
UseSimpleDirList	Instructs the component to issue the NLST command instead of LIST. Type: bool Default Value: false

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.

AS3 Transmitter

Setting the AS3 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 AS3 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 AS3 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.AS3 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.AS3 2024 Transport Properties dialog box, use the following properties to:


AfterConnect	A set of FTP commands to be executed immediately after connecting to the FTP server. Type: xs:string Default Value: ""
AfterPut	A set of FTP commands to be executed after the files are uploaded to the server. Type: xs:string Default Value: ""
AS3From	The identity of the sending system. Type: xs:string Default Value: ""
AS3MessageId	The Id of the AS3 Message. Type: xs:string Default Value: ""
AS3To	The identity of the receiving system. Type: xs:string Default Value: ""
BeforePut	A set of FTP commands to be executed before the files are uploaded to the server. Type: xs:string Default Value: ""
CompressionFormat	The compression format (if any) to use. Type: xs:int Default Value: 0
DeliveryPath	The remote path on the FTP server where outgoing AS3 messages are delivered. Type: xs:string Default Value: ""
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"
FileName	The file name of the AS3 message to generate. Type: xs:string Default Value: ""
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
FTPPassword	The password to log into the FTP server with. Type: baf:Password Default Value: "" NOTE: This property must be specified.
FTPPort	The port of the FTP server (default is 21). Type: xs:int Default Value: 21 NOTE: This property must be specified.
FTPServer	The domain name or IP address of the FTP server. Type: xs:string Default Value: "" NOTE: This property must be specified.
FTPUser	The user id to log into the FTP server. Type: xs:string Default Value: "" NOTE: This property must be specified.
LogDirectory	The path to a directory for logging. Type: xs:string Default Value: ""
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending. Type: xs:int Default Value: 1
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
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI payload. Type: xs:string Default Value: ""
MDNTo	The system to which an MDN should be directed. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
Passive	Controls whether to direct the server into passive mode. Recommended if behind a firewall. Type: bool Default Value: true
RecipientCert	The certificate of the recipient. Type: Certificate Default Value: null
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SigningCert	The certificate used to sign the outgoing AS3 request. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
SSLAcceptServerCert	When connecting to the FTP server, a server certificate to unconditionally accept. Type: Certificate Default Value: null
SSLCert	The certificate to use for client authentication during the SSL handshake to the FTP server, if required. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
SSLStartMode	Determines how the component starts the SSL negotiation with the FTP Server. Type: xs:int Default Value: 3
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: ""

Click OK and OK again to save settings.

AfterConnect Property (AS3 Adapter)

A set of FTP commands to be executed immediately after connecting to the FTP server.

Data Type

String

Default Value

Remarks

AfterConnect is a script that is executed immediately following a successful connection.

The script may contain any number of standard FTP commands.

Each line in the script is treated as a single command. By default, if the adapter encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the adapter. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

AfterGet Property (AS3 Adapter)

A set of FTP commands to be executed after AS3 Messages are downloaded.

Data Type

String

Default Value

Remarks

AfterGet is a script that is executed immediately following each successful FTP GET operation.

The script may contain any number of standard FTP commands.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Sender.

AfterPut Property (AS3 Adapter)

A set of FTP commands to be executed after the files are uploaded to the server.

Data Type

String

Default Value

Remarks

AfterPut is a script that is executed immediately following each successful FTP PUT operation.

In the Send adapter, this is executed after outgoing AS3 files are uploaded.

In the Receive adapter, this is executed after outgoing MDN files are uploaded.

The script may contain any number of standard FTP commands.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

AS3From Property (AS3 Adapter)

The identity of the sending system.

Data Type

String

Default Value

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

AS3MessageId Property (AS3 Adapter)

The Id of the AS3 Message.

Data Type

String

Default Value

Remarks

The Id format is as in RFC 2822: id-left@id-right. This will be the Id assigned to the AS3 message.

In the Send adapter, AS3MessageId returns an Id generated by the adapter for each outgoing file.

In the Receive adapter, AS3MessageId contains the Original-Message-ID reported in the MDN receipt, which identifies the Id of the initial AS3 transmission.

It is recommended that you match these values in your orchestration to ensure that the MDN receipt is matched against the transmission.

AS3To Property (AS3 Adapter)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

Required.

BeforeGet Property (AS3 Adapter)

A set of FTP commands to be executed before AS3 Messages are downloaded.

Data Type

String

Default Value

Remarks

BeforeGet is a script that is executed immediately before each successful FTP GET operation.

The script may contain any number of standard FTP commands.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Sender.

BeforePut Property (AS3 Adapter)

A set of FTP commands to be executed before the files are uploaded to the server.

Data Type

String

Default Value

Remarks

BeforePut is a script that is executed immediately before each successful FTP PUT operation.

In the Send adapter, this is executed before outgoing AS3 files are uploaded.

In the Receive adapter, this is executed before outgoing MDN files are uploaded.

The script may contain any number of standard FTP commands.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

CompressionFormat Property (AS3 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.

DeleteMode Property (AS3 Adapter)

Controls if and when the remote files are deleted after processing.

Data Type

Enumeration

Possible Values

Never (0)
On Success (1)
On Failure (2)
Always (3)

Default Value

Remarks

This property informs the adapter as to whether or not it should delete a remote file from the server after a successful download. The possible values and their meanings are as follows:


Never	The remote file is never deleted.
OnSuccess	The remote file is deleted after a successful MDN delivery.
OnFailure	The remote file is deleted if the transfer fails or the MDN cannot be delivered.
Always	The remote file is deleted regardless of success or failure of the transfer and MDN delivery.

Note: the default value is Never for data protection purposes. Unless modified this will result in the adapter continuously receiving the same data.

This property is not available in the Sender.

DeliveryPath Property (AS3 Adapter)

The remote path on the FTP server where outgoing AS3 messages are delivered.

Data Type

String

Default Value

Remarks

The DeliverPath determines what directory outgoing AS3 messages are sent to. You can set it to either an absolute directory path or a path relative to the initial remote directory when the adapter connects to the FTP server.

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

ErrorThreshold Property (AS3 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.

Filemask Property (AS3 Adapter)

A filemask used to filter incoming messages for processing.

Data Type

String

Default Value

Remarks

When receiving files for processing, the adapter will filter files based on FileMask. If FileMask is not specified, the adapter will not filter files based on the filename. If the FTP server supports it, normal wildcard characters may be used, e.g.:

*.*

This property is not available in the Sender.

FileName Property (AS3 Adapter)

The file name of the AS3 message to generate.

Data Type

String

Default Value

Remarks

FileName should contain the name of the file that will be written on the AS3/FTP server. You may leave FileName blank to allow the component to determine an appropriate name.

This property is not available in the Receiver.

Firewall Property (AS3 Adapter)

A set of properties related to firewall access.

Data Type

Default Value

Remarks

The FTPServer property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server.

If the FTPServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FTPServer property is set to the corresponding address. If the search is not successful, an error is returned.

FTPUser Property (AS3 Adapter)

The user id to log into the FTP server.

Data Type

String

Default Value

Remarks

LogDirectory Property (AS3 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. For each request processed, the adapter will log the original EDI data, the complete text of the outgoing request and the incoming response.

The adapter will write multiple log file for each transmission, with separate extensions for each type of data:


Status (.log)	Contains information on applied security options and pass/fail status of transmission
Request (.req)	Contains the outgoing request, after security options have been applied
Payload (.dat)	Contains log of unsecured payload prior to transmission
AS1 Message (.as3)	Raw AS3 messages created or downloaded by the adapter.
MDN Receipt (.as3-mdn)	MDN receipts created or downloaded by the adapter.
Error (.err)	This is only written in an error is encountered, containing the error.

LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the adapter will attempt to create the directory. The following macros are supported:


%MessageID%	The MessageID of the AS3 transmission, after it is generated.
%OriginalMessageID%	In MDN Receipts, the MessageID of the transmission that the receipt is for. You can use this to pair asynchronous MDN receipt logs with their transmissions
%date:format%	%Format% is a platform-specific date/time formatting string. For example: yyyy-MM-dd-HH-mm-ss-tttt

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, with extensions "-2", "-3", used in case files of those names already exist.

If logs cannot be written an exception will be thrown.

MaxBatchSize Property (AS3 Adapter)

The maximum size, in MB, of the current batch (0 indicates no limit).

Data Type

Integer

Default Value

Default Value

Remarks

This setting specifies the maximum number of simultaneous persistent connections when sending.

The default value is 1, which limits the adapter to using one persistent connection for the adapter at any one time. This means when ConnectionLifetime is set to Persisted the send adapter will first check to see if an existing connection is present before transmitting data. In the case where a connection exists but another instance of the send port is using the connection the adapter will wait for the connection to become free. A value of 1 effectively serializes all communication for the send port through one persistent connection.

By setting a value greater than 1 a pool of persistent connections can be created. This allows multiple simultaneous persistent connections to be used. When the send adapter is active it will check to see if there are any existing connections. In the case where a connection exists but is being used by another instance of the send port it will attempt to create a new persistent connection. If creating a new persistent connection would exceed the limit specified in this setting the adapter will instead wait for a connection to become free. Setting this to a value greater than 1 allows multiple simultaneous connections to be made while still taking advantage of persistent connections to reduce the overhead of re-connecting.

Note: This only applies to the send adapter.

The default value is 1.

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.

MaxThreads Property (AS3 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 (AS3 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.

MDNDisposition Property (AS3 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 AS3 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 AS3 receiver when the message was processed. It is recommended that you read this values in your orchestration to determine the overall status of the AS3 message delivery.

This property is not available in the Sender.

MDNFileName Property (AS3 Adapter)

The file name of the MDN receipt generated by the component.

Data Type

String

Default Value

Remarks

FileName should contain the name of the file that will be written on the AS3/FTP server. You may use the keyword %AS3MessageId% to refer to the complete AS3 MessageID of the incoming message, e.g.:

%AS3MessageId%.MDN

If ReceiveMode is set to rAS3Message, MDNFileName must be specified.

This property is not available in the Sender.

MDNMICValue Property (AS3 Adapter)

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

Data Type

String

Default Value

Remarks

This property will contain the MIC calculated over the EDI payload.

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

It is recommended that you match these values in your orchestration to ensure that the MDN contains the correct MIC calculated in the send transmission.

MDNPath Property (AS3 Adapter)

The remote path on the FTP server where MDN's are sent or received.

Data Type

String

Default Value

Remarks

In the Send adapter, the MDNPath determines what directory incoming MDN receipts are read from.

In the Receive adapter, the MDNPath determines what directory MDN receipts are sent to.

You can set it to either an absolute directory path or a path relative to the initial remote directory when the adapter connects to the FTP server.

This property is not available in the Sender.

MDNSignatureStatus Property (AS3 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 (AS3 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 AS3 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 (AS3 Adapter)

The system to which an MDN should be directed.

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. You should specify a valid FTP URL for the request, e.g., "ftp://123.0.0.1".

Other Property (AS3 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

Passive Property (AS3 Adapter)

Controls whether to direct the server into passive mode. Recommended if behind a firewall.

Data Type

Boolean

Default Value

true

Remarks

When false, FTP communications take place in Active mode. In an Active mode connection, data connections are established from server to client on an IP address and port specified by the client in a PORT command to the server.

Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client adapter expects them. By default, Passive is set to TRUE, and the adapter will request that FTP communications take place in Passive mode. In Passive mode, the adapter will use the PASV instead of the PORT command and data connections will be established from the client to the server.

PollingInterval Property (AS3 Adapter)

The amount of time, in seconds, between download attempts.

Data Type

Integer

Default Value

Remarks

The adapter will wait for the number of seconds indicated before attempting another download.

This property is not available in the Sender.

ReceiveMode Property (AS3 Adapter)

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

Data Type

Enumeration

Possible Values

AS3Message (0)
MDN (1)

Default Value

Remarks

The possible values and their meanings are as follows:


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

This property is not available in the Sender.

ReceivePath Property (AS3 Adapter)

The remote path on the FTP server where incoming AS3 files are processed.

Data Type

String

Default Value

Remarks

The ReceivePath determines what directory the adapter uses to look for incoming AS3 files. You can set it to either an absolute directory path or a path relative to the initial remote directory when the adapter connects to the FTP server.

This property is not available in the Sender.

RecipientCert Property (AS3 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 trading partner reports decryption errors or adapter is unable to verify a signature, make sure RecipientCert is set appropriately.

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.

RequeueEndpoints Property (AS3 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.

This is only used if your FTP server requires SSL client authentication.

This field is used to set a Private Key Certificate.

SSLStartMode Property (AS3 Adapter)

Determines how the component starts the SSL negotiation with the FTP Server.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)

Default Value

Remarks

The SSLStartMode property may have one of the following values:


Automatic	If the remote port is set to the standard plaintext port of the protocol (where applicable), the adapter will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit (Implicit).
Implicit	The SSL negotiation will start immediately after the connection is established.
Explicit	The adapter will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
None	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Timeout Property (AS3 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).

TransmitBatchMode Property (AS3 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.

Default Value

false

Remarks

When this is set to true, the adapter will send the NLST command to the server. This tells the server to return a more simply formatted listing. If the server's directory listing can not be parsed when this is false, setting this to true will be helpful.

This property is not available in the Sender.

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

Config Settings (AS3 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.

AS3 Config Settings

DeleteOnSuspend: Specifies whether files may be deleted from server when message is suspended.

If true, the file on the server will be deleted in accordance with the option selected in DeleteMode even if the message is suspended.

The default value is False.

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

In the Send adapter, if RecipientCert is set to a valid certificate, the data will be encrypted using "3DES", or industry-standard 168-bit Triple-DES encryption. Use of this algorithm is strongly recommended.

If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The adapter also supports "RC2" (with a default keysize of 128 bits; you may also set "RC2CBC40" or "RC2CBC64" for 40- or 64-bit keysizes), single "DES", and "AES" encryption (with a default keysize of 128 bits; you may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes).

MDNOptions: Used to indicate the options requested for the MDN receipt.

By default, the adapter will request that the MDN be signed with a PKCS#7 signature over an SHA1 or MD5 hash, which is the industry standard.

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

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

MDNPassword: A password id to login to the MDN FTP server.

Ordinarily, the adapter uses the same FTP server to manage AS3 Messages and MDN receipts. Use this value to send and receive MDN's on a separate server.

MDNServer: A separate FTP server to use for MDN's.

Ordinarily, the adapter uses the same FTP server to manage AS3 Messages and MDN receipts. Use this value to send and receive MDN's on a separate server.

MDNUser: A user id to login to the MDN FTP server.

Ordinarily, the adapter uses the same FTP server to manage AS3 Messages and MDN receipts. Use this value to send and receive MDN's on a separate server.

MessageSecurity: Required security level for incoming messages.

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

Other values include:


0	None
1	Signed
2	Encrypted
3	Signed And Encrypted

CAUTION: "None" is included for debugging purposes only. There is no security with this level.

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.