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

Appearance
Table style: The style of the table.
Color style: The color style for the table display.
Columns: The columns to display in the list. FileListColumn[]

Behavior
Show footer: Show the table footer. Boolean
Show table stats: Show table statistics. For example, "Showing 1 to 5 of 59 entries". Boolean
Show pager: Display the pager. Boolean
Initial page size: The initial maximum number of entries shown for each page. Integer
Max file size (MB): The maximum file size for uploads. Decimal
File types allowed: Select a pre-configured file type from the drop-down list or select "Custom" to specify your own file type. When this field empty, all file types are valid. FileType[]
Add documents to folder: Add new documents to the current process folder when the coach is running within the scope of a process. Boolean

Content management
Allow create: Allow the creation of files. Boolean
Allow updates: Allow updates to the files in the list. Boolean
Allow document deletions: Enable documents to be deleted using this control. Boolean
Confirm on deletion: Show a confirmation dialog box before files are deleted. Boolean
Allow revisions display: Indicates whether versions are displayed for the files in the list. Boolean
Max results: The maximum number of files to display. When set, the Max results value indicates the number of documents to be fetched at a time. When no value is set, by default, Max results fetches 10 documents at a time. When more documents than the configured Max results value are displayed, a Load More button appears, which you can click to fetch the next set of Max results documents. The Load More button is not shown when there are no more documents. Integer
Associated with process instance: Display only those files that are associated with the current process instance. Boolean
Match rule: Select whether articles should be displayed based on any, all, or none of the filter rules defined in the "Filter" section.
{None | All Properties | Any Property}
BPMDocumentMatchRule
Filter: The properties in the "Filter" table that are used to filter files. These properties are only available if they were assigned when the files were uploaded. NameValuePair[]
Default upload name: The default name of the document that you want to create. To allow a user to edit the name, select the "User editable" check box. String
User editable: Allows the user to edit the default name of the document in the Create Document window. The default name is set in the "Default upload name" option. Boolean
Add properties: Add the properties specified in the "Upload properties" table to the document. Boolean
Upload properties: Add the properties in the "Upload properties" table to the document (if the Add Properties check box is selected). NameValuePair[]
Hide in portal: Prevent the BPM document from being displayed in the portal. Boolean

Events
On revision file clicked:
Description: This event is fired when a revision is clicked. Additional parameters: doc
Example:
console.log(doc.fileName)
Context Variables doc {object} Type Description
Properties id String The identifier of the document
fileName String The file name of the document
mimeType String The MIME type of the document
url String The url of the document that can be used to download the document content
versionLabel String The version number of the document
On file clicked:
Description: This event is fired when a file is clicked. Additional parameters: doc
Example:
console.log(doc.fileName)
Context Variables doc {object} Type Description
Properties id String The identifier of the document
fileName String The file name of the document
mimeType String The MIME type of the document
url String The url of the document that can be used to download the document content
On error:
Description: This event is fired when an error occurs during the execution of operations in the document list. Additional parameters: message
Example:
alert("There has been an error: "+message)
Context Variables message {Object}
Extends:
com.ibm.bpm.coach.CoachView
Methods:

Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();

getLabel() Returns: {string}
Returns the label of the document list.

getType() Returns: {string}
Returns the descriptive string that represents the control type.

Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();

Inherited isBound() Returns: {boolean}
Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);

Inherited recalculate()
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula
for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

refresh()
Refreshes the document list.

Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

setLabel(label)
Sets the label of the document list.
NameTypeDefaultDescription
label{string}The new label.

Inherited setLabelVisible(visible)
Show/hide the label of this view/control
NameTypeDefaultDescription
visible{boolean}Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
valid{boolean}Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText{string}Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, creates a pseudo binding if there is no current binding.
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)
Show/hide this view/control
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show view, false to hide)
collapse{boolean}Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

Inherited show()
Show this view/control
Example
MyView.show();

Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();