Document and Folder Browser Component

Document and Folder Browser

Function: a!documentandFolderBrowserFieldColumns()

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

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 Use this parameter to supply 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 Folder or Knowledge Center The contents of the specified folder or knowledge center are displayed in the first column of the browser.
Navigation Value navigationValue Folder The folder that has been navigated to whose contents are displayed in the rightmost column.
Save Navigation To navigationSaveInto List of Save Variable or list of variables to update when the navigation folder changes.
Selection Value selectionValue Document or Folder The document or folder to show as selected.
Save Selection To selectionSaveInto List of Save Variable or list of variables to update when a document or folder 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.
Read Only readOnly Boolean Determines whether selection is enabled. Default: false.
Height height Text Determines the height of the component. Valid values are SHORT, MEDIUM (default), and TALL.

Notes

  • The current user must have permission to view the selected items.
  • 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, with folders always listed first.
  • 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
30
31
32
33
34
35
=load(
  local!selection,
  local!navigation,
  local!rootFolder: cons!REPORTS_FOLDER,
  a!sectionLayout(
    label: "System Report Picker",
    contents: {
      a!documentAndFolderBrowserFieldColumns(
        rootFolder: local!rootFolder,
        selectionValue: local!selection,
        selectionSaveInto: local!selection,
        navigationValue: local!navigation,
        navigationSaveInto: local!navigation
      ),
      a!pickerFieldDocumentsAndFolders(
        label: "Selection",
        labelPosition: "JUSTIFIED",
        folderFilter: local!rootFolder,
        maxSelections: 1,
        value: local!selection,
        saveInto: {
          local!selection,
          if(
            isnull(local!selection),
            null,
            a!save(
              local!navigation,
              document(local!selection[1], "folderId")
            )
          )
        }
      )
    }
  )
)

A document and 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