RNIFSender Component

Properties   Methods   Events   Config 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 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.

Method List

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

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.

Config Settings

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

ActionCode Property (RNIFSender Component)

The code for this action.

Syntax

• C#
• VB.NET

public string ActionCode { get; set; }

Public Property ActionCode As 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."

This property is a field of the service header.

ActionMessage Property (RNIFSender Component)

Whether or not this message is an action message.

Syntax

• C#
• VB.NET

public bool ActionMessage { get; set; }

Public Property ActionMessage As Boolean

Default Value

False

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.

ActionMessageStandardName Property (RNIFSender Component)

The name of the standard used to create this action.

Syntax

• C#
• VB.NET

public string ActionMessageStandardName { get; set; }

Public Property ActionMessageStandardName As 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 (RNIFSender Component)

The version of the standard used to create this action.

Syntax

• C#
• VB.NET

public string ActionMessageStandardVersion { get; set; }

Public Property ActionMessageStandardVersion As 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.

Attachments Property (RNIFSender Component)

A collection of files attached to the current RNIF message.

Syntax

• C#
• VB.NET

public RNIFAttachmentList Attachments { get; }

Public Property Attachments As RNIFAttachmentList

Remarks

Some RosettaNet PIPs, and potentially any non-RosettaNet standards, allow for extra files or data to be attached to the RosettaNet business document. Since the RosettaNet document is MIME-encoded, there are no specific limitations on the number of attachments. The message attachments are included in the payload container with the ServiceContent, so if EncryptionType is set to any non-zero value (i.e., etEncryptPayloadContainer or etEncryptServiceContent) the attachments will be encrypted as well.

The message attachments are described by the RNIFAttachment objects stored within the Attachments property.

This property is a field of the service header.

This property is not available at design time.

BusinessActivity Property (RNIFSender Component)

This property denotes the type of business activity.

Syntax

• C#
• VB.NET

public string BusinessActivity { get; set; }

Public Property BusinessActivity As String

Default Value

""

Remarks

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

Certificate Property (RNIFSender Component)

The encryption certificate of the sender.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As Certificate

Remarks

If this property is specified and the message receipt is encrypted, the receipt content will be decrypted using the Certificate's private key.

If set, this property should be a private key instance of Certificate.

Cookies Property (RNIFSender Component)

A collection of cookies.

Syntax

• C#
• VB.NET

public HTTPCookieList Cookies { get; }

Public Property Cookies As HTTPCookieList

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to count -1.

This property is not available at design time.

DeliveryHeaderXML Property (RNIFSender Component)

The complete XML data from the Delivery Header

Syntax

• C#
• VB.NET

public string DeliveryHeaderXML { get; set; }

Public Property DeliveryHeaderXML As 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 component. 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 component 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 (RNIFSender Component)

The algorithm used to encrypt the EDI data.

Syntax

• C#
• VB.NET

public string EncryptionAlgorithm { get; set; }

Public Property EncryptionAlgorithm As 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 component supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The component 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 (RNIFSender Component)

The encryption type for RNIF 2.0.

Syntax

• C#
• VB.NET

public RNIFSenderEncryptionTypes EncryptionType { get; set; }

enum RNIFSenderEncryptionTypes {
  etNoEncryption,
  etEncryptServiceContent,
  etEncryptPayloadContainer
}

Public Property EncryptionType As RnifsenderEncryptionTypes

Enum RNIFSenderEncryptionTypes
  etNoEncryption
  etEncryptServiceContent
  etEncryptPayloadContainer
End Enum

Default Value

0

Remarks

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

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.

This property is not available at design time.

Firewall Property (RNIFSender Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FromRole Property (RNIFSender Component)

The business role of the entity that originated this message.

Syntax

• C#
• VB.NET

public string FromRole { get; set; }

Public Property FromRole As 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 (RNIFSender Component)

The service that originated this message.

Syntax

• C#
• VB.NET

public string FromService { get; set; }

Public Property FromService As 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 (RNIFSender Component)

A universal code describing basic usage for this message.

Syntax

• C#
• VB.NET

public RNIFSenderGlobalUsageCodes GlobalUsageCode { get; set; }

enum RNIFSenderGlobalUsageCodes {
  gucTest,
  gucProduction
}

Public Property GlobalUsageCode As RnifsenderGlobalUsageCodes

Enum RNIFSenderGlobalUsageCodes
  gucTest
  gucProduction
End Enum

Default Value

0

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.

LocalHost Property (RNIFSender Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property 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 IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property 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).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

MessageDateTime Property (RNIFSender Component)

The time at which this message was sent.

Syntax

• C#
• VB.NET

public string MessageDateTime { get; set; }

Public Property MessageDateTime As 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:

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.

MessageReceiverId Property (RNIFSender Component)

Identity of the entity receiving this message.

Syntax

• C#
• VB.NET

public string MessageReceiverId { get; set; }

Public Property MessageReceiverId As 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 (RNIFSender Component)

Location of the entity receiving this message.

Syntax

• C#
• VB.NET

public string MessageReceiverLocation { get; set; }

Public Property MessageReceiverLocation As 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 (RNIFSender Component)

Identity of the entity that sent this message.

Syntax

• C#
• VB.NET

public string MessageSenderId { get; set; }

Public Property MessageSenderId As 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 (RNIFSender Component)

Location of the entity that sent this message.

Syntax

• C#
• VB.NET

public string MessageSenderLocation { get; set; }

Public Property MessageSenderLocation As 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 (RNIFSender Component)

Unique value that identifies this message.

Syntax

• C#
• VB.NET

public string MessageTrackingId { get; set; }

Public Property MessageTrackingId As 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 (RNIFSender Component)

The action code of the original message.

Syntax

• C#
• VB.NET

public string OriginalActionCode { get; set; }

Public Property OriginalActionCode As 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.

OriginalMessageStandardName Property (RNIFSender Component)

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

Syntax

• C#
• VB.NET

public string OriginalMessageStandardName { get; set; }

Public Property OriginalMessageStandardName As 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.

OriginalMessageStandardVersion Property (RNIFSender Component)

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

Syntax

• C#
• VB.NET

public string OriginalMessageStandardVersion { get; set; }

Public Property OriginalMessageStandardVersion As 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.

OriginalMessageTrackingId Property (RNIFSender Component)

Tracking identifier for the original message.

Syntax

• C#
• VB.NET

public string OriginalMessageTrackingId { get; set; }

Public Property OriginalMessageTrackingId As 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.

PartnerId Property (RNIFSender Component)

Identity of the partner.

Syntax

• C#
• VB.NET

public string PartnerId { get; set; }

Public Property PartnerId As 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 (RNIFSender Component)

Whether or not the partner is known.

Syntax

• C#
• VB.NET

public bool PartnerKnown { get; set; }

Public Property PartnerKnown As Boolean

Default Value

False

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.

PartnerLocation Property (RNIFSender Component)

Location of the partner.

Syntax

• C#
• VB.NET

public string PartnerLocation { get; set; }

Public Property PartnerLocation As 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.

PartnerPIPBindingId Property (RNIFSender Component)

The partner-defined PIP payload binding ID.

Syntax

• C#
• VB.NET

public string PartnerPIPBindingId { get; set; }

Public Property PartnerPIPBindingId As 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 (RNIFSender Component)

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

Syntax

• C#
• VB.NET

public string PartnerURL { get; set; }

Public Property PartnerURL As 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.

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 (RNIFSender Component)

RosettaNet PIP code of this message.

Syntax

• C#
• VB.NET

public string PIPCode { get; set; }

Public Property PIPCode As 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 (RNIFSender Component)

The Id of this PIP instance.

Syntax

• C#
• VB.NET

public string PIPInstanceId { get; set; }

Public Property PIPInstanceId As 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.

PIPVersion Property (RNIFSender Component)

RosettaNet PIP version of this message.

Syntax

• C#
• VB.NET

public string PIPVersion { get; set; }

Public Property PIPVersion As 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.

PreambleHeaderXML Property (RNIFSender Component)

The complete XML data from the Preamble Header.

Syntax

• C#
• VB.NET

public string PreambleHeaderXML { get; set; }

Public Property PreambleHeaderXML As 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.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the component. 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 component 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:

• StandardName
• StandardVersion

Proxy Property (RNIFSender Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QOSSpecifications Property (RNIFSender Component)

Specifies quality of service constraints for this message.

Syntax

• C#
• VB.NET

public QOSSpecificationList QOSSpecifications { get; }

Public Property QOSSpecifications As QOSSpecificationList

Remarks

Version 2.0 of the RosettaNet Implementation Framework introduced a set of Quality of Service (QOS) elements to ensure future backward compatibility.

The component supports these future QOS options through the QOSSpecifications collection.

This property is a field of the service header.

NOTE: there are no valid values for the quality of service parameters at this time, therefore this property may be ignored by the RNIF entity.

This property is not available at design time.

ReceiptSignerCert Property (RNIFSender Component)

The public key certificate for the receipt signature.

Syntax

• C#
• VB.NET

public Certificate ReceiptSignerCert { get; set; }

Public Property ReceiptSignerCert As Certificate

Remarks

Ordinarily, if your trading partner uses the same certificate for both signing and encryption, the certificate specified in RecipientCert is used for both encryption and verifying the receipt signature.

If your trading partner uses different certificates for signing and encryption, you must set this property to the public key for you partner's signing certificate before invoking Post.

If set, this property should be a public key instance of Certificate.

RecipientCert Property (RNIFSender Component)

The encryption certificate of the recipient.

Syntax

• C#
• VB.NET

public Certificate RecipientCert { get; set; }

Public Property RecipientCert As Certificate

Remarks

The encryption certificate of the recipient. If this property is specified, the message content will be encrypted using the algorithm given by EncryptionAlgorithm.

This property will also be used to verifying signed receipts if ReceiptSignerCert is not specified. If your trading partner uses different certificates for signing and encryption, you should set RecipientCert to the encryption certificate and ReceiptSignerCert to the signing certificate.

If the component is unable to verify a signature make sure RecipientCert is set appropriately.

If set, this property should be a public key instance of Certificate.

ReplyData Property (RNIFSender Component)

This property is used to retrieve synchronous reply message content.

Syntax

• C#
• VB.NET

public string ReplyData { get; }
public byte[] ReplyDataB { get; }

Public ReadOnly Property ReplyData As String
Public ReadOnly Property ReplyDataB As Byte()

Default Value

""

Remarks

This property is only used when the sender is requiring a synchronous reply or signal of acknowledgement to be sent following its action message. This gets the message body content from the receiver 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 read-only.

ReplyHeaders Property (RNIFSender Component)

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

Syntax

• C#
• VB.NET

public string ReplyHeaders { get; }

Public ReadOnly Property ReplyHeaders As 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 read-only.

ReplyMessage Property (RNIFSender Component)

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

Syntax

• C#
• VB.NET

public bool ReplyMessage { get; set; }

Public Property ReplyMessage As 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.

ResponseType Property (RNIFSender Component)

Requested response type. Available only in RNIF 2.0.

Syntax

• C#
• VB.NET

public RNIFSenderResponseTypes ResponseType { get; set; }

enum RNIFSenderResponseTypes {
  rtSync,
  rtAsync
}

Public Property ResponseType As RnifsenderResponseTypes

Enum RNIFSenderResponseTypes
  rtSync
  rtAsync
End Enum

Default Value

0

Remarks

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

The following types of supported responses are:

This property is only available in RNIF version 2.0.

This property is not available at design time.

RNIFVersion Property (RNIFSender Component)

The RNIF Standard Version used to generate this message.

Syntax

• C#
• VB.NET

public RNIFSenderRNIFVersions RNIFVersion { get; set; }

enum RNIFSenderRNIFVersions {
  v1,
  v2
}

Public Property RNIFVersion As RnifsenderRNIFVersions

Enum RNIFSenderRNIFVersions
  v1
  v2
End Enum

Default Value

0

Remarks

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

This property is not available at design time.

SecureTransportRequired Property (RNIFSender Component)

Indicates that security is required when forwarding this message.

Syntax

• C#
• VB.NET

public bool SecureTransportRequired { get; set; }

Public Property SecureTransportRequired As 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.

ServiceContent Property (RNIFSender Component)

The PIP message data.

Syntax

• C#
• VB.NET

public string ServiceContent { get; set; }

Public Property ServiceContent As String

Default Value

""

Remarks

The ServiceContent property contains the PIP message data. This is the body of the message which contains the request, action, or reply being sent from one business process to another.

There are specific formats to which this data must adhere. These formats are specified by the RosettaNet community in the form of Partner Interface Processes (PIPs). Each PIP instance also has an ID associated with it which is stored in the PIPInstanceId property.

ServiceHeaderXML Property (RNIFSender Component)

The complete XML data from the Service Header.

Syntax

• C#
• VB.NET

public string ServiceHeaderXML { get; set; }

Public Property ServiceHeaderXML As 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.

This property is an aggregate property containing XML either generated from or parsed into various other properties of the component. 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 component 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:

• 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

SignalCode Property (RNIFSender Component)

The code for this signal.

Syntax

• C#
• VB.NET

public string SignalCode { get; set; }

Public Property SignalCode As String

Default Value

""

Remarks

This is the code for the signal message received. This property is only set if the message is a signal. The code denotes what type of signal is being received, or sent.

SignalMessage Property (RNIFSender Component)

Whether or not this message is a signal.

Syntax

• C#
• VB.NET

public bool SignalMessage { get; set; }

Public Property SignalMessage As Boolean

Default Value

False

Remarks

SignalMessage is a boolean value indicating whether or not the message is a signal. Signals do not contain content that is of business nature. Instead, they are simply acknowledgments to business actions.

RNIF 2.0 specifies two types of signals: a positive, and a negative. A positive signal has all of the properties of a valid RosettaNet action message, however it is simply an acknowledgement of receipt of a valid Business Action message. A negative signal is an acknowledgement sent to notify the originating entity of an error. In RNIF 2.0, there is only one type of exception message, as opposed to the three types in RNIF 1.1.

NOTE: only Business Actions may be acknowledged, Signals cannot.

This property is a field of the service header.

SignalVersion Property (RNIFSender Component)

The version of this signal.

Syntax

• C#
• VB.NET

public string SignalVersion { get; set; }

Public Property SignalVersion As String

Default Value

""

Remarks

This is the version for the signal message received. This property is only set if the message is a signal. The version denotes what version of signal is being received, or sent.

SignatureAlgorithm Property (RNIFSender Component)

Signature algorithm to be used in outgoing messages.

Syntax

• C#
• VB.NET

public string SignatureAlgorithm { get; set; }

Public Property SignatureAlgorithm As String

Default Value

"sha-256"

Remarks

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

• sha1
• md5
• sha256 (default)
• sha384
• sha512
• sha224

The default value is "sha256".

SignerCert Property (RNIFSender Component)

Contains the certificate to use when signing messages.

Syntax

• C#
• VB.NET

public Certificate SignerCert { get; set; }

Public Property SignerCert As Certificate

Remarks

This is your signing certificate. If this property is specified, the message content will be signed using the algorithm given by SignatureAlgorithm.

If set, this property should be a private key instance of Certificate.

This property is not available at design time.

SSLAcceptServerCert Property (RNIFSender Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (RNIFSender Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (RNIFSender Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public RNIFSenderSSLProviders SSLProvider { get; set; }

enum RNIFSenderSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As RnifsenderSSLProviders

Enum RNIFSenderSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (RNIFSender Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StandardName Property (RNIFSender Component)

The name of the standard used to create this message.

Syntax

• C#
• VB.NET

public string StandardName { get; set; }

Public Property StandardName As String

Default Value

""

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 (RNIFSender Component)

The version of the standard used to create this message.

Syntax

• C#
• VB.NET

public string StandardVersion { get; set; }

Public Property StandardVersion As 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 (RNIFSender Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

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 component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

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 component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

ToRole Property (RNIFSender Component)

The role of the entity receiving this message.

Syntax

• C#
• VB.NET

public string ToRole { get; set; }

Public Property ToRole As 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 (RNIFSender Component)

The service for which this message is bound.

Syntax

• C#
• VB.NET

public string ToService { get; set; }

Public Property ToService As 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.

URL Property (RNIFSender Component)

The URL to which requests are sent.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As 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.

Config Method (RNIFSender Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Post Method (RNIFSender Component)

Posts Message to the RNIF partner.

Syntax

• C#
• VB.NET

public void Post();

Async Version
public async Task Post();
public async Task Post(CancellationToken cancellationToken);

Public Sub Post()

Async Version
Public Sub Post() As Task
Public Sub Post(cancellationToken As CancellationToken) As Task

Remarks

This method posts the message to the RNIF partner server. When Post is called, the component will generate, encrypt, and sign the RosettaNet message in accordance with the various message settings.

NOTE: URL must be set before a call to Post.

Reset Method (RNIFSender Component)

This property is used to reset all attributes of the Rnifsender instance.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

Reset is used to reset all attributes of the Rnifreceiver instance including the headers, attachments, etc. to their default values. This may be useful when multiple messages need to be created.

ResetHeaders Method (RNIFSender Component)

Resets all HTTP headers, cookies, LocalFile , and AttachedFile .

Syntax

• C#
• VB.NET

public void ResetHeaders();

Async Version
public async Task ResetHeaders();
public async Task ResetHeaders(CancellationToken cancellationToken);

Public Sub ResetHeaders()

Async Version
Public Sub ResetHeaders() As Task
Public Sub ResetHeaders(cancellationToken As CancellationToken) As Task

Remarks

Resets all the HTTP headers to "" (empty string). Also clears the Cookies collection. Use this method before creating a new request, so that headers from the previous message are not carried over to the next one.

SetRequestHeader Method (RNIFSender Component)

Allows the user to set or add arbitrary HTTP request headers.

Syntax

• C#
• VB.NET

public void SetRequestHeader(string header, string value);

Async Version
public async Task SetRequestHeader(string header, string value);
public async Task SetRequestHeader(string header, string value, CancellationToken cancellationToken);

Public Sub SetRequestHeader(ByVal Header As String, ByVal Value As String)

Async Version
Public Sub SetRequestHeader(ByVal Header As String, ByVal Value As String) As Task
Public Sub SetRequestHeader(ByVal Header As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used when preparing the message. It allows the user to set or add HTTP request headers as needed. You must pass this method a name of the header and a value. This method thens looks to see if the header you are trying to set is already in the HTTP request message. If it is, then this method simply changes the value of the header. If it is not found, this method adds the new header.

Connected Event (RNIFSender Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, RNIFSenderConnectedEventArgs e);

public class RNIFSenderConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As RNIFSenderConnectedEventArgs)

Public Class RNIFSenderConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (RNIFSender Component)

Fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, RNIFSenderDisconnectedEventArgs e);

public class RNIFSenderDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As RNIFSenderDisconnectedEventArgs)

Public Class RNIFSenderDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (RNIFSender Component)

Fired when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, RNIFSenderEndTransferEventArgs e);

public class RNIFSenderEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As RNIFSenderEndTransferEventArgs)

Public Class RNIFSenderEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (RNIFSender Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, RNIFSenderErrorEventArgs e);

public class RNIFSenderErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As RNIFSenderErrorEventArgs)

Public Class RNIFSenderErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (RNIFSender Component)

Fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, RNIFSenderHeaderEventArgs e);

public class RNIFSenderHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As RNIFSenderHeaderEventArgs)

Public Class RNIFSenderHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Redirect Event (RNIFSender Component)

Fired when a redirection is received from the server.

Syntax

• C#
• VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, RNIFSenderRedirectEventArgs e);

public class RNIFSenderRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As RNIFSenderRedirectEventArgs)

Public Class RNIFSenderRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (RNIFSender Component)

Fired for every cookie set by the server.

Syntax

• C#
• VB.NET

public event OnSetCookieHandler OnSetCookie;

public delegate void OnSetCookieHandler(object sender, RNIFSenderSetCookieEventArgs e);

public class RNIFSenderSetCookieEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public string Expires { get; }
  public string Domain { get; }
  public string Path { get; }
  public bool Secure { get; }
}

Public Event OnSetCookie As OnSetCookieHandler

Public Delegate Sub OnSetCookieHandler(sender As Object, e As RNIFSenderSetCookieEventArgs)

Public Class RNIFSenderSetCookieEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property Expires As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Secure As Boolean
End Class

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (RNIFSender Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, RNIFSenderSSLServerAuthenticationEventArgs e);

public class RNIFSenderSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As RNIFSenderSSLServerAuthenticationEventArgs)

Public Class RNIFSenderSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (RNIFSender Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, RNIFSenderSSLStatusEventArgs e);

public class RNIFSenderSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As RNIFSenderSSLStatusEventArgs)

Public Class RNIFSenderSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (RNIFSender Component)

Fired when a document starts transferring (after the headers).

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, RNIFSenderStartTransferEventArgs e);

public class RNIFSenderStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As RNIFSenderStartTransferEventArgs)

Public Class RNIFSenderStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (RNIFSender Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, RNIFSenderTransferEventArgs e);

public class RNIFSenderTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As RNIFSenderTransferEventArgs)

Public Class RNIFSenderTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is 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

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

• C#
• VB.NET

public HTTPCookie();

Public HTTPCookie()

• C#
• VB.NET

public HTTPCookie(string name, string value);

Public HTTPCookie(ByVal Name As String, ByVal Value As String)

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

QOSSpecification Type

A name-value pair defining a quality of service.

Remarks

Version 2.0 of the RosettaNet Implementation Framework introduced a set of Quality of Service (QOS) elements to ensure future backward compatibility.

Fields

Constructors

• C#
• VB.NET

public QOSSpecification();

Public QOSSpecification()

• C#
• VB.NET

public QOSSpecification(string code, string value);

Public QOSSpecification(ByVal Code As String, ByVal Value As String)

RNIFAttachment Type

This describes the file being attached.

Remarks

Information about the file's location that is being attached to the message is contained here.

Fields

Constructors

• C#
• VB.NET

public RNIFAttachment();

Public RNIFAttachment()

• C#
• VB.NET

public RNIFAttachment(string fileName);

Public RNIFAttachment(ByVal FileName As String)

• C#
• VB.NET

public RNIFAttachment(string fileName, string id);

Public RNIFAttachment(ByVal FileName As String, ByVal Id As String)

• C#
• VB.NET

public RNIFAttachment(string fileName, string id, string description);

Public RNIFAttachment(ByVal FileName As String, ByVal Id As String, ByVal Description As String)

• C#
• VB.NET

public RNIFAttachment(string fileName, string id, string description, string MIMEType);

Public RNIFAttachment(ByVal FileName As String, ByVal Id As String, ByVal Description As String, ByVal MIMEType As String)

Config Settings (RNIFSender Component)

RNIFSender Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (RNIFSender Component)

SMIME Errors

XML Errors

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors