Record Picker Component

Record Picker

Function: a!pickerFieldRecords()

Displays an autocompleting input for the selection of one or more records, filtered by a single record type. Suggestions and picker tokens use the title of the record.

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
Instructions instructions Text Optional text displayed below the picker.
Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
Placeholder placeholder Text Optional text to display in the field when it is empty. Does not show if the field is read-only.
Max Selections maxSelections Integer Once this number of selections has been reached, further selections are blocked until a selection is removed.
Record Type recordType Record Type Only records of this record type appear in the suggestions.
Filters filters Query Filter Array Filters to apply when searching for records, configured using a!queryFilter(). Only records that meet the filter criteria appear in the suggestions.
Selected Records value Text or Integer Array Array of identifiers of the currently selected records. The record title of each selected record will be displayed in the picker.
Save Selection To saveInto Save Array One or more variables that are updated with the array of selected records when the user selects or removes a record. Use a!save() to save a modified or alternative value to a variable.
Required required Boolean Determines if a value is required to submit the form. Default is false.
Required Message requiredMessage Text Custom message to be displayed when the field's value is required and not provided.
Disabled disabled Boolean Determines if the user is prevented from changing the value. Default is false.
Validations validations Text Array Validation errors to be displayed below the field when the value is not null.
Validation Group validationGroup Text When present, this field is only validated when a button in the same validation group is clicked.
Visibility showWhen Boolean Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

  • Suggestions are based on the fields used in the record title. This is equivalent to the search functionality in a feed-style record list.
    • If you are having trouble getting your record picker to work for an expression-backed record, make sure the record list search is working correctly. See the Expression-Backed Record Tutorial for an example of how to configure this.
  • Only records that the viewing user has permissions to see appear in the suggestions list, as determined by the default filterson the record type.
  • All selected record tokens include a link to the record.
  • Any nulls in the array passed to Selected Records are not displayed. A [Not Available] token is displayed for any invalid identifiers in the Selected Records array.
  • The component always saves an array regardless of how many selections have been made.
  • Whether placeholder text clears on focus or input varies by device and browser. Placeholder text does not display on Microsoft Internet Explorer 9.
  • This picker cannot be used to selected records of a rule-backed record type (deprecated).

Examples

The examples below reference the record created from the Entity-Backed Record Tutorial through a constant that references the employee record type. Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE.

Select a Record from a Record Type

1
2
3
4
5
6
7
8
9
=load(
  local!storedRecord,
  a!pickerFieldRecords(
    label: "Choose an Employee Record",
    recordType: cons!EMPLOYEE_RECORD,
    value: local!storedRecord,
    saveInto: local!storedRecord
  )
)

Displays the following:

Select a Record from a Record Type with a Filter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
=load(
  local!storedRecord,
  a!pickerFieldRecords(
    label: "Choose an Employee Record",
    recordType: cons!EMPLOYEE_RECORD,
    filters:{ 
      a!queryFilter(
        field: "department",
        operator: "=",
        value: "Engineering"
      )
    },
    value: local!storedRecord,
    saveInto: local!storedRecord
  )
)

Displays the following:

FEEDBACK