Screens

Screen Field Editor Overview

 

Overview

Data is collected in screens through fields.

  • When you edit a field in FIELD EDITOR, the modifications will apply to that field wherever it appears in Clarity Human Services.
  • When you modify within a screen, those modifications will only apply to that particular screen. These modifications take place in the SCREEN FIELD EDITOR.

 

This article explains the different ways to modify fields within screens. For information about adding fields to screens, see Creating and Editing Screens

Editing Fields in Screen Field Editor

Navigate to SETUP > SCREENS and click the Edit icon next to the screen where the field you want to edit is used. The SCREEN EDITOR opens.

Click the Edit icon next to the field you want to edit. This will take you to the 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 you save a field, you cannot change the Editing Field name. No two data fields have the same Editing Field name. 

Database Field: a unique identifier for the field in the screen. You cannot change the Database Field name. 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 the following:

  • 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.
  • 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. If you don't enter a response, you cannot save the screen.

 

Hide: hides the field in the screen. For more information, see Hidden Fields

Read Only: This prevents users from editing this field in the screen. 

Disable Data Cascade: prevents the data entered in that specific field from cascading to other program enrollments.

Sensitive Data: a staff member's ability to see data entered for the field in the screen will be determined by the access rights enabled for the staff member's access role.

  • If Agency Sensitive Data and Any Agency Sensitive Data are toggled off, the only sensitive data the staff member will see is the sensitive data they have entered. 
  • If Agency Sensitive Data is toggled on and Any Agency Sensitive Data is toggled off, the staff member can 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 on, the staff member can see sensitive data entered by any staff member at any agency.

Note: The following fields, which are integral to client records and federal reporting, cannot be marked as Sensitive Data:

  • assessment_date
  • program_date
  • clients.alias
  • non-custom fields on the Profile screen  
      • Note that this change does not affect whether a field can be marked sensitive on other screens; for example, Veteran Status can’t be marked as sensitive on a Profile screen but could be marked as sensitive on an Enrollment screen.

 

Field Marker: if the Field Marker functionality has been enabled for this field in the FIELD EDITOR, you can turn this toggle on to allow data to cascade from a Housing Inventory setup screen to the screen below it.

If you turn on the Field Marker toggle for a field:

  • The field will be read-only on the screen.
  • The Display Name will be editable. 
  • The system will look at the value of that field on the screen above it and insert that value. The value will be displayed on the screen when in use unless Hide is toggled on.
  • After you SAVE CHANGES, the system hides the following fields:
    • Data Quality Check
    • Read Only
    • Sensitive Data
  • When you save the screen, you will see the following pop-up: “If there is existing data associated with this field on this screen, enabling Field Marker may overwrite that data. Please confirm.”

Size: determines the width (and in the case of text boxes, height) of the field or drop-down menu. For example, a drop-down menu with words will require a wider drop-down menu size than a drop-down with just numbers.

The system defines the field size by a number.

This number determines the width of the field in pixels, using the formula x*9+30. So, if the size is "50," this will display as 50*9+30 or 480 pixels. 

Display on Inventory Card: This setting is available for custom fields that are attached to Housing Inventory screens. Toggle this setting on if you want to display this field in the More Information section of the Unit Card on the Inventory Tab.

 

Display Constraints and Calculations

SCREEN FIELD EDITOR includes two additional sections: DISPLAY CONSTRAINTS and CALCULATIONS. 


DISPLAY CONSTRAINTS

For more information on using constraints, see the article Screen Field Editor: Display Constraints.


CALCULATIONS

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.

For example, suppose we want a field on a screen that calculates a client's total available balance by adding the number in Savings plus the number in Checking.

First, we ensure that the fields we will need for this calculation have been created and added to the screen where we want to use the calculation. In this example, we need a field for entering the number in Savings, a field for entering the number in Checking, and a field for calculating and displaying the number in Total Available.

Next, we click the Edit icon next to the field where we want the calculation result to appear (in this case, Total Available). Scroll down to the CALCULATIONS section and click ADD CALCULATION.

The ADD CALCULATION window appears, displaying the 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 or the fixed number to which the mathematical operation will be applied. When you click the drop-down arrow, you will see the "Fixed Number" option displayed, along with the fields on the screen that have a Field Type of "Number" or "Dollar."

Value: the value for the fixed number to which the action will be applied. It only applies if you select "Fixed Number" for Based on Field.

For our example, we will start by adding Savings. So we select "Addition" for the Action, select "Savings" as the Based on Field, and click SAVE. 

Savings has now been added to the Total Available field.

Next, we will add Checking. So we click ADD CALCULATION again, and select "Addition" again, but this time we select "Checking" as the Based on Field. Click SAVE.

Checking has now been added to the Total Available field. So we have created a calculation in the Total Available field that adds Savings and Checking.

When we go back to the SCREEN EDITOR for this screen, we see that our Total Available field is displayed with a calculator icon to indicate that it includes a calculation.


To complete our example, let's look at what happens when this screen is in use. As shown below, the Total Available field starts at 0. It is updated with the new total as you enter Savings and Checking

 

Audit Log

Click the button in the lower right corner of the SCREEN FIELD EDITOR to access the Audit Log.audit_log.png