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-4300] Clarified info about sort properties for Edit task/proc cloud docs (#4503)

Browse Source
This commit is contained in:
Andy Stark
2019-03-26 17:01:55 +00:00
committed by Eugenio Romano
parent 3897bafe0c
commit c2d639ff66
2 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
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-20 Last reviewed: 2019-03-26
--- ---
# [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")
@@ -85,7 +85,7 @@ given below:
| **_status_** | Execution status of the process. | | **_status_** | Execution status of the process. |
| **_processDefinitionId_** | Process definition ID | | **_processDefinitionId_** | Process definition ID |
| **_processDefinitionKey_** | Process definition key | | **_processDefinitionKey_** | Process definition key |
| **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_**| | **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_** |
| **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". | | **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". |
| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) | | **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) |
@@ -124,7 +124,9 @@ With this configuration, only the four listed properties will be shown.
### Sort properties ### Sort properties
You can supply various _sort properties_ to sort the processes. You can supply a list of _sort properties_ to sort the processes. Any of the
[filter properties](#filter-properties) listed above can also be used as
sort properties.
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

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

@@ -2,7 +2,7 @@
Title: Edit Task Filter Cloud component Title: Edit Task Filter Cloud component
Added: v3.0.0 Added: v3.0.0
Status: Experimental Status: Experimental
Last reviewed: 2019-03-20 Last reviewed: 2019-03-26
--- ---
# [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts") # [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts")
@@ -20,6 +20,8 @@ Edits task filter details.
- [Details](#details) - [Details](#details)
- [Editing APS2 task filters](#editing-aps2-task-filters) - [Editing APS2 task filters](#editing-aps2-task-filters)
- [Filter properties](#filter-properties) - [Filter properties](#filter-properties)
- [Sort properties](#sort-properties)
- [Action properties](#action-properties)
- [See also](#see-also) - [See also](#see-also)
## Basic Usage ## Basic Usage
@@ -40,11 +42,13 @@ Edits task filter details.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| actions | `string[]` | | List of task filter actions. |
| appName | `string` | | (required) Name of the app. | | appName | `string` | | (required) Name of the app. |
| filterProperties | `string []` | `['status', 'assignee', 'sort', 'order']` | List of task filter properties to display. | | filterProperties | `string[]` | | List of task filter properties to display. |
| id | `string` | | (required) ID of the task filter. | | id | `string` | | (required) ID of the task filter. |
| showFilterActions | `boolean` | true | Toggles the filter actions. | | showFilterActions | `boolean` | true | Toggles the filter actions. |
| showTitle | `boolean` | true | Toggles the title. | | showTitle | `boolean` | true | Toggles the title. |
| sortProperties | `string[]` | | List of sort properties to display. |
### Events ### Events
@@ -86,11 +90,10 @@ given below:
| **_processDefinitionId_** | Process definition ID | | **_processDefinitionId_** | Process definition ID |
| **_processDefinitionKey_** | Process definition key | | **_processDefinitionKey_** | Process definition key |
| **_processInstanceId_** | Process instance ID | | **_processInstanceId_** | Process instance ID |
| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_**| | **_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". | | **_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). | | **_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 By default, the **_status_**, **_assignee_**, **_sort_** and **_order_** properties
are displayed in the editor. However, you can also choose which 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 to show using the `filterProperties` array. For example, the code below initializes
@@ -121,7 +124,9 @@ With this configuration, only the four listed properties will be shown.
### Sort properties ### Sort properties
You can supply various *sort properties* to sort the tasks. You can supply a list of _sort properties_ to sort the tasks. Any of the
[filter properties](#filter-properties) listed above can also be used as
sort properties.
By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** properties are By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** 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
@@ -129,7 +134,6 @@ to show using the `sortProperties` array.
For example, the code below initializes the editor with the **_createdDate_** , **_lastModified_** and **_priority_** properties: For example, the code below initializes the editor with the **_createdDate_** , **_lastModified_** and **_priority_** properties:
```ts ```ts
export class SomeComponent implements OnInit { export class SomeComponent implements OnInit {
sortProperties: string[] = [ sortProperties: string[] = [
@@ -145,6 +149,7 @@ export class SomeComponent implements OnInit {
console.log('Clicked action: ', $event); console.log('Clicked action: ', $event);
} }
``` ```
```html ```html
<adf-cloud-edit-task-filter <adf-cloud-edit-task-filter
[id]="taskFilterId" [id]="taskFilterId"
@@ -152,26 +157,25 @@ export class SomeComponent implements OnInit {
[sortProperties]="sortProperties"> [sortProperties]="sortProperties">
</adf-cloud-edit-task-filter> </adf-cloud-edit-task-filter>
``` ```
With this configuration, only the three listed sort properties will be shown. With this configuration, only the three listed sort properties will be shown.
### Action properties ### Action properties
You can supply various *actions* to apply on task filter. You can supply various _actions_ to apply on task filter.
| Name | Description | | Name | Description |
| -- | -- | | ---- | ----------- |
| **_save_** | Save task filter. | | **_save_** | Save task filter. |
| **_saveAs_** | Creates a new 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 By default, the **_save_**, **_saveAs_** and **_delete_** actions are
displayed in the editor. However, you can also choose which actions to displayed in the editor. However, you can also choose which actions to
show using the `actions` array. show using the `actions` array.
For example, the code below initializes the editor with the **_save_** and **_delete_** actions: For example, the code below initializes the editor with the **_save_** and **_delete_** actions:
```ts ```ts
export class SomeComponent implements OnInit { export class SomeComponent implements OnInit {
actions: string[] = ['save', 'delete']; actions: string[] = ['save', 'delete'];