Bookshelf v7.5: Event Handler Parameters

Table 13 describes the parameters available in event handlers in the communications configuration data. A dash (—) in the Macro column indicates that macro expansion is not applicable for the parameter. Y indicates that macro expansion applies to the parameter.

Table 13. Event Handler Parameters
Parameter	Type	Macro	Description
DeviceEvent	Char	—	Communications device-generated event name. For possible values, see the events table for the relevant driver in Using Siebel CTI Connect. Note: This parameter should not be specified as an event handler parameter. Rather, the device event for the event handler should be specified directly, using the Communications Administration screen. This parameter is used in .def files that you export to or import from.
Filter	Group	—	Event data-field filter. This works like a standard IsLike() function. All filter results are logically joined by AND to determine if the event matches this event handler. You can filter data received from the communications driver, data attached to the work item by the channel manager, or data attached or modified by an agent who previously handled the work item—such as a transferring agent. The Filter and FilterSpec parameters can be used together to evaluate event data-field data received with the device event associated with this event handler. Evaluations using the Filter parameter (AND conditions) occur before evaluations using the FilterSpec parameter (compound predicate). For information on fields available for filtering, see the event data fields table for the relevant driver in Using Siebel CTI Connect.
FilterSpec	Char	Y	Event data-field filter that supports simple or complex queries. Filter results are evaluated using a compound predicate that can include standard query operators to determine if the event handler matches the event. FilterSpec queries use standard comparison operators, including: = LIKE AND OR EXISTS > < >= <= For example: FilterSpec="[attr1] IS NOT NULL OR [attr2] LIKE 'value'" where attr1* and attr2 are event data fields and value represents part of a comparison value for attr2. In this example, the event handler is evaluated for a match if attr1 is not empty or if attr2 is like the value of "value*". Here is another example: FilterSpec="[@UserName]='SADMIN'" In this example, @UserName is macro-expanded before the query is performed. The Filter and FilterSpec parameters can be used together to evaluate event data-field data received with the device event associated with this event handler. Evaluations using the Filter parameter (AND conditions) occur before evaluations using the FilterSpec parameter (compound predicate). See also the descriptions for the Filter event handler parameter and the QuerySpec event response parameter.
Order	Numeric	—	The order in which event handlers for which the same device event is specified will be tested against event matching. Each received communications event is checked against all event handlers to determine which response to execute. Event handlers with a lower Order value will be checked before those with higher values. The default is 0. The check stops once there is a match. Note: This parameter should not be specified as an event handler parameter. Rather, the order for the event handler should be specified directly, using the Communications Administration screen. This parameter is used in .def files that you export to or import from.
Profile	Char	—	Name of the communications driver profile that generates the device event associated with this event handler. If a profile is associated with the event handler, then the event handler is evaluated only for events received from the communications driver for that profile. See also Creating Event Handlers. Note: This parameter should not be specified as an event handler parameter. Rather, the profile for the event handler should be specified directly, using the Communications Administration screen. This parameter is used in .def files that you export to or import from.
Response	Char	—	Name of the event response that will be executed when a matching event is detected. Note: This parameter should not be specified as an event handler parameter. Rather, the event response for the event handler should be specified directly, using the Communications Administration screen. This parameter is used in .def files that you export to or import from.
ServiceMethod	Char	—	The name of a Siebel business service and method to be called in order to evaluate the event handler for a match. You can use the ServiceMethod and ServiceParam parameters to supplement or replace filter mechanisms using the Filter or FilterSpec parameters. You can also use this method to execute custom code before executing a specified event response. The business method should set a parameter of Result to a value 1 or 0 (or TRUE or FALSE): 1 (TRUE) indicates that this event handler matches and should be executed, and the associated event response should be executed. 0 (FALSE) invalidates this event handler; the next event handler will then be evaluated. The service and method are specified in the form service.method. Optionally, you can use the ServiceParam parameter to provide parameter names and values to pass to the method to be called. For more information, see Using Business Services with Communications Server.
ServiceParam	Group	Y	A group of subparameters that are parameters to the Siebel business service method (if any) invoked using the ServiceMethod parameter. You create each parameter you need in the form ServiceParam.param_name, then specify a parameter value. The parameter name and value are both passed to the service method. Parameters should be ordered in the sequence in which they are expected by the service method. ServiceParam.Param1="value1" ServiceParam.Param2="name" Param1 and Param2 are subparameters of the ServiceParam parameter. For more information, see Using Business Services with Communications Server.