mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
4.4 KiB
4.4 KiB
Title, Added, Status, Last reviewed
Title | Added | Status | Last reviewed |
---|---|---|---|
Edit Process Filter Cloud component | v3.0.0 | Experimental | 2019-01-30 |
Edit Process Filter Cloud component
Shows Process Filter Details.
Contents
Basic Usage
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="applicationName"
[filterProperties]="filterProperties"
(filterChange)="onFilterChange($event)"
(action)="onAction($event)">
</adf-cloud-edit-process-filter>
Class members
Properties
Name | Type | Default value | Description |
---|---|---|---|
appName | string |
The name of the application. | |
filterProperties | string[] |
List of process filter properties to display | |
id | string |
Id of the process instance filter. | |
showFilterActions | boolean |
true | Toggles editing of process filter actions. |
showTitle | boolean |
true | Toggles editing of the process filter title. |
Events
Name | Type | Description |
---|---|---|
action | EventEmitter < ProcessFilterActionType > |
Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
filterChange | EventEmitter < 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]="applicationName">
</adf-cloud-edit-process-filter>
Filter properties
You can supply various filter properties to edit that will determine which processes are found by a filter. The full set of properties is given below:
Name | Description |
---|---|
appName | Name of the app |
processInstanceId | Process instance ID |
processName | Process name. |
initiator | ID of the user who initiated the process |
state | Execution state of the process. |
processDefinitionId | Process definition ID |
processDefinitionKey | Process definition key |
lastModifiedFrom | Finds processes modified after this date |
lastModifiedTo | Finds processes modified before this date |
sort | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "status" or "startDate". |
order | Sort ordering of the filter results (this doesn't participate in the filtering itself) |
By default, the state, 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,
processInstanceId, startDate and lastModified properties:
import { UserProcessModel } from '@alfresco/adf-core';
export class SomeComponent implements OnInit {
filterProperties: string[] = [
"appName",
"processInstanceId",
"startDate",
"lastModified"];
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.
Note: Currently, the sort
property has a limited set of properties
to choose from: id, name, status and startDate.