bpm-case-actions

The <bpm-case-actions> business component displays the available case actions for a specified case.

The component's internal controller invokes the CaseManagementService.listCaseActions operation to provide the data that is displayed from the CaseManagementModel.caseActions object.

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

Usage

<bpm-case-actions
   case-ref="string" 
   [case-action-success="functionReference"]
   [template-path="string"]>
</bpm-case-actions>

Attributes

Name Type Description
case-ref String Case reference for which case actions should be displayed.
case-action-success functionReference (Optional) Function that executes after the case action is successfully executed.
template-path String (Optional) Relative pathname of a custom template file to use in place of the internal template

User Interaction

The default component template displays the case actions as a horizontal list of buttons. Each button contains the case action's name. If there are more case actions than will fit in the available display space, a More button is displayed providing a drop-down list of the case actions that cannot be displayed.

When a user clicks a button, the case action is started and the appropriate form is displayed in a tab, titled with the case action's name. The user must Cancel or Submit the form before they can start another instance of the same case action. Clicking the same button when a tab containing that case action is already open simply sets the focus on that tab. It does not open a new tab containing another instance.

Example

The <bpm-case-actions> business component is used in the Case Management application when you click Case Actions on the Case Menu for a case.