ELIS Custom fields examples

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here: ELIS Custom fields examples.

Custom Field Examples

To access the Custom fields go to the Program Management block > Admin > Custom fields. From there use the tabs at the top of the page to navigate to a section and create a new field. Custom fields are added to categories, if there isn't a category on the page one will need to be added.
elis customfield input types.png
There are 6 custom field input control types:
  1. Checkbox
  2. Dropdown menu
  3. Text input
  4. Text area
  5. Password input
  6. Date/time

The control types are selected on the creating/editing screen for custom fields. The following image of this screen shows the Manual editing section of the form.
elis customfield input types2.png

Checkbox

To demonstrate the checkbox input control type I will create a custom track field. The first image shows the first section of the screen to create a custom field, the Common settings section.

The short text data type has been selected for this example. This data type enables a list to be added with a checkbox next to each value.
elis customfield checkbox.png
The following image shows the second section of the custom field creation screen, the Manual editing section. The input control type is selected here, checkbox is selected in this example. Since we are using the short text data type, we can add a list of values that will be shown when adding a track.
elis customfield checkbox2.png
This image is showing the Add Track screen with the custom field we just added.
elis customtrackfield.png

Dropdown Menu

To demonstrate the dropdown menu input control type I will create another custom track field. The name of this custom field is Track Color. In the following image I am creating the custom field, I have scrolled down near the Manual editing section.

  1. The short text data type has been selected.
  2. The dropdown menu input control type has been selected.
  3. 4 values or options have been added. I add the 'none' option for a default value, because with this setup the first option will be automatically assigned to new tracks unless edited.
elis customfield dropdown.png
The following image shows the add track screen with the new dropdown menu custom field.
elis customtrackfield menu.png

Text Input

This is an example of the text input type. I'll be creating another custom track field for this example. The following screen is showing the Common settings section for this new field.

  1. Shortname of the new custom field
  2. Name
  3. The Data type will be "long text"
elis customtrackfield textinput.png
The next image shows the manual editing section. For the input control type, Text Input has been selected from the drop down menu.
elis customtrackfield textinput2.png
Save changes and the new option is displayed on the add/edit track screens. For this field, just add the text.
elis customtrackfield textinput3.png

Text Area

This example will demonstrate the "text area" input control type. The following image is showing the setup screen for this custom field.

  1. "Long text" has been selected for the Data type.
  2. "Text area" has been selected for the Input control type
elis customtrackfield textarea.png
The following image shows the new custom field on the add/edit track screen. This Input control type enables an html editor.
elis customtrackfield textarea2.png

Password Input

The following use case will demonstrate a Password Input type profile field:

An administrator wants to assign users to user sets by sending them a password that they will enter in a survey, which updates their profile and assigns them to a user set.

First, create a custom Moodle profile field. Go to the Administration block > Users > Accounts > User profile fields. The are a couple reasons why we create a Moodle profile field first:

  1. User sets use Moodle profile fields to auto-assign users to user sets.
  2. The survey will use the Moodle profile field.
  3. Custom user fields in ELIS are created from Moodle profile fields. In this use case the custom user field in ELIS isn't necessary, but we will create it and synchronize it to copy values from Moodle anyways.

Adding the Moodle profile field:
elis passwordprofilefield.png
Create the ELIS custom user field. Go to the Program Management block > Admin > Custom Fields > User tab. Select the Moodle field that will be used to create this field.
elis customuserfield.png
Edit the settings for the new field.
elis customuserfield settings.png
Save changes when finished.

Now we will create the user set. The user set is being auto-associated with the Moodle profile field "Password Input" and the password "1234". Other user sets could be created and assigned different passwords, e.g., 12345.
elis passworduserset.png
The new profile field needs to be added to the survey. We are adding the Moodle profile field to the survey.
elis updatingsurvey.png
The administrator sends the users a password that they enter in the profile survey. In this example the password is 1234.
elis completingsurvey.png
When users enter their password in the profile survey it updates their profile, which auto-associates them with the user set. The user set could be auto-associated with programs/tracks - auto-enrolling users of the user set in programs, tracks, and classes.