Task List
Adds a task list widget to your dashboard, which lists all the tasks that you claimed or you've been assigned, as well as the unclaimed tasks that are assigned to your team.
Appearance
Show statistics: | Show a summary of task statistics. | Boolean |
Show Refresh button: | Show the Refresh button, which you can use to manually refresh the task list when the notification server is unavailable. | Boolean |
Hide status column: | Hide the status column from the list. | Boolean |
Show Start workflow: | Show the Start workflow button. | Boolean |
Disable actions menu: | Disable the menu that gives access to more actions for the task. | Boolean |
Hide search bar: | Hide search bar | Boolean |
Table style: | The table style {Default | Condensed} |
TableStyle |
Behavior
Customize columns: | Specify the columns to display in the task list. | NameValuePair[] |
Set persistent filters: | Select the binding to persist the filters in the task list. | SearchFilter[] |
Set tasks per page: | Enter the number of tasks to show per page. | Integer |
Show saved searches: | Show a drop-down list of saved searches. | Boolean |
Show search filter: | Show the search filter button. | Boolean |
Show view instance: | Enable the ability to open a task instance. | Boolean |
Disable auto-refresh: | Disable the auto-refresh of the list when filters are updated. | Boolean |
Filter by app: | Enter an app acronym to filter the list to show only tasks for that app. | String |
Enable task prioritization: | Activate Intelligent Task Prioritization that sorts the list, placing the best tasks to work on next at the top. | Boolean |
Set persistent searches: | Select the binding to persist the recent searches in the search bar. | String[] |
Use event to fetch tasks: | Delegate the fetch tasks request to an event. | Boolean |
Set event when tasks are launched: | Enter the name of the event to fire when a task is opened. | String |
Check task ownership: | Check whether the current user is authorized to open the task. | Boolean |
Disable opening of completed tasks: | Disable opening of completed tasks | Boolean |
Disable task claiming: | Do not show the Claim task modal. The task is automatically claimed upon opening. | Boolean |
Set persistent saved searches: | Select the binding to persist the saved searches in the task list | String |
Enable batch modify: | Enable the modification of multiple selected tasks at once. | Boolean |
Set persistent column widths: | Select the binding to persist the column widths in the task list. | NameValuePair[] |
Set persistent sorting: | Select the binding to persist the sorting of the task list. | NameValuePair |
Open task in new window: | Open a task in a new window. | Boolean |
Enable task launch: | Enable the ability to open a task. | Boolean |
Show copy link: | Show the copy link action in the overflow menu. | Boolean |
Automatically claimed task: | The task ID of the task that is automatically claimed when it appears in the task list. | String |
Set persistent advanced search: | Select the binding to persist the advanced search of the task list. | String |
Set persistent advanced search text: | Select the binding to persist the advanced search text of the task list. | String |
Performance
Set responsive mode: | Select the screen size for viewing the task list. {large | medium | small} |
ResponsiveMode |
Events | ||||||||
On Load: |
| |||||||
On Task Launched: |
|
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
Name | Type | Default | Description |
name | {string} | CSS class name(s) to add to the control. Separate class names by a space if more than one class. | |
replaced | {string} | CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class. |
Example
Button.addClass("green"); |
addStaticFilters()
Handler for when the pagination view's value changes
configBatchModify()
Setting batch config options
createStatusCell(theView, cell)
Creates the status cell with the appropriate highlighting based on the current task status.
Name | Type | Default | Description |
theView | {View} | The current view | |
cell | {Cell} | The table cell where the status information will be displayed |
deSelectAllRows()
Deselcts all selected rows
displayExpandedTaskRow(row.td, row.data, row.data.TASK.TKIID)
Set the task Table's expanded row
Name | Type | Default | Description |
row.td | {object} | - task data | |
row.data | {object} | - task data | |
row.data.TASK.TKIID | {string} | || row.data.tkiid |
getEmptyTableTexts()
Gets texts in the empty table
getSelectedRecords()
Gets selected tasks
handleTaskAction(event)
Handles the task action when a menu item is clicked.
Name | Type | Default | Description |
event | {event} | The actions menu click event |
Inherited
hide(collapseFlag)
Hide this view/control
Name | Type | Default | Description |
collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
MyView.hide(); |
Inherited
isBound()
Returns:
{boolean}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Checks if control label is visible
Example
var labelVisible = MyView.isLabelVisible(); |
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible(); |
launchTask(row)
Launches the task referenced by the given row.
Name | Type | Default | Description |
row | {Row} | The row of the table that contains the task record. |
loadEmptyTasksTableContent()
Loads empty task table content
loadSavedSearch()
Load saved search stack
onActionMenuClosed(actionsMenuView, actionsMenuTargetElement)
Called when the actions menu is closed.
Name | Type | Default | Description |
actionsMenuView | {View} | The actions menu view | |
actionsMenuTargetElement | {Element} | The action menu button that was clicked to invoke the menu. |
onActionMenuOpen(actionsMenuView, actionsMenuTargetElement)
Called when the actions menu is opened.
Name | Type | Default | Description |
actionsMenuView | {View} | The actions menu view | |
actionsMenuTargetElement | {Element} | The action menu button that was clicked to invoke the menu. |
onColumnSorting()
Triggered on column sorting
onResizeColumn()
Sets the column widths to the columnWidths binding
onTableRowSelected()
Triggered when table row get (all) selected
openBatchModifyTasks()
Event handler for launch batch modify tasks modal
openFilter()
The event handler for the slideout toggle.
paginationHandler()
Handler for when the pagination view's value changes
refreshTaskList()
Refresh tasklist when the refresh button is clicked
reload()
Reloads the Task List.
setAdvancedSearch(data)
Sets the json query for filtering the task list.
Name | Type | Default | Description |
data | {Object} | An object containing the input string, interaction filter, json query, and sort of the advanced search |
setEmptyTableTexts()
Set texts in the empty table
Inherited
setEnabled(enabled, required)
Enable/disable this view/control
Name | Type | Default | Description |
enabled | {boolean} | Enabled/read-only flag (true to enable view, false to disable/make read-only) | |
required | {boolean} | Enable/disable required field flag for control |
Example
MyView.setEnabled(false); //Make MyView read-only |
setExclusiveColumns(fields)
Sets the list of exclusive columns to filter the task list.
Name | Type | Default | Description |
fields | {String[]} | The list of colum name. |
setFilterConditions(conditions)
Sets the list of conditions for filtering the task list. If a search term is provided, it overrides the previously specified search conditions. The valid operators include "Equals", "NotEquals", "LessThan", "GreaterThan", and "In". For the "In" operator, use semi-colons ";" to separate a list of values.
Name | Type | Default | Description |
conditions | {NameValuePair[]} | The list of filter conditions. |
Inherited
setLabelVisible(visible)
Show/hide the label of this view/control
Name | Type | Default | Description |
visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
MyView.setLabelVisible(false); |
setQuickFilterConditions(conditions)
Sets the list of conditions for filtering the task list. If a search term is provided, it overrides the previously specified search conditions.
Name | Type | Default | Description |
conditions | {NameValuePair[]} | The list of filter conditions. |
setScopeCondition(conditions)
Sets the list of scope conditions to filter the task list.
Name | Type | Default | Description |
conditions | {NameValuePair[]} | The list of filter conditions. |
setSearchTerm(searchTerm)
Sets the search term. If a search term is provided, it overrides any previously specified search conditions.
Name | Type | Default | Description |
searchTerm | {string} | The search term used to filter the task list. |
setSelectedColumns(columns)
Sets the selected columns that the task list displays, and reloads the list.
Name | Type | Default | Description |
columns | {NameValuePair[]} | The list of selected columns. |
setSortByOptions()
Sets the sort by a drop-down value.
setTasks()
Sets tasks for displaying
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set
pattern detailed in the Knowlege Center section Binding Data and Configuration OptionsName | Type | Default | Description |
data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
createPseudoBinding | {boolean} | If set to true, creates a pseudo binding if there is no current binding. |
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
Name | Type | Default | Description |
visible | {boolean} | Visibility flag (true to show view, false to hide) | |
collapse | {boolean} | Set to true to collapse the control space when visible is set to false . |
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide() |
MyView.setVisible(false, true); // Sets visibility to "None" |
Inherited
show()
Show this view/control
Example
MyView.show(); |
sortByConditionOnChange()
Sets the conditions of the task displaying order.
toggleOrder()
Toggles the order button.
toggleTFS()
Set the task Table
updateSortIcons()
Update sort icons displayed on table headers