Siebel Communications Server Administration Guide > Configuring Events and Commands > Event Logs >

Event Log Parameters


Table 16 describes the parameters available in event logs. 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 16.  Event Log Parameters
Parameter
Type
Macro
Description

AfterWork

Group

Y

Field names and values, from the log business component, that will be used to update the work-tracking log record when the work item has ended or been released.

NOTE:  After the work item has been released, the log record that is modified according to the fields specified with this parameter is refreshed when the agent clicks off the record, then clicks on it again.

BusComp

Char

Log business component name.

BusObj

Char

Log business object name.

Display

Boolean

Parameter that, when it is set to TRUE and the current view contains a business component specified in the event log, uses the current business component to add a new log record. The log record appears on the screen immediately, and is selected.

If Display is set to FALSE, the log record is generated but is not selected, and might not be displayed in the current record set. The default is FALSE.

NOTE:  While the work item is active, the agent can modify the log record. After the work item has been released, however, if AfterWork is set, an agent's changes may conflict with how the log record was written by the system at that time. The agent can click off the record, then click on it again in order to modify it.

LogField

Group

Y

Field names and values of the log business component.

QuerySpec

Char

Y

Parameter that can be used to retrieve the desired record in the business component:

  • If QuerySpec is not defined, a new record is created for the event log.
  • If QuerySpec is defined and returns a single record, this record is used for the event log.
  • If QuerySpec is defined and returns more than one record, a new record will be created for the event log.

ServiceMethod

Char

The name of a Siebel business service and method to be called. 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.

If ServiceMethod and ServiceParam are specified, they are executed first when the event log is invoked. If the specified business service method does not return the required result, such as a value of TRUE (1) for the output argument Continue, the event log will stop executing.

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.

WorkTrackingObj

Group

Y

Field name and values of a work-tracking object to create. You can retrieve the value of the tracking object from a command.

For example, the following parameter defines a custom work-tracking object, called "ContactId", whose value is derived from the Id field of the Contact business component.

WorkTrackingObj.ContactId="{Contact.Id}"

For a selected work item, this data could then be accessed from a communications command, using the WorkTrackingObj command data parameter. In this example, ContactId becomes a custom work item attribute.

Alternatively, if an event log includes a parameter definition like the following, then text you specify is displayed in the Work Items list in the communications toolbar.

WorkTrackingObj.Description="your descriptive text goes here"

For more information about using these and other attributes, see Work Item Attributes.

Siebel Communications Server Administration Guide