ServiceCall

Service call

Invokes a service that can be triggered by an On load event handler or programmatically.

Appearance

Busy indicator: Busy icon to show while the service call is executing.
{None | Spinner | Refresh | Cog} ServiceIndicatorType

Behavior

Called service: The service that runs when this view executes. Takes in the Input Value as an argument for the service, and outputs the result as the bound data of this view.

Input value: The value used as input to the service. If this value changes, the service is automatically invoked with the updated input. ANY

Auto run: Run on start and whenever input data changes Boolean

Formula

Input value formula: String

Events

On Load:

Description: Triggers whenever the view is loaded.

Example:

me.execute(${Data1}.getValue())

On Invoked:

Description: Fires when service is invoked.

Example:

${SvcButton}.setEnabled(false);

On Before Result:

Description: Fires when the service returns a result and prior to the result being processed to allow for data augmentation.

Example:

alert("Service call returned: " + data.results);

On Result:

Description: Fires when the service returns a result.

Example:

alert("Service call returned: " + result);

On Error:

Description: Triggers when an error is returned from the service. To return an error, an AjaxError object should be used as an output variable inside the service. This can be used in conjunction with an Error Intermediate Event to catch any errors (and set the AjaxError object accordingly).

Example:

alert("Service error: " + error.errorText);

Extends:

com.ibm.bpm.coach.CoachView

Methods:

execute(input)

Executes the attached AJAX service

Name Type Default Description

input {ANY} Input data for the AJAX service (type will depend on the binding type of the AJAX service)

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getInputData() Returns: {ANY}

Returns the input for this service

getLastError() Returns: {ServiceError}

Get most recent error thrown

getResult() Returns: {ANY}

Returns the result from the attached AJAX service

isAutoRun() Returns: {boolean}

Returns the indicator for Auto Run

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

setAutoRun(flag)

Specifies whether this service runs automatically on load and whenever the input value is updated

Name Type Default Description

flag {boolean} Set to true to enable autorun for the service

setInputData(data)

Specifies the default input for this service

Name Type Default Description

data {*} the input data

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

visible {boolean} Label visibility flag (true to show view label, false to hide)

Example

MyView.setLabelVisible(false);

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers