RNIF Adapter
Properties Configuration Settings
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:
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.
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:
If the message is signed and/or encrypted, or if a signed receipt will be sent back in response the following properties are applicable:
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. |
Configuration Settings
The following is a list of configuration 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 | Tells the component whether or not to use the system security libraries or an internal implementation. |