BPM File Uploader (deprecated)

The BPM File Uploader control (now contained in the Content Management Toolkit) allows the user to select a file from their computer. This control is best used with the BPM File List control, or File Viewer control.

The BPM File Uploader will retrieve the file you've selected and store it on your IBM BPM document store, or IBM BPM content store. IBM Knowledge Center 

Like almost all SPARK controls, you can trigger events that are fired when the user interacts with the control (see the Event and Methods sections below and the Event Handling article for more information).

This control is best used with the BPM File List control, or File Viewer control.


Doc Title Formula  Allows you to rename the file you have selected.


Color Style:

Shape Style  Default, Rounded, Flat

Size Style Default, Large, Small

Outline Makes Outline-only means the control only shows its color-based style when hovered over

Icon Type in your selected icon style.  Use the Font Awesome Link below*

Hide Browser Button This will hide the Uploader Control

Hide File Name This will hide the file name

*There are a variety of icons offered at Font Awesome, allowing you to give visual indication to a user.

Content Management

Associate with Process Instance When checked (true) the documents to be uploaded will be associated with the current process instance, otherwise (false) the document will not be associated with the current process instance.

Upload Properties  Specifies the matching properties to be uploaded with this document; you can name Upload Properties; for example: Name: Prop1 and Value: Value1, this tells the BPM File List to only show files with these properties when the same information is entered in the Filter table (for more information on the BPM File List, see below under Related Article(s)).


Auto Upload  Upload selected files automatically.  This is equivalent to using the startUpload() method in the On File Selected Event. If not selected, the startUpload() method can be used instead to trigger the upload manually (such as through a button).

File Types Allowed  Pick a valid file type from the dropdown, or specify custom to specify your own file type. When empty all file types are valid.


These are the configuration option settings...

This is the result...which has the selected file name next to it


With the BPM File Uploader Control, there are 4 types of event handlers:

  • On Load When the page loads
  • On File Selected When the file is selected
  • On Upload Complete When file upload is complete
  • On Upload Error When there is a file upload error

You can use JavaScript logic to affect the effects of the control, depending on the event. More information on using these controls can be found in the Event Handling article.


For detailed information on the available methods for this control, access the JS Doc file.

Related Article(s)

BPM File Dropzone

BPM File List

File Viewer


  • Author: Dan Abresch
  • Date Created: June 9, 2015
  • Date Modified: July 27, 2015
Was this article helpful?
0 out of 0 found this helpful