IPWorks EDI 2020 macOS Edition

Questions / Feedback?

RNIFSender Module

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:

  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 class to generate, sign, and encrypt the RosettaNet business document and upload it to the server.

NOTE: when the Post method is called, the class 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 class 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 module with short descriptions. Click on the links for further details.

ActionCodeThe code for this action.
ActionMessageWhether or not this message is an action message.
ActionMessageStandardNameThe name of the standard used to create this action.
ActionMessageStandardVersionThe version of the standard used to create this action.
AttachmentsA collection of files attached to the current RNIF message.
BusinessActivityThis property denotes the type of business activity.
CertEffectiveDateThe date which this certificate becomes valid.
CertEncodedThe certificate (PEM/base64 encoded).
CertExpirationDateThe date the certificate expires.
CertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
CertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
CertIssuerThe issuer of the certificate.
CertKeyPasswordThe password for the certificate's private key (if any).
CertPrivateKeyThe private key of the certificate (if available).
CertPrivateKeyAvailableShows whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
CertPublicKeyThe public key of the certificate.
CertPublicKeyAlgorithmTextual description of the public key algorithm of the certificate.
CertPublicKeyLengthThe length of the certificate public key (in bits).
CertSerialNumberThe serial number of the certificate encoded as a string.
CertSignatureAlgorithmText description of the signature algorithm of the certificate.
CertStoreThe name of the certificate store for the client certificate.
CertStorePasswordIf 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.
CertStoreTypeThe type of certificate store for this certificate.
CertSubjectThe subject of the certificate used for client authentication.
CertSubjectAltNamesA comma-separated lists of alternative subject names of the certificate.
CertThumbprintMD5MD5 hash of the certificate.
CertThumbprintSHA1SHA1 hash of the certificate.
CertThumbprintSHA256SHA256 hash of the certificate.
CertUsageText description of UsageFlags .
CertUsageFlagsFlags that show intended use for the certificate.
CertVersionThe certificate's version number.
CookiesCollection of cookies.
DeliveryHeaderXMLThe complete XML data from the Delivery Header.
EncryptionAlgorithmThe algorithm used to encrypt the EDI data.
EncryptionTypeThe encryption type for RNIF 2.0.
FirewallA set of properties related to firewall access.
FromRoleThe business role of the entity that originated this message.
FromServiceThe service that originated this message.
GlobalUsageCodeA universal code describing basic usage for this message.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageDateTimeThe time at which this message was sent.
MessageReceiverIdIdentity of the entity receiving this message.
MessageReceiverLocationLocation of the entity receiving this message.
MessageSenderIdIdentity of the entity that sent this message.
MessageSenderLocationLocation of the entity that sent this message.
MessageTrackingIdUnique value that identifies this message.
OriginalActionCodeThe action code of the original message.
OriginalMessageStandardNameThe name of the standard used to create the original message.
OriginalMessageStandardVersionThe version of the standard used to create the original message.
OriginalMessageTrackingIdTracking identifier for the original message.
PartnerIdIdentity of the partner.
PartnerKnownWhether or not the partner is known.
PartnerLocationLocation of the partner.
PartnerPIPBindingIdThe partner-defined PIP payload binding ID.
PartnerURLA URL to which replies must be sent if the partner is unknown.
PIPCodeRosettaNet PIP code of this message.
PIPInstanceIdThe Id of this PIP instance.
PIPVersionRosettaNet PIP version of this message.
PreambleHeaderXMLThe complete XML data from the Preamble Header.
ProxyA set of properties related to proxy access.
QOSSpecificationsSpecifies quality of service constraints for this message.
ReceiptSignerCertEffectiveDateThe date which this certificate becomes valid.
ReceiptSignerCertEncodedThe certificate (PEM/base64 encoded).
ReceiptSignerCertExpirationDateThe date the certificate expires.
ReceiptSignerCertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
ReceiptSignerCertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
ReceiptSignerCertIssuerThe issuer of the certificate.
ReceiptSignerCertKeyPasswordThe password for the certificate's private key (if any).
ReceiptSignerCertPrivateKeyThe private key of the certificate (if available).
ReceiptSignerCertPrivateKeyAvailableShows whether a PrivateKey is available for the selected certificate.
ReceiptSignerCertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
ReceiptSignerCertPublicKeyThe public key of the certificate.
ReceiptSignerCertPublicKeyAlgorithmTextual description of the public key algorithm of the certificate.
ReceiptSignerCertPublicKeyLengthThe length of the certificate public key (in bits).
ReceiptSignerCertSerialNumberThe serial number of the certificate encoded as a string.
ReceiptSignerCertSignatureAlgorithmText description of the signature algorithm of the certificate.
ReceiptSignerCertStoreThe name of the certificate store for the client certificate.
ReceiptSignerCertStorePasswordIf 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.
ReceiptSignerCertStoreTypeThe type of certificate store for this certificate.
ReceiptSignerCertSubjectThe subject of the certificate used for client authentication.
ReceiptSignerCertSubjectAltNamesA comma-separated lists of alternative subject names of the certificate.
ReceiptSignerCertThumbprintMD5MD5 hash of the certificate.
ReceiptSignerCertThumbprintSHA1SHA1 hash of the certificate.
ReceiptSignerCertThumbprintSHA256SHA256 hash of the certificate.
ReceiptSignerCertUsageText description of UsageFlags .
ReceiptSignerCertUsageFlagsFlags that show intended use for the certificate.
ReceiptSignerCertVersionThe certificate's version number.
RecipientCertEffectiveDateThe date which this certificate becomes valid.
RecipientCertEncodedThe certificate (PEM/base64 encoded).
RecipientCertExpirationDateThe date the certificate expires.
RecipientCertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
RecipientCertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
RecipientCertIssuerThe issuer of the certificate.
RecipientCertKeyPasswordThe password for the certificate's private key (if any).
RecipientCertPrivateKeyThe private key of the certificate (if available).
RecipientCertPrivateKeyAvailableShows whether a PrivateKey is available for the selected certificate.
RecipientCertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
RecipientCertPublicKeyThe public key of the certificate.
RecipientCertPublicKeyAlgorithmTextual description of the public key algorithm of the certificate.
RecipientCertPublicKeyLengthThe length of the certificate public key (in bits).
RecipientCertSerialNumberThe serial number of the certificate encoded as a string.
RecipientCertSignatureAlgorithmText description of the signature algorithm of the certificate.
RecipientCertStoreThe name of the certificate store for the client certificate.
RecipientCertStorePasswordIf 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.
RecipientCertStoreTypeThe type of certificate store for this certificate.
RecipientCertSubjectThe subject of the certificate used for client authentication.
RecipientCertSubjectAltNamesA comma-separated lists of alternative subject names of the certificate.
RecipientCertThumbprintMD5MD5 hash of the certificate.
RecipientCertThumbprintSHA1SHA1 hash of the certificate.
RecipientCertThumbprintSHA256SHA256 hash of the certificate.
RecipientCertUsageText description of UsageFlags .
RecipientCertUsageFlagsFlags that show intended use for the certificate.
RecipientCertVersionThe certificate's version number.
ReplyDataThis property is used to retrieve synchronous reply message content.
ReplyHeadersThis property is used to retrieve headers from synchronous reply messages.
ReplyMessageWhether or not this message is a reply to another message.
ResponseTypeRequested response type. Available only in RNIF 2.0.
RNIFVersionThe RNIF Standard Version used to generate this message.
SecureTransportRequiredIndicates that security is required when forwarding this message.
ServiceContentThe PIP message data.
ServiceHeaderXMLThe complete XML data from the Service Header.
SignalCodeThe code for this signal.
SignalMessageWhether or not this message is a signal.
SignalVersionThe version of this signal.
SignatureAlgorithmSignature algorithm to be used in outgoing messages.
SignerCertEffectiveDateThe date which this certificate becomes valid.
SignerCertEncodedThe certificate (PEM/base64 encoded).
SignerCertExpirationDateThe date the certificate expires.
SignerCertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
SignerCertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
SignerCertIssuerThe issuer of the certificate.
SignerCertKeyPasswordThe password for the certificate's private key (if any).
SignerCertPrivateKeyThe private key of the certificate (if available).
SignerCertPrivateKeyAvailableShows whether a PrivateKey is available for the selected certificate.
SignerCertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
SignerCertPublicKeyThe public key of the certificate.
SignerCertPublicKeyAlgorithmTextual description of the public key algorithm of the certificate.
SignerCertPublicKeyLengthThe length of the certificate public key (in bits).
SignerCertSerialNumberThe serial number of the certificate encoded as a string.
SignerCertSignatureAlgorithmText description of the signature algorithm of the certificate.
SignerCertStoreThe name of the certificate store for the client certificate.
SignerCertStorePasswordIf 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.
SignerCertStoreTypeThe type of certificate store for this certificate.
SignerCertSubjectThe subject of the certificate used for client authentication.
SignerCertSubjectAltNamesA comma-separated lists of alternative subject names of the certificate.
SignerCertThumbprintMD5MD5 hash of the certificate.
SignerCertThumbprintSHA1SHA1 hash of the certificate.
SignerCertThumbprintSHA256SHA256 hash of the certificate.
SignerCertUsageText description of UsageFlags .
SignerCertUsageFlagsFlags that show intended use for the certificate.
SignerCertVersionThe certificate's version number.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StandardNameThe name of the standard used to create this message.
StandardVersionThe version of the standard used to create this message.
TimeoutA timeout for the component.
ToRoleThe role of the entity receiving this message.
ToServiceThe service for which this message is bound.
URLThe URL to which requests are sent.

Method List


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

ConfigSets or retrieves a configuration setting.
PostPosts Message to the RNIF partner.
ResetThis property is used to reset all attributes of the Rnifsender instance.
ResetHeadersResets all HTTP headers, cookies, LocalFile , and AttachedFile .
SetRequestHeaderAllows the user to set or add arbitrary HTTP request headers.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).

Configuration Settings


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

ApplyBase64EncodingAllows you to control the base64 encoding of the message body when signing the message.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
FromPartnerClassificationCodeCode identifying the sending partner's function in the supply chain.
GlobalProcessCodeBusiness process identifier.
HTTPStatusLineReturns the status line of the last response.
PasswordA password if authentication is to be used.
RequestBodyThe full body of the outgoing request.
RequestHeadersThe MIME headers of the outgoing request.
ToPartnerClassificationCodeCode identifying the receiving partner's function in the supply chain.
TransactionCodeThe service transaction code.
TransactionIdA unique transaction Id.
UserA user name if authentication is to be used.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 macOS Edition - Version 20.0 [Build 8203]