RecordHistory

Commerce Server 2000

Use this component to record the identifiers of the winning content items in the history list string.

Although the component appears as RecordHistory in the Pipeline Editor, its ProgID is Commerce.CSFRecordHistory.

Intended use: Content Selection pipeline, Record stage.

Configuration Values

You can determine how many items the RecordHistory component saves in the string by setting component properties. Use the following box on the Record History tab of the Component Properties dialog box to determine this information.

BoxDescription
Maximum number of items to store in history stringNumeric. The maximum number of items saved in the history string. The default is 35.

Values Read

The RecordHistory component reads the following values from the indicated dictionaries.

KeyDictionaryDescription
_historyOrderThe history string retrieved by the LoadHistory component.
_winnerindexesOrderA SimpleList object containing the ContentList object indexes of the winning content items.

If this entry is present, the _winners key should not be present. If both are present, only this key is used.

_winnersOrderA SimpleList object containing the values from the item_id keys of the winning content items.

If this entry is present, the _winnerindexes key should not be present. If both are present, only the _winnerindexes key is used.

_contentOrderThe item_id key for the various content items contained in the ContentList object referenced by the _content key.

The item_id key is automatically looked up if the _winnersindexes key is passed instead of the _winners key.


Values Written

The RecordHistory component writes the following values to the Order dictionary.

KeyDescription
_historyThe updated history list string.

Remarks

The RecordHistory component is responsible for managing the size of the history list and truncates it when necessary. The component removes the oldest entries from the string when it exceeds the maximum length.

The property page for the RecordHistory component allows the maximum number of entries in the history to be configured. This component trims the least recent history list entries, as necessary, to assure that this limit is not exceeded.

See Also

ContentList Object

SimpleList Object


All rights reserved.
Show: