Important

You are browsing upcoming documentation for version 5.1 of OroCommerce, OroCRM, and OroPlatform, scheduled for release in March 2023. Read version 5.0 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Available in OroCRM Available in OroCommerce

Create Entity Fields

Fields are used to store 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 extendable system entity.

This topic describes how you can create custom entity fields, explains what basic and advanced entity field properties are available for them, and illustrates examples of adding new fields to existing entities.

Note

See a short demo on how to create a custom field or keep reading the step-by-step guidance below.

To create a custom entity field:

  1. Navigate System > Entities > Entities Management in the main menu.
  2. On the All Entities page, click the required entity to open its page.
  3. On the entity page, click Create Field on the top right.

Hint

You may receive the following warning message which notifies you about the limits for the number of fields that can be created, which can effect the future export of entities.

The number of fields stored as columns in the X table (the fields that are relations or that have ever been marked as “A”, “B”, “C”) is approaching the limit after which it will no longer be possible to export Y with the standard X export. Remaining number of attributes - approximately Z.

Once 90% of the limit is reached, you will receive a flash message with the related warning.

Reaching 100% of the limit triggers a warning message on a potential inactive export when clicking the Export button.

  1. Provide the basic entity field properties, such as the name, the field and field storage types.
  2. Click Continue.
  3. Provide advanced field properties, some of which can be field-type-related.
  4. Click Save and Close when you finish creating the new entity field.
  5. Once the field is saved, update the schema, if the storage type for the field is set to Table Column.

Related Topics