WCC Public Methods

Public methods are provided that allow you to add custom business logic, as well as programmatically perform functions that are normally performed by WCC components, for example, opening a work item, cancelling a process instance, etc.

For information about the classes that are created (that provide access to the public methods), when you develop a custom WCC application, see Application Template.

Note that all files under the following directories are considered to be TIBCO's private implementation of WCC components and should not be modified: 

JSXAPPS\base
JSXAPPS\components
Note: There are some exceptions to this rule for the \JSXAPPS\base directory: you are allowed to modify the files in the \JSXAPPS\base\locale\eventRoles directory (see the "Configuring Events" topic in the TIBCO Workspace Configuration and Customization guide), and in the \JSXAPPS\base\jss\workspaceCSS.xml file (see the "Customizations" topic in the TIBCO Workspace Configuration and Customization guide), as well as in the \JSXAPPS\base\locale\locale.xml file (to localize strings displayed in the application).

Only files under the following directory should be modified: 

JSXAPPS\wccApp

where wccApp is the name of the custom WCC application (which is “workspace” if you are using the Workspace application).

The following comprise the public methods that can be used in custom WCC applications:

  • Override methods - These methods, which provide entry points into your WCC application for custom code, are located in the main Application class (Application.js) for your custom WCC application.

    For details about the available override methods, see Override Methods.

  • Application class methods - These methods can be called from your custom application to perform various functions like getting the application block, adding an entry to the application log, etc. They also provide the means to perform functions normally performed by WCC components, such as logging in, opening a work item, etc.

    For details about the available Application class methods, see Application Class Methods.

  • Mixin interface methods - The mixin interface (AppMain.js) is implemented by the Application class for your custom application. It contains samples of how custom methods can be added. Plus, it provides a container for other custom code you want to add.

    For details about the method examples in the mixin interface, see Mixin Interface Methods.

  • Component public methods - A number of the WCC components contain public methods that allow you to perform functions specific to that component. For instance, the WorkItemsPreview component contains public methods that allows you to hide or show text in the caption bar of the WorkItemsPreview component.

    These methods must be called from their respective component instance (e.g., com.tibco.wcc.components.WorkItemsPreview).

    For details about the component public methods, see Component Public Methods.

  • Prototype Public Methods - The com.tibco.wcc.components.Prototype class contains a single public method, getVersion.

    For information, see Prototype Public Methods.

  • Server Requests - An API is available that allows you to make direct calls to the server to perform tasks such as listing work items, allocating work items, suspending process instances, etc.

    For information, see Server Requests.

  • Callout Interface Methods - The methods in the callout interface can be used to specify filter expressions, sort parameters, available filter attributes, available sort attributes, and display columns for various lists in WCC applications (including the Workspace application).

    For information, see Callout Interface Methods.