Collection of criteria used to filter process instances, which may be customized by users.


Basic Usage


Class members


NameTypeDefault valueDescription
appIdnumberDisplay filters available to the current user for the application with the specified ID.
appNamestringDisplay filters available to the current user for the application with the specified name.
filterParamFilterProcessRepresentationModelThe parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected.
showIconbooleantrueToggle to show or hide the filter's icon.


errorEventEmitter<any>Emitted when an error occurs.
filterClickedEventEmitter<UserProcessInstanceFilterRepresentation>Emitted when a filter is being clicked from the UI.
filterSelectedEventEmitter<UserProcessInstanceFilterRepresentation>Emitted when a filter is being selected based on the filterParam input.
successEventEmitter<ProcessInstanceFilterRepresentation[]>Emitted when the list of filters has been successfully loaded from the server.


This component displays a list of available filters and allows the user to select any given filter as the active filter.

The most common usage is in driving a process instance list to allow the user to choose which process instances are displayed in the list.

If both appId and appName are specified then appName will take precedence and appId will be ignored.

How filter the activiti process filters

   [filterParam]="{index: 0}">

You can use inside the filterParam one of the properties defined by FilterParamsModel (see below).


    "id": "number",
    "name": "string",
    "index": "number"
idstringThe id of the task filter.
namestringThe name of the task filter, lowercase is checked.
indexnumberZero-based position of the filter in the array.

See also

© 2023 Alfresco Software, Inc. All Rights Reserved.