Optional profiles: Difference between revisions

Revision as of 16:35, 23 June 2025

Similar to additional user profile fields in core Moodle, IOMAD allows for administrators to set up custom profile fields on a per-tenant basis.

Go to the IOMAD dashboard.
Choose the company you'd like to edit from the Select a company dropdown (or use the company selector at the top right of the page).
Click on the Companies tab.
Select Optional profiles.

To create a new profile field, select the desired field type from the Create a new profile field dropdown menu. The types of field available here are identical to those in core Moodle:

Checkbox
Date/Time
Drop-down menu
Social
Text area
Text input

Common settings

Shortname

Required. Short code or other identifier for the profile field. This must be unique, and can only contain alphanumeric upper- or lower-case characters (no underscores). Shortnames are case insensitive, so a field named myfield and one named MyField do not pass requirements for uniqueness and wouldn't be allowed.

Name

Required. Full name of the field.

Description of the field

Short summary describing what the field contains.

Is this field required?

Set this to Yes to make the field compulsory for new users. Existing users will be prompted to complete and submit the field when they next log in.

Is this field locked?

If Yes, the value entered by the user can't then be edited by the user afterwards.

Should the data be unique?

If Yes, data is validated to ensure that the field is unique tenant-wide (e.g. for institutional ID numbers and so on).

Display on signup page?

If Yes and self-registration is enabled, users who self-signup will see the field on the registration form.

Who is this field visible to?

Can be set to Visible to everyone (default), Visible to user, or Not visible.

Visible to everyone: All users can view the contents of this field for any other user.
Visible to user: The user can only view the contents of their own instance of the field, but can't view that of others. Still visible to site administrators.
Not visible: Can only be viewed by a site administrator.

@@ Line 1: / Line 1: @@
+Similar to [https://docs.moodle.org/en/User_profile_fields additional user profile fields] in core Moodle, IOMAD allows for administrators to set up custom profile fields on a per-tenant basis.
+# Go to the '''IOMAD dashboard'''.
+# Choose the company you'd like to edit from the '''Select a company''' dropdown (or use the company selector at the top right of the page).
+# Click on the '''Companies''' tab.
+# Select '''Optional profiles'''.
+To create a new profile field, select the desired field type from the '''Create a new profile field''' dropdown menu. The types of field available here are identical to those in core Moodle:
+*Checkbox
+*Date/Time
+*Drop-down menu
+*Social
+*Text area
+*Text input
+==Common settings==
+;Shortname : ''Required.'' Short code or other identifier for the profile field. This must be unique, and can only contain alphanumeric upper- or lower-case characters (no underscores). Shortnames are case insensitive, so a field named ''myfield'' and one named ''MyField'' do '''not''' pass requirements for uniqueness and wouldn't be allowed.
+;Name : ''Required.'' Full name of the field.
+;Description of the field : Short summary describing what the field contains.
+;Is this field required? : Set this to ''Yes'' to make the field compulsory for new users. Existing users will be prompted to complete and submit the field when they next log in.
+;Is this field locked? : If ''Yes'', the value entered by the user can't then be edited by the user afterwards.
+;Should the data be unique? : If ''Yes'', data is validated to ensure that the field is unique tenant-wide (e.g. for institutional ID numbers and so on).
+;Display on signup page? : If ''Yes'' and self-registration is enabled, users who self-signup will see the field on the registration form.
+;Who is this field visible to? : Can be set to Visible to everyone (default), Visible to user, or Not visible.
+:* '''Visible to everyone:''' All users can view the contents of this field for any other user.
+:* '''Visible to user:''' The user can only view the contents of their own instance of the field, but can't view that of others. Still visible to site administrators.
+:* '''Not visible:''' Can only be viewed by a site administrator.
 [[Category:Company]]