Welcome to the Alfresco Builder Network

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

Contents

Basic Usage

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

Transclusions

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

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

Class members

Properties

NameTypeDefault valueDescription
applicationNamestring""The name of the application.
assigneestring""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).
createdDatestring""Filter the tasks. Display only tasks created on the supplied date.
dueDatestring""Filter the tasks. Display only tasks with dueDate equal to the supplied date.
idstring""Filter the tasks. Display only tasks with id equal to the supplied value.
landingTaskIdstringDefine which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected.
multiselectbooleanfalseToggles multiple row selection, rendering a checkbox at the beginning of each row.
namestring""Filter the tasks. Display only tasks with the supplied name.
parentTaskIdstring""Filter the tasks. Display only tasks with parentTaskId equal to the supplied value.
processDefinitionIdstring""Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value.
processInstanceIdstring""Filter the tasks. Display only tasks with processInstanceId equal to the supplied value.
selectionModestring"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.
sortingTaskListCloudSortingModel[]Specifies how the table should be sorted. The parameters are for BE sorting.
statusstring""Filter the tasks. Display only tasks with status equal to the supplied value.

Events

NameTypeDescription
errorEventEmitter<any>Emitted when an error occurs.
rowClickEventEmitter<string>Emitted when a task in the list is clicked
rowsSelectedEventEmitter<any[]>Emitted when rows are selected/unselected
successEventEmitter<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
    [applicationName]="'ApplicationName'">
    <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
                        [applicationName]="'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

Interested in trying Alfresco?

Try Now