User Picker Component

Function

a!pickerFieldUsers( label, instructions, required, requiredMessage, readOnly, disabled, maxSelections, groupFilter, value, validations, validationGroup, saveInto, labelPosition, placeholder, helpTooltip, accessibilityText, showWhen )

Displays an autocompleting input for the selection of one or more users.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Instructions	`instructions`	Text	Supplemental text about this field.
Required	`required`	Boolean	Determines if a value is required to submit the form. Default: false.
Required Message	`requiredMessage`	Text	Custom message to display when the field's value is required and not provided.
Read-only	`readOnly`	Boolean	Determines if the field should display as not editable. Default: false.
Disabled	`disabled`	Boolean	Determines if the field should display as potentially editable but grayed out. Default: false.
Maximum Selections	`maxSelections`	Number (Integer)	Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.
Group Filter	`groupFilter`	Group	When present, only users who are members of this group are suggested.
Display Value	`value`	List of Username	Array of currently selected users.
Validations	`validations`	List of Text String	Validation errors to display below the field when the value is not null.
Validation Group	`validationGroup`	Text	When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, `“validation group”` is not a valid value. You need to add an underscore between words: `“validation_group”`. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'
Save Input To	`saveInto`	List of Save	One or more variables that are updated with the array of selected users when the user selects or removes a user. Use a!save() to save a modified or alternative value to a variable.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"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.
Placeholder	`placeholder`	Text	Text to display in the field when it is empty. Does not show if the field is read only.
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"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
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.

Usage considerations

Saving and displaying values and placeholders

Any nulls in the array passed to selected users are not displayed.
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.

Filtering and permissions

All user members are suggested when groupFilter is used, including users who are members of member groups and users who are members by rule.
The user viewing the picker must have access to view any users passed to the value. Only users that the viewing user has permissions to see appear in the suggestions list. When Group Filter is not null, the viewing user must have permission to view members of the filter group for any suggestions to be made.

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Incompatible
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible
Process Reports	Incompatible	You cannot use this function to configure a process report.
Process Events	Incompatible	You cannot use this function to configure a process event node, such as a start event or timer event.

The following patterns include usage of the User Picker Component.

Add, Remove, and Move Group Members Browser (Hierarchical Data, Group Management): Display the membership tree for a given group and provide users with the ability to add, remove, and move user members from a single interface.

Feedback

Was this page helpful?