overrideFilterOnLoad

This method is called once while initializing the list and provides a means for modifying the refinement filter initially applied to a work item, process instance, or event list. The filter can be modified by the user using the Filter tool on the list.

To prevent users from modifying the refinement filter, remove access to "Filter" in userAccess.xml.

Syntax

classProto.overrideFilterOnLoad = function(oValue, oContext)

Parameters

  • oValue - (Object) An object containing the following properties, defining the base filter:
    • oValue.filter - (string) The filter expression to initially apply to the view. For information about viewing filter expressions on the Filter dialog in a WCC application, see Callout Utilities. For additional details about filter expressions, see the “SortingLists" and "Filtering Lists” topics in the TIBCO ActiveMatrix BPM Developer’s Guide.
    • oValue.filterXML - (string) The XML that is used to graphically depict the filter expression in the Filter dialog. This XML string is obtained using the Export Filter XML tool on the Filter dialog in a WCC application (see Callout Utilities).
    • oValue.userChanged - (boolean read-only) A flag indicating whether or not the user has ever modified the value, facilitating logic related to default values. This value is null if it is unknown whether the user has changed the value because the view was created prior to implementation of the callout interface.
  • oContext - (Object) An object that provides information about the list being modified with the following properties:
    • oContext.userName - (string read-only) The name of the logged-in user.
    • oContext.userGuid - (string read-only) A unique identifier for the logged-in user.
    • oContext.viewType - (string read-only) The view type of the list. The possible values are:
      • com.tibco.wcc.base.ListContainer.WORKVIEW (Work View)
      • com.tibco.wcc.base.ListContainer.PTVIEW (Process View)
      • com.tibco.wcc.base.ListContainer.EVENTVIEW (Event View)
    • oContext.viewName - (string read-only) The name of the view that created the list.
    • oContext.viewDescription - (string read-only) A description of the view.
    • oContext.isSystemView - (boolean read-only) True if the view is a system view; False if the view is a user-defined view.

Returns

The modified oValue object, or null if no changes are to be made.