alfresco-ng2-components/docs/process-list.component.md

Process Instance List

Renders a list containing all the process instances matched by the parameters specified.

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		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
page	number	0	The page of the tasks to fetch.
size	number	25	The number of tasks to fetch.
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}
]