ssossossosso
Documentation Home »Administrator Guide »Entities Management »Entity Fields

Entity Fields

Overview

Fields are used to collect details of entity records.

For example, a ‘street name’, a ‘zip code’, and a ‘building number’ may be fields of an ‘address.’

You can add new fields to any custom entity or an extendible system entity.

This guide describes how to create and modify the fields.

Actions

Create a Custom Entity Field

  1. In the main menu, navigate System>Entities>Entities Management.

  2. On the All Entities page, click the required entity in the grid.

  3. On the entity view page, click the Create Field button in the upper-right corner of the page.

  4. Specify information for the basic entity field properties. See the descriptions of the basic properties in the Basic Entity Field Properties section.



  5. Click Continue button. Depending on what has been selected for Type, the corresponding additional fields appear.

  6. Specify information for additional properties. See the descriptions of the basic properties in the Advanced Entity Field Properties section.

  7. Click Save in the upper-right corner of the page.

  8. After that, you may require to update the schema. For how to do it, see the Update Schema section.

Edit a Custom Entity Field

  1. In the main menu, navigate System>Entities>Entities Management.

  2. On the All Entities page, click the required entity in the grid.

  3. On the entity view page, click Fields.

  4. In the grid of the Fields section, click the required field.

  5. Make the required changes according to the description provided in step 6 of the Create a Custom Entity Field section.

    Important

    The list of properties editable for system entity fields depends on configuration and is created in a way reasonable and safe for the system performance and operation.

  6. Click Save in the upper-right corner of the page.

  7. After that, you may require to update the schema. For how to do it, see the Update Schema section.

Alternatively, you can start editing an entity field from the entity view page by clicking the Edit icon at the right end of the corresponding row.

Delete a Custom Entity Field

  1. In the main menu, navigate System>Entities>Entities Management.
  2. On the All Entities page, click the required entity in the grid.
  3. On the entity view page, click Fields.
  4. In the grid of the Fields section, choose the required entity field and click the Delete icon at the right end of the corresponding row.
  5. In the Deletion Confirmation dialog box, click Yes.
  6. After that, you may require to update the schema. For how to do it, see the Update Schema section.
Browse maintained versions:
current1.102.02.32.4