Page Comparison

The Custom entities module allows platform users to extend factory entities and introduce new entities in the loyalty program management. This way, the range of data fields that Antavo can store and provide through APIs upon request can be widened.

...

• Click the ‘Edit’ button of the entity that you’d like to add a new attribute to

• Click the ‘Create new attribute’ button in the sidebar on the left

• Add a label – the human-readable name of the entity that is the displayed name of the attribute in the Antavo Backoffice that is accessible through the API as well
  Tip: by defining the label of the attribute as ‘label’, you can store the name value of a specific entity in an attribute that is called ‘label’

• Define the unique ID of the attribute – this has to be a machine-readable ID of the attribute that can be used to refer to the attribute in the Antavo APIs

• Write the description of the attribute

• Select the field type
  Select the type of data that is stored in the field. When sending the data through API, 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
    Choose this attribute type to upload images (png, jpeg, jpg type files) to any entity.
    Once saved, an image can be uploaded in the new field type (for example, a secondary image for a Reward).

  • Reference
    Use this type to tie the entity to an individual customer profile. When the reference type attribute is populated with a customer ID, the entity with all its attributes will appear on the corresponding entity tab of the profile of the referenced customer.
    This attribute type is not available for built-in entities and currently, only the customer reference is applicable.

  • Translatable

    Anchor
    translate translate

    
    Challenge entities can be expanded with translatable-type attributes to support multilingual sites. The configuration field of the attribute will appear in the challenge editor with a ‘Translate’ button. Use it to enter values for all languages added in the Multi-language module, so that you can query the translations through the Entities API to apply them on your website.

• Add a default value (only applicable for String, Numeric, Boolean and Url type attributes)
  You can enter a default value for entity fields.
  After the new entity attribute is activated, the default value will be automatically populated in all the entity items.

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

• Anchor
  tag tag

  Add tags, if necessary
  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 Entities API if it is included in the request (fields=<attribute>)
    In case you’d like to include the field without requesting it explicitly, please use the ‘Default API field’ checkbox described below.

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

  • importable - the value of the field can be updated through the Imports module

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

  • Anchor
    filterable filterable

    filterable - the field can be used as a filter condition when requesting customer data through the Entities API and filtering the list of entities on module configuration pages

  • unique - the same field value can only be registered once

...

• Click ‘Extend’

• Click the ‘Save’ button on the entity editor interface
  You can choose to edit the label and the description of the entity here.

...