ECMFileList

ECM File List

The ECM File List view displays (in tabular form) files/documents from a folder in a configurable ECM store, Events can be fired from user actions on the list, such as clicking on a file to view its content. Files can also be deleted from the list, if allowed through configuration.

Content management advanced

ECM server configuration name: The ECM server to use. The default server is the embedded ECM server. String

Folder path or ID: The default folder path is the root folder. String

Document object type ID: Specify the object type ID for the documents. The ID must be defined in your ECM server. The default value is "cmis:document". String

Appearance

Table style: The style of the table.

Color style: The color style for the table display.

Max thumbnail size: The maximum size (in bytes) to display a thumbnail. Integer

Width: The width in pixels (px), percent (%), or em units (em). For example: 500px, 20%, 40em. If "px", "%", or "em" is not appended to the numeric value, the value defaults to "px". String

Height: The height in pixels (px), percent (%), or em units (em). For example: 500px, 20%, 40em. If "px", "%", or "em" is not appended to the numeric value, the value defaults to "px". String

Columns: The columns to display in the list. ECMFileListColumn[]

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

Selection mode: Determines the selectability of table items.

Content management

Allow updates: Allow updates to the files in the list. Boolean

Allow document deletions: Enable files 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

Show all versions: Show all versions of each file 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

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[]

CMIS query filter: A string of text that contains the Content Management Interoperability Services (CMIS) query. String

Search Service: Specify the service to use when searching for documents.

Events

On load

Description:	The logic that is called when the control is loaded. This event is only fired one time for each page load.
Example:	`${Data1}.setData(me.getDocumentCount())`

On file clicked:

Description:	This event is fired when a file is clicked. Additional parameters: doc
Example:	`window.open(url, '_blank');`

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
	versionLabel	String	The version number of the document
	url	String	The url of the document that can be used to download the document content

On document deleted:

Description:	This event is fired after a file is deleted.
Example:	`if (me.getDocumentCount() < 1) ${WarningText}.setVisible(true);`

On refreshed:

Description:	This event is fired when the file table has been built.
Example:	`console.log("List refreshed")`

Context Variables	loadMore {boolean}

On error:

Description:	This event is fired when an error occurs during the execution of an operation. Additional parameters: message
Example:	`alert("There has been an error: "+message)`

Context Variables	message {string}

On update requested:

Description:	This event is fired when the "Update document" icon is clicked. Optional parameters passed: doc
Example:	`alert("Update document: "+doc.fileName)`

Context Variables	doc {Object}	Type	Description
Properties	id	String	The identifier of the document
	fileName	String	The file name of the document
	versionLabel	String	The version number of the document

On version display requested:

Description:	The inline event logic that is called when the "Display document versions" icon is clicked. Optional parameters passed: doc
Example:	`alert("Update document: "+doc.fileName)`

Context Variables	doc {Object}	Type	Description
Properties	id	String	The identifier of the document
Properties	fileName	String	The file name of the document

On row selected:

Description:	This event is fired when a row is selected using a radio button or check box. Additional parameters passed: row
Example:	`console.log("Document Selected")`

Context Variables	row {Object}

Extends:

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

clearAllSelection()

Deselects the selected records in the document list.

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

getDocumentCount() Returns: {integer}

Returns the number of documents in the file list.

getDocumentTypeId() Returns: {string}

Returns the document type ID that is currently configured in the view.

getFolderPath() Returns: {string}

Returns the folder path that is currently configured in the view.

getLabel() Returns: {string}

Returns the view label.

getSelectedRecord() Returns: {Object}

Returns the selected record from the document list.

getServerName() Returns: {string}

Returns the server name that is currently configured in the view.

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

Refreshes the file list.

Name Type Default Description

loadMore {boolean} Loads more records if any are available in the repository (when 'true').

search(searchText)

Searches for records that contain the specified search text.

Name Type Default Description

searchText {string} The search string.

selectRecordWithName(recordName)

Selects the record with the specified name.

Name Type Default Description

recordName {string} The name of the record.

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

setFolderPath(path)

Sets the folder path for the document list.

Name Type Default Description

path {string} The new folder path.

setLabel(label)

Sets the view label.

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

setRecordSelected(record, selected)

Selects or deselects a record from the document list.

Name Type Default Description

record {Object} The record to select.

selected {boolean} The selection value (where 'true' is selected and 'false' is deselected).

setServerConfig(serverName, folderpath)

Sets the server name and folder path for the document list.

Name Type Default Description

serverName {string} The server name.

folderpath {string} The folder path.

setTitle(title)

Sets the label of the underlying Service Data Table view.

Name Type Default Description

title {string} The new label.

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

sort(col, asc)

Sorts the document list based on the specified column.

Name Type Default Description

col {string} The column name.

asc {boolean} Sorts the document list in ascending order in the column (when 'true').

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