Fields
Every PEER™ ticket contains entry fields which are completed by the user who raises it. The fields are maintained by the system administrator using the Field Editor. Fields are then added to various Forms using the Forms Editor. A single field definition may be used on one or many forms. There are two types of fields, which are described below.
There is no limit on the number of custom fields a System Administrator can add.
Custom Field Type | Description |
|---|---|
Textbox | Free text entry field, limited to 50 characters |
TextArea | Free text entry field, unlimited characters |
Selectbox | A dropdown field with user-defined options |
Checkbox | A field whose value can only be "yes" or "no" (checked, or unchecked) |
MultiSelectBox | A series of checkboxes which can be selected in any combination |
HierarchySelect | Allows final values to be arranged according to parent values, so the user drills in from the top level down to the final level |
Date | Presents the user with a Date/time picker control, to specify a particular point in time |
Radiobutton | A series of radio buttons whose values are mutually exclusive (can only select one at a time) |
Image | Allows the user to take a picture with their device's camera, and attach it to the ticket |
File | Allows the user to attach a document to the ticket (image, document, pdf, excel, json, xml) |
These are reserved fields required for the application to function, and cannot be deleted. Some allowed values may be edited (i.e. the various values of the Andon Status field), and others are configured outside the field editor, in the Area Editor, Asset Editor, Notification Group Editor, etc.
System Field Type | Description | Required on these Forms | Visible on these Forms |
|---|---|---|---|
Andon Status | The required values for this field are "Request Made", "Acknowledged", and "Closed". However, users may add additional values. | Create,Update,Edit | Create,Update,Edit |
Area | A Selectbox control, whose values are specified by the user, in the Area Editor. | Create,Edit | Create,Edit |
Date | A Date control, with date and time selectors. | Create,Update,Edit | Create,Update,Edit |
Notification Groups | A multi-selectable Checkbox control, whose values are specified by the user, in the Notification Group Editor. | Create,Update,Edit | Create,Update,Edit |
Workstation/Asset | A Selectbox control, whose values are specified by the user, in the Asset Editor. | Create,Edit | Create,Edit |
When adding fields to forms, there are parameters other than field type which must be specified. Those are described below:
All fields, regardless of which form(s) on which they appear, are created in the Field Editor. When adding any field to a particular form, there are several parameters available:
Parameter | Description |
|---|---|
Name | An alphanumeric description of the field which will appear as the field label on its various forms. |
Type | The type of field used to capture data when creating or editing a ticket. |
Values | For fields which are limited to a particular set of values (i.e. Selectbox, HierarchySelect, Radiobutton, etc), those are entered here as a comma-delimited list. These are shown here for reference, and are only editable in the Field Editor. |
Read Only | The Administrator may determine if a field should be read-only (non-editable by the user) on a particular form. For example, a field may be entered once on the Create form, but not changeable on the Edit form. This allows the user to reference the original value when subsequently editing the ticket. |
Required | The Administrator may determine if a field should be required on a particular form. In some cases, the user who opens the ticket may or may not have the information to complete a particular field at the outset, so it wouldn't be required on the Create form. Conversely, the user who acknowledges the ticket in the Edit form might then be required to complete that field. |
Visible | Most fields can be hidden on any form. This would be useful when deprecating a field, in order to preserve historical data which was entered in it. |
Order | This is a number which determines the order in which fields appear on the form. |