This section provides an overview of the Field Editor.
This section is divided into four parts:
- Searching For Data Fields
- Field Options
- Field Name / Display Name / Type / From
- Editing Custom Data Fields
The Field Editor can be used to create custom data fields. These custom data fields can then be used (and modified) through the Screen Editor in the Screens tab. To learn how to modify existing custom data fields, please refer to the Working with Screen Data Fields page.
To use the Field Editor, go to Setup > Field Editor. This will open the Field Editor screen.
Searching for Data Fields
From the Field Editor screen, you can search for existing data fields by typing a keyword in the search bar. In the example below, the user typed ‘Gender’ into the search bar and the data fields associated with Gender are now listed below.
You also have the ability to narrow your search using the dropdown to the right of the search bar. The options are listed below:
- Live Markers
Core & System Fields
These are fields that are permanently integrated into the system and cannot be changed by users.
These fields can be created and modified by the user.
Live Markers use custom programming to serve two primary purposes:
- Eliminate the need to ask duplicate questions on multiple screens,
- Automatically calculate information that can subsequently be used as a display constraint.
For more information on Live Markers, please refer to the Creating Custom Data Fields page.
In the example below, when ‘Live Markers’ is selected, the search results only lists the data fields that are Live Markers and associated with Gender. In this case, there is only one such data field.
Field Name / Display Name / Type / From
When you enter a keyword into the search box, you will notice 4 columns in the search results: Field Name, Display Name, Type, and From. Each are described below.
Field Name Column
The ‘Field Name’ column indicates the the name of the field in the SQL table. It is usually all lower case letters separated with underscores (e.g. field_data_name).
Display Name Column
The ‘Display Name’ column refers to the Field Display Name, which is the name that appears on the end-user’s screen.
The ‘Type’ column refers to Field Type, or the type of data field.
A data field can be designed to be any of the following types:
Small text box. Example: Middle Name
Larger text box. Example: The text box field used in Manage > Programs to describe the program.
Number value responses. Example: Number of females in household.
Date responses. Example: Pregnancy due date. (A calendar will appear when the user selects the calendar icon.)
The response is a dollar amount. Example: Gross Annual Household Income.
The response is yes/no. Example: Determining whether a client has other sources of cash income.
The response is a telephone number. Example: Cell phone number.
The response could be one of several options. Example: Race.
The ‘From’ column refers to the From Table, which indicates what field category the data belongs to (i.e. Live Marker, Custom, Core, System).
Editing Custom Data Fields
Data Fields with a ‘Custom’ or ‘Live Marker’ field category are the only type of data fields that the user can edit. Core and System field categories can only be created/modified by Clarity Human Services staff.
To edit an existing custom data field, mouseover the data field and select the ‘Edit’ icon that appears to the left.
This will take you to the Modify Field screen, where you can edit the data field.
(For more information on the elements of this screen, please refer to the Creating Custom Data Fields page.)
You can also create new custom data fields by selecting the ‘Add Field’ link at the top right corner of the Field Editor main screen.