Siebel Business Process Designer Administration Guide for Financial Services > Predefined Business Services > Predefined Business Services >

Configuring Event-based Commands

The Data Transfer Utilities business service allows you to configure toolbar and menu commands based on Siebel Event Manager.

To configure event-based commands

  1. Define a command in Siebel Tools. Business Service ="FINS Data Transfer Utilities". Method = "FAFireEventxxx". The method name can be anything that begins with "FAFireEvent".
  2. Define a toolbar.
  3. Define a toolbar item for the command you defined.
  4. In the Siebel client, navigate to Site Map >Business Process Administration >Workflow Process, and then create a new workflow. The table below lists the entries you should make to configure the Start step for the workflow.

Field
Entry
Event Object Type
BusComp
Event
InvokeMethod
Event Object
The name of the business component in which the event is invoked. For a toolbar command, this is the primary business component in the view in which the command is invoked.
Sub Event
EventMethodxxx. Choose the same value for xxx that you chose for FAFireEvent.
Event Cancel Flag
Yes.

  1. Define a Mock Event Sink step. For more information, see Mock Event Sink.
  2. Define the remaining workflow.
  3. Define command visibility. In Siebel Tools navigate to Business Services >FINS Data Transfer Utilities. Define a user property in which Name = MethodName GotoView, and Value = The name of a view. MethodName is the name of the command method. When you define this user property, this method is enabled only for users who have visibility to the view defined in the value. If the method does not contain a GotoView, visibility is not imposed on the method.

Mock Event Sink

When a command is invoked from a toolbar button or menu, the Data Transfer Utilities business service invokes the method "EventMethodxxx" on the primary business component of the active view. To allow the invocation to be captured by Siebel Event Manager, the primary business component should be derived from CSSBCBase.

When the view is changed, Siebel framework polls each command for the application-level toolbar buttons and application menu to determine whether the button or menu items should be made read-only.

Data Transfer Utilities determines at runtime whether a "FAFireEventxxx" method should be disabled or not by initializing Mock Event Mode. It sets up a global mock event flag within the client's object manager. It then invokes "EventMethodxxx" on the primary business component of the active view. If this "EventMethodxxx" is finally captured by a Mock Event Sink, a global response flag is set. When the Data Transfer Utilities finds out the response flag is set by a mock event sink, it enables the "FAFireEventxxx" method for that particular view. Otherwise, the method is disabled.

Mock Event Sinks are specialized business service methods that capture mock events. They check whether the client's OM is in the mock event mode. If not, they do nothing. If so, they reply to the mock event by setting the response flag as well as the output argument.

MockMethodReplied = `Y'.

TryMockMethod in Data Transfer Utilities is a mock event sink. DataTransfer method has a built-in mock event sink.

Toolbar Button

For information about configuring a toolbar button, see Release Notes.

If the toolbar button is mapped to a workflow, the last step before the End step in the workflow should contain a GoToView function, which can be implemented by either the DataTransfer Method in Data Transfer Utilities or the User Interact business service. If staying in the same view is desired, specify the target view name as the active view name. The purpose of the GoToView function is to force the user interface to refresh.


 Siebel Business Process Designer Administration Guide for Financial Services 
 Published: 22 May 2003