Class: ECMFolderList

ECMFolderList

The BPM Folder List control displays (in tabular form) folders from the ECM content store. Events can be fired from user actions on the list, such as clicking on a folder. Folders can also be deleted from the list, if allowed through configuration. An ECMFolderList control provides the following configuration properties in Process Designer:

Behavior

Show Footer: Show the table footer boolean
Show Table Stats: Show table statistics (e.g. "Showing 1 to 5 of 59 entries") boolean
Show Pager: Visibility of the pager boolean
Initial Page Size: Initial maximum number of entries to be shown per page integer
Selection Mode: =Table item selection mode
{None | Single | Multiple}
string
Hide Drill-up: Hide folder drill-up table entry boolean

Content Management

Allow Document Deletions: If disabled, files cannot be deleted through this control. boolean
Confirm On Deletion: Enable to bring up a confirmation dialog before deleting files boolean

Content Management Advanced

ECM Server Configuration Name: ECM Server to be used. Default is the Embedded ECM Server. string
Folder Path: Default is the root folder string

Appearance

Table Style: Style of the table
{Default | Elegant | Bordered | Striped | Hover Row | Condensed}
string
Color Style: Color style for table display
{None | Light | Primary | Info | Success | Warning | Danger}
string
Max Thumbnail Size: Maximum allowed size (in bytes) for a thumbnail to be displayed integer
Width: Width in px, %, em For example: 500px, 20%, 40em. If no unit is specified, px is assumed string
Height: Height in px, %, em For example: 500px, 20%, 40em. If no unit is specified, px is assumed string

Columns: Columns to display in list ECMFileListColumn[]
Label string
Field
{Doc Name (Clickable) | Version Label | Last Modified By | Last Modified Date | Created By | Created Date | MIME Type | Size Length}
string
Sortable boolean
Width string
Options string
Css string

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
console.log(me.getFolderCount())
On Folder Clicked:
Description: This event is triggered when a folder is clicked.
Example:
window.open(url, '_blank');
Context Variables folder {object}
Properties id
name
path
On Folder Deleted:
Description: This event is triggered when a folder is deleted.
Example:
console.log('Folder Deleted.');
On Refreshed:
Description: This event is triggered when the folder list is refreshed.
Example:
console.log("Folder List refreshed")
On Error:
Description: This event is triggered when there is an error with refresh.
Example:
alert("There has been an error : "+message)
Context Variables message {String}
On Row Selected by User:
Description: This event is triggered when folder is selected by user.
Example:
console.log("Folder Selected")
Context Variables row {Object}
Article(s)

new ECMFolderList()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

clearAllSelection()

clears record selection from folder list

createFolder(Parent, Folder)

creates folder under parent folder path
Name Type Description
Parent String Folder Path
Folder String Name

getFolderCount(){integer}

Get the number of documents that is in the file list
Returns:
Type Description
integer

getFolderPath(){String}

returns folder path of folder list
Returns:
Type Description
String

getSelectedRecord(){Object}

returns selected folder record from folder list
Returns:
Type Description
Object

getServerName(){string}

Returns the view of the GetAllVersions Service Call
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Refreshes the file list
searches for records with search text from folder list
Type Description
String

selectRecordWithName()

selects folder record with folder name
Type Description
String

setFolderPath(Folder)

sets folder path for folder list
Name Type Description
Folder String Path

setServerConfig(Server, Folder)

sets server name and folder path for folder list
Name Type Description
Server String Name
Folder String Path

setTitle(Label)

Sets label of underlying Table control
Name Type Description
Label String of control

sort(Column, Sorting)

Sorts folder list with passed column
Name Type Description
Column String Name
Sorting String type