bpm-work-list

The <bpm-work-list> business component displays a work list for a specified user.

The component's internal controller invokes BPMWorklistService operations to populate the work list. The component also allows you to:

  • display the work list contents as cards, a list or a table.
  • sort the work list by priority, process or date.
  • search the work list.
  • select, deselect or open work items.
  • display an additional menu of controls when you have one or more work items selected, which you can use to perform additional tasks. (The controller makes individual controls available or unavailable depending on whether one or more work items is selected, and the state and context of those work items). Each control invokes a particular business component or component service to provide the required functionality.
Control Action Invokes
OPEN Open a selected work item. BPMWorklistService.openWorkItem operation
OPENNEXT Open the next work item in a chained or piled sequence. BPMWorklistService.openNextWorkItem operation
DETAILS Display additional information about the selected work item. work-item-detail-nav business component
ALLOCATE Allocate one or more work items. BPMWorklistService.allocateWorkItem operation
RE-OFFER Re-offer one or more work items. BPMWorklistService.unallocateWorkItem operation

If you want to customize the contents of the <bpm-work-list> business component, see Customizing a Business Component for more information.

Usage

<bpm-work-list
    template-data="object"
    [template-path="string"]>
</bpm-work-list>
Note: In ActiveMatrix BPM 4.0 the <bpm-work-list> business component was called <work-list>. In this release of ActiveMatrix BPM you can use either name to call this business component, as follows: 
<work-list
   // all attributes are the same as for <bpm-work-list>
   // ...
</work-list>
However, best practice is to use <bpm-work-list>. <work-list> has been deprecated in ActiveMatrix BPM 4.1 and may be removed in a later release.

Attributes

Name Type Description
template-data workListData Object Data for the work list.
template-path String (Optional) Relative pathname of a custom template file to use in place of the internal template.
Note: If you use a custom template, it must include a <work-list-action-controls> directive (which is included in the default, internal template), otherwise <bpm-work-list> will not function properly.

Example

The <bpm-work-list> business component is used:

  • on the WORK LIST tab of the Component Showcase application.
  • in the My Work App application, in the main display area. (See workapp/index.html).
  • in the Case Management application, when you click Case Work Items on the Case Menu for a case.