RNIFReceiver Configuration

The component 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 component, access to these internal properties is provided through the Config method.

RNIFReceiver Configuration Settings

AttachmentOutputPath: Allows the specification of an output path to which attachments will be written to.

This must be set to tell the receiver which directory to save any attached files in.

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.

HTTPStatusCode: The HTTP status code to send in the response.

If set, this defines the HTTP status code returned by the component when SendResponse is called. By default the component will return a HTTP status code of 200.

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.

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 component 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 component will throw an exception. The default value is False.

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.

TransferredHeaders: The HTTP headers of the incoming request.

After calling ParseRequest this will contain the full HTTP headers of the incoming request.

TransferredData: The full body of the incoming request.

After calling ParseRequest this will contain the full body of the incoming request.

SignatureAlgorithm: Signature algorithm to be used in outgoing messages.

Signature Algorithm can be set to md5 or sha1, to indicate the preferred signing algorithm.

Base Configuration Settings


	GUIAvailable: Tells the component whether or not a message loop is available for processing events. In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.
	UseBackgroundThread: Whether threads created by the component are background threads. If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.
	UseManagedSecurityAPI: Tells the component whether or not to use the system security libraries or a managed implementation. By default the component will use the system security libraries to perform cryptographic functions. This means calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal managed implementation instead of using the system's security API. Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file.