ECM Document List

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

Integrating with an Enterprise Content Management server

Assuming that they have the appropriate permissions, users can add new documents. From the actions column, users can select an action to perform on a document. You can set configuration options so that users can update an existing document, view the versions of the document, and delete the document.
Table 1. Document actions
Action Description
Update Replaces the file contents and updates its properties.
Display document versions Shows the versions of the document.
Delete Removes the document.

To integrate the ECM Document List view with an Enterprise Content Management (ECM) server, the process application must have a connection to that server. See Adding an Enterprise Content Management server. For information about building ECM services, see Building a service that integrates with an ECM system or a BPM store. For additional information, see the topics under Enabling document support.

Restrictions and limitations

When you configure the displayed folder for the ECM document list through a script at run time, it might display the contents of the root folder. You must click Refresh in the doc list viewer control to display the correct folder.

Data binding

Set the data binding for the view in the General properties tab.
Table 2. ECM Document List view data binding
Binding description Data type
The ECMDocumentInfo binding contains the URL for the selected document. ECMDocumentInfo

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 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 Document List view are shown in the following table:

Table 3. Content management properties for ECM Document List
Content management property Description Data type
Allow create Allow users to add a document to the Enterprise Content Management document repository. The default value is false. Boolean
Allow updates Boolean indicator of whether files in the list can be updated. Boolean
Allow document deletions If this option is disabled, files cannot be deleted by using this view. Boolean
Confirm on deletion Show a confirmation dialog before deleting files. Boolean
Allow revisions display Boolean indicator of whether files in the list have their versions that are displayed. 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
Filter Properties to filter files on. These properties are assigned at upload (if they are assigned). 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 Document List view are shown in the following table:

Table 4. Content management advanced properties for ECM Document List
Content management advanced property. Description Data type
ECM server configuration name The ECM server to be used. String
Document object type ID Specify the documentObjectType for the documents. This must be defined in your ECM server. String
Folder path The default folder path is the root folder. String

The behavior configuration properties for the ECM Document List view are shown in the following table:

Table 5. Behavior configuration properties for ECM Document List
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
Max file size (MB) The maximum file size (in megabytes) for uploads. Decimal
Show pager Show the pager. Boolean
Initial page size Initial maximum number of entries to be shown per page. Integer
Default document properties Select the variable to use for the default properties of the ECM document. When an ECM document is created, the document list contains the default values for the document properties. The values might be read-only or hidden from users when they create the document. List of ECMDefaultProperty
File types allowed Select a file type, or specify custom to specify your own file type. When empty, all file types are valid. For file upload troubleshooting information, see MIME type determination. FileType[]
MIME type determination
You can configure the File types allowed property to upload only certain types of files by providing the MIME (Multipurpose Internet Mail Extension) type values, which are determined by the operating system on the machine that runs the browser. The Windows registry is used to map MIME types to file extensions. For example, if the file type is restricted to CSV only, you can provide the "Custom : text/csv" and "Custom : application/vnd.ms-excel" values.
If you don't have the MIME type mapping for certain file types in your Windows registry, the file upload might fail because the correct MIME type cannot be detected. For more information, see IBM Content Navigator: MIME Type Determination.

The appearance configuration properties for the ECM Document List view are shown in the following table:

Table 6. Appearance configuration properties for ECM Document List
Appearance configuration property Description Data type
Table style The table style for this view. String
Color style The color style for this view. String
Columns The columns to display in the list. FileListColumn[]

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 Document List view has the following types of event handlers:
  • On file clicked: Activated when a file is clicked. For example,
    console.log(doc.fileName)
  • On error: Activated when there is an error while running operations in the document list. For example,

    alert("There has been an error: "+message)

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 Document List, see the ECM Document 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.