Class: BPMFileList

BPMFileList

The BPM File List control displays (in tabular form) files/documents from the BPM content store, optionally filtered by properties, and optionally associated with a process instance. 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. A BPMFileList 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

Content Management

Display Version: Boolean indicator of whether files in the list have their versions displayed boolean
Show All Versions: Show all versions of each file boolean
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
Associated w/ Process Instance: Enable to only display files associated with this process instance boolean
Max Results: Max number of files to display integer
Filter: Properties to filter files on. These properties are assigned at upload (if they've been assigned) NameValuePair[]
Match Rule: Select whether displayed articles should match any or all of the filter rules
{None | All Properties | Any Property}
string
Allow Updates: Boolean indicator of whether files in the list can be updated boolean

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 FileListColumn[]

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
me.getDocumentCount()
On File Clicked:
Description: This event is triggered when a file is clicked.
Example:
console.log(doc.fileName)
Context Variables url {string} doc {object}
Properties id
fileName
mimeType
On Document Deleted:
Description: This event is triggered when a file is deleted.
Example:
console.log("File Deleted") 
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 control.
Example:
alert("There has been an error with the refresh")
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
Article(s)

new BPMFileList()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

getDocumentCount(){integer}

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

getLabel(){String}

Returns label of control
Returns:
Type Description
String

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

refresh(Load)

Refreshes the file list
Name Type Description
Load boolean more records if there is available in repository

setLabel(Label){integer}

Sets label of control
Name Type Description
Label String of control
Returns:
Type Description
integer