Instance Search List

The Instance Search List control displays a Saved Search (Organized by Process Instance) which has been previously created.  The saved search to be displayed is specified by the Default Saved Search name configuration option in the Query group.  It comes with many easy to configure behavior, columns, query, performance, appearance, client-side searching, client-side sorting, and client-side paging options.  

See the IBM Knowledge Center article Creating and maintaining saved searches for Process Portal for more information on creating saved searches.

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 Show the footer of the table. Must be enabled to view table stats

Show Table Stats Show table stats (i.e. how many entries are currently displayed out of how many total). Must have table footers enabled.


Note that the columns that are to be displayed are determined by the defined saved search.  This section describes how those columns will be formatted.

Columns The format for the columns displayed

     Type Show what data is displayed, e.g. BPD Name, Instance Name, Instance                    ID, 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

     Column Label Specify the name of the column

     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

Only Show Configured Columns Indicates that only those columns specified with be shown, other columns defined in the saved search will be hidden


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

Default Saved Search Name Default saved search to load (this field is required)

Start Empty Leave the table empty on initial load, entries can be shown using the refresh method

Condition A query table condition language expression (WHERE clause) that performs additional filtering on the result set. All attributes defined on the query can be referenced. E.g. PI_STATUS = 'Active' AND PRIORITY > 10

Available Query Attributes

Sort By Comma-separated list of sort criteria applied to the list of returned process instance entities. Each list entry has the form attribute [ASC|DESC] where ascending is the default. The attributes TAD_DESCRIPTION, STATE and KIND cannot be used within sort criteria. E.g. PRIORITY ASC, STATUS DESC

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 Select to load entries in batches

Async Batch Size Number of entries to load at a time when Async Loading is used


Color Style 

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

Width Width of the table, e.g. 500px, 80%, 20em, etc.

Height Height of the table, e.g. 500px, 20em, etc.

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


A Saved Search has already been created in the Process Admin Console.


These are the configuration option settings...

This is the result...


With the Instance Search 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 Search List control is refreshed
  • On New Cell When a custom rendered cell or a clickable cell is created, this method is called.  Parameters are table, and cell.  Note that in most instances the clickable cells require further processing.
  • On Item Click When an item in a cell is clicked.  Parameters are table, and cell.

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: February 25, 2016
  • Date Modified: March 3, 2016
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request