bpm-case-states

The <bpm-case-states> business component displays the available case states and current case state for a specified case.

The component's internal controller invokes the CaseManagementService.getCaseStates operation to provide the data that is displayed from the CaseManagementModel.caseStates.

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

Usage

<bpm-case-states
   case-ref="string" | case-states-array="array" [current-state="string"]
   [template-path="string"]>
</bpm-case-states>

Attributes

Name Type Description
case-ref String Case reference for which the case state data should be displayed.
case-states-array Array A previously populated CaseManagementModel.caseStates object containing the case state data to be displayed.
Note: The getCaseStates operation is not invoked when you use this attribute.
current-state String (Optional) Current state of the case. This allows you to update the data displayed by the case-states-array attribute if the case state has been updated since that object was populated (for example, by the execution of a case action).
template-path String (Optional) Relative pathname of a custom template file to use in place of the internal template
Note: Use either case-ref, or case-states-array and current-state. These options are mutually exclusive.

Example

The <bpm-case-states> business component is used in the Case Management application when you click Case Overview on the Case Menu for a case. This is also the default option displayed when you click a Case from the main Cases pane.

The Case Overview display shows both the <bpm-case-states> business component and, below it, the <bpm-case-data> business component.