Several custom fields with predefined selection options support multi-step configuration beyond their basic settings. A list of values can depend on a selection in another field, retired options can stay hidden while their historical data is preserved, and the value saved to the system can differ from the value shown to users. For the full list of input type settings, see Custom Fields: Common Input Types Settings Reference.
Who: Global administrators and system administrators
When to Use Advanced Options for Predefined Selection Fields
Use advanced options for predefined selection fields when:
- Conditional lists fit a field whose available values depend on another field's selection.
- Retired options fit list values that must be hidden but kept for historical records.
- Stored and displayed values fit a field where the value saved to the system needs to differ from the value shown to users, such as for translation.
- Default selected options fit a field where one option should be selected on page load, such as to support dynamic field visibility controls.
Set Up Conditional Lists of Values
The selectable values in one custom field can depend on the selection made in another field. The controlling field is the Parent Field, and the dependent field is the Child Field.
Child fields can include the following selection type custom fields:
- Lookup - Autocomplete Options - Presents a collection of values in an Ajax lookup box. It lets users select more than one value and can look up values from an external source.
- Select Many - Checkboxes - Presents values as checkboxes so users can select multiple values. View mode shows the selected values separated by semicolons.
- Select One - Radio Buttons - Presents values as radio buttons so users select a single value.
- Select One - Dropdown List - Allows users to choose one value from a drop-down menu.
To set up a conditional list of values:
- Navigate to the child field. See the Access the Configuration Page for Custom Fields section of the Configure Custom Fields article.
- Click the General Settings tab.
- Click the Parent Field, and select the relevant field from the drop-down menu.
- The selected field provides the dependent values as the Parent Field.
- Click the Predefined Options field, enter each set of dependent values wrapped in the
ssOptionsyntax, which names the parent value that displays them, and click Save.
Example
The following example shows Ontario and British Columbia only when Canada is selected in the Country field, and Texas only when United States is selected:
--Select One--<ssOption:Canada>;Ontario;British Columbia</ssOption><ssOption:United States>;Texas</ssOption>
Configure Retired Options
Retired options hide list values that are no longer in use and keep them for historical records.
To configure retired options:
- Navigate to the relevant custom field. See the Access the Configuration Page for Custom Fields section of the Configure Custom Fields article.
- Click the Predefined Options field, and enter the values to retire wrapped in the
ssRetiredOptionstag, with a semicolon before and after the tag.- If a value to retire is first in the list, move it to the end of the list, because retired values must never be first.
- Click Save.
Example
The following example hides values 5 and 6 from the list and keeps them available in existing records:
1;2;3;<ssRetiredOptions>5;6</ssRetiredOptions>;7;8
Default selected options fit a field where one value should be selected when the page loads, such as when dynamic field visibility controls depend on a particular option.
Set a Default Selected Option
A leading equal sign before an option in a predefined selection field makes that option selected when the page loads. Without a default, all options are blank.
To set a default selected option:
- Navigate to the relevant custom field. See the Access the Configuration Page for Custom Fields section of the Configure Custom Fields article.
- Click the Predefined Options field, and add a leading
=before the option to select by default.- Set a default option with this structure: Option1;=Option2;Option3
- Click Save.
Good Example
The following default works well when email is the standard notification method:
- Notification Preference = Email
Bad Examples
The following defaults make it difficult to tell whether an applicant chose the value or accepted the preset:
- Do you agree with the terms? = Yes
- Are you a Canadian resident? = Yes
- Which product are you interested in? = Product A
Set Up Stored and Displayed Values
Several selection type custom fields let the value stored in the field differ from the value displayed to the user. The stored value stays the same across languages while the displayed value can change, which supports translation.
These settings apply to Select Many - Checkboxes, Select One - Radio Buttons, Lookup - Autocomplete Options, and Select One - Dropdown List custom fields.
To set up stored and displayed values:
- Navigate to the relevant custom field. See the Access the Configuration Page for Custom Fields section of the Configure Custom Fields article.
-
Click the Predefined Options field. Enter values using this syntax, where the value before the equal sign is stored and the value after the equal sign is displayed but not saved:
StoreValue1=DisplayValue1;
StoreValue2=DisplayValue2; StoreValue3=DisplayValue3; - The
StoreValuemust stay consistent across all languages.
- The
- Click Save.
Example
The following example shows a selection field where Yes, No, and Maybe are the displayed options, and 1, 2, and 3 are the stored values:
1=Yes;2=No;3=Maybe;
Reference the Stored Value for a Selection Field Type
To reference the stored value of a selection field elsewhere in the system, use this syntax:
New syntax {{fieldname.value}}.
Old syntax @fieldname.value@.
It is recommended that global administrators enable the new syntax. Locate the System Options section in Global Settings, and toggle Enable New Variable Syntax on.