Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
There are two types of objects in the system: tables and columns. Tables consist of columns . Both of these objects can be created via the agent interfacethat store different information depending on the type.
Tip |
---|
Role required: admin. |
You can create a column in two ways:
- via table forms.
- by adding a record to the All Columns (sys_db_column) table.
Info |
---|
Columns You can be added add columns only to existing tables. |
To create a column via a table form, complete the following steps:
- Navigate to System Definition Settings→ All Tables.
- Choose Open the table you need to add a column to.
- Scroll down to In the Related Lists area and , select the Column Columns tab.
- Click New and fill in the formfields.
- Click Save or Save and Exitexit to apply the changes.
To create a column record in the All Columns table, complete the following steps below:
- Navigate to System DefinitionSettings → All Columns.
- Click New and fill in the formfields.
- Click Save or Save and Exitexit to apply the changes.
Column attributes
Tip |
---|
A column can be configured from any form it is displayed on. To do so, complete the following steps:
|
Column form fields
FieldAttribute | Mandatory | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Table | Y | Specify the table in which the column should be created. If this table has child tables, then this column will also be added to them. This field references to the the Tables (sys_db_table) dictionary. After the record is saved, this field becomes read-only. | ||||||||||||||
Column typeColumn Type | Y | Specify a column type. The column type specifies the type of the data stored. Depending on the type selected, additional tabs or fields may appear on the form (see below). For more information, refer to the See Column Types article to learn more. After the record is saved, this field becomes read-only. | ||||||||||||||
Title | Y | Specify a column title displayed onin the forminterface. It should be sensiblemeaningful and human-readable. You can use Latin or Cyrillic letters, [0..9] numbers and the underscore symbol ( _ ). The Title field can be translated to other languages. | ||||||||||||||
Column name Anchor |
| Y | System column name. This field is populated automatically, depending on the title entered Title entered, and becomes read-only after the record is saved. Latin letters, [0..9] numbers, and the underscore symbol ( _ ) are allowed. The system name must begin with a letter. System column names are used in scripts.
| |||||||||||||
Comments | N | Put Add some comments here describing that describe the column. | ||||||||||||||
Active | N | Select the checkbox to activate or deactivate the column. If unselectednot selected, the column will be is not visible available in the Form Layoutform layout or List list layout configuration. | ||||||||||||||
ReadOnlyonly | N | Select the checkbox to make the field read-only.
| ||||||||||||||
Mandatory | N | Select the checkbox to make the field mandatory. | ||||||||||||||
FullText Searchtext search | N | Select the checkbox to make it possible to perform a Global Searchglobal search against the current column values.info
When selected, search indices are created for the column values. | ||||||||||||||
Display by ref | N | Select the checkbox to display the column values instead of record IDs in the reference fields that refer to the Table. A table can have only one column with this checkbox selected. If another column is set as a displayed field, the previously selected Display by ref checkbox is cleared | Display by Ref | N | Enable the attribute Display by Ref,so the column value will be displayed in the reference fields. By default, this attribute is set equal to 'true' for the sys_id column this column contains unique IDs. If a table contains a column that has Display by Ref equal to 'true', the value of this field will be displayed when referencing this table in the Reference field. | |||||||||||
Unique | N | Select the checkbox to forbid to add prevent from creating a new record with a certain value, in the Table if a record with the same value in this column already exists. |
Type Specification
TabIn SimpleOne, several column types have an extended attribute set. In addition to the standard field set, these column types demonstrate a dynamic change of the sys_db_column object attribute set depending on its type. Some of these attributes can be defined in the Type Specification tab.
icon | false |
---|---|
title | Most column types can have a limited number of characters defined by the Max Length field. |
section
The presence of this section on the column form and the field available to vary depending on the Column type selected.
Field |
---|
Mandatory | Description |
---|---|
Max |
length | N | Specify the maximum value length for the |
value. The value length cannot exceed the allowed length for the specified data type. These limitations, if any, are specified in the Column Types article.
|
The Choice, Conditions, Reference, List, Image, Template, and Field Name column types have a specific set of fields. See the description in the sections below.
See the Choice Fields article to learn more about this column type.
Field | Mandatory | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
Choice table | N | Specify a table that contains the choice options. | |||||||
Choice field | Y | Specify a column of the Choice table to use its values as choice options. | |||||||
Choice type | Y | Select the list type. Available options:
If the Dropdown without --None-- is selected, the Default Value section becomes mandatory. | |||||||
Extra attributes | N | Input the text below to apply the radio buttons style to the choice field:
|
Conditions column type
Field | Mandatory | Description | |
---|---|---|---|
Dependent on column | Y | Specify a reference column of the Table. The column should have the table_id name and reference to the Table dictionary to build conditions. | |
Extra attributes | N | Specify the extended condition operators. For example:
These operators become available for use in the condition builder. |
Reference column type
See the Reference Fields article to learn more about this column type.
Field | Mandatory | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Reference | Y | Specify a table with the values you need. | |||||||||||
On delete | N | Define actions to be taken in case the referenced record is deleted. Available options:
|
Image column type
Field | Mandatory | Description |
---|---|---|
Extra attributes | N | Specify the maximum image width and height. For example: |
|
Field Name and Template column types
Field | Mandatory | Description |
---|---|---|
Dependent on column | Y | Specify a reference column of the Table. The column should have the table_id name and reference to the Table dictionary to build conditions. |
Default Value section Anchor default value default value
default value | |
default value |
The Default Value tab section is available for all column types.
Attribute | Mandatory | Description | ||
---|---|---|---|---|
Default Valuevalue | Y/N | Specify a default value that will be populated automatically to the field when a new record is created. The field is mandatory when the Choice type is Dropdown without --None-- (specify a default value). | ||
Use Dynamic Defaultdynamic default | N | Select the checkbox if you want to generate the default value dynamically. | ||
Dynamic Defaultdefault | N | This field appears only when the Use Dynamic Defaultdynamic default attribute is set to 'true'. Select the script from the Dynamic Default Values (sys_default_value_dynamic) dictionarytable, so its execution results will be are automatically calculated and entered into this field. This value will be the default value for the column specified.
|
Reference Qualifier
Tabsection
The section appears for the following column types:
- Field Name
- List
- Reference
Field | Mandatory | Description |
---|---|---|
Reference Qualifier Typequalifier type | N | Select the type of reference qualifier. Available options:
|
Reference Qualifier Conditionqualifier condition | N | Configure the filters using the Condition Buildercondition builder. This field appears when the Reference Qualifier Typequalifier type value is Simple. |
Dynamic Reference Qualifierreference qualifier | N | Select the dynamic reference qualifier from the list. This field appears when the Reference Qualifier Typequalifier type value is Dynamic. |
Reference Qualifier Fixedqualifier fixed | N | Select the checkbox to fix filters in the breadcrumbs of the dictionary table when using this field. This functionality will block using the Condition Builder functionalityblocks the use of the condition builder. |
Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|