Fields
On this page
Most fields of an object class are system fields that come with the product. You can rename a system field and change some of its options, but you cannot remove it. Fields that an administrator adds are user-defined fields; see User-Defined Fields.
A field's name and type are the same wherever it occurs. A system field's label, and the Mandatory and Read Only settings of any field, belong to each table or database view the field occurs on, so the same field can carry different settings on different tables.
The type the product gives some system fields differs from their database column: the time-spent, cumulative time-spent, and planned-effort fields are Duration fields, the client secret field is Encrypted, and long-text fields, such as the description of tickets, the notes of most tables, and the resolution of incidents and work orders, are HTML fields.
A new 2026.1 database created with the Default Workflow already carries custom labels and Mandatory and Read Only settings on many of the fields that come with the product; see Default Workflow Configuration. An upgraded database need not have these settings, and an administrator may have changed them.
You manage fields in the Admin Center and in the Settings App; for the two applications, see Admin Center and Settings App.
Mandatory and read-only settings
You can apply these settings to system fields and user-defined fields:
- Mandatory requires a non-empty value in the field's input control on the full object form.
- Read Only lets users view the field's value on the full object form but prevents them from editing it there.
NOTE: These field settings apply to input controls on full object forms. They do not create system-wide business rules or enforce the same restrictions on workflow action forms or other methods of creating or updating records.
For user-defined fields, see also How user-defined fields appear in the Web App.
Fields with fixed behavior
Some system fields behave in a fixed way that no setting changes:
- Some fields are never offered to users at all.
- Some fields are always read-only, and their read-only setting cannot be cleared.
- Some fields are read-only on full edit forms.
- Some fields are read-only on the edit form only; the workflow's Update Field operation can still write them (see Operations Reference).
- Some fields are always mandatory, and their mandatory setting cannot be cleared. A task's parent is mandatory as well.
- Some fields of activities cannot be edited.
- Some fields cannot be modified by users and are used by Update Field operations.
Which label a field shows
Each table and each database view keeps its own label for a field. A field shows its custom label when one is set, and otherwise its default label. A view does not inherit the table's custom label: a view with no label of its own shows the default label.
On an action form, the form field's own label, when set, takes precedence over both. When it is empty, the form shows the table's label.
A user-defined field always shows its single label.
Filters on reference fields
A reference field can carry a filter: an SQL condition on the columns of the
table the field refers to. The filter can contain placeholders, such as
%[DBF Currency_Code]%, which are replaced with values of the record being
edited. You set the filter in the Admin Center or in the Settings App.
The Web App applies this filter wherever it builds a field list with no form: an action without a form, a step action whose form is empty, the field list for updating several records at once, and the field list for customizing a list view. When a form exists, a field placed on it uses the form field's own filter, even an empty one, and a field not on the form gets no filter. This holds for action forms and View Forms alike.
The Web App joins the filter with and to the lookup's own filter and, except
for a lookup that lists all records, to the condition that leaves out inactive
records; the result narrows the field's drop-down list. Only a filter set on a
table is used: a filter on a database view or on the Activity table is never
loaded.
Turning on multicurrency adds the condition
[Currency_Code] = %[DBF Currency_Code]% to the filter of the purchase order's
vendor field, joined with and to any filter already there, unless the
condition is already present. The Settings App's Regional Settings and the
Admin Center both make this change.
In the Admin Center
The field table
Open General > Fields. The page lists one node per table; when no node is selected, it opens the first one. A folder cannot be selected as a field list.
- Four of the table nodes are aggregated views: All CIs, All Tickets, My Tickets, and Task Parents.
- The Miscellaneous folder holds Object Activity; the Classification and Reference Tables folder of 19 nodes, such as Company Address, Manufacturers, and Workspaces, in which every node except Company Address and Manufacturers is an aggregated view; and All Fields.
- All Fields is one flat list of the fields of every table. Its Group By list groups the fields by user-defined versus system fields, by table name, or by field. Its toolbar has Edit and Delete only; Delete is available only for a user-defined field that is not on a database view.
Each object class in the Workflow tree also has its own Fields node. It shows the same field table, with the same grouping and toolbar, as the table nodes under General > Fields.
On a table's node, Edit is available for any selected field, system or user-defined. New and Delete work on user-defined fields and, on All Tickets, on shared ticket fields; UDF Layout is available when the class has at least one user-defined field. See User-Defined Fields.
Change a system field's label or options
- Select the table's node or All Fields under General > Fields, or the class's Fields node in the Workflow tree, select the field, and click Edit. The Field Properties drawer opens. Under Binding, Field Name and Table are shown and cannot be changed. Under Display, Default Label is shown and cannot be changed.
- In Custom Label, enter the label you want, up to 100 characters. To go back to the default label, clear the box.
- Under Options, select or clear Read Only and Mandatory.
- For a reference field, enter a Filter if you want one. The box is not shown for the fields of stock rooms and software products. See Filters on reference fields.
- Save your changes.
The drawer has no command that restores a default: you revert a value only by clearing it. The drawer has no tabs, and it shows neither where the field is used nor the labels of the database views.
Saving writes the custom label, Read Only, Mandatory, and Filter for the table you edited. It also writes the custom label into the same field on every database view that depends on the table, whatever label each view had before, so a label set for one view does not survive a change made here. When you edit a table, Read Only and Mandatory are copied to the dependent aggregated views too.
The Options group follows these rules:
- On an aggregated view's node, the drawer shows "These options are not available for aggregated Views", and both boxes are disabled.
- On Object Activity, a system field's drawer has no Options group.
- Read Only is disabled, and checked, for a field that is always read-only or read-only on full edit forms, and Mandatory for a field that is always mandatory (see Fields with fixed behavior). On a table's node, this covers the fixed behavior set for every table and the one set for that table; on All Fields, only the fixed behavior set for every table.
- Mandatory is also disabled for a Logical field.
- Each box starts checked when the option is on for the field.
In the Settings App
The field table
The Fields page opens from two places:
- General > Fields lists every licensed class your account may administer, then a Miscellaneous folder holding Object Activity, Classification and Reference Tables with one node per reference table, and All Fields with By Table Name, By Field Name, and List.
- In the Workflow and Business Logic group, each class has its own Fields node, under Service Desk, Service Management, Project Management, Asset Management, Purchasing, Configuration Management, Software Asset Management, and Organization Management. The All Tickets/My Tickets node of Service Desk and the All Configuration Items node of Configuration Management have a Fields node too.
The page's field list shows each field's mandatory, read-only, and hidden settings in columns of their own.
The commands of the Fields page depend on the node:
- On a class that can have user-defined fields, the page offers New, Delete, Edit, and UDF Layout....
- On All Tickets/My Tickets, the first two read Add and Remove, and UDF Layout... is not shown.
- Other tables and the All Fields lists have neither New nor UDF Layout....
- Edit, or a double-click on a row, opens any system field and a table's user-defined field; see Field Properties.
- Delete, or Remove on All Tickets/My Tickets, works only on a table's user-defined field or a shared ticket field. A system field cannot be deleted. For user-defined and shared ticket fields, see User-Defined Fields.
Save your changes
Changes on the Fields page are kept on the page until you save them. To save, click Save on the Standard toolbar, choose Save, the first command of the File menu, or press Ctrl+S. Save is available while at least one open page has unsaved changes, and it saves every page you opened in the session at once, each with its own confirmations.
Saving changes to system fields asks for no confirmation. Changes that add, delete, rename, or resize user-defined fields, or that change shared ticket fields, ask you to confirm a change of the database structure first; see User-Defined Fields.
Field Properties
From the Fields page, a system field opens in the Field Properties dialog and a user-defined field in the User Defined Field dialog; a shared ticket field opens its own editor. Both dialogs have a General and a Usage tab.
To change a system field's label or whether it is mandatory, select the field on the Fields page and click Edit, change the values in the Field Properties dialog, and then save the page (see Save your changes).
In the Field Properties dialog, the mandatory check box of a Logical field is disabled, so a Logical field cannot be made mandatory.
Under Advanced, the Field Properties dialog lists the database views that depend on the table and each view's label for the field:
- When you change the table's label, the change is copied only to the views whose label equals the table's current custom label. A view with a label of its own keeps it.
- A label you edit in this list is saved for that view alone.
- A label equal to the default label is stored as empty.
The dialog shows a filter only for a reference field of a class other than
Software Product, Stock Room, or Activity, and only when the field has a table
to filter. The filter box builds the same condition as in the Admin Center,
with an expression builder whose prompt reads
select * from <lookup table> where. The builder can also insert a stored filter template with its
parameters filled in.
See where a field is used
The Usage tab of the Field Properties or User Defined Field dialog
lists the workflow items of the field's class that hold the field's placeholder,
%[DBF <field name>]%; for a reference user-defined field, the placeholder of
its _ID field. For workflow items, see
Workflow Overview.
- The references are counted when the dialog opens. The tab reads Usage (n) when there are references, and Usage when there are none.
- The list loads when you first show the tab. Open an item with Open or Open in New Window.
- A service field mapping that names the field is listed with the placement Field Mapping.
- The tab of a new user-defined field is disabled.
- Deleting a user-defined field that workflow items of its class refer to fails with the message "Unable to delete field "label" because one or more workflow items refer to it. Remove dependencies first." The field's dialog then opens on the Usage tab.
Set the Related CI format
The Related CI template sets how the Related CI field of tickets displays the configuration item. It is set on the Options node of All Configuration Items.
- In the navigation tree, select Workflow and Business Logic > Configuration Management > All Configuration Items > Options.
- In the Related CI template group, choose a template in
Current Template:, or type one. The list offers these templates:
- [Class], [ID], [Name]
- [Type], [ID], [Name]
- [Class], [Type], [ID], [Name]
- [ID], [Name]
- [Name], [ID]
- [Name]
- [Class], [Asset Tag], [Name]
- [Type], [Asset Tag], [Name]
- To check the template, click Preview.... The result opens in a dialog captioned Preview..., with the sample values Computer for the class, Workstation for the type, C000027 for the ID, AT000005 for the asset tag, and JOHNDOW15 for the name.
- Click Apply.
A template you type is kept as you typed it. It can use the placeholders listed under the box: [Class], [Type], [ID], [Asset Tag], which is filled only where available, and [Name]. When no template is stored, the page shows [Class], [ID], [Name], and the field is displayed with that template.
Each placeholder is replaced with the configuration item's value:
- A value the configuration item does not have leaves an empty place between the separators the template has around it.
- An empty [Name] is left out together with the comma and space in front of it. Where [Name] has no comma and space in front of it, for example at the start of [Name], [ID] and [Name], a configuration item without a name shows an internal placeholder value in its place.
- [Asset Tag] is taken from the asset associated with the configuration item, and only for some classes of configuration item; for the others, it stays empty.
When users see a change
A changed field label reaches the Web App without a restart. Each Web App session checks for changed labels and for changes to the database structure at sign-in and, after that, when the session is used, at most once every 30 seconds; when either has changed since its last check, the session reloads its field information, and the captions the server builds, such as column captions, carry the new label.
The Alloy Navigator API makes the same check at most once a minute and is not restarted for it. A mobile app that works through the API is served by a session that is refreshed the same way.
Field-level History
Alloy Navigator records changes to the fields of 34 object tables, among them the five ticket tables (Incidents, Problems, Change Requests, Service Requests, and Work Orders), tasks, Knowledge Base articles, locations, organizational units, user groups, projects, and asset, purchasing, and reference tables, plus changes to activities. The list of tracked tables is built into the product. A fixed list of fields is excluded from History even on a tracked table, for example the time-spent fields of every ticket class and a Knowledge Base article's content text and views.
One system-wide setting turns History recording on or off. Recording is on unless the setting is turned off; while it is off, no History entries are written at all.
Each entry records:
- Changed by: the user who made the change. When a scheduled task started the run, the entry names the task. Changes made by the product's own services name the service, such as Automation Server, Mail Connector, Self Service Portal, Alloy Navigator API, or Scheduled Task Agent. The name is stored as text when the entry is written, so renaming the person later does not change existing entries.
- Change Date: when the change was made.
- Action and Attribute: the kind of change and what it was made to.
- Old Value and New Value, stored as text.
- WF Item # and WF Action #: when a workflow made the change, the workflow event that was running and the event that started the run.
The kinds of entry:
| Action | Attribute | Written when |
|---|---|---|
| Changed | The field's label, or its column name when it has no label | A field of a tracked record changes. For a lookup field such as a status or a priority, the old and new values are the displayed text, not the ID. |
| Activity changed | #, the activity's number, and the field's label |
A field of an activity changes. The entry belongs to the activity's parent record. |
| Activity deleted | # and the activity's number |
An activity is deleted. Adding an activity writes no entry. |
| Action executed, or the text the workflow passes | The workflow event's caption | A workflow action runs. The entry has no field and no values. |
Changes to related records write entries of their own, among them:
| Action | Attribute |
|---|---|
| Work Order added, Work Order deleted | The label of the Ticket field, or Ticket when it has none |
| Receiver added, Receiver updated, Receiver deleted | Receivers |
| PO Item added, PO Item updated, PO Item deleted | # and the line number |
| Attachment added or Link added, and their deleted forms | |
| Email added, Login added, IP Address added, with their updated and deleted forms | |
| Service Level added, Service Level deleted | |
| Member added, Member deleted | Group Member |
| Allocate License, Deallocate License | Software |
| Added, Deleted | Relationship; the value is the related object's class, identifier, and name |
| Restriction added, Restriction changed, Restriction deleted | |
| Category added, Category updated, Category delete | |
| Reservation added, Reservation deleted | The requester's full name |
In the Web App
A record's History tab lists the record's History entries. 34 of the
built-in Web App forms carry the tab. The grid has no actions button. Entries
the browser has cached are read again from the server as soon as the grid
shows them. When an HTML field has an old or new value, the grid shows that
value as the text <html>.
Open an entry to see it in the History flyout. The flyout shows Change Date, Changed by, Action, Attribute, WF Item #, and WF Action #, then the Old Value and New Value boxes, with HTML converted to plain text.
The Web App writes History entries too: after each workflow action it runs, it adds an Action executed entry, and saving a record in the Web App records its field changes as described above: on a tracked table, except the excluded fields, while History recording is on.
Related topics
- User-Defined Fields - add, change, and delete fields of your own, and shared ticket fields.
- Form Layouts