reportBatch method for application logging

Last Updated : Mar 06, 2019 |
Prolog information
Metadata
Keywords:
The reportBatch method can be used to create application or call flow data log entries in the Experience Portal report database. In either case, the list of input parameters is the same. The only difference is the information you specify for each input parameter.
This topic discusses the information you should specify to create an application log entry. For information about creating a call flow data log entry, see reportBatch method for call flow data.

Parameters

Parameter
Type
Description
appServerAddress
string
The hostname or IP address of the application server.
applicationID
string
The name of the application. For example: CollectTicketInfo
Important:
The applicationID must match the name that was specified when the application was added to Avaya Experience Portal through the EPM.
For an application that is assigned to a non-default zone, include the zone information using the format: ZoneId:applicationName
You can view all application names on the Applications page.
You can retrieve the zone Id information using the getZoneInfo method of the Management Interface web service.
level
string
The logging level.
The options are:
  • Fatal
  • Error
  • Warning
  • Info
reason
string
The reason this log entry was made. For example: Application ended successfully.
The reason for the first log entry in a session block should always be "-" (dash).
sessionID
string
The session ID for the session.
This is a user-defined identifier that should be unique across sessions.
timestamp
string
The current system time in milliseconds since January 1, 1970 00:00:00 UTC. The value of this parameter should contain a long number.
transactionName
string
The transaction name that this log entry is a part of. For example: Hung Up
Important:
Every transaction should start with a log entry setting the transaction name along with the activity type of Start. Once you start a transaction, all log entries should use the same transaction name up to and including the final log entry for that transaction.
type
string
The activity type for this log.
The options are:
  • Start
  • In Progress
  • End
  • Cancel
userLog
string
The session label.
varName
string
A variable name, if one should be included with this log entry.
varValue
string
The value of the variable named in varName.
activityDuration
integer
The duration in seconds between the timestamp of the first log entry with the same transaction name and the activity type of Start and this log entry in a single session block.
Note:
This calculation should be based on one block of log entries that belong in one session.
moduleIdNodeId
string
The module ID and node ID 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
  • GetPayment:StartPay

Return values

The reportBatch method returns one of the following values:
  • success
  • decryption failed - error occured decrypting the password
  • Password incorrect
  • Request is out of date
  • Error storing data in database
  • Error initializing database
  • Error getting the EPID
If the method fails, you can use the logFailed method to enter an event into the Experience Portal event log.