Class: BPMDocumentList

BPMDocumentList

The BPM Document List control displays (in tabular form) files in the BPM content store. It provides under one control the ability to upload, delete, and change the properties of documents. It also allows users to view revisions associated with a file. This control aggregates BPM File List, BPM File Properties, BPM File Revisions, and BPM File Uploader controls as a simpler-to-use but less customizable alternative to the modular controls it contains. A BPMDocumentList control provides the following configuration properties in Process Designer:

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
Max Results: Max number of files to display integer
Associated w/ Process Instance: Enable to only display files associated with this process instance 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[]
Allow Create: If enabled, allows file creation. boolean
Hide in portal: Prevent the BPM document from displaying in portal 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
Default upload name: The default name of the document that you want to create. string
User editable: Select this to edit the name of the document in the Create Document dialog box. The default value is false. boolean
Add properties: Select this to add the properties specified in the Upload Properties table to the document. The default value is false. boolean
Upload properties: Specify the properties that you want to associate with the document (if you have selected the Add Properties check box). NameValuePair[]

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
Max File Size (MB): Maximum allowed file size for uploads decimal
File Types Allowed: Select a valid pre-configured file type, or specify custom to specify your own file type. When empty all file types are valid. FileType[]

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

Columns: Columns to display in list FileListColumn[]

Events

On File Clicked:
Description: This event is triggered when a file is clicked.
Example:
console.log(doc.fileName)
Context Variables doc {object}
Properties id
fileName
mimeType
url
On Revision File Clicked:
Description: This event is triggered when a revision is clicked.
Example:
console.log(doc.fileName)
Context Variables doc {object}
Properties id
fileName
mimeType
url
versionLabel
On Error:
Description: This event is triggered when there is an error while executing operations in document list.
Example:
alert("There has been an error: "+message)
Context Variables message {Object}
Article(s)

new BPMDocumentList()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

getLabel(){String}

Returns label of document list
Returns:
Type Description
String

getType(){string}

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

setLabel(Label){integer}

Sets label of document list
Name Type Description
Label String of document list
Returns:
Type Description
integer