Common attributes

You can define action attributes that can be included in requests sent to the Events API as an attribute of any event, including factory and custom events.

Find the configuration page by opening the Modules menu and searching for the ‘Common attributes’ module in the list. The page will open to the list of attributes that have been added with the following information:

• Name of the attribute

• Unique ID of the attribute

• Data type

Open

Create new attributes

Basic settings

• Click the ‘Create a new attribute’ option in the sidebar

• Define the unique ID
  The machine-readable ID of the attribute that needs to be referenced when sending API calls.

• Add a label
  The listing name of the attribute across the interface of the Backoffice, including workflows and customers' event streams.

• Add a description
  The description serves informative purposes in the Backoffice, reminding the user what the attribute is used for.

• Select the field type
  Select the type of data that is stored in the attribute. When sending the data through API, please make sure that it is sent in the format required by the selected type, otherwise, the API request will fail.

  • String

  • Numeric

  • Boolean

  • Select
    Add the selectable options by defining possible values.

  • URL

  • Date

  • Datetime

  • Multiple choice
    Add the selectable options by defining possible values.

  • List

  • Image

• Add a default value (only applicable for String, Numeric, Boolean and Url type attributes)
  You can enter a default value for event fields.
  After the new event attribute is saved, the default value will be automatically populated in all the events that will be registered moving forward if no value is provided in the API request.
  Please note, that as events are WORM (Write Once-Read Many) objects, the field values cannot be populated with any default value that was configured after the event has been registered.

• Format (only applicable for String and List types of fields)
  The format of String and List types of values can be further specified to Date, URL, Email, Phone number formats, the API will validate the values accordingly.

• Tags
  Tags define the ways how attributes can be accessed and managed in the system.

  • API - the field is included in the response returned by the History endpoint of the Display API

  • searchable - the value of the field can be used as a search condition when requesting customer data through the Display API

  • importable - the value of the field can be populated through the Imports module
    Please note, that as events are WORM (Write Once-Read Many) objects, the field values cannot be modified after the event has been registered.

  • groupable - the data values of the field can be grouped together when configuring charts to be displayed on the Dashboard

  • filterable - the field can be used as a filter condition when requesting customer data through the Display API, find further information about filtering here

  • unique - the same field value can only be registered once, the value cannot be saved to the same field of any other customer

• Access Level
  Select the access level that should apply to the event field. Users without the defined level of access cannot add and/or view this attribute through the Events tab of Customer Insights.
  Read more about access levels here.

Open

Data and privacy controls

• Required
  Tick the checkbox to make this attribute required for all events.

Don’t forget to click ‘Save’ at the bottom of the page.

Edit attributes

• Navigate to the Common attributes module configuration page

• Click the ‘Edit' button of the attribute that you’d like to edit

• Edit attribute settings. settings

• Click ‘Save’ before leaving the page

Archive attributes

• Navigate to the Common attributes module configuration page

• Click the ‘Edit' button of the attribute that you’d like to archive.

• Click the ‘Archive’ button in the upper right-hand corner.

• Confirm your decision in the dialog that appears.

Please note, that archiving is an irreversible action.