The Record Store supports the configuration properties listed in the table below.

Configuration Property

Value

btreePageSize

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

The number of children per btree node. This value must be greater than 0. The default is 100.

The Record Store validates that the btreePageSize property is greater than 0. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.

changePropertyNames

The changePropertyNames configuration property specifies which record properties to examine when determining whether a record has changed.

The changePropertyNames configuration property is useful because it allows you to specify exactly which record properties are evaluated to determine if that record has changed between crawls (in other words, if the record is different from the previous generation's record in the Record Store instance).

If not specified, the value of changePropertyNames defaults to all the properties on a record.

If you choose to specify the value changePropertyNames, here are several suggested properties:

If you are gathering native file system properties for file system crawls, you can also use the ACL properties as change properties.

cleanerInterval

The cleanerInterval property specifies how often (in hours) the Record Store Service checks for stale generations of records in a Record Store. (A stale generation is defined by the generationRetentionTime property.)

This value of cleanerInterval must be greater than or equal to 0. If not specified, the value defaults to 1 hour.

Fractional values (like 0.1) can be specified if you want the service to check more frequently than once per hour. A value of 0 (zero) does not check for stale generations.

dataDirectory

The dataDirectory property specifies the location where the Record Store’s data files are stored.

The value of the dataDirectory property can either be an absolute path or a path relative to the directory where the Record Store is running. If not specified, the value defaults to <install path>\CAS\<version>\workspace\state\<Record store name>. This directory is created when a Record Store instance is created if it does not already exist.

The Record Store service validates that the dataDirectory property specifies a directory for which the user running the CAS Service has write permissions.

duplicateRecordCompressionEnabled

The duplicateRecordCompressionEnabled property has been deprecated in 3.1.2, so this property is ignored.

The duplicateRecordCompressionEnabled property specifies whether to store new versions of records whose change properties have not changed. Enabling this feature improves Record Store performance and decreases Record Store disk space.

The duplicateRecordCompressionEnabled property takes a Boolean value: true does not store duplicate copies of records, and false stores duplicate copies of records.

If not specified, the value defaults to false.

generationRetentionTime

The generationRetentionTime property specifies how long (in hours) a record generation should remain in a Record Store instance before it is considered a stale generation. The next time the cleanerInterval value is reached, then stale generations are deleted from the Record Store.

However, the Record Store does not remove the most recent generation even if it exceeds the value of generationRetentionTime, and the Record Store does not remove the last generation specified with the set-last-read-generation task for a client ID.

Fractional values (like 0.1) can be specified if you want a generation to be maintained for less than an hour. If not specified, generationRetentionTime defaults to 48 hours (two days).

The Record Store validates that the generationRetentionTime property is greater than or equal to 0. If set to 0, the Record Store instance only stores the latest (single) generation after the clean up.

idPropertyName

The idPropertyName property specifies the source property from which the record ID is derived. This value must be a non-empty string. If not specified, it defaults to Endeca.Id.

When selecting a record property as the idPropertyName, you should choose a property that is present on every record and whose value is unique to each record. That is, all records (except those tagged with Delete All) must have a single unique non-null value for this property.

The uniqueness of the property value is important because if two records have the same idPropertyName property value, the second record that is processed overwrites the first one in the Record Store.

The Record Store validates that the idPropertyName property is a non-empty string. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.

ignoreInvalidRecords

The ignoreInvalidRecords property specifies how invalid records are handled.

Invalid records are records with missing IDs (either the idPropertyName property is missing or it has a null value) or with invalid action types for the Endeca.Action property.

The ignoreInvalidRecords property takes a Boolean value:

In either case, invalid records are not added to the Record Store. If not specified, the value defaults to true.

During the development stage of your Record Store application, you may want to set the ignoreInvalidRecords property to false so that an InvalidRecordFault exception is thrown whenever an invalid record is processed. This allows you to immediately see if your source records have the appropriate properties. Once you go into production, you can change the property to true and monitor the logs for warning messages about invalid records.

indexWriteFlushInterval

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

This value must greater than 0. The Record Store validates that the indexWriteFlushInterval property is greater than 0. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.

jdbmSettings

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

maxDataFileSize

The property maxDataFileSize has been removed in version 3.1.2 and later.

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

This value must be greater than 0. The default value is 2 GB.

The Record Store validates that the maxDataFileSize property is greater than 0. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.

mergeBufferSize

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

This value must be greater than 0. The default value is 131072 bytes. The Record Store validates that the mergeBufferSize property is greater than 0. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.

recordCompressionEnabled

The recordCompressionEnabled property specifies whether records are stored on disk in a compressed format.

The recordCompressionEnabled property takes a Boolean value:

If not specified, the value defaults to false.

writeBufferSize

Oracle Commerce Internal Use. Oracle Commerce does not recommend modifying this property.

This value must be greater than 0. The default value is 104857600 bytes. The Record Store validates that the writeBufferSize property is greater than 0. If this property is not correctly set, RecordStore.setConfiguration() throws a RecordStoreConfigurationException.


Copyright © Legal Notices