Skip to main content

How to create and configure a custom field

Learn how to create custom fields in Sage Sales Management Admin and define their basic details, visibility, and conditions of use.

Written by Jon Trasobares

Open the creation form

  1. Open Sage Sales Management Admin.

  2. Select Fields from the side menu.

  3. Select the entity where you want to add the field.

  4. Open Create and select Create field.

The creation form opens. Fields marked with an asterisk are mandatory.

The Create menu also includes Create tab, which lets you group custom fields within an entity.


Complete the basic details

Property

What to enter

Entity

The entity the field belongs to, such as Accounts or Contacts.

Tab

The group where the field will appear. If you do not select another tab, the general or default tab is used.

Field name

The name users will see in the web and mobile apps. Use Multilingual to add translations.

DB and API name

The field’s technical name in the database and application programming interface (API). It should be short and descriptive.

Data type

The type of information the field will collect.

Default value

The value entered automatically, which can be changed when using the field.

Keep the prefix Z_- when it forms part of the technical identifier.

Data types include text, single selection, multiple selection, integer, decimal, currency, date and time, boolean, and percentage.

Additional properties depend on the selected type. For example:

  • For text fields, you can specify the Maximum number of characters.

  • For selection fields, specify the Value list that provides the options.


Define visibility by environment

Under Visibility by environment, select the relevant environments.

Only users with visibility over those environments can view the field in forms and record details in the web and mobile apps.

To highlight it for specific profiles, review Mark as a highlighted field for these user types.


Configure how the field is used

Under General settings, select the relevant options:

Option

Purpose

Visible on web

Displays the field in the web app.

Visible on mobile

Displays the field in the mobile apps.

Include in views

Makes the field available when configuring views.

Include in searches

Includes its content in searches.

Mandatory

Requires the field to be completed before saving the record.

Read-only

Prevents users from changing its value in forms.

Search suggestions

Allows the field to be used in search suggestions.

Visible in post-call report

Displays the field in the report after a call.

Visible via API (V4 or later)

Makes the field available through the specified API.

Mandatory via REST API

Requires the field in the relevant operations through the REST API.

Review the mandatory settings for forms and the API separately, as each has its own option.

Use Internal comment to document the field’s purpose or add notes about its configuration.


Conditional field settings

The form also includes settings for dependencies and dynamic visibility.

These options let another field control the available values, visibility, or behaviour of the current field.

Their configuration is covered in the articles about dynamic fields, dependent fields, and Smart Fields.


Save one or several fields

At the top of the form, you can select:

  • Save: saves the field and completes its creation.

  • Add and create another: saves the field and opens a new form so you can continue creating fields.

  • Cancel: closes the form without saving the field.

Use Add and create another when you need to create several fields consecutively.


Check the result

After saving:

  1. Open a form for the relevant entity.

  2. Check that the field appears in the intended tab.

  3. Verify that it accepts the type of information you need.

  4. Review the default value and configured conditions.

  5. Check translations and visibility on web, mobile, and across environments, according to the selected settings.

To edit it later, find it in Fields, hover over its row, and select the pencil icon.

Some properties may be locked after creation. These properties display a padlock.


​

Did this answer your question?