alfresco-ng2-components/docs/process-services-cloud/edit-process-filter-cloud.component.md
siva kumar ea733fc996 [ADF-3883] Improve edit-process-filter-cloud by adding inputs to control filters, sort and actions (#4127)
* [ADF-3883] Improve edit-process-filter-cloud by adding inputs to control filters, sort and actions * Fixed translate keys

* * Added more properties to the editProcessModel

* Fix FIlterOption model

* Fix import model name

* * After rebase* Cherry pick * Updated doc

* Revert commit

* Revert changes

* * Removed obervalu from model* Added edit process/task filter to the demo shell* Refacotred edit task/process filter * Updated test to the recent changes

* * Fixed failing e2e tests * Added data-automation-id

* * After rebase

* * Modified ProcessFilterActionType model* Added condition to get the currect filter after save as* Changed column to sort in the en.json, removed unused keys* Improved onSave editProcessfilter method * imported missing groupModule in the process-service-cloud module

* * Fixed e2e test
2019-01-29 12:48:11 +00:00

3.2 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Edit Process Filter Cloud component v3.0.0 Experimental 2019-01-08

Edit Process Filter Cloud component

Shows Process Filter Details.

Basic Usage

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

Class members

Properties

Name Type Default value Description
appName string (required) The name of the application.
id string (required) Id of the process instance filter.
filterProperties string [] ['state', 'sort', 'order'] List of process filter properties to display.
showFilterActions boolean true Toggles edit process filter actions.
showTitle boolean true Toggles edit process filter title.

Events

Name Type Description
action EventEmitter<ProcessFilterActionType> Emitted when an filter action occurs i.e Save, SaveAs, Delete.
filterChange EventEmitter<ProcessFilterCloudModel> Emitted when an process instance filter property changes.

Details

Editing APS2 process filter

Use the application name and process filter id property to edit process filter properties:

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

By default these below properties are displayed:

state, sort, order.

However, you can also choose which properties to show using an input property filterProperties:

Populate the filterProperties in the component class:

import { UserProcessModel } from '@alfresco/adf-core';

export class SomeComponent implements OnInit {

    filterProperties: string[] = [
        "appName",
        "processInstanceId",
        "startDate",
        "startedAfter"];

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

    onAction($event: ProcessFilterActionType) {
        console.log('Clicked action: ', $event);
    }

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

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

All Available properties are:

appName, initiator, state, sort, order, processDefinitionId, processDefinitionKey, processInstanceId, startDate, lastModified, lastModifiedFrom, lastModifiedTo.

edit-process-filter-cloud