Data is collected in screens through fields. When a field is edited in Field Editor, modifications will apply to the field wherever it appears in Clarity Human Services. When a field is modified within a screen, those modifications will only apply to that particular screen. These modifications take place in Screen Field Editor (figure 1).
The purpose of this article is to explore the different ways fields can be modified within screens. For information about adding fields to screens, see Creating and Editing Screens.
Editing Fields in Screen Field Editor
To edit a field within a screen, first edit the screen in Screen Editor.
Locate the field and click the Edit icon (figure 2). This will take you to Screen Field Editor.
The following components of the field will display in Screen Field Editor:
Editing Field: synonymous with Field Data Name in Field Editor. A unique identifier for the field. Once a field is saved, the Editing Field name cannot be changed. No two data fields have the same Editing Field name.
Database Field: a unique identifier for the field in the screen. The Database Field name cannot be changed. No two data fields have the same Database Field name.
Display Name: How the field name will display in the screen. Modifying this will only impact the screen you're editing.
Data Quality Check: this can be set to -
- Not Required: the screen can be saved if the field is left unanswered.
- Soft Required: the screen can be saved if the field is left unanswered. However, the field will briefly have a yellow underline when it's saved. In addition, a yellow warning ribbon will flash across the top of the page, encouraging the user to check soft required fields for accuracy (figure 3).
- Required: The screen cannot be saved until the field is answered. Trying to save changes after leaving a required field blank will cause the data field to turn red. A red warning ribbon appears at the top of the page (figure 4). If the user doesn't enter a response, the screen cannot be saved.
Hide: hides the field in the screen. For more information, see Hidden Fields.
Read Only: prevents users from editing this field in the screen.
- If Agency Sensitive Data and Any Agency Sensitive Data are toggled off: the staff member will only be able to see sensitive data they entered.
- If Agency Sensitive Data is toggled on and Any Agency Sensitive Data is toggled off: the staff member will be able to see sensitive data entered by any staff members at the agency.
- If Agency Sensitive Data is toggled on and Any Agency Sensitive Data is toggled off: the staff member will be able to see sensitive data entered by any staff member at any agency.
|Note: Sensitive Data cannot be enabled for fields in Profile Screens because Profile Screens are either public (all agencies can see the data) or private (data is only visible to the staff members at the agency entering the data).|
Size: determines the width (and in the case of text boxes, height) of the field or dropdown menu. For example, a dropdown menu with words will require a wider dropdown menu size than a dropdown with just numbers.
The size of a field is defined by a number (figure 5).
This number is used to determine the number of pixels the field will display with using the formula x*9+30. So, if the size is "50" this will display as 50*9+30 or 480 pixels.
There are two additional sections within Screen Field Editor: Display Constraints and Calculations.
For more information on using constraints, see the article Screen Field Editor: Display Constraints.
Calculations are used to create a response for the field based on mathematical formulas applied to other fields in the screen. Any field with a Field Type of "Number" or "Dollar" can have a calculation added to it and be used in a calculation.
To create a new calculation, click Add Calculation (figure 5).
There are three settings to configure for a calculation: Action, Based on Field, and Value.
Action: the mathematical formula to apply to the field. The options are addition, subtraction, multiplication, and division.
Based on Field: the field to which the mathematical operation will be applied (or "Fixed Number").
Value: only applicable if "Fixed Number" is selected for the Based on Field. The value for the fixed number to which the action will be applied.