mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
3204bdebcb
* [ADF-1749] Task List - Should be able to customize the rendered columns from JSON * Refactored task/process list components to support customization key's * Added Key properties to the app.config.json. * Created preset model for task/process list . * [ADF-1749] Task/Process List - Should be able to customize the rendered columns from JSON * Fixed failing testcases. * [ADF-1749] Task/Process List - Should be able to customize the rendered columns from JSON. * Added test cases. * Updated task/process list readme.md file * * Updated task/process list readme.md file.
95 lines
2.6 KiB
Markdown
95 lines
2.6 KiB
Markdown
# Activiti Process Instance List
|
|
|
|
This component renders a list containing all the process instances matched by the parameters specified.
|
|
|
|
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
|
|
|
<!-- toc -->
|
|
|
|
- [Basic Usage](#basic-usage)
|
|
* [Properties](#properties)
|
|
* [Events](#events)
|
|
- [Details](#details)
|
|
|
|
<!-- tocstop -->
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## Basic Usage
|
|
|
|
**app.component.html**
|
|
|
|
```html
|
|
<adf-process-instance-list
|
|
[appId]="'1'"
|
|
[state]="'open'">
|
|
</adf-process-instance-list>
|
|
```
|
|
|
|
You can also use custom schema declaration as shown below:
|
|
|
|
define custom schema in the app.config.json as shown below json format.
|
|
|
|
```json
|
|
"adf-process-list": {
|
|
"presets": {
|
|
"customSchema": [
|
|
{
|
|
"key": "name",
|
|
"type": "text",
|
|
"title": "name",
|
|
"sortable": true
|
|
}],
|
|
"default": [
|
|
{
|
|
"key": "name",
|
|
"type": "text",
|
|
"title": "name",
|
|
"sortable": true
|
|
}],
|
|
}
|
|
}
|
|
```
|
|
|
|
```html
|
|
<adf-process-instance-list
|
|
[appId]="'1'"
|
|
[state]="'open'"
|
|
[presetColumn]="'customSchema'">
|
|
</adf-process-instance-list>
|
|
```
|
|
### Properties
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| appId | The id of the app. |
|
|
| processDefinitionKey | The processDefinitionKey of the process. |
|
|
| presetColumn | string || The presetColumn of the custom schema to fetch. |
|
|
| state | Define state of the processes. Possible values are `running`, `completed` and `all` |
|
|
| sort | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` |
|
|
| schemaColumn | List of columns to display in the process instances datatable (see the [Details](#details) section below) |
|
|
|
|
### Events
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| rowClick | Emitted when a row in the process list is clicked |
|
|
| success | Emitted when the list of process instances has been loaded successfully from the server |
|
|
| error | Emitted when an error is encountered loading the list of process instances from the server |
|
|
|
|
|
|
|
|
|
|
## Details
|
|
|
|
Example value for the schemaColumn property (see [Properties](#properties) section above):
|
|
|
|
```json
|
|
[
|
|
{type: 'text', key: 'id', title: 'Id', sortable: true},
|
|
{type: 'text', key: 'name', title: 'Name', cssClass: 'full-width name-column', sortable: true},
|
|
{type: 'text', key: 'started', title: 'Started', sortable: true},
|
|
{type: 'text', key: 'startedBy.email', title: 'Started By', sortable: true}
|
|
]
|
|
```
|