RNIFReceiver Class

Properties   Methods   Events   Config Settings   Errors  

The RNIFReceiver class implements a RosettaNet server.

Syntax

ipworksedi.rnifreceiver()

Remarks

The RNIFReceiver implements server-side receiving of RosettaNet messages, as specified by the RosettaNet community. It can be used to decrypt and verify incoming messages and to generate synchronous receipts and replies if needed. The class is designed to be easily incorporated into an HTTP server. RosettaNet is used in a variety of industries including Semiconductor Manufacturing, Electronic Components, Telecommunications, Logistics, the Chemical Industry (through CIDX), and more.

BASIC OPERATION

When a RosettaNet request comes in, you should first call the ReadRequest method to read in the request. Once this is done, you must parse the headers and the request. You first parse the headers of the HTTP request using the ParseHeaders method. You may then set the appropriate certificates by setting the Certificate to your private key certificate and SignerCert to your trading partner's (signing) certificate.

The next step is to parse the RosettaNet message using ParseRequest. This method decrypts the message if needed. The class then parses all parts of the message. The preamble, delivery, and service headers are all parsed into the PreambleHeaderXML, DeliveryHeaderXML, and the ServiceHeaderXML, respectively. It also parses the actual body of the RosettaNet message, or the PIP, into the ServiceContent. Any attachments that may be in the message are parsed into the attachment array, and may be accessed via the Attachments property.

The class can also be used to handle synchronous responses. In order to complete this task, the receiver must first reset all header properties to values appropriate for a response. This may include changing values such as the MessageSenderId, MessageReceiverId, ActionCode, etc. The ServiceContent should then be set to a response indicating the state of the transaction. A typical response is a simple receipt acknowledgement, which has all qualities of a valid RosettaNet action, but is simply a receipt. Once these properties have been set, the message is ready to be sent using the SendResponse method.

NOTE: the RNIFReceiver Class can only handle sending synchronous responses. If an asynchronous response is desired, or required by a particular Partner Interface Process (PIP), you should use the RNIFSender class.

The following example illustrates how to use the class within a web page.

EXAMPLE

RNIFReceiver.ReadRequest(); RNIFReceiver.Certificate = new Certificate(CertStoreTypes.cstPFXFile, // Store type "\my_server_directory\encrypt.pfx", // File name "my password", // Password "CN=Encrypt"); // Subject RNIFReceiver.SignerCert = new Certificate("\my_server_directory\partnercert.cer"); RNIFReceiver.ParseHeaders(); RNIFReceiver.ParseRequest();

The server can then get the data from the preamble header, delivery header, service header, and the PIP content from their properties: PreambleHeaderXML, DeliveryHeaderXML, ServiceHeaderXML<;, and the ServiceContent, respectively. The message may then be easily processed, as all details of the transaction will be populated into their respective properties.

NOTE: Any attachments are saved by the name in the corresponding Attachments entry, and in the directory specified by the receiver. The directory is specified using the AttachmentOutputPath config property, and must be specified before you read and process the request. For example:

RNIFReceiver.Config("AttachmentOutputPath='\my_server_directory\Attachments'")

NOTE: In the above example, a receipt acknowledgement was not sent.

Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the RosettaNet response message. See the property and method list for details.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

RNIFReceiver.ActionCode Property

The code for this action.

Syntax

getActionCode(): string;
setActionCode(actionCode: string): void;

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.

RNIFReceiver.ActionMessage Property

Whether or not this message is an action message.

Syntax

isActionMessage(): boolean;
setActionMessage(actionMessage: boolean): void;

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.

RNIFReceiver.ActionMessageStandardName Property

The name of the standard used to create this action.

Syntax

getActionMessageStandardName(): string;
setActionMessageStandardName(actionMessageStandardName: string): void;

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.

RNIFReceiver.ActionMessageStandardVersion Property

The version of the standard used to create this action.

Syntax

getActionMessageStandardVersion(): string;
setActionMessageStandardVersion(actionMessageStandardVersion: string): void;

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.

RNIFReceiver.Attachments Property

A collection of files attached to the current RNIF message.

Syntax

getAttachments(): RNIFAttachmentList;
setAttachments(attachments: RNIFAttachmentList): void;

Default Value

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.

NOTE: You can change the path to which the files are saved in with the AttachmentOutputPath config property.

This property is not available at design time.

Please refer to the RNIFAttachment type for a complete list of fields.

RNIFReceiver.BusinessActivity Property

This property denotes the type of business activity.

Syntax

getBusinessActivity(): string;
setBusinessActivity(businessActivity: string): void;

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".

RNIFReceiver.Certificate Property

The encryption certificate.

Syntax

getCertificate(): Certificate;
setCertificate(certificate: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use to decrypt incoming RosettaNet messages and sign responses. If set prior to calling ParseRequest, the certificate will be used to decrypt the incoming message. If set prior to calling SendResponse, the certificate will be used to sign the response. Certificate must be set to a private key certificate.

Please refer to the Certificate type for a complete list of fields.

RNIFReceiver.DeliveryHeaderXML Property

The complete XML data from the Delivery Header.

Syntax

getDeliveryHeaderXML(): string;
setDeliveryHeaderXML(deliveryHeaderXML: string): void;

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 class. 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 class 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.

RNIFReceiver.EncryptionAlgorithm Property

The algorithm used to encrypt the EDI data.

Syntax

getEncryptionAlgorithm(): string;
setEncryptionAlgorithm(encryptionAlgorithm: string): void;

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 class supports "3DES", or industry-standard 168-bit Triple-DES encryption.

The class 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

RNIFReceiver.EncryptionType Property

The encryption type for RNIF 2.0.

Syntax

getEncryptionType(): RnifreceiverEncryptionTypes;
setEncryptionType(encryptionType: RnifreceiverEncryptionTypes): void;

enum RnifreceiverEncryptionTypes {
  etNoEncryption,
  etEncryptServiceContent,
  etEncryptPayloadContainer
}

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.

RNIFReceiver.FromRole Property

The business role of the entity that originated this message.

Syntax

getFromRole(): string;
setFromRole(fromRole: string): void;

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.

RNIFReceiver.FromService Property

The service that originated this message.

Syntax

getFromService(): string;
setFromService(fromService: string): void;

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.

RNIFReceiver.GlobalUsageCode Property

A universal code describing basic usage for this message.

Syntax

getGlobalUsageCode(): RnifreceiverGlobalUsageCodes;
setGlobalUsageCode(globalUsageCode: RnifreceiverGlobalUsageCodes): void;

enum RnifreceiverGlobalUsageCodes {
  gucTest,
  gucProduction
}

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.

RNIFReceiver.MessageDateTime Property

The time at which this message was sent.

Syntax

getMessageDateTime(): string;
setMessageDateTime(messageDateTime: string): void;

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.

RNIFReceiver.MessageReceiverId Property

Identity of the entity receiving this message.

Syntax

getMessageReceiverId(): string;
setMessageReceiverId(messageReceiverId: string): void;

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.

RNIFReceiver.MessageReceiverLocation Property

Location of the entity receiving this message.

Syntax

getMessageReceiverLocation(): string;
setMessageReceiverLocation(messageReceiverLocation: string): void;

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.

RNIFReceiver.MessageSenderId Property

Identity of the entity that sent this message.

Syntax

getMessageSenderId(): string;
setMessageSenderId(messageSenderId: string): void;

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.

RNIFReceiver.MessageSenderLocation Property

Location of the entity that sent this message.

Syntax

getMessageSenderLocation(): string;
setMessageSenderLocation(messageSenderLocation: string): void;

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.

RNIFReceiver.MessageTrackingId Property

Unique value that identifies this message.

Syntax

getMessageTrackingId(): string;
setMessageTrackingId(messageTrackingId: string): void;

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.

RNIFReceiver.OriginalActionCode Property

The action code of the original message.

Syntax

getOriginalActionCode(): string;
setOriginalActionCode(originalActionCode: string): void;

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.

RNIFReceiver.OriginalMessageStandardName Property

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

Syntax

getOriginalMessageStandardName(): string;
setOriginalMessageStandardName(originalMessageStandardName: string): void;

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.

RNIFReceiver.OriginalMessageStandardVersion Property

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

Syntax

getOriginalMessageStandardVersion(): string;
setOriginalMessageStandardVersion(originalMessageStandardVersion: string): void;

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.

RNIFReceiver.OriginalMessageTrackingId Property

Tracking identifier for the original message.

Syntax

getOriginalMessageTrackingId(): string;
setOriginalMessageTrackingId(originalMessageTrackingId: string): void;

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.

RNIFReceiver.PartnerId Property

Identity of the partner.

Syntax

getPartnerId(): string;
setPartnerId(partnerId: string): void;

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.

RNIFReceiver.PartnerKnown Property

Whether or not the partner is known.

Syntax

isPartnerKnown(): boolean;
setPartnerKnown(partnerKnown: boolean): void;

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.

RNIFReceiver.PartnerLocation Property

Location of the partner.

Syntax

getPartnerLocation(): string;
setPartnerLocation(partnerLocation: string): void;

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.

RNIFReceiver.PartnerPIPBindingId Property

The partner-defined PIP payload binding ID.

Syntax

getPartnerPIPBindingId(): string;
setPartnerPIPBindingId(partnerPIPBindingId: string): void;

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.

RNIFReceiver.PartnerURL Property

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

Syntax

getPartnerURL(): string;
setPartnerURL(partnerURL: string): void;

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.

RNIFReceiver.PIPCode Property

RosettaNet PIP code of this message.

Syntax

getPIPCode(): string;
setPIPCode(PIPCode: string): void;

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.

RNIFReceiver.PIPInstanceId Property

The Id of this PIP instance.

Syntax

getPIPInstanceId(): string;
setPIPInstanceId(PIPInstanceId: string): void;

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.

RNIFReceiver.PIPVersion Property

RosettaNet PIP version of this message.

Syntax

getPIPVersion(): string;
setPIPVersion(PIPVersion: string): void;

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.

RNIFReceiver.PreambleHeaderXML Property

The complete XML data from the Preamble Header.

Syntax

getPreambleHeaderXML(): string;
setPreambleHeaderXML(preambleHeaderXML: string): void;

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 class. 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 class 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

RNIFReceiver.QOSSpecifications Property

Specifies quality of service constraints for this message.

Syntax

getQOSSpecifications(): QOSSpecificationList;
setQOSSpecifications(QOSSpecifications: QOSSpecificationList): void;

Default Value

Remarks

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

The class 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.

Please refer to the QOSSpecification type for a complete list of fields.

RNIFReceiver.RecipientCert Property

The encryption certificate of the recipient.

Syntax

getRecipientCert(): Certificate;
setRecipientCert(recipientCert: Certificate): void;

Default Value

Remarks

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

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

Please refer to the Certificate type for a complete list of fields.

RNIFReceiver.ReplyMessage Property

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

Syntax

isReplyMessage(): boolean;
setReplyMessage(replyMessage: boolean): void;

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.

RNIFReceiver.Request Property

The HTTP request to be processed.

Syntax

getRequest(): Uint8Array;
setRequest(request: Uint8Array): void;

Default Value

""

Remarks

This property holds the body of the request to be processed. The HTTP headers may be set separately in RequestHeaders or may be included in Request. If they are included, a double CRLF pair should be used to separate the headers from the body.

When ReadRequest is called the contents of Request are overwritten.

RNIFReceiver.RequestHeaders Property

The HTTP headers in the RNIF request.

Syntax

getRequestHeaders(): HeaderList;
setRequestHeaders(requestHeaders: HeaderList): void;

Default Value

Remarks

A collection of headers. These will include RNIF-specific headers as well as general HTTP headers.

When assigning an RNIF request to the component, the headers may be included in Request or specified separately in RequestHeaders. If the headers are included in Request they will be parsed out whenever ReadRequest, ParseRequest, or ProcessRequest is invoked.

Please refer to the Header type for a complete list of fields.

RNIFReceiver.RequestHeadersString Property

The HTTP headers in the RNIF request.

Syntax

getRequestHeadersString(): string;
setRequestHeadersString(requestHeadersString: string): void;

Default Value

""

Remarks

The entire list of headers, concatenated into a single string. These will include RNIF-specific headers as well as general HTTP headers. You may access specific headers through RequestHeaders.

When assigning an RNIF request to the component, the headers may be included in Request or specified separately in RequestHeaders or RequestHeadersString. If the headers are included in Request they will be parsed out whenever ReadRequest, ParseRequest, or ProcessRequest is invoked.

RNIFReceiver.ResponseType Property

Requested response type. Available only in RNIF 2.0.

Syntax

getResponseType(): RnifreceiverResponseTypes;

enum RnifreceiverResponseTypes {
  rtSync,
  rtAsync
}

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 read-only and not available at design time.

RNIFReceiver.RNIFVersion Property

The RNIF Standard Version used to generate this message.

Syntax

getRNIFVersion(): RnifreceiverRNIFVersions;

enum RnifreceiverRNIFVersions {
  v1,
  v2
}

Default Value

0

Remarks

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

This property is read-only and not available at design time.

RNIFReceiver.SecureTransportRequired Property

Indicates that security is required when forwarding this message.

Syntax

isSecureTransportRequired(): boolean;
setSecureTransportRequired(secureTransportRequired: boolean): void;

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.

RNIFReceiver.ServiceContent Property

The PIP message data.

Syntax

getServiceContent(): string;
setServiceContent(serviceContent: string): void;

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.

RNIFReceiver.ServiceHeaderXML Property

The complete XML data from the Service Header.

Syntax

getServiceHeaderXML(): string;
setServiceHeaderXML(serviceHeaderXML: string): void;

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 class. 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 class 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

RNIFReceiver.SignalCode Property

The code for this signal.

Syntax

getSignalCode(): string;
setSignalCode(signalCode: string): void;

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.

RNIFReceiver.SignalMessage Property

Whether or not this message is a signal.

Syntax

isSignalMessage(): boolean;
setSignalMessage(signalMessage: boolean): void;

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.

RNIFReceiver.SignalVersion Property

The version of this signal.

Syntax

getSignalVersion(): string;
setSignalVersion(signalVersion: string): void;

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.

RNIFReceiver.SignerCert Property

Your trading partner's signing certificate.

Syntax

getSignerCert(): Certificate;
setSignerCert(signerCert: Certificate): void;

Default Value

Remarks

This property can be set to your trading partner's signing certificate to verify signatures on incoming RosettaNet messages when calling ParseRequest

This property should be set to a public key instance of Certificate.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

RNIFReceiver.StandardName Property

The name of the standard used to create this message.

Syntax

getStandardName(): string;
setStandardName(standardName: string): void;

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.

RNIFReceiver.StandardVersion Property

The version of the standard used to create this message.

Syntax

getStandardVersion(): string;
setStandardVersion(standardVersion: string): void;

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.

RNIFReceiver.ToRole Property

The role of the entity receiving this message.

Syntax

getToRole(): string;
setToRole(toRole: string): void;

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.

RNIFReceiver.ToService Property

The service for which this message is bound.

Syntax

getToService(): string;
setToService(toService: string): void;

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.

RNIFReceiver.config Method

Sets or retrieves a configuration setting.

Syntax

async rnifreceiver.config(configurationString : string): Promise<string>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

RNIFReceiver.parseHeaders Method

Processes the headers, and populates the appropriate properties.

Syntax

async rnifreceiver.parseHeaders(): Promise<void>

Remarks

When this method is called, the headers are parsed from the HTTP request. Based on the headers, the class will set the RNIFVersion and ResponseType properties. After ParseHeaders is called, these two properties should be polled to determine how the message should be handled.

RNIFReceiver.parseRequest Method

Parses the MIME message and determines the Message .

Syntax

async rnifreceiver.parseRequest(): Promise<void>

Remarks

Once the message is acquired from the sender and the RNIFVersion and ResponseType properties have been parsed out, this method should be called to MIME decode the RosettaNet message, verify the signature if present, and decrypt the service content if needed. The PreambleHeaderXML, DeliveryHeaderXML, ServiceHeaderXML and ServiceContent properties are all populated, as well as the attachment properties, if any exist.

NOTE: before calling this method, the message must be read from the server via a call to ReadRequest.

RNIFReceiver.readRequest Method

Reads the RNIF request from the given HTTP servlet request.

Syntax

async rnifreceiver.readRequest(): Promise<void>

Remarks

This method acquires the request from the HTTP servlet. Once this is done, ReadRequest then calls ParseHeaders, which parses the headers for the acquired message.

RNIFReceiver.requestHeader Method

Gets the specified header from the HTTP request.

Syntax

async rnifreceiver.requestHeader(header : string): Promise<string>

Remarks

This method is invoked to return a specific header from the HTTP request. Header is the name of a header from the incoming HTTP request. The method will return either the value of that header or the empty string if the header did not exist.

RNIFReceiver.reset Method

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

Syntax

async rnifreceiver.reset(): Promise<void>

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.

NOTE: The application should always call Reset and set all message properties to valid value before sending a response message.

RNIFReceiver.sendResponse Method

Optional. Acknowledges the incoming request.

Syntax

async rnifreceiver.sendResponse(): Promise<void>

Remarks

This sends a signal to the client. The signal may be a receipt of acknowledgement or a notification of failure. SendResponse will send the response message synchronously over the original HTTP connection. If an asynchronous response is requested by the client or required by the PIP, you should use the RNIFSender.

NOTE: This method does not create the RosettaNet acknowledgement receipt or notification of failure, it simply sends it. You must create the response message and set it via the ServiceContent, along with setting the headers to valid values, before you calling this method.

RNIFReceiver.Error Event

Fired when information is available about errors during data delivery.

Syntax

rnifreceiver.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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.

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

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X.509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public Header();

public Header(String field, String value);

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

public QOSSpecification();

public QOSSpecification(String code, String value);

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

public RNIFAttachment();

public RNIFAttachment(String filename);

public RNIFAttachment(String filename, String id);

public RNIFAttachment(String filename, String id, String description);

public RNIFAttachment(String filename, String id, String description, String MIMEType);

Config Settings (class ipworksedi.rnifreceiver)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

RNIFReceiver Config Settings

Base Config Settings

Trappable Errors (class ipworksedi.rnifreceiver)

SMIME Errors

	10191   Invalid index (RecipientIndex).
	10192   Message decoding error (code).
	10193   Unexpected message type.
	10194   Unsupported hashing/signing algorithm.
	10195   The message does not have any signers.
	10196   The message signature could not be verified.
	10197   Could not locate a suitable decryption certificate.
	10198   The signer certificate could not be found.
	10199   No signing certificate was supplied for signing the message.
	10201   The specified certificate was not the one required.
	10202   The specified certificate could not be found.
	10221   Could not acquire CSP.
	10222   Type validation error.
	10223   Unsupported key size.
	10224   Unrecognized Content-Type object identifier.
	10225   Unrecognized public key format.
	10226   No choices specified.
	10228   Must specify output stream.
	10280   Invalid part index.
	10281   Unknown MIME type.
	10283   No MIME-boundary found.
	10280   Error decoding certificate.

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.