bpm-case-types

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

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

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

Usage

<bpm-case-types
   case-model="object" | case-types-array=array"
   on-click-case-type=functionReference
   [config=object]
   [template-path="string"]>
</bpm-case-types>

Attributes

Name Type Description
case-model CaseModelBasicInfoType object Case model for which case types should be displayed.

You can obtain the information needed to populate the CaseModelBasicInfoType object using the GlobaldataAdminService.getCaseModelBasicInfo method from the objectAPI.

case-types-array Array A previously populated CaseManagementModel.caseTypes object containing the case types to be displayed.
Note: The listCaseTypes operation is not invoked when you use this attribute.
on-click-case-type Function reference Defines the actions to be performed when the user selects one of the displayed case types.
config Object (Optional) Defines whether the list of case types should be displayed using a CARD or LIST format. The default option is CARD. The parameter is viewType, of type String.
template-path String (Optional) Relative pathname of a custom template file to use in place of the internal template
Note: case-model and case-types-array are mutually exclusive.

Example

The <bpm-case-types> business component is used in the Case Management application when you click the Cases button on the main navigation sidebar. This is also the default option displayed when you run the Case Management application.

Note: The Case Management application uses a function to populate the CaseModelBasicInfoType object with data from the CaseManagement.config.json file. Before using the application, you must edit the CaseManagement.config.json file so that it contains the details of a case model that exists on your ActiveMatrix BPM system. See Configuring the Case Management Application for more information.