FolderList JSP Tag Attributes

The FolderList JSP tag is a BI Beans list tag that lets you define a list of folders. You can also specify other folder lists or object lists that are to be updated when a user selects a folder in this list.

A FolderList can be a target of another FolderList tag so that the selection of a folder in the other list triggers an update of the folders that appear in this FolderList.

If a FolderList is not a target of another FolderList, then you specify the contents of the list in one of the following ways:

Attributes

additionalAttributes -- A delimited string of Catalog attributes to fetch in addition to the attributes that are already required for the search.

folders -- (Use only to create a predefined, static list.) Full path of each folder that is to appear in a predefined list. If you specify a value for this attribute, then attributes that are related to searching the Catalog are ignored.

id -- (Required) A unique identifier for this tag.

includeShortcuts -- Indicates whether to include shortcut objects in a list that results from a Catalog search. Default value is False.

itemLabelFormat -- Format for the label of each item that appears in the list.

maxCount -- Maximum number of items that are allowed to appear in the list.

partialTargets -- Tag identifiers of additional objects that this tag should update and include in a partial page refresh. Do not include objects that are specified in the targetFolderList or targetObjectList attributes.

searchPaths -- The full path of each folder from which to start searching for objects that are to be included in a dynamic list. If no value is specified for this attribute, then the BI Beans Catalog root is used as the starting point.

searchString -- Custom search string for locating objects that are to be included in a dynamic list. The search string allows the use of wildcard characters (*). For example, to find all folders that begin with the text "Sales", use the string: "Sales*".

searchSubfolders -- Indicates whether to search Catalog subfolders recursively when creating a dynamic list. Default value is True.

sortBy -- Name of any Catalog attribute that is to be used for sorting the objects in this list.

sortOrder -- Specifies the sort sequence for objects in this list: Ascending or Descending.

targetFolderListIds -- Identifiers of any folder list tags that are to be updated by the selection in this folder list.

targetObjectListIds -- Identifiers of any object list tags that are to be updated by the selection in this folder list.