Class: InstanceList

InstanceList

Controls that utilizes the InstanceList provides the following configuration properties in Process Designer:
Behavior
Show Footer: {True | False} boolean
Show Table Stats: {True | False} boolean
Show Footer: {True | False} boolean
Show Table Stats: {True | False} string
Show Pager: {True | False} string
Show Page Sizer: {True | False} string
Initial Page Size: {True | False} string
Columns:
Column Label: (e.g. Name) string
Type: {Instance Name| Instance ID | BPD Name | Instance Due Date | Instance Created Date | Instance Modified Date | Instance Status | Instance Snapshot | Instance Process App | Case Folder ID | Starting Document ID | search alias} string
Search alias: (e.g. instanceName) 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
Query
Start Empty: {True | False} boolean
Conditions:
Column : {Instance Name| Instance Status | BPD Name | search alias | Instance Process App | Instance Snapshot | Instance Due Date | Instance Modified Date | Instance Created Date | Case Folder ID | Starting Document ID | Instance ID} string
Search alias: (e.g. ID) string
Operator: {Contains | = | > | < | <> | Starts with} string
Value: (e.g. Test) string
Sort By:
Type : {Instance Name| Instance ID | BPD Name | Instance Due Date | Instance Created Date | Instance Modified Date | Instance Status | Instance Snapshot | Instance Process App | Case Folder ID | Starting Document ID | search alias} string
Search Alias: (e.g. instanceName) string
Second Sort By:
Type : {Instance Name| Instance ID | BPD Name | Instance Due Date | Instance Created Date | Instance Modified Date | Instance Status | Instance Snapshot | Instance Process App | Case Folder ID | Starting Document ID | search alias} string
Search Alias: (e.g. instanceCreateDate) string
Filter By Current User: {True | False} boolean
Beginning Index: (e.g. 10) integer
Max Entries: (e.g. 100) integer
Performance
Async Loading: {True | False} boolean
Async Batch Size: (e.g. 20) integer
Appearance
Color Style: {None | Light | Primary | Info | Success | Warning | Danger} string
Table Style: {Default | Elegant | Primary | Bordered | Stripe | Hover Row | Condensed} string
Width: (e.g 50px) string
Height: (e.g. 500px) string
Show Table Stats: {True | False} boolean
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: (e.g. 10) integer
Initial Sort Ascending: {True | False} boolean
Client-Side Paging
Enable: {True | False} boolean
Show Pager: {True | False} boolean
Page Size: (e.g. 20) integer
Show Page Sizer: {True | False} boolean
Events
On Load:
Description: This event when the table is loaded.
Example:
On Refresh:
Description: This event fires whenever a the control refreshes.
Example:
On New Cell:
Description: This event fires whenever a new cell in inserted.
Example:
On Item Click:
Description: This event fires whenever an item is clicked.
Example:

new InstanceList()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

getMaxRecords(){integer}

Get the maximum records that has been set for the control
Returns:
Type Description
integer
Set the maximum records that can be rendered by the control
Name Type Description
max integer the maximum number of records

getOffset(){integer}

Get the beginning index
Returns:
Type Description
integer
Get descriptive string representing the type of control
Returns:
Type Description
string
Refreshes the list
Set the beginning index
Name Type Description
offset integer row number in which the list control begins