Skip to content

Custom Fields

Purpose

The Custom Fields screen in Clarity Transform is where you add your own fields to Clarity tables without code changes. Each custom field has a Name, belongs to one Table, and has a Data Type. The screen has no header or subtitle: it opens straight onto the grid.

Where to find it

Settings → Field Management → Custom Fields

What you see

Columns

  • Name
  • Table: the one table the field belongs to. The tables available are application, application_service, cluster, database, database_instance, datacenter, device, firewall_rule, host, load_balancer, network, relationship, storage, subnet, user and website.
  • Data Type: string or integer.

Actions

The grid uses the standard Clarity grid toolbar:

  • Create New (the add icon): opens the create form.
  • Edit
  • Remove selected
  • Clear selection
  • Reload table data
  • Enable spreadsheet editing
  • Export CSV
  • Import CSV

Each row has a View Details row action (the eye icon).

Fields

The create form (Create new entry) and the edit form (Edit entry) have three fields only. There is no required flag, default value, list type, description or display order.

  • Name: text. Help: "Use lowercase format and underscores to separate words e.g. 'first_name'".
  • Table: a list with application, application_service, cluster, database, database_instance, datacenter, device, firewall_rule, host, load_balancer, network, relationship, storage, subnet, user and website.
  • Data Type: a list with string and integer.

The form footer has Cancel and Save.

Filters

The grid has a Search: box, a filter row under each column, and a page-size selector (10 / 25 / 50 / All).

The grid remembers its Search: text, column filters, sort order and page size between visits. If the grid shows fewer rows than you expect, clear the Search: box and the filter row.

How to

Add a custom field

  1. Go to Settings → Field Management → Custom Fields.
  2. Select the add icon (tooltip beginning Create New). The Create new entry form opens.
  3. Enter the Name in lowercase, with underscores between words, for example first_name.
  4. Select the Table the field belongs to.
  5. Select string or integer in Data Type.
  6. Select Save.

A new custom field appears straight away as a column on its table's grid on Discover → CMDB and as a field in that table's form. The column heading is the Name with underscores shown as spaces and each word capitalised (for example first_name becomes First Name). Deleting the custom field removes the column and the form field at once.

Remove a custom field

  1. Go to Settings → Field Management → Custom Fields.
  2. Select the field's row in the grid.
  3. Select the delete icon (tooltip Remove selected).
  • Dropdown Lists and Field Validations: set the allowed values for a field, or mark a field as Mandatory or Suggested.
  • CMDB: the CI-type grids on Discover → CMDB.
  • Change Log: its Table filter includes field_management_custom_fields, so you can review changes made on this screen.