ECM File List
Configuration properties
Set or modify configuration properties for the view, such as behavior and appearance 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.
The content management configuration properties for the ECM File List view are shown in the following table:
Content management property | Description | Data type |
---|---|---|
Allow updates | Allow files in the list to be updated. | Boolean |
Allow document deletions | If disabled, documents cannot be deleted through this view. | Boolean |
Confirm on deletion | Show a confirmation dialog before deleting files. | Boolean |
Allow revisions display | Files in the list have their versions displayed. | Boolean |
Show all versions | Show all versions of each file. | 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 displayed articles should match any or all of the filter rules. | String |
Filter | Properties to filter files on. These properties are available only if they were assigned when the files were uploaded. | NameValuePair[] |
CMIS query filter | A string of text containing the Content Management Interoperability Services (CMIS) query. | String |
Search service | The service to use when searching for documents. | ECM Document Search Service |
The content management advanced configuration properties for the ECM File List view are shown in the following table:
Content management advanced property | Description | Data type |
---|---|---|
ECM server configuration name | The ECM Server to be used. | String |
Folder path | The default folder path is the root folder. | String |
Document object type ID | Specify the documentObjectType for the documents. This must be defined in your ECM Server. | String |
The behavior configuration properties for the ECM File List view are shown in the following table:
Behavior configuration property | Description | Data type |
---|---|---|
Show footer | Show the footer. | Boolean |
Show table stats | Show table statistics, for example, "Showing 1 to 5 of 59 entries". | Boolean |
Show pager | Show the pager. | Boolean |
Initial page size | Initial maximum number of entries to be shown per page. |
Integer |
Selection mode | The selection mode for items in the table. | String |
The appearance configuration properties for the ECM File List view are shown in the following table:
Appearance configuration property | Description | Data type |
---|---|---|
Table style | The table style for this view. | String |
Color style | The color style for this view. | String |
Max thumbnail size | The maximum size (in bytes) for a thumbnail to be displayed. | Integer |
Width | The width of the view. You can specify the width in px (pixels), % (percent), or em units. For example, 50px, 20%, or 0.4em. If a unit type is not specified, px is assumed. | String |
Height | The height of the view in px (pixels) or em units. If no unit type is specified, px is assumed. | String |
Columns | The columns to display in the list. | ECMFileListColumn[] |
Events
Set or modify the event handlers for the view in the Events properties. You can set events to be triggered programmatically or when a user interacts with the view. For information about how to define and code events, see User-defined events. The ECM File List view has the following types of event handlers:- On load: Activated when the view is loaded. For example:
${Data1}.setData(me.getDocumentCount())
- On file clicked: Activated when a file is clicked. For
example:
window.open(url, '_blank');
- On document deleted: Activated when a file is deleted. For
example:
if (me.getDocumentCount() < 1) ${WarningText}.setVisible(true);
- On refreshed: Activated when the view is refreshed. For
example:
console.log("List refreshed")
- On error: Activated when there is an error while refreshing or deleting in
the view. For example:
alert("There has been an error with the refresh")
- On version display requested: Activated when the document version icon is
clicked. For example:
alert("Update document: "+doc.fileName)
- On row selected by user: Activated when the document is selected by a user.
For example:
console.log("Document Selected")
- On update request: Activated when the update document icon is clicked.
Optional parameter passed: doc. For
example:
alert("Update document: "+doc.fileName)
Depending on the specific event, you can use JavaScript logic to modify the effects of the view. More information on using events with views is found in the topic User-defined events.
Methods
For detailed information on the available methods for ECM File List, see the ECM File List JavaScript API.
Additional resources
For
information about how to create a coach or page, see Building coaches.
For information about standard properties (General,
Configuration, Positioning,
Visibility, and HTML Attributes), see View properties.
For information about other UI and content management views,
see UI toolkit and Content Management toolkit.