Managing List of Values

  • Article

List of Values (LoV) or Enums are used throughout the system. LoVs are used to validate incoming data based on corresponding data types that are being associated. Also see Default List of Values for the full list of default types and values.

We're allowing the ability to extend and manage specific data types.

  • Academic Subjects
  • Demographic: Ethnicity
  • Demographic: Race
  • Grade Level
  • Organization Types
  • Person Flags

Matching and validation handling for LoV (ENUMS)

During data processing School Data Sync (SDS) validates data, bringing in good data to the data lake and flagging bad data.

To determine the health of the data, the data is passed through data matching and validation rules. The rules are to help safeguard good required and optional data only going into the data lake. Data that doesn't pass validation is identified as errors or warnings and isn't sent to the data lake.

For default and customer defined LoVs, the following matching and validation handling are used. For more information, see Data Health and Monitoring when an incorrect code value is passed for a LoV.

Matching Validation Value Stored
Case Insensitive Match to lower case As LoV code value

Important

Leading zeros ‘0’ missing on incoming value for Grade Level LoV, for example ‘1’, will match defined List of Value ‘01’ and will be stored as ‘01’.

Add Customer Defined LoV

Warning

Reference Code values have to be unique. For example you can not create another Organization reference code value of 'School'or 'school'. Display names can't be longer than 255 characters.

  1. Navigate to 'Settings' | 'List of Values'.
  2. Select the option Add to List of Values. You see a fly-out window.
  3. Select the dropdown for manageable options available for the List of Value type. Select the appropriate type from the options presented.
  4. Enter the code / text for the Value reference code that corresponds to the incoming data you're sending. The value CAN NOT be edited after adding the value.
  5. Enter text for the Display name for the reference code value. The text may be used to display a friendly string in the SDS UI. The value CAN be edited after adding the value.
  6. Select Add. A progress message is presented and will close the fly-out.
  7. When the new LoV is added a confirmation message is shown. You can navigate to the List of Value type to see your new LoV. The Created by column shows 'Customer' with Status column showing 'Enabled'.

Edit Customer Defined LoV

Note

You can edit the Display name but not the LoV Reference Code value or type.

  1. Navigate to 'Settings' | 'List of Values'.
  2. Expand the List of Value type for the LoV you wish to edit.
  3. Select from the list presented the corresponding row for the LoV you wish to edit. You see a fly-out window.
  4. Enter the updated Display name text and select Update. A progress message is presented and will close the fly-out.
  5. When the LoV is updated a confirmation message is shown.

Disable Customer Defined LoV

Important

You can disable but not delete a customer defined LoV. This is because historical data may be tied to the code value from previous data runs. Disabling keeps the integrity of the data but allows you to no longer allow future uploaded data records to be associated to the LoV based on the passed Reference Code value.

  1. Navigate to 'Settings' | 'List of Values'.
  2. Expand the List of Value type for the LoV you wish to disable.
  3. Select from the list presented the corresponding row for the LoV you wish to disable. You see a fly-out window.
  4. Update the Status toggle to 'Disabled' and select Update. A progress message is presented and will close the fly-out.
  5. When the LoV is updated a confirmation message is shown.

Enable Customer Defined LoV

Important

Historical data tied to the code value from previous data runs will still remain. Enabling will allow future uploaded data records to be associated to the LoV based on the passed Reference Code value.

  1. Navigate to 'Settings' | 'List of Values'.
  2. Expand the List of Value type for the LoV you wish to enable.
  3. Select from the list presented the corresponding row for the LoV you wish to enable. You see a fly-out window.
  4. Update the Status toggle to 'Enabled' and select Update. A progress message is presented and will close the fly-out.
  5. When the LoV is updated a confirmation message is shown.