Reports

Mailbox Administration can generate any of several reports relating to mailboxes in general, guest room mailboxes specifically, and the emergency alert feature. Each report is generated as an HTML web page and displayed in the system's default browser.

These report options are accessed from the Reports menu, as shown below:

The table below summarizes the reports currently available. They are described more thoroughly in the sections that follow.

ReportMenu OptionDescription
Emergency AlertEmergency AlertLists each occurrence of someone dialing an emergency number.
Line ActivityActivity / LineLists usage statistics for all voice lines, over a specified date range.
Mailbox ActivityActivity / Mailbox -or-
Mailbox / Activity
Details all mailbox-related activity for either a single mailbox or for all mailboxes, over a specified date range.
Mailbox DirectoryMailbox / DirectoryLists directory information for all mailboxes.
Mailbox StatisticsMailbox / StatsLists mailbox statistics for all mailboxes.
Occupied RoomsGuest Rooms / OccupiedLists basic information for all checked-in guest room mailboxes.
PMS ActivityPMS ActivityLists all PMS Link activity over a specified date range. Same data as displayed by PMS Monitor in real-time.
Room StatusGuest Rooms / StatusLists basic status information for all guest room mailboxes.
System EventsSystem EventsLists service-related activity, such as services starting or shutting down, maintenance activity, and so forth, over a specified date range.
Vacant RoomsGuest Rooms / VacantLists basic information for all checked-out guest room mailboxes.

Additional hospitality-focused reports, such as those related to wakeup call activity, are available within the InnDesk web application.

This report provides details for each occurrence of someone dialing an emergency number (as configured for the Emergency Alert feature).

The report contains the following data:

ColumnDescription
Date/TimeDate and time alert was posted. Format is YYYY/MM/DD HH:MM:SS
CallerThe extension that dialed an emergency number.
CalledThe emergency number that was dialed.
TypeType of alert. Voice for a voice message or Email for an email message.
MailboxMailbox associated with the caller.
NameGuest or subscriber name associated with the caller's mailbox at the time of the alert.
PBXThe PBX that the alert was detected on. Will show optional name and IP address.
DetailsInformation about the alert and who it was sent to.

This report provides usage statistics for the voice lines.

The report contains the following data:

ColumnDescription
LineLine number.
InboundNumber of inbound calls received on the port during the selected time period.
OutboundNumber of outbound calls made on the port during the selected time period.
WakeupNumber of wakeup calls performed on the port during the selected time period.
MWINumber of MWI notifications performed on the port during the selected time period.
LoginNumber of subscriber logins performed on the port during the selected time period.
% Inbound BusyPercentage of time the port was busy with inbound calls during the selected time period.
% Outbound BusyPercentage of time the port was busy with outbound calls during the selected time period.
Inbound MinutesThe total number of minutes the port was busy with inbound calls during the selected time period.
Outbound MinutesThe total number of minutes the port was busy with outbound calls during the selected time period.
Total CallsThe total number of calls processed on the port during the selected time period (including both inbound and outbound calls.

This report lists basic information (guest name, maid status, room state, VIP status and description) for all guest mailboxes.

This report contains the following data:

ColumnDescription
RoomMailbox number.
FirstGuest first name.
LastGuest last name.
Maid StatusHousekeeping / room clean status, if known.
StateRoom status. Occupied if checked-in; otherwise, Vacant.
VIPVIP status. Yes if enabled; otherwise, No.
DescriptionThe mailbox description field.

This report lists basic information (guest name, maid status, VIP status and description) for all occupied (checked in) mailboxes.

This report contains the following data:

ColumnDescription
RoomMailbox number.
FirstGuest first name.
LastGuest last name.
Maid StatusHousekeeping / room clean status, if known.
VIPVIP status. Yes if enabled; otherwise, No.
DescriptionThe mailbox description field.

This report lists basic information (guest name, maid status and description) for all vacant (checked out) mailboxes.

This report contains the following data:

ColumnDescription
RoomMailbox number.
FirstGuest first name.
LastGuest last name.
Maid StatusHousekeeping / room clean status, if known.
DescriptionThe mailbox description field.

The mailbox activity report provides information on how mailboxes have been used or modified over a specified period of time, including such things as login/logout, check in/out, maid status updates, MWI activity, and so forth.

When you select Reports | Mailbox | Activity from the menu, the system will first ask you for a mailbox number and date range, using the following dialog:

To view activity for a specific mailbox, enter the number in the box provided. Or leave the box blank to include activity for all mailboxes.

To limit the report to a specific time period, check the Date selection checkbox and then use the State Date and End Date controls to select the start and end dates, respectively. If you leave the Date selection box unchecked, the report will include all data available for the selected mailbox(es).

This report contains the following data:

ColumnDescription
Date/TimeDate and time the log entry was made. Format is YYYY/MM/DD HH:MM:SS.
MailboxMailbox number.
ActivityThe activity the occurred in the mailbox or was performed by or upon the mailbox.
DetailsFurther details about what activity occurred.
MethodGeneral indication of how the action occurred.
ResultIndicates success or failure of activity.
UsernameIf the activity came from InnDesk, this column shows the InnDesk username of the account that initiated the activity. Otherwise, it will likely be blank.
LineThe voice line that performed the callout. If the activity is not related to a callout, this will be blank.
Callout NumberThe extension or off-premise phone number that was called. If the activity is not related to a callout, this will be blank.

The remaining columns are primarily included for debugging purposes and are only filled in if the activity deals with a voice message:

ColumnDescription
Msg To/FromFor a message being sent, forwarded or replied to, this will be the recipient mailbox. For a message being received, this will be the sender, if known, or blank otherwise.
Msg Created ByFor future use.
Msg FileThe filename for the actual message recording.
Msg EnvelopeThe filename for the message information file.
Unique IDFor future use.

The mailbox directory report lists just the basic information (extension, name and description) for each mailboxes. All mailboxes are included in the report.

This report contains the following data, for all mailboxes in the system:

ColumnDescription
MailboxMailbox number.
ExtensionExtension number.
FirstSubscriber's first name.
LastSubscriber's last name.
DescriptionMailbox description field.

The Mailbox Statistics report is generated when you select Reports | Mailbox | Stats and is displayed in the system's default web browser. It will look similar to the figure below:

This report contains the following data, for all mailboxes in the system:

FieldDescription
MailboxMailbox number.
FirstSubscriber's first name. Configured on the Owner Settings page.
LastSubscriber's last name. Configured on the Owner Settings page.
DescriptionMailbox description field. Configured on the Owner Settings page.
TypeMailbox type.
New MessagesCurrent number of new messages.
Last LoginDate and time subscriber last logged in. Format is YYYY/MM/DD HH:MM:SS
Last MessageDate and time most recent message was received. Format is YYYY/MM/DD HH:MM:SS
ModifiedDate and time mailbox settings were last modified. Format is YYYY/MM/DD HH:MM:SS
CreatedDate and time mailbox was created. Format is YYYY/MM/DD HH:MM:SS

The PMS Activity report displays all PMS Link activity for a specified date range using the same format as PMS Monitor. To generate the report, select Reports | PMS Activity; this will open the Enter Date Range dialog, shown below.

To view all available link activity, leave the Date selection box unchecked and click OK. Otherwise, check the box and then use the date controls to set the start and end dates, then click OK. The report will be generated and displayed in the system's default web browser. It will look similar to the figure below:

This report contains the following data, for the selected date range:

FieldDescription
Date/TimeThe date and time this entry was logged. The date format by default is MM/DD/YYYY and the time format is HH:MM:SS.msec.
PortThe port number over which the communication took place. COM ports will fall in the range from 1-255, whereas TCP ports are typically above 1024.
DirectionThe direction of the communication, In or Out. In means the message was received from the PMS; Out means it was sent to the PMS.
DataThe raw packet or control byte received, if relevant. For some entries, this may be blank if no actual data was transferred.

Non-printable ASCII characters generally cannot be displayed on-screen by most fonts, so PMS Monitor displays them using a special notation: a two-digit hexadecimal value inside of angle brackets. Any hex value between 0x00 and 0x19, inclusive, will be displayed using this notation.
ResponseThe control character sent back to the PMS in response to a message received, or received from the PMS in response to a message sent. Typically, this will either be <06> (ACK) or <15> (NAK). If the PMS does not respond within the time allowed (typically a few seconds), this field may display something like (timeout) instead.

If the entry is for an event or message where a response is not expected or not relevant, this field will be left blank.
ActionA statement indicating the action taken by the 7.00.

For inbound packets, this will indicate how the 7.00 interpreted and processed the message. For outbound packets, it will typically state what type of message was sent.

For connection events, it will state the IP address of the PMS that has connected. This occurs only if the hospitality server is configured to use a TCP Server connection (where the 7.00 is the server that opens the port and waits for the PMS to connect). There will be a corresponding disconnect entry if the PMS closes the connection.
ResultA statement indicating the success or failure of the action indicated in the Action column, from the perspective of the 7.00.

This report provides details for various service-related events in the system.

The report contains the following data:

ColumnDescription
Time/DateDate and time the event occurred. Format is YYYY/MM/DD HH:MM:SS
TypeThe general type of event, such as: Connected, Disconnected, Restart, Shutdown, Startup, Status.
LevelIndicates the potential seriousness of the event:
  • Information – Normal activity that is of note but not indicative of a problem.
  • Warning – Normal activity that may suggest a configuration issue if the behavior is unexpected.
  • Error – An event that may indicate a significant issue.
SourceDenotes the source of the event. Service indicates the main DuVoice service, Hostel indicates the hospitality server, Maintenance indicates the nightly maintenance routine, and so forth.
SummaryDescriptive summary of the event.
DetailAdditional details; typically blank.
  • Last modified: 2023/01/07 11:45
  • by 127.0.0.1