Skip to main content
Skip table of contents

Getting started with NoSQL Database Offer History Definitions


A grid is displayed, listing all existing NoSQL database offer history definitions:

Within the grid, the following read-only columns are displayed (see below for property details)

  • Name

  • Collection Name

  • Default

  • Queue Default

  • State: one of Added, Edited, Deleted or Unchanged.

When no NoSQL database offer history definitions have been configured, an advisory message is displayed.

Selected NoSQL Database Offer History Definition Details

This section displays the details of the NoSQL database offer history definition selected currently in the list. If no definitions have been configured, an advisory message is displayed.

The sections contains a tabset, which contains Details and Metadata tabs

The Details tab contains the following properties:

  • Name: the unique name used to identify the definition. Name is mandatory, can be a maximum of 100 characters in length, and must be unique across all definitions.

  • Description: an optional property that can be a maximum of 1000 characters in length.

  • Default NoSQL DB offer history definition: this checkbox allows you to specify whether the current definition is the default. The default NoSQL database offer history definition is selected automatically when creating an audience in a NoSQL environment. The checkbox is unchecked by default. Only one definition can be selected as the default.

  • Offer history collection name: this mandatory, 100-character text field represents the name of the NoSQL database collection in which offer history data is to be persisted.

  • NoSQL DB collection definition: this dropdown property lists all existing NoSQL database collection definitions, and allows you create a link between the offer history definition (which defines data to be written at execution) and the collection definition (which defines from where data is sourced for targeting purposes). By default, no value selected, and selection of a value in this context is mandatory.

  • Attributes: this property allows you to define extra attributes added to be added to the offer history collection in addition to a unique key. You can drag parameter attributes only from the toolbox and add them to the list. A warning is thrown if you attempt to add the same attribute more than once. Also, a validation error is raised at Save if you attempt to add a non-top-level attribute in this context.

  • Global contact rule: this property represents a filter that is always applied when an audience based on the current definition is executed. In this way, you can ensure consistency of targeting by limiting your global audience scope in accordance with the selected rule's configuration. The property is set using a NoSQL selection rule only, and its provision is optional. Auxiliary NoSQL selection rules are supported. You can populate the property using browse or drag and drop. You can also initiate the creation of a new NoSQL selection rule with which to configure the property. Once populated, you can open the latest version of the NoSQL selection rule in the Rule Designer. You can also clear your selection.

  • Attribute folder: this RPI folder is used to persist automatically-generated parameter attributes which expose the data stored in the collection. At save, offer history attributes are created in the selected folder, in accordance with their definition in the Metadata tab. A States subfolder is created within the same context, containing the following attributes:

    • Metric Value

    • State Detail

    • State Name

    • Timestamp

These are used to persist channel state information, as returned by the channel sync task.

  • Run fulfilment queries in test mode: a checkbox, which is unchecked by default. If the property is checked, when the current definition is used during interaction workflow execution in Test mode, all queries that select attributes for fulfilment content will be executed. This will provide a more accurate impression of the time that might be expected to be taken at Production workflow execution. When checked, 'Testing fulfilment queries' entries will appear in the workflow's query trace.

  • Queue Listener section: containing the following properties:

    • Use for queue listeners: this checkbox allows you to specify whether the definition is to be used to support queue listeners. It is unchecked by default. When checked, the following properties are hidden:

      • NoSQL DB collection definition

      • Attributes

      • Global contact rule

The following property shown is shown instead:

Listener collection name

Listener collection name: this mandatory text property accepts a maximum of 100 characters and allows you to specify the name of the NoSQL database collection in which queue listener data is to be persisted.

The Metadata tab is only shown if Use for queue listeners is unchecked.

It is behaviorally identical to the equivalent tab in the Audience Definition configuration interface. For more information, please see that interface’s documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.