Class: ServiceUIFrame

ServiceUIFrame

A ServiceUIFrame control provides the following configuration properties in Process Designer:
Appearance
Style of Content:
Css file: (e.g. PortalCss.css) string
Css type: {Web | External | Server | Design} string
App acronym: (e.g. AGT) string
Width: (e.g. 50px) string
Height: (e.g. 500px) string
Behavior
Navigate On Task Closed: {True | False} boolean
Events
On Load:
Description: This event is triggered when the control is loaded.
Example:
On Service Open:
Description: This event is triggered when a service is opened.
Example:
On Service Closed:
Description: This event is triggered when a service is closed.
Example:
On Service Unavailable:
Description: This event is triggered when a service is unavailable.
Example:
On Status Changed:
Description: This event is triggered when a service is changed.
Example:

new ServiceUIFrame()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

Gets the service information
Gets the title of the frame
Returns:
Type Description
boolean
Returns the type
Returns:
Type Description
string

getType(taskSpec, serviceName, branchId)

Loads the service
Name Type Description
taskSpec string
serviceName string
branchId integer the id of the vranch
Checks whether the disposition is open
Returns:
Type Description
boolean

loadService(taskSpec, serviceName, branchId)

Loads the service
Name Type Description
taskSpec string
serviceName string
branchId integer optional the id of the branch
Example
${ServiceUI}.loadService(service.acronym, service.name); //this would be run from the On Item Click event of a ServiceList control
Resets the control

setContentStyle(cssFile, type, appAcronym)

set the content style of the UI Frame
Name Type Description
cssFile string the name of the CSS file
type string Web | External | Server | Design
appAcronym string the acronym of the style