Skip to content

Create a multiple choice field

This guide shows how to create a custom multiple choice field and use it in a DataChecker configuration.

Example

The example creates a support_needs Flex Field with three possible values:

  • food;
  • cash;
  • shelter.

The field will allow selecting more than one value.

1. Create a Field Definition

Open Field Definitions, click Add Field Definition, and create a new record:

  • Name: Support needs choices;
  • Field type: CustomMultipleChoiceField;
  • Description (optional): Multiple choice field for household support needs.

Save the record.

Open the created Field Definition and click Configure.

Set the field attributes:

{
  "label": "Support needs",
  "required": false,
  "help_text": "Select one or more support needs.",
  "choices": [
    ["food", "Food assistance"],
    ["cash", "Cash assistance"],
    ["shelter", "Shelter support"]
  ]
}

Save the configuration.

Use Test to check that the field accepts one or more selected values.

2. Create or update a Fieldset

Open Fieldsets and create or select the Fieldset that should contain the support_needs field.

For this example, click Add Fieldset and create a new record:

  • Name: Household support needs;
  • Description: Fields related to household support needs.

Leave Extends, Content type, Group, and Validation empty.

Save the record.

This Fieldset will group the fields related to household support needs.

3. Create a Flex Field

Open Flex Fields, click Add Flex Field, and create a new record:

  • Name: support_needs;
  • Definition: Support needs choices;
  • Fieldset: Household support needs.

Leave Master and Overrides empty.

Save the record.

The support_needs name is used in imports, validation, and beneficiary data.

4. Add the Fieldset to a DataChecker

Open DataCheckers and create or open the DataChecker that should include this Fieldset.

For this example, create a new record:

  • Name: Household support needs checker;
  • Description: Validation configuration for household support needs.

In Data Checker Fieldsets, add the new Household support needs Fieldset together with the existing Fieldsets required by the beneficiary structure.

For example, add:

  • HOPE Household core;
  • HOPE Admin Areas;
  • Household support needs.

For the Household support needs Fieldset, use:

  • Prefix: empty;
  • Order: according to the beneficiary structure;
  • Override group default value: unchecked, unless the beneficiary structure requires a group override.

Save the record.

The DataChecker is the final validation configuration that can be assigned to a Program.

5. Check the final configuration

Open the DataChecker and use:

  • Inspect to check that support_needs is included in the generated field structure;
  • Test to validate the field manually;
  • Create XLS importer to generate an import template;
  • Validate to test a sample import file.

Example valid values for import:

food,cash

or:

food cash

The value will be treated as a list of selected choices.