Cisco Cisco Unified Customer Voice Portal 11.0(1) Release Note
C
HAPTER
13:
L
OGGERS
P
ROGRAMMING
G
UIDE FOR
C
ISCO
U
NIFIED
CVP
VXML
S
ERVER
AND
C
ISCO
U
NIFIED
C
ALL
S
TUDIO
R
ELEASE
7.0(1)
75
Chapter 13: Loggers
The mechanism used by VXML Server to record information about global administrations,
errors caused by sub-systems, activities taken by callers to deployed applications or
administrators is by using loggers. Loggers collect this information and can do any number of
tasks with it, from aggregating it for reporting purposes, to sending that information to external
systems for managing, to simply storing the information in log files. A developer can produce a
logger to supplement or replace the functionality the loggers included with VXML Server
provide. Due to the complexity of integrating with VXML Server, loggers can be built only by
using the Java API.
errors caused by sub-systems, activities taken by callers to deployed applications or
administrators is by using loggers. Loggers collect this information and can do any number of
tasks with it, from aggregating it for reporting purposes, to sending that information to external
systems for managing, to simply storing the information in log files. A developer can produce a
logger to supplement or replace the functionality the loggers included with VXML Server
provide. Due to the complexity of integrating with VXML Server, loggers can be built only by
using the Java API.
This chapter describes in detail how to create custom loggers and integrate them with VXML
Server. For more detail on the loggers included with VXML Server , refer to the User Guide for
Cisco Unified CVP VXML Server and Cisco Unified Call Studio Chapter 5: VXML Server
Logging.
Server. For more detail on the loggers included with VXML Server , refer to the User Guide for
Cisco Unified CVP VXML Server and Cisco Unified Call Studio Chapter 5: VXML Server
Logging.
VXML Server Logging Design
Before discussing the design of an individual logger, it is warranted to introduce the design of
the logging mechanism within VXML Server. Knowledge of this design will help the logger
developer create loggers that work harmoniously with the system.
the logging mechanism within VXML Server. Knowledge of this design will help the logger
developer create loggers that work harmoniously with the system.
Logger Events
The mechanism by which information is passed to a logger is through an event object. This
object will encapsulate information about what just occurred, including a timestamp. Event
objects are created by VXML Server in many different situations that belong to three levels:
related to global activities, related to an application and related to a call session. The event object
will contain all the information accessible to the logger for the particular event as well as
information about the environment. For global level events, the environment varies. For some
events the environment consists of HTTP information about the request such as parameters and
headers. Other events were activated internally and so do not define any environment
information. For application-level events such as an administration event, the environment
consists of application data and global data (not call data since this event is not affiliated with a
call). For call-level events such as a call start event, the environment consists of information
about the call such as the ANI, element and session data, default audio path, etc. Since the
purpose of a logger is to report information, loggers are limited to obtaining environment
information and cannot change any value. Loggers may still need to store session-related
information for its purposes so to accommodate this VXML Server provides loggers “scratch”
data that is stored in the session and will be available to the logger only for those events
associated with the session.
object will encapsulate information about what just occurred, including a timestamp. Event
objects are created by VXML Server in many different situations that belong to three levels:
related to global activities, related to an application and related to a call session. The event object
will contain all the information accessible to the logger for the particular event as well as
information about the environment. For global level events, the environment varies. For some
events the environment consists of HTTP information about the request such as parameters and
headers. Other events were activated internally and so do not define any environment
information. For application-level events such as an administration event, the environment
consists of application data and global data (not call data since this event is not affiliated with a
call). For call-level events such as a call start event, the environment consists of information
about the call such as the ANI, element and session data, default audio path, etc. Since the
purpose of a logger is to report information, loggers are limited to obtaining environment
information and cannot change any value. Loggers may still need to store session-related
information for its purposes so to accommodate this VXML Server provides loggers “scratch”
data that is stored in the session and will be available to the logger only for those events
associated with the session.
Figure 13-1Error! Reference source not found. shows the class hierarchy for all events both
global and application:
global and application: