Custom application activity reports

Last Updated : Jan 24, 2017 |
Prolog information
Metadata
Keywords:
You can create custom application reports using the data stored in the vpapplog table of the PostgreSQL VoicePortal database. Experience Portal applications are designed to write log entries during their execution, much as other software applications do. Those log entries are composed of standard fields, some of which allow free-form string expressions. The occurrence and content of log entries is therefore subject to the design of the application. For each log entry, there is one row in the table. The columns of each row correspond to the standard fields. Rows are created after the controlling session completes and the data is pushed from the application server to a database updating web service on the EPM. Rows are deleted according to an administrable data retention limit.
This comprises of a collection of 5 columns:
Primary Key column
Name
VPID
SessionID
MsgTimestamp
SessionIndex
Logtype
Columns
Column
Data Type
Description
ActivityDuration
INTEGER
The number of seconds that have elapsed since the start of the activity.
The start time for an activity is the time at which a record with ActivityName <name> and LogType Start is logged.
ActivityName
VARCHAR (1024)
Application generated value used to group report or log entries.
For example, "Buy Ticket" or "Rent Car".
ApplicationID
VARCHAR (512)
<Application Name> where entry was logged.
AppServerAddress
VARCHAR (512)
Host name or IP address of the application server where the application was initially invoked.
InsertID
BIGSERIAL, NUMBER(20,0) BIGINT_ IDENTITY, BIGINT UNSIGNED
Unique sequence number which is automatically incremented by the database for each row that is inserted into the table. This field exists to permit easy access by extract, transform, and load (ETL) processes that are used by other Avaya products such as Avaya IQ.
LogLevel
VARCHAR (512)
Application specified level of log entry "Info", "Warning", "Error", "Fatal".
LogTimestamp
TIMESTAMP (62)
Date and time the log entry was generated in the time zone of the EPM.
LogType
VARCHAR (512)
Type of log (generated by application). The possible values are:
  • Start: Beginning of an activity.
  • End: End of an activity.
  • In Progress: General log entry.
  • Cancel: Canceling of an activity.
  • Cancel All: Cancel all started activities in session.
  • Node Entry: Generated automatically by the DD framework if the collection of ‘Call Flow Data’ is enabled when the application is configured on the EPM. The node that is being entered (destination node) is listed in the ModuleIDNodeID field. The previous node (Exit node or Source node) is listed in the Message field.
  • Module Exit: Generated automatically by the DD framework if the collection of ‘Call Flow Data’ is enabled when the application is configured on the EPM. The module name that is exiting is listed in the ModuleIDNodeID field.
  • Application Exit: Generated automatically by the DD framework if the collection of ‘Call Flow Data’ is enabled when the application is configured on the EPM.
Message
VARCHAR (1024)
Application-defined, free-format text.
ModuleIDNodeID
VARCHAR
The node name that is being entered when LogType is Node Entry.
The module and node identifiers in the format [Module Id]:Node Id, where Module Id is only specified if it is not the same as the application name.
For example, if the application name is CollectTicketInfo and it contains the CollectTicketInfo module with the node StartTicket and the GetPayment module with the node StartPay, you would specify them as :StartTicket and GetPayment:StartPay.
MsgTimestamp
TIMESTAMP
Date and time the log entry was generated in GMT time zone.
NoInputCount
INTEGER
The number of times that no input was received prior to entering this node. This field is only populated for LogType of Node Entry and only when the previous node was a menu.
NoMatchCount
INTEGER
The number of times that no match events occurred prior to entering this node. This field is only populated for LogType of Node Entry and only when the previous node was a menu.
RecConf
INTEGER
The confidence reported by the speech recognition engine. This field is only populated for LogType of Node Entry and only when the previous node was a menu. Values will range from 0 to 99.
SessionID
VARCHAR (512)
Session ID generated by the media server.
SessionIndex
INTEGER
This log entry’s position within the session, where 1 indicated the first log entry, 2 indicates the second log entry, and so on.
SessionLabel
VARCHAR (1024)
A unique identifier set by the application designer.
Note:
An application designer can change the session label at any point while processing a single call. This field shows the label that was in effect when the log entry was made.
VarName
VARCHAR (1024)
A user-defined Dialog Designer application variable associated with this log entry by the application designer.
VarValue
VARCHAR (1024)
Value of variable defined in the column VarName when the log entry was made.
VPID
INTEGER
Identifies the EP system within a cluster of multiple EP systems that merge their data into the same external database.
If there is only one EP system at your installation, this field will always be 1.