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:

  1. Navigate to System Definition Settings All Tables.
  2. Open the table you need to add a column to.
  3. In the Related Lists area, select the Columns tab.
  4. Click New and fill in the fields.
  5. Click Save or Save and Exitexit to apply the changes.

To create a column record in the All Columns table, complete the following steps:

  1. Navigate to System DefinitionSettings → All Columns.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exitexit to apply the changes.
Tip

A column can be configured from any form it is displayed on. To do thisso, complete the following steps:

  1. Open any record in the table that contains the column you need to modify.
  2. Right-click the title of the required field → Configure field.

Column form fields


FieldMandatoryDescription

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 the Tables (sys_db_table) dictionary.

After the record is saved, this field becomes read-only.

Column

Type

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

on

in the

form

interface. It should be meaningful 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

name 
Anchor
column_name
column_name

Y

System column name. This field is populated automatically, depending on the 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.

Note

Column name prefixes are added, depending on the circumstances listed below:

  1. If you create a column within any table related to vendor applications (Simple, ITSM, or Personal Schedule), then this column automatically gets the "c_" prefix. For example:

    TitleColumn name
    New columnc_new_column


  2. If you create a column within a table related to non-vendor applications, then the prefix is not added.


Comments

NAdd some comments describing that describe the column.

Active

N

Select the checkbox to activate the column.

If not selected, the column is not available in the Form Layout or List Layout form layout or list layout configuration.

Read

Only

only

N

Select the checkbox to make the field read-only.

Info

This checkbox is hidden if the Column Typetype is set to Journal Input


Mandatory

NSelect the checkbox to make the field mandatory.

Full

Text Search

text search

N

Select the checkbox to make it possible to perform a global search against the column values.

When selected, search indices are created for the column values.

Display by

Ref

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 Refref checkbox is cleared.

Unique

NSelect the checkbox to prevent from creating a new record in the Table if a record with the same value in this column already exists.

Type Specification section


The presence of this section on the column form and the field available in to vary depending on the Column type selected.

FieldMandatoryDescription

Max Lengthlength

N

Specify the maximum value length for the columnvalue. The value length cannot exceed the allowed length for the specified data type. These limitations, if any, are specified in the Column Types article.

Expand
titleThe field is displayed in the section for the following column types
  • Encrypted Password
  • HtmlHTML
  • Journal Input
  • Password
  • Record Class
  • Script
  • String
  • Template
  • Text
  • Translated text
  • URL


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.

FieldMandatoryDescription

Choice Tabletable

NSpecify a table containing that contains the choice options.

Choice Fieldfield

YSpecify a column of the Choice Tabletable to use its values as choice options.

Choice Typetype

Y

Select the list type. Available options:

  • Dropdown with --None--
  • Dropdown without --None-- (specify a default value)

If the Dropdown without --None-- is selected, the Default Value section becomes mandatory.

Extra Attributesattributes

N

Input the text below to apply the radio buttons style to the choice field:

Code Block
languagejs
themeEclipse
choice_decorator=radio

Conditions column type

FieldMandatoryDescription
Dependent on ColumncolumnYSpecify a reference column of the Table. The column should have the table_id name and reference to the Table dictionary to build conditions.
Extra AttributesattributesN

Specify the extended condition operators. For example:

extended_operators=VALCHANGES;CHANGESFROM;CHANGESTO;IS_CALCULATED

These operators become available for use on in the column view condition builder.

Reference column type

See the Reference Fields article to learn more about this column type.

FieldMandatoryDescription
ReferenceYSpecify a dictionary table with the values you need.
On DeletedeleteN

Define actions to be taken in case the referenced record is deleted. Available options:

  • No action – no actions will be taken.
  • Set NULL – the reference to this record will be deleted from the field (the value will be equal to 'null').

    Warning

    When deleting a record A, an update error of a record B will occur if the record has a column that references the record A is mandatory and the Action on delete for this column is Set NULL.

    Code Block
    languagetext
    titleError
    Unable to update the {link} record because it references to the deleted one



  • Cascade – a record containing a reference to the deleted record will be deleted as well.
  • Restrict – deletion of the referenced record is forbidden.
  • Set default value – the reference to the column will be changed to the default value defined in the Default Value section.

    Note

    Make sure that you set the default value on the Default Value tab if the Set Default option default value option is selected. In case the default value is not set, and the referenced record is deleted, the reference to this record will be deleted from the field (the value will be equal to 'null').


Image column type

FieldMandatoryDescription
Extra AttributesattributesN

Specify the maximum image width and height. For example:

No Format
width=1600 height=800


Field Name and Template column types

FieldMandatoryDescription
Dependent on ColumncolumnY

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

section 
Anchor
default value
default value


The Default Value section is available for all column types.

AttributeMandatoryDescription

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 defaultUse Dynamic Default

NSelect 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 are automatically calculated and entered into this field. This value will be the default value for the column specified.

Note
  1. The script must preliminarily be created in the Dynamic Default Values (sys_default_value_dynamic) dictionarytable; otherwise, you will not be able to choose select it.
  2. You can choose select only active scripts (the Active attribute checkbox is selected).


Reference Qualifier section

InfoThe Reference Qualifier section

The section appears for the following column types:

  • Field Name
  • List
  • Reference
FieldMandatoryDescription

Reference Qualifier Typequalifier type

N

Select the type of reference qualifier. Available options:

  • Simple
  • Dynamic

Reference Qualifier Conditionqualifier condition

N

Configure the filters using the condition 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

NSelect the checkbox to fix filters in the breadcrumbs of the dictionary table when using this field. This functionality prevents from using blocks the use of the condition builder functionality.


Table of Contents
maxLevel3
absoluteUrltrue
classfixedPosition
printablefalse