Evidence type settings
    • 19 Oct 2022
    • 5 minutes to read

    Evidence type settings


    Article Summary

    There are only a few settings for evidence types, as most of the content of the evidence type is controlled by the custom fields added. 

    SettingDescriptionNotes

    Type name

    The name of the evidence type. This should be descriptive. 

    This is a required field.

    Type ID number

    A unique ID number for the evidence type. 

    -

    Type description

    A description of the evidence type - this can be used to guide other users when selecting it. 

    -

    Custom field types

    There are a number of different types of custom fields to choose from. 

    Field typeDescription

    Checkbox

    Presents a checkbox that can be ticked. 

    Date/time

    Enables users to enter a date and time. 

    File

    Enables users to add a file.

    Location

    Enables users to configure and display a location. 

    Menu of choices

    Presents a dropdown menu of options. 

    Multi-select

    Presents a number of options with checkboxes and icons (you can choose multiple options).

    Text area

    Allows the user to enter text and other content (such as images, hyperlinks, and attachments). 

    Text input

    Allows the user to enter text. 

    URL

    Allows the user to enter a URL.

    Custom field settings

    When creating a custom field you can configure the following settings.

    Setting
    Description
    Notes

    Full name

    The full name of the custom field - this should be descriptive. The name entered here will be presented to the user when entering data.

    -

    Short name (must be unique)

    This must be unique.

    -

    Description of the field

    This is for your own reference. 

    -

    Is this field required

    This option specifies whether this is a mandatory or optional field. 

    -

    Is this field locked?

    This option determines whether once information is populated in this field, it cannot be edited by the user.

    -

    Should the data be unique?

    If you need the information populated in your field to be unique across the system (such as an ID number) select Yes for this option and a validation check will be performed on the data entered.

    Does not appear for File or URL custom field types. 

    Hidden on the settings page?

    When set to Yes the custom field will not be visible on the settings page or elsewhere where it would have been shown. When No is selected the custom field will be visible.

    -

    Checked by default

    When set to Yes the Custom field checkbox will be checked by default. When set to No the Custom field checkbox will not be checked by default. (Checkbox)

    Checkbox custom field type only. 

    Start year

    Set the start year to be used in the date field. 

    Date/time custom field type only.

    End year

    Set the end year to be used in the date field. 

    Date/time custom field type only.

    Include time?

    Check the box to include time as well as date. 

    Date/time custom field type only.

    Default address

    Enter a default address or leave this blank. 

    Location custom field type only.

    Default map size

    Choose the default display size for the map from either small, medium, or large.

    Location custom field type only.

    Default map view

    Decide the default view of the map. Choose from:

    • Map
    • Satellite
    • Map & satellite (hybrid)

    Location custom field type only.

    Default display

    Decide what you want to be displayed for the location field. Choose from:

    • Map & address
    • Map
    • Address

    Location custom field type only.

    Set map location

    You can set the map location using the address entered into Default address (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 clicking on it while holding the mouse button, moving the pin and then releasing the mouse button.

    Location custom field type only.

    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 Client ID and set it within Totara.

    Menu options (one per line)

    Enter the menu options that will appear in the dropdown box. Only enter one option per line.

    Menu of choices custom field type only.

    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.

    Menu of choices custom field type only.

    Menu options (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 select the Choose icon link to browse for image with file picker. For each option you can also select 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) and a Delete link if you want to remove that option. 

    Underneath the list of options there is an Add another option link so you can add additional menu options.

    Multi-select custom field type only.

    Default value

    Enter any text you want to 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.

    Text area custom field type only. 

    Columns

    Columns sets the width of text area custom field. If a text editor plug-in is applied to the text area, the width will be determined by the plugin and changing this value may have no effect.

    Text area custom field type only.

    Rows

    Rows 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 area custom field type only.

    Default value

    Enter any text you want to appear in the text input 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.

    Text input custom field type only.

    Display size

    Display size sets the number of characters that will be displayed in the text field.

    Text input custom field type only.

    Maximum length

    Maximum length sets the maximum number of characters the text field will accept.

    Text input custom field type only.

    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.

    Text input custom field type only.

    Description of regular expression validation format

    Add description message explaining required format to users.

    Text input custom field type only.

    Default URL

    Enter a default URL to be used or leave this field blank. 

    URL custom field type only. 

    Default text

    Default link text to be displayed. If empty the URL will be used.

    URL custom field type only. 

    Open in a new window

    Check the box to open the URL in a new window.

    URL custom field type only.

    © Copyright 2024 Totara Learning Solutions. All rights reserved.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.