Class: ECMFileList

ECMFileList

The ECM File List control displays (in tabular form) files/documents from a folder in a configurable ECM store, Events can be fired from user actions on the list, such as clicking on a file to view its content. Files can also be deleted from the list, if allowed through configuration. An ECMFileList 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

Content Management
Allow Document Deletions: If disabled, files cannot be deleted through this control. boolean
Allow Updates: Boolean indicator of whether files in the list can be updated boolean
Allow Revisions Display: Boolean indicator of whether files in the list have their versions displayed boolean
Confirm On Deletion: Enable to bring up a confirmation dialog before deleting files boolean
Max Results: Max number of files to display integer
Show All Versions: Show all versions of each file. Currently there is NO version support for Custom servers boolean
Match Rule: Select whether displayed articles should match any or all of the filter rules
{None | All Properties | Any Property}		 string
Filter: Properties to filter files on. These properties are assigned at upload (if they've been assigned) NameValuePair[]
CMIS Query Filter: A string of text containing the Content Management Interoperability Services (CMIS) query. string

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
Document Object Type Id: Specify the documentObjectType for the documents. This MUST be defined in your ECM Server. Default is "cmis:document". 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: 
${Data1}.setData(me.getDocumentCount())
On File Clicked:
Description: This event is triggered when a file is clicked.
Example: 
window.open(url, '_blank');
Context Variables url {string} doc {object}
Properties id
fileName
mimeType
versionLabel
url
On Document Deleted:
Description: This event is triggered when a document is deleted.
Example: 
if (me.getDocumentCount() < 1) ${WarningText}.setVisible(true);
On Refreshed:
Description: This event is triggered when the control is refreshed.
Example: 
console.log("List refreshed")
Context Variables loadMore {boolean}
On Error:
Description: This event is triggered when there is an error while executing refresh or delete operations in document list.
Example: 
alert("There has been an error: "+message)
Context Variables message {String}
On Update Requested:
Description: This event is triggered when update document icon is clicked.
Example: 
alert("Update document: "+doc.fileName)
Context Variables doc {Object}
Properties id
fileName
versionLabel
On Version Display Requested:
Description: This event is triggered when document version icon is clicked.
Example: 
alert("Update document: "+doc.fileName)
Context Variables doc {Object}
Properties id
fileName
On Row Selected by User:
Description: This event is triggered when document is selected by user.
Example: 
console.log("Document Selected")
Context Variables row {Object}
Article(s)

new ECMFileList()

ECMFileList.js, line 126
This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

clearAllSelection()

ECMFileList.js, line 635
clears record selection from document list

getDocumentCount(){integer}

ECMFileList.js, line 546
Get the number of documents that is in the document list
Returns:
Type Description
integer

getDocumentTypeId(){string}

ECMFileList.js, line 570
Returns the ID of document type
Returns:
Type Description
string

getFolderPath(){string}

ECMFileList.js, line 586
returns folder path of document list
Returns:
Type Description
string

getLabel(){String}

ECMFileList.js, line 610
Returns label of Document List control
Returns:
Type Description
String

getSelectedRecord(){Object}

ECMFileList.js, line 627
returns selected record from document list
Returns:
Type Description
Object

getServerName(){string}

ECMFileList.js, line 562
Returns the view of the GetAllVersions Service Call
Returns:
Type Description
string

getType(){string}

ECMFileList.js, line 529
Get descriptive string representing the type of control
Returns:
Type Description
string

refresh()

ECMFileList.js, line 554
Refreshes the document list with load more option
Type Description
boolean
ECMFileList.js, line 651
searches for records with search text from document list
Type Description
String

selectRecordWithName()

ECMFileList.js, line 521
selects document record with document name
Type Description
String

setFolderPath()

ECMFileList.js, line 578
Sets folder path for document list
Type Description
string

setLabel(Label)

ECMFileList.js, line 602
Sets label of Document List control
Name Type Description
Label String of control

setRecordSelected(Record, Selection)

ECMFileList.js, line 618
selects or deselects a record from document list
Name Type Description
Record Object for selection
Selection boolean status

setServerConfig(Server, Folder)

ECMFileList.js, line 642
sets server name and folder path for document list
Name Type Description
Server String Name
Folder String Path

setTitle(Label)

ECMFileList.js, line 594
Sets label of underlying File Table control
Name Type Description
Label String of control

sort(Column, Sorting)

ECMFileList.js, line 537
Sorts document list with passed column
Name Type Description
Column String Name
Sorting String type