Class: BPMFileList

BPMFileList

The BPM File List control lists uploaded files either from the BPM File Uploader or BPM File Dropzone controls. A BPMFileList 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
Show All Versions: Show all versions of each file boolean
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[]

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
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
Max Thumbnail Size: Maximum allowed size (in bytes) for a thumbnail to be displayed integer

Columns: Columns to display in list FileListColumn[]
Label Label to display at top of column string
Field File information to display in this column
{Doc Name (Clickable) | Doc Name | Type (File or URL) | File Name | Version Label | Last Modified By | Last Modified Date | Created By | Created Date | MIME Type | Size or Length | Thumbnail}
string
Sortable When enabled, list can be sorted on this column boolean
Width Column width string
Options For use with specifying date formats string
Css Any custom css options to add (e.g. background-color:#00ff00) string

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
me.getDocumentCount
On File Click:
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")
On Refresh Error:
Description: This event is triggered when there is an error with refresh.
Example:
alert("There has been an error with the refresh")
Article(s)
BPM File List

new BPMFileList()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional 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");
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getDocumentCount(){integer}

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

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean . True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
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
Refreshes the file list
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
Enable/disable this view/control
Name Type Description
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
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);
Flag this view/control as valid or invalid
Name Type 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, "Please fix your data entry"); //Make MyView invalid
Show/hide this view/control
Name Type Description
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"
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();