RNIFSender Component
Properties Methods Events Configuration Settings Errors
The RNIFSender component implements a RosettaNet Implementation Framework (RNIF) client.
Syntax
nsoftware.IPWorksEDI.Rnifsender
Remarks
The RNIFSender component may be used to send RosettaNet Implementation Framework (RNIF) messages over the TLS/SSL-secured HTTPS transport protocol. RosettaNet is used in a variety of industries including Semiconductor Manufacturing, Electronic Components, Telecommunications, Logistics, the Chemical Industry (through CIDX), and more.
A typical RosettaNet transaction is as follows:
- 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.
- Upon receipt of the message, the receiver will verify the transport headers, then will attempt to decrypt the message and verify the digital signature.
- 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. |
Attachments | A collection of files attached to the current RNIF message. |
BusinessActivity | This property denotes the type of business activity. |
Certificate | The encryption certificate of the sender. |
Cookies | Collection of cookies. |
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. |
Firewall | A set of properties related to firewall access. |
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. |
Proxy | A set of properties related to proxy access. |
QOSSpecifications | Specifies quality of service constraints for this message. |
ReceiptSignerCert | The public key certificate for the receipt signature. |
RecipientCert | The encryption certificate of the recipient. |
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. |
SignatureAlgorithm | Signature algorithm to be used in outgoing messages. |
SignerCert | Contains the certificate to use when signing messages. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
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 | The URL to which requests are sent. |
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.
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. |
FromPartnerClassificationCode | Code identifying the sending partner's function in the supply chain. |
GlobalProcessCode | Business process identifier. |
HTTPStatusLine | Returns the status line of the last response. |
Password | A password if authentication is to be used. |
RequestBody | The full body of the outgoing request. |
RequestHeaders | The MIME headers of the outgoing request. |
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. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
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. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
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. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
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;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
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. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
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. |
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. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |