ECM File Uploader

The ECM File Uploader coach view enables users to select and upload a file from their computer. The file can be assigned specific properties and targeted to a particular ECM folder.

Configuration properties

Set or modify configuration properties for the control, such as appearance and behavior properties, in the Configuration properties tab.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor (deprecated), you are setting the value for the large screen size. The other screen sizes inherit this value.

The content management configuration properties for the ECM File Uploader control are shown in the following table:

Table 1. Content management properties for ECM File Uploader
Content management property	Description	Data type
Upload properties	Specifies the matching properties to be uploaded with this document.	`NameValuePair[]`

The content management advanced configuration properties for the ECM File Uploader control are shown in the following table:

Table 2. Content management advanced properties for ECM File Uploader
Content management advanced property	Description	Data type
ECM server configuration name	The ECM server to be used.	`String`
Upload folder path	The default folder path is the root folder.	`String`
Custom document object type ID	Specify the documentObjectType for the documents. The default value is "cmis:document". Note: This value must be defined in your ECM server.	`String`

The behavior configuration properties for the ECM File Uploader control are shown in the following table:

Table 3. Behavior configuration properties for ECM File Uploader
Behavior configuration property	Description	Data type
Max file size (MB)	The maximum allowed file size for uploads.	`Decimal`
Auto upload	Uploads selected files automatically. If this option is not selected, use the startUpload() method instead	`Boolean`
File types allowed	Select a valid file type from the drop-down menu, or select Custom to specify your own file type. When this field is empty, all file types are valid.	`FileType[]`

The appearance configuration properties for the ECM File Uploader control are shown in the following table:

Table 4. Appearance configuration properties for ECM File Uploader
Appearance configuration property	Description	Data type
Color style	The color style for this control.	`String`
Shape style	The shape of this control.	`String`
Size style	The style of this control.	`String`
Outline	Outline-only means the control only shows its color-based style when hovered over.	`Boolean`
Icon	The name of the icon name. For example, `calendar`, `clock-o`, `camera`, `cloud-upload`, `bell`, `info`, or `file-text`. For a comprehensive list, see The Icons. Note: The "fa-" prefix is optional.	`String`
Hide Browse button	When true, the browse button is not displayed. When false, it is displayed.	`Boolean`
Hide file name	When true, the file name is not displayed. When false, it is displayed.	`Boolean`

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events.

The formula configuration property for the ECM File Uploader control is shown in the following table:

Table 5. Formula configuration property for the ECM File Uploader control
Formula configuration property	Description	Data type
Document name formula	The expression or formula that is used to set the name of the document to be uploaded. You can set the name by using a static string or you can set it dynamically by using a formula. For example: To use static text, enclose the text in double quotation marks: `"Static Document Name"` To use a formula to dynamically calculate the name, use the following format: `${Text1}.getText()` For more information about using formulas, see Binding data and configuration options.	`String`

The ECM File Uploader control has the following types of event handlers:

On load: Activated when the control loads. For example
```
me.setAssociatedWithProcessInstance(true)
```
On file selected: Activated when a file in the control is selected. For example:
${DocInfoDlg}.show()
On upload complete: Activated when a file uploads successfully. For example:
${BPMFileList1}.refresh()
On upload error: Activated when an error occurs while uploading a file. For example:
console.error("Error occurred: " + error)

Depending on the specific event, you can use JavaScript logic to modify the effects of the control. You can find more information about using events with controls in User-defined events.

Methods

For detailed information on the available methods for ECM File Uploader, see the ECM File Uploader JavaScript API.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.
For information about other BPM UI and content management controls, see BPM UI toolkit and Content Management toolkit.