Supported Custom Interfaces

This topic describes the types of custom interfaces that are supported.

They are:

  • Simple iFrame - This type of custom interface is simply an iFrame embedded in Workspace, or a browser window, and displays a source URL specified in customInterfaces.xml. The URL is automatically loaded and the interface displays at a specified location when the launch component is executed.
  • Simple Managed Hub iFrame - This custom interface is a TIBCO PageBus Managed Hub iFrame embedded in Workspace, or a browser window, and opens a web application at the URL specified in customInterfaces.xml. A managed Hub iFrame has the capability to communicate with WCC components and other web applications via secure PageBus events. The URL, of the web application, is automatically loaded and the interface displays at a specified location when the launch component is executed.
  • Simple Prototype - This custom interface consists of a TIBCO General Interface prototype containing user interface components. Custom JavaScript may be added to the Workspace application to handle events generated by the prototype components. The prototype is automatically loaded into a specified location when the launch component is executed.
  • Scripted Interface - This custom interface is determined by a custom JavaScript method that is automatically invoked when the launch component is executed. The type, functionality, and location of the custom interface is managed by custom JavaScript. Helper methods are provided to use with this custom interface type; see Custom Interface Helper Methods.

During Workspace application initialization, the contents of customInterfaces.xml are extracted and the launch component, for each custom interface, is placed at the specified location within the Workspace layout along with the associated text and image definition. The execute event, of the launch component, is set to either automatically load the source of the interface (for the "simple" interfaces), or to call a JavaScript method that performs the function of launching the custom interface (for the "scripted" interface).

If the Workspace Configuration Administrator is used to define custom interfaces in customInterfaces.xml, associated user access elements are automatically added to userAccess.xml to define which users in the organization have access to the launch component for each interface. For more information, see User Access Elements for Custom Interfaces.