BPMDocumentList

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

Disable drag and drop: Select this option to disable the addition of documents by using drag and drop. 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 or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views 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 the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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 or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

setLabel(label)

Sets the label of the document list.

Name Type Default Description

label {string} The new label.

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

visible {boolean} Label visibility flag (true to show view label, false to hide)

Example

MyView.setLabelVisible(false);

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default Description

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, "Fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers