Fields
Last updated
Last updated
In the Platform, it is possible to manage a set of the following fields in objects:
Customer;
Transaction/receipt;
Transaction line;
Product;
Category.
The Fields section displays the list of fields in the Platform.
The fields are combined into groups. For example, fields of the Customer object are divided into groups:
Customer;
Contacts;
Bonuses;
Scoring.
For each field, the following is displayed:
Name: name of the field that users see;
Field code (system name): field name, which is used for accessing it via REST API;
Field type (line, integer, date, etc.);
System/User:
System fields are initially present in the system;
User fields are fields, created by user.
User fields can be edited and deleted. For system fields, limited editing functionality is available, such fields cannot be deleted.
You can change the order of fields and groups of object by dragging and dropping them.
Fields in the segment builder are displayed in the same order as in the field list.
The order of fields in the customer profile is set through the customer profile view settings. For more information, see the Managing views article.
Filtering by field name is available:
You can hide Transactions/Receipts and Transaction lines objects in a customer profile.
To hide transactions, click Hide transactions in the Transactions tab:
Orders block in the customer profile when transactions are visible:
When transactions are hidden, the Orders block is not displayed in the customer profile:
To hide transaction lines, click Hide transaction lines in the Transaction lines tab:
Transaction lines are displayed when you click on the receipt number in the Orders tab of the customer profile.
Receipt when transaction lines are visible:
Receipt when transactions lines are hidden:
You can add new group of fields by clicking the Add group button:
For a group of fields, you must specify a name:
You can add new field by clicking the Add field button:
Field properties should be filled out:
Fields can have different properties depending on the field type. It is necessary to fill out the general properties of the field and the properties inherent to its type:
Group name: to what group of fields this field belongs;
Field name: name of the field that users can see;
Field code: system name of the field, used for addressing to it via REST API;
Description;
Type of data:
Operators. For some fields not all operators are relevant. For example, only these operators are relevant for field “gender”:
These operators, in particular, will be displayed in the segment builder when the condition for this field is formed:
Visible field.
Visible field will be displayed in the customer profile and in the segment builder.
Invisible fields are displayed in light gray in the list of fields.
Show in summary tables. Allows you to use the field in summary tables in the Analytics – Reports section. For example, to use the customer attribute City in the summary table of receipts, follow these steps:
In the Customers section, go to editing the City field:
2. In the Show in summary tables section, check the Receipts/Transactions box:
Type: field/metrics
An additional property is available for integer fields: Element of management:
Each element of management has its own set of additional properties.
You can enter the following value in the input field:
The following additional properties are available for input fields:
Minimum value;
Maximum value;
Increment: value of the field can be incremented by this parameter;
Default value: this value will be automatically displayed in the segment builder.
Control element: value
In the field you will be able to select an option from the list.
The following additional fields are available:
Type of view;
A set of options.
There are two possible variants for the Variant set field:
The List of options allows you to specify possible field values directly in the field settings.
Data from database allows you to select a value from the database in a field. For example, the segment builder will compile a list of all unique values that are stored in the database in this field and display them.
Possible views:
Drop-down list;
Autocomplete: when you enter a value, all suitable variants are offered;
Radio buttons;
Control element: directory
In this field you will be able to select a variant from the directory.
The following additional fields are available:
Type of view;
Directory.
Possible types of view are described above (for fields with control element: value):
Drop-down list;
Autocomplete;
Radio buttons.
The following variants are available in the Directory field:
If required directory exists in the Platform, you must specify its name in the Directory name field.
For more information about directories, see Settings directories.
If the Platform doesn't have required directory, you should create a new one, specify its name and code. The code will be used to access directory via API.
You can fill out and edit directory in the Settings --> Directories section.
The following additional properties are available for fractional fields:
Minimum value;
Maximum value;
Increment: value of the field can be increased by this parameter. For example, if minimum field value is "1", maximum - "2" and increment "0.5", the field can take values: "1", "1.5", "2";
Default value: this value will be automatically displayed when generating a query in the segment builder.
or "string" type fields an additional property, Control element, is available:
Each control element has its own set of additional properties.
Additional properties:
Maximum length: limit on the length of the field value;
Default value.
In this field you will be able to select a variant from the list. For more information about configuring additional fields, see Control element: value section.
In this field you will be able to select variant from the list. For more information about configuring additional fields, see Control element: directory section.
For “date” type fields, the Add field with distance to date property is available.
The field with distance to the date allows you to calculate how much time has passed since that date.
The field will be displayed in the customer profile;
The field can be used when building queries in the segment builder.
For example, there is a field Wedding date. Let's add an additional field: Days since wedding date:
The new field can be used in the segment builder:
"Logical" type fields have no additional properties.
Only three operators are available for fields of this type:
Equal;
Empty;
Not Empty.
To edit group of fields, click the edit button to the right of the group name:
You can edit only the name of the group.
You can edit field using the edit button to the right of the field name:
In user field, all properties described in the Adding fields section are editable. In the system field, only some of the properties are editable:
You can delete group of fields by clicking the delete button to the right of the group name:
You can delete only the group that has no fields.
You can delete field by clicking the delete button to the right of the field name:
Only user fields can be deleted. A system field cannot be deleted.
