# RNIFReceiver Class 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](#rnifreceiverreadrequest-method) 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](#rnifreceiverparseheaders-method) method. You may then set the appropriate certificates by setting the [Certificate](#rnifreceivercertificate-property) to your private key certificate and [SignerCert](#rnifreceiversignercert-property) to your trading partner's (signing) certificate. The next step is to parse the RosettaNet message using [ParseRequest](#rnifreceiverparserequest-method). 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](#rnifreceiverpreambleheaderxml-property), [DeliveryHeaderXML](#rnifreceiverdeliveryheaderxml-property), and the [ServiceHeaderXML](#rnifreceiverserviceheaderxml-property), respectively. It also parses the actual body of the RosettaNet message, or the PIP, into the [ServiceContent](#rnifreceiverservicecontent-property). Any attachments that may be in the message are parsed into the attachment array, and may be accessed via the [Attachments](#rnifreceiverattachments-property) 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](#rnifreceivermessagesenderid-property), [MessageReceiverId](#rnifreceivermessagereceiverid-property), [ActionCode](#rnifreceiveractioncode-property), etc. The [ServiceContent](#rnifreceiverservicecontent-property) 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](#rnifreceiversendresponse-method) method. NOTE: the [RNIFReceiver](#rnifreceiver-class) 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](RNIFSender.md#RNIFSender) class. The following example illustrates how to use the class within a web page. **EXAMPLE** ```text 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](#rnifreceiverpreambleheaderxml-property), [DeliveryHeaderXML](#rnifreceiverdeliveryheaderxml-property), [ServiceHeaderXML](#rnifreceiverserviceheaderxml-property)<;, and the [ServiceContent](#rnifreceiverservicecontent-property), 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](#rnifreceiverattachments-property) entry, and in the directory specified by the receiver. The directory is specified using the [AttachmentOutputPath](#AttachmentOutputPath) config property, and must be specified before you read and process the request. For example: ```text 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.* | | | | --- | --- | | [ActionCode](#rnifreceiveractioncode-property) | The code for this action. | | [ActionMessage](#rnifreceiveractionmessage-property) | Whether or not this message is an action message. | | [ActionMessageStandardName](#rnifreceiveractionmessagestandardname-property) | The name of the standard used to create this action. | | [ActionMessageStandardVersion](#rnifreceiveractionmessagestandardversion-property) | The version of the standard used to create this action. | | [Attachments](#rnifreceiverattachments-property) | A collection of files attached to the current RNIF message. | | [BusinessActivity](#rnifreceiverbusinessactivity-property) | This property denotes the type of business activity. | | [Certificate](#rnifreceivercertificate-property) | The encryption certificate. | | [DeliveryHeaderXML](#rnifreceiverdeliveryheaderxml-property) | The complete XML data from the Delivery Header. | | [EncryptionAlgorithm](#rnifreceiverencryptionalgorithm-property) | The algorithm used to encrypt the EDI data. | | [EncryptionType](#rnifreceiverencryptiontype-property) | The encryption type for RNIF 2.0. | | [FromRole](#rnifreceiverfromrole-property) | The business role of the entity that originated this message. | | [FromService](#rnifreceiverfromservice-property) | The service that originated this message. | | [GlobalUsageCode](#rnifreceiverglobalusagecode-property) | A universal code describing basic usage for this message. | | [MessageDateTime](#rnifreceivermessagedatetime-property) | The time at which this message was sent. | | [MessageReceiverId](#rnifreceivermessagereceiverid-property) | Identity of the entity receiving this message. | | [MessageReceiverLocation](#rnifreceivermessagereceiverlocation-property) | Location of the entity receiving this message. | | [MessageSenderId](#rnifreceivermessagesenderid-property) | Identity of the entity that sent this message. | | [MessageSenderLocation](#rnifreceivermessagesenderlocation-property) | Location of the entity that sent this message. | | [MessageTrackingId](#rnifreceivermessagetrackingid-property) | Unique value that identifies this message. | | [OriginalActionCode](#rnifreceiveroriginalactioncode-property) | The action code of the original message. | | [OriginalMessageStandardName](#rnifreceiveroriginalmessagestandardname-property) | The name of the standard used to create the original message. | | [OriginalMessageStandardVersion](#rnifreceiveroriginalmessagestandardversion-property) | The version of the standard used to create the original message. | | [OriginalMessageTrackingId](#rnifreceiveroriginalmessagetrackingid-property) | Tracking identifier for the original message. | | [PartnerId](#rnifreceiverpartnerid-property) | Identity of the partner. | | [PartnerKnown](#rnifreceiverpartnerknown-property) | Whether or not the partner is known. | | [PartnerLocation](#rnifreceiverpartnerlocation-property) | Location of the partner. | | [PartnerPIPBindingId](#rnifreceiverpartnerpipbindingid-property) | The partner-defined PIP payload binding ID. | | [PartnerURL](#rnifreceiverpartnerurl-property) | A URL to which replies must be sent if the partner is unknown. | | [PIPCode](#rnifreceiverpipcode-property) | RosettaNet PIP code of this message. | | [PIPInstanceId](#rnifreceiverpipinstanceid-property) | The Id of this PIP instance. | | [PIPVersion](#rnifreceiverpipversion-property) | RosettaNet PIP version of this message. | | [PreambleHeaderXML](#rnifreceiverpreambleheaderxml-property) | The complete XML data from the Preamble Header. | | [QOSSpecifications](#rnifreceiverqosspecifications-property) | Specifies quality of service constraints for this message. | | [RecipientCert](#rnifreceiverrecipientcert-property) | The encryption certificate of the recipient. | | [ReplyMessage](#rnifreceiverreplymessage-property) | Whether or not this message is a reply to another message. | | [Request](#rnifreceiverrequest-property) | The HTTP request to be processed. | | [RequestHeaders](#rnifreceiverrequestheaders-property) | The HTTP headers in the RNIF request. | | [RequestHeadersString](#rnifreceiverrequestheadersstring-property) | The HTTP headers in the RNIF request. | | [ResponseType](#rnifreceiverresponsetype-property) | Requested response type. Available only in RNIF 2.0. | | [RNIFVersion](#rnifreceiverrnifversion-property) | The RNIF Standard Version used to generate this message. | | [SecureTransportRequired](#rnifreceiversecuretransportrequired-property) | Indicates that security is required when forwarding this message. | | [ServiceContent](#rnifreceiverservicecontent-property) | The PIP message data. | | [ServiceHeaderXML](#rnifreceiverserviceheaderxml-property) | The complete XML data from the Service Header. | | [SignalCode](#rnifreceiversignalcode-property) | The code for this signal. | | [SignalMessage](#rnifreceiversignalmessage-property) | Whether or not this message is a signal. | | [SignalVersion](#rnifreceiversignalversion-property) | The version of this signal. | | [SignerCert](#rnifreceiversignercert-property) | Your trading partner's signing certificate. | | [StandardName](#rnifreceiverstandardname-property) | The name of the standard used to create this message. | | [StandardVersion](#rnifreceiverstandardversion-property) | The version of the standard used to create this message. | | [ToRole](#rnifreceivertorole-property) | The role of the entity receiving this message. | | [ToService](#rnifreceivertoservice-property) | The service for which this message is bound. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#rnifreceiverconfig-method) | Sets or retrieves a configuration setting. | | [ParseHeaders](#rnifreceiverparseheaders-method) | Processes the headers, and populates the appropriate properties. | | [ParseRequest](#rnifreceiverparserequest-method) | Parses the MIME message and determines the Message . | | [ReadRequest](#rnifreceiverreadrequest-method) | Reads the RNIF request from the given HTTP servlet request. | | [RequestHeader](#rnifreceiverrequestheader-method) | Gets the specified header from the HTTP request. | | [Reset](#rnifreceiverreset-method) | This property is used to reset all attributes of the Rnifreceiver instance. | | [SendResponse](#rnifreceiversendresponse-method) | Optional. Acknowledges the incoming request. | | [SetAttachmentOutputStream](#rnifreceiversetattachmentoutputstream-method) | Decodes the specified attachment to the output stream. | | [SetRequestStream](#rnifreceiversetrequeststream-method) | Sets the stream from which the class will read the RNIF request. | ## 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.* | | | | --- | --- | | [Error](#rnifreceivererror-event) | Fired when information is available about errors during data delivery. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AttachmentOutputPath](#AttachmentOutputPath) | Specifies a path on disk to which attachments will be saved. | | [ExpectedVersion](#ExpectedVersion) | The RNIF document version that the RNIFReceiver is expecting to receive. | | [FromPartnerClassificationCode](#FromPartnerClassificationCode) | Code identifying the sending partner's function in the supply chain. | | [GlobalProcessCode](#GlobalProcessCode) | Business process identifier e.g. 'Manage Product Subscriptions'. This code is the name of a PIP specification document. | | [HTTPStatusCode](#HTTPStatusCode) | The HTTP status code to send in the response. | | [MessageDigest](#MessageDigest) | The base-64 encoded hash of the received data. | | [RequireEncryption](#RequireEncryption) | Whether encryption is required when processing received messages. | | [RequireSignature](#RequireSignature) | Whether a signature is required when processing received messages. | | [SignatureAlgorithm](#SignatureAlgorithm) | Signature algorithm to be used in outgoing messages. | | [ToPartnerClassificationCode](#ToPartnerClassificationCode) | Code identifying the receiving partner's function in the supply chain. | | [TransactionCode](#TransactionCode) | Service transaction dialog. The code is the name of the business activity and the transaction dialog in the PIP specification document. | | [TransactionId](#TransactionId) | A unique alpha-numeric identifier that represents a specific instance of an business process, business transaction, business action or business signal. The instance identifier must be unique for a particular instance of a business process, business transaction, business action and business signal. | | [TransferredData](#TransferredData) | The full body of the incoming request. | | [TransferredHeaders](#TransferredHeaders) | The HTTP headers of the incoming request. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # [RNIFReceiver](#rnifreceiver-class).ActionCode Property The code for this action. ## Syntax ```text 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](#rnifreceiver-class).ActionMessage Property Whether or not this message is an action message. ## Syntax ```text 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](#rnifreceiver-class).ActionMessageStandardName Property The name of the standard used to create this action. ## Syntax ```text 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](#rnifreceiveractionmessagestandardversion-property). 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](#rnifreceiveroriginalmessagestandardname-property) and [OriginalMessageStandardVersion](#rnifreceiveroriginalmessagestandardversion-property) when creating or processing replies. This property is a field of the service header. # [RNIFReceiver](#rnifreceiver-class).ActionMessageStandardVersion Property The version of the standard used to create this action. ## Syntax ```text 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](#rnifreceiveractionmessagestandardname-property) 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](#rnifreceiveroriginalmessagestandardname-property) and [OriginalMessageStandardVersion](#rnifreceiveroriginalmessagestandardversion-property) when creating or processing replies. This property is a field of the service header. # [RNIFReceiver](#rnifreceiver-class).Attachments Property A collection of files attached to the current RNIF message. ## Syntax ```text getAttachments(): RNIFAttachmentList; ``` ## 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](#rnifreceiverservicecontent-property), so if [EncryptionType](#rnifreceiverencryptiontype-property) 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](#rnifattachment-type) 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](#AttachmentOutputPath) config property. This property is not available at design time. Please refer to the [RNIFAttachment](#rnifattachment-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).BusinessActivity Property This property denotes the type of business activity. ## Syntax ```text 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](#rnifreceiver-class).Certificate Property The encryption certificate. ## Syntax ```text 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](#rnifreceiverparserequest-method), the certificate will be used to decrypt the incoming message. If set prior to calling [SendResponse](#rnifreceiversendresponse-method), the certificate will be used to sign the response. Certificate must be set to a private key certificate. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).DeliveryHeaderXML Property The complete XML data from the Delivery Header. ## Syntax ```text 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](#rnifreceiversecuretransportrequired-property) - [MessageDateTime](#rnifreceivermessagedatetime-property) - [MessageReceiverId](#rnifreceivermessagereceiverid-property) - [MessageReceiverLocation](#rnifreceivermessagereceiverlocation-property) - [MessageSenderId](#rnifreceivermessagesenderid-property) - [MessageSenderLocation](#rnifreceivermessagesenderlocation-property) - [MessageTrackingId](#rnifreceivermessagetrackingid-property) NOTE: If [RNIFVersion](#rnifreceiverrnifversion-property) is set to *v1*, the value of this property is ignored when generating messages. # [RNIFReceiver](#rnifreceiver-class).EncryptionAlgorithm Property The algorithm used to encrypt the EDI data. ## Syntax ```text getEncryptionAlgorithm(): string; setEncryptionAlgorithm(encryptionAlgorithm: string): void; ``` ## Default Value "AESCBC256" ## 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 **"AESCBC256"**, or industry-standard 256-bit AES-CBC encryption, by default. The class supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 (default) - AESGCM128 - AESGCM192 - AESGCM256 # [RNIFReceiver](#rnifreceiver-class).EncryptionType Property The encryption type for RNIF 2.0. ## Syntax ```text 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: | | | | --- | --- | | 0 (etNoEncryption) | The entire contents of the RosettaNet message are unencrypted. | | 1 (etEncryptServiceContent) | The service content and attachments are encrypted. | | 2 (etEncryptPayloadContainer) | The service header, content, and attachments are encrypted. | 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](#rnifreceiverrecipientcert-property) for more information on specifying a certificate for encryption. This property is not available at design time. # [RNIFReceiver](#rnifreceiver-class).FromRole Property The business role of the entity that originated this message. ## Syntax ```text 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](#rnifreceiver-class).FromService Property The service that originated this message. ## Syntax ```text 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](#rnifreceiver-class).GlobalUsageCode Property A universal code describing basic usage for this message. ## Syntax ```text 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](#rnifreceiver-class).MessageDateTime Property The time at which this message was sent. ## Syntax ```text 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: | | | | --- | --- | | YYYY | This is the year of the time stamp. | | MM | This is the month of the time stamp. | | DD | This specifies the day of the month. | | T | The 'T' denotes the separation between the date and the time stamps. | | hh | This is the hour, in 24 hour format in which the message was sent. | | mm | This specifies the minutes at which the message was sent. | | ss.sss | This is the seconds at which the message was sent. Everything after the decimal is a fraction of a seconds. | | Z | This is a delimiter for the end of the date/time stamp. | 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](#rnifreceiver-class).MessageReceiverId Property Identity of the entity receiving this message. ## Syntax ```text 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](#rnifreceiver-class).MessageReceiverLocation Property Location of the entity receiving this message. ## Syntax ```text 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](#rnifreceiver-class).MessageSenderId Property Identity of the entity that sent this message. ## Syntax ```text 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](#rnifreceiver-class).MessageSenderLocation Property Location of the entity that sent this message. ## Syntax ```text 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](#rnifreceiver-class).MessageTrackingId Property Unique value that identifies this message. ## Syntax ```text 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](#rnifreceiver-class).OriginalActionCode Property The action code of the original message. ## Syntax ```text 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](#rnifreceiver-class).OriginalMessageStandardName Property The name of the standard used to create the original message. ## Syntax ```text 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](#rnifreceiveractionmessagestandardname-property) and the version in [ActionMessageStandardVersion](#rnifreceiveractionmessagestandardversion-property). 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](#rnifreceiveroriginalmessagestandardversion-property) when creating or processing replies. This property is a field of the service header. # [RNIFReceiver](#rnifreceiver-class).OriginalMessageStandardVersion Property The version of the standard used to create the original message. ## Syntax ```text 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](#rnifreceiveractionmessagestandardname-property) and the version in [ActionMessageStandardVersion](#rnifreceiveractionmessagestandardversion-property). 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](#rnifreceiveroriginalmessagestandardname-property) and OriginalMessageStandardVersion when creating or processing replies. This property is a field of the service header. # [RNIFReceiver](#rnifreceiver-class).OriginalMessageTrackingId Property Tracking identifier for the original message. ## Syntax ```text 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](#rnifreceivermessagetrackingid-property), 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](#rnifreceiver-class).PartnerId Property Identity of the partner. ## Syntax ```text getPartnerId(): string; setPartnerId(partnerId: string): void; ``` ## Default Value "" ## Remarks [PartnerKnown](#rnifreceiverpartnerknown-property) 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](#rnifreceiverpartnerlocation-property) can be specified. This property is not an address, but may be a city. NOTE: If the partner is not known, then a [PartnerURL](#rnifreceiverpartnerurl-property) 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](#rnifreceiver-class).PartnerKnown Property Whether or not the partner is known. ## Syntax ```text 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](#rnifreceiverpartnerid-property) 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](#rnifreceiverpartnerlocation-property) can be specified. This property is not an address, but may be a city. NOTE: If the partner is not known, then a [PartnerURL](#rnifreceiverpartnerurl-property) 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](#rnifreceiver-class).PartnerLocation Property Location of the partner. ## Syntax ```text getPartnerLocation(): string; setPartnerLocation(partnerLocation: string): void; ``` ## Default Value "" ## Remarks [PartnerKnown](#rnifreceiverpartnerknown-property) 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](#rnifreceiverpartnerid-property) 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](#rnifreceiverpartnerurl-property) 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](#rnifreceiver-class).PartnerPIPBindingId Property The partner-defined PIP payload binding ID. ## Syntax ```text 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](#rnifreceiver-class).PartnerURL Property A URL to which replies must be sent if the partner is unknown. ## Syntax ```text getPartnerURL(): string; setPartnerURL(partnerURL: string): void; ``` ## Default Value "" ## Remarks [PartnerKnown](#rnifreceiverpartnerknown-property) 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](#rnifreceiverpartnerid-property) 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](#rnifreceiverpartnerlocation-property) 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](#rnifreceiver-class).PIPCode Property RosettaNet PIP code of this message. ## Syntax ```text getPIPCode(): string; setPIPCode(PIPCode: string): void; ``` ## Default Value "" ## Remarks The [ServiceContent](#rnifreceiverservicecontent-property) 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](#rnifreceiverpipversion-property). 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](#rnifreceiverpipinstanceid-property) 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](#rnifreceiver-class).PIPInstanceId Property The Id of this PIP instance. ## Syntax ```text getPIPInstanceId(): string; setPIPInstanceId(PIPInstanceId: string): void; ``` ## Default Value "" ## Remarks The [ServiceContent](#rnifreceiverservicecontent-property) 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](#rnifreceiverpipcode-property) and the version in [PIPVersion](#rnifreceiverpipversion-property). 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](#rnifreceiver-class).PIPVersion Property RosettaNet PIP version of this message. ## Syntax ```text getPIPVersion(): string; setPIPVersion(PIPVersion: string): void; ``` ## Default Value "" ## Remarks The [ServiceContent](#rnifreceiverservicecontent-property) 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](#rnifreceiverpipcode-property) 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](#rnifreceiverpipinstanceid-property) 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](#rnifreceiver-class).PreambleHeaderXML Property The complete XML data from the Preamble Header. ## Syntax ```text 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](#rnifreceiverstandardname-property) - [StandardVersion](#rnifreceiverstandardversion-property) # [RNIFReceiver](#rnifreceiver-class).QOSSpecifications Property Specifies quality of service constraints for this message. ## Syntax ```text getQOSSpecifications(): QOSSpecificationList; ``` ## 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](#qosspecification-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).RecipientCert Property The encryption certificate of the recipient. ## Syntax ```text 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](#rnifreceiverencryptionalgorithm-property) when a response is sent using [SendResponse](#rnifreceiversendresponse-method). If set, this property should be a public key instance of [Certificate](#certificate-type). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).ReplyMessage Property Whether or not this message is a reply to another message. ## Syntax ```text 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](#rnifreceiver-class).Request Property The HTTP request to be processed. ## Syntax ```text 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](#rnifreceiverrequestheaders-property) 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](#rnifreceiverreadrequest-method) is called the contents of Request are overwritten. # [RNIFReceiver](#rnifreceiver-class).RequestHeaders Property The HTTP headers in the RNIF request. ## Syntax ```text getRequestHeaders(): HeaderList; ``` ## 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](#rnifreceiverrequest-property) or specified separately in RequestHeaders. If the headers are included in [Request](#rnifreceiverrequest-property) they will be parsed out whenever [ReadRequest](#rnifreceiverreadrequest-method), [ParseRequest](#rnifreceiverparserequest-method), or ProcessRequest is invoked. Please refer to the [Header](#header-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).RequestHeadersString Property The HTTP headers in the RNIF request. ## Syntax ```text 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](#rnifreceiverrequestheaders-property). When assigning an RNIF request to the component, the headers may be included in [Request](#rnifreceiverrequest-property) or specified separately in [RequestHeaders](#rnifreceiverrequestheaders-property) or RequestHeadersString. If the headers are included in [Request](#rnifreceiverrequest-property) they will be parsed out whenever [ReadRequest](#rnifreceiverreadrequest-method), [ParseRequest](#rnifreceiverparserequest-method), or ProcessRequest is invoked. # [RNIFReceiver](#rnifreceiver-class).ResponseType Property Requested response type. Available only in RNIF 2.0. ## Syntax ```text 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: | | | | --- | --- | | rtSync | The response will be received on the same HTTP session as the initial request. | | rtAsync | The response will be received later. | This property is only available in RNIF version 2.0. This property is read-only and not available at design time. # [RNIFReceiver](#rnifreceiver-class).RNIFVersion Property The RNIF Standard Version used to generate this message. ## Syntax ```text 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:: | | | | --- | --- | | v1 | RosettaNet version 1.1 | | v2 | RosettaNet version 2.0 | This property is read-only and not available at design time. # [RNIFReceiver](#rnifreceiver-class).SecureTransportRequired Property Indicates that security is required when forwarding this message. ## Syntax ```text 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](RNIFSender.md#RNIFSender) for more information on sending messages over a secure transport. This property is a field of the delivery header. # [RNIFReceiver](#rnifreceiver-class).ServiceContent Property The PIP message data. ## Syntax ```text 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](#rnifreceiverpipinstanceid-property) property. # [RNIFReceiver](#rnifreceiver-class).ServiceHeaderXML Property The complete XML data from the Service Header. ## Syntax ```text 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](#rnifreceiveractioncode-property) - [ActionMessage](#rnifreceiveractionmessage-property) - [ActionMessageStandardName](#rnifreceiveractionmessagestandardname-property) - [ActionMessageStandardVersion](#rnifreceiveractionmessagestandardversion-property) - [Attachments](#rnifreceiverattachments-property) - [FromRole](#rnifreceiverfromrole-property) - [FromService](#rnifreceiverfromservice-property) - [OriginalActionCode](#rnifreceiveroriginalactioncode-property) - [OriginalMessageStandardName](#rnifreceiveroriginalmessagestandardname-property) - [OriginalMessageStandardVersion](#rnifreceiveroriginalmessagestandardversion-property) - [OriginalMessageTrackingId](#rnifreceiveroriginalmessagetrackingid-property) - [PartnerId](#rnifreceiverpartnerid-property) - [PartnerKnown](#rnifreceiverpartnerknown-property) - [PartnerLocation](#rnifreceiverpartnerlocation-property) - [PartnerPIPBindingId](#rnifreceiverpartnerpipbindingid-property) - [PartnerURL](#rnifreceiverpartnerurl-property) - [PIPCode](#rnifreceiverpipcode-property) - [PIPInstanceId](#rnifreceiverpipinstanceid-property) - [PIPVersion](#rnifreceiverpipversion-property) - [QOSSpecifications](#rnifreceiverqosspecifications-property) - [ReplyMessage](#rnifreceiverreplymessage-property) - [SignalCode](#rnifreceiversignalcode-property) - [SignalMessage](#rnifreceiversignalmessage-property) - [GlobalUsageCode](#rnifreceiverglobalusagecode-property) - [SignalVersion](#rnifreceiversignalversion-property) - [ToRole](#rnifreceivertorole-property) - [ToService](#rnifreceivertoservice-property) # [RNIFReceiver](#rnifreceiver-class).SignalCode Property The code for this signal. ## Syntax ```text 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](#rnifreceiver-class).SignalMessage Property Whether or not this message is a signal. ## Syntax ```text 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](#rnifreceiver-class).SignalVersion Property The version of this signal. ## Syntax ```text 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](#rnifreceiver-class).SignerCert Property Your trading partner's signing certificate. ## Syntax ```text 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](#rnifreceiverparserequest-method) This property should be set to a public key instance of [Certificate](#certificate-type). This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [RNIFReceiver](#rnifreceiver-class).StandardName Property The name of the standard used to create this message. ## Syntax ```text 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](#rnifreceiver-class).StandardVersion Property The version of the standard used to create this message. ## Syntax ```text 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](#rnifreceiver-class).ToRole Property The role of the entity receiving this message. ## Syntax ```text 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](#rnifreceiver-class).ToService Property The service for which this message is bound. ## Syntax ```text 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](#rnifreceiver-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text 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](#config-settings-class-ipworksedirnifreceiver) 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](#config-settings-class-ipworksedirnifreceiver), you must call *Config("PROPERTY")*. The value will be returned as a string. # [RNIFReceiver](#rnifreceiver-class).parseHeaders Method Processes the headers, and populates the appropriate properties. ## Syntax ```text 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](#rnifreceiverrnifversion-property) and [ResponseType](#rnifreceiverresponsetype-property) properties. After ParseHeaders is called, these two properties should be polled to determine how the message should be handled. # [RNIFReceiver](#rnifreceiver-class).parseRequest Method Parses the MIME message and determines the Message . ## Syntax ```text async rnifreceiver.parseRequest(): Promise< void> ``` ## Remarks Once the message is acquired from the sender and the [RNIFVersion](#rnifreceiverrnifversion-property) and [ResponseType](#rnifreceiverresponsetype-property) 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](#rnifreceiverpreambleheaderxml-property), [DeliveryHeaderXML](#rnifreceiverdeliveryheaderxml-property), [ServiceHeaderXML](#rnifreceiverserviceheaderxml-property) and [ServiceContent](#rnifreceiverservicecontent-property) 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](#rnifreceiverreadrequest-method). # [RNIFReceiver](#rnifreceiver-class).readRequest Method Reads the RNIF request from the given HTTP servlet request. ## Syntax ```text async rnifreceiver.readRequest(): Promise< void> ``` ## Remarks This method acquires the request from the HTTP servlet. Once this is done, ReadRequest then calls [ParseHeaders](#rnifreceiverparseheaders-method), which parses the headers for the acquired message. # [RNIFReceiver](#rnifreceiver-class).requestHeader Method Gets the specified header from the HTTP request. ## Syntax ```text 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](#rnifreceiver-class).reset Method This property is used to reset all attributes of the Rnifreceiver instance. ## Syntax ```text 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](#rnifreceiver-class).sendResponse Method Optional. Acknowledges the incoming request. ## Syntax ```text 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](RNIFSender.md#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](#rnifreceiverservicecontent-property), along with setting the headers to valid values, before you calling this method. # [RNIFReceiver](#rnifreceiver-class).setAttachmentOutputStream Method Decodes the specified attachment to the output stream. ## Syntax ```text async rnifreceiver.setAttachmentOutputStream(index : number, stream : WriteableStream): Promise< void> ``` ## Remarks This method decodes the attachment specified by *index* to the specified *stream*. When this method is called the attachment is decoded immediately and the decoded data is written to the specified stream. # [RNIFReceiver](#rnifreceiver-class).setRequestStream Method Sets the stream from which the class will read the RNIF request. ## Syntax ```text async rnifreceiver.setRequestStream(inputStream : ReadableStream): Promise< void> ``` ## Remarks If an input stream is set before the component attempts to process an RNIF request, the data is read from the input stream. Otherwise the [Request](#rnifreceiverrequest-property) will be checked. The content of the stream will be read from the current position all the way to the end and no bytes will be skipped. # [RNIFReceiver](#rnifreceiver-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text 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](#trappable-errors-class-ipworksedirnifreceiver) 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. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *string (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *string (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *string (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *string (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *string (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *string* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys. NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling . **PrivateKey** *string (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *number (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *string (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *string* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *Uint8Array* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *string* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *string (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *string (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *string (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *number (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **EncodedB** *Uint8Array* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See 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). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See 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 the * 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). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See 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. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array 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). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array 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). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * 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](#header-type) type. This type contains a , and its corresponding . The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *string* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *string* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors ```text public Header(); ``` ```text 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. The following fields are available: - [Code](#QOSSpecification_f_Code) - [Value](#QOSSpecification_f_Value) ## Fields **Code** *string* *Default Value: ""* is a string representing a quality of service measurement category. **Value** *string* *Default Value: ""* is a string that defines the constraints for the category in . ## Constructors ```text public QOSSpecification(); ``` ```text 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. The following fields are available: - [Data](#RNIFAttachment_f_Data) - [Description](#RNIFAttachment_f_Description) - [FileName](#RNIFAttachment_f_FileName) - [Id](#RNIFAttachment_f_Id) - [InputStream](#RNIFAttachment_f_InputStream) - [MIMEType](#RNIFAttachment_f_MIMEType) - [OutputStream](#RNIFAttachment_f_OutputStream) ## Fields **Data** *string* *Default Value: ""* contains the raw data of the current attachment. If is set, the value in will be used to specify the name of the attachment when generating messages to be sent. When receiving, polling This property will cause the attachment to be parsed out of the transmitted MIME entity to memory rather than being parsed to a file. **DataB** *Uint8Array* *Default Value: ""* contains the raw data of the current attachment. If is set, the value in will be used to specify the name of the attachment when generating messages to be sent. When receiving, polling This property will cause the attachment to be parsed out of the transmitted MIME entity to memory rather than being parsed to a file. **Description** *string* *Default Value: ""* contains descriptions for this attachment. These descriptions are human-readable strings and may set to any arbitrary value. These descriptions should play no role in how the message is processed or interpreted. **FileName** *string* *Default Value: ""* is the name of the file containing the decoded data of the current attachment. When sending messages, this value tells the class where to find the file and is used in accordance with MIME encoding rules to indicate the filename to be used by the receiving RNIF entity when parsing the attachments. When receiving, polling This property will cause the attachment to be parsed out of the transmitted MIME entity to the filename indicated by the MIME encoding rules. When the property returns, the file will be written to the path indicated. **Id** *string* *Default Value: ""* is a unique content-identifier used within the RosettaNet message to internally reference the attachments. Because these identifiers are used to reference the attachments, each attachment must have a unique identifier, but they only need to be unique within the scope of the current message. These values may take the form of a URI. **InputStream** *ReadableStream* *Default Value: ""* A stream which contains the decoded data of the current attachment. **MIMEType** *string* *Default Value: ""* is a value indicating how the [RNIFAttachment](#rnifattachment-type) should be interpreted. Valid MIME types include, but are not limited to, the following: - "plain/html" - "plain/text" - "image/jpg" - "image/gif" - "image/bmp" - "application/stream" **OutputStream** *WriteableStream (read-only)* *Default Value: ""* The class decodes the attachment when is specified. NOTE: It is recommended to use the SetAttachmentOutputStream method instead of setting this property. ## Constructors ```text public RNIFAttachment(); ``` ```text public RNIFAttachment(String fileName); ``` ```text public RNIFAttachment(String fileName, String id); ``` ```text public RNIFAttachment(String fileName, String id, String description); ``` ```text public RNIFAttachment(String fileName, String id, String description, String MIMEType); ``` # ReadableStream Type ## Syntax ```text interface ReadableStream { read(buffer: Uint8Array, offset: number, length: number): Promise; readSync(buffer: Uint8Array, offset: number, length: number): number; available(): number; close(): void; mark():void; reset():void; markSupported():boolean; } ``` ## Remarks The RNIFReceiver class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the RNIFReceiver class. When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text read(buffer: Uint8Array, offset: number, length: number): Promise { } ``` ```text readSync(buffer: Uint8Array, offset: number, length: number): number { } ``` ```text available(): number { } ``` ```text close(): void { } ``` ```text mark(): void { } ``` ```text reset(): void { } ``` ```text markSupported(): boolean { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | buffer: The buffer to store the read data.
offset: The starting position within the buffer to write data.
length: The maximum number of bytes to read.
| | read | Reads data from the stream into the provided buffer. This method must be implemented.
Returns a promise resolving to the number of bytes read, -1 if no data is available. | | readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. | | available | Returns the number of bytes available for reading. This method must be implemented.
| | close | Closes the stream and releases associated resources. | | mark | Marks the current position in this stream. | | reset | Repositions this stream to the position at the time the mark method was last called. | | markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. | # WriteableStream Type ## Syntax ```text interface WriteableStream { write(data: Uint8Array, offset: number, length: number): Promise; writeSync(data: Uint8Array, offset: number, length: number): void; close(): void; } ``` ## Remarks The RNIFReceiver class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the RNIFReceiver class. When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text write(data: Uint8Array, offset: number, length: number): Promise { } ``` ```text writeSync(data: Uint8Array, offset: number, length: number): void { } ``` ```text close(): void { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | data: The buffer containing the data to write.
offset: The starting position in the buffer to read data from.
length: The maximum number of bytes to write.
| | write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.
Returns a promise that resolves when the write operation completes. | | writeSync | Synchronously writes data from the buffer to the stream. | | close | Closes the stream and releases associated resources. | # Config Settings (*class *ipworksedi.[rnifreceiver](#rnifreceiver-class)) 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](#rnifreceiverconfig-method) method. ### RNIFReceiver Config Settings **AttachmentOutputPath**: Specifies a path on disk to which attachments will be saved.This setting specifies a path on disk to which attachments will be saved when processing incoming messages. **ExpectedVersion**: The RNIF document version that the RNIFReceiver is expecting to receive.This configuration option allow you to explicitly define the RNIF version of the document that you are expecting to receive. If this value is set, the component will not attempt to parse the RNIF version from the received headers and will attempt to process the received document as an RNIF document of the version specified in this configuration option. | | | | --- | --- | | Option | Effect | | 0 (default) | No expected version. Parses the RNIF version from received headers and process document based on this. | | 1 | Expect RNIF v1.1 document. | | 2 | Expect RNIF v2.0 document. | **FromPartnerClassificationCode**: Code identifying the sending partner's function in the supply chain. **GlobalProcessCode**: Business process identifier e.g. 'Manage Product Subscriptions'. This code is the name of a PIP specification document. **HTTPStatusCode**: The HTTP status code to send in the response.If set, this defines the HTTP status code returned by the class when [SendResponse](#rnifreceiversendresponse-method) is called. By default the class will return a HTTP status code of 200. **MessageDigest**: The base-64 encoded hash of the received data.This configuration setting will return the base-64 encoded hash of the received data. **RequireEncryption**: Whether encryption is required when processing received messages.This setting may be set to True to require that received messages are encrypted. When True if a message is received that is not encrypted the class will throw an exception. The default value is False. **RequireSignature**: Whether a signature is required when processing received messages.This setting may be set to True to require that received messages are signed. When True if a message is received that is not signed the class will throw an exception. The default value is False. **SignatureAlgorithm**: Signature algorithm to be used in outgoing messages. *Signature Algorithm* can be set to **md5** or **sha1**, to indicate the preferred signing algorithm. **ToPartnerClassificationCode**: Code identifying the receiving partner's function in the supply chain. **TransactionCode**: Service transaction dialog. The code is the name of the business activity and the transaction dialog in the PIP specification document. **TransactionId**: A unique alpha-numeric identifier that represents a specific instance of an business process, business transaction, business action or business signal. The instance identifier must be unique for a particular instance of a business process, business transaction, business action and business signal. **TransferredData**: The full body of the incoming request.After calling [ParseRequest](#rnifreceiverparserequest-method) this will contain the full body of the incoming request. **TransferredHeaders**: The HTTP headers of the incoming request.After calling [ParseRequest](#rnifreceiverparserequest-method) this will contain the full HTTP headers of the incoming request. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *ipworksedi.[rnifreceiver](#rnifreceiver-class)) ### 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 (cannot find namespace). | | 203 | Unknown attribute prefix (cannot 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 | Cannot open file. | | 401 | Invalid XML would be generated. | | 402 | An invalid XML name has been specified. |