mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

siva kumar 3204bdebcb [ADF-1749] Task/Process List - Should be able to customize the rendered columns from JSON (#2613 )

* [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.

2017-11-07 23:37:07 +00:00

2.6 KiB

Raw Blame History

Activiti Process Instance List

This component renders a list containing all the process instances matched by the parameters specified.

Basic Usage
- Properties
- Events
Details

Basic Usage

app.component.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.

"adf-process-list": {
        "presets": {
            "customSchema": [
            {
                    "key": "name",
                    "type": "text",
                    "title": "name",
                    "sortable": true         
            }],
            "default": [
                {
                    "key": "name",
                    "type": "text",
                    "title": "name",
                    "sortable": true
            }],
        }
}

<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
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 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 section above):

[
    {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}
]

2.6 KiB Raw Blame History