All guides & tutorials
in this lesson
1
Video
2
What reference types are
3
Where to find reference types
4
Create a reference type
5
Add the values (references)
6
Use the reference type in a field
7
Bulk import values via CSV
8
9
10
11
share
Video tutorial
Curriculum

Curriculum: Reference types (dropdowns)

This guide explains how to create a reference type (option list) and its values, how to use it in a custom field as a dropdown, and how to import values in bulk via CSV.

in this lesson
1
Video
2
What reference types are
3
Where to find reference types
4
Create a reference type
5
Add the values (references)
6
Use the reference type in a field
7
Bulk import values via CSV
8
9
10
11
Requirements

Video

This video explains how to create a reference type (option list) and its values, how to use it in a custom field as a dropdown, and how to import values in bulk via CSV.

The article below is AI generated based on the video.

What reference types are

A reference type is an option list that you define yourself, for example a list of teaching languages, delivery modes or project types. Once a reference type exists, it can be used in a custom field so that users pick a value from a dropdown instead of typing free text.

This guide creates the reference type Teaching language with four values. That is the list used for the Teaching language field in Custom types and fields. Create the reference type first, then the field that uses it.

Where to find reference types

Go to Administration -> Objects -> Reference types. The page is described as: Create and configure option lists, such as literature, project types, or employee types. These reference types can be used in custom fields.

The overview lists all reference types with their External ID, Code and Name, for example closureType, competences, country, deliveryModes, ft-pt, level, locations, modeOfStudy and yes/no.

  • Use the search box to filter the list.
  • Click + Add to create a new reference type.
  • Use the page-size options (5 / 10 / 25 / 50 / 250) at the bottom to show more rows.

Reference types are lists you create yourself. Lists that the system itself relies on are Elements (Administration -> Objects -> Elements).

Create a reference type

  1. On the Reference types page, click + Add. The dialog Add new reference type opens.
  2. Fill in the External ID, for example teachingLanguage.
  3. Fill in the Code (required), for example teachingLanguage.
  4. Fill in the Name per language (EN / NL / SV), for example EN Teaching language.
  5. Click Save. The message The data has been saved appears and the new type is added to the overview.

Add the values (references)

Click the new reference type to open it. The detail page has three tabs: Type, Fields and Lists. The Type tab shows the External ID, Code and Name, a Used in fields section, and a table of the values in the list. The table is empty at first (No results found).

To add a value:

  1. Click + Add above the values table. The dialog Add reference opens.
  2. Fill in the External ID, the Code (required) and the Name per language, for example English for all three.
  3. Optionally fill in the other settings (see the table below).
  4. Click Save.

Repeat this for every value, for example English, Dutch, Swedish and French. The table shows each value with its Code, Name, Sequence, Default selected, Active, Start date and End date.

Setting in Add referenceNotes
External IDIdentifier of the value.
CodeRequired.
Name (EN / NL / SV)Text shown to users in the dropdown.
SequenceDisplay order.
ParentDropdown.
OwnerDropdown.
Default selectedToggle.
Start date / End datePeriod in which the value is valid.
ColorColor picker with HEX value.

‍

Conditional lists

The Lists tab is for conditional lists: subsets of the values (Reference lists with a Name, Sequence and Condition, plus the Items they contain).

Use the reference type in a field

Create a custom field with value type Reference and select this reference type as its Subtype. Users then see the values as a dropdown on the object.

Step-by-step instructions are in Curriculum: Custom types and fields.

Bulk import values via CSV

For longer lists, values can be imported instead of added one by one.

  1. Go to Administration -> System -> Import CSV. Uploads can apply historic changes, so use this with caution and test in a test environment first.
  2. Set Type to REFERENCE. Separator (,) and Quote (") are filled in by default.
  3. Select the CSV file and upload it.

Once the type is selected, the page shows the documentation for the CSV columns:

ColumnDescriptionTypeRequiredExample
yearAcademic yeartext2023
facultyFaculty identifiertext2900
typeReference typetext✔STUDY_TYPE
reference_idReference identifiertext✔BACHELOR
codeReference codetext✔B
abbreviationReference abbreviationtextBA
name-EN (one per language)Reference nametextBachelor
description-EN (one per language)Reference descriptiontextBachelor programme
categoryCategory nametextSTUDY
versionVersion numbertextv1
start_dateFirst date when reference is activedate2023-01-01
end_dateLast date when reference is activedate2040-01-01
sequenceSequence number, used for orderingnumber1
owner_typeOwner typetext
owner_idOwner identifiertext
parent_idParent identifiertext

Custom values can be added to the default CSV configuration, with the column header containing the unique name of the custom type.

More Guides & Tutorials