1. Description
Allows configuring the structure of fields in a custom lookup (Fig. 1).
Important! This tab becomes available only after saving data in the General tab.
The tab consists of the following elements (Fig. 1):
-
Columns registry (Fig. 1.(1));
-
Save button (Fig. 1.(2));
-
Close button (Fig. 1.(3));
-
Search field (Fig. 1.(4));
-
Add column tool (Fig. 1.(5));
-
Delete tool (Fig. 1.(6)).
1.1. Columns registry
The registry (Fig. 1.(1)) displays a list of all columns in the lookup:
-
Checkbox column;
-
Title column;
-
Type column;
-
Position column;
-
Move tool;
-
Edit tool;
-
Deletion tool.
After creating a lookup, the system automatically adds the following base fields:
-
ID;
-
Created on;
-
Created by;
-
Modified on;
-
Modified by;
-
Name;
-
Description.
Important!
-
System columns cannot be edited or moved, except for the Description column and any manually created columns.
-
System columns can be deleted only via the checkbox.
1.1.1. Checkbox column
Used to select one or more entries. An additional removal tool appears next to the search field after selecting one or more entries. Information about the number of entries chosen for deletion appears when you hover over this tool. When you click on it, a modal confirmation window appears.
It contains the Yes, No, and close (
-
Clicking the Yes button deletes the entries.
-
Clicking the No button closes the modal window, and the entries are not deleted.
All records on the page will be selected if you select the checkbox in the header.
Fig. 2. Confirm deletion modal window
1.1.2. Title column
Displays the name of the column that will be shown to users in the lookup.
-
For system columns, the title is predefined and cannot be changed.
-
For custom columns, the title is set during creation or editing.
1.1.3. Type column
Shows the type of data that will be stored in the column.
1.1.4. Position column
Displays the sequential order number of the column in the table.
-
For custom columns, the position can be adjusted manually using the move tool.
-
The position defines the display order of columns in the lookup form.
Important! The position of system columns cannot be changed.
1.1.5. Move tool
The icon
1.1.6. Edit tool
The icon
1.1.7. Delete tool
The icon
1.2. Save button
After making changes, click the Save button (Fig. 1.(2)). Without clicking the button, the changes are not saved.
1.3. Close button
The Close button (Fig. 1.(3)) exits the tab and returns the user to the Custom lookups tab.
1.4. Search panel
The search field (Fig. 1.(4)) allows you to quickly find a column by its title.
1.5. Add column tool
To create a new column, click the icon
A modal window Add column (Fig. 5) will open. It contains the following elements:
-
Title field;
-
Code field;
-
Type field;
-
Object field;
-
Required switch;
-
Default value field.
-
The Add button creates a new column and adds it to the configuration.
-
The Close button closes the window without saving changes.
1.5.1. Title field
Required field, the name of the field.
1.5.2. Code field
Required field. A unique identifier that may include only Latin letters (A–Z, a–z) and digits (0–9) and must start with a letter.
Important! Reserved system values must not be used:
-
bool;
-
bytes;
-
double;
-
null_type;
-
int;
-
list;
-
map;
-
string;
-
type;
-
uint.
If one of these values is entered, the system will display an error and will not allow the column to be saved.
1.5.3. Type field
Required field. A parameter that defines the data format stored in the column. Available options:
-
Text — a field for text values;
-
Number — a field for numeric values;
-
Select — a list allowing the user to choose only one value;
-
Multiselect — a list allowing multiple values;
-
Calendar — a field for selecting a date;
-
Boolean — a switch that allows you to set two states: enabled
/ disabled
.
1.5.4. Object field
Selection of another lookup whose values will be used when filling this field.
Displayed only if the Type parameter is set to Select or Multiselect.
1.5.5. Required switch
The switch is displayed after selecting the field type (except for the Boolean type).
Enabling the switch
1.5.6. Default value field
Displayed after enabling the Required switch.
The field is mandatory to fill in.
The default value type corresponds to the selected custom field Type (text, number, select, multiselect, calendar).
Default value application logic:
-
for existing lookup records where the required field is not filled in, the default value is automatically applied;
-
for existing lookup records where the field is already filled in, the current value is preserved and not changed;
-
for new lookup records, the default value is automatically applied when the record is created.
1.6. Delete tool
Used to delete a column with confirmation via a modal window. It becomes active after selecting the checkbox next to a column.
When hovering over the delete button
Clicking Yes deletes the column and all its records. Clicking No closes the modal window without deleting the column.
2. Opportunities
2.1. Add column
|
Goal |
Add a new column |
|---|---|
|
Preconditions |
|
|
Steps:
|
|
|
Result |
The modal window closes. The data is saved. The column is added to the registry. |
2.2. Delete column
|
Goal |
Delete a column |
|---|---|
|
Preconditions |
|
|
Steps:
|
|
|
Result |
The modal window closes. The column is deleted. |
2.3. Delete several columns
|
Goal |
Delete several columns |
|---|---|
|
Preconditions |
|
|
Steps:
|
|
|
Result |
The modal window closes. The selected columns are deleted. |
2.4. Edit column
|
Goal |
Edit a column |
|---|---|
|
Preconditions |
|
|
Steps:
|
|
|
Result |
The data is saved. |