Instance List

The Instance List control allows the Portal user to suspend, resume, or abort a process instance. 

The Instance List control comes with many easy to configure behavior, columns, query, performance, appearance, client-side searching, client-side sorting, and client-side paging options.

Like all Portal Builder controls, you can trigger events that are fired when the user interacts with the control (see the Event and Methods sections below and the Event Handling article for more information).



Show Footer Displays the table footer, if you are using paging (see below) make sure this is checked

Show Table Stats Displays information regarding the table, for example: Showing 1 to 10 of 39 entries


Columns The columns that the table displays

     Column Label Specify the name of the column

     Type Show what data is displayed, e.g. Instance Name, Instance ID, BPD                         Name, Instance Due Date, etc.

     Search alias This is the alias to be used for business data fields only.  This                     allows business data to participate in the Conditions, Sorting, and Order.

     Clickable Allows for the column a clickable link

     Sortable Allows client-side sorting on the column

     Invisible Hides the column

     Format as Default, Text, Integer, Decimal, Date, Boolean, Custom

     Format options e.g. "datePattern": "yyyy/MM/dd"

     Width Specifies the width of the column, e.g. 150px. 100% Note: default unit                   is px

     Css Allows for specification of a specific CSS class, e.g. font-weight:bold;                       color:red


This section allows you to specify the query which is run against the returned list to further filter it.

Start Empty Whether or not the list is empty when the page loads.  Entries can be shown using the refresh method.

Conditions Conditional expression to be used with the query

     Column The column the condition should apply to

     Search alias The alias that was specified in Columns, e.g. instanceName

     Operator Contains, = (equal), > (greater than), < (less than), <> (not equal),                   and Starts with

     Value What the operator should evaluate

Sort By The name of the column on which to base the primary sort of the search results.

     Type What to base the sort on

     Search alias The alias that was specified in Columns, e.g. instanceName

Second Sort By The name of the column on which to base the secondary sort of the search results.

    Type What to base the sort on

     Search alias The alias that was specified in Columns

Filter By Current User Note: This parameter is used only when the request is being executed by an administrative user, otherwise it is ignored.This parameter is a flag which indicates whether or not the search results should be restricted to those entities associated with the current user. A value of false means that an unfiltered search will be performed, whereas a value of true indicates that the search results will be filtered by the current user. 

Beginning Index Index to start at in returned entries.  (default 0)

Max Entries Maximum number of entries (Threshold) to return. (default 100)


Use Async Loading Whether or not to asynchronously load the table.

Asyc Batch Size The batch size when asynchronously loading the table.


 Color Style 

 Table Style Default, Elegant, Bordered, Striped, Hover Row, Condensed 

Client-Side Searching


Enable Searches When TRUE allows for searches against the table

Allow Wildcards When TRUE allows wildcards in searches

Case Insensitive Search When TRUE any search is case-insensitive.

Client-Side Sorting

Initial Sort Index The initial column sort when the page loads. (Based on a 0-index)

Initial Sort Ascending Whether or not to sort the column in ascending order.

Client-Side Paging

Enable Enable paging

Show Pager Whether to show the pager or not

Page Size Indicate the page size

Show Page Sizer Whether or not to show the page sizer


Here is a BPD named Test, the data that will be displayed in the Task List will correspond to the Process Instances of this BPD.

These are the configuration option settings...

 Note: The Css for the Status column is: font-weight:bold; color:red

This is the result...


With the Instance List control, there are 4 types of event handlers:

  • On Load When the page loads, Note that this particular event is only fired ONCE per page load.
  • On Refresh When the Instance List control is refreshed
  • On New Cell When there is a new cell (In order for this event to work, the developer needs to create a custom render)
  • On Item Click When an item in a cell is clicked

You can use JavaScript logic to affect the effects of the control, depending on the event. More information on using these controls can be found in the Event Handling article. 


For detailed information on the available methods for this control, access the JS Doc file.


  • Author: Courtney Silva
  • Date Created: January 20, 2016
  • Date Modified: February 19, 2016
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request