DeviceEvent

Char

Not applicable

Communications device-generated event name.

Device commands that are recognized by the communications driver are specific to particular communications systems. Possible values include the device events supported by your communications driver.

For information about the events supported by the Virtual CTI driver, see Virtual CTI Driver Events.

NOTE:  Do not specify this parameter as an event handler parameter. Rather, specify the device event for the event handler directly, using the Administration - Communications screen. This parameter is used in DEF files that you export to or import from.

Filter

Group

Not applicable

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).

The fields available for filtering depend on the communications driver you are using.

FilterSpec

Char

Yes

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).

For more information, see the descriptions for the Filter event handler parameter and the QuerySpec event response parameter.

Order

Numeric

Not applicable

The order in which event handlers (for which the same device event is specified) are 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 are checked before those with higher values. The default is 0. The check stops when there is a match.

NOTE:  Do not specify this parameter as an event handler parameter. Rather, specify the order for the event handler directly, using the Administration - Communications screen. This parameter is used in DEF files that you export to or import from.

Profile

Char

Not applicable

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. For more information, see Creating Event Handlers.

NOTE:  Do not specify this parameter as an event handler parameter. Rather, specify the profile for the event handler directly, using the Administration - Communications screen. This parameter is used in DEF files that you export to or import from.

Response

Char

Not applicable

Name of the event response that executes when a matching event is detected.

NOTE:  Do not specify this parameter as an event handler parameter. Rather, specify the event response for the event handler directly, using the Administration - Communications screen. This parameter is used in DEF files that you export to or import from.

ServiceMethod

Char

Not applicable

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 must set a parameter of Result to a value 1 or 0 (or True or False):

• 1 (True) indicates that this event handler matches and is executed, and the associated event response is executed.
• 0 (False) invalidates this event handler; the next event handler is evaluated.

Specify the service and method 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 Siebel Communications Server.

ServiceParam

Group

Yes

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. Order parameters 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 Siebel Communications Server.