RNIF Adapter

The RNIF Component provides a way to send and receive RosettaNet messages.

Remarks

The RNIF Adapter can be used to send and receive RosettaNet messages. Encryption and Signing are supported, as well a variety of signature algorithms including SHA-256.

RNIF Send Adapter

The RNIF Send Adapter may be used to send RosettaNet messages to a partner's server. The adapter of properties may be configured before receiving messages. Some of the basic properties that should be set are:

FromRole
FromService
PartnerId
PartnerKnown
ToRole
ToService

The body of the BizTalk message submitted to the adapter will be used as the ServiceContent.

The adapter may be used in a Solicit Response Send Port. The response received from the server will be present in the body of the BizTalk message returned by the adapter.

The following properties are used to encrypt/sign the outgoing message and verify the signature on a received receipt.

Certificate
RecipientCert
ReceiptSignerCert

The RNIF adapter only supports processing synchronous responses. Asynchronous responses cannot be processed.

RNIF Receive Adapter

The RNIF Receive Adapter is an isolated adapter which requires the use of a HTTP endpoint hosted in IIS to receive requests from your partner. Included in the demos folder of the installation is a "aspx-cs" folder with a "rnifserver.aspx" file. This file contains the necessary logic to receive requests and pass them to the RNIF receive location configured from the BizTalk Administration Console.

The HTTP endpoint is created during setup by default. Confirm that an application exists in IIS that has a physical path pointing to the "aspx-cs" demo directory on disk.

One receive location must be configured for each partner from which RosettaNet messages will be received. A variety of properties may be configured before receiving messages. Some of the basic properties that should be set are:

FromRole
FromService
PartnerId
PartnerKnown
ToRole
ToService

If the message is signed and/or encrypted, or if a signed receipt will be sent back in response the following properties are applicable:

Certificate
RecipientCert
SignerCert

Note that the adapter will automatically send a receipt after processing the data. This may be disabled by setting SendReceipt to False.

At this time only receipts may be sent in response to received messages. Responding with action messages is not supported.

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.


ActionCode	The code for this action.
ActionMessageStandardName	The name of the standard used to create this action.
ActionMessageStandardVersion	The version of the standard used to create this action.
AsyncRespURL	The URL to which the asynchronous response is posted.
AttachmentOutputPath	Specifies a path on disk to which attachments will be saved.
BusinessActivity	This property denotes the type of business activity.
Certificate	The digital id to be used for decryption and signing.
DeliveryHeaderXML	The complete XML data from the Delivery Header.
EncryptionAlgorithm	The algorithm used to encrypt the EDI data.
EncryptionType	The encryption type for RNIF 2.0.
ErrorThreshold	The maximum number of errors before the component shuts down.
FromRole	The business role of the entity that originated this message.
FromService	The service that originated this message.
GlobalUsageCode	A universal code describing basic usage for this message.
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.
MessageReceiverId	Identity of the entity receiving this message.
MessageReceiverLocation	Location of the entity receiving this message.
MessageSenderId	Identity of the entity that sent this message.
MessageSenderLocation	Location of the entity that sent this message.
MessageTrackingId	Unique value that identifies this message.
Other	Defines a set of configuration settings to be used by the component.
PartnerId	Identity of the partner.
PartnerKnown	Whether or not the partner is known.
PartnerLocation	Location of the partner.
PartnerPIPBindingId	The partner-defined PIP payload binding ID.
PartnerURL	A URL to which replies must be sent if the partner is unknown.
PIPCode	RosettaNet PIP code of this message.
PIPInstanceId	The Id of this PIP instance.
PIPVersion	RosettaNet PIP version of this message.
PollingInterval	The amount of time, in seconds, between download attempts.
PreambleHeaderXML	The complete XML data from the Preamble Header.
RecipientCert	The public certificate of the recipient used for encryption.
RegisterIsolatedReceiverTimeout	This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RNIFSiteURL	The path to the website hosting the RNIF component.
RuntimeLicense	Specifies the component runtime license key.
SecureTransportRequired	Indicates that security is required when forwarding this message.
ServiceHeaderXML	The complete XML data from the Service Header.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
SignerCert	The public certificate used to verify signed requests.
SignReceipt	Whether or not to sign the receipt.
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept.
SSLCert	The certificate to use for client authentication during the SSL handshake.
StandardName	The name of the standard used to create this message.
StandardVersion	The version of the standard used to create this message.
Timeout	A timeout for the component.
ToRole	The role of the entity receiving this message.
ToService	The service for which this message is bound.
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.

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.


ActionCode	The code for this action.
ActionMessage	Whether or not this message is an action message.
ActionMessageStandardName	The name of the standard used to create this action.
ActionMessageStandardVersion	The version of the standard used to create this action.
BusinessActivity	This property denotes the type of business activity.
Certificate	The digital id to be used for decryption and signing.
DeliveryHeaderXML	The complete XML data from the Delivery Header.
EncryptionAlgorithm	The algorithm used to encrypt the EDI data.
EncryptionType	The encryption type for RNIF 2.0.
FromRole	The business role of the entity that originated this message.
FromService	The service that originated this message.
GlobalUsageCode	A universal code describing basic usage for this message.
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.
MessageDateTime	The time at which this message was sent.
MessageReceiverId	Identity of the entity receiving this message.
MessageReceiverLocation	Location of the entity receiving this message.
MessageSenderId	Identity of the entity that sent this message.
MessageSenderLocation	Location of the entity that sent this message.
MessageTrackingId	Unique value that identifies this message.
OriginalActionCode	The action code of the original message.
OriginalMessageStandardName	The name of the standard used to create the original message.
OriginalMessageStandardVersion	The version of the standard used to create the original message.
OriginalMessageTrackingId	Tracking identifier for the original message.
Other	Defines a set of configuration settings to be used by the component.
PartnerId	Identity of the partner.
PartnerKnown	Whether or not the partner is known.
PartnerLocation	Location of the partner.
PartnerPIPBindingId	The partner-defined PIP payload binding ID.
PartnerURL	A URL to which replies must be sent if the partner is unknown.
PIPCode	RosettaNet PIP code of this message.
PIPInstanceId	The Id of this PIP instance.
PIPVersion	RosettaNet PIP version of this message.
PreambleHeaderXML	The complete XML data from the Preamble Header.
ReceiptSignerCert	The public certificate used to verify signed responses.
RecipientCert	The public certificate of the recipient used for encryption.
ReplyHeaders	This property is used to retrieve headers from synchronous reply messages.
ReplyMessage	Whether or not this message is a reply to another message.
ResponseType	Requested response type. Available only in RNIF 2.0.
RNIFVersion	The RNIF Standard Version used to generate this message.
RuntimeLicense	Specifies the component runtime license key.
SecureTransportRequired	Indicates that security is required when forwarding this message.
ServiceHeaderXML	The complete XML data from the Service Header.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept.
SSLCert	The certificate to use for client authentication during the SSL handshake.
StandardName	The name of the standard used to create this message.
StandardVersion	The version of the standard used to create this message.
Timeout	A timeout for the component.
ToRole	The role of the entity receiving this message.
ToService	The service for which this message is bound.
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.
URL	The URL to which requests are sent.

Config Settings

The following is a list of config settings for the Adapter with short descriptions. Click on the links for further details.


ApplyBase64Encoding	Allows you to control the base64 encoding of the message body when signing the message.
Authorization	The Authorization string to be sent to the server.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
ExpectedVersion	The RNIF document version that the RNIFReceiver is expecting to receive.
FromPartnerClassificationCode	Code identifying the sending partner's function in the supply chain.
GlobalProcessCode	Business process identifier.
Password	A password if authentication is to be used.
SendReceipt	Whether to send a receipt automatically.
ToPartnerClassificationCode	Code identifying the receiving partner's function in the supply chain.
TransactionCode	The service transaction code.
TransactionId	A unique transaction Id.
User	A user name if authentication is to be used.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.

RNIF Receiver

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

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


ActionCode	The code for this action. Type: xs:string Default Value: ""
ActionMessageStandardName	The name of the standard used to create this action. Type: xs:string Default Value: ""
ActionMessageStandardVersion	The version of the standard used to create this action. Type: xs:string Default Value: ""
AsyncRespURL	The URL to which the asynchronous response is posted. Type: xs:string Default Value: ""
AttachmentOutputPath	Specifies a path on disk to which attachments will be saved. Type: xs:string Default Value: ""
BusinessActivity	This property denotes the type of business activity. Type: xs:string Default Value: ""
Certificate	The digital id to be used for decryption and signing. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
DeliveryHeaderXML	The complete XML data from the Delivery Header. Type: xs:string Default Value: ""
EncryptionAlgorithm	The algorithm used to encrypt the EDI data. Type: xs:string Default Value: "3DES"
EncryptionType	The encryption type for RNIF 2.0. Type: xs:int Default Value: 0
ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int Default Value: 5
FromRole	The business role of the entity that originated this message. Type: xs:string Default Value: ""
FromService	The service that originated this message. Type: xs:string Default Value: ""
GlobalUsageCode	A universal code describing basic usage for this message. Type: xs:int Default Value: 0
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
MessageReceiverId	Identity of the entity receiving this message. Type: xs:string Default Value: "" NOTE: This property must have a value.
MessageReceiverLocation	Location of the entity receiving this message. Type: xs:string Default Value: ""
MessageSenderId	Identity of the entity that sent this message. Type: xs:string Default Value: "" NOTE: This property must have a value.
MessageSenderLocation	Location of the entity that sent this message. Type: xs:string Default Value: ""
MessageTrackingId	Unique value that identifies this message. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
PartnerId	Identity of the partner. Type: xs:string Default Value: ""
PartnerKnown	Whether or not the partner is known. Type: bool Default Value: false
PartnerLocation	Location of the partner. Type: xs:string Default Value: ""
PartnerPIPBindingId	The partner-defined PIP payload binding ID. Type: xs:string Default Value: ""
PartnerURL	A URL to which replies must be sent if the partner is unknown. Type: xs:string Default Value: ""
PIPCode	RosettaNet PIP code of this message. Type: xs:string Default Value: ""
PIPInstanceId	The Id of this PIP instance. Type: xs:string Default Value: ""
PIPVersion	RosettaNet PIP version of this message. Type: xs:string Default Value: ""
PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int Default Value: 60
PreambleHeaderXML	The complete XML data from the Preamble Header. Type: xs:string Default Value: ""
RecipientCert	The public certificate of the recipient used for encryption. Type: Certificate Default Value: null
RegisterIsolatedReceiverTimeout	This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location. Type: xs:int Default Value: 15
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool Default Value: false
RNIFSiteURL	The path to the website hosting the RNIF component. Type: xs:string Default Value: "" NOTE: This property must have a value.
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SecureTransportRequired	Indicates that security is required when forwarding this message. Type: bool Default Value: false
ServiceHeaderXML	The complete XML data from the Service Header. Type: xs:string Default Value: ""
SignatureAlgorithm	Signature algorithm to be used in outgoing messages. Type: xs:string Default Value: "SHA256"
SignerCert	The public certificate used to verify signed requests. Type: Certificate Default Value: null
SignReceipt	Whether or not to sign the receipt. Type: bool Default Value: false
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept. Type: Certificate Default Value: null
SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
StandardName	The name of the standard used to create this message. Type: xs:string Default Value: "RosettaNet" NOTE: This property must have a value.
StandardVersion	The version of the standard used to create this message. Type: xs:string Default Value: "" NOTE: This property must have a value.
Timeout	A timeout for the component. Type: xs:int Default Value: 60
ToRole	The role of the entity receiving this message. Type: xs:string Default Value: ""
ToService	The service for which this message is bound. Type: xs:string Default Value: ""
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.
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.

RNIF Transmitter

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


ActionCode	The code for this action. Type: xs:string Default Value: ""
ActionMessage	Whether or not this message is an action message. Type: bool Default Value: true
ActionMessageStandardName	The name of the standard used to create this action. Type: xs:string Default Value: ""
ActionMessageStandardVersion	The version of the standard used to create this action. Type: xs:string Default Value: ""
BusinessActivity	This property denotes the type of business activity. Type: xs:string Default Value: ""
Certificate	The digital id to be used for decryption and signing. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
DeliveryHeaderXML	The complete XML data from the Delivery Header. Type: xs:string Default Value: ""
EncryptionAlgorithm	The algorithm used to encrypt the EDI data. Type: xs:string Default Value: "3DES"
EncryptionType	The encryption type for RNIF 2.0. Type: xs:int Default Value: 0
FromRole	The business role of the entity that originated this message. Type: xs:string Default Value: ""
FromService	The service that originated this message. Type: xs:string Default Value: ""
GlobalUsageCode	A universal code describing basic usage for this message. Type: xs:int Default Value: 0
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
MessageDateTime	The time at which this message was sent. Type: xs:string Default Value: ""
MessageReceiverId	Identity of the entity receiving this message. Type: xs:string Default Value: "" NOTE: This property must be specified.
MessageReceiverLocation	Location of the entity receiving this message. Type: xs:string Default Value: ""
MessageSenderId	Identity of the entity that sent this message. Type: xs:string Default Value: "" NOTE: This property must be specified.
MessageSenderLocation	Location of the entity that sent this message. Type: xs:string Default Value: ""
MessageTrackingId	Unique value that identifies this message. Type: xs:string Default Value: ""
OriginalActionCode	The action code of the original message. Type: xs:string Default Value: ""
OriginalMessageStandardName	The name of the standard used to create the original message. Type: xs:string Default Value: ""
OriginalMessageStandardVersion	The version of the standard used to create the original message. Type: xs:string Default Value: ""
OriginalMessageTrackingId	Tracking identifier for the original message. Type: xs:string Default Value: ""
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
PartnerId	Identity of the partner. Type: xs:string Default Value: ""
PartnerKnown	Whether or not the partner is known. Type: bool Default Value: false
PartnerLocation	Location of the partner. Type: xs:string Default Value: ""
PartnerPIPBindingId	The partner-defined PIP payload binding ID. Type: xs:string Default Value: ""
PartnerURL	A URL to which replies must be sent if the partner is unknown. Type: xs:string Default Value: ""
PIPCode	RosettaNet PIP code of this message. Type: xs:string Default Value: ""
PIPInstanceId	The Id of this PIP instance. Type: xs:string Default Value: ""
PIPVersion	RosettaNet PIP version of this message. Type: xs:string Default Value: ""
PreambleHeaderXML	The complete XML data from the Preamble Header. Type: xs:string Default Value: ""
ReceiptSignerCert	The public certificate used to verify signed responses. Type: Certificate Default Value: null
RecipientCert	The public certificate of the recipient used for encryption. Type: Certificate Default Value: null
ReplyHeaders	This property is used to retrieve headers from synchronous reply messages. Type: xs:string Default Value: ""
ReplyMessage	Whether or not this message is a reply to another message. Type: bool Default Value: false
ResponseType	Requested response type. Available only in RNIF 2.0. Type: xs:int Default Value: 0
RNIFVersion	The RNIF Standard Version used to generate this message. Type: xs:int Default Value: 1
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SecureTransportRequired	Indicates that security is required when forwarding this message. Type: bool Default Value: false
ServiceHeaderXML	The complete XML data from the Service Header. Type: xs:string Default Value: ""
SignatureAlgorithm	Signature algorithm to be used in outgoing messages. Type: xs:string Default Value: "SHA256"
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept. Type: Certificate Default Value: null
SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
StandardName	The name of the standard used to create this message. Type: xs:string Default Value: "RosettaNet" NOTE: This property must be specified.
StandardVersion	The version of the standard used to create this message. Type: xs:string Default Value: "" NOTE: This property must be specified.
Timeout	A timeout for the component. Type: xs:int Default Value: 60
ToRole	The role of the entity receiving this message. Type: xs:string Default Value: ""
ToService	The service for which this message is bound. Type: xs:string Default Value: ""
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: ""
URL	The URL to which requests are sent. Type: xs:string Default Value: "" NOTE: This property must be specified.

Click OK and OK again to save settings.

ActionCode Property (RNIF Adapter)

The code for this action.

Data Type

String

Default Value

Remarks

This property is a string which denotes the type of action for the current RosettaNet message, if it is an action. If it is a reply, then the ActionCode describes the type of action that the message is in reply to. An example is a "Purchase Order Request Action."

ActionMessage Property (RNIF Adapter)

Whether or not this message is an action message.

Data Type

Boolean

Default Value

true

Remarks

This property indicates whether or not the message is an action message. A RosettaNet action is defined as a message which requires or requests a business activity. A "PurchaseOrderRequestMessage" is a valid Business Action message, as is the corresponding "PurchaseOrderConfirmMessage". The latter, however, is also a reply to the original action request.

Receipt acknowledgments are considered Signals, and not Business Action messages, even though they contain all of the properties of a valid Business Action message.

This property is a field of the service header.

This property is not available in the Receiver.

ActionMessageStandardName Property (RNIF Adapter)

The name of the standard used to create this action.

Data Type

String

Default Value

Remarks

While the RosettaNet community has a set of widely adopted, pre-defined and standardized message templates, it also allows for business partners to agree on specification geared more toward their particular needs. If a special, non-RosettaNet standard is to be used to create the action message, the name of the standard must be reported in ActionMessageStandardName and the version in ActionMessageStandardVersion. This way, the receiving entity can know how to process and interpret the incoming business message.

Since replies may sent in response to a message created using such a specialized standard, the standard used to create the original message should be referenced using the OriginalMessageStandardName and OriginalMessageStandardVersion when creating or processing replies.

This property is a field of the service header.

ActionMessageStandardVersion Property (RNIF Adapter)

The version of the standard used to create this action.

Data Type

String

Default Value

Remarks

This property is a field of the service header.

AsyncRespURL Property (RNIF Adapter)

The URL to which the asynchronous response is posted.

Data Type

String

Default Value

Remarks

This property specifies the URL to which the asynchronous response (if requested) is posted.

If an incoming messages requests an async response the adapter will automatically send a response to the URL specified in this setting.

This is only applicable if the sender has requested an async response.

This property is not available in the Sender.

AttachmentOutputPath Property (RNIF Adapter)

Specifies a path on disk to which attachments will be saved.

Data Type

String

Default Value

Remarks

This property specifies a path on disk to which attachments will be saved when processing incoming messages.

This property is not available in the Sender.

BusinessActivity Property (RNIF Adapter)

This property denotes the type of business activity.

Data Type

String

Default Value

Remarks

This property tells the receiver what type of business activity the RosettaNet document that is sent refers to. An example is: "Create Purchase Order".

Certificate Property (RNIF Adapter)

The digital id to be used for decryption and signing.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for signing outgoing messages and decrypting incoming messages.

RNIF Send Adapter

The certificate with private key specified will be used to sign outgoing messages. If the response from the server is encrypted this will be used to decrypt the response.

RNIF Receive Adapter

The certificate with private key specified will be used to decrypt received messages. If a signed response is sent this will be used to sign the response.

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.

DeliveryHeaderXML Property (RNIF Adapter)

The complete XML data from the Delivery Header.

Data Type

String

Default Value

Remarks

This property is the full XML data of the RosettaNet message Delivery Header. This header contains information about the sending and receiving business processes, as well as tracking data for the message itself. This header was introduced by RNIF 2.0 to speed the movement of RosettaNet messages through message-forwarding hubs.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the adapter. If the value of a related property changes, this property will be updated the next time it is polled and the current valid XML will be returned. When this property is set directly, the adapter will automatically parse the XML and validate the content of the header to ensure that all required fields contain appropriate values. Once this property has been set and validated, the following properties will be populated:

SecureTransportRequired
MessageDateTime
MessageReceiverId
MessageReceiverLocation
MessageSenderId
MessageSenderLocation
MessageTrackingId

NOTE: If RNIFVersion is set to v1, the value of this property is ignored when generating messages.

EncryptionAlgorithm Property (RNIF Adapter)

The algorithm used to encrypt the EDI data.

Data Type

String

Default Value

"3DES"

Remarks

If RecipientCerts contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in EncryptionAlgorithm. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The adapter supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The adapter supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

Possible values are:

3DES (default)
DES
AESCBC128
AESCBC192
AESCBC256
AESGCM128
AESGCM192
AESGCM256

EncryptionType Property (RNIF Adapter)

The encryption type for RNIF 2.0.

Data Type

Enumeration

Possible Values

No Encryption (0)
Encrypt Service Content (1)
Encrypt Payload Container (2)

Default Value

Remarks

RNIF 2.0 allows encryption of a message at three different levels:


0 (etNoEncryption)	The entire contents of the RosettaNet message are unencrypted.
1 (etEncryptServiceContent)	The service content and attachments are encrypted.
2 (etEncryptPayloadContainer)	The service header, content, and attachments are encrypted.

NOTE: By default, the value is etNoEncryption. Therefore, if encryption is desired, the EncryptionType property must be specified, even if a certificate is supplied through the certificate properties. See RecipientCert for more information on specifying a certificate for encryption.

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

FromRole Property (RNIF Adapter)

The business role of the entity that originated this message.

Data Type

String

Default Value

Remarks

This property describes what role the process sending this message plays in the business model. This may be a one-word description, e.g. "Buyer".

This property is a field of the service header.

FromService Property (RNIF Adapter)

The service that originated this message.

Data Type

String

Default Value

Remarks

This property describes the type of service that is being provided by the sender of this message. This can be a short description of the service being provided, e.g. "Buyer Service".

This property is a field of the service header.

GlobalUsageCode Property (RNIF Adapter)

A universal code describing basic usage for this message.

Data Type

Enumeration

Possible Values

Test (0)
Production (1)

Default Value

Remarks

GlobalUsageCode is a value that specifies how the RosettaNet message is to be treated from a business standpoint.This property currently only supports the following two values:

0 (gucTest)
1 (gucProduction)

This property is a field of the service header.

MaxBatchSize Property (RNIF Adapter)

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

Data Type

Integer

Default Value

Remarks

This property limits the maximum amount of data the adapter can store before finalizing and processing the current batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

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.

MaxFileCount Property (RNIF Adapter)

The maximum number of files in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

Remarks

This property places a limit on the number of files that can be transmitted in a single batch.

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.

MaxFileSize Property (RNIF Adapter)

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

Data Type

Integer

Default Value

Remarks

This property limits the maximum size of any file in the current transmission batch to the number of bytes indicated.

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.

MaxPersistentConnections Property (RNIF Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

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 (RNIF 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 (RNIF 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.

MessageDateTime Property (RNIF Adapter)

The time at which this message was sent.

Data Type

String

Default Value

Remarks

This property is a date and time stamp representing the moment the RosettaNet message was created. The sending process should set this value as close to the time when it sends as possible. The accepted standard for date fields in RosettaNet messages uses the format "YYYYMMDDThhmmss.sssZ", e.g. "20001121T145200.000Z". The format is interpreted as follows:


YYYY	This is the year of the time stamp.
MM	This is the month of the time stamp.
DD	This specifies the day of the month.
T	The 'T' denotes the separation between the date and the time stamps.
hh	This is the hour, in 24 hour format in which the message was sent.
mm	This specifies the minutes at which the message was sent.
ss.sss	This is the seconds at which the message was sent. Everything after the decimal is a fraction of a seconds.
Z	This is a delimiter for the end of the date/time stamp.

The message in the example was sent at 2:52:00.000 PM November 11, 2000.

This property is a field of the delivery header.

This property is not available in the Receiver.

MessageReceiverId Property (RNIF Adapter)

Identity of the entity receiving this message.

Data Type

String

Default Value

Remarks

MessageReceiverId describes the identity of the receiver for this message. It is specifically the DUNS number for the trading partner.

This property is a field of the delivery header.

MessageReceiverLocation Property (RNIF Adapter)

Location of the entity receiving this message.

Data Type

String

Default Value

Remarks

This property describes the location of the receiver for this message. The location is not an address, but may be a city name.

This property is a field of the delivery header.

MessageSenderId Property (RNIF Adapter)

Identity of the entity that sent this message.

Data Type

String

Default Value

Remarks

MessageSenderId describes the identity of the sender for this message. It is specifically the DUNS number for the trading partner.

This property is a field of the delivery header.

MessageSenderLocation Property (RNIF Adapter)

Location of the entity that sent this message.

Data Type

String

Default Value

Remarks

This property describes the location of the sender for this message. The location is not an address, but may be a city name.

This property is a field of the delivery header.

MessageTrackingId Property (RNIF Adapter)

Unique value that identifies this message.

Data Type

String

Default Value

Remarks

MessageTrackingId is a unique instance identifier for this message. This value is used by both parties to keep a record of all the messages it receives. It is the responsibility of the sender to ensure that this value is unique for each transaction. The receiving entity should respond with an error if it receives a message with a previously used tracking id. This value can be used to persist any information relevant to the current business process to an external database .

This property is a field of the delivery header.

OriginalActionCode Property (RNIF Adapter)

The action code of the original message.

Data Type

String

Default Value

Remarks

This property describes the action code of the original message. This is useful when acquiring or processing replies. This tells a process what the original action was which started the current business process of actions and replies.

This property is a field of the service header.

This property is not available in the Receiver.

OriginalMessageStandardName Property (RNIF Adapter)

The name of the standard used to create the original message.

Data Type

String

Default Value

Remarks

This property is a field of the service header.

This property is not available in the Receiver.

OriginalMessageStandardVersion Property (RNIF Adapter)

The version of the standard used to create the original message.

Data Type

String

Default Value

Remarks

This property is a field of the service header.

This property is not available in the Receiver.

OriginalMessageTrackingId Property (RNIF Adapter)

Tracking identifier for the original message.

Data Type

String

Default Value

Remarks

This property contains the identifier used to track the original message. This can be used when processing replies to previous actions to look up details about the original action that started the current business process. Complementary to the MessageTrackingId, this property can be used to retrieve any information relevant to the current business process from an external database.

This property is a field of the service header.

This property is not available in the Receiver.

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

PartnerId Property (RNIF Adapter)

Identity of the partner.

Data Type

String

Default Value

Remarks

PartnerKnown denotes whether or not the initiating partner for the current transaction is known. If the partner is known the sender should specify their business identifier using the PartnerId property. This allows the receiving entity to look up information on how to reply, or forward the current message, to the partner in question. Also, PartnerLocation can be specified. This property is not an address, but may be a city.

NOTE: If the partner is not known, then a PartnerURL MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

PartnerKnown Property (RNIF Adapter)

Whether or not the partner is known.

Data Type

Boolean

Default Value

false

Remarks

NOTE: If the partner is not known, then a PartnerURL MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

PartnerLocation Property (RNIF Adapter)

Location of the partner.

Data Type

String

Default Value

Remarks

NOTE: If the partner is not known, then a PartnerURL MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

PartnerPIPBindingId Property (RNIF Adapter)

The partner-defined PIP payload binding ID.

Data Type

String

Default Value

Remarks

This property is only defined when non-RosettaNet content is bound in the payload portion of the RosettaNet Business message. This may only be used with PIPs which specifically support the use of non-RosettaNet content. Both trading partners must agree on the use of non-RosettaNet content, and on the Id being used. The Id is used to identify the two partners' own version of the PIP used.

NOTE: This property MUST be set when non-RosettaNet content is being sent in the payload, and MUST NOT be set when regular PIP's are being used.

PartnerURL Property (RNIF Adapter)

A URL to which replies must be sent if the partner is unknown.

Data Type

String

Default Value

Remarks

NOTE: If the partner is not known, then a PartnerURL MUST be specified in order for the messages and responses to reach their appropriate destinations.

This property is a field of the service header.

NOTE: If partner is unknown and this value is not specified, further processing may not be possible.

PIPCode Property (RNIF Adapter)

RosettaNet PIP code of this message.

Data Type

String

Default Value

Remarks

The ServiceContent of a RosettaNet message is an instance of a pre-defined, widely accepted and standardized RosettaNet business action document called a Partner Interface Process (PIP). These documents define the most common business action scenarios, as well as the most common information used by a company to complete transactions under these scenarios. Each PIP has its own code, and many PIPs are defined in multiple versions. To ensure that the receiving partner knows how to interpret the PIP instance, the code should be set in PIPCode and the version in PIPVersion.

Since no two business actions are exactly the same, each instance of PIP needs to have an associated identifier so that information about the transaction may be easily persisted to and retrieved from an external database. These instance ids are reported by the PIPInstanceId property. It is up to the sending client to ensure that this value is unique. The receiver should respond with an error if it receives a PIP instance id that has already been used.

This property is a field of the service header.

PIPInstanceId Property (RNIF Adapter)

The Id of this PIP instance.

Data Type

String

Default Value

Remarks

This property is a field of the service header.

PIPVersion Property (RNIF Adapter)

RosettaNet PIP version of this message.

Data Type

String

Default Value

Remarks

This property is a field of the service header.

PollingInterval Property (RNIF 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.

PreambleHeaderXML Property (RNIF Adapter)

The complete XML data from the Preamble Header.

Data Type

String

Default Value

Remarks

The contents of PreambleHeaderXML are the full XML data RosettaNet message Preamble Header. This header includes information about the version of the RosettaNet Implementation Framework (RNIF) protocol used to create the message.

StandardName
StandardVersion

ReceiptSignerCert Property (RNIF Adapter)

The public certificate used to verify signed responses.

Data Type

Certificate

Remarks

This property specifies the partner's public certificate. It is used to verify the signature on signed responses. If this is not specified the certificate specified in RecipientCert will be used to verify the signature.

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.

RecipientCert Property (RNIF Adapter)

The public certificate of the recipient used for encryption.

Data Type

Certificate

Remarks

This property specifies the partner's public certificate. It is used to encrypt messages send to the partner.

This property is used to set a Public Key Certificate.

RegisterIsolatedReceiverTimeout Property (RNIF Adapter)

This setting specifies the number of seconds the isolated receive adapter will search for a corresponding receive location.

Data Type

Integer

Default Value

Remarks

When processing an incoming request from the HTTP endpoints the adapter will look for the URI of a receive location which matches the incoming request. This process communicates with BizTalk and in high load scenarios this operation may require additional time to complete. The default value is 15 seconds. If an intermittent "Timeout while waiting for endpoint configuration" error is seen, set this to a larger value.

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

ReplyHeaders Property (RNIF Adapter)

This property is used to retrieve headers from synchronous reply messages.

Data Type

String

Default Value

Remarks

This property is only used when the sender is requiring a synchronous reply or signal of acknowledgement to be sent by the receiver following its action message. This gets the header of the reply message or signal sent from the receiver. It is received from the synchronous connection.

NOTE: This property is only populated when a synchronous reply (i.e., a reply over the same HTTP connection as the POST) is received. In all other cases, it will be empty.

This property is not available in the Receiver.

ReplyMessage Property (RNIF Adapter)

Whether or not this message is a reply to another message.

Data Type

Boolean

Default Value

false

Remarks

This property is a boolean value indicating whether or not the message is a reply to a previous message or not. The first message in any business process is always an action message. Reply messages may be an update, another action, or a signal.

Some actions may request data, in which case a reply RosettaNet message must be sent with the data that was requested. All action messages sent in response to the original action message are considered replies.

When sending a reply, this property should be set to "True" to tell the receiver how to interpret and handle the message.

This property is a field of the service header.

This property is not available in the Receiver.

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

The default value is No.

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

ResponseType Property (RNIF Adapter)

Requested response type. Available only in RNIF 2.0.

Data Type

Enumeration

Possible Values

Sync (0)
Async (1)

Default Value

Remarks

This property tells the receiver which type of response the sender is expecting.

The following types of supported responses are:


rtSync	The response will be received on the same HTTP session as the initial request.
rtAsync	The response will be received later.

This property is only available in RNIF version 2.0.

This property is not available in the Receiver.

RNIFSiteURL Property (RNIF Adapter)

The path to the website hosting the RNIF component.

Data Type

String

Default Value

Remarks

This is the virtual path of the application that will host the instance of the RNIF adapter. It is not necessary to include the schema ("http") or host information: the adapter will ignore everything other than the path information.

For example, if the URL you would post to is "http://localhost/RNIFReceiver/RNIFServer.aspx", you only need to set "/RNIFReceiver/RNIFServer.aspx".

This property is not available in the Sender.

RNIFVersion Property (RNIF Adapter)

The RNIF Standard Version used to generate this message.

Data Type

Enumeration

Possible Values

1 (0)
2 (1)

Default Value

Remarks

This property describes which standard version of RNIF was used to generate this message. Possible values are::


v1	RosettaNet version 1.1
v2	RosettaNet version 2.0

This property is not available in the Receiver.

RuntimeLicense Property (RNIF Adapter)

Specifies the component runtime license key.

Data Type

String

Default Value

Remarks

You can use the RuntimeLicense property to set the runtime key for the adapter license.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

SecureTransportRequired Property (RNIF Adapter)

Indicates that security is required when forwarding this message.

Data Type

Boolean

Default Value

false

Remarks

This property is a boolean value which denotes whether or not security is required when forwarding this message. Since RosettaNet messages are business messages, secure transport is often required. See RNIFSENDER for more information on sending messages over a secure transport.

This property is a field of the delivery header.

ServiceHeaderXML Property (RNIF Adapter)

The complete XML data from the Service Header.

Data Type

String

Default Value

Remarks

ServiceHeaderXML contains the full XML data of the RosettaNet message Service Header. This header includes information about the contents of the RosettaNet message itself. It contains information about the type of message, the PIP used to create the service content, and the various attachments as well as information about the business partners involved in the transaction, such as each entity's role.

ActionCode
ActionMessage
ActionMessageStandardName
ActionMessageStandardVersion
Attachments
FromRole
FromService
OriginalActionCode
OriginalMessageStandardName
OriginalMessageStandardVersion
OriginalMessageTrackingId
PartnerId
PartnerKnown
PartnerLocation
PartnerPIPBindingId
PartnerURL
PIPCode
PIPInstanceId
PIPVersion
QOSSpecifications
ReplyMessage
SignalCode
SignalMessage
GlobalUsageCode
SignalVersion
ToRole
ToService

SignatureAlgorithm Property (RNIF Adapter)

Signature algorithm to be used in outgoing messages.

Data Type

String

Default Value

"SHA256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

sha1
md5
sha-256 (default)
sha-384
sha-512
sha-224

The default value is "sha256".

SignerCert Property (RNIF Adapter)

The public certificate used to verify signed requests.

Data Type

Certificate

Remarks

This property specifies the partner's public certificate. It is used to verify the signature on signed requests.

This property is used to set a Public Key Certificate.

This property is not available in the Sender.

SignReceipt Property (RNIF Adapter)

Whether or not to sign the receipt.

Data Type

Boolean

Default Value

false

Remarks

This property specifies whether receipts returned by the adapter are signed. The default value is False.

If set to True the receipt will be signed with the certificate specified by Certificate.

This property is not available in the Sender.

SSLAcceptServerCert Property (RNIF Adapter)

For sending HTTPS requests, a server certificate to unconditionally accept.

Data Type

Certificate

Remarks

In the Send Adapter, this property is used when communicating with trading partners via HTTPS to the URL specified in URL.

In the Receive Adapter, this property is used when an asynchronous MDN is requested by your trading partner to the URL specified in MDNDeliveryOption.

When an HTTPS request is issued by the adapter, a new secure connection is created with the trading partner. By default, the adapter will reject self-signed certificates and any other server certificates not signed by a trusted Certificate Authority (CA).

This property is used to set a Public Key Certificate.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the adapter to report the server's credentials to Location.

SSLCert Property (RNIF Adapter)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

StandardName Property (RNIF Adapter)

The name of the standard used to create this message.

Data Type

String

Default Value

"RosettaNet"

Remarks

This property is the name of the standard which was used to create the message. In this case, we are working with RosettaNet, so RosettaNet will always be the StandardName, unless this specification is used to send a non-RosettaNet type message. The type name and version must be specified when this occurs.

This property is a field of the preamble.

StandardVersion Property (RNIF Adapter)

The version of the standard used to create this message.

Data Type

String

Default Value

Remarks

StandardVersion describes the version of the standard used to create this message. In this case, the standard being used is RosettaNet. Therefore, the version will be which version of RosettaNet the sender is using.

This property is a field of the preamble.

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

ToRole Property (RNIF Adapter)

The role of the entity receiving this message.

Data Type

String

Default Value

Remarks

This describes what role the process receiving this message plays in the business model. This may be a one-word description, e.g. "Seller".

This property is a field of the service header.

ToService Property (RNIF Adapter)

The service for which this message is bound.

Data Type

String

Default Value

Remarks

This property describes the type of service that is being provided by the receiver of this message. This can be a short description of the service being provided, e.g. "Seller Service".

This property is a field of the service header.

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

This property is not available in the Receiver.

TransportLog Property (RNIF Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

URI Property (RNIF Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

URL Property (RNIF Adapter)

The URL to which requests are sent.

Data Type

String

Default Value

Remarks

This property describes the URL location where the partner will receive the message being sent. This must be set before the message may be sent. It tells HTTP where to send the message. The URL of the partner process should be known by each of the processes.

This property is not available in the Receiver.

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.

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 (RNIF 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.

RNIF Config Settings

ApplyBase64Encoding: Allows you to control the base64 encoding of the message body when signing the message.

This setting allows you to control the base64 encoding of the message body when signing the message. By default, this value is true, and the body will be base64 encoded when the message is being signed.

Authorization: The Authorization string to be sent to the server.

If the Authorization setting contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This setting is provided so that the adapter can be extended with other security schemes in addition to the authorization schemes already implemented by the adapter.

The AuthScheme; setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization setting in the form "Basic [encoded-user-password]".

AuthScheme: The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the component which type of authorization to perform when the User and Password properties are set. Possible values are:


0 (default)	Basic
1	Digest
2	Proprietary
3	None
4	NTLM
5	Negotiate
6	OAuth

By default, AuthScheme is Basic (0), and if the User and Password configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead.

For security reasons, setting this value will clear the values of User and Password.

ExpectedVersion: The RNIF document version that the RNIFReceiver is expecting to receive.

This configuration option allow you to explicitly define the RNIF version of the document that you are expecting to receive. If this value is set, the component will not attempt to parse the RNIF version from the received headers and will attempt to process the received document as an RNIF document of the version specified in this configuration option. This setting is only applicable to the receive adapter


Option	Effect
0 (default)	No expected version. Parses the RNIF version from received headers and process document based on this.
1	Expect RNIF v1.1 document.
2	Expect RNIF v2.0 document.

FromPartnerClassificationCode: Code identifying the sending partner's function in the supply chain.

This setting specified the code identifying the sending partner's function in the supply chain.

GlobalProcessCode: Business process identifier.

This setting specifies the business process identifier e.g. 'Manage Product Subscriptions'. This code is the name of a PIP specification document.

Password: A password if authentication is to be used.

If AuthScheme is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.

SendReceipt: Whether to send a receipt automatically.

This setting specifies whether a receipt is sent in response to a received message. This is only applicable to the receive adapter. The default value is True.

ToPartnerClassificationCode: Code identifying the receiving partner's function in the supply chain.

This setting specifies the code identifying the receiving partner's function in the supply chain.

TransactionCode: The service transaction code.

This setting specifies the service transaction code. The code is the name of the business activity and the transaction dialog in the PIP specification document.

TransactionId: A unique transaction Id.

This property specifies a unique alpha-numeric identifier that represents a specific instance of a business process, business transaction, business action or business signal. The instance identifier must be unique for a particular instance of a business process, business transaction, business action and business signal.

User: A user name if authentication is to be used.

If AuthScheme is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, User and Password are immediately cleared.

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the adapter will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the adapter is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the adapter will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the adapter will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the adapter will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

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.