mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ACS-7427] Process Services improvements and cleanup (#9664)
This commit is contained in:
Denys Vuika
GitHub
@@ -41,27 +41,27 @@ Edits task filter details.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| actions | `string[]` | | List of task filter actions. |
|
||||
| appName | `string` | "" | (required) Name of the app. |
|
||||
| environmentList | [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]` | \[] | List of environments. |
|
||||
| filterProperties | `string[]` | \[] | List of task filter properties to display. |
|
||||
| id | `string` | | (required) ID of the task filter. |
|
||||
| processInstanceId | `string` | | processInstanceId of the task filter. |
|
||||
| role | `string` | "" | user role. |
|
||||
| showFilterActions | `boolean` | true | Toggles the filter actions. |
|
||||
| showTaskFilterName | `boolean` | true | Toggles display of task filter name |
|
||||
| showTitle | `boolean` | true | Toggles the title. |
|
||||
| sortProperties | `string[]` | \[] | List of sort properties to display. |
|
||||
| taskFilter | [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) | | Task Filter to use. |
|
||||
| Name | Type | Default value | Description |
|
||||
|--------------------|----------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------|
|
||||
| actions | `string[]` | | List of task filter actions. |
|
||||
| appName | `string` | "" | (required) Name of the app. |
|
||||
| environmentList | [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]` | \[] | List of environments. |
|
||||
| filterProperties | `string[]` | \[] | List of task filter properties to display. |
|
||||
| id | `string` | | (required) ID of the task filter. |
|
||||
| processInstanceId | `string` | | processInstanceId of the task filter. |
|
||||
| role | `string` | "" | user role. |
|
||||
| showFilterActions | `boolean` | true | Toggles the filter actions. |
|
||||
| showTaskFilterName | `boolean` | true | Toggles display of task filter name |
|
||||
| showTitle | `boolean` | true | Toggles the title. |
|
||||
| sortProperties | `string[]` | \[] | List of sort properties to display. |
|
||||
| taskFilter | [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) | | Task Filter to use. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
|
||||
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when a task filter property changes. |
|
||||
| Name | Type | Description |
|
||||
|--------------|----------------------------------|------------------------------------------------------------------|
|
||||
| action | `EventEmitter<TaskFilterAction>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
|
||||
| filterChange | `EventEmitter<any>` | Emitted when a task filter property changes. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -82,23 +82,23 @@ You can supply various _filter properties_ to edit that will determine
|
||||
which tasks are found by a filter. The full set of properties is
|
||||
given below:
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| **_appName_** | Name of the app |
|
||||
| **_status_** | Execution state of the task. |
|
||||
| **_assignee_** | [`User`](lib/core/src/lib/pipes/user-initial.pipe.ts) the task is assigned to |
|
||||
| **_taskName_** | Name of the task |
|
||||
| **_taskId_** | ID of the task |
|
||||
| **_parentTaskId_** | ID of the task's parent task |
|
||||
| **_priority_** | Task priority |
|
||||
| **_createdDate_** | Date the task was created |
|
||||
| **_standalone_** | Standalone status of the task |
|
||||
| **_owner_** | [`User`](lib/core/src/lib/pipes/user-initial.pipe.ts) ID of the task's owner |
|
||||
| **_processDefinitionId_** | Process definition ID |
|
||||
| **_processInstanceId_** | Process instance ID |
|
||||
| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** |
|
||||
| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". |
|
||||
| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). |
|
||||
| Name | Description |
|
||||
|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **_appName_** | Name of the app |
|
||||
| **_status_** | Execution state of the task. |
|
||||
| **_assignee_** | [`User`](lib/core/src/lib/pipes/user-initial.pipe.ts) the task is assigned to |
|
||||
| **_taskName_** | Name of the task |
|
||||
| **_taskId_** | ID of the task |
|
||||
| **_parentTaskId_** | ID of the task's parent task |
|
||||
| **_priority_** | Task priority |
|
||||
| **_createdDate_** | Date the task was created |
|
||||
| **_standalone_** | Standalone status of the task |
|
||||
| **_owner_** | [`User`](lib/core/src/lib/pipes/user-initial.pipe.ts) ID of the task's owner |
|
||||
| **_processDefinitionId_** | Process definition ID |
|
||||
| **_processInstanceId_** | Process instance ID |
|
||||
| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** |
|
||||
| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". |
|
||||
| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). |
|
||||
|
||||
By default, the **_status_**, **_assignee_**, **_sort_** and **_order_** properties
|
||||
are displayed in the editor. However, you can also choose which properties
|
||||
@@ -107,8 +107,6 @@ the editor with the **_appName_**, **_processInstanceId_**, **_createdDate_** an
|
||||
**_lastModified_** properties:
|
||||
|
||||
```ts
|
||||
import { UserProcessModel } from '@alfresco/adf-core';
|
||||
|
||||
export class SomeComponent implements OnInit {
|
||||
|
||||
filterProperties: string[] = [
|
||||
@@ -124,6 +122,7 @@ export class SomeComponent implements OnInit {
|
||||
onAction($event: TaskFilterAction) {
|
||||
console.log('Clicked action: ', $event);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
With this configuration, only the four listed properties will be shown.
|
||||
@@ -155,6 +154,7 @@ export class SomeComponent implements OnInit {
|
||||
onAction($event: TaskFilterAction) {
|
||||
console.log('Clicked action: ', $event);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```html
|
||||
@@ -171,11 +171,11 @@ With this configuration, only the three listed sort properties will be shown.
|
||||
|
||||
You can supply various _actions_ to apply on task filter.
|
||||
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| **_save_** | Save task filter. |
|
||||
| Name | Description |
|
||||
|--------------|----------------------------|
|
||||
| **_save_** | Save task filter. |
|
||||
| **_saveAs_** | Creates a new task filter. |
|
||||
| **_delete_** | Delete task filter. |
|
||||
| **_delete_** | Delete task filter. |
|
||||
|
||||
By default, the **_save_**, **_saveAs_** and **_delete_** actions are
|
||||
displayed in the editor. However, you can also choose which actions to
|
||||
@@ -194,6 +194,7 @@ export class SomeComponent implements OnInit {
|
||||
onAction($event: TaskFilterAction) {
|
||||
console.log('Clicked action: ', $event);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```html
|
||||
|
||||
@@ -25,7 +25,7 @@ Lists all available process filters and allows to select a filter.
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | "" | (required) The application name |
|
||||
| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default |
|
||||
| filterParam | `UserTaskFilterRepresentation` | | (optional) The filter to be selected by default |
|
||||
| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -31,21 +31,21 @@ Shows all available filters.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | "" | Display filters available to the current user for the application with the specified name. |
|
||||
| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. |
|
||||
| showIcons | `boolean` | false | Toggles display of the filter's icons. |
|
||||
| Name | Type | Default value | Description |
|
||||
|-------------|---------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| appName | `string` | "" | Display filters available to the current user for the application with the specified name. |
|
||||
| filterParam | `FilterParamsModel` | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. |
|
||||
| showIcons | `boolean` | false | Toggles display of the filter's icons. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
|
||||
| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. |
|
||||
| filterCounterUpdated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` | Emitted when filter counters are updated. |
|
||||
| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
|
||||
| Name | Type | Description |
|
||||
|----------------------|---------------------------------------|-------------------------------------------------------------------------|
|
||||
| error | `EventEmitter<any>` | Emitted when an error occurs during loading. |
|
||||
| filterClicked | `EventEmitter<TaskFilterCloudModel>` | Emitted when a filter is being clicked from the UI. |
|
||||
| filterCounterUpdated | `EventEmitter<TaskCloudEngineEvent>` | Emitted when filter counters are updated. |
|
||||
| filterSelected | `EventEmitter`<TaskFilterCloudModel>` | Emitted when a filter is being selected based on the filterParam input. |
|
||||
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -59,8 +59,7 @@ Use the `filterParam` property to restrict the range of filters that are shown:
|
||||
</adf-cloud-task-filters>
|
||||
```
|
||||
|
||||
You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
|
||||
as the value of `filterParam` as shown in the table below:
|
||||
You can use properties from `FilterParamsModel` as the value of `filterParam` as shown in the table below:
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
|
||||
Reference in New Issue
Block a user