BPM Document List

Edit online

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15

The BPM Document List view displays (in tabular form) files in the BPM content store. It provides under one view the ability to upload, delete, and change the properties of documents. It also allows users to view revisions associated with a file. This view aggregates the BPM File List, BPM File Properties, BPM File Revisions, and BPM File Uploader views as a simpler-to-use but less customizable alternative to the modular views it contains.

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.

For additional information, see the topics listed under the topic Enabling document support.

Restrictions and limitations

None

Data binding

Set the data binding for the view in the General properties tab.

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

Table 3. Content management properties for BPM Document List
Content management property	Description	Data type
Allow create	Allow file creation.	`Boolean`
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	Show versions of files 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`
Associated with process instance	Display files associated with this process instance only.	`Boolean`
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[]`
Default upload name	The default name of the document that you want to create. To allow a user to edit the name, select the User editable check box.	`String`
User editable	Allows the user to edit the default name of the document in the Create Document window. The default name is set in the Default upload name option.	`Boolean`
Add properties	Add the properties in the Upload Properties table to the document. The default value is false.	`Boolean`
Upload properties	If you selected Add Properties, the properties you want to associate with the document.	`NameValuePair[]`
Hide in portal	Prevent the document from displaying in Process Portal.	`Boolean`

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

Table 4. Behavior configuration properties for BPM 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`
Show pager	Show the pager.	`Boolean`
Initial page size	Initial maximum number of entries to be shown per page.	`Integer`
Max file size	The maximum file size (in megabytes) for uploads.	`Decimal`
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[]`
Add documents to folder	Adds new documents to the current process folder when the coach is running within the scope of a process.	`Boolean`
Disable drag and drop	Select this option to disable the addition of documents by using drag and drop. By default, the Disable drag and drop option is clear.	`Boolean`

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

Table 5. Appearance configuration properties for BPM 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 BPM 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 revision file clicked: Activated when a revision is clicked. For example:
```
console.log(doc.fileName)
```
On error: Activated when there is an error while executing operations in the view. For example:
```
alert("There has been an error: "+message)
```

Depending on the event, you can use JavaScript logic to modify the effects of the view. For more information about using events with views, see User-defined events.

Methods

For detailed information on the available methods for BPM Document List, see the BPM 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.