Shows/edits process filter details.

edit-process-filter-cloud

Contents

Basic Usage

<adf-cloud-edit-process-filter
    [id]="processFilterId"
    [appName]="appName"
    [filterProperties]="filterProperties"
    (filterChange)="onFilterChange($event)"
    (action)="onAction($event)">
</adf-cloud-edit-process-filter>

Class members

Properties

NameTypeDefault valueDescription
actionsstring[]DEFAULT_ACTIONSList of sort actions.
appNamestring""The name of the application.
environmentIdstringEnvironment ID of the application.
environmentListEnvironment[][]List of environments.
filterPropertiesstring[]List of process filter properties to display
idstringId of the process instance filter.
rolestring""roles to filter the apps
showFilterActionsbooleantrueToggles editing of process filter actions.
showProcessFilterNamebooleantrueToggles the appearance of the process filter name .
showTitlebooleantrueToggles editing of the process filter title.
sortPropertiesstring[]List of sort properties to display.
processFilterProcessFilterCloudModelProcess filter

Events

NameTypeDescription
actionEventEmitter<ProcessFilterAction>Emitted when a filter action occurs i.e Save, SaveAs, Delete.
filterChangeEventEmitter<ProcessFilterCloudModel>Emitted when a process instance filter property changes.

Details

Editing APS2 process filters

Use the appName and id properties to choose which process filter to edit:

<adf-cloud-edit-process-filter
    [id]="processFilterId"
    [appName]="appName">
</adf-cloud-edit-process-filter>

Filter properties

You can supply various filter properties to edit. These will determine which processes are found by a filter. The full set of properties is given below:

NameDescription
appNameName of the app
idProcess instance ID
nameProcess name.
initiatorID of the user who initiated the process
statusExecution status of the process.
processDefinitionIdProcess definition ID
processDefinitionKeyProcess definition key
lastModifiedDate the process was last modified. If lastModified defined the component will show the range lastModifiedTo, lastModifiedFrom
sortField on which the filter results will be sorted. Can be "id", "name", "status", "startDate".
orderSort ordering of the filter results (this doesn't participate in the filtering itself)

By default, the status, sort and order properties are displayed in the editor. However, you can also choose which properties to show using the filterProperties array. For example, the code below initializes the editor with the appName, id, name and lastModified properties:

export class SomeComponent implements OnInit {

    filterProperties: string[] = [
        "appName",
        "id",
        "name",
        "lastModified"
    ];

    onFilterChange(filter: ProcessFilterCloudModel) {
        console.log('On filter change: ', filter);
    }

    onAction($event: ProcessFilterAction) {
        console.log('Clicked action: ', $event);
    }
<adf-cloud-edit-process-filter
    [id]="processFilterId"
    [appName]="applicationName"
    [filterProperties]="filterProperties">
</adf-cloud-edit-process-filter>

With this configuration, only the four listed properties will be shown.

Sort properties

You can supply a list of sort properties to sort the processes. You can use any of the filter properties listed above as sort properties and you can also use the process's startDate.

By default, the id, name, status and startDate properties are displayed in the editor. However, you can also choose which sort properties to show using the sortProperties array. For example, the code below initializes the editor with the startDate and lastModified properties:

export class SomeComponent implements OnInit {

    sortProperties: string[] = [
        "startDate",
        "lastModified"];

    onFilterChange(filter: ProcessFilterCloudModel) {
        console.log('On filter change: ', filter);
    }

    onAction($event: ProcessFilterAction) {
        console.log('Clicked action: ', $event);
    }
<adf-cloud-edit-process-filter
    [id]="processFilterId"
    [appName]="applicationName"
    [sortProperties]="sortProperties">
</adf-cloud-edit-process-filter>

With this configuration, only the two listed sort properties will be shown.

Action properties

You can supply various actions to apply on process filter.

NameDescription
saveSave process filter.
saveAsCreates a new process filter.
deleteDelete process filter.

By default, the save, saveAs and delete actions are displayed in the editor. However, you can also choose which actions to show using the actions array. For example, the code below initializes the editor with the save and delete actions:

export class SomeComponent implements OnInit {

    actions: string[] = ['save', 'delete'];

    onFilterChange(filter: ProcessFilterCloudModel) {
        console.log('On filter change: ', filter);
    }

    onAction($event: ProcessFilterAction) {
        console.log('Clicked action: ', $event);
    }
<adf-cloud-edit-process-filter
    [id]="processFilterId"
    [appName]="applicationName"
    [actions]="actions">
</adf-cloud-edit-process-filter>

With this configuration, only the two actions will be shown.

Saving custom filters

Users can save a filter if they make any changes to it in an application using the Save icon. How it is saved is dictated by the Activiti version used:

  • An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session.

  • An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices.

See also

© 2023 Alfresco Software, Inc. All Rights Reserved.