This article explains how to use the FIELD EDITOR function to create and edit fields in Clarity Human Services.
Fields are created, edited, and deleted in FIELD EDITOR. As noted in Introduction to Fields, configurations made to a field in FIELD EDITOR impact its appearance and functionality in any screens that include the field. For more information about configuring fields at the screen level, see Creating and Editing Screens and Screen Field Editor Overview.
To create a new field, navigate to SETUP > FIELD EDITOR. Click ADD FIELD.
Define the field's Table Type, Display Name, Data Name, and Type. Add any comments or tooltip text.
Table Type: the category of the field. Refer to Introduction to Fields for descriptions of the field categories.
Field Display Name: what the user will see on the screen. The name cannot be more than 255 characters in length (the system will not display any text beyond that limit).
Field Data Name: a unique identifier for the field. You cannot change the Field Data Name after you save the field. No two data fields can have the same Field Data Name. If you attempt to save a field with a Field Data Name already in use, you'll receive an error message. The name cannot be more than 98 characters in length.
Field Type: the type of data the field will collect. Refer to Introduction to Fields for descriptions of the nine different field types. You cannot change the Field Type after you save the field.
Comments: additional information about the field. For example, Core Fields associated with the HMIS Data Standards include the Data Element number and name in the Comments.
Tooltip Text: text entered here will appear when a user hovers over the field in a screen. The Tooltip cannot be more than 1,024 characters in length (the system will not display any text beyond that limit).
After completing the initial field configuration, click SAVE CHANGES. Additional field(s) appear:
Publish to Data Analysis: includes the field in a Data Analysis model. Refer to our Custom Fields in Data Analysis article for additional information.
Note: Once a field is published to Data Analysis, it cannot be removed.
Field Marker: If you select "Housing Inventory Custom" for the Table Type, a Field Marker toggle will be displayed after you click SAVE CHANGES.
- Designating a field as Field Marker enables the system to cascade data to a Housing Inventory setup screen from the screen above it.
- If the Field Marker toggle is turned off, you can still use this field as a regular field, just not as a Field Marker.
- After turning on the Field Marker here, the next step is to navigate to SETUP > SCREENS, select a Housing Inventory screen to edit, and either add that field to the screen or select that field to edit. You will see a Field Marker toggle in the SCREEN FIELD EDITOR. Refer to the Screen Field Editor Overview article for additional details.
- Field Markers may be added to screens at any level. Keep in mind, though, that because Inventory data cascades from the level above it, a Field Marker at the Site level cannot have any data cascaded into it because it is at the top of the Housing Inventory hierarchy.
- In order for data in Field Markers to cascade, the Field Marker must be included at the level you want it to cascade from and the level you want it to cascade to, but also at all levels in between. You may hide the Field Marker at the “in between” levels if desired. For example, if you want data to cascade from a Field Marker at the Building level to that Field Marker at the Unit level, you must also include that Field Marker at the UCT level.
Creating Picklist Selection Options
If the Field Type "Picklist" is selected, an additional SELECTION OPTIONS section will display, allowing you to create the drop-down menu options that will be available for the field.
The system automatically includes four options: "Select," "Client doesn't know," "Client prefers not to answer," and "Data not collected." If these selections are not applicable, you can edit or remove them by hovering over the selection and clicking the delete or edit icon.
To add new selections, click ADD SELECTION.
In the EDIT PICKLIST ITEM pop-up, enter a Value and Description, then click ADD.
After you have finished adding selections to the field, click SAVE CHANGES.
System administrators can change the order of picklist Selection Options by clicking the option and dragging and dropping it to the desired location.
Click the Edit icon next to a picklist value to edit it. Click the trash can icon to delete the picklist value.
Inactive Picklist Values
You can make a picklist value inactive by clicking the Inactive icon that appears when you hover over that value. This feature is available for all picklist values created by a System Administrator, even if they have data associated with them.
Clicking the Inactive icon displays the following message: "This action will make the picklist value inactive and no longer available for use within the system. Please confirm"
- Inactive picklist values will be greyed out in FIELD EDITOR and will be labeled "INACTIVE."
- Inactive picklist values will not appear within screens.
- A Field Information column within the relevant database table will identify inactive fields.
- Hovering over an inactive picklist value displays an Active icon. Click the icon to make the picklist value active again.
Note: Historical picklist values that are currently inactive will be labeled" "Inactive" in the client record.
The "inactive" option applies to both custom fields and custom options in the System/Core fields.
Viewing/Editing Existing Fields
To view or edit an existing field, first search for the field as described in our Introduction to Fields article. A list of fields that meet your search criteria will be displayed. Hover over the field you want to view/edit and click its Edit icon to display the FIELD MANAGEMENT page. Edit as desired, then click SAVE CHANGES.
Notice that, for System/Core fields associated with HMIS Data Elements, the system displays the following read-only fields in addition to the fields described above:
- HMIS Element ID (Hmis_element_id): the official data element number from the HMIS Data Dictionary.
- HMIS Element Name (hmis_element_name): the name of the element used in the HMIS CSV and XSD files.
- HMIS Element Type (hmis_element_type): the XML Schema type of the HMIS element.
- HMIS Element Description (hmis_element_description): the description of the data element from the HUD Data Dictionary.
- HMIS Data Standard Year (hmis_data_standard_year): the version of the HMIS Data Standard, such as FY2024.
Note: If you click SAVE CHANGES on the FIELD MANAGEMENT page without making any changes, the system will not display the green "Changes successfully saved" banner, track the action in the Audit Log, or update last_updated and ref_user_updated.
Deleting Existing Custom Fields
To delete a field, hover over the field in the Field Editor search results and click the trash can icon. A field that is currently included in a screen cannot be deleted until it is removed from that screen.
Note: Custom picklist values created by System Administrators can be deleted as long as there is no data associated with them (i.e. if no users have selected that value as a response to a field). If there is data associated with a field picklist value, the system will implement logic that prevents that value from being deleted. If you click the trash can icon for one of these values, the system displays a pop-up saying, "This picklist value cannot be deleted as there is data associated." To allow for immediate deletion of accidentally created picklist values, the system will implement this check 5 minutes after picklist value creation.
Users with the appropriate access can click the Audit Log button at the bottom of the FIELD MANAGEMENT page to track the following:
- Adding fields
- Changing field values
- Adding/modifying/deleting picklist selection options
- Inactivating/activating picklist values