BPM File Dropzone

The BPM File Dropzone control allows the user to drag and drop a file from their computer or select a file manually, and will store it in the IBM BPM document store.

Appearance

Show border:	Show a border around the file upload area.	`Boolean`
Square border corners:	Use square border corners instead of rounded border corners.	`Boolean`
Show thumbnails:	Show thumbnails of the files in the dropzone.	`Boolean`

Behavior

Auto upload:	Automatically upload dropped files.	`Boolean`
Auto-remove uploaded files:	Remove uploaded files from the dropzone.	`Boolean`
Max File Size (MB):	The maximum file size (in megabytes) 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 is 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

Hide in portal:	Hide the BPM document in the portal.	`Boolean`
Upload properties:	Specifies the matching properties to upload with this document.	`NameValuePair[]`

Events

On load:

Description:	The logic that is called when the event is fired. This event is only fired one time for each page load.
Example:	`me.setAssociatedWithProcessInstance(true)`

On file added:

Description:	This event is fired when a file is added to the dropzone. Optional parameters passed: file
Example:	`${DocInfoDlg}.show()`

Context Variables	file {object}
Properties	status
	name
	lastModifiedDate
	size
	type

On file selected:

Description:	This event is fired when a file is clicked in the dropzone. Optional parameters passed: file
Example:	`${DocInfoDlg}.show()`

Context Variables	file {object}
Properties	status
	name
	lastModifiedDate
	size
	accepted

On file removed:

Description:	This event is fired when a file is removed from the dropzone. Optional parameters passed: file
Example:	`return confirm("Are you sure you want to remove this?")`

Context Variables	file {object}
Properties	status
	name
	lastModifiedDate
	accepted
	xhr

On upload complete:

Description:	This event is fired when an upload operation completes successfully. Optional parameters passed: file, message
Example:	`${BPMFileList1}.refresh()`

Context Variables	file {object}	message {string}
Properties	status
	name
	lastModifiedDate
	accepted
	xhr

On upload error:

Description:	This event is fired when an upload operation fails. Optional parameters passed: file, message, xhr
Example:	`console.error("Error occurred: " + error)`

Context Variables	file {object}	message {string}	xhr {object}
Properties	status
	name
	lastModifiedDate
	accepted
	xhr

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add/replace CSS class(es) for this control

Name	Type	Default	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}`		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();

getSelectedFile() Returns: {File}

Returns the file that is currently selected.

getType() Returns: {string}

Returns the descriptive string that represents the control type.

Inherited hide(collapseFlag)

Hide this view/control

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}

Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}

Checks if the view is enabled or not

Example

var enabled = MyView.isEnabled();

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();

openFileSelectionDialog()

Programmatically opens the file selection dialog. For security reasons, the file selection dialog can only be opened programmatically as a result of a user interaction, such as performing a mouse click on another button on the coach user interface (UI).

processQueue()

Starts uploading the documents that are currently selected.

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagates value change of control up through parent views

Name	Type	Default	Description
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

Inherited setData(value)

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

Name	Type	Default	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'

setDocumentName(file, title)

Sets the name that is associated with the given file.

Name	Type	Default	Description
file	`{File}`		The file object.
title	`{string}`		The new name.

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	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

Inherited setValid(valid, errorText)

Flag this view/control 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, "Please fix your data entry"); //Make MyView invalid

Inherited setVisible(visible, collapse)

Show/hide this view/control

Name	Type	Default	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"

Inherited show()

Show this view/control

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcasts 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();

uploadFile(file)

Starts uploading a file.

Name	Type	Default	Description
file	`{File}`		The file object to upload.

Methods

Parent

Helpers