alfresco-ng2-components/docs/process-services-cloud/components/task-list-cloud.component.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Task List Cloud component	v3.0.0	Experimental	2019-01-08

Task List Cloud component

Renders a list containing all the tasks matched by the parameters specified.

Contents

• Basic Usage
  • Transclusions
• Class members
  • Properties
  • Events
• Details
  • Setting the column schema
  • Setting Sorting Order for the list
  • Pagination strategy
  • DataTableAdapter example
  • DataColumn Features
• See also

Basic Usage

<adf-cloud-task-list
    [appName]="'APPLICATION-NAME'" >
</adf-cloud-task-list>

Transclusions

Any content inside an <adf-custom-empty-content> sub-component will be shown when the task list is empty:

<adf-cloud-task-list>
    <adf-custom-empty-content>
        Your Content
    </adf-custom-empty-content>
<adf-cloud-task-list>

Class members

Properties

Name	Type	Default value	Description
appName	string	""	The name of the application.
assignee	string	""	The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved).
createdDate	string	""	Filter the tasks. Display only tasks created on the supplied date.
dueDate	string	""	Filter the tasks. Display only tasks with dueDate equal to the supplied date.
id	string	""	Filter the tasks. Display only tasks with id equal to the supplied value.
lastModifiedFrom	string	""	Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date.
lastModifiedTo	string	""	Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date.
multiselect	boolean	false	Toggles multiple row selection, rendering a checkbox at the beginning of each row.
name	string	""	Filter the tasks. Display only tasks with the supplied name.
owner	string	""	Filter the tasks. Display only tasks with owner equal to the supplied value.
parentTaskId	string	""	Filter the tasks. Display only tasks with parentTaskId equal to the supplied value.
presetColumn	string		Custom preset column schema in JSON format.
priority	number		Filter the tasks. Display only tasks with priority equal to the supplied value.
processDefinitionId	string	""	Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value.
processInstanceId	string	""	Filter the tasks. Display only tasks with processInstanceId equal to the supplied value.
selectionMode	string	"single"	Row selection mode. Can be none, single or multiple. For multiple mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows.
sorting	TaskListCloudSortingModel[]		Specifies how the table should be sorted. The parameters are for BE sorting.
standAlone	boolean	false	Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true.
status	string	""	Filter the tasks. Display only tasks with status equal to the supplied value.

Events

Name	Type	Description
error	EventEmitter<any>	Emitted when an error occurs.
rowClick	EventEmitter<string>	Emitted when a task in the list is clicked
rowsSelected	EventEmitter<any[]>	Emitted when rows are selected/unselected
success	EventEmitter<any>	Emitted when the task list is loaded

Details

This component displays lists of tasks related to the application name insterted. Extra filtering can be provided by applying extra input parameters.

Setting the column schema

You can use an HTML-based schema declaration to set a column schema for the tasklist as shown below:

<adf-cloud-task-list ...>
    <data-columns>
        <data-column key="name" title="NAME" class="full-width name-column"></data-column>
        <data-column key="created" title="Created" class="hidden"></data-column>
    </data-columns>
</adf-cloud-task-list>

You can also set a static custom schema declaration in app.config.json as shown below:

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

<adf-cloud-task-list
    [appId]="'1'"
    [presetColumn]="'customSchema'">
</adf-cloud-task-list>

You can use an HTML-based schema and an app.config.json custom schema declaration at the same time:

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

<adf-cloud-task-list
    [appName]="'appName'">
    <data-columns>
        <data-column key="assignee" title="Assignee" class="full-width name-column">
            <ng-template let-entry="$implicit">
                    <div>{{getFullName(entry.row.obj.assignee)}}</div>
            </ng-template>
        </data-column>
    </data-columns>
</adf-cloud-task-list>

Setting Sorting Order for the list

You can specify a sorting order as shown in the example below:

let sorting = { orderBy: 'created', direction: 'desc' };

<adf-cloud-task-list
    [appId]="'1'"
    [sorting]="[sorting]">
</adf-cloud-task-list>

Pagination strategy

The Tasklist also supports pagination as shown in the example below:

<adf-cloud-task-list #taskCloud
                        [appName]="'APPLICATION-NAME'">
</adf-cloud-task-list>
<adf-pagination [target]="taskCloud"
                (changePageSize)="onChangePageSize($event)">
</adf-pagination>

DataTableAdapter example

See the DataTableAdapter page for full details of the interface and its standard implementation, ObjectDataTableAdapter. Below is an example of how you can set up the adapter for a typical tasklist.

[
 {"type": "text", "key": "id", "title": "Id"},
 {"type": "text", "key": "name", "title": "Name", "cssClass": "full-width name-column", "sortable": true},
 {"type": "text", "key": "formKey", "title": "Form Key", "sortable": true},
 {"type": "text", "key": "created", "title": "Created", "sortable": true}
]

DataColumn Features

You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the DataColumn page for more information about these features.

See also

• Data column component
• DataTableAdapter
• Pagination component