Avaya PeriReporter Business Communications Manager User Manual

PeriReporter User’s Guide 2.1

Avaya Business Communications Manager Release 6.0

Document Status: Standard Document Number: P0988093 Document Version: 02.12 Date: July 2010

Notices

While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes.

Documentation disclaimer

Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. End User agree to indemnify and hold harmless Avaya, Avaya’s agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User.

Link disclaimer

Avaya is not responsible for the contents or reliability of any linked Web sites referenced within this site or documentation(s) provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages.

Warranty

Avaya provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya’s standard warranty language, as well as information regarding support for this product, while under warranty, is available to Avaya customers and other parties through the Avaya Support Web site: http://www.avaya.com/support

Please note that if you acquired the product from an authorized reseller, the warranty is provided to you by said reseller and not by Avaya.

Licenses

THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, HTTP://SUPPORT.AVAYA.COM/LICENSEINFO/ ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN AVAYA AUTHORIZED RESELLER, AND AVAYA RESERVES THE RIGHT TO T AKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS "YOU" AND "END USER"), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVA YA AFFILIATE ("AVAYA").

Except where expressly stated otherwise, no use should be made of the Documentation(s) and Pr oduct( s) p rovided by Avaya. All content in this documentation(s) and the product(s) pr ov id ed by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected b y copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software. Unauthorized reproduction, transmission, dissemination, storage, and or use without the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law.

Third Party Components

Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms" ). Information regarding distributed Linux OS source code (for those Products that have distributed the Linux OS source code), and identifying the copyright holders of the Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: http://support.avaya.com/Copyright.

Trademarks

The trademarks, logos and service marks ("Marks") displayed in this site, the documentation(s) and product(s) pr ovided by Avaya are the registered or unregistered Marks of Avaya, its affiliates, or other third parties. Users are not permitted to use such Marks without prior written consent from A vaya or such third party which may own the Mark. Nothing contained in this site, the documentation(s) and product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc. All non-Avaya

trademarks are the property of their respective owners.

Downloading documents

For the most current versions of documentation, see the Avaya Support. Web site: http://www.avaya.com/support

Contact Avaya Support

Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The suppo rt telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://

www.avaya.com/support

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Organization of this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Conventions Used in This Manual . . . . . . . . . . . . . . . . . . . . . . . . 10

Solaris and Windows Conventions . . . . . . . . . . . . . . . . . . . . . . . 12

Trademark Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

What is PeriReporter? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Three Components of PeriReporter . . . . . . . . . . . . . . . . . . . . . . . 15

PeriConsolidator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

PeriDefiner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

PeriReporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Sharing Data Between Solaris and Windows . . . . . . . . . . . . . . . 16

Time Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Statistical Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Collection and Maintenance of Statistical Data . . . . . . . . . . . . . . 20

Single vs. Multi-node Environments . . . . . . . . . . . . . . . . . . 21

Defining Stat Events in a Single Node Environment . . . 22

Application Stat Events in a Multi-Node Environment . 23

PeriReporter and the Avaya MPS Network . . . . . . . . . . . . . 25

System and Application Statistics. . . . . . . . . . . . . . . . . . . . . 27

System Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Application Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

The PeriProducer Application . . . . . . . . . . . . . . . . . . . . 34

Gathering Application Statistics (Block Execution Statistics) . .

Defining Application (Block Execution) Statistics . . . . 36

Determining Blocks Associated With a Counter . . . . . . 37

Passing Statistics Folders to a Linked Application . . . . . 37

PeriConsolidator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Data Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

pchistory.log . . . . . . . . . . . 44

Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

PeriReporter’s User Guide P0988093 July 2010

PeriDefiner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Launch PeriDefiner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Launch PeriDefiner through PeriReporter . . . . . . . . . . . 48

PeriDefiner Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Open a Report Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Defining a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Save the Report Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Update the Report Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Lines for Report Title . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Report Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Column Heading Rows . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Rows per Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Rows for Subtotals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Rows for Totals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Report Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Default Detail Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Default Start/End Time . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Define Column Formulas and Mappings . . . . . . . . . . . . . . . 54

Column Formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Data Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Update Individual Columns and Cells . . . . . . . . . . . . . . . . . 58

Display Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Column Appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Define Subtotals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Define Totals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Column Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Column Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Screen Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Fill/Empty Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Print the Report Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

PeriReporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Launch PeriReporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

PeriReporter Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Generating a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Open a Report Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Select a Report Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Start Date and End Date . . . . . . . . . . . . . . . . . . . . . . . . . 78

Start Time and End Time . . . . . . . . . . . . . . . . . . . . . . . . 79

PeriReporter’s User Guide P0988093 July 2010

Override Column Avaya MPS/VPS Numbers . . . . . . . . 79

Avaya MPS/VPS Range . . . . . . . . . . . . . . . . . . . . . . . . . 80

Detail Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

List Files in Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Generate the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Web-Based Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Start Date and End Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Start Time and End Time . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Detail Level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Avaya MPS Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Graph Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Plot Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Bar Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Area Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Candle Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Hilo Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Pie Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Scatter Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Stacking Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Grid Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Columns Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Titles Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Selected Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Screen Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Preview a Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Export/Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Print a Generated Report. . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Other Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Step-by-Step

Sample Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Step-by-Step Sample Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

PeriReporter’s User Guide P0988093 July 2010

Preface

Scope

The PeriReporter User’s Guide provides information for the use of the PeriReporter tool. It gives step-by-step instructions on gathering and displaying data from the Avaya Media Processing Series system.

In addition to this document, the PeriView Reference Manual may be particularly helpful when working with PeriReporter. It describes how to work within PeriView’s Graphical User Interface (GUI) and individually documents each of PeriView’s tools.

Intended Audience

This document is targeted at any PeriView user. That is, any person responsible for using PeriView to interact with the Avaya Media Processing Server (Avaya MPS) Series could use this information. This guide assumes that PeriView users have completed a Periphonics training program conducted as part of the initial system installation.

How to Use This Manual

This manual uses many standard terms relating to computer system and software application functions. However, it contains some terminology that can only be explained in the context of the Avaya MPS system. See the Glossary of Avaya MPS Terminology for definitions of Avaya MPS-specific terms.

Initially, you should read this manual at least once, from start to finish. Later, you can use the Table of Contents to locate topics of interest for reference and review.

If you are reading this document online, use the cross-reference links (shown in blue) to quickly locate related topics. <L with your cursor over the cross-reference link. Click on any point in a Table of Contents entry to move to that topic. Click on the page number of any Index entry to access that topic page.

To familiarize yourself with various specialized textual references within the manual, , see Conventions Used in This Manual on page 10.

Periphonics is part of Avaya. The name Periphonics, and variations thereof, appear in this manual only where it is referred to in a product. (For examples, a PeriProducer application, the PERImps package, the perirev command, etc.)

At certain points in this manual, Avaya MPS is analogous with Voice Processing Series (VPS). This is reflected in specific file names and directories, as well as certain software features.

EFT> click once with your mouse while positioned

PeriReporter’s User Guide P0988093 July 2010

Organization of this Manual

This manual contains separate sections that describe the features and functions of the PeriReporter tool.

• Chapter 1 - Introduction

This chapter discusses the general characteristics of the PeriReporter tool, including function, terminology, and individual components.

• Chapter 2 - Statistical Maintenance

This chapter discusses the differences between single and multi node environments along with System and Application statistics. This chapter further discusses the collection and storage of statistical information for the Avaya MPS system.

• Chapter 3 - PeriConsolidator

This chapter discusses the various ways statistical data is gathered for use by the PeriReporter tool.

• Chapter 4 - PeriDefiner

This chapter discusses how reports are designed for generation at a later time.

• Chapter 5 - PeriReporter

This chapter discusses how reports are generated for specific dates and times.

• Chapter 6 - Step-by-Step Sample Report

This chapter contains a step-by-step construction of a sample report.

PeriReporter’s User Guide P0988093 July 2010

Conventions Used in This Manual

This manual uses different fonts and symbols to differentiate between document elements and types of information. These conventions are summarized in the following table.

Conventions Used in This Manual Sheet 1 of 2

Notation Description

Normal text

important term

system command

command, condition

and alarm

file name / directory

on-screen field

Book Reference

Normal text font is used for most of the document.

The Italics font is used to introduce new terms, to highlight meaningful words or phrases, or to distinguish specific terms from nearby text.

This font indicates a system command and/or its arguments. Such keywords are to be entered exactly as shown (i.e., users are not to fill in their own values).

Command, Condition and Alarm references appear on the screen in magenta text and reference the Command Reference Manual, the PeriProducer User’s Guide, or the Alarm Reference Manual, respectively. See these documents for detailed information about

Commands, Conditions, and Alarms.

This font is used for highlighting the names of disk directories, files, and extensions for file names. It is also used to show displays on text-based screens (e.g., to show the contents of a file.)

This font is used for field labels, on-screen menu buttons, and action buttons.

A term that appears within angled brackets denotes a terminal keyboard key, a telephone keypad button, or a system mouse button.

This font indicates the names of other publications referenced within the document.

cross reference

A cross reference appears on the screen in blue text. Click on the cross reference to access the referenced location. A cross reference that refers to a section name accesses the first page of that section.

The Note icon identifies notes, important facts, and other keys to understanding.

The Caution icon identifies procedures or events that require special attention. The icon indicates a warning that serious problems may arise if the stated instructions are improperly followed.

PeriReporter’s User Guide P0988093 July 2010

Conventions Used in This Manual Sheet 2 of 2

Notation Description

The flying Window icon identifies procedures or events that apply

to the Windows operating system only.

The Solaris icon identifies procedures or events that apply to the

Solaris operating system only.

a. Windows and the flying Window logo are either trademarks or registered trade-

marks of the Microsoft Corporation.

b. Solaris is a trademark or registered trademark of Sun Microsystems, Inc. in the

United States and other countries.

PeriReporter’s User Guide P0988093 July 2010

Solaris and Windows Conventions

This manual depicts examples (command line syntax, configuration files, and screen shots) in Solaris format. In certain instances Windows specific commands, procedures, or screen shots are shown where required. The following table lists examples of general operating system conventions to keep in mind when using this manual with either the Solaris or Windows operating system.

Solaris Windows

Environment $MPSHOME %MPSHOME%

Paths $MPSHOME/common/etc %MPSHOME%\common\etc

Command <command> & start /b <command>

Trademark Conventions

The following trademark information is presented here and applies throughout for third party products discussed within this manual. Trademarking information is not repeated hereafter.

Solaris is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries.

Microsoft, Windows, Internet Explorer, and the Flying Windows logo are either trademarks or registered trademarks of Microsoft Corporation.

Netscape® and Netscape Navigator® are registered trademarks of Netscape Communications Corporation in the United States and other countries. Netscape's logos and Netscape product and service names are also trademarks of Netscape Communications Corporation, which may be registered in other countries.

PeriReporter’s User Guide P0988093 July 2010

Introduction

This chapter covers:

1. What is PeriReporter?

2. Three Components of PeriReporter

3. Sharing Data Between Solaris and Windows

4. Time Zones

What is PeriReporter?

PeriReporter is a PeriView tool, consisting of three subtools - PeriConsolidator, PeriDefiner, and PeriReporter - each contributing to the process of collecting, maintaining, defining, and reporting statistical data for the Avaya Media Processing Server (Avaya MPS) Series network. Using a Graphical User Interface (GUI), it allows a point and click specification of multiple report formats for each statistics record type. A report is viewed as a set of columns, with each column representing an application or system statistics defined counter. There is a row of cells for each time interval recorded in a statistics file.

When the PeriReporter Tools package is installed a .perireporter file is created in the default PeriReporter home directory ($MPSHOME/PERIprpt/prpt). When any changes are made in the Global Settings, Screen Colors, or Print Setup portions of the PeriDefiner or PeriReporter components a new .perireporter file is created in your home directory. These changes are then saved in this new file. The original .perireporter file will remain unchanged. Eliminating the file residing in your home directory will reset all parameters back to their default settings. For additional information on the installation of the PeriReporter Tools package, refer to the Avaya Installing Graphical Tools on a Customer Supplied Workstation (9090504(I)) manual.

In a single node environment, each of PeriView’s tools reside on the Avaya MPS node and all tools will display on the tool bar. In a multi-node environment, PeriView tools reside on each node in the Avaya MPS network, but the PeriReporter tool typically resides only on the node that is designated as the site for statistical collection and reporting. Therefore, in a multi-node environment, the PeriReporter tool will only display on the tool bar at the node(s) at which PeriReporter resides.

For additional information on single node environments, see

Defining Stat Events in a Single Node Environment on page 22.

PeriReporter’s User Guide P0988093 July 2010

Three Components of PeriReporter

PeriReporter consists of three parts, each dependent on previous input for required information.

PeriConsolidator

This program gathers all system and application statistics and consolidates them into 15 minute, hourly, daily, weekly, monthly and yearly files. PeriConsolidator should be configured in the crontab and set to run once a day at a convenient time, preferably when the Avaya MPS system load is relatively light.

For additional information, see the PeriConsolidator chapter.

PeriDefiner

This program is a graphical utility which is used to set up the contents and the display of a specific report. After a report definition is created and saved it can be generated using the PeriReporter tool.

For additional information, see the PeriDefiner chapter.

PeriReporter

This program is a graphical utility which is used to generate reports. The report (created in PeriDefiner) must be specified, along with the date and the consolidation type, after which it can be generated and printed.

For additional information, see the PeriReporter chapter.

PeriReporter’s User Guide P0988093 July 2010

Sharing Data Between Solaris and Windows

If PeriReporter is going to be used to collect data from both Solaris and Windows terminals certain configuration changes have to be made to the .rhosts file.

On Solaris terminals the .rhosts file is located in the /home/peri directory. This configuration change only needs to be made if data will be collected from both Solaris and Windows terminals.

On Windows terminals the .rhosts file is located in the \WinNT directory. This configuration change always needs to be made, regardless of whether data will or will not be collected from both Solaris and Windows terminals.

Open the .rhosts file and add the identifications of all terminals from where statistics are to be collected.

The following example represents a system which has three Solaris terminals and three Windows terminals, where the .rhosts file from the first Solaris terminal (UNIX1) is being changed.

UNIX2_NAME peri UNIX2_NAME SYSTEM UNIX3_NAME peri UNIX3_NAME SYSTEM WINDOWS1_NAME peri WINDOWS1_NAME SYSTEM WINDOWS2_NAME peri WINDOWS2_NAME SYSTEM WINDOWS3_NAME peri WINDOWS3_NAME SYSTEM

Seeing as how the statistics are being collected on the UNIX1 terminal from the terminals UNIX2, UNIX3, WINDOWS1, WINDOWS2 and WINDOWS3, only those terminals need be listed.

Microsoft Services for UNIX (SFU) must be installed for PeriReporter collections scripts to function correctly.

Symantec pcAnywhere cannot be installed, for any reason, on a node where the SFU utilities reside. There is a conflict between pcAnywhere and the Avaya software that produces system errors.

PeriReporter’s User Guide P0988093 July 2010

Time Zones

In certain areas of the world, Java will not recognize the time zones set on the system which it is installed. If this occurs, PeriReporter will default to Greenwich Mean Time and report times will be off by several hours. It is also possible that the consolidation will not be performed correctly.

To be sure this does not occur the .perireporter file, residing in your home directory, must be modified. A line stating timezone= along with your three-digit time zone identification code must be added.

For example, if your system is installed in Hong Kong, and runs on China Standard Time, the following line would need to be added to the .perireporter file.

timezone=CTT

To determine your time zone identification code, refer to the following table.

All times are listed in Standard Time. Adjust for Daylight Saving Time accordingly.

Time Zones Sheet 1 of 2

Time Zone Name Offset From GMT ID Countries/Cities/Regions

Greenwich Mean Time GMT + 0 hours GMT Africa/Casablanca

Romance Standard Time GMT + 1 hour ECT Europe/Paris

Egypt Standard Time GMT + 2 hours EET Arica/Cairo

Saudi Arabia Standard Time GMT + 3 hours EAT Asia/Riyadh

Iran Standard Time GMT + 3 1/2 hours MET Asia/Tehran

Arabian Standard Time GMT + 4 hours NET Asia/Yerevan

West Asia Standard Time GMT + 5 hours PLT Asia/Karachi

India Standard Time GMT + 5 1/2 hours IST Asia/Calcutta

Central Asia Standard Time GMT + 6 hours BST Asia/Dacca

Bangkok Standard Time GMT + 7 hours VST Asia/Bangkok

China Standard Time GMT + 8 hours CTT Asia/Shanghai

Tokyo Standard Time GMT + 9 hours JST Asia/Tokyo

Central Australia Standard Time

GMT + 9 1/2 hours ACT Australia/Adelaide

Sydney Standard Time GMT + 10 hours AET Australia/Sydney

Central Pacific Standard Time GMT + 11 hours SST Pacific/Guadalcanal

New Zealand Standard Time GMT + 12 hours NST Pacific/Auckland

Samoa Standard Time GMT - 11 hours MIT Pacific/Apia

PeriReporter’s User Guide P0988093 July 2010

Time Zones Sheet 1 of 2

Time Zone Name Offset From GMT ID Countries/Cities/Regions

Hawaiian Standard Time GMT - 10 hours HST Pacific/Honolulu

Alaskan Standard Time GMT - 9 hours AST America/Anchorage

Pacific Standard Time GMT - 8 hours PST America/Los Angeles

US Mountain Standard Time GMT - 7 hours MST America/Denver

Central Standard Time GMT - 6 hours CST America/Chicago

Eastern Standard Time GMT - 5 hours EST America/New York

Atlantic Standard Time GMT - 4 hours PRT America/Halifax

Newfoundland Standard Time GMT - 3 1/2 hours CNT America/St. Johns

South America Eastern Standard Time

East South America Standard Time

Azores Standard Time GMT - 1 hours CAT Atlantic/Azores

GMT - 3 hours AGT America/Buenos Aires

GMT - 3 hours BET America/San Paulo

PeriReporter’s User Guide P0988093 July 2010

Statistical

Maintenance

This chapter covers:

1. Collection and Maintenance of Statistical Data

Collection and Maintenance of Statistical Data

Statistics are collected and stored in 15-minute intervals, on a per Avaya Media Processing Server (Avaya MPS) Series basis, for all Avaya MPS configured for the network. The $MPSHOME/common/etc/vpshosts file lists all networked servers and the nodes at which they are configured.

When collecting stats from remote systems, PeriReporter will look in the vpshosts file. For both system and application stats, PeriReporter will retrieve data for all systems that are of TYPE vps in the vpshosts file. In some cases, the vpshosts

file may or may not contain some vps systems to gather statistics from. To solve this problem, the collections scripts check for the presence of an alternate vpshosts file called vpshosts.prpt. This file will be used if it exists. Otherwise, the normal vpshosts file will be read.

For system stats, PeriReporter goes through each vps entry, converts the data to binary form and brings it back to the PeriReporter node.

For application stats, PeriReporter goes through each vps entry. If it is not the local node and it has not already been copied from another vps entry, the data is brought back to the PeriReporter node.

The vpshosts file determines which systems will be used to gather statistics from. Use the vhman or xvhman command to configure the vpshosts file.

For additional information on configuring the vpshosts file, see the Per i View Reference Manual (9090722 (I)).

Statistics may be categorized as being either system statistics or user-defined, application-specific statistics. All statistics data is stored and is available for creating and generating reports.

• Each Avaya MPS’ VSTAT process collects system statistics and writes them to raw statistics files in the directory $MPSHOME/vps(#)/stats. One VSTAT process exists for each server.

• Each node’s VSUPD process collects application statistics and writes them to raw statistics files in the directory: $ASEHOME/stats. One VSUPD process exists for each node.

The process of system statistics collection and reporting is transparent to the user. However, the process of collecting and reporting application statistics requires user intervention.

Once a report is generated, report data is always static. Statistical updates can only be displayed by generating a new report.

PeriReporter’s User Guide P0988093 July 2010

Single vs. Multi-node Environments

In a single node environment, the PeriReporter tool, statistics files and applications all exist on the same node. (Stat events are defined, generated and collected on this same node.) In a multi-node environment, applications can execute on nodes where PeriReporter does not reside. Statistics are transferred from the node at which they are generated to the statistics node via scripts which run on the collection node.

PeriReporter’s User Guide P0988093 July 2010

Defining Stat Events in a Single Node Environment

This process applies to a configuration in which application statistics are to be collected from Avaya MPS Series and VAS resources that reside on the statistics node. The node’s VSUPD process is responsible for collecting application statistics from all resources on the node. Each server’s VSTAT process is responsible for collecting system statistics for the unit. A single Avaya MPS consists of Telephony Media Server (TMS) hardware and both Application Services Environment (ASE) and Voice Operating Software (Avaya VOS) software processes. The UNIX node consists of Avaya MPS Series elements common to all units configured for the node. The following diagrams illustrate the relationships between the components in a single node Avaya MPS Series from the PeriReporter point of view.

In this example, the UNIX node consists of a

MPS

UNIX Node

VSUPD

Per iView & PeriReporter

MPS 1

VSTAT

Application(s)

ASE / VOS

VSUPD process and PeriView—with PeriReporter, and a single execute. The

Ava y a MPS on which applications

Ava ya MPS consists of a VSTAT

process; applications; ASE and VOS processes; and TMS hardware.

Application stat events are defined within each application, to the statistics node, and to the VSUPD process. The VSUPD process collects application statistics for the node and writes them to $ASEHOME/stats as raw statistics files.

MPS

UNIX Node

VSUPD

PeriView & PeriReporter

MPS 1

VSTAT

Application(s)

ASE / VOS

TMS

MPS 2

VSTAT

Application(s)

ASE / VOS

TMS

After System statistics for the

Ava ya MPS are

collected they are converted and stored in $ASEHOME/stats as raw statistics files.

In this example, the UNIX node consists of a VSUPD process and PeriView—with PeriReporter, and two

The

Ava ya MPSs on which applications execute.

Ava ya MPSs each consist of a VSTAT process;

applications; ASE and VOS processes; and TMS hardware.

After System statistics for the

Ava ya MPS are

collected they are converted and stored in $ASEHOME/stats as raw statistics files.

PeriReporter’s User Guide P0988093 July 2010

Application Stat Events in a Multi-Node Environment

This process applies to a configuration in which application statistics may have to be collected from the Avaya MPS Series Network and VAS resources that reside on the statistics node and from Avaya MPS and VAS resources that reside on nodes at which the statistics files do not reside. Typically, in a multi-node environment, the PeriReporter tool resides at one node only.

A node’s VSUPD process is responsible for collecting application statistics from all Avaya MPS and VAS resources on the node. Each servers VSTAT process is responsible for collecting system statistics for the unit.

VSUPD must be running on all nodes at which application statistics are to be collected. This includes all Avaya MPS and VAS nodes at which applications are running.

The following diagram illustrates the relationship between the components in a multi-node Avaya MPS Series Network configuration, from the PeriReporter tool point of view.

In this example, the Avaya MPS Series Network is configured with two UNIX nodes, and a VSUPD process is associated with each node. Although PeriView resides at both nodes, PeriReporter resides only on Node A, which is configured with a single Avaya MPS 100. Node B consists of two Avaya MPS 100s. Each Avaya MPS consists of ASE and VOS software processes, a VSUPD process, TMS hardware, and applications.

Applications assigned to Node A are executing locally with respect to PeriReporter. Applications assigned to Node B are executing remotely with respect to PeriReporter.

Stat Events are defined within each application and to each node’s VSUPD process (which collects application statistics for the node and writes them to the directory $ASEHOME/stats as raw statistics files).

The strec#.sre files must be copied from Node A to Node B.

Application statistics, collected at Node B, need to be transferred to Node A.

MPS

PeriView & PeriReporter

Application(s)

ASE / VOS

Node A

VSUPD

MPS 1

VSTAT

TMS

MPS network

Application(s)

ASE / VOS

MPS 2

VSTAT

TMS

MPS

Node B VSUPD

Per iView

MPS 3

VSTAT

Application(s)

ASE / VOS

TMS

PeriReporter’s User Guide P0988093 July 2010

In a multi-node environment, the stat event definition process may involve defining stat events for applications that are executing on both local and remote nodes. Fields in a stat record file must be defined once for each unique application for which statistics are to be collected, whereas stat record code stub files must exist on each node at which application statistics are to be collected.

Example:

If multiple instances of the same application are to execute on different nodes in the network, fields in a stat record file have to be defined only once for the application, regardless of the number of locations at which it will execute. However, stat record code stub files must be located on all nodes running applications for which statistics are to be collected.

PeriReporter’s User Guide P0988093 July 2010

PeriReporter and the Avaya MPS Network

Typically, a single node in a Avaya MPS Series Network is designated to collect and report statistical data. PeriReporter resides on the node designated for this purpose.

System statistics are collected from each Avaya MPS Series by the server’s VSTAT process. One VSTAT process exists for each unit.

• In a single node environment, all Avaya MPS Series exist on the same (local)

node. System statistics are collected once each hour by each unit’s VSTAT process. The script pr-sys-v5.plx runs and collects the raw data files from the $MPSHOME/vpsN/stats directory and creates binary files in the $ASEHOME/stats directory.

• In a multi-node environment, Avaya MPS Series can be configured for nodes at

which PeriReporter does not reside (remote) as well as for the statistics collection node (local). Scripts run on the collection node only and are transferred from the remote nodes to the $ASEHOME/stats directory of the collection node.

• System statistics generated at remote nodes are collected by each remote Avaya MPS Series’ VSTAT process, transferred to the statistics node and stored in sysstats and accstats files.

• System statistics generated by Avaya MPS Series configured for the statistics node (local) are collected by each local server’s VSTAT process and stored in

sysstats and accstats files. Two types of files are created by the script pr-sys-v5.plx.

• sysstats - system statistics files by Avaya MPS, line, span, and host

• accstats - system statistics files by time

• The System Variables are predefined. Of the System Variables available, each report definition can specify only one of the following.

• System.VPS

• System.Line

• System.Host

• System.Span

If one of the above system variables is chosen in a report then all variables for the report definition will be collected from sysstats files. Counters for the rest of the report definition can be any combination of remaining System Va ri a bl e s .

These variables are usually mapped to the first column of a report in place of the date. When these variables are used, no column may be mapped to record the date. If one of these variables is chosen for a particular column and Date is chosen for another column an error message will appear.

• With the exception of the above variables, report definitions can be mapped to any combination of Application and System Variables.

For additional information on mapping of columns for report definitions, see the Data

Mapping section of this manual.

PeriReporter’s User Guide P0988093 July 2010

Application statistics are generated during an application’s execution cycle and collected by each node’s VSUPD process. One VSUPD process exists for each node.

• In a single node environment, all Avaya MPS Series exist on the same (local) node. Application statistics are collected by the node’s VSUPD process and written to raw statistics files in the directory $ASEHOME/stats.

• Application statistics generated at remote nodes are collected by each remote

node’s VSUPD process, transferred to the statistics node and stored in

appstats files in $ASEHOME/stats. The script pr-app-v5.plx is used to collect remote statistics for the application data.

• appstats - application statistics files

• Application statistics generated by Avaya MPS Series configured for the

statistics node (local) are collected by the node’s VSUPD process and stored in appstats files.

To view these files, use the vsupdump -f command.

The VSUPD process must be running on all nodes at which applications are executing and statistics are to be collected. If VSUPD is not running on a node at which applications are executing, any statistics that are generated at that node will not be collected.

To run the VSUPD process, uncomment the VSUPD line within the gen.cfg file in the $MPSHOME/common/etc directory.

PeriReporter’s User Guide P0988093 July 2010

System and Application Statistics

Statistical data originates from user defined, application-specific stat events and system defined stat events.

System statistics and application statistics reports can be generated individually for each Avaya MPS, or for all units configured for the network.

On systems configured with more than one node, application statistics will be collected for all of the node’s resources by a single VSUPD process. However, system statistics will be collected for each Avaya MPS by individual VSTAT processes.

System Statistics

System statistics report data related to phone line usage, digital span activity, and host interaction. System statistics are Avaya MPS-specific and include all statistics generated by all applications on each unit.

System stat events are predefined by Avaya. System statistical reports are predefined by Avaya and should not be modified without consulting Avaya. System statistics can be viewed with PeriReporter, which is used to select and generate a report.

VSTAT is the VOS (Voice Operating Software) process responsible for collecting system statistics. System stat events are maintained by stat event counters. Each Avaya MPS Series designates one counter for each unique occurrence of a specified event. System statistics are collected on a per Avaya MPS Series basis, by each unit’s VSTAT process. At regular intervals, data is collected from each unit to the collection node and transferred to binary files, where it is stored on a per unit basis.

These files are located in $ASEHOME/stats and are called sysstats and accstats.

PeriReporter’s User Guide P0988093 July 2010

System Statistics Reports Summary

There are seven predefined System Statistics Reports.

Filename Report

MPSPhoneDetail.prd Detail Phone Line Statistics Report

MPSPhoneSum.prd Summary Phone Line Statistics Report

MPSPhoneAcc.prd Accumulated Summary Phone Line Statistics Report

SpanDetail.prd Detail Span Statistics Report

SpanSum.prd Summary Span Statistics Report

HostDetail.prd Detail System Statistics Report

HostSum.prd Summary System Statistics Report

The tables that follow summarize the contents of each of the previously mentioned predefined reports.

The following tables also describe the system counters for statistical collection and reporting for which individual columns can be mapped. These counters can be chosen in the System Variables section of the Data Mapping window.

For additional information on Data Mapping, see the PeriDefiner section of this manual.

PeriReporter’s User Guide P0988093 July 2010

System Statistical Reports Sheet 1 of 3

SPAN REPORTS

Span statistics indicate span activity for digital T-1 systems in both summary and detail format. Reports include the Span Detail Report and Span Summary Report.

Type

Detail

Summary

Busy

Seconds

Errored

Seconds

Severe

Seconds

Failed

Seconds

Yellow

Seconds

Max Bit

Change

SpanDetail.prd: Data is reported for each span on selected or all Avaya MPS Series, for a specified range.

SpanSum.prd: Data is collectively summarized for all spans, for selected or all Avaya MPS Series, then reported for a specified date range. Data for each unit is summarized on a single line. Totals reflect span activity inclusive of all units.

Statistics

System.SpanBusy: The number of seconds the span was in an in-

service/busy state.

System.SpanError: The number of seconds the span was in an errored signal state. (The span could not take calls.)

System.SpanSevere: The number of seconds the span was in an errored signal state and the severity of the state was high. (The span could not take calls.)

System.SpanFailed: The number of seconds the span was in a failed signal state. (The span could not take calls.)

System.SpanYellow: The number of seconds the span was in a yellow signal state. (The span could not take calls.)

System.SpanMaxBit: The number of “MAX a and b” bit changes per second that occurred on the span.

Degraded

Minutes

System.SpanDegraded: This variable is not implemented at this time.

PeriReporter’s User Guide P0988093 July 2010

System Statistical Reports Sheet 2 of 3

PHONE LINE REPORTS

Phone line statistics indicate phone line usage in both a summary and detail format. Reports include the Phone Line Detail Report, Phone Line Summary Report, and Phone Line Accumulated Summary Report.

Type

Detail

Summary

Accumulated

Summary

MIS

#CE

ACS

MPSPhoneDetail.prd: Phone line usage is reported for selected or all Avaya MPS Series and phone lines, for a specified date range. Totals reflect usage per individual units.

MPSPhoneSum.prd: Data is collectively summarized for selected or all phone lines, then reported for selected or all Avaya MPS Series, for a specified date range. Data for each unit is summarized on a single line. Totals reflect usage inclusive of all units.

MPSPhoneAcc.prd: Data is summarized per the time period specified by the user collectively for selected or all phone lines, then reported for selected or all Avaya MPS Series for the specified date–time range.

Statistics

System.MIS: Minutes In Service: The number of minutes the line was in an

in-service state—connected and able to take calls.

System.Utilized: Percent Utilization: The percentage of time the line was in a busy state—out of service or taking calls.

System.Calls: Number of Calls Ended: The total number of calls ended— irrespective of the termination process.

System.ACS: Average Call Seconds: The length of the average call— measured in seconds. While this is correct for a column within a report, the actual counter stores the data as the average multiplied by the total number of calls for that period.

UAB

SAB

System.UAB: User Abandoned Calls: The number of user abandoned calls—the user elects not to follow through with the call.

System.SAB: System Abandoned Calls: The number of system abandoned calls—the Avaya MPS Series application terminates the call.

PHONE LINE REPORTS - Statistics (continued)

SYSTEM REPORTS

System Statistics indicate overall system activity in both summary and detail format. Reports include the System (Host) Detail Report and System (Host) Summary Report.

Type

Detail

PeriReporter’s User Guide P0988093 July 2010

HostDetail.prd: Data is reported for selected or all Avaya MPS Series and external hosts for a specified date range.

+ 103 hidden pages