Class: TaskSearchList

TaskSearchList

A TaskSearchList provides the following configuration properties in Process Designer:
Behavior
Show Footer: {True | False} boolean
Show Table Stats: {True | False} boolean
Columns
Column Formats:
Type: {BPD Name | Task Activity Name | Assigned To User | Assigned To Role | Assigned To Role (Display Name) | Task Status | Task Due Date | Task Priority | Task Subject | Task Recieved Date | Task Closed Date | Task Setn Time | Tast Read Time | Task Recieved From | Task Closed By | Task ID | Instance Name | Instance ID | Instance Due Date | Instance Created Date | Instance Modified Date | Instance Process App | Instance Status | Instance Snapshot | Starting Document ID | Case Folder ID | Search Alias...} string
Search alias: (e.g. instanceName) string
Column Label: (e.g. Name) string
Clickable: {True | False} boolean
Sortable: {True | False} boolean
Invisible: {True | False} boolean
Format as: {Default | Text | Integer | Decimal | Date | Boolean | Custom} string
Format options: string
Width: (e.g. 50px, 100% Note:default unit is px) string
CSS: (e.g. color:red) string
Only Show Configured Columns: {True | False} boolean
Query
Default Saved Search Name: e.g. Saved Search String
Start Empty: {True | False} boolean
Condition: WHERE clause for query, e.g. PI_STATUS='Active' AND PRIORITY > 10 String
Sort By: comma separated list of sort criteria with ASC|DESC, e.g. PRIORITY ASC, STATUS DESC String
Interaction Filter: {None | Work on User's Tasks | Asses Available Tasks | Asses and Work on Tasks | Check Completed Tasks | Administer Tasks | Browse All Tasks} String
Filter By Current User: {True | False} boolean
Beginning Index: Index to start returned entries at (default is 0) integer
Max Entries: Maximum number of entries to return (e.g. 20) integer
Performance
Use Async Loading: {True | False} boolean
Async Batch Size: Number of list items to retrieve in each batch (e.g. 5) integer
Appearance
Color Style: {None | Light | Primary | Info | Success | Warning | Danger} string
Table Style: {Default | Elegant | Bordered | Striped | Hover Row | Condensed} string
Width: Width of the control (e.g. 500px, 80%, 20em, etc.) String
Height: Height of the control (e.g. 500px, 20em, etc.) String
Client-Side Searching
Enable Searches: {True | False} boolean
Allow Wildcards: {True | False} boolean
Case Insensitive Search: {True | False} boolean
Client-Side Sorting
Initial Sort Index: Index of the column to sort on initially (e.g. 2 to sort on the third column) integer
Initial Sort Ascending: {True | False} boolean
Client-Side Paging
Enable: {True | False} boolean
Show Pager: {True | False} boolean
Page Size: Number of entries to include per page. integer
Show Page Sizer: {True | False} boolean
Events
On Load:
Description: Triggers whenever the view is loaded.
Example:
console.log("Task Search List loaded")
On Refresh:
Description: Triggers when the list is refreshed.
Example:
${BusyIndicator}.hide();
On New Cell:
Description: Triggers upon rendering a cell.
Example:
Context Variables cell
Properties colIndex
controlType
parentNode
row
table
td
value
varName
getFormattedValue()
setSortValue()
On Item Click:
Description: Triggers upon reaching a Stay On Page event after a boundary event is fired through this control.
Example:
${Task_UI_Frame1}.loadTask(taskId)
Context Variables taskId item
Properties cell
data
instanceId
taskId

new TaskSearchList()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

getCondition(){String}

Get the current WHERE clause being used to execute the query
Returns:
Type Description
String

getMaxRecords(){integer}

Get the max number of results to return
Returns:
Type Description
integer

getOffset(){integer}

Get the offset from the first returned entry
Returns:
Type Description
integer

getSavedSearchName(){String}

Get the name of the current search being used to populate the list
Returns:
Type Description
String

getSortCriteria(){String}

Get the current sort criteria
Returns:
Type Description
String
Get descriptive string representing the type of control
Returns:
Type Description
string

refresh(reloadColumns)

Refresh the search list
Name Type Description
reloadColumns boolean If true, the list's columns will be reloaded

setCondition(condition)

Set the WHERE clause for query execution
Name Type Description
condition String WHERE clause to use
Example
${SearchList1}.setCondition("PI_STATUS='Active' AND PRIORITY > 10")
Set the maximum number of records to return
Name Type Description
max integer Max number of records to return
Set the offset from the first returned entry for displayed results
Name Type Description
offset integer Offset from the first result

setSavedSearchName(name)

Set which saved search to use to populate the list
Name Type Description
name String Name to set for the search
Set the criteria to use for sorting
Name Type Description
sc String Sort criteria