RAPStore Subscriber XML Element Descriptions

Configure the RAPStore subscriber using the three configuration files located in the RAPStoreSubscriber/config folder: opensubscriber.xml, messagefilter.xml and rapstore.xml.

Warning!

Shut down the RAPStore subscriber before modifying any of its configuration elements.

The opensubscriber.xml file contains publisher-subscriber communication information.

Configurable Elements Of Opensubscriber.xml
Element	Description
OpenSubscriber	Root element for the configuration file.
Logger	Settings for logging activities.
LogLevel	The level of logging. Valid values are: Error – Log only errors. Warning – Log warnings and errors. Info – Log informational messages in addition to messages logged at the warning level. Debug – Log debugging messages in addition to messages logged at the info level.
LogFile	Name and location of the log file. The file name can be relative or a full path.
TemplateDir	Directory where the message templates are located.
DataStreamHandlerConfig	File to use for data stream handler configuration.
NumPacketBuffers	Number of network packet buffers to create per data channel. The size of one buffer is about the size of the MTU of the network interfaces being used. A larger number of packet buffers means that a larger burst of traffic can be handled without requiring resends. This setting can have a value from 1 - 4294967296.
PacketWindowSize	The number of packets are tracked for resend purposes. This setting can have a value from 1 - 4294967296. The value should be 80 - 90% of the publishers NumPacketBuffers.
LatencyCheckInterval	Determines how often (in seconds) the network latency between publisher and subscriber is checked. This setting can have a value from 1 - 65535.
FlushInterval	Indicates how long (in milliseconds) a data channel can sit idle before a check is made for dropped packets. This setting can have a value from 1 - 65535.
AdminChannel	Information about the administration channel, which accepts requests for version information, statistics, and shutdowns.
LocalInterface	Local interface that the publisher uses to monitor administrative requests.
AdminPort	Port number used by the UAF agent to communicate with the subscriber. The subscriber listens for incoming administration requests on this port.
MaxConnections	Number of concurrent connections to the AdminChannel. Defaults to 10. Valid values are of 1 - 65535.
DataStreamChannelList	List of data stream channels from which the subscriber receives messages. Either all or none of the channels for a given publisher should be present. Channels from multiple publishers may be present, and there can be up to 255 data stream channels.
DataStreamChannel	Contains information for one publisher data stream channel.
LocalInterface	IP address of a network interface on the local machine that will receive the messages.
PublisherName	Contains a publisher name for each unique publisher, and is used to identify the publisher.
ChannelName IPAddress Port	These elements should have the same values as in the corresponding channel in the publisher. ChannelName is a descriptive name for the publisher data stream channel. IPAddress is the UDP multicast address used by the publisher's data stream channel for sending the messages over the network. Port is the local port used by the publisher's data stream channel to send messages over the network using UDP multicasting.
PublisherList	Contains one entry for each unique publisher used by the subscriber. The list can contain publisher entries that are unused in the DataStreamChannel definitions, however, this consumes resources and may decrease performance.
Publisher	Information about each unique publisher being used by the subscriber.
PublisherName	Corresponds to the PublisherName used in the DataStreamChannel definitions.
IPAddress	IP address or host name of the machine hosting the publisher.
ResendPort	Must have the same value as the publisher's ResendPort definition in publisher.xml.

The opensubscriber.xml file contains publisher-subscriber communication information.

Configurable Elements Of Opensubscriber.xml
Element	Description
OpenSubscriber	Root element for the configuration file.
Logger	Settings for logging activities.
LogLevel	The level of logging. Valid values are: Error – Log only errors. Warning – Log warnings and errors. Info – Log informational messages in addition to messages logged at the warning level. Debug – Log debugging messages in addition to messages logged at the info level.
LogFile	Name and location of the log file. The file name can be relative or a full path.
TemplateDir	Directory where the message templates are located.
DataStreamHandlerConfig	File to use for data stream handler configuration.
NumPacketBuffers	Number of network packet buffers to create per data channel. The size of one buffer is about the size of the MTU of the network interfaces being used. A larger number of packet buffers means that a larger burst of traffic can be handled without requiring resends. This setting can have a value from 1 - 4294967296.
PacketWindowSize	The number of packets are tracked for resend purposes. This setting can have a value from 1 - 4294967296. The value should be 80 - 90% of the publishers NumPacketBuffers.
LatencyCheckInterval	Determines how often (in seconds) the network latency between publisher and subscriber is checked. This setting can have a value from 1 - 65535.
FlushInterval	Indicates how long (in milliseconds) a data channel can sit idle before a check is made for dropped packets. This setting can have a value from 1 - 65535.
AdminChannel	Information about the administration channel, which accepts requests for version information, statistics, and shutdowns.
LocalInterface	Local interface that the publisher uses to monitor administrative requests.
AdminPort	Port number used by the UAF agent to communicate with the subscriber. The subscriber listens for incoming administration requests on this port.
MaxConnections	Number of concurrent connections to the AdminChannel. Defaults to 10. Valid values are of 1 - 65535.
DataStreamChannelList	List of data stream channels from which the subscriber receives messages. Either all or none of the channels for a given publisher should be present. Channels from multiple publishers may be present, and there can be up to 255 data stream channels.
DataStreamChannel	Contains information for one publisher data stream channel.
LocalInterface	IP address of a network interface on the local machine that will receive the messages.
PublisherName	Contains a publisher name for each unique publisher, and is used to identify the publisher.
ChannelName IPAddress Port	These elements should have the same values as in the corresponding channel in the publisher. ChannelName is a descriptive name for the publisher data stream channel. IPAddress is the UDP multicast address used by the publisher's data stream channel for sending the messages over the network. Port is the local port used by the publisher's data stream channel to send messages over the network using UDP multicasting.
PublisherList	Contains one entry for each unique publisher used by the subscriber. The list can contain publisher entries that are unused in the DataStreamChannel definitions, however, this consumes resources and may decrease performance.
Publisher	Information about each unique publisher being used by the subscriber.
PublisherName	Corresponds to the PublisherName used in the DataStreamChannel definitions.
IPAddress	IP address or host name of the machine hosting the publisher.
ResendPort	Must have the same value as the publisher's ResendPort definition in publisher.xml.

The messagefilter.xml file contains message filtering information for the subscriber.

Configurable elements of messagefilter.xml
Element	Description
MessageFilter	Root element for the configuration file.
RuleList	List of message filtering rules.
Rule	Contains information about a message filtering rule. This element contains one MessageType element and zero or one FieldRule elements.
MessageType	Type of the message to include/exclude.
RuleType	Determines the message filtering rule type. Valid values are include: if the rule holds true, include the message and exclude: if the rule holds true, exclude the message.
FieldRule	Conditions for rules on a particular message field.
FieldName	Name of the field to include/exclude when the value of the field matches FieldValue.
FieldValue	Value of the field to match. If the value is a time, the format of the value must be hh:mm:ss or hh:mm:ss.sss. If the value is a date, the format must be YYYY-MM-DD. If the value is a DateTime, then the format must be YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ss.sss.

The messagefilter.xml file contains message filtering information for the subscriber.

Configurable elements of messagefilter.xml
Element	Description
MessageFilter	Root element for the configuration file.
RuleList	List of message filtering rules.
Rule	Contains information about a message filtering rule. This element contains one MessageType element and zero or one FieldRule elements.
MessageType	Type of the message to include/exclude.
RuleType	Determines the message filtering rule type. Valid values are include: if the rule holds true, include the message and exclude: if the rule holds true, exclude the message.
FieldRule	Conditions for rules on a particular message field.
FieldName	Name of the field to include/exclude when the value of the field matches FieldValue.
FieldValue	Value of the field to match. If the value is a time, the format of the value must be hh:mm:ss or hh:mm:ss.sss. If the value is a date, the format must be YYYY-MM-DD. If the value is a DateTime, then the format must be YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ss.sss.

The rapstore.xml file contains configuration information specific to the RAPStore subscriber.

RAPStore subscriber elements of rapstore.xml
Element	Description
StoreDSH	Root element for the configuration file.
WorkDB	Gives the connection information for the RAPStore database and is used to persist information about files awaiting loading into the RAPStore database.
WorkDBServer	Name of the machine hosting the WorkDB database.
WorkDBPort	Port number for WorkDB database.
WorkDBUser	User name for connecting to the WorkDB database.
WorkDBPassword	Password for connecting to the WorkDB database.
StoreDB	Gives the connection information for the RAPStore database and is the database which used to store the messages processed by RAP.
StoreDBServer	Name of the machine hosting the RAPStore database.
StoreDBPort	Port number for RAPStore database.
StoreDBUser	User name for connecting to the RAPStore database.
StoreDBPassword	Password for connecting to the RAPStore database.
PrimaryFileLocationList	This element contains one or more PrimaryFileLocation elements. The PrimaryFileLocationList allows RAP to take advantage of multiple disks in order improve the file read/write performance.
PrimaryFileLocation	Points to a directory where the generated binary files (containing messages received from publishers) are written so messages are loaded into the RAPStore database. This directory should be on a different disk/controller than the RAPStore database devices and require enough free space to hold any generated binary files that have not been loaded yet during the day.
OverflowFileLocation	OverflowFileLocation is used only used when the PrimaryFileLocation is full. It should be on a different disk/controller than both the RAPStore database devices and the PrimaryFileLocation.
IOBufferSizeMB	Specifies the size, in megabytes, of each internal I/O buffer used to store messages received from the publishers before the messages are written to file. Each table referenced in the message templates has the number of I/O buffers specified in the Number of IO Buffers option. Larger buffers may result in better throughput for writing the messages to disk, but also consume more memory.
NumIOBuffers	Number of I/O buffers created per table. Use the value of 3.
TargetFileSizeMB	Maximum size of a generated binary file in the file system. The file size should be a multiple of the I/O buffer size. Larger binary files require more memory in the RAPStore database and take longer to load.
IdleBufferWriteDelaySec	Number of seconds data can be present in an opened and idle generated binary file before being written out and made available for loading into the RAPStore database.
BufferAgeLimitSec	Forces the loading of any data which has been in existence longer than the time limit. The default value for this parameter is 600 (10 minutes). This value cannot be lower than 1 or greater than 65535.
DisableLoadRIInterlink	(Optional) Tells the RAP Store Subscriber data loader whether to disable referential integrity checking on data files generated by the high-speed derived data transfer mechanism. True – Disables referential integrity checking False – (Default) Enables referential integrity checking. Disabling referential integrity checking allows the RAPStore database to improve load performance by omitting checks for primary and foreign key consistency. You must decide if these checks can safely be omitted based on the origin and nature of the data being loaded. Loading data that does not meet referential integrity checks may result in inconsistent and incorrect results from RAP Store queries. The default rapstore.xml file specifies this tag and sets it to false.
DisableLoadRIMarketData	(Optional) Tells the RAP Store Subscriber data loader whether to disable referential integrity checking on data files generated by the publisher/subscriber mechanism. True – Disables referential integrity checking False – (Default) Enables referential integrity checking. Disabling referential integrity checking allows the RAPStore database to improve load performance by omitting checks for primary and foreign key consistency. You must decide if these checks can safely be omitted based on the origin and nature of the data being loaded. Loading data that does not meet referential integrity checks may result in inconsistent and incorrect results from RAP Store queries. The default rapstore.xml file specifies this tag and sets it to false.