Properties   Methods   Events   Configuration Settings  

The RNIFSender component implements a RosettaNet Implementation Framework (RNIF) client.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The RNIFSender component may be used to send RosettaNet Implementation Framework (RNIF) messages over the SSL-secured HTTPS transport protocol.

A typical RosettaNet transaction is as follows:

1. The RNIF client creates a RosettaNet message and uploads it to the receiver over HTTPS. The contents and structures of these messages are defined by the RosettaNet community in the form of standardized Partner Interface Processes (PIPs). Due to the sensitive nature of most business documents, such messages will usually be encrypted and wrapped in an S/MIME entity along with a digital signature.
2. Upon receipt of the message, the receiver will verify the transport headers, then will attempt to decrypt the message and verify the digital signature.
3. Once these steps have been completed, the receiving application can process the PIP instance, and either send an acknowledgement of receipt or a reply in the form of another RosettaNet message back to the sender, depending upon the requirements of the particular PIP.

When sending a RosettaNet message, the client, at minimum, must specify the StandardName and StandardVersion of the message being sent in the preamble header. In the delivery header, the client must specify the SecureTransportRequired, MessageDateTime, MessageReceiverId, MessageSenderId, and MessageTrackingId properties. For the service header, all properties that are relevant to the action, reply, or signal must be specified. The client, after setting all appropriate header properties, must then set the content of the RosettaNet message body by setting the ServiceContent property.

Attachments may be added to the RosettaNet message. Attachments are arbitrary files allowed by specific PIPs, and may be simple text documents or pictures of products. Attachments are added to the RosettaNet message by adding instances of rnifattachment to the Attachments collection.

To secure the RosettaNet message, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the component will apply the highest level of message security if the appropriate certificates are specified. To sign the data, set Certificate. To encrypt, set RecipientCert. To change which parts of the message, if any, are to be encrypted, set the EncryptionType property.

The final property to be set is the URL to which the client is posting the request. Once this is done, a call to the Post method causes the component to generate, sign, and encrypt the RosettaNet business document and upload it to the server.

NOTE: when the Post method is called, the component will perform a minimal set of checks on the various RosettaNet message headers to ensure that an invalid business message is not sent. If any values in the header are missing or are in conflict, the message cannot be processed by the receiving entity. To avoid a round trip, the component throws an exception with a description of which header field is in error.

The response, may be sent synchronously or asynchronously, whether it is a complete business reply or a simple receipt acknowledgement. To change whether a synchronous or asynchronous response is desired, set the ResponseType before calling Post. If a synchronous response is received after the HTTPS post, ReplyHeaders and ReplyData will be populated appropriately.

Property List

---

The following is the full list of the properties of the component 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.
AttachmentCount	The number of records in the Attachment arrays.
AttachmentData	Data contains the raw data of the current attachment.
AttachmentDescription	Description contains descriptions for this attachment.
AttachmentFileName	FileName is the name of the file containing the decoded data of the current attachment.
AttachmentId	Id is a unique content-identifier used within the RosettaNet message to internally reference the attachments.
AttachmentMIMEType	MimeType is a value indicating how the rnifattachment should be interpretted.
BusinessActivity	This property denotes the type of business activity.
CertEffectiveDate	The date which this certificate becomes valid.
CertEncoded	The certificate (PEM/base64 encoded).
CertExpirationDate	The date the certificate expires.
CertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
CertIssuer	The issuer of the certificate.
CertKeyPassword	The password for the certificate's private key (if any).
CertPrivateKey	The private key of the certificate (if available).
CertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
CertPublicKey	The public key of the certificate.
CertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
CertPublicKeyLength	The length of the certificate public key (in bits).
CertSerialNumber	The serial number of the certificate encoded as a string.
CertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
CertStore	The name of the certificate store for the client certificate.
CertStorePassword	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.
CertStoreType	The type of certificate store for this certificate.
CertSubject	The subject of the certificate used for client authentication.
CertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
CertThumbprintMD5	MD5 hash of the certificate.
CertThumbprintSHA1	SHA1 hash of the certificate.
CertUsage	Textual description of UsageFlags .
CertUsageFlags	Flags that show intended use for the certificate.
CertVersion	The certificate's version number.
CookieCount	The number of records in the Cookie arrays.
CookieDomain	The domain of a received cookie.
CookieExpiration	This property contains an expiration time for the cookie (if provided by the server).
CookieName	The name of the cookie.
CookiePath	This property contains a path name to limit the cookie to (if provided by the server).
CookieSecure	This property contains the security flag of the received cookie.
CookieValue	This property contains the value of the cookie.
DeliveryHeaderXML	The complete XML data from the Delivery Header.
EncryptingAlgorithm	The algorithm used to encrypt the EDI data.
EncryptionType	The encryption type for RNIF 2.0.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
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.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
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.
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.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
QOSSpecificationCount	The number of records in the QOSSpecification arrays.
QOSSpecificationCode	Code is a string representing a quality of service measurement category.
QOSSpecificationValue	Value is a string that defines the constraints for the category in Code.
ReceiptSignerCertEffectiveDate	The date which this certificate becomes valid.
ReceiptSignerCertEncoded	The certificate (PEM/base64 encoded).
ReceiptSignerCertExpirationDate	The date the certificate expires.
ReceiptSignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
ReceiptSignerCertIssuer	The issuer of the certificate.
ReceiptSignerCertKeyPassword	The password for the certificate's private key (if any).
ReceiptSignerCertPrivateKey	The private key of the certificate (if available).
ReceiptSignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
ReceiptSignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
ReceiptSignerCertPublicKey	The public key of the certificate.
ReceiptSignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
ReceiptSignerCertPublicKeyLength	The length of the certificate public key (in bits).
ReceiptSignerCertSerialNumber	The serial number of the certificate encoded as a string.
ReceiptSignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
ReceiptSignerCertStore	The name of the certificate store for the client certificate.
ReceiptSignerCertStorePassword	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.
ReceiptSignerCertStoreType	The type of certificate store for this certificate.
ReceiptSignerCertSubject	The subject of the certificate used for client authentication.
ReceiptSignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
ReceiptSignerCertThumbprintMD5	MD5 hash of the certificate.
ReceiptSignerCertThumbprintSHA1	SHA1 hash of the certificate.
ReceiptSignerCertUsage	Textual description of UsageFlags .
ReceiptSignerCertUsageFlags	Flags that show intended use for the certificate.
ReceiptSignerCertVersion	The certificate's version number.
RecipientCertEffectiveDate	The date which this certificate becomes valid.
RecipientCertEncoded	The certificate (PEM/base64 encoded).
RecipientCertExpirationDate	The date the certificate expires.
RecipientCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
RecipientCertIssuer	The issuer of the certificate.
RecipientCertKeyPassword	The password for the certificate's private key (if any).
RecipientCertPrivateKey	The private key of the certificate (if available).
RecipientCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
RecipientCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
RecipientCertPublicKey	The public key of the certificate.
RecipientCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
RecipientCertPublicKeyLength	The length of the certificate public key (in bits).
RecipientCertSerialNumber	The serial number of the certificate encoded as a string.
RecipientCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
RecipientCertStore	The name of the certificate store for the client certificate.
RecipientCertStorePassword	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.
RecipientCertStoreType	The type of certificate store for this certificate.
RecipientCertSubject	The subject of the certificate used for client authentication.
RecipientCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
RecipientCertThumbprintMD5	MD5 hash of the certificate.
RecipientCertThumbprintSHA1	SHA1 hash of the certificate.
RecipientCertUsage	Textual description of UsageFlags .
RecipientCertUsageFlags	Flags that show intended use for the certificate.
RecipientCertVersion	The certificate's version number.
ReplyData	This property is used to retrieve synchronous reply message content.
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.
SecureTransportRequired	Indicates that security is required when forwarding this message.
ServiceContent	The PIP message data.
ServiceHeaderXML	The complete XML data from the Service Header.
SignalCode	The code for this signal.
SignalMessage	Whether or not this message is a signal.
SignalVersion	The version of this signal.
SignerCertEffectiveDate	The date which this certificate becomes valid.
SignerCertEncoded	The certificate (PEM/base64 encoded).
SignerCertExpirationDate	The date the certificate expires.
SignerCertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
SignerCertIssuer	The issuer of the certificate.
SignerCertKeyPassword	The password for the certificate's private key (if any).
SignerCertPrivateKey	The private key of the certificate (if available).
SignerCertPrivateKeyAvailable	Shows whether a PrivateKey is available for the selected certificate.
SignerCertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
SignerCertPublicKey	The public key of the certificate.
SignerCertPublicKeyAlgorithm	Textual description of the public key algorithm of the certificate.
SignerCertPublicKeyLength	The length of the certificate public key (in bits).
SignerCertSerialNumber	The serial number of the certificate encoded as a string.
SignerCertSignatureAlgorithm	Textual description of the signature algorithm of the certificate.
SignerCertStore	The name of the certificate store for the client certificate.
SignerCertStorePassword	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.
SignerCertStoreType	The type of certificate store for this certificate.
SignerCertSubject	The subject of the certificate used for client authentication.
SignerCertSubjectAltNames	A comma-separted lists of alternative subject names of the certificate.
SignerCertThumbprintMD5	MD5 hash of the certificate.
SignerCertThumbprintSHA1	SHA1 hash of the certificate.
SignerCertUsage	Textual description of UsageFlags .
SignerCertUsageFlags	Flags that show intended use for the certificate.
SignerCertVersion	The certificate's version number.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	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.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
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.
Url	URL where partner will be receiving this message.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Config	Sets or retrieves a configuration setting.
Post	Posts Message to the RNIF partner.
Reset	This property is used to reset all attributes of the Rnifsender instance.
ResetHeaders	Resets all HTTP headers, cookies, LocalFile , and AttachedFile.
SetRequestHeader	Allows the user to set or add arbitrary HTTP request headers.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

---

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

HTTPStatusLine	Returns the status line of the last response.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.