inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4383] Updated filter props details in Edit proc cloud docs (#4586)

Browse Source
This commit is contained in:
Andy Stark
2019-04-10 12:20:14 +01:00
committed by Eugenio Romano
parent 7a2c5762ff
commit 0d38321182
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/process-services-cloud/components/edit-process-filter-cloud.component.md
View File

@@ -2,7 +2,7 @@
Title: Edit Process Filter Cloud component Title: Edit Process Filter Cloud component
Added: v3.0.0 Added: v3.0.0
Status: Experimental Status: Experimental
Last reviewed: 2019-03-27 Last reviewed: 2019-04-10
--- ---
# [Edit Process Filter Cloud component](../../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts") # [Edit Process Filter Cloud component](../../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
@@ -79,8 +79,8 @@ given below:
| Name | Description | | Name | Description |
| ---- | ----------- | | ---- | ----------- |
| **_appName_** | Name of the app | | **_appName_** | Name of the app |
| **_processInstanceId_** | Process instance ID | | **_id_** | Process instance ID |
| **_processName_** | Process name. | | **_name_** | Process name. |
| **_initiator_** | ID of the user who initiated the process | | **_initiator_** | ID of the user who initiated the process |
| **_status_** | Execution status of the process. | | **_status_** | Execution status of the process. |
| **_processDefinitionId_** | Process definition ID | | **_processDefinitionId_** | Process definition ID |
@@ -93,15 +93,17 @@ By default, the **_status_**, **_sort_** and **_order_** properties are
displayed in the editor. However, you can also choose which properties displayed in the editor. However, you can also choose which properties
to show using the `filterProperties` array. to show using the `filterProperties` array.
For example, the code below initializes the editor with the **_appName_**, For example, the code below initializes the editor with the **_appName_**,
**_processInstanceId_**, **_processName_** and **_lastModified_** properties: **_id_**, **_name_** and **_lastModified_** properties:
```ts ```ts
export class SomeComponent implements OnInit { export class SomeComponent implements OnInit {
filterProperties: string[] = [ filterProperties: string[] = [
"processName" "appName",
"processInstanceId", "id",
"lastModified"]; "name",
"lastModified"
];
onFilterChange(filter: ProcessFilterCloudModel) { onFilterChange(filter: ProcessFilterCloudModel) {
console.log('On filter change: ', filter); console.log('On filter change: ', filter);
@@ -126,8 +128,7 @@ With this configuration, only the four listed properties will be shown.
You can supply a list of _sort properties_ to sort the processes. You can use You can supply a list of _sort properties_ to sort the processes. You can use
any of the [filter properties](#filter-properties) listed above as any of the [filter properties](#filter-properties) listed above as
sort properties and you can also use the process **_id_** and **_startDate_** sort properties and you can also use the process's **_startDate_**.
properties and use **_name_** as a shorthand for **_processName_**.
By default, the **_id_**, **_name_**, **_status_** and **_startDate_** properties are By default, the **_id_**, **_name_**, **_status_** and **_startDate_** properties are
displayed in the editor. However, you can also choose which sort properties displayed in the editor. However, you can also choose which sort properties