Course custom field settings
- 28 Mar 2024
- 4 minutes to read
Course custom field settings
- Updated on 28 Mar 2024
- 4 minutes to read
Article summary
Did you find this summary helpful?
Thank you for your feedback
When creating a course custom field you can configure the following settings.
Common settings
| Setting | Description | Notes |
|---|---|---|
| Full name | The complete title of the custom field. | - |
| Short name (must be unique) | The abbreviated name of the custom field, which can be used for display purposes. Custom fields will appear as options on the Edit item screen for position items. | - |
| Description | Add a description to explain the purpose of the custom field. | - |
| Is this field required? | When set to Yes, the field is compulsory. | Note that this setting cannot be changed for Decimal input and Integer input custom fields, as it’s important that empty strings are not stored for these field types. |
| Is this field locked? | When set to Yes, the field only displays the information set when the field was set up. | - |
| Should the data be unique? | When set to Yes, the field only accepts unique values. | Does not appear for the File or URL custom field types. |
| Hidden on the settings page? | When set to Yes, the field is not displayed on the competency framework overview page. | - |
Checkbox
| Setting | Description | Notes |
|---|---|---|
| Checked by default | When set to Yes, the checkbox will be checked by default. When set to No, the checkbox will not be checked by default. | - |
Date/time
| Setting | Description | Notes |
|---|---|---|
| Start year | The earliest year you can use. | - |
| End year | The most recent (future) year you can use. | - |
| Include time? | Tick to include a time. | - |
Decimal input
| Setting | Description | Notes |
|---|---|---|
| Default value | The number that will appear in the field by default. | - |
| Minimum value | The lowest value that will be accepted. | - |
| Maximum value | The highest value that will be accepted. | - |
| Step | The accepted increments for values in this field. For example, if this is set to 0.5 then the field will accept values such as -1.0, -0.5, 0, 0.5, 1.0, 1.5, etc. | - |
| Decimal points | The number of decimal points that the field will accept. | - |
File
Choosing this custom field creates a file upload field. There are no specific settings for this field type.
Integer input
| Setting | Description | Notes |
|---|---|---|
| Default value | The number that will appear in the field by default. | - |
| Minimum value | The lowest value that will be accepted. | - |
| Maximum value | The highest value that will be accepted. | - |
| Step | The accepted increments for values in this field. For example, if this is set to 5 then the field will accept values such as -5, 0, 5, 10, 15, etc. | - |
Location
| Setting | Description | Notes |
|---|---|---|
| Default address | Optionally enter a default address to be displayed. | - |
| Default map size | Choose from:
| - |
| Default map view | Choose from:
| - |
| Default display | Choose from:
| - |
| Set map location | You can set the map location using the address above (if provided), or search for an address, town or city. If you want to refine the location of the pin, you can do so by dragging and dropping it. | Please check that your site adheres to the Google Maps JavaScript API Terms Of Service before changing the view to include a map. We strongly recommend you get a Google Maps JavaScript API Key or a Client ID and set it within Totara. |
Menu of choices
| Setting | Description | Notes |
|---|---|---|
| Menu option (one per line) | Enter the menu options that will appear in the dropdown box. Only enter one option per line. | - |
| Default value | Set the default value that will appear in the dropdown box. The default value must appear in the menu options above. Leave blank if there is no default entry required. | - |
Multi-select
| Setting | Description | Notes |
|---|---|---|
| Menu option (and icons) | Enter the multi-select options (and icons) that will appear in the dropdown box. There is a text box to enter the options, alongside this you can then click Choose icon link to browse for image with the file picker. For each option you can also click Make selected by default to select that option as default (the user would have to unselect it if they do not want to select it). You can add additional menu options by clicking Add another option. | - |
Text area
| Setting | Description | Notes |
|---|---|---|
| Default value | The text that will appear in the text area by default. This could be instructions e.g. 'Enter your text here...' or a default answer value. Leave this field blank if no default text is required. | - |
| Columns | This setting sets the width of the text area. If a text editor plugin is applied to the text area, the width will be determined by the plugin, and changing this value may have no effect. | - |
| Rows | This setting sets the height of the text area custom field (the number of lines). If a text editor plugin is applied to the text area, the height will be determined by the plugin, and changing this value may have no effect. | - |
Text input
| Setting | Description | Notes |
|---|---|---|
| Default value | The text that will appear in the text field by default. Leave this field blank if no default text is required. | - |
| Display size | Sets the number of characters that will be displayed in the text field. | - |
| Maximum length | Sets the maximum number of characters the text field will accept. | - |
| Regular expression validation | A regular expression that will be used to ensure entered text is in the expected format. For example, /^[0-9]{3}$/ will ensure the text consists of exactly three numbers. This validation is performed only when submitting forms with custom fields. Current data is not affected after validation is changed. For more information on regular expressions please refer to the PHP PCRE regular expression documentation. | - |
| Description of regular expression validation format | Add a description message explaining the required format to users. | - |
URL
| Setting | Description | Notes |
|---|---|---|
| Default URL | Enter a default website address. | - |
| Default text | Default link text to be displayed. If empty, the URL will be used. | - |
| Open in a new window | Enable this setting to open the link in a new window. | - |
© Copyright 2024 Totara Learning Solutions. All rights reserved. Some content originally obtained via GPLv3 license and continues to be available under GPLv3. All other content is the sole copyright of Totara Learning Solutions.
Was this article helpful?
