FunctionCopy link to clipboard
a!pickerFieldDocuments( label, labelPosition, instructions, required, requiredMessage, readOnly, disabled, maxSelections, folderFilter, value, validations, validationGroup, saveInto, placeholder, helpTooltip, accessibilityText, showWhen, marginAbove, marginBelow )
Displays an autocompleting input for the selection of one or more documents.
ParametersCopy link to clipboard
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Instructions |
|
Text |
Supplemental text about this field. |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
Read-only |
|
Boolean |
Determines if the field should display as not editable. Default: false. |
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
Maximum Selections |
|
Number (Integer) |
Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed. |
Folder Filter |
|
Folder |
When present, only documents that are inside this folder and its sub-folders are suggested. |
Display Value |
|
List of Document |
Array of currently selected documents. |
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
Validation Group |
|
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, |
Save Input To |
|
List of Save |
One or more variables that are updated with the array of selected documents when the user selects or removes a document. Use a!save() to save a modified or alternative value to a variable. |
Placeholder |
|
Text |
Text to display in the field when it is empty. Does not show if the field is read only. |
Help Tooltip |
|
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 |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Margin Above |
|
Text |
Determines how much space is added above the component. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD" , "MORE", "EVEN_MORE". |
Margin Below |
|
Text |
Determines how much space is added below the component. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE". |
Usage considerationsCopy link to clipboard
Saving and displaying values and placeholdersCopy link to clipboard
- Any nulls in the array passed into selected Documents 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.
Permissions and placeholdersCopy link to clipboard
- The user viewing the picker must have access to view documents passed to the value. Only documents that the viewing user has permissions to see appear in the suggestions list. When folderFilter is not null, the viewing user must have permission to view the filtering folder for any suggestions to be made.
Feature compatibilityCopy link to clipboard
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 | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Process Autoscaling | Compatible |