Folder Browser Component

Folder Browser

Function: a!folderBrowserFieldColumns()

Displays the contents of a folder and allows users to navigate through a series of folders to find and select a folder.

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Label Position

labelPosition

Text

Determines where the label appears. Valid values: "ABOVE" (default), "ADJACENT", "COLLAPSED".

Instructions

instructions

Text

Supplemental text about this field.

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".

Root Folder

rootFolder

Any Type

The contents of the specified folder or knowledge center are displayed in the first column of the browser.

Navigation Folder Value

navigationValue

Folder

The folder that has been navigated to whose contents are displayed in the rightmost column.

Save Navigation Folder To

navigationSaveInto

List of Save

Variable or list of variables to update when the navigation folder changes.

Selection Value

selectionValue

Folder

The folder to show as selected.

Save Selection To

selectionSaveInto

List of Save

Variable or list of variables to update when a folder is clicked.

Read-only

readOnly

Boolean

Determines whether selection is enabled. Default: false.

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.

Height

height

Text

Determines the height of the component. Valid values: "SHORT", "MEDIUM" (default), "TALL".

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Notes

  • The current user must have permission to view the selected folder or knowledge center in the parameter.
  • Within a folder or knowledge center, the user can only see contents for which they have permission to view.
  • Each column displays items in alphabetical order.
  • Avoid using this component for offline mobile forms because tapping on a folder does not display its contents and tapping on a file does not download it when offline.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
=a!localVariables(
  local!selection,
  local!navigation: if(
    isnull(local!selection),
    null,
    document(local!selection[1], "folderId")
  ),
  local!rootFolder: cons!REPORTS_FOLDER,
  a!sectionLayout(
    label: "System Report Picker",
    contents: {
      a!folderBrowserFieldColumns(
        rootFolder: local!rootFolder,
        selectionValue: local!selection,
        selectionSaveInto: local!selection,
        navigationValue: local!navigation,
        navigationSaveInto: local!navigation
      ),
      a!pickerFieldFolders(
        label: "Selection",
        labelPosition: "JUSTIFIED",
        folderFilter: local!rootFolder,
        maxSelections: 1,
        value: local!selection,
        saveInto: local!selection
      )
    }
  )
)

A folder browser similar to the one pictured below displays. Note that your folder contents may differ from the example:

An example of the document browser component

FEEDBACK