Report Generator s User Guide

Transcription

1 Titlepage Report Generator s User Guide Document SPECTRUM Management

2 Copyright Notice Document Copyright May 2002 Aprisma Management Technologies, Inc., 121 Technology Drive, Durham, NH USA. All rights reserved worldwide. Use, duplication, or disclosure by the United States government is subject to the restrictions set forth in DFARS (c)(1)(ii) and FAR Liability Disclaimer Aprisma Management Technologies, Inc. ("Aprisma") reserves the right to make changes in specifications and other information contained in this document without prior notice. In all cases, the reader should contact Aprisma to inquire if any changes have been made. The hardware, firmware, or software described in this manual is subject to change without notice. IN NO EVENT SHALL APRISMA, ITS EMPLOYEES, OFFICERS, DIRECTORS, AGENTS, OR AFFILIATES BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT OF OR RELATED TO THIS MANUAL OR THE INFORMATION CONTAINED IN IT, EVEN IF APRISMA HAS BEEN ADVISED OF, HAS KNOWN, OR SHOULD HAVE KNOWN, THE POSSIBILITY OF SUCH DAMAGES. Trademark, Service Mark, and Logo Information SPECTRUM, IMT, and the SPECTRUM IMT/VNM logo are registered trademarks of Aprisma Management Technologies, Inc., or its affiliates. APRISMA, APRISMA MANAGEMENT TECHNOLOGIES, the APRISMA MANAGEMENT TECHNOLOGIES logo, MANAGE WHAT MATTERS, DCM, VNM, SpectroGRAPH, SpectroSERVER, Inductive Modeling Technology, Device Communications Manager, SPECTRUM Security Manager, and Virtual Network Machine are unregistered trademarks of Aprisma Management Technologies, Inc., or its affiliates. For a complete list of Aprisma trademarks, service marks, and trade names, go to All referenced trademarks, service marks, and trade names identified in this document, whether registered or unregistered, are the intellectual property of their respective owners. No rights are granted by Aprisma Management Technologies, Inc., to use such marks, whether by implication, estoppel, or otherwise. If you have comments or concerns about trademark or copyright references, please send an to spectrum-docs@aprisma.com; we will do our best to help. Report Generator User s Guide Page 2

3 Restricted Rights Notice (Applicable to licenses to the United States government only.) This software and/or user documentation is/are provided with RESTRICTED AND LIMITED RIGHTS. Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR (June 1987) Alternate III (g)(3) (June 1987), FAR (June 1987), or DFARS (c)(1)(ii) (June 1988), and/or in similar or successor clauses in the FAR or DFARS, or in the DOD or NASA FAR Supplement, as applicable. Contractor/manufacturer is Aprisma Management Technologies, Inc., 121 Technology Drive, Durham, NH In the event the government seeks to obtain the software pursuant to standard commercial practice, this software agreement, instead of the noted regulatory clauses, shall control the terms of the government's license. Virus Disclaimer Aprisma makes no representations or warranties to the effect that the licensed software is virusfree. Aprisma has tested its software with current virus-checking technologies. However, because no anti-virus system is 100 percent effective, we strongly recommend that you write-protect the licensed software and verify (with an anti-virus system in which you have confidence) that the licensed software, prior to installation, is virus-free. Contact Information Aprisma Management Technologies, Inc. 121 Technology Drive Durham, NH Phone: U.S. toll-free: Web site: Report Generator User s Guide Page 3

4 Contents Preface 14 About This Guide...14 Who Should Read This Guide...14 How To Use This Guide...15 Typographical Conventions...16 Introduction To the Report Generator 18 Overview...18 Report Types...20 Alarm Reports...20 Event Reports...20 Inventory Reports...21 Statistical Reports...21 Up/Down Time Reports...21 Summary...22 Reporting Fundamentals 23 Overview...23 Opening the Report Generator...23 Selecting a SpectroSERVER...24 The Report Generator Main Window...24 Specifying Landscapes...28 Specifying Models for a Report...29 Specifying Several Models...32 Using Multiple Select...32 Specifying a Post Generate Script...32 The Report Formatter Window...35 File Menu...36 Edit Menu...37 View Menu...38 Format Menu...38 The Regions Of a Report Format File...38 Exploring Buttons and Some Operations...39 Report Generator User s Guide Page 4

5 Contents Using the Buttons...40 Working In a Region...41 Examining an Object...41 Inserting a New Object...41 Verifying the Appearance of Your Work...42 Selecting Text or an Object...42 Copying Text or Objects...43 Cutting Text or Objects...43 Pasting Text or Objects...43 Copying Text and Objects: a Quick Way...43 Working With Templates...43 Working With Dialog Boxes...44 File Selection Dialog Box...44 Selecting an Item With the Search or Filter Methods...46 Using Keyboard Shortcuts...48 Other Display Options...49 Long Model Names...49 Extended Decimal Places...49 Time Formats...50 Quitting Reports...50 Quick Start 51 In This Section...51 Creating an Alarm Report...51 Creating an Event Report...54 Creating an Inventory Report...57 Creating a Statistical Report...60 Creating an Up/Down Time Report...62 Alarm Reports 67 Overview...67 Starting the Report Generator...68 Specifying Landscapes...69 Specifying a Report Format File...69 Specifying a Report Output File Name...69 Specifying the Viewing Output...70 Report Generator User s Guide Page 5

6 Contents Specifying Filter Criteria...71 Where Do You Go From Here?...71 Customizing an Alarm Report...72 Selecting a Template File...73 Setting the Page Size Of the Report...73 Creating the Regions Of Your Report...74 The Report Header Region...75 The Column Header Region...75 The Line Data Region...75 The Summary Header Region...76 The Summary Data Region...76 Advanced Format Options...77 Using the Sort Operation...77 Top-N...82 Summary Only...82 Saving the New Report Format File...82 Event Reports 83 Overview...83 Starting the Report Generator...84 Specifying Landscapes...85 Specifying One or More Models...86 Specifying a Report Format File...86 Specifying a Data Range...86 Using the Custom Data Range...87 Specifying a Report Output File Name...88 Specifying the Viewing Output...89 Specifying Filter Criteria...89 Where Do You Go From Here?...92 Customizing an Event Report...92 Selecting a Template File...93 Setting the Page Size Of the Report...94 Creating the Regions Of Your Report...95 The Report Header Region...95 The Column Header Region...96 The Line Data Region...96 The Summary Header Region...97 Report Generator User s Guide Page 6

7 Contents The Summary Data Region...97 Advanced Format Options...98 Using the Sort Operation...98 Top-N Summary Only Saving the New Report Format File Inventory Reports 104 Overview Starting the Report Generator Specifying Landscapes Specifying One or More Model Types Specifying a Report Format File Specifying a Report Output File Name Specifying the Viewing Output Specifying Level Of Detail Specifying the Site Name Where Do You Go From Here? Customizing an Inventory Report Selecting a Template File Setting the Page Size Of the Report Creating the Regions Of Your Report The Report Header Region The Column Header Region The Line Data Region The Summary Header Region The Summary Data Region Advanced Format Options Using the Sort Operation Top-N Summary Only Saving the New Report Format File Statistical Reports 124 Overview Starting the Report Generator Specifying Landscapes Report Generator User s Guide Page 7

8 Contents Specifying One or More Models Specifying a Report Format File Specifying a Data Range Using the Custom Data Range Specifying a Report Output File Name Specifying the Viewing Output Where Do You Go From Here? Customizing a Statistical Report Selecting a Template File Setting the Page Size Of the Report Creating the Regions Of Your Report The Report Header Region The Column Header Region The Line Data Region The Summary Header Region The Summary Data Region Advanced Format Options Applying a Verb To a <STAT> Object Using the Compute Operation Using the Sort Operation Top-N Summary Only Summary Report Column Labels Enumerated Text Saving the New Report Format File Up/Down Time Reports 152 Overview Starting the Report Generator Specifying Landscapes Specifying One or More Models Considerations for Up/Down Time Reports on Interfaces Models Relations in Up/Down Time Reports Specifying a Report Format File Specifying a Data Range Using the Custom Data Range Specifying a Report Output File Name Report Generator User s Guide Page 8

9 Contents Specifying the Viewing Output Where Do You Go From Here? Customizing an Up/DownTime Report Selecting a Template File Setting the Page Size Of the Report Creating the Regions Of Your Report The Report Header Region The Column Header Region The Line Data Region The Summary Header Region The Summary Data Region Advanced Format Options Using the Compute Operation Using the Sort Operation Top-N Summary Only Saving the New Report Format File Displaying Reports 174 Displaying the Report In Tabular Output Printing Tabular Reports Solaris Printing Tabular Reports NT Displaying the Report In Graphical Output The Graphical Reports Application General Features Respecifying the Data For the Graph Changing Between Colors and Patterns Resetting the Graph Scrolling the Graph Graph Types and Styles Graph Types Graph Styles Data Point Labels and Data Values Editing Functions Zooming on the Graph Changing the Appearance Of the Graph Setting the Scale Bounds Report Generator User s Guide Page 9

10 Contents Bounds Source Bounds Scope Editing the Graph Label Editing the Axis Labels Saving a Graph File Loading Another Graph File Specifying Preferences General Considerations Printing the Graph Printing Graphical Reports in a UNIX Environment Printing Graphical Reports in an NT-only Environment Print Setup Scheduling Reports 221 Accessing the Scheduler Scheduling a Report Scheduler Update Scripts Setting Defaults In the Resource Files 228 The RibE Resource File The Reports Resource File Glossary of Terms 241 Up/Down Time Report - Special Event Cases 244 Using Report Output in HTML Pages 249 Overview Setup Procedures Incorporating GIF Files into an HTML Page Reporting on SpectroWATCH Model Data 259 Index 260 Report Generator User s Guide Page 10

11 Figures Figure 1: SPECTRUM Report Generation...22 Figure 2: The Report Generator Main Window...24 Figure 3: Landscapes Dialog Box...29 Figure 4: Models Dialog Box...30 Figure 5: Model Types/Models List...31 Figure 6: Regions of the Report Formatter Window...36 Figure 7: Report Header Region...41 Figure 8: File Selection Dialog Box...45 Figure 9: Searching for Model Types and Models...47 Figure 10: Using Filter to Find Model Types (Case Sensitive)...48 Figure 11: The Report Generator Main Window (Alarm Report)...52 Figure 12: Alarm Report...53 Figure 13: The Report Generator Main Window (Event Report)...55 Figure 14: Event Report...56 Figure 15: The Report Generator Main Window (Inventory Report)...58 Figure 16: Inventory Report...59 Figure 17: The Report Generator Main Window (Statistical Report)...60 Figure 18: Graphical Statistical Report...62 Figure 19: The Report Generator Main Window (Up/Down Time Report)...63 Figure 20: Up/Down Time Report...65 Figure 21: Alarm Report Main Window...68 Figure 22: Alarm Report Template...73 Figure 23: Sorting Dialog Box...78 Figure 24: Unsorted Report...79 Figure 25: Sorted Report by Alarm ID...81 Figure 26: Event Report Main Window...85 Figure 27: Data Range Dialog Box for Custom Option...87 Figure 28: Filter on Event Code Dialog Box...90 Figure 29: Filter on Alarm Conditions Dialog Box...91 Figure 30: Event Report Template...94 Figure 31: Sorting Dialog Box...99 Figure 32: Unsorted Report Report Generator User s Guide Page 11

12 Figures Figure 33: Sorted Report by Event Code Figure 34: Inventory Report Main Window Figure 35: Model Types Dialog Box Figure 36: General Report Example Figure 37: Detailed Report Example Figure 38: Inventory Report Template Figure 39: Sorting Dialog Box Figure 40: Unsorted Report Figure 41: Sorted Report by Number of Inactive Models Figure 42: Statistical Report Main Window Figure 43: Data Range Dialog Box for Custom Option Figure 44: Statistical Report Template Figure 45: Statistic Dialog Box Figure 46: Expression Dialog Box Figure 47: Sorting Dialog Box Figure 48: Unsorted Report Figure 49: Sorted Report by Descending Packet Rate Figure 50: Up/Down Time Report Main Window Figure 51: Data Range Dialog Box for Custom Option Figure 52: Up/Down Time Report Template Figure 53: Statistic Dialog Box Figure 54: Sorting Dialog Box Figure 55: Sorted Report by Model Handle Figure 56: Display Type Screen Figure 57: Specify Data Dialog Box Figure 58: Graphical Reports Main Window Figure 59: Menu Bar Selections Figure 60: Graph in Expanded Format Figure 61: Graph in Condensed Format Figure 62: Zoom Dialog Box Figure 63: Column Graph at 4 Data Points Figure 64: Column Graph at 29 Data Points Figure 65: Graph Formatting Dialog Box Figure 66: Scale Bounds Dialog Box Report Generator User s Guide Page 12

13 Figures Figure 67: Default Bounds for All Data Figure 68: Results of Setting Own Bounds Figure 69: Graph Label Dialog Box Figure 70: Axis Labels Dialog Box Figure 71: Preference Information Figure 72: Print Graph Dialog Box Figure 73: Print Setup Dialog Box Figure 74: The Scheduler Dialog Box Figure 75: Frequency Options Figure 76: Example HTML Page with Small GIF Files Embedded Report Generator User s Guide Page 13

14 Preface This preface describes the purpose and content of this manual, assumptions about SPECTRUM Report Generator users, and typographical conventions used in this manual. Welcome to the SPECTRUM Report Generator User s Guide. SPECTRUM Report Generator is a full-featured reporting application designed to help you create reports about your network. About This Guide This guide describes how to use the SPECTRUM Report Generator to generate five types of reports: Alarm, Event, Inventory, Statistical, and Up/Down Time. It also describes how to create the format of a report using the Report Formatter and how to display the output of a report in various formats using the Report Display. With the Report Generator, you will quickly produce the results you want to see in a report. Once you become familiar with the Report Generator, you can schedule your reports to run periodically. There are two parts to this guide. The first part gives you a quick orientation on reports and helps you get started using the Report Generator right away. The second part contains background information, procedures, and examples to get the most out of all the features of the Report Generator. Who Should Read This Guide This guide is intended for network administrators and users who need to access information about the network. This guide assumes that you already know how to perform basic operations using SPECTRUM and that the data for your report is logged and available in a network database or archive. Report Generator User s Guide Page 14

15 Preface How To Use This Guide This guide is organized as follows: How To Use This Guide Section Description Introduction To the Report Generator Reporting Fundamentals Quick Start Alarm Reports Event Reports Inventory Reports Statistical Reports This section provides an overview of the Report Generator application. The Report Generator allows you to format, generate, and display reports that present useful information about a SPECTRUMmanaged network. This section describes how to start the Report Generator and become familiar with Report Generator features. This section provides a tutorial for using the Report Generator, and introduces you to the basics of running your first report. This section discusses how to create and customize an Alarm Report. This section discusses how to create and customize an Event Report. This section discusses how to create and customize an Inventory Report. This section discusses how to create and customize a Statistical Report. Up/Down Time Reports This section discusses how to create and customize an Up/Down Time Report. Displaying Reports This section describes how to use the Report Display feature of Reports to display tabular and graphical outputs for your report. It also describes the features of graphical output in the Graphical Reports application. It describes the types and styles of graphs, and the components of the Graphical Reports main window. Report Generator User s Guide Page 15

16 Preface Typographical Conventions Section Scheduling Reports Setting Defaults In the Resource Files Glossary of Terms Up/Down Time Report - Special Event Cases Using Report Output in HTML Pages Reporting on SpectroWATCH Model Data Description This section describes how to schedule the execution time of your report. This section discusses changing resources in the Report Generator resource files (RibE and Reports). You can modify these files using a text editor to change the default startup parameters. This section describes terms that pertain to the Report Generator. This section presents different cases of special events as they affect an Up/Down Time Report. This section discusses the steps that must be performed in order to use Graphical GIF report output in Web browsers. This section describes creating a report with logged data generated by a SpectroWATCH watch that is logging at a model-only level. Typographical Conventions This manual uses the following typographical conventions: References to other sections of this document appear in italics (hypertext-blue italics for on-line readers). References to other Aprisma manuals appear in bold italics. For example: See Report Types for more information on the types of reports you can create with SPECTRUM Report Generator. See the SPECTRUM Installation Guide for SPECTRUM installation procedures. Report Generator User s Guide Page 16

17 Preface Typographical Conventions Operational dialog appears in a monospace typeface. Text displayed by the system at the UNIX command level appears as normal monospace typeface. Keyboard entries at the UNIX command level appear as bold monospace typeface. For example: prompt: mte Code examples and sample reports appear in Courier. For example: *ColorTablePath: /usr/data/sg-support/csimage/color.tbl When the code example contains site specific variables (such as, the name of your VNM or a user specified path), the variable is represent by its name, and is bold and bound by angled brackets. For example: *vnmname: <vnm system name> When it is necessary to keep examples of long lines of code on one line in order to illustrate the proper formatting and spacing, it appears in Times. For example: * / <$SPECROOT>/SG-Tools/dataexp Note: Calls your attention to information of special importance. Tip: Calls your attention to shortcuts or alternate procedures. Caution: Calls your attention to procedures which, if not followed exactly, could damage or otherwise incapacitate your software or hardware. Report Generator User s Guide Page 17

18 Introduction To the Report Generator This section provides an overview of the Report Generator application. The Report Generator allows you to format, generate, and display reports that present useful information about a SPECTRUM-managed network. Overview SPECTRUM s design is based on a client-server model where the SpectroSERVER (VNM) includes a database. This database provides storage for the specific device configurations and contains a modeling catalog (model types and relations) that is the structure for all your network information. By modeling devices in the database, SPECTRUM provides a wide range of information about network devices and network structure even when a device is powered-off or contact is lost. While this information resides in the database it serves no purpose to you unless it is retrieved and displayed in a report. The SPECTRUM Report Generator application performs this task for you. The Report Generator is your guide through the history of your network. You can use this tool to help gain a better understanding of what has happened to your network. Through a good understanding of past performance, you can prevent problems in the future and continue efficient operations. The Report Generator comprises a three-part process. Report Formatter Start with the end in mind. Think about what kind of network information you need to have in hand at the end of the day, week, or month. Define what you want that information to look like. You may want to keep in mind that these reports are very useful as status reports to Report Generator User s Guide Page 18

19 Introduction To the Report Generator Overview management for strategic decision making or for yourself to perform trend analysis. The output of the Report Formatter is a Report Format File, which defines the output format of your report. Often there may be a report format file already configured for the version of the report you want. Therefore, you could generate a report using the available report format files that are supplied with SPECTRUM Report Generator. Alternately, you could customize a report by creating your own report format file for the format you want. Report Generator Connect the kinds of data you want to collect with the specific models or model types that interest you. Decide which models or model types need daily, weekly, or monthly reports. Report Display Use printouts and graphical presentations of the generated reports to look into the activity on your network. This is the phase where you can get a clear picture of what has happened on those models or model types with which you are interested. You can explore and analyze your data by using a variety of graphs available in the Graphical Reports application within Report Generator. In addition, you can easily change the arrangement of data on any of the graphs and prepare them for different presentations. The procedures for developing your reports are discussed in the remaining sections. The SPECTRUM Report Generator is a core SPECTRUM component, and is installed by default with the core SPECTRUM product using the standard SPECTRUM installation program, Install. Therefore, no custom installation script options are required. You can install the SpectroSERVER and SpectroGRAPH portions of Report Generator on different machines, if necessary. See the SPECTRUM Installation Guide for more information. Report Generator User s Guide Page 19

20 Introduction To the Report Generator Report Types The Report Generator lets you create the following types of reports: Alarm Reports Event Reports Inventory Reports Statistical Reports Up/Down Time Reports Alarm Reports Report Types Alarm Reports are reports on the current problems of the network. They provide you with information about the active alarms from your network Alarm Monitor. The report can include model handle, model name, model type name, date/time stamp, alarm ID, alarm condition, alarm cause, view path, and probable cause code for all currently active alarms. In addition, a table is appended to the end of an alarm report that lists only the relevant probable causes for each active alarm and the recommended corrective actions. Event Reports Event Reports provide you with information on the network events as SPECTRUM collects data related to network activity. This may include a history of the behavior of a specific model or groups of models from the Event Log. The event report can include the model name, model type name, model handle, date/time stamp, event type, event message, and view path. If the event records that an alarm was generated, the report lists the alarm ID, alarm condition, and the probable cause code for the alarm. Event reports will show all the devices under the models that you select during the report generation process. All data is extracted from the Events database. Report Generator User s Guide Page 20

21 Introduction To the Report Generator Inventory Reports Report Types Inventory Reports provide cumulative model type data within a view or within a landscape. For models that are multi-slot devices, such as hubs, you can also get a detailed inventory report. This detailed report will give you data on the individual interfaces and boards in your multi-slot device as well as reporting on the device itself. An inventory report can provide data on both hardware and software. For Inventory Reports, the following variations of the report are available: Model Types Under The Landscape Lists inventory information for all selected model types under the landscape. Model Types Under A Model Lists inventory information for all selected model types under a model. Statistical Reports Statistical Reports provide you with information (load, packet rates, error rates, etc.) on the communications performance of the LANs and devices on your network. There is no limit to the data that can be collected in this report. All data is extracted from the Statistics database where device attributes of interest are logged. Up/Down Time Reports Up/Down Time Reports allow you to see when devices have lost contact and when the contact has been established. When SPECTRUM loses contact with the device, the device is considered down. When SPECTRUM is able to contact the device, the device is considered up. The report also calculates how long the device has been up or down. The report is generated by reading the Events database. It should be noted that the device Up/Down time can be calculated only when the VNM is active. See Up/Down Time Report - Special Event Cases for more information. Report Generator User s Guide Page 21

22 Introduction To the Report Generator Summary Up/Down Time Reports include the model type name, model name, model handle, down time, up time, down time duration, up time duration, and special events. The special events are the events that will affect the calculation of device Up/Down time duration. These events are discussed in Up/Down Time Report - Special Event Cases. Up/Down Time Reports also show the percent down time duration and percent up time duration. The reports will show all the devices under the current view, or current icon if an icon is selected. Summary The reports you can run with Report Generator are unlimited. You can create as many reports as you need for your network information base. Whatever reports you decide on, you make them by following the instructions in this guide. Figure 1 shows the general flow of operations in making a report. Figure 1: SPECTRUM Report Generation Reports Format Generate Display Report Formatter Use existing format Create new one from template Change an existing format Decide on: Format file to use Output directory Models Report output Time range Graphical Screen Print Tabular Screen Print Schedule the report Report Generator User s Guide Page 22

23 Reporting Fundamentals This section describes how to start the Report Generator and become familiar with Report Generator features. Overview This section introduces the Report Generator basics. It describes the contents of the Generate window and how to work with some of the functions in the Format window, such as: Opening the Report Generator and identifying the contents of the Report Generator Window (see Opening the Report Generator). Identifying the contents of the Report Formatter Window (see The Report Formatter Window). Making changes to the regions of a report format (see Working In a Region). Working with dialog boxes (see File Selection Dialog Box). Using keyboard shortcuts (see Using Keyboard Shortcuts). Using long model names (see Long Model Names). Using extended decimal places (see Extended Decimal Places). Changing the date and time format (see Time Formats). Quitting the Report Generator (see Quitting Reports). Opening the Report Generator You invoke the Report Generator by selecting Reports from the SpectroGRAPH Tools menu, and then selecting the Generate option from the Reports menu. When you make these selections in a single SpectroSERVER environment, the Report Generator main window then displays (see Figure 2). Report Generator User s Guide Page 23

24 Reporting Fundamentals Selecting a SpectroSERVER The Report Generator Main Window In a multiple SpectroSERVER environment, after you have selected the Reports Generator option, a popup window appears which contains a list of available SpectroSERVERs. Select a SpectroSERVER, then click on the OK button. The Report Generator main window then displays (see Figure 2). The Report Generator Main Window Figure 2 shows the contents of the Report Generator main window. The contents in this window change when you select a Report Type. For each Report Type, you select the information that lets you build your report. Figure 2: The Report Generator Main Window Report Generator User s Guide Page 24

25 Reporting Fundamentals The Report Generator Main Window The Report Generator main window contains selections that apply to most report types (exceptions are noted). For more details on these selections, see the sections Quick Start through Up/Down Time Reports. Landscapes Models Report Format Output File This button lets you choose the preferred list of landscapes that you will wish to select models from. This acts as a filter on the model types that appear in the Model Selection Dialog Box. This button lets you select model(s) for your report. This button is grayed out for Alarm reports because alarms are reported on all models. For Inventory reports, this button is replaced by a Model Types button. This button lets you choose a format file for your report. The format file determines what attribute data is placed in your report and how it will be arranged. This button lets you specify the directory path and the output name of your report. The Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output Note: In order for Report Generator to produce GIF output, your system administrator must first perform the steps listed in Using Report Output in HTML Pages. Report Generator User s Guide Page 25

26 Reporting Fundamentals The Report Generator Main Window Post Generate Script This button displays a file selection dialog box. You can select a file that contains a post generate script to be invoked following the successful completion of the report. On the NT platform, the file you specify must be a script file; on the Solaris platform, this file can be either a script file or a compiled executable file. Note: While using the Post Generate Script option with Reports, the.prm file will remain in the $SPECROOT/report.output/ directory until it is deleted by the user, or moved to another directory. Data Range The Data Range option lets you specify a time range for extracting the data for your report. The options are: Custom -- Lets you specify start and end dates and times for which data should be reported. Day -- Reports data from the previous calendar day (00:00:00 to 23:59:59) from the date of report execution. For example, if your report is executed on May 21, data from the events database from May 20 at 00:00:00 to 23:59:59 is reported. Week -- Reports data from the previous seven calendar days from the date of execution from 00:00:00 of the first day to 23:59:59 of the last day. For example, if your report is executed on Wednesday, May 24, 2000, data is reported from Wednesday, May 17 at 00:00:00 to Tuesday, May 23 at 23:59:59. Month -- Reports data from the previous calendar month from the date of execution, from the first day Report Generator User s Guide Page 26

27 Reporting Fundamentals The Report Generator Main Window Report Depth Site Name of the month at 00:00:00 to the last day of the month at 23:59:59. For example, if your report is executed on May 21, data will be reported from April 1 at 00:00:00 to April 30 at 23:59:59. Data Range applies only to Event, Statistical, and Up/Down Time reports. These report types are historical in nature, so a range of time for data extraction must be specified. Other report types use Now as the implied data range. For Inventory reports, the Report Depth option lets you specify the level of detail (see Inventory Reports). For Inventory reports, you can type the name for your site that you are reporting on (optional). You can select this icon (hereafter referred to as the Generate icon) from the toolbar after enough information to generate your report has been entered through the Report Generator main window. Clicking on this icon runs the report immediately. Output Format You can select this icon (hereafter referred to as the Schedule icon) from the toolbar after enough information to generate your report has been entered through the Report Generator main window. Clicking on this icon opens the Scheduler from which you can choose to have the report run at a specified time or at time intervals in the future. (For more details, see Scheduling Reports.) This section lets you specify one or more of the following types of output for your report: Graphical display ASCII tabular PostScript Report Generator User s Guide Page 27

28 Reporting Fundamentals The Report Generator Main Window File Applications Help GIF.Comma Delimited ASCII See Displaying Reports for more information. Select Generate to generate your report, Schedule to schedule your report, or Close from the File menu to return to the SpectroGRAPH user interface. Select Report Formatter from the Applications menu to enter the Report Formatter. Select Reports Display from the Applications menu to enter the Display feature of Report Generator. Select User s Guide from the Help menu to display an online copy of this manual. Specifying Landscapes If you wish to change the selections that appear by default in the Landscapes field, press the Landscapes button. The Landscapes dialog box shown in Figure 3 appears. Report Generator User s Guide Page 28

29 Reporting Fundamentals Figure 3: The Report Generator Main Window Landscapes Dialog Box Select the preferred landscape(s). If you do not wish to automatically expand your preferred landscapes upon selection of a model type when in a model selection window (see Specifying Models for a Report), toggle off the Automatically Expand Preferred Landscapes button. Press OK to return to the updated Report Generator main window. Note: SPECTRUM Report Generator now lets you report on data from more than one landscape. However, be careful to ensure that reports will not cause a substantial drain on system resources, or require an inordinate amount of time. Specifying Models for a Report You specify the models for an Event, Statistical, or Up/Down Time report by selecting Models from the Report Generator main window. The resulting Model Selection dialog box is shown in Figure 4. This dialog box Report Generator User s Guide Page 29

30 Reporting Fundamentals The Report Generator Main Window lists all the model types that have been instantiated in your preferred landscapes. Note: In Statistical and Events reports dialog boxes, model names followed by a (D) indicate models that have been deleted from the SPECTRUM modeling database. They will be visible only to users with Admin 0 privileges, for as long as Statistical and Events data for those models exist. Figure 4: Models Dialog Box To make selections from this dialog box follow these steps: Report Generator User s Guide Page 30

31 Reporting Fundamentals The Report Generator Main Window 1 In the Model Types/Models list, double click on each model type for which you want to report on. (For Statistical reports, you can only select one model type.) When you double click on a model type, a list appears underneath it that contains, for each landscape you have selected in the Landscape Dialog box, all models for that model type (see Figure 5). If you toggled off Automatically Expand Preferred Landscapes (see Specifying Landscapes), you will only see a list of landscapes. Double click on a landscape name to expand the list of models. Figure 5: Model Types/Models List 2 Select the model(s) for which you want to report on by clicking once on them. You can select as few or as many models as you want, but Report Generator User s Guide Page 31

32 Reporting Fundamentals The Report Generator Main Window you must select at least one. If you wish to select all models of the expanded model type within a landscape, click on the landscape. If you wish to select all models across all landscapes, click on the model type. 3 When you have made all the selections for your report, click OK to return to the Report Generator main window. Note: If you as a SPECTRUM user are not modeled in a secondary landscape but want to obtain models from that landscape, you must add a user model for yourself in that landscape, close the Report Generator, and start it back up again. Specifying Several Models You can use the Multiple Select feature of SPECTRUM to specify several models for your report before you enter the Report Generator (see SPECTRUM Menus and SPECTRUM Views). Using Multiple Select To select several models of the same model type using Multiple Select, complete the following steps: 1 From a view, click on one of the model icons you want to include in your report. 2 Hold down the shift key and click on additional model icons (of the same model type for Statistical reports) until you have selected all of the models for your report. 3 Select the Reports submenu from the Tools menu. Specifying a Post Generate Script The Post Generate Script button lets you specify a script to be run when the associated report completes. The base name of the output file (i.e., minus the output type extension and date, if a scheduled report) is Report Generator User s Guide Page 32

33 Reporting Fundamentals The Report Generator Main Window passed as an input parameter to the script. This feature lets you perform certain actions or tasks that need to be done automatically after the report is generated (for example, automatically printing out the Reportsgenerated output). By default, SPECTRUM Report Generator runs post generate scripts only when data exists in the report. To force Report Generator to always run post generate scripts (even when there is no data): Edit the $SPECROOT/SG/rptscript file and uncomment (remove the hash marks before the first characters) of the following lines: #INVOKE_POSTGENSCRIPT_ALWAYS=1 #export INVOKE_POSTGENSCRIPT_ALWAYS When you next print your report, any applicable post generate scripts will be run. The following are two examples of such a script. The first script example prints out the tabular output from a non-scheduled report. #!/bin/sh # # This script will print the tabular output from a non-scheduled Report # # Input: The basic name of the output file # Output: Printed output - printed to printer "nlp2" # # define the printer # PRINTER="nlp2" # # Get the input file # P_FILE_BASE="$1" # # Add the TAB extension to the file # PRINT_FILE="$P_FILE_BASE.TAB" Report Generator User s Guide Page 33

34 Reporting Fundamentals The Report Generator Main Window # # Go ahead and print the file # This command may require modification depending upon which unix flavor # you are running. # lpr -P$PRINTER $PRINT_FILE The second script example prints the tabular output from a scheduled Report. #!/bin/sh # # This script will print the tabular output from a scheduled Report # This script assumes that the creation of the report output file and # the actual running of the script will occur on the same day. # # Input: The basic name of the output file # Output: Printed output - printed to printer "nlp2" # # # define the printer # PRINTER="nlp2" # # Get the input file # P_FILE_BASE="$1" # # Get the date and add it to the base # DATE=`date +%m.%d.%y` P_FILE_DATE="$P_FILE_BASE.$DATE" # # Add the TAB extension to the file # PRINT_FILE="$P_FILE_DATE.TAB" Report Generator User s Guide Page 34

35 Reporting Fundamentals The Report Formatter Window # # Go ahead and print the file. This command may require modification # depending upon which unix flavor you are running. # lpr -P$PRINTER $PRINT_FILE The Report Formatter Window You invoke the Report Formatter by selecting Reports from the SpectroGRAPH Tools menu, then selecting Format from the Reports menu. Figure 5 shows the contents of the Report Formatter Window. From this window you make selections to build a format for your report. You can create as many formats (called report format files) as you need for the report types that you work with. Once you create a unique report format file, it should be saved and not overwritten in the future. (See the Save As command in the next section, File Menu.) Report Generator User s Guide Page 35

36 Reporting Fundamentals The Report Formatter Window Figure 6: Regions of the Report Formatter Window File Menu The File menu contains the following selections: Template Select Template when you want to create a new report format file. You access a file selection box from which you select a template file for a particular report type: Alarm Report, Event Report, Inventory Report, Statistical Report, or Up/Down Time Report. For example, if you choose Alarm Report, you access a file selection box from which you select the Alarm template file (Alarm.temp). After you select the file and press OK, the Report Formatter main window is refreshed with the template. Please Report Generator User s Guide Page 36

37 Reporting Fundamentals The Report Formatter Window Open Save Save As Preview Close do this now, so you can follow the discussions in the next sections. Select Open to open an existing report format file. You access a file selection box from which you select a report format file for a particular report type. Select Save to save a newly-created report format file. Select Save As to save a modified report format file under a new name. Select Preview to view the output format. Select Close to exit the Report Formatter and return to the SpectroGRAPH user interface. Edit Menu The Edit menu contains the following selections that let you move items around in the format of your report: Cut Copy Paste Page Size Removes highlighted text and objects from the Report Formatter and places them in the clipboard. Objects are representations of data types and are displayed as <ATTR>, <FIXED>, or <STAT>. (See the sections on the following pages for more information on objects.) Duplicates highlighted text and objects from the Report Formatter and places them in the clipboard. Moves text and objects from the clipboard and places them at a designated location in the Report Formatter. Lets you choose values for Page Width and Lines Per Page for your report. Report Generator User s Guide Page 37

38 Reporting Fundamentals View Menu The Report Formatter Window The View menu contains the selections for viewing or hiding the specific regions of the Report Formatter. This lets you select which regions are viewed as you work. The menu selections have no effect on the format of the report. Format Menu The Format menu contains a Suppress Line Data toggle button. This option lets you create a compact report based only on the information contained in the Summary Data region of the report. The Line Data information that is processed will not appear in your report. The Regions Of a Report Format File The regions of a report format file (see Figure 6) are: Comments Report Header Column Header Line Data Summary Header Summary Data Note: The Comments region is optional and can be accessed from the View menu. It is used to enter notes about a report format file. This information does not appear in the output of the report. The regions correspond to the following buttons, selectable at the bottom of the window: Report Header This region contains descriptive text for your report heading and the <FIXED> and <ATTR> objects that represent keywords and attributes. Keywords in this Report Generator User s Guide Page 38

39 Reporting Fundamentals The Report Formatter Window Column Header Line Data Summary Header Summary Data region might be DATE (date of the report) and PAGE (page number(s) of the report). This region contains the text for column header information. Depending on the report type, this region may contain the <FIXED>, <ATTR>, and <STAT> objects that represent keywords, attributes and logged attributes respectively. This region contains the text for summary header information. Depending on the report type, this region may contain <FIXED> and <STAT> objects. As you click on these buttons, the corresponding region on the window becomes active and the blinking insertion cursor appears at the first position. You can also activate a region by simply clicking within the region with the mouse. Note: In each region, to access additional information (not presently visible) on the screen, either: (1) use the vertical scroll bars, (2) position the cursor to the left of the region and use the left directional key, or position the cursor to the right of the region and use the right directional key, or (3) resize the window. Exploring Buttons and Some Operations The buttons labeled Attribute, Statistic, and Fixed correspond to the data type objects, ATTR, STAT, and FIXED that you see in the edit areas. The Attribute data type lets you utilize information that is used in the network. The Statistic data type contains a subset of Attribute data types. Both ATTR and STAT represent information that you can obtain from a model. Report Generator User s Guide Page 39

40 Reporting Fundamentals The Report Formatter Window Attributes are the set of all information available. Statistics are the smaller group of information that you, as a SPECTRUM user, have set to be logged in the SpectroSERVER Statistics Log. Typically, these are attributes whose values change frequently. The Fixed data type gives access to derived information that is predefined within reports. Time and Page are examples of fixed data. The Sort button corresponds to an operation rather than a data type. The Sort function lets you order the rows of your output by one or more columns. The Sort button is active when there is at least one object in the Line Data or Summary Data regions. Before you can work with the contents of a region, you need to make that region active. For example, click in the report header region to make it active.when a region is active, the applicable buttons, Attribute, Statistic, Fixed, or Sort become available to the region. Note that the active or inactive status of these buttons depends on the report type and the region. Using the Buttons You can invoke the dialog boxes associated with the Attribute, Statistic, Fixed, or Sort buttons in any of the following ways. You can click on the button with the appropriate label. You can click on a <FIXED>, <ATTR>, or <STAT> object in a region. This action will highlight the corresponding button: Fixed, Attribute, or Statistic. You can then click on the button and bring up the dialog box. You can double-click on an object in a region. This will bring up the dialog box for the column location that you clicked in. You can click between fields which places a text insertion cursor ( ) there. Then click on the appropriate button. When you finish with the resulting dialog box and press OK, an object of that data type will appear where the text insertion cursor was. Report Generator User s Guide Page 40

41 Reporting Fundamentals Working In a Region The Report Formatter Window You can either examine the objects in the region and change their keywords or attributes, or you can create your own objects and assign the desired keywords or attributes. For example, note the Report Header region in Figure 7. Figure 7: Report Header Region Generic Statistical Report Templateee <FIXED> Date: <FIXED> Model Name: <ATTR> Internet Addr: <ATTR> Device Type: <ATTR> <FIXED> Examining an Object To examine an object and its keywords or attributes: Double-click on any <FIXED> object. A FIXED dialog box appears. This box lists all of the FIXED keywords for the Report Header region. The highlighted item represents the keyword corresponding to the selected object. Inserting a New Object To create an object and select keywords and attributes: 1 Place the cursor at the position where you want to specify, for example, Date, Page, or Model Name. The line and column numbers in the Line and Column fields show you where the text or data type entries will appear in a printed tabular report. The line number is only relevant in the Report Header or Column Header regions. 2 Select FIXED, ATTR, or STAT. 3 Select an item from the dialog box. Report Generator User s Guide Page 41

42 Reporting Fundamentals The Report Formatter Window 4 Click OK. The data type object appears at the location. 5 Create more data type objects, as appropriate in the region. Note: When you create or modify an attribute object make sure that enough space exists for all possible values of the attribute, especially if the attribute is close to the end of a line. Failure to do so may cause the data in that attribute to become corrupted. Verifying the Appearance of Your Work To verify the position of the text or data type objects you have placed in the Report Header region, pull down the File menu and select Preview. The screen shows the format of your report format file without data. As you enter and/or modify text and objects in a region, the corresponding format of the output is dynamically updated on the Preview screen. To view additional information (not presently visible) on the Preview screen, do one of the following: Use the vertical scroll bars. Position the cursor to the left of the screen and use the left directional key, or position the cursor to the right of the screen and use the right directional key. Resize the window. Press CANCEL to return to the Report Formatter window. Selecting Text or an Object To select text: 1 Click to position the insertion point at the beginning of the text. 2 Hold down the left mouse button as you drag to select the text. The selected text is highlighted on the screen. To select an object, click on the object. Report Generator User s Guide Page 42

43 Reporting Fundamentals The Report Formatter Window Copying Text or Objects Copying text or an object leaves it in its original location, but places a copy on the Clipboard so you can paste it in a different location. To copy text or an object, select it and choose Copy from the Edit menu. Cutting Text or Objects Cutting text or an object removes it from the region and places it in the Clipboard so you can paste it in a different location. To cut text or an object, select it and choose Cut from the Edit menu. Pasting Text or Objects To paste text or an object from the Clipboard, put the insertion point where you want the text to go. Then choose Paste from the Edit menu. If the pasted object contains assigned keywords or attributes, they are also pasted. Copying Text and Objects: a Quick Way In addition to the Cut, Copy, and Paste functions, the Report Formatter has a drag-and-drop editing feature. With drag-and-drop, you can use the mouse to drag a selection text or objects to a new location in the same region of the Report Formatter. To use drag and drop: 1 Select the text or object by highlighting it. 2 Press the second (or middle) mouse button over the selection. A small arrow and text symbol appears. 3 Drag the selection to a new location. 4 Release the mouse button where you want to drop or insert it. Working With Templates The Report Generator comes with several predefined report format files. If you don t find a predefined report format file of the report type needed, you will need to use the templates as a starting point. The templates you Report Generator User s Guide Page 43

44 Reporting Fundamentals Working With Dialog Boxes see in the Report Formatter make it easy to produce reports with a consistent style. The Report Formatter comes with Aprisma-designed templates that you can use for all types of reports. When you use a template to create a report, the template determines: The layout, including page size, number of columns, column margins, and headings Special text, keywords, and objects As you will learn in later sections, you can customize the templates included with the Report Formatter to suit your particular needs. Working With Dialog Boxes The procedures for selecting items from dialog boxes are generally common to many dialog boxes. Let s look at some examples. File Selection Dialog Box To access a file selection dialog box, click Report Format from the Report Generator main window. A dialog box similar to the one in Figure 8 appears. Report Generator User s Guide Page 44

45 Reporting Fundamentals Figure 8: File Selection Dialog Box Working With Dialog Boxes The Report Generator lets you select or specify an item in a dialog box in several ways. To select a report format file from the dialog box shown in Figure 8: a b In the Directories column, double-click on the directory that contains report format files for the type of report you want to create. The directory name is appended to the subdirectory in the Selection field, and a list of report format files appears in the Files column. Do one of the following: Position your mouse pointer after the last character in the Selection field, click your mouse button, type the file name, and press OK (or ENTER from the keyboard). Report Generator User s Guide Page 45

46 Reporting Fundamentals Working With Dialog Boxes Single-click on the file name in Files. The file name is appended to the subdirectory in the Selection field. Press OK. To specify a different directory, type the appropriate filter name in the Filter field, click on the Filter button, and navigate to the correct directory in the Directories column. Also, you can navigate through directories by double-clicking on the directory you want to examine. These procedures for selecting a file also apply to the Event Codes and Output File dialog boxes. Selecting an Item With the Search or Filter Methods In the previous section you learned how to select an item by clicking on it. Here you will learn how to select an item from dialog boxes that contain a long list of items. Let s try an example. Click on Models from the Report Generator main window to access a Model Selection dialog box (see Figure 9). Report Generator User s Guide Page 46

47 Reporting Fundamentals Working With Dialog Boxes Figure 9: Searching for Model Types and Models The Report Generator lets you quickly select an item in certain dialog boxes (the Models dialog box is an example) by using the Search or Filter operations. (Clicking on the flashlight icon in the lower right corner of the model type list activates or deactivates the Search/Filter button.) With Search, you type the name or the first few characters of the item you are searching for in the list. As you type characters, the listing in the selected list box immediately scrolls and that item (or the closest match) appears at the top of the list. With Filter, you type the name or a character string contained in the item you are searching for. As you type characters, all items in the listing that do not contain the characters are temporarily deleted (see Figure 10). Unlike a search operation, the characters you are filtering on do not have to be at the beginning of an item. Report Generator User s Guide Page 47

48 Reporting Fundamentals Using Keyboard Shortcuts By default, Search and Filter operations are case sensitive. To specify a case insensitive operation, toggle the Case Sensitive button. The Filter/ Search operations are available with the following dialog boxes that have a long list of items: Models Landscapes Model Types (note that the Filter/Search operations work on the model types portion of the model types/models list only) Figure 10: Using Filter to Find Model Types (Case Sensitive) Using Keyboard Shortcuts The Report Generator keyboard shortcuts vary from platform to platform because of each platform s conventions and available keys. For a list of keyboard shortcuts, see your platform documentation. Report Generator User s Guide Page 48

49 Reporting Fundamentals Other Display Options Many commands that you choose from menus can also be given using keyboard shortcuts. A keyboard shortcut is a combination of keys that you press simultaneously to get the same results as choosing the command from the menu using the mouse. For example, instead of choosing Save from the File menu of the Report Formatter by using the mouse you could press F10 first, then the ALT-F keys followed by the S key. Usually, it is the same combination of the ALT key and a letter. This letter is called a mnemonic and is indicated by an underline. For example, the mnemonic in Save As is the letter A. Other Display Options This section describes some display options available with SPECTRUM Report Generator. Long Model Names To enable SPECTRUM Report Generator to correctly display long model names you must modify the REPORT_MODEL_NAME_LEN variable in the rptscript file, found in the $SPECROOT/SG directory. It is set to 16 by default the value can be increased up to 1024 to allow for long model names. The rib file for your report must also be modified with sufficient column width to support long model names. This is done within The Report Formatter Window (see Edit Menu). Tip: If landscape names appear truncated in the generated reports, then you must modify the REPORT_MODEL_NAME_LEN variable to an appropriate value to accommodate the names. Extended Decimal Places To enable SPECTRUM Report Generator to correctly display values that extend beyond two decimal places you must modify the Report Generator User s Guide Page 49

50 Reporting Fundamentals Quitting Reports DECIMAL_POSITION variable in the rptscript file, found in the $SPECROOT/SG directory. Valid arguments for this variable range from 2 to 6 it is set to 2 by default. For values that extend beyond 6 decimal places, set the DECIMAL_POSITION variable to 6. Time Formats SPECTRUM Report Generator, by default, displays dates and times in the standard MM/DD/YYYY time format. You can, however, configure Report Generator to display displays dates and times in the European DD/MM/ YYYY time format. To do so: Edit the $SPECROOT/SG/rptscript file and uncomment (remove the hash marks before the first characters) of the following lines: - #EUROPEAN_DATE_TIME=1 - #export EUROPEAN_DATE_TIME When you next print your report, dates and times will be displayed in the European DD/MM/YYYY time format. Quitting Reports If you need to stop working from any of the main windows of the Report Generator, choose Close from the File menu. Alternately, you can exit from the Report Formatter by clicking on the right mouse button. Canceling out of a dialog box closes the box as well as any entries that you may have opened using that box. Click OK if you wish to exit the dialog box and save your changes; click Cancel if you do not wish to save your changes. If you choose Close from the Report Formatter and formats are open that haven t been saved, the Report Formatter asks you if you want to continue quitting. Click Yes to close the format without saving changes. Report Generator User s Guide Page 50

51 Quick Start This section provides a tutorial for using the Report Generator, and introduces you to the basics of running your first report. In This Section Creating an Alarm Report Creating an Event Report Creating an Inventory Report Creating a Statistical Report Creating an Up/Down Time Report Creating an Alarm Report Alarm Reports can provide a concise picture of all the current problems on your network, or give more specific information on one network problem. Create an Alarm Report by following these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Alarm for the Report Type. The main window shows the selections for an Alarm Report (see Figure 11). Report Generator User s Guide Page 51

52 Quick Start Figure 11: Creating an Alarm Report The Report Generator Main Window (Alarm Report) 3 Select Landscapes. Choose the landscape(s) you want to report on from the Landscapes dialog box. See Specifying Landscapes. 4 Click on Report Format. Choose the file Alm_Active.rib and press OK. 5 Click on Output File. Enter the filename alarm to the end of the of the selection text and click on the OK button. 6 In the Output Format section, choose Graphical Display and Tabular ASCII. Report Generator User s Guide Page 52

53 Quick Start Creating an Alarm Report 7 Select Alarm Filters. Click on some alarm conditions from the Filter On Alarm Conditions selections. 8 Click on the Generate icon from the toolbar. When the generation process is complete, you will see an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) in a popup dialog box as long as the Report Generator Main Window is still displayed. The dialog box header contains message-specific information. After the report is completed, you can go into Applications>Reports Display to look at the report (from the Display Type screen, click on the Tabular button, select the file alarm.tab, and click on the Display button). The report will look similar to the one shown in Figure 12. Figure 12: Alarm Report Spectrum Active Alarms Report Page : 1 Date: 02/28/ :40:22 Landscape ID: 0x Model Name Model Type Name Mdl Hdl CRITICAL MAJOR MINOR MAINTENANCE SUPPRESSED INITIAL Totals Transparent Transparnt_App 0x50079c MIB-II SNMP2_Agent 0x UDP UDP2_App 0x trlnm7 GnSNMPDev 0x MIB-II SNMP2_Agent 0x50055b Hub_CSI_TRMM 0x5002e armonk Host_IBM 0x5005f GnSNMPDev 0x5004ff Network A CSIRptr 0x50069a trlnm1 GnSNMPDev 0x GnSNMPDev 0x50063e Gen Bridge App Gen_Bridge_App 0x cross8 GnSNMPDev 0x Report Generator User s Guide Page 53

54 Quick Start Creating an Event Report Model Name Model Type Name Mdl Hdl CRITICAL MAJOR MINOR MAINTENANCE SUPPRESSED INITIAL Totals Hub_CSI_TRMM 0x5004d ncaa Host_IBM 0x GnSNMPDev 0x5004f Source Routing Source_Rt_App 0x5008f UDP UDP2_App 0x cross1 Hub_CSI_TRMM 0x50050f Repeating CSIRptr 0x500aaa IP IP2_App 0x50054e UDP UDP2_App 0x5005e alton Host_SGI 0x Gen Bridge App Gen_Bridge_App 0x rtr_test8 HubCSIEMME 0x Hub_CSI_TRMM 0x50050d IP IP2_App 0x50079f Network A CSIRptr 0x500a9f MIB-II SNMP2_Agent 0x5006b sanjuan Host_IBM 0x5003d Hub_CSI_IRM2 0x Gen Bridge App Gen_Bridge_App 0x5008f Spanning Tree Span_Tree_App 0x50079d GnSNMPDev 0x50042f dublin Host_IBM 0x5004b Hub_CSI_TRMM 0x ICMP ICMP_App 0x50054a Source Routing Source_Rt_App 0x Transparent Transparnt_App 0x5005dc Hub_CSI_TRMM 0x5004ee GnSNMPDev 0x5004f IP IP2_App 0x Totals: Creating an Event Report Event Reports provide you with a history of the behavior of a given model or group of models. You can also use this report to examine one particular Report Generator User s Guide Page 54

55 Quick Start Creating an Event Report behavior. Event Reports may also be tailored to look at several event codes that were triggered on a list of models. In addition, Event Reports can also generate reports on alarms over a specified time range. This gives you a historical view of your alarms, in contrast to an Alarm Report that reports on currently active alarms only. Create an Event Report by following these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Event for the Report Type. The main window shows the selections for an Event Report (see Figure 13). Figure 13: The Report Generator Main Window (Event Report) Report Generator User s Guide Page 55

56 Quick Start Creating an Event Report 3 Select Landscapes. Choose the landscape(s) you want to report on from the Landscapes dialog box. See Specifying Landscapes. 4 Select Models. Double click on several model types in the Model Types/Models list, then (if you have landscapes set to automatically expand) click on several models. Click on the OK button to finish Models selection. See Specifying Models for a Report. 5 Click on Report Format. Choose the file Evt_Msg.rib and click on the OK button. 6 For a Data Range choose Week. 7 Click on Output File. Enter the filename event in the selection text and click on the OK button. 8 In the Output Format section, choose Tabular ASCII. 9 Click on the Generate icon in the toolbar. When the generation process is complete, you will see an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) in a popup dialog box as long as the Report Generator Main Window is still displayed. The dialog box header contains message-specific information. After the report is completed, you can go into Applications>Reports Display to look at the report (from the Display Type screen, click on the Tabular button, select the file event.tab, and click on the Display button). The report will look similar to the one shown in Figure 14. Figure 14: Event Report Spectrum Event Messages Report Page : 1 From Thu Jan 20 0:00: To Wed Jan 26 13:41: Date: 02/28/ :49:45 Model Name: brazil Device Type: Host_IBM LandScape ID: 0x Poll Time Event Message 02/28/ Report Generator User s Guide Page 56

57 Quick Start Creating an Inventory Report 10:48:04 Wed 26 Jan, :48:04 - Contact has been lost with device brazil of type Host_IBM. (event [ ]) 10:48:58 Wed 26 Jan, :48:58 - Device brazil of type Host_IBM has been contacted. (event [ ]) Model Name Model Type Name Mdl Hdl CRITICAL MAJOR MINOR MAINTENANCE SUPPRESSED INITIAL Others Totals brazil Host_IBM 0x Totals: Creating an Inventory Report Inventory Reports provide an efficient way of getting an account of what model types exist on your network. This report will help facilitate asset management. For example, you may want a listing of all the SGI workstations on your local network. Create an Inventory Report by following these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Inventory for the Report Type. The main window shows the selections for an Inventory Report (see Figure 15). Report Generator User s Guide Page 57

58 Quick Start Figure 15: Creating an Inventory Report The Report Generator Main Window (Inventory Report) 3 Select Landscapes. Choose the landscape(s) you want to report on from the Landscapes dialog box. See Specifying Landscapes. 4 Select Model Types. In the Model Type Selection dialog box, click on a landscape in the Landscape list. Click on Host_SGI in the Model Types list and click on the OK button. 5 Select Report Format. Choose the file Invt_All.rib and press OK. 6 Select Output File. Enter the filename inventory in the selection text and then click the OK button. 7 In the Output Format section, select Tabular ASCII. 8 Accept the default for the Site Name field. The site name could be used to identify the name of the SPECTRUM installation (site) where the report is run. Report Generator User s Guide Page 58

59 Quick Start Creating an Inventory Report 9 For Report Depth, select General. 10 Click the Generate icon in the toolbar. When the generation process is complete, you will see an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) in a popup dialog box as long as the Report Generator Main Window is still displayed. The dialog box header contains message-specific information. After the report is completed you can go into Applications>Reports Display, and select Tabular from the Display Type screen to look at the report. The report will look similar to the one shown in Figure 16. Figure 16: Inventory Report Spectrum Network Inventory Report Page : 1 Date: 04/30/ :17:07 LandScapeID:0x User Name: root Site Name: Default Site Model Type Total Number of Models Number of Active Models Number of Inactive Models Host_SGI Totals: Model Type Model Name IP Address Network Address Create Date Contact Last Contacted View Info Host_SGI falcon C.15 04/30/ :11ESTB 04/30/ :09/merlan/falcon Host_SGI fire C.4.E /30/ :13ESTB 04/30/ :09/merlan/fire Host_SGI hamlet /30/ :19ESTB 04/30/ :09/merlan/hamlet Host_SGI scotty B.7C.B6 04/30/ :11ESTB 04/30/ :08/merlan/scotty Host_SGI spikelee /30/ :17ESTB 04/30/ :09/merlan/spikelee Host_SGI storm /30/ :17ESTB 04/30/ :08/merlan/storm Host_SGI sunbird /30/ :14ESTB 04/30/ :09/merlan/sunbird Host_SGI tyr /30/ :15ESTB 04/30/ :09/merlan/tyr Host_SGI wiz B.4A.7A 04/30/ :12ESTB 04/30/ :09/merlan/wiz Host_SGI zero /30/ :14ESTB 04/30/ :09/merlan/zero Host_SGI alton F.9D 04/30/ :20ESTB 04/30/ :09/merlan/alton Host_SGI bmw AA /30/ :21ESTB 04/30/ :09/merlan/bmw Host_SGI calvin /30/ :22INIT 04/30/ :00/merlan/calvin Host_SGI cuba /30/ :24INIT 04/30/ :00/merlan/cuba Host_SGI dagger AA B.4 04/30/ :22ESTB 04/30/ :09/merlan/dagger Report Generator User s Guide Page 59

60 Quick Start Creating a Statistical Report Create a Statistical Report by following these steps: Creating a Statistical Report 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Statistical for the Report Type. The main window shows the selections for a Statistical Report (see Figure 17). Figure 17: The Report Generator Main Window (Statistical Report) 3 Select Landscapes. Choose the landscape(s) you want to report on from the Landscapes dialog box. 4 Select Models. Double click on a model type in the Model Types/ Models list (for instance, Hub_CSI_IRM2 ), then (if you have Report Generator User s Guide Page 60

61 Quick Start Creating a Statistical Report landscapes set to automatically expand) click on several models. Click on the OK button to finish Models selection. See Specifying Models for a Report. 5 Select Report Format. Choose the file Hub_CSI_IRM2/ IRM2_MMAC.rib from the File Selection box and click the OK button. 6 For a Data Range choose Day. 7 Select Output File. Enter the filename statistical in the selection text and click the OK button. 8 In the Output Format section, select Graphical Display. 9 Click the Generate icon in the toolbar. When the generation process is complete, you will see an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) in a popup dialog box as long as the Report Generator Main Window is still displayed. The dialog box header contains message-specific information. After the report is completed, you can go into Applications>Reports Display to look at the report (from the Display Type screen, click the Graphical button, select the file statistical.grf, and click the Display button). The report will look similar to the one shown in Figure 18. Report Generator User s Guide Page 61

62 Quick Start Creating an Up/Down Time Report Figure 18: Graphical Statistical Report 600 Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate /27/ :00 13:00 17:00 18:40 13:40 17:40 20:20 01/27/ :20 Creating an Up/Down Time Report Create an Up/Down Time Report by following these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Up/Down Time for the Report Type. The main window shows the selections for an Up/Down Time Report (see Figure 19). Report Generator User s Guide Page 62

63 Quick Start Figure 19: Creating an Up/Down Time Report The Report Generator Main Window (Up/Down Time Report) 3 Select Landscapes. Choose the landscape(s) you want to report on from the Landscapes dialog box. 4 Select Models. Double click on several model types in the Model Types/Models list, then (if you have landscapes set to automatically expand) click on several models. Press OK to finish Models selection. See Specifying Models for a Report. 5 Select Report Format. Select the file UpDown.rib and press OK. 6 For a Data Range choose Custom. When the Data Range dialog box appears: 7 Set the Start Date and End Date: Report Generator User s Guide Page 63

64 Quick Start Creating an Up/Down Time Report 8 Pull down the Month menu and select a month. 9 Click the Up or Down button next to the Day and Year to increment or decrement the settings for the day and year. 10 Set the Start Time and End Time by clicking the Up or Down button next to the Hours and Minutes to increment or decrement the settings. 11 Click the OK button. 12 In the Output Format section, choose Tabular ASCII. 13 Select Output File. Enter the filename updown in the selection text and press OK. 14 Click the Generate icon in the toolbox. When the generation process is complete, you will see an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) in a popup dialog box as long as the Report Generator Main Window is still displayed. The dialog box header contains message-specific information. After the report is completed, you can go into Applications>Reports Display to look at the report (from the Display Type screen, click the Tabular button, select the file updown.tab, and then click the Display button). The report will look similar to the one shown in Figure 20. Report Generator User s Guide Page 64

65 Quick Start Creating an Up/Down Time Report Figure 20: Up/Down Time Report Spectrum Device Up/Down Time Report Page : 1 Date: 01/13/ :56:02 From Thu Jan 06 9:00: To Mon Jan 10 9:00: Model Name: Device Type: Landscape ID: Unplaced Unplaced 0x Model Type Model Name Mdl Hdl Lost Time Contacted Time Down Time Up Time Special Event Host_IBM warren 0x /08/ :42: :00:00:00 001:05:42:33 VNM Started at 01/08/ :38:53 Host_IBM warren 0x /08/ :42:33 01/08/ :47:03 000:00:04:30 000:00:00:00 Host_IBM warren 0x /10/ :33:43 01/08/ :47:03 000:00:00:00 001:19:46:40 Host_IBM warren 0x /10/ :33:43 01/10/ :34:43 000:00:01:00 000:00:00:00 Host_IBM warren 0x /10/ :34:43 000:00:00:00 000:22:25:17 Host_DEC m2ltx8 0x /09/ :28: :00:00:00 002:02:28:15 Host_DEC m2ltx8 0x /09/ :28:15 01/09/ :29:15 000:00:01:00 000:00:00:00 Host_DEC m2ltx8 0x /09/ :29:15 000:00:00:00 001:21:30:45 Host_IBM prism 0x68001d 01/10/ :55: :00:00:00 003:08:55:50 Host_IBM prism 0x68001d 01/10/ :55:50 01/11/ :36:08 000:13:40:18 000:00:00:00 Host_IBM prism 0x68001d /11/ :36:08 000:00:00:00 000:01:23:52 Host_IBM acorn 0x /10/ :36: :00:00:00 003:06:36:24 Host_IBM acorn 0x /10/ :36:24 01/10/ :38:33 000:00:02:09 000:00:00:00 Host_IBM acorn 0x /10/ :38:33 000:00:00:00 000:17:21:27 Host_IBM iron 0x /11/ :32: :00:00:00 003:23:32:03 Host_IBM iron 0x /11/ :32:03 01/11/ :33:03 000:00:01:00 000:00:00:00 Host_IBM iron 0x /11/ :33:03 000:00:00:00 000:00:26:57 Host_IBM amosk 0x /09/ :49:54 002:01:49:54 000:00:00:00 Host_IBM amosk 0x /09/ :55:01 01/09/ :49:54 000:00:00:00 000:06:05:07 Host_IBM amosk 0x /09/ :55:01 01/10/ :14:17 000:15:19:16 000:00:00:00 Host_IBM amosk 0x /10/ :56:36 01/10/ :14:17 000:00:00:00 000:08:42:19 Host_IBM amosk 0x /10/ :56: :16:03:24 000:00:00:00 Report Generator User s Guide Page 65

66 Quick Start Creating an Up/Down Time Report Host_SGI coffee 0x /09/ :44: :00:00:00 002:07:44:26 Host_SGI coffee 0x /09/ :44:26 01/09/ :48:44 000:00:04:18 000:00:00:00 Host_SGI coffee 0x /09/ :48:44 000:00:00:00 001:16:11:16 ModelType Model Name Mdl Hdl Down Time Duration Up Time Duration % Down Time % Up Time Host_IBM warren 0x :00:05:30 003:23:54: Host_DEC m2ltx8 0x :00:01:00 003:23:59: Host_IBM prism 0x68001d 000:13:40:18 003:10:19: Host_IBM acorn 0x :00:02:09 003:23:57: Host_IBM iron 0x :00:01:00 003:23:59: Host_IBM amosk 0x :09:12:34 000:14:47: Host_SGI coffee 0x :00:04:18 003:23:55: Totals: 003:23:06:49 024:00:53: Report Generator User s Guide Page 66

67 Alarm Reports This section discusses how to create and customize an Alarm Report. Overview The Generate feature of the SPECTRUM Report Generator lets you create reports about current active alarms on the network. Active alarms are those that have not yet been acknowledged or cleared. See the SPECTRUM manual Modeling with the GnSNMPDev Toolkit for more information on alarms. An alarm report provides the following information on the active alarms in the network: Date/time stamp Model type name Model name Model handle Alarm ID Alarm condition Alarm cause Topological view path In addition, a table is appended to the end of an alarm report that lists only the relevant probable causes for each active alarm and the recommended corrective actions. The procedure for generating an alarm report involves making selections in the Report Generator main window. For example, you can select: The report format you want to use. The output of the report. The file name and path location for the report. The types of alarms you want to report on. Report Generator User s Guide Page 67

68 Alarm Reports Overview When and how often you want to run the report. After you have made all your choices, you are ready to run your report. You can have the report run immediately or schedule it for a convenient time and frequency in the future. Starting the Report Generator To start the Report Generator, you complete these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Alarm as the Report Type. The main window shows the selections you must choose for an Alarm Report (see Figure 21). Figure 21: Alarm Report Main Window Report Generator User s Guide Page 68

69 Alarm Reports Specifying Landscapes Specifying Landscapes From the Alarm Report main window, press Landscapes to display the Landscape dialog box. This dialog box lets you select the landscapes for which you want information. To select landscapes, click once on each landscape that you want to select. Then, click OK to return to the Alarm Report main window. Note that running an alarm report on multiple landscapes is like running separate reports on each landscape and then stapling them together; as a result, the alarm report will contain multiple probable cause sections. See Specifying Landscapes for more details. Specifying a Report Format File You can use an already configured report format file to define the output format of your report. To do this, press Report Format from the Alarms Report main window to display the Choose Report Format File dialog box. In this dialog box, navigate to the directory that contains the Alarms report format files (SG-Support/CsRib by default), then select a file. When you select a report format file, click OK and the name of the file appears in the Report Format field of the Alarms Report main window. You can also use the Report Formatter to modify an existing format or create a new one using the event template. See Customizing an Alarm Report. Specifying a Report Output File Name The Output File field identifies your report with a file name and path location. If you want to change it, press Output File to display the Output File dialog box. This dialog box lets you specify the path and file name for the report. If you do not specify a file name for the output file, you cannot generate a report. Report Generator User s Guide Page 69

70 Alarm Reports Specifying the Viewing Output When you press OK, the Alarm Report main window appears with the path and file name in the Output File field. Note that the Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output.csv for comma delimited ASCII. Specifying the Viewing Output From the Alarms Report main window, specify how your report will be viewed by selecting one or more of the following items in the Output Format section: Tabular ASCII Tabular PostScript Graphical Display Graphical PostScript Graphical GIF Common Delimited ASCII To create the report as columns of data. To create the report as a tabular PostScript file. To create the report as a graph. Depending on your data, the default graph will usually be a column graph. You can change it later to another graph type when you display it. To create the report as a graphical PostScript file. To create the report as a graphical GIF file. This GIF can then be incorporated into an HTML page; see Using Report Output in HTML Pages for details. To create a report as a tabular, common delimited, ASCII file that can be openend in Microsoft Excel or Sun s Star Office. Report Generator User s Guide Page 70

71 Alarm Reports Specifying Filter Criteria Specifying Filter Criteria For an Alarm Report, press the Alarm Filters button to display the Filter On Alarm Conditions dialog box. Conditions are activated by pressing the appropriate button. The conditions are as follows: Critical SPECTRUM has lost contact with the device. Major The model has had a major alarm and is at the second level of marginal operation. Minor The model has a minor alarm and is at the first level of marginal operation. Suppressed The status of the model is not known. SPECTRUM could not reach the model because of an error in another model. Initial Initial condition. Maintenance The device is in maintenance mode. All Alarms All the alarms (this is the default). Where Do You Go From Here? You are now ready to run your report by simply clicking on the Generate icon in the toolbar. It may take a short amount of time, depending upon the information to be gathered for the report. If you keep the Report Generator Main Window up, an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) appears in a popup dialog box when the report is complete. Note: The default.rib file, Alm_Active.rib, does not contain the VIEWPATH attribute. This reduces the time required to generate alarm reports against large numbers of models. If you create a custom.rib file that includes the VIEWPATH attribute, and then use it to generate reports against large numbers of models, report generation may take increased time to complete. Report Generator User s Guide Page 71

72 Alarm Reports Customizing an Alarm Report To see what your report looks like, select Reports Display from the Applications menu. See Displaying Reports for detailed instructions. You use Generate to get an indication of what a report will look like for your network needs. When you are satisfied with the appearance and the information in your report you may want to run it at a regular interval. To schedule your report to run at a later time or at a regular interval, click on the Schedule icon in the toolbar. See Scheduling Reports for detailed instructions. Customizing an Alarm Report You can create a customized look for your report with the Report Formatter. What you do depends on what data you want and how you want to present it. Do you want to revise an existing report format file that you have saved? Or do you want to start fresh and revise the template file that is provided in the Report Formatter? In either case, the steps are the same: 1 From the Report Formatter, choose either: An existing alarm report format file (e.g., Open from the File Menu) or, An alarm report template file (e.g., Template from the File Menu) 2 Set the page size of the report. 3 Create the regions of the report format file. View the format using the Preview screen. Make adjustments to the format as necessary. 4 Use any of the advanced features of the Report Formatter. For an alarm report, these features are: Sorting the data in your report (see Using the Sort Operation). Top-N (see Top-N). Creating a Summary Only report (see Summary Only). 5 Name and save the new file. These steps are explained in detail in the following sections. Report Generator User s Guide Page 72

73 Alarm Reports Selecting a Template File To select a template file, complete the following steps: Customizing an Alarm Report 1 In the Report Formatter window, select Template from the File menu. 2 Select Alarm Report from the Template menu. 3 From the Template dialog box, select Alarm.temp and press OK. The Alarm Template appears as shown in Figure 22. Figure 22: Alarm Report Template Setting the Page Size Of the Report Set the page size of your report by following these steps: 1 From the Edit menu, select Page Size to display the Current Page Settings dialog box. The default settings are 80 and 66 for Page Width and Lines Per Page, respectively. Report Generator User s Guide Page 73

74 Alarm Reports Customizing an Alarm Report 2 Enter the number of characters per line you want in the printed report in the Page Width field (1 to 200; recommended maximum is 132). 3 Enter the number of lines you want to appear on each printed report page in the Lines Per Page field (1 to 100). Creating the Regions Of Your Report You now create regions of your report and use the Preview screen to see how the format is progressing. Creating the regions of the report involves some or all of these functions: Entering text, moving text and replacing text, as required Entering objects, moving objects and replacing objects Verifying keywords and attributes associated with objects Assigning keywords and attributes to objects Using the Line and Column values to determine a location in the region Before you can work in a region, you must make it active. To make a region active, either select the appropriate button at the bottom of the window (see Figure 22), or click within the region. Note that all regions contain objects and text already assigned to locations. To perform the above tasks, see the instructions in Working In a Region. Note: The report header is a required region. All other regions are optional. However, if a region is omitted, the Report Formatter prevents you from adding any of the regions that follow it. Exceptions are: (1) Comments region. (2) Summary Header region is not required before Summary Data region. Report Generator User s Guide Page 74

75 Alarm Reports Customizing an Alarm Report The Report Header Region For an Alarm report, the valid entries in the report header region are text and the data types: FIXED and ATTR (all valid Aprisma attributes). FIXED type DATE LSCAPEHDL MODHDL PAGE USERNM Description Date and time that the report is started Landscape handle Model handle in hexadecimal Page number of the report User name The Column Header Region The headings in the column header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Line Data region. The only type of entry valid for this region is text. The Line Data Region The only valid data type is FIXED. FIXED type ALMCAUSE ALMCOND ALMID MODHDL MODNM MODTYPENM Description Alarm cause in hexadecimal Alarm condition, such as CRITICAL, MAJOR, MINOR, etc. Alarm ID in decimal Model handle in hexadecimal Model name Model type name Report Generator User s Guide Page 75

76 Alarm Reports Customizing an Alarm Report FIXED type Description POLLTIME VIEWPATH Alarm time stamp String output of the model s hierarchy in a directory structure format e.g., /Universe/classB/network/lan/ model140 Note: Use of a VIEWPATH may slow down report execution. The Summary Header Region The headings in the Summary Header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Summary Data region. The only type of entry valid for the Summary Header region is text. The Summary Data Region For an Alarm report, the only data type for the Summary Data region is FIXED. FIXED type CRITICAL MAJOR MINOR MAINTENANCE SUPPRESSED INITIAL Description Number of devices SPECTRUM has lost contact with Number of major alarms (model is at the second level of marginal operation) Number of minor alarms (model is at the first level of marginal operation) Number of devices in maintenance mode Number of models with an unknown status Number of devices in initial condition Report Generator User s Guide Page 76

77 Alarm Reports Customizing an Alarm Report FIXED type TOTALALMS MODHDL MODNM MODTYPENM Description Total number of alarms Model handle in Hex Model name Model type name Advanced Format Options Report Formatter lets you set up the following operations on data in a report: Sort the data in your report (see Using the Sort Operation). Create a Summary Only report (see Summary Only). Top-N (see Top-N). These operations are saved in your report format file and performed when your report is executed. Using the Sort Operation The Sort operation lets you order the rows of your report by one or more of the columns. You can sort on any selected column (in either ascending or descending order); or optionally, you can first sort on one column and then sort on another column within the first sort. To create the conditions for the Sort operation, complete the following steps: 1 Activate either the Line Data or Summary Data region. 2 Click the Sorting button to open the Sorting dialog box (see Figure 23). Report Generator User s Guide Page 77

78 Alarm Reports Customizing an Alarm Report Figure 23: Sorting Dialog Box In the Columns box is a list of the columns in the selected region of the current report and a description of each column. Note that columns will change between the Line Data and Summary Data regions. 3 Select the desired column entry in the Columns box. When this action is taken, the selected column number and data description appear in the Column Sorting Order box (see Figure 23). 4 Specify the sorting order within a column Ascending (to present data items from lowest to highest value) or Descending (highest value first), by pressing the Ascending or Descending toggle buttons. 5 Optionally, you can choose to sort a second column within the first sort by selecting it from the list in the Columns box and repeating the operations in Steps 3 and 4. Report Generator User s Guide Page 78

79 Alarm Reports Customizing an Alarm Report The Up and Down buttons allow you to change the sort order of the two columns identified in the Column Sorting Order box. For example, if the first entry in the box is C2 and the second entry is C3, the sort order can be changed (first sort C3 followed by C2) by highlighting C2 and pressing the Down button. (Or optionally, by highlighting C3 and pressing the Up button.) The Remove button lets you remove the highlighted column entry from the Column Sorting Order box. 6 Click the OK button to save the sort operation as part of the report format file. The Reset button removes the column entries from the Column Sorting Order box and returns them to the Columns box. Figure 24 shows an example of an alarm report that was run with a report format file that did not have a sort. Figure 25 shows the same alarm report that has been run from a report format file that has the sort feature implemented. In the example, the sort is performed on column 5, Alarm ID. Figure 24: Unsorted Report Spectrum Active Alarms Report Page : 1 Date: 01/28/ :40:22 Landscape ID: 0x Date/Time Model Type NameModel NameMdl HdlAlm IDAlmCond Alm CauseView Path 01/22/ :45:58 ICMP_App ICMP 0x50079b413 CRITICAL0x /LostFound / /MIB-I/ICMP 10:46:23 IP1_App IP 0x CRITICAL0x /LostFound Report Generator User s Guide Page 79

80 Alarm Reports Customizing an Alarm Report / /IP 10:44:57 GnSNMPDev x50053f279CRITICAL0x /LostFound / :48:17 Hub_CSI_TRMM x CRITICAL0x /Universe / / /Unplaced/ :27:26 Hub_CSI_TRMM x CRITICAL0x /LostFound / :43:28 ICMP_App ICMP 0x CRITICAL0x /LostFound / /MIB-II /ICMP 01/28/ :25:06 GnSNMPDev trlnm7 0x5005d CRITICAL0x /Universe / / /Unplaced/trlnm7 01/22/ :45:00 ICMP_App ICMP 0x5005e3289 CRITICAL0x /LostFound / /MIB-II/ICMP 10:44:43 ICMP_App ICMP 0x CRITICAL0x /Universe / /Unplaced / /MIB-II /ICMP 10:45:57 UDP2_App UDP 0x CRITICAL0x /LostFound / /MIB-II /UDP Report Generator User s Guide Page 80

81 Alarm Reports Customizing an Alarm Report Figure 25: Sorted Report by Alarm ID Date: 01/28/ :40:22 Landscape ID: 0x Spectrum Active Alarms Report Page : 1 Date/Time Model Type Name Model Name Mdl Hdl Alm ID AlmCond Alm Cause View Path 10:43:28 ICMP_App ICMP 0x CRITICAL 0x /LostFound / /MIB-II /ICMP 10:44:43 ICMP_App ICMP 0x CRITICAL 0x /Universe / /Unplaced / /MIB-II /ICMP 10:44:57 GnSNMPDev x50053f 279 CRITICAL 0x /LostFound / /22/ :45:00 ICMP_App ICMP 0x5005e3 289 CRITICAL 0x /LostFound / /MIB-II/ICMP 10:45:57 UDP2_App UDP 0x CRITICAL 0x /LostFound / /MIB-II /UDP 01/22/ :45:58 ICMP_App ICMP 0x50079b 413 CRITICAL 0x /LostFound / /MIB-I/ICMP 10:46:23 IP1_App IP 0x CRITICAL 0x /LostFound / /IP 10:48:17 Hub_CSI_TRMM x CRITICAL 0x /Universe / / /Unplaced/ :27:26 Hub_CSI_TRMM x CRITICAL 0x /LostFound / /28/ :25:06 GnSNMPDev trlnm7 0x5005d CRITICAL 0x /Universe / / Report Generator User s Guide Page 81

82 Alarm Reports Customizing an Alarm Report /Unplaced/trlnm7 Top-N If you want to display a subset of the sorted data, click on the Top N button and enter a value in the field. For example, entering the value 20 would display the first 20 unique data items for the sort criteria. Note that if you select Ascending, you actually get the Bottom N items. Summary Only You can have your report appear with just the summary data. (The Line Data for an alarm report can be quite lengthy.) To have this option be part of your report format file, choose the Suppress Line Data toggle switch from the Format menu. The Line Data information that is collected will not appear in your report. Saving the New Report Format File To save the file, complete the following steps. If you have created a report format file from a template file: 1 Pull down the File menu on the Report Formatter main window and select Save As. The Save As dialog box appears. 2 Enter a name for the report format file. 3 Click the OK button. If you have modified an existing report format file: 1 Pull down the File menu on the Report Formatter main window and select Save or Save As. If you select Save, the modified report format file replaces the original. If you select Save As, the modified report format file is saved as a new file and the original is unchanged. 2 Enter a name for the report format file. 3 Click the OK button. Report Generator User s Guide Page 82

83 Event Reports This section discusses how to create and customize an Event Report. Overview The Generate feature of the SPECTRUM Report Generator lets you create Event reports of the historical data on your network. An event report provides the following information on the events in the network: Date/time stamp Event message Model name Model type name Model handle Event type Topological view path If the event records that an alarm was generated, the report lists the alarm ID, alarm condition, and the probable cause code for the alarm. The procedure for generating an event report involves making selections in the Report Generator main window. For example, you can select: The landscape(s) for which you want information. The model types, models, and specific alarms/conditions for which you want information. The report format to use. The output of the report. The file name and path location for the report. The time interval you want to report on from the events database. Report Generator User s Guide Page 83

84 Event Reports Overview The events you want to report on. When and how often to run the report. After you have made all your choices, you are ready to run your report. You can have the report run immediately or schedule it for a convenient time and frequency in the future. Starting the Report Generator To start the Report Generator, you complete these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Event as the Report Type. The main window shows the selections you must choose for an Event Report (see Figure 26). Report Generator User s Guide Page 84

85 Event Reports Specifying Landscapes Figure 26: Event Report Main Window Specifying Landscapes From the Event Report main window, press Landscapes to display the Landscape dialog box. This dialog box lets you select the landscapes for which you want information. To select landscapes, click once on each landscape that you want to select. Then, click OK to return to the Event Report main window. See Specifying Landscapes for more details. Report Generator User s Guide Page 85

86 Event Reports Specifying One or More Models Specifying One or More Models From the Event Report main window, press Models to display the Model Selection dialog box. When you double click on a model type, a list appears underneath the model type that contains, for each selected landscape, all models present for that model type. Expand as many model types and select as many models as required. When you have made all the selections for your report, click OK to return to the Event Report main window. See Specifying Models for a Report for more details. Specifying a Report Format File You can use an already configured report format file to define the output format of your report. To do this, press Report Format from the Event Report main window to display the Choose Report Format File dialog box. In this dialog box, navigate to the directory that contains the Event report format files (SG-Support/CsRib by default), then select a file. When you select a report format file, click OK and the name of the file appears in the Report Format field of the Event Report main window. You can also use the Report Formatter to modify an existing format or create a new one using the event template. See Customizing an Event Report. Specifying a Data Range Data Range lets you specify a time range for extracting the data for the report. Click on one of the Data Range buttons and select a range option. Custom Day Reports data from the specified start date to the specified end date. See Using the Custom Data Range. Reports data from the previous calendar day (00:00:00 to 23:59:59) from the date of report execution. For example, if your report is executed on May 21, data from the events database from May 20 at 00:00:00 to 23:59:59 is reported. Report Generator User s Guide Page 86

87 Event Reports Week Month Specifying a Data Range Reports data from the previous seven calendar days from the date of execution from 00:00:00 of the first day to 23:59:59 of the last day. For example, if your report is executed on Wednesday, May 24, 2000, data is reported from Wednesday, May 17 at 00:00:00 to Tuesday, May 23 at 23:59:59. Reports data from the previous calendar month from the date of execution from the first day of the month at 00:00:00 to the last day of the month at 23:59:59. For example, if your report is executed on May 21, data will be reported from April 1 at 00:00:00 to April 30 at 23:59:59. Using the Custom Data Range If you select Custom, the Data Range dialog box in Figure 27 appears. To set a custom range for the report: 1 Click on the Available Range button to see what range of data exists. The range values appear in the appropriate fields after the Report Generator examines your events database. The available range will be the union of the time ranges of all the selected landscapes. Figure 27: Data Range Dialog Box for Custom Option SDE: Report Generator User s Guide Page 87

88 Event Reports Specifying a Report Output File Name 1 To set a different date and time range, set the Start Date and End Date. a b Pop-up the Month menu and select a month. Click on the Up or Down button next to the Day and Year to increment or decrement the settings for the day and year. 2 Set the Start Time and End Time by clicking the Up or Down button next to the Hours and Minutes to increment or decrement the settings. (Note that the Start Time cannot be equal to or greater than the End Time.) 3 Click OK. To set the date and time settings to the current date and time, click on Now and then OK. Specifying a Report Output File Name The Output File field identifies your report with a file name and path location. To specify an output file, press Output File to display the Output File dialog box. This dialog box lets you specify the path and file name for the report. If you do not specify a file name for the output file, you cannot generate a report. When you press OK, the Event Report main window appears with the path and file name in the Output File field. Note that the Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output.csv for comma delimited ASCII Report Generator User s Guide Page 88

89 Event Reports Specifying the Viewing Output Specifying the Viewing Output From the Event Report main window, specify how your report will be viewed by selecting one or more of the following items in the Output Format section: Tabular ASCII Tabular PostScript Graphical Display Graphical PostScript Graphical GIF Comma Delimited ASCII Specifying Filter Criteria To create the report as columns of data. To create the report as a tabular PostScript file. To create the report as a graph. Depending on your data, the default graph will usually be a column graph. You can change it later to another graph type when you display it. To create the report as a graphical PostScript file. To create the report as a graphical GIF file. This GIF can then be incorporated into an HTML page; see Using Report Output in HTML Pages for details. To create a report as a tabular, common delimited, ASCII file that can be opened in Microsoft Excel or Sun s Star Office. For an Event Report, press the Event Filters button to display the Event Filters dialog box. Conditions are activated by pressing the appropriate button. The conditions are as follows: Select All Events Select this button if you want all alarm condition events and all event codes. Filter on Event Code Select this button to report on an event code or several event codes (see Figure 28). Report Generator User s Guide Page 89

90 Event Reports Specifying Filter Criteria Figure 28: Filter on Event Code Dialog Box To select the event code(s) for your report, click on the event code(s) in the Files field of the dialog box and press OK. You can use the wildcard choice to filter out a range of event codes in the Files field by typing the event code s common parts followed by an asterisk (*). To specify another directory, type the appropriate filter name in the Path field, click on the Filter button, and navigate to the correct directory in the Directories column. Select event codes and press the OK button to accept the entries and return to the Event Report main window. Filter on Alarm Conditions Select this button to display the dialog box shown in Figure 29. Report Generator User s Guide Page 90

91 Event Reports Figure 29: Specifying Filter Criteria Filter on Alarm Conditions Dialog Box For an Event Report, the alarm conditions are activated by pressing the appropriate button. These are the alarm conditions you want to report on. The conditions are as follows: Critical SPECTRUM has lost contact with the device. Major The model has had a major alarm and is at the second level of marginal operation. Minor The model has a minor alarm and is at the first level of marginal operation. Suppressed The status of the model is not known. SPECTRUM could not reach the model because of an error in another model. Initial Initial condition. Maintenance The device is in maintenance mode. All Alarms All of the alarm conditions (this is the default). For more information on conditions, see the SPECTRUM manual Modeling with the GnSNMPDev Toolkit. Once you have selected all of the conditions for the Event report, click OK to return to the Event Report main window. Report Generator User s Guide Page 91

92 Event Reports Where Do You Go From Here? Where Do You Go From Here? You are now ready to run your report by simply clicking on the Generate icon in the toolbar. It may take a short amount of time, depending on the information to be gathered for the report. If you keep the Report Generator Main Window up, an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) appears in a popup dialog box when the report is complete. To see what your report looks like, select Reports Display from the Applications menu. See Displaying Reports for detailed instructions. You use Generate to get an indication of what a report will look like for your network needs. When you are satisfied with the appearance and the information in your report you may want to run it at a regular interval. To schedule your report to run at a later time or at a regular interval, click on the Schedule icon in the toolbar. See Scheduling Reports for detailed instructions. Customizing an Event Report You can create a customized look for your report with the Report Formatter. What you do depends on what data you want and how you want to present it. Do you want to revise an existing report format file that you have saved? Or perhaps you want to start fresh and revise the template file that is provided in the Report Formatter. Either way you do it, the steps are the same: 1 From the Report Formatter, choose either: An existing event report format file (e.g., Open from the File menu) or An event report template file (e.g., Template from the File menu) 2 Set the page size of the report. 3 Create the regions of the report format file. View the format using the Preview screen. Make adjustments to the format as necessary. Report Generator User s Guide Page 92

93 Event Reports Customizing an Event Report 4 Use any of the advanced features of the Report Formatter. For an event report, these features are: Sorting the data in your report Creating a Summary Only report 5 Name and save the new file. These steps are explained in detail in the following sections. Selecting a Template File To select a template file, complete the following steps: 1 In the Report Formatter window, select Template from the File menu. 2 Select Event Report from the Template menu. 3 From the Template dialog box, select Event.temp and press OK. The Event Report Template appears as shown in Figure 30. Report Generator User s Guide Page 93

94 Event Reports Customizing an Event Report Figure 30: Event Report Template Setting the Page Size Of the Report Set the page size of your report by following these steps: 1 From the Edit menu, select Page Size to display the Current Page Settings dialog box. Note that the default settings are 80 and 66 for Page Width and Lines Per Page, respectively. 2 Enter the number of characters per line you want in the printed report in the Page Width field (1 to 200; recommended maximum is 132). 3 Enter the number of lines you want to appear on each printed report page in the Lines Per Page field (1 to 100). Report Generator User s Guide Page 94

95 Event Reports Creating the Regions Of Your Report Customizing an Event Report You now create regions of your report and use the Preview screen to see how the format is progressing. Creating the regions of the report involves some or all of these functions: Entering text, moving text and replacing text, as required Entering objects, moving objects and replacing objects Assigning keywords and attributes to objects Using the Line and Column values to determine a location in the region Before you can work in a region, you must make it active. To make a region active, either select the appropriate button at the bottom of the window (see Figure 30), or click within the region. Notice that all regions contain objects and text already assigned to locations. To perform the above tasks, see the instructions in Working In a Region. Note: The report header is a required region. All other regions are optional. However, if a region is omitted, the Report Formatter prevents you from adding any of the regions that follow it. Exceptions are: (1) Comments region. (2) Summary Header region is not required before Summary Data region. The Report Header Region The only valid entries are text and the data types: FIXED and ATTR (all valid Aprisma attributes). FIXED keywords are: FIXED type DATE LSCAPEHDL PAGE Description Date and time that the report is started Landscape handle Page number of the report Report Generator User s Guide Page 95

96 Event Reports Customizing an Event Report FIXED type Description USERNM RANGE User name Time range reported on The Column Header Region The headings in the column header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Line Data region. The only type of entry valid for this region is text. The Line Data Region For an Event report, the only data types for this region are FIXED. FIXED type ALMCAUSE ALMCOND ALMID EVTCODE EVTMSG EVTTYPE MODHDL MODNM MODTYPENM POLLTIME VIEWPATH Alarm cause in hexadecimal Description Alarm condition, such as CRITICAL, MAJOR, MINOR, etc. Alarm ID in decimal Event code Event message in text format Event type, such as Active, Cleared, etc. Model handle in hexadecimal Model name Model type name Event time stamp String output of the model s hierarchy in a directory structure format e.g., /Universe/classB/network/lan/model140 Report Generator User s Guide Page 96

97 Event Reports Customizing an Event Report Note: Use of a VIEWPATH may slow down report execution. The Summary Header Region The headings in the Summary Header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you should move its corresponding object in the Summary Data region. The only type of entry valid for the Summary Header region is text. The Summary Data Region For an Event report, the only data type for the Summary Data region is FIXED. FIXED type CRITICAL MAJOR MINOR MAINTENANCE SUPPRESSED INITIAL NO_CONDITION TOTALEVTS MODHDL MODNM MODTYPENM Description Number of devices SPECTRUM has lost contact with Number of major alarms (model is at the second level of marginal operation) Number of minor alarms (model is at the first level of marginal operation) Number of devices in maintenance mode Number of models with an unknown status Number of devices in initial condition Event without any alarm condition Total number of events Model handle in hexadecimal Model name Model type name Report Generator User s Guide Page 97

98 Event Reports Advanced Format Options Customizing an Event Report The Report Formatter lets you set up the following operations on report data: Sorting the data in your report (see Using the Sort Operation). Creating a Summary Only report (see Summary Only). Top-N (see Top-N). These operations are saved in your report format file and performed when your report is executed. Using the Sort Operation The Sort operation lets you order the rows of your report by one or more of the columns. You can sort on any selected column (in either ascending or descending order); or optionally, you can first sort on one column and then sort on another column within the first sort. To create the conditions for the Sort operation, complete the following steps: 1 Activate either the Line Data or Summary Data region. 2 Click on the Sorting button to open the Sorting dialog box (see Figure 31). Report Generator User s Guide Page 98

99 Event Reports Customizing an Event Report Figure 31: Sorting Dialog Box In the Columns box is a list of the columns in the selected region of the current report and a description of each column. Note that columns will change between the Line Data and Summary Data regions. 3 Click on the desired column entry in the Columns box. When this action is taken, the selected column number and data description appear in the Column Sorting Order box (see Figure 31). 4 Specify the sorting order within a column Ascending (to present data items from lowest to highest value) or Descending (highest value first), by pressing the Ascending or Descending toggle buttons. 5 Optionally, you can choose to sort a second column within the first sort by selecting it from the list in the Columns box and repeating the operations in Steps 3 and 4. Report Generator User s Guide Page 99

100 Event Reports Customizing an Event Report 6 The Up and Down buttons lets you change the sort order of the two columns in the Column Sorting Order box. For example, if the first entry in the box is C2 and the second entry is C3, the sort order can be changed (first sort C3 followed by C2) by highlighting C2 and pressing the Down button. (Or optionally, by highlighting C3 and pressing the Up button.) The Remove button lets you remove the highlighted column entry from the Column Sorting Order box. 7 Press the OK button to save the sort operation as part of the report format file. The Reset button removes the column entries from the Column Sorting Order box and returns them to the Columns box. Figure 32 shows an example of an event report that was run with a report format file that did not have a sort. Figure 33 shows the same event report that has been run from a report format file that has the sort feature implemented. In the example, the sort is performed on column 6 Evt Code. Figure 32: Unsorted Report Spectrum Event Report Page : 1 From Sat Jan 15 1:00: To Thu Jan 27 13:41: Date: 01/28/ :57:30 Model Name: Device Type: Hub_CSI_TRMM Landscape ID: 0x Poll Time Model Type Name Model Name Mdl Hdl Evt Typ Evt Code Alm ID Alm CondAlm CauseView Path 01/17/ :24:41 Hub_CSI_TRMM x x / :24:42 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / :25:47 Hub_CSI_TRMM x x / :25:57 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / :27:41 Hub_CSI_TRMM x x / :27:47 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x Report Generator User s Guide Page 100

101 Event Reports Customizing an Event Report / :28:46 Hub_CSI_TRMM x x / :28:55 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / /19/ :49:42 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / :49:42 Hub_CSI_TRMM x x / :43:48 Hub_CSI_TRMM x x / :43:59 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / /22/ :44:55 Hub_CSI_TRMM x x / :44:55 Hub_CSI_TRMM x500548Active 0x MINOR 0x / :44:55 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / :38:59 Hub_CSI_TRMM x x / :39:00 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / :27:08 Hub_CSI_TRMM x x / :27:26 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / Model Name Model Type Name Mdl Hdl CRITICALMAJORMINOR MAINTENANCESUPPRESSEDINITIALOthersTotals Hub_CSI_TRMM0x Totals: Figure 33: Sorted Report by Event Code Spectrum Event Report Page : 1 Date: 01/28/ :57:30 Model Name: Device Type: Hub_CSI_TRMM Landscape ID: 0x From Sat Jan 15 1:00: To Thu Jan 27 13:41: Poll Time Model Type Name Model Name Mdl Hdl Evt Typ Evt Code Alm ID Alm CondAlm CauseView Path 01/17/ :24:41 Hub_CSI_TRMM x x / :27:41 Hub_CSI_TRMM x x / Report Generator User s Guide Page 101

102 Event Reports Customizing an Event Report 01/19/ :49:42 Hub_CSI_TRMM x x / :38:59 Hub_CSI_TRMM x x / /17/ :25:47 Hub_CSI_TRMM x x / :28:46 Hub_CSI_TRMM x x / /19/ :43:48 Hub_CSI_TRMM x x / /22/ :27:08 Hub_CSI_TRMM x x / :44:55 Hub_CSI_TRMM x x / /17/ :27:26 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / :25:57 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / /19/ :43:59 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / /22/ :44:55 Hub_CSI_TRMM x500548Active 0x MINOR 0x / :44:55 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / :28:55 Hub_CSI_TRMM x500548Active 0x CRITICAL0x / /17/ :24:42 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / :27:47 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / /19/ :49:42 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / /22/ :39:00 Hub_CSI_TRMM x500548Cleared0x CRITICAL0x / Model Name Model Type Name Mdl Hdl CRITICALMAJORMINOR MAINTENANCESUPPRESSEDINITIALOthersTotals Hub_CSI_TRMM0x Totals: Report Generator User s Guide Page 102

103 Event Reports Customizing an Event Report Top-N If you want to display a subset of the sorted data, click on the Top N button and enter a value in the field. For example, entering the value 20 would display the first 20 unique data items for the sort criteria. Note that if you select Ascending, you will actually get the Bottom N items. Summary Only You can have your report appear with just the summary data. (The Line Data for an event report can be quite lengthy.) To have this option be part of your report format file, choose the Suppress Line Data toggle switch from the Format menu. The Line Data information that is collected will not appear in your report. Saving the New Report Format File To save the file, complete the following steps: 1 Pull down the File menu on the Report Formatter main window and select Save. The Save As dialog box appears. 2 Enter a name for the report format file. 3 Press the OK button. If you have modified an existing report format file: 1 Pull down the File menu on the Report Formatter main window and select Save or Save As. If you select Save, the modified report format file will replace the original. If you select Save As, the modified report format file is saved as a new file and the original is unchanged. 2 Enter a name for the report format file. 3 Press the OK button. Report Generator User s Guide Page 103

104 Inventory Reports This section discusses how to create and customize an Inventory Report. Overview The Generate feature of the SPECTRUM Report Generator lets you create one or more Inventory reports. An inventory report provides the following information about the devices in the network: Model types Total number of models Number of active models Number of inactive models IP address Network address Model creation date Last contacted date Topological view information The procedure for generating an inventory report involves making the following selections in the Report Generator main window: The model types. The report format you want to use. The output of the report. The file name and path location for the report. The level of detail for the report. The site name for the report. After you have made all your choices, you are ready to run your report. You can have the report run immediately or schedule it for a convenient time and frequency in the future. Report Generator User s Guide Page 104

105 Inventory Reports Starting the Report Generator To start the Report Generator, you complete these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. Overview 2 Select Inventory as the Report Type. The main window shows the selections you must choose for an Inventory Report (see Figure 34). Figure 34: Inventory Report Main Window Report Generator User s Guide Page 105

106 Inventory Reports Specifying Landscapes Specifying Landscapes From the Inventory Report main window, press Landscapes to display the Landscape dialog box. This dialog box lets you select the landscapes for which you want information. To select landscapes, click once on each landscape that you want to select. Then, click OK to return to the Inventory Report main window. See Specifying Landscapes for more details. Specifying One or More Model Types From the Inventory Report main window, press Model Types to display the Model Types dialog box shown in Figure 35. Figure 35: Model Types Dialog Box Report Generator User s Guide Page 106

107 Inventory Reports Specifying a Report Format File You can choose only one model at a time. When you choose a model under a different landscape, the model types list is cleared and a new list of model types appears. Note: For Inventory Reports, the Report Generator user interface lets you choose only one model at a time. In addition, unpredictable results will occur if you select more than one model in SpectroGRAPH and then invoke the Report Generator. Select model types by clicking on them and/or using the Select All and Deselect All buttons. When you have made all the selections for your report, click OK to return to the Inventory Report main window. Specifying a Report Format File You can use an already configured report format file to define the output format of your report. To do this, select Report Format from the Inventory Report main window to display the Choose Report Format File dialog box. In this dialog box, navigate to the directory that contains the Inventory report format files (SG-Support/CsRib by default), then select a file. When you select a report format file, click OK and the name of the file appears in the Report Format field of the Inventory Report main window. You can also use the Report Formatter to modify an existing format or create a new one using the inventory template. See Customizing an Inventory Report. Note: The Aprisma-supplied Rib file Invt_Det.rib cannot be used for Graphical reports. Report Generator User s Guide Page 107

108 Inventory Reports Specifying a Report Output File Name Specifying a Report Output File Name The Output File field identifies your report with a file name and path location. If you want to change it, press Output File to display the Output File dialog box. This dialog box lets you specify the path and file name for the report. If you do not specify a file name for the output file, you cannot generate a report. When you press OK, the Inventory Report main window appears with the file name in the Output File field. Note that the Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output.csv for comma delimited output Specifying the Viewing Output From the Inventory Report main window, specify how your report will be viewed by selecting one or more of the following items in the Output Format section: Tabular ASCII Tabular PostScript Graphical Display Graphical PostScript To create the report as columns of data. To create the report as a tabular PostScript file. To create the report as a graph. Depending on your data, the default graph will usually be a column graph. You can change it later to another graph type when you display it. To create the report as a graphical PostScript file. Report Generator User s Guide Page 108

109 Inventory Reports Graphical GIF Comma Delimited ASCII Specifying Level Of Detail To create the report as a graphical GIF file. This GIF can then be incorporated into an HTML page; see Using Report Output in HTML Pages for details. To create a report as a tabular, common delimited ASCII file that can be opened in Microsoft Excel or Sun Star s Office. Specifying Level Of Detail Specify the level of detail for the report by making a selection from Report Depth. Select either General or Detailed. General Provides cumulative data for model types. Detailed Provides additional model information for model types that are multi-slot devices, such as repeaters. For example, the repeater inventory report provides further information on each port and board in the repeater if model type(s) such as port group is specified. The port information will be not provided if the report type is general, even if the model type(s) of port group are specified. If the model type(s) are not multi-slot devices, there is no difference between a general and a detailed inventory report. Figure 36 illustrates an example of a general report; Figure 37 shows a sample detailed report. Report Generator User s Guide Page 109

110 Inventory Reports Specifying Level Of Detail Figure 36: General Report Example Spectrum Network Inventory Report Page : 1 Date: 01/18/ :25:42 LandScapeID: User Name: Site Name: 0x root Default Site Model Name Model Name IP Address MAC Address Create Date Contact Last Contacted Vendor Object ID CSIRptr Network C D.B.26.B8 11/09/ :26 ESTB 01/18/ : Spectrum Network Inventory Report Page : 2 Date: 01/18/ :25:42 LandScapeID: User Name: Site Name: 0x root Default Site Model Type Total Number of Models Number of Active Models Number of Inactive Models CSIRptr Totals: Report Generator User s Guide Page 110

111 Inventory Reports Specifying Level Of Detail Figure 37: Detailed Report Example Spectrum Network Inventory Report Page : 1 Date: 01/18/ :08:50 LandScapeID: User Name: Site Name: 0x root Default Site Model Name Model Name IP Address MAC Address Create Date Contact Last Contacted Vendor Object ID CSIPortGroup /09/ :27 ESTB - - CSIRptr Network C D.B.26.B8 11/09/ :26 ESTB 01/18/ : EMMEPsdoBd /09/ :26 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - GenRptrR4Port /13/ :35 ESTB - - RptrPort /18/ :26 ESTB - - Spectrum Network Inventory Report Page : 2 Date: 01/18/ :08:50 LandScapeID: User Name: Site Name: 0x root Default Site Model Type Total Number of Models Number of Active Models Number of Inactive Models CSIPortGroup CSIRPTR EMMEPdsoBd GenRptrR4Port Report Generator User s Guide Page 111

112 Inventory Reports Specifying the Site Name Spectrum Network Inventory Report Page : 1 Date: 01/18/ :08:50 LandScapeID: User Name: Site Name: 0x root Default Site RptrPort Totals: For Inventory Reports, the following information filters are available: Model Types Under Landscape Lists inventory information for selected model types in the database. Model Types Under Model Lists inventory information for selected model types under the currently selected model. Specifying the Site Name Enter a site name in the Site Name field. The site name identifies the name of the SPECTRUM installation (site) where the report is run. Where Do You Go From Here? You are now ready to run your report by simply clicking on the Generate icon in the toolbar. It may take a short amount of time, depending on the information to be gathered for the report. If you keep the Report Generator Main Window up, an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) appears in a popup dialog box when the report is complete. To see what your report looks like, select Reports Display from the Applications menu. See Displaying Reports for detailed instructions. Report Generator User s Guide Page 112

113 Inventory Reports Customizing an Inventory Report You use Generate to get an indication of what a report will look like for your network needs. When you are satisfied with the appearance and the information in your report you may want to run it at a regular interval. To schedule your report to run at a later time or at a regular interval, click on the Schedule icon in the toolbar. See Scheduling Reports for detailed instructions. Customizing an Inventory Report You can create a customized look for your report with the Report Formatter. What you do depends on what data you want and how you want to present it. Do you want to revise an existing report format file that you have saved? Or perhaps you want to start fresh and revise the template file that is provided in the Report Formatter. Either way you do it, the steps are the same: 1 From the Report Formatter, choose either: An existing inventory report format file (e.g., Open from the File Menu) or An inventory report template file (e.g., Template from the File Menu) 2 Set the page size of the report. 3 Create the regions of the report format file. View the format using the Preview screen. Make adjustments to the format as necessary. 4 Use any of the advanced features of the Report Formatter. For an inventory report, these features are: Sorting the data in your report. Creating a Summary Only report. 5 Name and save the new file. These steps are explained in detail in the following sections. Report Generator User s Guide Page 113

114 Inventory Reports Selecting a Template File To select a template file, complete the following steps: Customizing an Inventory Report 1 In the Report Formatter window, select Template from the File menu. 2 Select Inventory Report from the Template menu. 3 From the Template dialog box, select Inventory.temp and then click OK. The Inventory Template appears as shown in Figure 38. Figure 38: Inventory Report Template Report Generator User s Guide Page 114

115 Inventory Reports Customizing an Inventory Report Setting the Page Size Of the Report Set the page size of your report by following these steps: 1 From the Edit menu, select Page Size to display the Current Page Settings dialog box. Note that the default settings are 80 and 66 for Page Width and Lines Per Page, respectively. 2 Enter the number of characters per line you want in the printed report in the Page Width field (1 to 200; recommended maximum is 132). 3 Enter the number of lines you want to appear on each printed report page in the Lines Per Page field (1 to 100). Creating the Regions Of Your Report You now create regions of your report and use the Preview screen to see how the format is progressing. Creating the regions of the report involves some or all of these functions: Entering text, moving text and replacing text, as required. Entering objects, moving objects and replacing objects. Assigning keywords and attributes to objects. Using the Line and Column values to determine a location in the region. Before you can work in a region, you must make it active. To make a region active, either select the appropriate button at the bottom of the window or click within the region. Note that all regions contain objects and text already assigned to locations. To perform these tasks, see Working In a Region. Report Generator User s Guide Page 115

116 Inventory Reports Customizing an Inventory Report Note: The report header is a required region. All other regions are optional. However, if a region is omitted, the Report Formatter prevents you from adding any of the regions that follow it. Exceptions are: (1) Comments region. (2) Summary Header region is not required before Summary Data region. The Report Header Region The only valid entries are text and the data types: FIXED and ATTR (all valid Aprisma attributes). FIXED keywords are: FIXED type DATE LSCAPEHDL PAGE SITE USERNM Description Date and time that the report is started Landscape handle Page number of the report Site location User name The Column Header Region The headings in the column header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Line Data region. The only type of entry valid for this region is text. Report Generator User s Guide Page 116

117 Inventory Reports Customizing an Inventory Report The Line Data Region For an Inventory report, the only data types for this region are FIXED and ATTR (all valid Aprisma attributes). The valid data type is FIXED. FIXED type Description CONTACT VIEWPATH Name of individual String output of the model s hierarchy in a directory structure format, e.g., /Universe/classB/network/lan/model140 Note: Use of a VIEWPATH may slow down report execution. The Summary Header Region The headings in the Summary Header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Summary Data region. The only type of entry valid for the Summary Header region is text. The Summary Data Region For an Inventory report, the only data type for the Summary Data region is FIXED. FIXED type Description MODTYPENM TOTALACT TOTALINACT TOTALMODS Model type number Total active models Total inactive models Total number of models of a particular model type Report Generator User s Guide Page 117

118 Inventory Reports Advanced Format Options Customizing an Inventory Report The Report Formatter lets you set up the following operations on the data in a report: Sorting the data in your report (see Using the Sort Operation). Top-N (see Top-N). Creating a Summary Only report (see Summary Only). These operations are saved in your report format file and performed when your report is executed. Using the Sort Operation The Sort operation lets you order the rows of your report by one or more of the columns. You can sort on any selected column (in either ascending or descending order); or optionally, you can first sort on one column and then sort on another column within the first sort. To create the conditions for the Sort operation, complete the following steps: 1 Activate either the Line Data or Summary Data region. 2 Click on the Sorting button to open the Sorting dialog box (see Figure 39). Report Generator User s Guide Page 118

119 Inventory Reports Customizing an Inventory Report Figure 39: Sorting Dialog Box In the Columns box is a list of the columns in the selected region of the current report and a description of each column. Note that columns will change between the Line Data and Summary data regions. 3 Click on the desired column entry in the Columns box. When this action is taken, the selected column number and data description appear in the Column Sorting Order box (see Figure 39). 4 Specify the sorting order within a column Ascending (to present data items from lowest to highest value) or Descending (highest value first), by pressing the Ascending or Descending toggle buttons. 5 Optionally, you can choose to sort a second column within the first sort by selecting it from the list in the Columns box and repeating the operations in Steps 3 and 4. Report Generator User s Guide Page 119

120 Inventory Reports Customizing an Inventory Report 6 The Up and Down buttons allow you to change the sort order of the two columns identified in the Column Sorting Order box. For example, if the first entry in the box is C2 and the second entry is C3, the sort order can be changed (first sort C3 followed by C2) by highlighting C2 and pressing the Down button. (Or optionally, by highlighting C3 and pressing the Up button.) The Remove button lets you remove the highlighted column entry from the Column Sorting Order box. 7 Click the OK button to save the sort operation as part of the report format file. The Reset button removes the column entries from the Column Sorting Order box and returns them to the Columns box. Figure 40 shows an example of an inventory report that was run with a report format file that did not have a sort. Figure 41 shows the same inventory report that has been run from a report format file that has the sort feature implemented. In the example, the sort is performed on column 5 - Number of Inactive Models, as was specified in the Sort dialog box in Figure 39. Report Generator User s Guide Page 120

121 Inventory Reports Customizing an Inventory Report Figure 40: Unsorted Report Spectrum Network Inventory Report Page : 1 Site Name: this-site Date: 01/05/ :21:03 LandScapeID: 0x User Name: root Model Type þþþþtotal Number of ModelsþþþNumber of Active Models þnumber of Inactive Models BdgCSINB Bdg_CSI_CGen Bdg_CSI_CNB Bdg_CSI_CNB Bdg_CSI_CNB Bdg_CSI_EFDMIM Bdg_CSI_SNB Bdg_CSI_SNB Hub_CSI_CIRM Hub_CSI_IRBM Hub_CSI_IRM Hub_CSI_IRM Hub_CSI_MRXi Hub_CSI_MiniM Hub_CSI_SIRM Hub_CSI_TRMM Hub_SO_Ser NA_Nov_LANtern Pingable Rtr_3Com Rtr_Cay_GatorB Rtr_DEC_WS Rtr_IBM_WS Rtr_Kin_FastP Rtr_Proteon Rtr_VitaLink Rtr_Wellfleet Rtr_cisco_AGS Rtr_cisco_CGS Rtr_cisco_IGS Rtr_cisco_MIM SNMP_Device TS_Xyl_AnnexII TS_Xyp_ETSMIM Host_DEC Host_IBM Host_SGI Totals: Report Generator User s Guide Page 121

122 Inventory Reports Figure 41: Customizing an Inventory Report Sorted Report by Number of Inactive Models Spectrum Network Inventory Report Page : 1 Date: 01/05/ :21:03 LandScapeID: 0x User Name: root Site Name: this-site Model TypeþþþþþþþþþþTotal Number of Models þþnumber of Active Models þnumber of Inactive Models Pingable Hub_CSI_IRM Host_SGI Hub_CSI_CIRM Host_DEC Host_IBM Hub_CSI_MRXi BdgCSINB Bdg_CSI_CGen Bdg_CSI_CNB Bdg_CSI_CNB Bdg_CSI_CNB Bdg_CSI_EFDMIM Bdg_CSI_SNB Bdg_CSI_SNB Hub_CSI_IRBM Hub_CSI_IRM Hub_CSI_MiniM Hub_CSI_TRMM Hub_SO_Ser NA_Nov_LANtern Rtr_3Com Rtr_Cay_GatorB Rtr_DEC_WS Rtr_IBM_WS Rtr_Kin_FastP Rtr_Proteon Rtr_VitaLink Rtr_Wellfleet Rtr_cisco_AGS Rtr_cisco_CGS Rtr_cisco_IGS Rtr_cisco_MIM SNMP_Device TS_Xyl_AnnexII TS_Xyp_ETSMIM Hub_CSI_SIRM Totals: Top-N If you want to display a subset of the sorted data, click on the Top N button and enter a value in the field. For example, entering the value 20 Report Generator User s Guide Page 122

123 Inventory Reports Customizing an Inventory Report would display the first 20 unique data items for the sort criteria. Note that if you select Ascending, you will actually get the Bottom N items. Summary Only You can have your report appear with just the summary data. (The Line Data for an inventory report can be quite lengthy.) To have this option be part of your report format file, choose the Suppress Line Data toggle switch from the Format menu. The Line Data information that is collected will not appear in your report. Saving the New Report Format File To save the file, complete the following steps. If you have created a report format file from a template file: 1 Pull down the File menu on the Report Formatter main window and select Save As. The Save As dialog box appears. 2 Enter a name for the report format file. 3 Click the OK button. If you have modified an existing report format file: 1 Pull down the File menu on the Report Formatter main window and select Save or Save As. If you select Save, the modified report format file will replace the original. If you select Save As, the modified report format file is saved as a new file and the original is unchanged. 2 Enter a name for the report format file. 3 Click the OK button. Report Generator User s Guide Page 123

124 Statistical Reports This section discusses how to create and customize a Statistical Report. Overview The Generate feature of the SPECTRUM Report Generator lets you create statistical reports of the historical data on your network. A statistical report provides you with information on the communication performance of the LANs and devices on the network. Here are some examples: Poll time Load Frame rate Error rate Collision rate Utilization rate Hard error count The procedure for generating a statistical report involves making selections in the Report Generator main window. For example, you can select: The landscape(s) for which you want information. The model type and models for which you want information. The report format to use. The output of the report. The file name and path location for the report. The time interval you want to report on from the statistics database. When and how often to run the report. Report Generator User s Guide Page 124

125 Statistical Reports Overview After you have made all your choices, you are ready to run your report. You can have the report run immediately or schedule it for a convenient time and frequency in the future. Starting the Report Generator To start the Report Generator, you complete these steps: Invoke the Report Generator as described in Opening the Report Generator. Note that Statistical is already selected as the Report Type. The main window shows the selections you must choose for a Statistical Report (see Figure 42). Figure 42: Statistical Report Main Window Report Generator User s Guide Page 125

126 Statistical Reports Specifying Landscapes Specifying Landscapes From the Statistical Report main window, press Landscapes to display the Landscape dialog box. This dialog box lets you select the landscapes for which you want information. To select landscapes, click once on each landscape that you want to select. Then, click OK to return to the Statistical Report main window. See Specifying Landscapes for more detail. Specifying One or More Models From the Statistical Report main window, press Models to display the Model Selection dialog box. When you double click on a model type, a list appears underneath the model type that contains, for each selected landscape, all models present for that model type. A statistical report can only run on models of the same model type. Expand one model type and select as many models of that model type as required. When you have made all the selections for your report, click OK to return to the Statistical Report main window. See Specifying Models for a Report for more detail. Note: For Statistical Reports, the Report Generator user interface lets you choose models from only one model type at a time. In addition, unpredictable results will occur if you select models from more than one model type in SpectroGRAPH and then invoke the Report Generator. Specifying a Report Format File You can use an already configured report format file to define the output format of your report. To do this, press Report Format from the Statistical Report main window to display the Choose Report Format File dialog box. In this dialog box, navigate to the directory that contains the Statistical report format files (SG-Support/CsRib by default), then select a file. When you select a report format file, click OK and the name of the Report Generator User s Guide Page 126

127 Statistical Reports Specifying a Data Range file appears in the Report Format field of the Statistical Report main window. You can also use the Report Formatter to modify an existing format or create a new one using the event template. See Customizing a Statistical Report. Note: Some Aprisma-supplied Statistical report format files may specify attributes that are not polled and logged by default. If you want to use one of these format files, you may need to go into the Model Type Editor and turn on polling and logging for the model type you want to report on. See the SPECTRUM Model Type Editor User s Guide for more information. Specifying a Data Range Data Range lets you specify a time range for extracting the data for the report. Click one of the Data Range buttons and select a range option. Custom Day Week Month Reports data from the specified start date to the specified end date. (See Using the Custom Data Range.) Reports data from the previous calendar day (00:00:00 to 23:59:59) from the date of report execution. For example, if your report is executed on May 21, data from the statistics database from May 20 at 00:00:00 to 23:59:59 is reported. Reports data from the previous seven calendar days from the date of execution from 00:00:00 of the first day to 23:59:59 of the last day. For example, if your report is executed on Wednesday, May 24, 2000, data is reported from Wednesday, May 17 at 00:00:00 to Tuesday, May 23 at 23:59:59. Reports data from the previous calendar month from the date of execution from the first day of the month at 00:00:00 to the last day of the month at 23:59:59. For Report Generator User s Guide Page 127

128 Statistical Reports Specifying a Data Range example, if your report is executed on May 21, data will be reported from April 1 at 00:00:00 to April 30 at 23:59:59. Using the Custom Data Range If you select Custom, the Data Range dialog box in Figure 43 appears. Figure 43: Data Range Dialog Box for Custom Option SDE: To set a custom range for the report: 1 Click on the Available Range button to see what range of data exists. The range values appear in the appropriate fields after the Report Generator examines your statistics database. 2 To set a different date and time range, set the Start Date and End Date. a b Pop-up the Month menu and select a month. Click the Up or Down button next to the Day and Year to increment or decrement the settings for the day and year. 3 Set the Start Time and End Time by clicking on the Up or Down button next to the Hours and Minutes to increment or decrement the settings. (Note that the Start Time cannot be equal to or greater than the End Time.) Report Generator User s Guide Page 128

129 Statistical Reports Specifying a Report Output File Name 4 Click OK. To set the date and time settings to the current date and time, click Now and then OK. Specifying a Report Output File Name The Output File field identifies your report with a file name and path location. To specify an output file, press Output File to display the Output File dialog box. This dialog box lets you specify the path and file name for the report. If you do not specify a file name for the output file, you cannot generate a report. When you press OK, the Statistical Report main window appears with the file name in the Output File field. Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output.csv for comma delimited output Specifying the Viewing Output From the Statistical Report main window, specify how your report will be viewed by selecting one or more of the following items in the Output Format section: Tabular ASCII Tabular PostScript Graphical Display To create the report as columns of data. To create the report as a tabular PostScript file. To create the report as a graph. Depending on your data, the default graph will usually be a column graph. You can Report Generator User s Guide Page 129

130 Statistical Reports Graphical PostScript Graphical GIF Comma Delimited ASCII Where Do You Go From Here? change it later to another graph type when you display it. To create the report as a graphical PostScript file. To create the report as a graphical GIF file. This GIF can then be incorporated into an HTML page; see Using Report Output in HTML Pages for details. To create a report as a tabular common delimited ASCII file that can be opened in Microsoft Excel or Sun s Star Office. Where Do You Go From Here? You are now ready to run your report by simply clicking on the Generate icon in the toolbar. It may take a short amount of time, depending on the information to be gathered for the report. If you keep the Report Generator Main Window up, an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) appears in a popup dialog box when the report is complete. To see what your report looks like, select Reports Display from the Applications menu. See Displaying Reports for detailed instructions. You use Generate to get an indication of what a report will look like for your network needs. When you are satisfied with the appearance and the information in your report you may want to run it at a regular interval. To schedule your report to run at a later time or at a regular interval, click on the Schedule icon in the toolbar. See Scheduling Reports for detailed instructions. Report Generator User s Guide Page 130

131 Statistical Reports Customizing a Statistical Report Customizing a Statistical Report You can create a customized look for your report with the Report Formatter. What you do depends on what data you want and how you want to present it. Do you want to revise an existing report format file that you have saved? Or perhaps you want to start fresh and revise the template file that is provided in the Report Formatter. Either way you do it, the steps are the same. The basic steps are as follows: 1 From the Report Formatter, choose either: An existing statistical report format file (e.g., Open from the File Menu) or A statistical report template file (e.g., Template from the File Menu) 2 Select a model type for your report. (If you are creating a new file, this step is mandatory.) 3 Set the page size of the report. 4 Create the regions of the report format file. View the format using the Preview screen. Make adjustments to the format as necessary. 5 Use any of the advanced features of the Report Formatter. For a statistical report, these features are: Mathematical operations on the data in a report Sorting the data in your report Creating a Summary Only report 6 Name and save the new file. Note that statistical report format files are in a subdirectory whose name is the model type for which the file was created. These steps are explained in detail in the following sections. Report Generator User s Guide Page 131

132 Statistical Reports Selecting a Template File To select a template file, complete the following steps: Customizing a Statistical Report 1 In the Report Formatter window, select Template from the File menu. 2 Select Statistical Report from the Template menu. 3 From the Template dialog box, select Statistic.temp and press OK. The Statistical Template box appears, as shown in Figure Click the Model Types button. A Model Types dialog box appears. 5 Select the model type you want and click OK. Figure 44: Statistical Report Template Report Generator User s Guide Page 132

133 Statistical Reports Setting the Page Size Of the Report Set the page size of your report by following these steps. Customizing a Statistical Report 1 From the Edit menu, select Page Size to display the Current Page Settings dialog box. Note that the default settings are 80 and 66 for Page Width and Lines Per Page, respectively. 2 Enter the number of characters per line you want in the printed report in the Page Width field (1 to 200; recommended maximum is 132). 3 Enter the number of lines you want to appear on each printed report page in the Lines Per Page field (1 to 100). Creating the Regions Of Your Report You now create regions of your report and use the Preview screen to see how the format is progressing. Creating the regions of the report involves some or all of these functions: Entering text, moving text and replacing text, as required Entering objects, moving objects and replacing objects Assigning keywords and attributes to objects Using the Line and Column values to determine a location in the region Before you can work in a region, you must make it active. To make a region active, either select the appropriate button at the bottom of the window (see Figure 44), or click within the region. Note that all regions contain objects and text already assigned to locations. To perform the above tasks, see the instructions in Working In a Region. Report Generator User s Guide Page 133

134 Statistical Reports Customizing a Statistical Report Note: The report header is a required region. All other regions are optional. However, if a region is omitted, the Report Formatter prevents you from adding any of the regions that follow it. Exceptions are: (1) Comments region. (2) Summary Header region is not required before Summary Data region. The Report Header Region The only valid entries are text and the data types: FIXED and ATTR (all valid Aprisma attributes). FIXED keywords are: FIXED type Description DATE PAGE RANGE LANDSCAPE HANDLE Date and time that the report is started Page number of the report Extraction time range specified Landscape handles that reports are being run on The Column Header Region The headings in the column header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Line Data region. The only type of entry valid for this region is text. The Line Data Region For a Statistical report, the only data types for this region are FIXED and STAT (logged attributes for the given model type). The verbs (operations) Report Generator User s Guide Page 134

135 Statistical Reports Customizing a Statistical Report associated with STAT are discussed in Applying a Verb To a <STAT> Object. POLLTIME FIXED type Description The alarm log time stamp The Summary Header Region The headings in the Summary Header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Summary Data region. The only type of entry valid for the Summary Header region is text. The Summary Data Region For a Statistical report, the only data type for the Summary Data region is STAT (logged attributes for the given model type). The verbs (operations) associated with STAT are discussed in Applying a Verb To a <STAT> Object. Advanced Format Options The Report Formatter lets you set up the following operations on the data in a report: Applying a verb COMPUTE, DELTA, AVERAGE, MAX, MIN, STD_DEV, and TOTALS to a <STAT> object (see Applying a Verb To a <STAT> Object). Sorting the data in your report (see Using the Sort Operation). Top-N (see Top-N). Creating a Summary Only report (see Summary Only). The operations that you select become part of the report format file when you save it. The operations are performed when your report is executed. Report Generator User s Guide Page 135

136 Statistical Reports Customizing a Statistical Report Applying a Verb To a <STAT> Object The verb operations let you perform mathematical operations on the data in a report so that it can be more meaningful for analysis. Verbs are selected from the Statistics dialog box. They can be applied to the columns of data (associated with <STAT>) in the Line Data and Summary Data regions of your report. To apply a verb to a <STAT> object, complete the following steps: 1 Activate the Line Data or Summary Data region. (Notice that the Statistics button is now available.) 2 Select a <STAT> object. Do one of the following: To modify an existing <STAT> object, double-click on the <STAT> object at the desired column location. To create a new < STAT> object, set the cursor to the desired location and click on the Statistic button. The Statistic dialog box appears (see Figure 45). Report Generator User s Guide Page 136

137 Statistical Reports Customizing a Statistical Report Figure 45: Statistic Dialog Box Line Data Region Verb Selections: NO ACTION* COMPUTE DELTA * Default value Summary Data Region Verb Selections: AVERAGE COMPUTE MAX MIN STD_DEV TOTALS* Line Data Region verbs: Verb COMPUTE DELTA NO ACTION Description Use arithmetic expressions to compute relations between data items (see Using the Compute Operation ). Difference between a previous value and a current value, or the change in value from a prior polltime. Use data as shown. Summary Data Region verbs: Verb TOTALS Description Show the total of several data items. Report Generator User s Guide Page 137

138 Statistical Reports Verb Description Customizing a Statistical Report AVERAGE COMPUTE MIN MAX STD_DEV Show the average of the data in the column. Use arithmetic expressions to compute relations between data items (see Using the Compute Operation ). Show the minimum value of several data items. Show the maximum value of several data items. Show the standard deviation of data items. 3 Select an attribute from the Statistic dialog box. 4 From the Verb pull down menu, select a verb. The choices for the verb operation are shown in the above tables. Press the OK button. The attribute and the verb are now represented by the <STAT> object. Example of some of the verb operations are shown on the following pages. (The COMPUTE operation is covered separately in the next section.) TOTALS In the tabular report below, the total of all the data values in the Packet Rate column is shown in the Summary LAN Performance Report Page : 1 From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: Report Generator User s Guide Page 138

139 Statistical Reports Customizing a Statistical Report 9:36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Totals AVERAGE In the tabular report below, the average value of all the data values in the Packet Rate column is shown in the Summary LAN Performance Report Page : 1 From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: Report Generator User s Guide Page 139

140 Statistical Reports Customizing a Statistical Report 10:46: :56: :06: :16: :26: :36: :46: :56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Averages MIN In the tabular report below, the minimum value of all the data values in the Packet Rate column is shown in the Summary LAN Performance Report Page : 1 þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: Report Generator User s Guide Page 140

141 Statistical Reports Customizing a Statistical Report 11:56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Minimum MAX In the tabular report below, the maximum value of all the data values in the Packet Rate column is shown in the Summary LAN Performance Report Page : 1 þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Maximum STD DEV Report Generator User s Guide Page 141

142 Statistical Reports Customizing a Statistical Report In the tabular report below, the standard deviation of all the data values in the Packet Rate column is shown in the Summary LAN Performance Report Page : 1 þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Standard Dev Report Generator User s Guide Page 142

143 Statistical Reports Customizing a Statistical Report Using the Compute Operation The COMPUTE operation is used with the STAT data type in the Line Data and Summary Data regions of a Statistical report. With COMPUTE you can create new fields and columns derived from field and columns data that are already declared. The value of the new field/column is the result obtained from the evaluation of an arithmetic expression involving: Already declared field/columns. All attributes associated with the selected model type. Integer or floating point constants. Binary arithmetic operators (such as +, -, *, /, and %). The expression evaluation is done following the precedence hierarchy of multiplication, division, addition, and subtraction (e.g., * and / have a higher precedence than + and -). However, the precedence order can be changed by using parentheses. The value of the expression is always a floating point number. Examples of the use of COMPUTE are: 1 C4 = (C1 + C3 / C2 * 100) where C4 is the new column/field being added. C1, C2, and C3 are the already declared columns. 2 C5 = C4 * 2 In this example, a new column/field C5 is computed using a derived field C4, where C4 is a field derived from C1, C2, C3. 3 C4 = (C2 / C3 * 2) + 0x In this example, an attribute ID associated with an attribute is contained in the expression. Note: New expressions can only be added to the end of the Line Data or Summary Data regions. Report Generator User s Guide Page 143

144 Statistical Reports Customizing a Statistical Report To use the COMPUTE operation, follow these steps: 1 Complete the procedures in the previous section to get to the Verb pull down menu. 2 From the Verb pull down menu, select COMPUTE. (Note that Expression is now sensitized.) 3 Click on Expression to display the dialog box similar to the one shown in Figure 46. Figure 46: Expression Dialog Box In the Columns box is a list of the column numbers and a description of each: C1 POLLTIME C2 Load C3 PacketRate C4 SoftErrorRate Report Generator User s Guide Page 144

145 Statistical Reports Customizing a Statistical Report Here, C5 is the computed field. C5 is the location of the <STAT> object that you selected. C1, C2, C3, and C4 are the other columns in the report. 4 To make entries to complete the expression in the C5 = field, a b Click on the desired column entries in the Columns box. When this action is taken, the selected column number (e.g., C1) appears in the Current Expression field. Click on the appropriate entries in Operators. 5 Use the Search operation to search for an attribute in the Attribute box (if applicable). Click on the attribute to enter its attribute ID in the C5 = field. Note: In the Current Expression field, if you double click on the attribute ID the items in the Attribute box will scroll until the corresponding attribute is highlighted. 6 Press the OK button to complete the expression and exit the Expression dialog box. The expression will be executed when you run the report. Using the Sort Operation The Sort operation lets you order the rows of your report by one or more of the columns. It lets you sort the data within the columns in your report and present the data in a specific order. You can sort on any selected column (either ascending or descending); or, optionally, you can first sort on one column and then sort on another column within the first sort. To create the conditions for the Sort operation, complete the following steps: 1 Activate either the Line Data or Summary Data region. 2 Click on the Sorting button to open the Sorting dialog box (see Figure 47). Report Generator User s Guide Page 145

146 Statistical Reports Customizing a Statistical Report Figure 47: Sorting Dialog Box In the Columns box is a list of the columns in the selected region of the current report and a description of each column. Note that columns will change between the Line Data and Summary Data regions. 3 Click on the desired column entry in the Columns box. When this action is taken, the selected column number and data description are moved to the Column Sorting Order box (see Figure 47). 4 Specify the sorting order within a column Ascending (to present data items from lowest to highest value) or Descending (highest value first), by pressing the Ascending or Descending toggle buttons. Report Generator User s Guide Page 146

147 Statistical Reports Customizing a Statistical Report 5 Optionally, you can choose to sort a second column within the first sort by selecting it from the list in the Columns box and repeating the operations in Steps 3 and 4. The Up and Down buttons let you change the sort order of the two columns identified in the Column Sorting Order box. For example, if the first entry in the box is C2 and the second entry is C3, the sort order can be changed (first sort C3 followed by C2) by highlighting C2 and pressing the Down button. (Or optionally, by highlighting C3 and pressing the Up button.) The Remove button lets you remove the highlighted column entry from the Column Sorting Order box. 6 Press OK to save the sort operation as part of the report format file. The Reset button removes the column entries from the Column Sorting Order box and returns them to the Columns box. Figure 48 shows an example of a statistical report that was run with a report format file that did not have a sort. Figure 49 shows the same statistical report that has been run from a report format file that has the sort feature implemented. In the example, the sort is performed on the Packet Rate column. Report Generator User s Guide Page 147

148 Statistical Reports Customizing a Statistical Report Figure 48: Unsorted Report LAN Performance Report Page : 1 þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :15: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: :06: :16: :26: :36: :46: :56: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Averages Report Generator User s Guide Page 148

149 Statistical Reports Figure 49: Customizing a Statistical Report Sorted Report by Descending Packet Rate LAN Performance Report Page : 1 þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ From Wed Jan 05 8:00: To Wed Jan 05 12:00: Model Name mylan_2 Poll Time Soft_Errors UtilizationRateþ PacketRateþ HardErrorCount Collisions 01/05/ :56: :46: :56: :26: :26: :36: :16: :06: :16: :36: :46: :06: :36: :46: :16: :26: :16: :06: :46: :56: :56: :15: :36: :26: þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ Averages Top-N If you want to display a subset of the sorted data, click on the Top N button and enter a value in the field. For example, entering the value 20 would display the first 20 unique data items for the sort criteria. Note that if you select Ascending, you will actually get the Bottom N items. Report Generator User s Guide Page 149

150 Statistical Reports Customizing a Statistical Report Summary Only You can have your report appear with just the summary data. (The Line Data for a statistical report can be quite lengthy.) To have this option be part of your report format file, choose the Suppress Line Data toggle switch from the Format menu. The Line Data information that is collected will not appear in your report. Summary Report Column Labels The Mdl Hdl column label of a summary report is hard-coded (e.g., not derived upon report generation). Therefore, it is by default not userchangeable. However, you may wish, for example, to use the device IP address, or some other label for which there is an associated attribute ID, instead of the Model Handle. To enable the display of attribute labels other than Mdl Hdl in the headers of tabular Statistical reports summaries: 1 Edit the $SPECROOT/SG/rptscript file and uncomment (remove the hash marks before the first characters) of the following lines: #EXEC_SUM_ATTR=0x1027f #export EXEC_SUM_ATTR 2 If desired, replace the hexadecimal attribute ID value 0x1027f (IP address) with a different hexadecimal attribute ID. When you next print your tabular Statistical report, the new attribute label will be substituted for Mdl Hdl in the summary column header. Enumerated Text The SPECTRUM database supports enumerated values for attributes. What this means for tabular Statistical reports is that for certain attributes in the database, you can now substitute numeric values for text values. For example, you can substitute the enumeration 1 in place of the enumerated text string value Established for the attribute Contact_status. This enables you to perform numerical computations for summary reports. Report Generator User s Guide Page 150

151 Statistical Reports Customizing a Statistical Report By default, tabular Statistical reports will display enumerated text strings instead of enumerations. To enable the display of enumerations (even for those attributes that have corresponding enumerated text values) in tabular Statistical reports: Edit the $SPECROOT/SG/rptscript file and uncomment (remove the hash marks before the first characters) of the following lines: #DISABLE_ENUM_TEXT=1 #export DISABLE_ENUM_TEXT When you next print your tabular Statistical report, available numerical attribute values will be substituted for corresponding enumerated text values. Saving the New Report Format File To save the file, complete the following steps: If you have created a report format file from a template file. 1 Pull down the File menu on the Report Formatter main window and select Save As. The Save As dialog box appears. 2 Enter a name for the report format file. 3 Press the OK button. If you have modified an existing report format file: 1 Pull down the File menu on the Report Formatter main window and select Save or Save As. If you select Save, the modified report format file will replace the original. If you select Save As, the modified report format file is saved as a new file and the original is unchanged. 2 Enter a name for the report format file. 3 Press the OK button. Report Generator User s Guide Page 151

152 Up/Down Time Reports This section discusses how to create and customize an Up/Down Time Report. Overview The Generate feature of the SPECTRUM Report Generator allows you to create Up/Down Time reports of the historical data on your network. An Up/Down Time report provides the following information on the status of the devices on the network: Model type name Model name Model handle Contact lost time Contact established time Down time duration Up time duration Percent down time duration Percent up time duration Special events a a. Special events are the ones that affect the calculation of device Up/ Down Time duration. These events are discussed in Up/Down Time Report - Special Event Cases. Up/Down Time reports present information about the following SPECTRUM events: Table 1: SPECTRUM Events in Up/Down Time Reports Event Event Code Event Message Event x10101 The VNM has been started. Event x10102 The VNM has been shut down. Report Generator User s Guide Page 152

153 Up/Down Time Reports Overview Table 1: SPECTRUM Events in Up/Down Time Reports Event Event Code Event Message Event x10201 A new model has been created. Event x10202 A model has been destroyed. Event x10301 Device has been contacted. Event x10302 Contact has been lost with device. Event004b0002 0x4b0002 Station removed from FDDI ring. Event00010d07 0x10d07 Link of a WA_Link is down. Event00010d08 0x10d08 Link of a WA_Link is up. Event00010d10 0x10d10 LINK_GOOD event for live pipes (up event). Event00010d11 0x10d11 LINK_BAD event for live pipes (down event). Event00010d12 0x10d12 LINK_DISABLED event for live pipes (down event). Event00010d14 0x10d14 LINK_UNREACHABLE event for live pipes (down event). Note: Device models of certain model types (for example, Pingables), do not generate the events that SPECTRUM requires for Up/Down Type reports. The procedure for generating an Up/Down Time report involves making selections in the Report Generator main window. For example, you can select: The landscape(s) for which you want information The model types and models for which you want information The report format to use Report Generator User s Guide Page 153

154 Up/Down Time Reports Overview The output of the report The file name and path location for the report The time interval you want to report on from the events database After you have made all your choices, you can have the report run immediately or schedule it for a convenient time and frequency in the future. Starting the Report Generator To start the Report Generator, you complete these steps: 1 Invoke the Report Generator as described in Opening the Report Generator. 2 Select Up/Down Time as the Report Type. The main window shows the selections you must choose for an Up/Down Time report (see Figure 50). Report Generator User s Guide Page 154

155 Up/Down Time Reports Figure 50: Up/Down Time Report Main Window Specifying Landscapes Specifying Landscapes From the Up/Down Time Report main window, press Landscapes to display the Landscapes dialog box. This dialog box lets you select the landscapes for which you want information. To select landscapes, click once on each landscape that you want to select. Then, click OK to return to the Up/Down Time Report main window. See Specifying Landscapes for more detail. Specifying One or More Models From the Up/Down Time Report main window, press Models to display the Model Selection dialog box. When you double click on a model type, a Report Generator User s Guide Page 155

156 Up/Down Time Reports Specifying One or More Models list appears underneath the model type that contains, for each selected landscape, all models present for that model type. (See Specifying Models for a Report for more detail.) Expand as many model types and select as many models as required. When you have made all the selections for your report, click OK to return to the Up/Down Time Report main window. Considerations for Up/Down Time Reports on Interfaces To generate Up/Down Time reports on interfaces (Gen_If_Port, Serial_If_Port, FrameRelayPort, etc.), you must first enable Live Pipes on each of the links (interfaces) upon which you wish to report. By default, the service of Live Pipes is enabled in SPECTRUM, but as links are created they are initially non-live (gold). To enable Live Pipes on a link: 1 Right click on the link in the SpectroGRAPH. 2 Select the Enable Live Pipes menu option. 3 Click on the OK button in the resulting window. Live Pipes is now enabled for that link. The link will change color in the SpectroGRAPH from gold to the corresponding color for its status. If the link changes status, SPECTRUM will generate the proper event codes to enable the Report Generator to generate Up/Down Time reports for that interface. Models Relations in Up/Down Time Reports SPECTRUM Report Generator s Up/Down Time report generation is designed to display information on a given model as well as on any associated child models, based on one of the following relations: COLLECTS CONTAINS HASPART LOST_AND_FOUND Report Generator User s Guide Page 156

157 Up/Down Time Reports Specifying a Report Format File ORGANIZES For example, if a WA_Link model CONTAINS a WA_Segment model, an Up/ Down Time report generated for the WA_Link model will display information for both the WA_Link and WA_Segment models. To prevent the display of child model information in Up/Down Time reports: Edit the $SPECROOT/SG/rptscript file and uncomment (remove the hash marks before the first characters) of the following lines: #UPDOWN_NO_CHILDMODEL=1 #export UPDOWN_NO_CHILDMODEL When you next print an Up/Down Time report for a model, no information about associated child models will display. Specifying a Report Format File You can use an already configured report format file to define the output format of your report. To do this, press Report Format from the Up/ Down Time Report main window. The Choose Report Format File dialog box is displayed. In this dialog box, navigate to the directory that contains the Up/Down Time report format files (SG-Support/CsRib/UpDownTime, by default), then select a file. When you select a report format file, click OK and the name of the file appears in the Report Format field of the Up/Down Time Report main window. You can also use the Report Formatter to modify an existing format or create a new one using the event template. See Customizing an Up/ DownTime Report. Specifying a Data Range Data Range lets you specify a time range for extracting the data for the report. Click on one of the Data Range buttons and select a range option. Report Generator User s Guide Page 157

158 Up/Down Time Reports Specifying a Data Range Custom Day Week Month Lets you specify start and end dates and times for which data should be reported (see Using the Custom Data Range). Reports data from the previous calendar day (00:00:00 to 23:59:59) from the date of report execution. For example, if your report is executed on May 21, data from the events database from May 20 at 00:00:00 to 23:59:59 is reported. Reports data from the previous seven calendar days from the date of execution from 00:00:00 of the first day to 23:59:59 of the last day. For example, if your report is executed on Friday, May 19, 2000, data is reported from Friday, May 12 at 00:00:00 to Thursday, May 18 at 23:59:59. Reports data from the previous calendar month from the date of execution from the first day of the month at 00:00:00 to the last day of the month at 23:59:59. For example, if your report is executed on May 21, data is reported from April 1 at 00:00:00 to April 30 at 23:59:59. Report Generator User s Guide Page 158

159 Up/Down Time Reports Specifying a Data Range Using the Custom Data Range If you select Custom, the Data Range dialog box in Figure 51 appears. To set a custom range for the report: 1 Click on the Available Range button to see what range of data exists. The range values appear in the appropriate fields after the Report Generator examines your events database. Figure 51: Data Range Dialog Box for Custom Option SDE: 2 To set a different date and time range, set the Start Date and End Date. a b Pop-up the Month menu and select a month. Click the Up or Down button next to the Day and Year to increment or decrement the settings for the day and year. 3 Set the Start Time and End Time by clicking the Up or Down button next to the Hours and Minutes to increment or decrement the settings. (Note that the Start Time cannot be equal to or greater than the End Time.) 4 Click OK. To set the date and time settings to the current date and time, click Now and then click OK. Report Generator User s Guide Page 159

160 Up/Down Time Reports Specifying a Report Output File Name Specifying a Report Output File Name The Output File field identifies your report with a file name and path location. To specify an output file, press Output File to display the The Output File dialog box. This dialog box allows you to specify the path and file name for the report. If you do not specify a file name for the output file, you cannot generate a report. When you press OK, the Up/Down Time main window appears with the file name in the Output File field. Note that the Report Generator automatically appends the following file extensions:.tab for tabular ASCII output.tab.ps for tabular PostScript output.grf for graphical display output.grf.ps for graphical PostScript output.grf.gif for GIF output.csv for comma delimited output Specifying the Viewing Output From the Up/Down Time Report main window, specify how your report will be viewed by selecting one or more of the following items in the Output Format section: Tabular ASCII Tabular PostScript Graphical Display Graphical PostScript To create the report as columns of data. To create the report as a tabular PostScript file. To create the report as a graph. Depending on your data, the default graph will usually be a column graph. You can change it later to another graph type when you display it. To create the report as a graphical PostScript file. Report Generator User s Guide Page 160

161 Up/Down Time Reports Graphical GIF Comma Delimited ASCII Where Do You Go From Here? To create the report as a graphical GIF file. This GIF can then be incorporated into an HTML page; see Using Report Output in HTML Pages for details. To create a report as a tabular common delimited ASCII filet hat can be opened in Microsoft Excel or Sun Star s Office. Where Do You Go From Here? Now you are ready to run your report by simply clicking on the Generate icon in the toolbar. It may take a short amount of time, depending on the information to be gathered for the report. If you keep the Report Generator Main Window up, an informational message ( Report... completed successfully if generation succeeds, otherwise Report... completed but failed ) appears in a popup dialog box when the report is complete. To see what your report looks like, select Reports Display from the Applications menu. See Displaying Reports for detailed instructions. You use Generate to get an indication of what a report will look like for your network needs. When you are satisfied with the appearance and the information in your report you may want to run it at a regular interval. To schedule your report to run at a later time or at a regular interval, click on the Schedule icon in the toolbar. See Scheduling Reports for detailed instructions. Customizing an Up/DownTime Report You can create a customized look for your report with the Report Formatter. What you do depends on what data you want and how you want to present it. Do you want to revise an existing report format file that you have saved? Or perhaps you want to start fresh and revise the Report Generator User s Guide Page 161

162 Up/Down Time Reports Customizing an Up/DownTime Report template file that is provided in the Report Formatter. Either way you do it, the steps are the same. The basic steps are as follows: 1 From the Report Formatter, choose either: An existing Up/Down Time report format file (e.g., Open from the File Menu) or An Up/Down Time report template file (e.g., Template from the File Menu) 2 Set the page size of the report. 3 Create the regions of the report format file. View the format using the Preview screen. Make adjustments to the format as necessary. 4 Use any of the advanced features of the Report Formatter. For an Up/Down Time report, these features are: The COMPUTE operation Sorting the data in your report Creating a Summary Only report 5 Name and save the new file. These steps are explained in detail in the following sections. Selecting a Template File To select a template file, complete the following steps: 1 Select Template from the File menu. 2 Select Up/Down Time Report from the Template menu. 3 From the Template dialog box, select UpDownTime.temp and press OK. The Up/Down Time Template appears as shown in Figure 52. Report Generator User s Guide Page 162

163 Up/Down Time Reports Figure 52: Customizing an Up/DownTime Report Up/Down Time Report Template Setting the Page Size Of the Report Set the page size of your report by following these steps. 1 From the Edit menu, select Page Size to display the Current Page Settings dialog box. Note that the default settings are 80 and 66 for Page Width and Lines Per Page, respectively. 2 Enter the number of characters per line you want in the printed report in the Page Width field (1 to 200; recommended maximum is 132). Report Generator User s Guide Page 163

164 Up/Down Time Reports Customizing an Up/DownTime Report 3 Enter the number of lines you want to appear on each printed report page in the Lines Per Page field (1 to 100). Creating the Regions Of Your Report You now create regions of your report and use the Preview screen to see how the format is progressing. Creating the regions of the report involves some or all of these functions: Entering text, moving text and replacing text, as required Entering objects, moving objects and replacing objects Assigning keywords and attributes to objects Using the Line and Column values to determine a location in the region Before you can work in a region, you must make it active. To make a region active, either select the appropriate button at the bottom of the window (see Figure 52), or click within the region. Notice in all the regions there are objects and text already assigned to locations. To perform these tasks, refer to the instructions in Working In a Region. Note: The report header is a required region. All other regions are optional. However, if a region is omitted, the Report Formatter prevents you from adding any of the regions that follow it. Exceptions are: (1) Comments region. (2) Summary Header region is not required before Summary Data region. Report Generator User s Guide Page 164

165 Up/Down Time Reports Customizing an Up/DownTime Report The Report Header Region For an Up/Down Time report, the only valid entries in the report header region are text and the data types: FIXED and ATTR (all valid Aprisma attributes). FIXED keywords are: FIXED type DATE LSCAPEHDL PAGE USERNM RANGE Description Date and time that the report is started Landscape handle Page number of the report User name Time range reported on The Column Header Region The headings in the column header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Line Data region. The only type of entry valid for this region is text. The Line Data Region For an Up/Down Time report, the only data type for this region is FIXED. FIXED type DOWNTIME DOWNTIMED MODHDL MODNM MODTYPENM Description Device Contact Lost event time stamp Duration of time between a Contact Lost status and a Contacted status Model handle in hexadecimal Model name Model type name Report Generator User s Guide Page 165

166 Up/Down Time Reports Customizing an Up/DownTime Report FIXED type SPECIAL_EVT UPTIME UPTIMED Description Special event reported during the specified time range, e.g.,vnm started, VNM shut down, model created or destroyed, station removed Device Contacted event time stamp Duration of time between a Contacted status and a Contact Lost status The Summary Header Region The headings in the Summary Header can be changed to reflect the needs of your report. Remember that if you move a heading to a new location, you also should move its corresponding object in the Summary Data region. The only type of entry valid for the Summary Header region is text. The Summary Data Region For an Up/Down Time report, the only data types for the Summary Data region are FIXED and STAT (for arithmetic computations). FIXED type DOWNTIMED MODHDL MODNM MODTYPENM UPTIMED Description Sum of the total down time duration within the specified time range Model handle in hexadecimal Model name Model type name Sum of the total up time duration within the specified time range Report Generator User s Guide Page 166

167 Up/Down Time Reports Customizing an Up/DownTime Report STAT type COMPUTE Description Compute the percent DOWNTIMED and percent UPTIMED The percent DOWNTIMED and UPTIMED can be calculated by the arithmetic expression operation via the COMPUTE verb (see Using the Compute Operation). Advanced Format Options The Report Formatter allows you to set up the following operations on the data in a report: Applying the verb COMPUTE to a <STAT> object (see Using the Compute Operation). Sorting the data in your report (see Using the Sort Operation). Top-N (see Top-N). Creating a Summary Only report (see Summary Only). These operations that you select become part of the report format file when you save it. The operations are performed when your report is executed. Using the Compute Operation The COMPUTE operation is the only verb available with the Up/Down Time report. It is used with the STAT data type in the Summary Data region. With COMPUTE you can create new fields and columns derived from field and columns data that are already declared. The value of the new field/ column is the result obtained from the evaluation of an arithmetic expression involving: Already declared field/columns. Integer or floating point constants. Report Generator User s Guide Page 167

168 Up/Down Time Reports Customizing an Up/DownTime Report Binary arithmetic operators (such as +, -, *, /, and %). The expression evaluation is done following the precedence hierarchy of multiplication, division, addition, and subtraction (e.g., * and / have a higher precedence than + and -). However, the precedence order can be changed by using parentheses. The resultant value of the expression is always a floating point number. An example of the use of COMPUTE is C6 = C4/(C4+C5)*100, where C6 is the new column/field being added, and C4 and C5 are the already declared columns. To use the COMPUTE operation, complete the following steps: 1 Activate the Summary Data region. (Notice that the Statistics button is now available.) 2 Select a <STAT> object at the right of the region. Do one of the following: To modify an existing <STAT> object, double-click on the <STAT> object at the desired column location. The Statistic dialog box appears (see Figure 53). To create a new < STAT> object, set the cursor to the desired location, and click the Statistic button. The Statistic dialog box appears. Report Generator User s Guide Page 168

169 Up/Down Time Reports Figure 53: Customizing an Up/DownTime Report Statistic Dialog Box Notice that the COMPUTE verb is automatically selected, and the Expression field is set to the correct arithmetic expression for calculating the percent DOWNTIMED or UPTIMED. 3 Click the OK button. The expression will be executed when you run the report. Using the Sort Operation The Sort operation allows you to order the rows of your report by one or more of the columns. It allows you to sort the data within the columns in your report and present the data in a specific order. For an Up/Down Time report, you should always sort on the Model Handle column (in either ascending or descending order) in order to obtain a readable tabular report. To create the conditions for the Sort operation, complete the following steps: Report Generator User s Guide Page 169

170 Up/Down Time Reports Customizing an Up/DownTime Report 1 Activate either the Line Data or Summary Data region. 2 Click the Sorting button to open the Sorting dialog box (see Figure 54). Figure 54: Sorting Dialog Box In the Columns box is a list of the columns in the selected region of the current report and a description of each column. Note that columns will change between the Line Data and Summary Data regions. 3 Select the MODHDL column entry in the Columns box. When this action is taken, the selected column number and data description appear in the Column Sorting Order box (see Figure 54). Report Generator User s Guide Page 170

171 Up/Down Time Reports Customizing an Up/DownTime Report 4 Specify the sorting order within a column Ascending (to present data items from lowest to highest value) or Descending (highest value first), by pressing the Ascending or Descending toggle buttons. 5 Optionally, you can choose to sort a second column within the first sort by selecting it from the list in the Columns box and repeating the operations in steps 3 and 4. The Up and Down buttons allow you to change the sort order of the two columns identified in the Column Sorting Order box. For example, if the first entry in the box is C2 and the second entry is C3, the sort order can be changed (first sort C3 followed by C2) by highlighting C2 and pressing the Down button. (Or optionally, by highlighting C3 and pressing the Up button.) The Remove button allows you to remove the highlighted column entry from the Column Sorting Order box. 6 Click the OK button to save the sort operation as part of the report format file. The Reset button removes the column entries from the Column Sorting Order box and returns them to the Columns box. Figure 55 shows an example of an Up/Down Time report that was run from a report format file that has the sort feature implemented. In the example, the sort is performed on column 3 - Model Handle, as was specified in the Sort dialog box in Figure 54. Report Generator User s Guide Page 171

172 Up/Down Time Reports Figure 55: Customizing an Up/DownTime Report Sorted Report by Model Handle Spectrum Device Up/Down Time Report Page : 1 Date: 04/14/ :56:02 Model Name: Device Type: Landscape ID: Unplaced Unplaced 0x (coke) From Sun Apr 09 9:00: to Wed Apr 12 9:00: Model Type Name Model Name Mdl Hdl Lost Time Contacted Time Down Time Duration Up Time Duration Special Ev VNM Starte at 04/09/2 14:38:53 Host_IBM warren 0x /09/ :42: :00:00:00 001:05:42:33 Host_IBM warren 0x /09/ :42:33 04/09/ :47:03 000:00:04:30 000:00:00:00 Host_IBM warren 0x /11/ :33:43 04/09/ :47:03 000:00:00:00 001:19:46:40 Host_IBM warren 0x /11/ :33:43 04/11/ :34:43 000:00:01:00 000:00:00:00 Host_IBM warren 0x /11/ :34:43 000:00:00:00 000:22:25:17 Host_DEC m2ltx8 0x /10/ :28: :00:00:00 002:02:28:15 Host_DEC m2ltx8 0x /10/ :28:15 04/10/ :29:15 000:00:01:00 000:00:00:00 Host_DEC m2ltx8 0x /10/ :29:15 000:00:00:00 001:21:30:45 Host_IBM prism 0x68001d 04/11/ :55: :00:00:00 003:08:55:50 Host_IBM prism 0x68001d 04/11/ :55:50 04/12/ :36:08 000:13:40:18 000:00:00:00 Host_IBM prism 0x68001d /12/ :36:08 000:00:00:00 000:01:23:52 Host_IBM acorn 0x /11/ :36: :00:00:00 003:06:36:24 Host_IBM acorn 0x /11/ :36:24 04/11/ :38:33 000:00:02:09 000:00:00:00 Host_IBM acorn 0x /11/ :38:3 000:00:00:00 000:17:21:27 Host_IBM iron 0x /12/ :32: :00:00:00 003:23:32:03 Host_IBM iron 0x /12/ :32:03 04/12/ :33:03 000:00:01:00 000:00:00:00 Host_IBM iron 0x /12/ :33:03 000:00:00:00 000:00:26:57 Host_IBM amosk 0x /10/ :49:54 002:01:49:54 000:00:00:00 Host_IBM amosk 0x /10/ :55:01 04/10/ :49:54 000:00:00:00 000:06:05:07 Host_IBM amosk 0x /10/ :55:01 04/11/ :14:17 000:15:19:16 000:00:00:00 Host_IBM amosk 0x /11/ :56:36 04/11/ :14:17 000:00:00:00 000:08:42:19 Host_IBM amosk 0x /11/ :56: :16:03:24 000:00:00:00 Host_SGI coffee 0x /10/ :44: :00:00:00 002:07:44:26 Host_SGI coffee 0x /10/ :44:26 04/10/ :48:44 000:00:04:18 000:00:00:00 Host_SGI coffee 0x /10/ :48:44 000:00:00:00 001:16:11:16 Model Type Name Model Name Mdl Hdl Down Time Duration Up Time Duration % Down Time Duration % Up Time Duration Host_IBM warren 0x :00:05:30 003:23:54: Host_DEC m2ltx8 0x :00:01:00 003:23:59: Host_IBM prism 0x68001d 000:13:40:18 003:10:19:42 14:24 85:76 Host_IBM acorn 0x :00:02:09 003:23:57: Host_IBM iron 0x :00:01:00 003:23:59: Host_IBM amosk 0x :09:12:34 000:14:47: Host_SGI coffee 0x :00:04:18 003:23:55: Report Generator User s Guide Page 172

173 Up/Down Time Reports Customizing an Up/DownTime Report Top-N If you want to display a subset of the sorted data, click on the Top N button and enter a value in the field. For example, entering the value 20 would display the first 20 unique data items for the sort criteria. Note that if you select Ascending, you will actually get the Bottom N items. Summary Only You can have your report appear with just the summary data. (The Line Data for an Up/Down Time report can be quite lengthy.) To have this option be part of your report format file, choose the Suppress Line Data toggle switch from the Format menu. The Line Data information that is collected will not appear in your report. Saving the New Report Format File To save the file, complete the following steps: If you have created a report format file from a template file: 1 Pull down the File menu on the Report Formatter main window and select Save As. The Save As dialog box appears. 2 Enter a name for the report format file. 3 Press the OK button. If you have modified an existing report format file: 1 Pull down the File menu on the Report Formatter main window and select Save or Save As. If you select Save, the modified report format file will replace the original. If you select Save As, the modified report format file is saved as a new file and the original is unchanged. 2 Enter a name for the report format file. 3 Click the OK button. Report Generator User s Guide Page 173

174 Displaying Reports This section describes how to use the Report Display feature of Reports to display tabular and graphical outputs for your report. It also describes the features of graphical output in the Graphical Reports application. It describes the types and styles of graphs, and the components of the Graphical Reports main window. Displaying the Report In Tabular Output The Tabular option of Display lets you display your report formatted in rows and columns. To access the Tabular representation of your report, you complete these steps: 1 Invoke the Reports Display window as described in Opening the Report Generator. The Display Type screen shown in Figure 56 appears. Report Generator User s Guide Page 174

175 Displaying Reports Displaying the Report In Tabular Output Figure 56: Display Type Screen 2 Select Tabular as the display type. When you choose Tabular output, you access a Select File box with a list of available tabular report files. 3 Select the report file you want to display by double clicking on the filename or by single clicking on the filename and then clicking on the Display icon. Solaris: A new terminal window containing the report text appears on your screen. NT: A Windows Notepad window containing the report text appears on your screen. If the report exceeds the area of the report window, press the space bar to view subsequent screens of information. Report Generator User s Guide Page 175

176 Displaying Reports Displaying the Report In Tabular Output To delete a report file, select the Remove option from the File menu. Solaris SPECTRUM uses X Windows and Motif utilities to display reports. If you have a problem viewing a report, you may see an error message such as the following: /bin/sh: xterm not found This message means that SPECTRUM cannot find the utility it requires to open a new window and display the report. If you still want to be able to view (and print) reports through SPECTRUM, locate the subdirectory in which the terminal session utility (xterm, xwsh, etc.) resides, note the directory path, add this path to the PATH environment variable on your system, and restart SpectroGRAPH. The default path to xterm on Solaris is /usr/openwin/bin. This is what SPECTRUM expects, so do not override this path value. Otherwise use vi or another UNIX editor to view the report. Printing Tabular Reports Solaris On the Solaris platform, the feature that lets you print tabular reports through SPECTRUM is incorporated into the Display option. To print a tabular report through SPECTRUM, first display your report following the steps in the previous section. Then complete the following steps: 1 View the Print Option prompt. The print option is actually a prompt that appears at the end of an onscreen report. You can get to the prompt in one of the following ways: a b Use the space bar to scroll to the end of the report. Press the letter q to terminate the on-line view feature of Display. The following prompt appears: Do you want to print the file (Y/N)? 2 Type y and press ENTER. The following prompt appears: Do you want to print in postscript format(y/n)? Report Generator User s Guide Page 176

177 Displaying Reports Displaying the Report In Tabular Output 3 To print the file in PostScript format, type y and press ENTER; to print the file in ASCII format, type n and press ENTER. Note: Inventory and Alarm reports must be printed in PostScript format. Otherwise, the right side of the report is truncated on laser printers. 4 Respond to the prompts that then appear for the following items: - Printer name - Print mode, portrait or landscape (PostScript only) - Paper type (type h for a listing of paper types) The report prints on the specified printer. By default, SPECTRUM Report Generator prints tabular reports with no page breaks between model summaries. To force page breaks between model summaries: Edit the $SPECROOT/SG/rptscript file and comment out (insert hash marks before the first characters) of the following lines: - TABULAR_PAGE_BREAKS_DISABLED=1 - export TABULAR_PAGE_BREAKS_DISABLED When you next print your tabular report, page breaks will be inserted between model summaries. Table 2 lists the available paper types: Table 2: Available Paper Types Menu Choice Paper Type 1 US_LETTER 2 US_LEGAL 3 A3 4 A4 Report Generator User s Guide Page 177

178 Displaying Reports Displaying the Report In Tabular Output Table 2: Available Paper Types Menu Choice Paper Type 5 A5 6 B5 7 US_TABLOID 8 US_LEDGER 9 OTHER (you are prompted for paper width and height) h Help - displays this list See Table 6 for more details on paper types. To terminate the print process and return to SpectroGRAPH at anytime during these steps, press CONTROL - C. Printing Tabular Reports NT On the Windows NT platform, you print tabular reports directly from Windows Notepad, not through SPECTRUM. To print a tabular report on NT: 1 Display your report following the steps in Displaying the Report In Tabular Output. 2 In Notepad, select Print from the File menu. The report prints on the default printer. TAB text files are associated with Windows Notepad by default. You can change the association from Notepad to any other application using Windows Explorer: NT 4.0 View>Options>File Types>Edit. When you choose text files, multiple file extensions are listed (such as DIC, EXC, SCP, TAB, TXT). All files with the listed extensions will be opened with the new application. Report Generator User s Guide Page 178

179 Displaying Reports Displaying the Report In Graphical Output Windows 2000 Tools>Folder Options>File Types>Change. You can choose just TAB files. Only TAB files will be opened with the new application. Displaying the Report In Graphical Output The Graphical Reports application lets you display your report in graphical form. To access the Graphical Reports application, you complete these steps: 1 Invoke the Reports Display window as described in Displaying the Report In Tabular Output. The Display Type screen shown in Figure 56 appears. 2 Select Graphical as the display type. When you choose Graphical output, you access a Select File box containing a list of available graph report files. 3 Select the report file you want to display by double clicking on the filename or by single clicking on the filename and then clicking on the Display icon. The Specify Data dialog box appears (see Figure 57). It contains a list of available landscapes/models/model types and the associated attributes. Report Generator User s Guide Page 179

180 Displaying Reports Displaying the Report In Graphical Output Figure 57: Specify Data Dialog Box 4 Specify the data: either one or more attributes for one or more landscapes/models/model types (statistical only), or one or more attributes for one landscape/model/model type. 5 Click the OK button. A graph of the report is displayed in the Graphical Reports main window for the specified data. To display the value of each attribute (e.g., Load, or Frame Rate), click on the data point in the graph. The value of the data point is displayed in the Value field (for example, see the graphs in Figure 58 and Figure 60). Report Generator User s Guide Page 180

181 Displaying Reports The Graphical Reports Application The Graphical Reports Application The Graphical Reports main window (Figure 58) is where all graphical reports are displayed and modified, as required. For example, you can see different graphical presentations of the same data. You can then select from among the possible graph types that are defined and illustrated (see Graph Types and Styles). Depending on the extent of the data, horizontal scroll buttons are available to let you view data on other sections of the graph (see Scrolling the Graph). Figure 58: Graphical Reports Main Window General Features The following sections describe some functions that you can perform while viewing the graph. Figure 59 shows the selections from the menu bar. Report Generator User s Guide Page 181

182 Displaying Reports The Graphical Reports Application Figure 59: Menu Bar Selections Respecifying the Data For the Graph To change the data selection: landscapes/models/model types or attributes of the graph, choose Respecify from the File menu. The Specify Data dialog box in Figure 57 is displayed. Make your selections and click OK to regenerate the graph for the new data. Note: For non-statistical reports, you can choose only one device and many attributes. For Statistical reports, you can choose one attribute for one or more devices OR one device and one or more attributes. Changing Between Colors and Patterns Clicking on the Color button changes the representation of Data Sets (see Table 3) from color to patterns or from patterns to color. It may be desirable to choose patterns when printing to a non-color printer. Report Generator User s Guide Page 182

183 Displaying Reports The Graphical Reports Application Note: For line graphs, patterns do not apply, so clicking on the Color button has no effect. Resetting the Graph Click on the Reset All button to reset the graph to the either the Application Default settings or the current preference settings. An example of default settings for a statistical report are: Graph Type set to Line and the Graph Style set to Basic. See Specifying Preferences for current preferences (options and settings) and how to establish your preferences when you start a session with the Graphical Reports. Note: Changes made to the graph header and axis labels (via Graph Label and Axis Labels from the Edit submenu) are not affected by the Reset All button. Scrolling the Graph You can use the scroll buttons at the bottom of the Graphical Reports window to see different portions of the graph. Note: Line and Scatter graphs default without scrolling; i.e., all data is put on one screen. You can optionally use Zoom to see more detail, which would then allow scrolling. Goto Note: The function of the scroll buttons can be better explained if it is assumed that the graph has a total of 160 data points and one screen displays 25 data points. Report Generator User s Guide Page 183

184 Displaying Reports The Graphical Reports Application The functions of the buttons are: Goto Displays the first screen of data points (1 through 25). (This button is not shown when the first screen is displayed.) Displays the previous screen of data points. (This button is not shown when the first screen is displayed.) Displays the previous screen of data points, decremented by one. (This button is not shown when the first screen is displayed.) Displays the screen of data points starting with the midpoint (81 through 105). Displays the next screen of data points, incremented by one. (This button is not shown when the last screen is displayed.) Displays the next screen of data points. (This button is not shown when the last screen is displayed.) Displays the last screen of data points (136 through 160). Displays a screen starting from a point that you have clicked on. To use this function, first click on the data point, then press GoTo. Note that if you choose Goto on a data point that utilizes the last screen, the starting point will not be the clicked point, but will work like: If all data is on one screen (no scrolling), the GoTo option is not available. Graph Types and Styles You can present your report output in several types and styles. However, you should bear in mind that some types or styles may be more Report Generator User s Guide Page 184

185 Displaying Reports The Graphical Reports Application appropriate to the data in your report than others. The information shown in Table 3 is useful in describing graphical output. Table 3: Terms Used in Graphical Reports Axis Term Data Points Data Point Labels Data Sets Data Set Labels Graph Area Label Legend Main Window Description A horizontal or vertical line used for all graph types except Pie graphs. Axis lines provide a reference point where the data is graphed. A scale is usually located next to the axis. The X axis is positioned horizontally for all graph types except Bar graphs. For Bar graphs the X axis is positioned vertically. The Y axis is positioned vertically for all graph types except Bar graphs. For Bar graphs the Y axis is positioned horizontally. Data values that are shown at given instances. For example, in a Statistical Line graph the data points are lined up vertically above the time of each data sample. Labels used to annotate data points. Sets of data values that belong to the same category. Each data set is distinguished by a different color or pattern. Labels used to annotate each data set that are contained in the legend. The area within the main window used for graphing data. Text within the graph area used to annotate data sets. The section of the main window that contains the interpretation of the data sets. The window that contains the graph area and graphing control functions. Report Generator User s Guide Page 185

186 Displaying Reports The Graphical Reports Application Term Table 3: Terms Used in Graphical Reports (Continued) Description Scale Saved GRF File Y axis: It is used as a gauge to determine the data values. X axis: For statistical reports, it contains labels that represent instances of time for data values. For non-statistical reports, it represents models or model types. A saved GRF file is an original file that was updated and then saved via a Save or Save As function. It contains various options of that session. Graph Types The following graph types are available in the Graphical Reports application: Column Bar Line Scatter Area Pie When you specify graphical output for your report, the output defaults to a specific graph type. The default graph type depends on your report type and the information in the report (i.e., number of data sets and data points). Table 4 shows these dependencies. For example, a Statistical Report with one data set and more than one data point will appear as a Line graph. You can display other graph types for the report, as appropriate. Report Generator User s Guide Page 186

187 Displaying Reports The Graphical Reports Application Table 4: Default Graph Type All Reports (except Statistical) One Data Set More Than One Data Set One Data Point Column Pie More Than One Data Point Column Column Statistical Report One Data Set More Than One Data Set One Data Point Column Pie More Than One Data Point Line Line The following tables outline the types of graphs provided with Graphical Reports.. Type of graph Column graph Shows data sets (e.g., Errors, Load, Frame Rate) and data points using vertical rectangles. The Graph Style is set to Basic as the default Sample graph Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thur Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate 0 01/27/ :00 01/27/ :10 01/27/ :20 01/27/ :30 Poll Time Report Generator User s Guide Page 187

188 Displaying Reports Type of graph Bar graph Shows data sets (e.g., Errors, Load, Frame Rate) and data points using horizontal rectangles. The Graph Style is set to Basic as the default. Line Graph Shows data sets (e.g., Errors, Load, Frame Rate) and data points plotted along the X axis and Y axis, connected by a continuous line for each data set. The Graph Style is set to Basic as the default. See Changing the Appearance Of the Graph to show markers ( ) for each data point. However, it is not recommended that you show markers in a line graph if you plan to use the Zoom option to zoom out to all data points for a screen. See Zooming on the Graph. The Graphical Reports Application Sample graph Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate 01/27/2000 8:00 01/27/2000 8:10 01/27/2000 8:20 01/27/2000 8:40 01/27/2000 8:50 01/27/2000 9:00 01/27/2000 9: /27/ :00 Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate 13:00 17:00 08:40 13:40 17:40 20:20 Report Generator User s Guide Page 188

189 Displaying Reports Type of graph Scatter Graph Shows data sets (e.g., Load, Errors, Packets) and data points plotted along the X axis and Y axis. The Graph Style is set to Basic as the default /27/ :10 The Graphical Reports Application Sample graph Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate 09:00 09:20 10:50 12:00 13:10 14:20 15:30 16:40 17:10 18:20 18:40 08:50 10:20 11:30 Area Graph Shows data sets (e.g., Errors, Load, Frame Rate) and data points using areas filled with either patterns or colors. The Graph Style is set to Stacked as the default Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Fri Jan 28 03:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate 0 01/27/ :00 08:00 17:00 18:40 13:40 17:40 20:20 01/28/ :20 Report Generator User s Guide Page 189

190 Displaying Reports The Graphical Reports Application Pie Graph Shows all the data sets (e.g., Errors, Load, Frame Rate) and data points combined in one divided circle. The only Graph Style is Relative. Pie is the default graph type when your report has only one data point and more than one data set. You can still change the graph to other applicable graph types. Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CLI_IRM2 IP Address: Errors Load Frame Rate You can explode the pie (i.e., remove a section) by clicking your pointer on a slice. Report Generator User s Guide Page 190

191 Displaying Reports Graph Styles The Graphical Reports Application The Graph Style buttons (Basic, Stacked, Relative) let you present graphical data in different formats. The following tables outline the types of graph styles provided with Graphical Reports. Type of style Sample style Basic Presents data sets in: a.) A side-by-side fashion for Bar and Column graphs (shown here). b.) An overlaid fashion for Line, Area and Scatter graphs Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CSI_IRM2 IP Address: Errors Load Frame Rate 0 01/27/ :00 08:20 08:40 09:00 09:20 10:00 10:20 10:40 11:00 Stacked Presents different data sets, stacked on top of one another Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CSI_IRM2 IP Address: Errors Load Frame Rate 0 01/27/ :00 08:20 08:40 09:00 09:20 10:00 10:20 10:40 11:00 Report Generator User s Guide Page 191

192 Displaying Reports Type of style Relative Presents different data sets, stacked on top of one another, compared with one another, and always totaling 100%. The Graphical Reports Application Sample style Daily Device Utilization and Error Report From Thu Jan 27 08:00: to Thu Jan 27 20:00: Device Name:Hub.111 Device Type: Hub_CSI_IRM2 IP Address: Errors Load Frame Rate 100% 80% 70% 60% 50% 40% 30% 20% 0% 01/27/ :00 08:20 08:40 09:00 09:20 10:00 10:20 10:40 11:00 Data Point Labels and Data Values The numbers in the Data Point Labels legend (shown at the right of a graph) correspond to the points on the X axis. For example, in Figure 60 the X axis shows Poll Time information that includes the Errors, Load, and Frame Rate attributes for the device. The Data Point Labels legend lists the date and time the device was polled. (The first column contains the data point. The second column contains the data point label.) To display the value of each instance of a Data Set (e.g., Errors, Load, or Frame Rate), click on the data point in the graph. The value of the data point is displayed in the Value field. The Data Point Labels legend does not apply to a Pie or Bar graph, since the labels can be applied directly to the graph. Note: When your report has four or less data points (or if you zoom to four or less) the Data Point Labels legend is blank. In this case, the data point label is shown at the data point in the graph (see Figure 63). To display the value, click on the data point. Report Generator User s Guide Page 192

193 Displaying Reports Figure 60: The Graphical Reports Application Graph in Expanded Format Expanded Condensed This button lets you have all data point labels appear in the Data Point Labels legend (see Figure 60). You can use the vertical scroll bar to see all the labels. This button lets you display only the data point labels shown on the graphing the Data Point Labels legend. The Condensed function is useful when you want to display (and print out) the screen that shows the entire range of data points with only the displayed labels in the legend (see Figure 61). Report Generator User s Guide Page 193

194 Displaying Reports Figure 61: The Graphical Reports Application Graph in Condensed Format Editing Functions The edit functions of Graphical Reports let you: Zoom on the graph Change the format of the graph Scale the bounds of the data in the graph Edit the graph label and the axis labels of a graph Zooming on the Graph You can display the data at different levels of granularity with the Zoom option. Choose Zoom from the Edit menu to open the dialog box shown in Figure 62. Report Generator User s Guide Page 194

195 Displaying Reports The Graphical Reports Application Tip: Clicking on a data point prior to using Zoom will zoom starting from that data point. Figure 62: Zoom Dialog Box To use the Zoom option, follow these steps: 1 On the Data Points scale, slide the pointer to the number of data points you want to be displayed on the screen. 2 Press Update. The graph is regenerated with the selected number of data points. Figure 63 shows the column graph for 4 data points. Figure 64 shows the column graph for 29 data points. 3 If you want to update and close the Zoom screen, press OK after completing Step 1. Report Generator User s Guide Page 195

196 Displaying Reports The Graphical Reports Application Note: When you zoom to 4 or less data points, the Data Point Labels legend is blank. In this case, the data point labels are shown at the data points in the graph (see Figure 63). The zoom option does not apply to a pie graph or for graphs with one data point. For Line, Scatter, or Area graphs, the minimum number you can zoom to is 2. Figure 63: Column Graph at 4 Data Points Report Generator User s Guide Page 196

197 Displaying Reports Figure 64: The Graphical Reports Application Column Graph at 29 Data Points Note: The display of graphical reports (and corresponding GIF and PostScript files) is limited to a maximum of 32,766 data points. This restriction does not apply to tabular reports. If the report contains no data points, and you select Graphical PostScript and GIF output, an error message will appear advising that GIF and PostScript file generation has failed. No PostScript or GIF files are created. Changing the Appearance Of the Graph Choose Graph Format from the Edit menu to open the Graph Formatting dialog box (see Figure 65) that contains several fields in which you can adjust or select: Axis Location Report Generator User s Guide Page 197

198 Displaying Reports The Graphical Reports Application Scale Location Scale Type (Linear or Log [Logarithm]) Legend Location Show Grid Show Markers Figure 65: Graph Formatting Dialog Box The Up, Down, Left, Right locations are determined by the directional arrows that you select. (Note that as you make a selection, the appearance of the graph is changed.) Axis Location: X axis can be positioned at the top or bottom of the graph (for bar graphs, at the left or right of the graph). Y axis can be positioned at the left or right of the graph (for bar graphs, at the top or bottom of the graph). Scale Location: Report Generator User s Guide Page 198

199 Displaying Reports The Graphical Reports Application X scale can be positioned along the top or bottom of the graph (for bar graphs, at the left or right of the graph). Y scale can be positioned along the left or right side of the graph (for bar graphs, at the top or bottom of the graph). Scale Type: The scale along the X axis can be set to Linear or Logarithm. Linear is the default setting. The scale along the Y axis can be set to Linear or Logarithm. Linear is the default setting. Logarithm can only be displayed when all data values are positive (greater than zero). Legend Location: Valid locations for the Legend are: Top, Bottom, Left, and Right of the graph. Top is the default setting. Show Grid: Show (or don t show) the grid on the X axis or Y axis. Grid lines (horizontal or vertical) are used to help read the data in the graph. Show Markers: For line graphs, show (or don t show) markers (+) for each data point. Reset: This button resets the Graph Formatting options to their default values. It does not affect the graph type and style settings (i.e., Reset All). Close: This button closes the Graph Formatting dialog box with the selections intact. Setting the Scale Bounds You can change the scale on the Y axis with the Scale Bounds option. Choose Scale Bounds from the Edit menu to open the dialog box shown in Figure 66. Report Generator User s Guide Page 199

200 Displaying Reports The Graphical Reports Application Note: Scale Bounds does not apply when the Graph Type is currently set to Pie. Figure 66: Scale Bounds Dialog Box The Scale Bounds dialog box has the following options: Bounds Source Application determines bounds Click on this button to have the Graphical Reports application determine the bounds on the Y axis of your graph. If all positive values are detected in the data, then the minimum value on the Y axis is set to 0. If a 0 value is detected in the data, then the minimum value is set to a negative number. This is done so that the X axis does not obscure any data points that may be too close to the X axis. Report Generator User s Guide Page 200

201 Displaying Reports The Graphical Reports Application Derived from actual reported data Click on this button to set the bounds on the Y axis based on the actual data values. The highest and lowest values that are detected are used. This option may result in some data points being obscured by the X axis. The bounds settings made via the Bounds Source selections are reflected in the Bounds Scope fields. Bounds Scope Set bounds based on each screen This option is active when you first select Scale Bounds. It displays the minimum and maximum values of the graph data in the current screen. You can click in the Min or Max fields of the Bounds region and enter new values. Clicking the OK button will regenerate the current screen with the Y axis corrected to show these values. This selection is not available if all data points can fit on one screen (no scrolling). Set bounds based on all data reported This button lets you display the minimum and maximum values of all the data points in the graph, regardless of what is currently displayed (see Figure 67). You can click in the Min or Max fields of the Bounds region and enter new values. Pressing OK will regenerate the current screen of data points with the Y axis corrected to show these values. Note: Set bounds based on all data reported is useful when you want to see at a glance the maximum and minimum values for all data collected. Also, choose Bounds Source Derived from actual reported data for this step. Report Generator User s Guide Page 201

202 Displaying Reports Figure 67: The Graphical Reports Application Default Bounds for All Data Set your own bounds This button lets you set the minimum and maximum values to be displayed on the Y axis of the graph. Pressing OK regenerates the graph with the Y axis showing these values. For example, in Figure 68 the graph is displayed for Min set to -20 and Max set to 120. Set your own bounds is useful when you want to see values of those data points that are small in comparison to the other values. When you choose Set your own bounds, the Bounds Source is automatically set to Derived from actual reported data, since the application is not determining the bounds. Note: The minimum scale bounds on the graph is determined by the incremental values currently being used for the Y axis. Thus, setting Min to -1 may produce a minimum scale bounds of -20 for the graph shown in Figure 68. Report Generator User s Guide Page 202

203 Displaying Reports Figure 68: The Graphical Reports Application Results of Setting Own Bounds You can also define your own scale bounds by editing the definitions of the following environmental variables in the $SPECROOT/report.config/default.PRF file: VARIABLE DESCRIPTION VALID ARGUMENTS USER_DEFINED_BOUNDS USER_BOUNDS_MIN USER_BOUNDS_MAX Specifies whether default or user-defined scale bounds are used. Specifies the minimum scale bounds. Specifies the maximum scale bounds. 0 Use default scale bounds 1 Override default scale bounds See Bounds Source and Bounds Scope. See Bounds Source and Bounds Scope. Report Generator User s Guide Page 203

204 Displaying Reports The Graphical Reports Application The same rules apply for setting minimum and maximum scale bounds in the default.prf file as for setting them via the Scale Bounds Dialog Box (see Figure 66). Editing the Graph Label You access the Graph Label dialog box (see Figure 69) by choosing Graph Label from the Edit menu. To edit the text of the graph label (or header), click on the line of text and follow these steps: 1 To delete text: a To delete the entire line (highlighted), press the Delete or Backspace key from your keyboard or b To delete a selected portion of text, highlight the portion of text by dragging the mouse over the text and then press the Delete or Backspace key. 2 To edit a line of text: a b With the mouse or arrow keys, move the cursor to the desired position (the highlighted text becomes un-highlighted). Type in the changes. If you create too many lines in the graph label, it may affect the display of the data in the graphing area. 3 Press OK. The graph appears with the changes in the label. Report Generator User s Guide Page 204

205 Displaying Reports The Graphical Reports Application Figure 69: Graph Label Dialog Box You can press Cancel to cancel the editing session without making changes. Editing the Axis Labels You access the Axis Labels dialog box (see Figure 70) by choosing Axis Labels from the Edit menu. (Axis Labels is not applicable to Pie graphs.) To edit the text of the axis label follow these steps: 1 Press on the Axis Label box (either X Axis or Y Axis). An insertion point appears in the box. 2 Modify existing text or enter new text. 3 Press OK. The graph now appears with the new label on the axis. Report Generator User s Guide Page 205

206 Displaying Reports The Graphical Reports Application Note: When the axis label is positioned vertically, only 20 characters (including spaces) can be displayed in the graph area. When the axis is positioned horizontally, the maximum number of displayable characters is 40. Editing Axis Labels does not apply to a Pie graph. Figure 70: Axis Labels Dialog Box Saving a Graph File Once you have viewed a graph, you may want to save it before loading another graph or quitting Graphical Reports. Saving a graph will save your current options selected to the file. To save the graph, follow these steps: 1 Pull down the File menu and select Save or Save As. In the File Selection box, enter a name for the graph file including the.grf extension. You must do the following: Report Generator User s Guide Page 206

207 Displaying Reports The Graphical Reports Application When specifying the output file, enter the filename in the second text box from the top. If you wish to change the directory for the file, you must specify the directory in the first text entry box. You must press Enter at the end of the specification while currently in that text box. If you just specify a directory without pressing Enter, the file you want to save will go into the directory that was displayed when first entering the file list widget. 2 Click the OK button. The graph file is saved. When you load this graph file again, the file name appears in the File Loaded field in the main window. Loading Another Graph File Once you have opened the Graphical Reports application, you can load another graph file by choosing Load from the File menu. The Graph Specification File dialog box appears. Select a file and click OK. The Specify Data dialog box (similar to Figure 57) appears. Make your choices and click OK. The graph then displays, and you can see different graphical presentations of the data by following the procedures in the previous sections. Specifying Preferences You can select how your graph will appear when you enter the Graphical Reports by making a preference. Preferences are options and settings from the choices (including Print) in the main window. You can access the preference commands from the Preference menu. Clear Load Save Sets the preferences to the Application Defaults. Opens a Preference Files Selection dialog box. Select a file name. When you click OK, the graph on display will regenerate with the preferences associated with the file. Opens a Save As dialog box. Enter a filename with the extension PRF. The file will have the options and settings Report Generator User s Guide Page 207

208 Displaying Reports The Graphical Reports Application Info associated with the graph on display. Click OK to save the file. In the future the file will be accessible from the Preference File Selection dialog box via the Load command. If you currently do not have a preference loaded but want to use one that was previously saved, then you must Load the preference file for it to take effect for the current session. Opens the Info dialog box shown in Figure 71. This box shows the preference file associated with the graph on display. When no preference file has been loaded for the graph, the options and settings are The Application Defaults. Report Generator User s Guide Page 208

209 Displaying Reports The Graphical Reports Application Figure 71: Preference Information General Considerations When you access the Graphical Reports application on the Solaris platform, it attempts to load your preference file (<login_name>.prf), if found, from the following directories (in order): 1 Your home directory 2 The $SPECROOT/app-defaults directory 3 The $SPECROOT/SG directory On the NT platform, Graphical Reports searches only the $SPECROOT/SG directory. Report Generator User s Guide Page 209

210 Displaying Reports The Graphical Reports Application The following rules apply to the use of preferences or saved GRF files: Whenever a preference is loaded, the following actions will restore any modified options/settings back to the states in the preference file. - Press Reset All - Load a GRF file - Respecify a GRF file Whenever a saved GRF file is loaded but preferences are not, the following actions will restore any modified options/settings back to the states in the saved GRF file. (Note: a saved GRF file is an original file that was updated and then saved via Save or Save As.) - Press Reset All - Load a GRF file - Respecify a GRF file Selecting Clear from the Preference menu, always clears the current state for options/settings and sets them back to the Application Defaults. Saving a preference. If a preference is currently loaded and you then Save that preference, any altered options/settings for the current session are saved in the specified preference file. If you Save to a currently loaded preference file, the current state of the options/settings are used for the current session (unless you Clear preferences). If you Save to a preference file that is not currently loaded, the specified preference file is altered, but the current session continues to use the loaded preference file. Selecting Reset All. If you select Reset All when your preference is loaded, any settings that you have altered are restored to the values based on the loaded preference file. Report Generator User s Guide Page 210

211 Displaying Reports The Graphical Reports Application If you select Reset All when a saved GRF file is loaded (without preferences), the options/settings in the saved GRF file are used. Any settings that you have altered are restored to the values based on the saved GRF file. If you select Reset All when the state is The Application Defaults (no preferences or saved GRF files), then the options/settings used are the Application Defaults. Any settings that you have altered are restored to the Application Defaults. Loading or respecifying a saved GRF file. If you Load or Respecify a saved GRF file when a preference file is loaded, the options/settings in the preference file are used. If you Load or Respecify a saved GRF file when no preference file is loaded, the options/settings in the GRF file are used. The following Graph options and application settings are saved and restored when using preferences and saved GRF files: Table 5: Graph Options Graph Options (Main) Graph Options (Formatting): Graph Type:** (Line, Scatter, Area, Column, Area, Pie) Graph Style:** (Basic, Stacked, Relative) Graph Label: (one for each model) X Axis Label: (one for each model) Y Axis Label: (one for each model) Data Point Label Mode:** (expanded/condensed) Bounds Scope: Determined by Application* / Derived from data values. Color On: (yes*, no) X Axis Location: (top, bottom*) Report Generator User s Guide Page 211

212 Displaying Reports The Graphical Reports Application Y Axis Location: (left*, right) X Scale Location: (top, bottom*) Y Scale Location: (left*, right) X Scale Method: (linear*, logarithmic) Y Scale Method: (linear*, logarithmic) Legend Location: (top*, bottom, left, right) Show X Grid: (yes, no*) Show Y Grid: (yes, no*) Show Markers: (yes, no*) * application default, ** default settings vary based on report type and current data The following print settings are saved and restored when using preferences and saved GRF files: Table 6: Print Settings Paper Orientation: Landscape*, Portrait Paper Type: US_Letter w:8.5 x h:11 * US_Legal w:8.5 x h:14 A5 w:5.83 x h:8.27 A3 w:11.69 x h:16.54 US_Tabloid w:11 x h:17 OTHER (you specify) A4 w:8.27 x h:11.69 B5 w:7.17 x h:10.12 US_Ledger w:17 x h:11 Report Generator User s Guide Page 212

213 Displaying Reports The Graphical Reports Application Paper Width: Paper Height: Poster Layout: X Overlap: Y Overlap: specified in Points*, Inches or mm specified in Points*, Inches or mm yes, no* specified in Points, Inches or mm specified in Points, Inches or mm Scaling Mode: Same factor X and Y* Separate X and Y factors Fit to page Fit to page width X Scaling Factor: specified in %, 100%* Y Scaling Factor: specified in %, 100%* Left Margin: Right Margin: Top Margin: Bottom Margin: Output To: Print Command: Filename for Write to File : specified in Points*, Inches or mm specified in Points*, Inches or mm specified in Points*, Inches or mm specified in Points*, Inches or mm Printer*, File lpr* or lp Graphrpt.ps Fill one page Fit to page height Report Generator User s Guide Page 213

214 Displaying Reports The Graphical Reports Application Printer Device for Send to Printer : Print Area: blank* Graph Only, Entire Window* *application default ** default settings vary based on report type and current data Printing the Graph You can elect to print either the: Graph shown on the screen including all the information in the window, or Graph only For graphs that are larger than the current window, you can also specify printing of all pages in the graph or only the contents of the current window. Choose Print from the File menu to open the dialog box shown in Figure 72. Report Generator User s Guide Page 214

215 Displaying Reports The Graphical Reports Application Figure 72: Print Graph Dialog Box Note: Before printing a graph, you may want to set up your page. See Print Setup. Report Generator User s Guide Page 215

216 Displaying Reports The Graphical Reports Application Printing Graphical Reports in a UNIX Environment 1 In the Print area, choose one of the following: Print Graph including Entire Window to print the portion of the graph and associated information currently displayed in the window. Print Graph Area Only to print just the portion of the graph currently displayed in the window. Print All Pages (Graph Area Only) to print all pages of the graph. Print All Pages (Entire Window) to print all pages of the graph and its associated information. 2 In the Output area: Click Printer Name (UNIX)/Command (NT) and type the printer name in the field. Select the Print Command, either lpr or lp. or Click Write To File and type the name of the file in the field. Note: You will be able to type in the text entry field only if you are printing from a UNIX workstation, or if on NT, you have completed Step 1 in the section, Printing Graphical Reports in an NT-only Environment. a Click OK to send the graph to the printer or save your selections in the file. To accept changes to the graph without printing, press the Accept button in the Print Graph Dialog Box. Printing Graphical Reports in an NT-only Environment In instances where there are no UNIX print queues, you may have to specify a unique NT print queue server and printer name. This can be accomplished by using variant of the lpr command. Report Generator User s Guide Page 216

217 Displaying Reports The Graphical Reports Application To define a unique print server and printer name in an NT-only print queue environment: 1 Open the $SPECROOT/report.config/default.PRF file in a text editor, and change the following entry: From //USENTPRINT 1 To //USENTPRINT 0 2 Restart the Report Display to display your graphical report. 3 Choose Print from the File menu to open the dialog box shown in Figure Follow the instructions in the section, Printing Graphical Reports in a UNIX Environment, with the following differences: a b Under Printer Name (UNIX)/Command (NT), the dialog box contains the string, lpr -S server1 -P printer1 -o l. Select that string and modify the lpr command such that: "server1" is replaced with the name (or IP address) of the NT lpd service host. "printer1" is replaced by the name of the desired NT print queue. Caution: Use care when editing the default.prf file. Standard text editors, like vi, add a carriage return to the end of each line, which creates problems during report generation. Using a "safe" editor, such as Windows Notepad (or editing on UNIX, then transferring the file in binary mode to NT), will not cause such issues. 5 Click OK to send the graph to the desired printer. Table 7 shows the relation between the use of print settings saved in Preference and GRF files. Report Generator User s Guide Page 217

218 Displaying Reports The Graphical Reports Application Table 7: Print Settings Relations Source for Print Settings Action Takenþþþþþ Preferences Loaded GRF file was updated Use information in preference file Invoked application Yes n/a Use current session settings Load, Respecify, Reset All, Clear preferences Yes n/a Use settings in saved GRF file Invoked application, Load No Yes Use The Application Defaults Invoked application No No Use current session settings Load No No Use current session settings Respecify, Reset All, Clear preferences No n/a Print Setup Choose Print setup from the File menu to open the Print Setup dialog box shown in Figure 73. You can choose from among various page sizes listed and identify the orientation of the page, landscape or portrait. The best settings for graphs may be Landscape and the selection fit to page. Choose fit to page from the choice box pull down located in the Scaling and Overlap area of the screen. Report Generator User s Guide Page 218

219 Displaying Reports The Graphical Reports Application Figure 73: Print Setup Dialog Box You prepare the printed page layout of a graph by following these steps: 1 In the Page Size area: a b c Pull down the appropriate Paper Type. The selections are: Inches US Letter, US Legal, US Tabloid, or US Ledger Metric A5, A4, A3, B5 Point Other When you select a Paper Type, the appropriate width dimension is displayed in the Paper Width field. When you select a Paper Type, the appropriate height dimension is displayed in the Paper Height field. 2 In the Margins area: Report Generator User s Guide Page 219

220 Displaying Reports The Graphical Reports Application a b c d In the Left field, type the left margin of the paper. In the Right field, type the right margin of the paper. In the Top field, type the top margin of the paper. In the Bottom field, type the bottom margin of the paper. 3 In the Orientation area, either: a b Click Portrait to print in portrait mode. Click Landscape to print in landscape mode. 4 In the Scaling and Overlap area: a b c d e f Pull down the appropriate Scaling Mode. The selections are: same factor in X and Y, separate X and Y factor, fit to page, fit one page (unequal), fit page width, and fit page height. Select a % value in the X Scaling field. Select a % value in the Y Scaling field. Select a value in the X Overlap field. Select a value in the Y Overlap field. Select the Poster Layout button to activate the X Overlap and Y Overlap fields. Note: The terms X Scaling and Y Scaling are for setting up your page. They should not be confused with the graph terms used in Graphical Reports. 5 In the Units area, select either mm, inch, or point. 6 Select OK to save the page setup. Report Generator User s Guide Page 220

221 Scheduling Reports This section describes how to schedule the execution time of your report. Accessing the Scheduler The Schedule option from the Report Generator main window lets you schedule at what time and how often you want to run your report (see Figure 74).See Scheduling a Report for instructions for scheduling reports. Figure 74: The Scheduler Dialog Box Report Generator User s Guide Page 221

222 Scheduling Reports Accessing the Scheduler The Scheduler contains the following fields and buttons: Current Date Field Command Frequency Scheduled Entries This field, located at the top of the Scheduled Entries list, displays the current date and time (24- hour clock format). This field displays the scheduled command. When you bring up the Schedule dialog box, the Scheduler enters the information in the Command field. The Frequency menu lets you specify how often to run the report. Frequency options are: Once, Hourly, Daily, Weekly, and Monthly. Each of these frequency options also includes a start-time option. Click on the Up or Down buttons to set the time. This list contains entries that you will apply or have applied to the Scheduled queue. After you specify the frequency date and time of the report execution and press the Add button, the Scheduler displays the entry in this list. Then when you click on the Save button, the Scheduler schedules this entry. Note: An entry in the Scheduled Entries list is made up of two parts, the scheduling information at the beginning and the command, enclosed in quotes, in the rest of the line. The Command field, on the other hand, contains only the command. Add Modify Press the Add button when you have specified the frequency date and time in the appropriate fields. When you press Add, the entry is displayed in the Scheduled Entries list. (Note that Add inserts the entry only in the Scheduled Entries list, while Save inserts the entry in the Scheduled queue.) The Modify button enables you to modify the entries in the Scheduled Entries list. As with the Report Generator User s Guide Page 222

223 Scheduling Reports Accessing the Scheduler Add button, Modify only modifies the entry in the Scheduled Entries list, whereas Save modifies the entry in the Scheduled queue. To modify an entry, follow these procedures: 1 Highlight the entry you want to change in the Scheduled Entries list. 2 Click on the appropriate buttons in the Frequency section. 3 Press the Modify button. The highlighted entry is replaced with the new information. Remove Save Reset Close The Remove button enables you to delete any entry in the Scheduled Entries list. (As with the Add and Modify buttons, the Remove button only deletes the entry in the Scheduled Entries list, whereas Save deletes the entry in the Scheduled queue.) Just highlight the entry and click on the Remove button. Press the Save button to send the entries in the Scheduled Entries list to the Scheduled queue. Press the Reset button to reread the Scheduled queue. After you press the Reset button, the Scheduled Entries list displays only those entries that are in the Scheduled queue. Press the Close button to close the Scheduler dialog box. Any add, modify, or remove operations you have performed will be lost unless you have pressed the Save button prior to closing. Report Generator User s Guide Page 223

224 Scheduling Reports Scheduling a Report Scheduling a Report Note: Windows 2000/NT Considerations Before using the Scheduler, Windows 2000/NT users should make sure that the Schedule Service is setup properly. See the Scheduler Requirements for Windows 2000/NT in the After Installing SPECTRUM section of the Installation Guide. Follow these steps to set up a schedule for running your report: 1 Click the Landscapes... button to select a landscape (if different from the default landscape). 2 Click the Models... button to select the model type for which you wish to generate a report. 3 Click the Report Format... button to select a report type. 4 Click the Output File... button to specify an output file name. 5 Click the Data Range drop-down list button to select the data range the report should cover. 6 From the Report Generator main window, click the Schedule button to display the Scheduler dialog box. 7 Select one of the Frequency options Once, Hourly, Daily, Weekly, Monthly. When you select a Frequency option, the Frequency section displays the appropriate options (see Figure 75). Once lets you specify the month, day, and start-time. On the NT platform, you can schedule report execution up to a month in advance; on other platforms, you can schedule report execution up to a year in advance. Hourly lets you specify the number of minutes (00 to 59) after each hour. This option is available only on the UNIX platform. Report Generator User s Guide Page 224

225 Scheduling Reports Scheduling a Report Daily lets you specify the time. Weekly lets you specify the day of the week and the time. Monthly lets you specify the day of the month and the time. When you select the Once, Daily, Weekly, and Monthly options, you must schedule a start time. Use the Up or Down buttons to specify a time between 00:00 (midnight) and 23:59 (11:59 PM). When you select the Hourly option, you have to schedule the minutes start time. Use the Up or Down buttons to specify the number of minutes after the hour between 00 and When you have selected the desired scheduling options, click the Add button. The Scheduler inserts the scheduling information in the Scheduled Entries list. 9 When you are finished, click the Save button to send the entry or entries to the Scheduled queue. The Scheduler applies the entries to the Scheduled queue and performs the operations automatically at the specified time(s). 10 Click the Close button to close the Scheduler dialog box and return to the Report Generator main window. Report Generator User s Guide Page 225

226 Scheduling Reports Scheduling a Report Figure 75: Frequency Options Note: If you are running SPECTRUM as root and you schedule a report to be run in the future, root may or may not get mail upon completion of the report depending on how mail is configured on your network. If you are a non-root user, you must be running in the Bourne shell or C shell in order to receive mail upon completion of the report. Report Generator User s Guide Page 226

227 Scheduling Reports Scheduler Update Scripts Note: If a scheduled report is currently running, you must wait until that report completes before you schedule another report. Failure to do so will result in the second report not running at that time and being scheduled for the same time the next year. Scheduler Update Scripts Aprisma supplies four script files that you can use in conjunction with Custom time range reports that you want to schedule (for example, if you want to run a report on a daily basis that obtains events data between 13:00 and 16:00). These four files, located in the <$SPECROOT>/ report.config/post_gen_scripts directory, are: hourlyupdate.sh -- Increments the scheduled time by one hour every time report execution is invoked via the Scheduler. dailyupdate.sh -- Increments the scheduled time by one day every time report execution is invoked via the Scheduler. weeklyupdate.sh -- Increments the scheduled time by one week every time report execution is invoked via the Scheduler. monthlyupdate.sh -- Increments the scheduled time by one month every time report execution is invoked via the Scheduler. To enable one of these scripts, use the Post Generate Script button on the Report Generator main window to specify the filename for that script (see Reporting Fundamentals). Report Generator User s Guide Page 227

228 Setting Defaults In the Resource Files This section discusses changing resources in the Report Generator resource files (RibE and Reports). You can modify these files using a text editor to change the default startup parameters. A resource file consists of a list of resources interspersed with comment lines. Each resource defines the appearance, or an operational feature, of SPECTRUM Report Generator running in the X Window System environment. For example, you have resources that support Report Generator by defining its default settings, such as the appearance of its menu bar. Resources allow you to change the default settings to whatever might be more useful in your particular environment. You do this by changing or adding a resource value in the expressions in the resource file. At installation, SPECTRUM Report Generator creates a resource file (called Reports) in the app-defaults directory created during installation. If you copy your resource file to your home directory, it will use that one instead. You can customize the following parameters: Default values Colors Fonts Note: Paths may differ depending on your particular installation. Report Generator User s Guide Page 228

229 Setting Defaults In the Resource Files The RibE Resource File The RibE Resource File The RibE resource file establishes the default SPECTRUM Report Formatter startup parameters. To override a default parameter, you need to specify the new parameter value in this file. The following RibE file is shipped with SPECTRUM:!! SPECTRUM Report Formatter default startup parameters!! Reports Formatter #include "RibE.prefs"! Get label tags for the vnm dialog box #include "spectrum.eng" #include "spectrum.prefs"! Location of the Report Format files *ribpath: /usr2/spectrum/6.0/sg-support/csrib/! SpectroGRAPH well known socket *uisocket: 0xbeaf! This should point to where you keep SPECTRUM external processes. *extprocesspath: Report Generator User s Guide Page 229

230 Setting Defaults In the Resource Files The RibE Resource File! The following colors are the number that you see if you are in! SpectroGRAPH and you can get these numbers by going into! File -> Edit, then select annotation toolbox, when this comes up! press the colors button.! This is the Main background color. Default 119, muted lilac. *BackgroundColor: 119! This is the color of the frames on the background.! Default 251, gray. *FrameBackgroundColor: 251! This is the color of the menu background and menu text.! Default: 251 gray and 245 black. *MenuColor: 251 *MenuTextColor: 245! This is the color editable text fields. Default: 254, light gray. *EditableTextColor: 254! This is the color of the window text. Default: 245, black. *WindowTextColor: 245! This is the color of most all labels. Default 245, black. Report Generator User s Guide Page 230

231 Setting Defaults In the Resource Files The RibE Resource File *LabelColor: 245! This is the color which indicates selection. Default: 249, dark gray. *SelectionColor: 249! This is an accent color. Default 249, dark gray. *DarkBackgroundColor: 249! This is the file that will be searched for close sized fonts if the! specified font cannot be found.! Default: /usr2/spectrum/6.0/app-defaults/spectrum.fonts *FontAliasFile: /usr2/spectrum/6.0/app-defaults/spectrum.fonts! This is the font for the Menu Bar's at the tops of the screens.! Default: -*-helvetica-medium-r-normal--* p-*- iso *MenuFont: -*-helvetica-medium-r-normal--* p-*- iso8859-1! This is the primary font used in the interface. It is used for all! Labels and Buttons in all windows.! Default: -*-helvetica-medium-r-normal--* p-*- iso *LabelFont: -*-helvetica-medium-r-normal--* p-*- iso Report Generator User s Guide Page 231

232 Setting Defaults In the Resource Files The RibE Resource File! This is the font used for all Text entry fields.! Default: -*-helvetica-medium-r-normal--* p-*- iso *TextFont: -*-helvetica-medium-r-normal--* p-*- iso8859-1! This is the font used in all Lists.! Default: -*-courier-medium-r-normal--* m-*-iso *ListFont: -*-courier-medium-r-normal--* m-*-iso8859-1! This is the font used in the 6 data regions within the paned window.! The default is a mono spaced font so the columns will line up! vertically! Default: -*-courier-medium-r-normal--* m-*- iso *MonospacedTextFont: -*-courier-medium-r-normal--* m- *-iso8859-1! These are the default sizes for the 6 data regions. Each resource! specifies the number of rows and columns.! Default: *commentstext.rows: 3 *commentstext.rows: 3 Report Generator User s Guide Page 232

233 Setting Defaults In the Resource Files The RibE Resource File! Default: *reporthdrtext.rows: 12 *reporthdrtext.rows: 12! Default: *columnhdrtext.rows: 4 *columnhdrtext.rows: 4! Default: *linedatatext.rows: 2 *linedatatext.rows: 2! Default: *summaryhdrtext.rows: 4 *summaryhdrtext.rows: 4! Default: *summarydatatext.rows: 2 *summarydatatext.rows: 2! Default: *reporthdrtext.columns: 80 *reporthdrtext.columns: 80! Location of the Reports UI Binaries *reportpath: /usr2/spectrum/6.0/sg/ #include "spectrum.platform"! end of file Report Generator User s Guide Page 233

234 Setting Defaults In the Resource Files The Reports Resource File The Reports Resource File The Reports resource file establishes the default Report Generator and Report Display startup parameters. To override a default parameter, you need to specify the new parameter value in this file. You can edit this file if you want to change the values of your Reports interface, landscape handle, or pathnames. The following Reports file is shipped with SPECTRUM.!! SPECTRUM Report Generator and Report Displays! default startup parameters!!! Reports Generator preferences #include "Reports.prefs"! Get label tags for the vnm dialog box #include "spectrum.eng" #include "spectrum.prefs"! Where the rib files are stored *ribpath: /usr2/spectrum/6.0/sg-support/csrib/! Location of the Report Generator Binaries *reportpath: /usr2/spectrum/6.0/sg/ Report Generator User s Guide Page 234

235 Setting Defaults In the Resource Files The Reports Resource File! Direct where the completed reports should be deposited *outputpath: /usr2/spectrum/6.0/report.output/! This is the directory where the event codes reside *evformatpath: /usr2/spectrum/6.0/sg-support/csevformat/! Where the probable cause files are stored *pcausepath: /usr2/spectrum/6.0/sg-support/cspcause/! Where the post generate scripts are located *postgenpath: /usr2/spectrum/6.0/report.config/post_gen_scripts/! Data Range :! DAY - data range within 24 hours! WEEK - data range within a week! MONTH - data range within a month! CUSTOM- data range according to user's choice!*datarange: DAY! Report Depth :! For Inventory report only :! GENERAL - general Inventory report! DETAILED - detailed Inventory report!*reportdepth: GENERAL Report Generator User s Guide Page 235

236 Setting Defaults In the Resource Files The Reports Resource File! preferredlandscapes comma separated list of landscape handles! user is interested in working with (initial selection in! landscape selection dialog box) *PreferredLandscapes: 0x ! AutoExpand determines whether to automatically expand the preferred! landscapes for the user. 0 = autoexpand off, 1 = autoexpand on *AutoExpand: 1! CaseSensitive determines the default sensitivity for searches and! filters: 0 = case insensitive 1 = case sensitive *CaseSensitive: 1! SearchDefault determines the search/filter default! 0 = filter default 1 = search default *SearchDefault: 1! SearchHighlightColor is the color used to indicate whether search! or filter is active. Default 170 (yellow). *SearchHighlightColor: 170! OverviewSelectionColor is the color used to indicate the selected models Report Generator User s Guide Page 236

237 Setting Defaults In the Resource Files The Reports Resource File! in the overview map ( to the left of model selection form ). Default is! set to 170 ( yellow ) *OverviewSelectionColor: 170! SpectroGRAPH well known socket *uisocket: 0xbeaf! The following colors are the number that you see if you are in! SpectroGRAPH and you can get these numbers by going into! File -> Edit, then select annotation toolbox, when this comes up! press the colors button.! This is the Main background color. Default 119, muted lilac. *BackgroundColor: 119! This is the color of the frames on the background.! Default 251, gray *FrameBackgroundColor: 251! This is the color of the menu background and menu text.! Default: 251 gray and 245 black. *MenuColor: 251 *MenuTextColor: 245 Report Generator User s Guide Page 237

238 Setting Defaults In the Resource Files The Reports Resource File! This is the color editable text fields. Default: 254, light gray. *EditableTextColor: 254! This is the color of the window text. Default: 245, black. *WindowTextColor: 245! This is the color of most all labels. Default: 245, black. *LabelColor: 245! This is the color which indicates selection. Default: 249, dark gray. *SelectionColor: 249! This is an accent color. Default: 249, dark gray. *DarkBackgroundColor: 249! This is the file that will be searched for close sized fonts if the! specified font cannot be found.! Default: /usr2/spectrum/6.0/app-defaults/spectrum.fonts *FontAliasFile: /usr2/spectrum/6.0/app-defaults/spectrum.fonts! This is the font for the Menu Bar's at the tops of the screens.! Default: -*-helvetica-medium-r-normal--* p-*- iso Report Generator User s Guide Page 238

239 Setting Defaults In the Resource Files The Reports Resource File *MenuFont: -*-helvetica-medium-r-normal--* p-*- iso8859-1! This is the primary font used in the interface. It is used for all! Labels and Buttons in all windows.! Default: -*-helvetica-medium-r-normal--* p-*- iso *LabelFont: -*-helvetica-medium-r-normal--* p-*- iso8859-1! This is the font used for all Text entry fields.! Default: -*-helvetica-medium-r-normal--* p-*- iso *TextFont: -*-helvetica-medium-r-normal--* p-*- iso8859-1! This is the font used in all Lists.! Default: -*-courier-medium-r-normal--* m-*-iso *ListFont: -*-courier-medium-r-normal--* m-*-iso8859-1! This is the timeout for waiting for SSAPI requests to be answered. *mailtime: ! This is default state of the graphical output format *GrfDisplayFormat: True Report Generator User s Guide Page 239

240 Setting Defaults In the Resource Files The Reports Resource File! This is default state of the graphical Postscript output format *GrfPostscriptFormat: False! This is the default configuration file for the graphical! Postscript output format *GrfPSConfigFile: /usr2/spectrum/6.0/report.config/default.rptrc! This is default state of the graphical GIF output format *GrfGIFFormat: False! This is the default configuration file for the graphical! GIF output format *GrfGIFConfigFile: /usr2/spectrum/6.0/report.config/default.rptrc! This is default state of the Tabular ASCII output format *TabASCIIFormat: True! This is default state of the Tabular Postscript output format *TabPostscriptFormat: False #include "spectrum.platform"! end of file Report Generator User s Guide Page 240

241 Glossary of Terms This section describes terms that pertain to the Report Generator. Alarm Attribute Average Clipboard Condition Customize Data type Down time duration Event Alarms occur when the Virtual Network Machine (VNM) detects a problem in a network model. Notice of the alarm is placed in the Alarm Register for the model along with the current status and probable cause of the alarm. The alarm is also written to the Event Log. The alarm can be examined in the Alarm Monitor Window until the alarm is cleared by the user (if possible) or eliminated as a result of a subsequent poll of the device. A piece of information that is available on a model. The sum of the values in a data sample, divided by the total number of values. An area of computer memory that holds what was last cut or copied. Information in the clipboard can be pasted to another location. The status of a device on the network. A term used to indicate that the format of a report has been prepared using the Report Formatter and that the user can be creative in its preparation. Also, to create a report format file using the Report Formatter. Attributes and keywords used to describe the report format, e.g., Attributes (<ATTR>), Statistics (<STAT>), or Fixed (<FIXED>). The time duration when a model is not responding. Measured in days, hours, minutes, and seconds. Significant occurrences within the SPECTRUM network model are events. Examples of events include a device Report Generator User s Guide Page 241

242 Glossary of Terms Graphical Header label Inventory Maximum Minimum Model Model type Object Region Reports Report Format File Standard Deviation Statistical being created or destroyed, the loss of contact with a device and the starting of a SpectroGRAPH session. The output of a report in a format designed for presentation as a graph. As opposed to Tabular. A term used in Graphical output to indicate information in the Report Header. The report type listing all models/model types of devices in, for example, an LAN, or for whatever network or segment is chosen in a view or icon. The largest value in a collection of data. The smallest value in a collection of data. A SpectroSERVER representation of a specific network device or network group (such as a specific bridge, cable, or port) or its associated software. A class of model. A template describing attributes, actions and associations, e.g., type of bridge and thin-wire cable. In the Report Formatter, the representation of the data set in a region. Examples of objects are: <ATTR>, <FIXED>, and <STAT>. A part of the report format file: Report Header, Column Header, Line Data, Summary Header, and Summary Data. A general term used to describe the set of reports available with the Report Generator product. A file created by the Report Formatter. Used to describe the format and data of a report. A measure of the average deviation of data values from the average. The report type that shows the performance of a model type or several models of a model type in the network. A Report Generator User s Guide Page 242

243 Glossary of Terms statistical report should contain the statistics supported in the Performance view. Tabular A report in table form with columns of information. As opposed to Graphical. Totals Up time duration The total of the values in a collection of data. The time duration when a model is responding. Measured in days, hours, minutes, and seconds. Up/Down Time The report type showing the status of models in the network. Report Generator User s Guide Page 243

244 Up/Down Time Report - Special Event Cases This section presents different cases of special events as they affect an Up/Down Time Report. Special events are those events that will affect the calculation of device Up/Down time duration. These special events are: The VNM has been started. The VNM has been shut down. A new VNM model has been created. A VNM model has been destroyed. A station has been removed from the FDDI ring. The following cases represent some of the special event situations when an Up/Down Time report is reading the Event Archive files. The legend common to all cases is: = Up Time Duration = Down Time Duration = Not Reported Start = Start Time End = End Time Device Lost Contact = the time stamp of the Device Lost Contact event Device Contacted = the time stamp of the Device Contacted event VNM Up = the time stamp of the VNM Has Started event VNM Down = the time stamp of the VNM Has Been Shut Down event Model Created = the time stamp of Model Created event Model Destroyed = the time stamp of the Model Destroyed event Case 1: A regular situation no special events occurred within the specified time range. Report Generator User s Guide Page 244

245 Up/Down Time Report - Special Event Cases Start Device Lost Contact Device Contacted End The time stamp of the Device Lost Contact event was recorded as the start of Down Time. Later, when the Device Contacted event was read, the time stamp was recorded as the start of Up Time. Case 2: The special event VNM has been started (VNM Up) occurred within the specified time range. Start VNM Up Device Contacted End The time between VNM Up and the first Device Contacted event in this example is not reported. If the first event after VNM Up is Device Lost Contact, then the time between VNM Up and Device Lost Contact is not reported either. Case 3: Special events VNM has been started (VNM Up) and VNM has been shut down (VNM Down) occurred within the time range. VNM Up Device Start Contacted Device Lost Contact VNM Down VNM Up Device Lost Contact End Report Generator User s Guide Page 245

246 Up/Down Time Report - Special Event Cases Note that the time between the VNM Down and the VNM Up event is not reported. Case 4: A special event VNM has been shut down (VNM Down) is missing. This can happen when the VNM was not brought down gracefully. Start Device Lost Contact VNM Up Device Lost Contact End Note that the time between the VNM has been started event and the last Device status event, i.e, Device Lost Contact event is not reported. Case 5: A special event Model Created occurred within the specified time range. Start Model Created Device Contacted Device Lost Contact End The time between the Model Created event and the first Device Status event is not reported. Case 6: A special event Model Destroyed occurred within the specified time range. Report Generator User s Guide Page 246

247 Up/Down Time Report - Special Event Cases Start Device Contacted Device Lost Contact Model Destroyed End After a model is destroyed, Device Status is unknown. Therefore, no status is reported after that point. A VNM Up/Down Time report can be generated when you select a VNM model. Case 7: Both VNM has been started (VNM Up) and VNM has been shut down (VNM Down) events are present. Start VNM Up VNM Down VNM Up End Since the VNM has been shut down event is not always logged, it cannot be assumed that the time duration before the VNM has been started event is actually VNM Down Time. Therefore, it remains as not reported. Case 8: VNM has been shut down (VNM Down) event is missing. Start VNM Up VNM Up End Report Generator User s Guide Page 247

248 Up/Down Time Report - Special Event Cases This is the worst case. The time between two VNM has been started events remains as not reported. Report Generator User s Guide Page 248

249 Using Report Output in HTML Pages This section discusses the steps that must be performed in order to use Graphical GIF report output in Web browsers. Overview The Graphical GIF output option lets you produce report output, in GIF format, that can be viewed in a graphical Web browser such as Netscape Navigator or Microsoft Internet Explorer. This means that such report output can be viewed on systems that do not have SPECTRUM, or on platforms that SPECTRUM does not support. Once you create these Graphical GIF output files, you can reference and display them in an HTML page. This appendix outlines this procedure, along with the preliminary steps a system administrator must perform before you can create and use Graphical GIF output files. Setup Procedures In order to create Graphical GIF output for use in HTML files, SPECTRUM Report Generator must have access to a running X server. This is because the conversion utilities need to do some work on the screen. This can present a problem if you run a screen saver/locking program. When such a program runs, scheduled reports cannot run their conversion utilities successfully because the locking program prevents them from accessing the screen. A simple solution would be to not lock the screen. Unfortunately this is not acceptable for some customers because it means leaving someone Report Generator User s Guide Page 249

250 Using Report Output in HTML Pages Setup Procedures logged into a workstation with no screen lock on, which could present a serious security problem. SPECTRUM Report Generator includes a special restricted shell that has been installed in /usr/bin/csresh. This shell is restricted in that the commands that one can run are limited to a certain set of commands. Using this shell, a system administrator can create a special account that uses this shell as its login shell. When the person running SPECTRUM leaves for the day, he/she can log out and then log in using the special account. That account lets you log in, start X, and log out. Nothing else works from the terminal windows. This way, you can leave an open X display available overnight without security fears. To set this up, the system administrator must do the following: 1 Create a new account on the target machine and set the login shell to /usr/bin/csresh/resh. 2 Create a configuration file for the account. The file must exist in the /usr/bin/csresh directory and must be named whatever the login id is. For example if the account is called reports the configuration file must be /usr/bin/csresh/reports. There is a sample configuration file called /usr/bin/csresh/webrprts. 3 Depending on your system and window manager, you may want to copy /usr/bin/csresh/.xinitrc and /usr/bin/csresh/.mwmrc into the home directory for the account that was created. This restricts the menus available to the user once X has started. The.xinitrc runs xhost + to let all clients connect to it. If you are running a system without mwm or your X startup doesn't use.xinitrc, you may need to modify the account s init files to provide suitable menus and to run xhost +. Report Generator User s Guide Page 250

251 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page Incorporating GIF Files into an HTML Page Follow the steps listed in Quick Start to create your report; be sure to specify.gif as an Output Format type. During report creation, Report Generator creates two GIF files: a full size version, and a smaller thumbnail version (denoted by a filename containing the word small ). Note: The GIF files created can display a maximum of 32,766 data points. If the report contains no data points, and you select Graphical PostScript and GIF output, an error message will appear advising that GIF and PostScript file generation has failed. No PostScript or GIF files are created. Default parameters for GIF output files are defined in the default.rptrc file, located in the $SPECROOT/report.config directory. The following defaults apply to.gif output format files:.gif files are output in the report.config directory. To override this default and direct output to another directory, you must change the value of the GIF_BASE variable in default.rptrc to the new directory. The following optional environmental variables can be modified in default.rptrc: VARIABLE DESCRIPTION VALID ARGUMENTS DATA_TYPE MULTIPLE_GRAPHS Variation of one model s attributes values or one attribute s value between models. Generate multiple GIFs from a single GRF. ATTRIBUTES or MODELS Y or N Report Generator User s Guide Page 251

252 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page VARIABLE DESCRIPTION VALID ARGUMENTS DATA_COUNT NAME_APPEND SCALING_X SCALING_Y GENERATE_HTML DEFAULT_FONT_TYPE DEFAULT_FONT_SIZE Maximum number of items that can be selected in the DATA_TYPE list. Suffixes that can be appended to filenames. Replace percent argument with desired argument. GIF X-axis scaling. GIF Y-axis scaling. Generate HTML file. HTML file font style HTML file font size (points) Integer %w day of the week (Tue, Wed, etc.) %d day of the month %m month (Apr, May, Jun, etc.) %H hour of the day (24-hour format) %M minute of the hour (0-59) %l user s login ID %h hostname %o OS (operating system) name %% single percent character (see below) (see below) Y or N (see below) (see below) (see below) You can increase or decrease the default size of the GIF files by adjusting the definitions of the SCALING_X and SCALING_Y variables in the default.rptrc file. SCALING_X and SCALING_Y, by default, are equal to 1.0. If, for example, you want to double the size of your GIF output files, you would set SCALING_X and SCALING_Y equal to 2.0. Report Generator User s Guide Page 252

253 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page You can modify the HTML file font style, and increase or decrease the default font size by adjusting the definitions of the DEFAULT_FONT_TYPE and DEFAULT_FONT_SIZE variables in the default.rptrc file. You can define the DEFAULT_FONT_TYPE as any standard font (e.g., Courier New, Times, Helvetica, etc.). The DEFAULT_FONT_SIZE can be any whole number more than 1 (e.g., 2, 3, 4, etc.). The following optional environmental variables can be modified in default.prf: VARIABLE DESCRIPTION VALID ARGUMENTS GRAPH_TYPE GRAPH_STYLE USER_DEFINED_FONTS HEADER_FONT_TYPE HEADER_FONT_SIZE Type of graph to be included in the HTML file. Format for the graphical data. Specifies whether default or user-defined fonts are used in GRF file header text. Font style used in GRF file header text. Font size used in GRF file header text (in points). 0 Pie chart 1 Vertical Bar chart 2 Horizontal Bar chart 3 Filled Area chart 4 Line chart 6 Scatter chart 0 Side-by-side 1 Cumulative 2 Relative 0 Use default fonts 1 Override default fonts 0 Normal 1 Bold 2 Italic (see below) Report Generator User s Guide Page 253

254 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page VARIABLE DESCRIPTION VALID ARGUMENTS AXIS_LABEL_FONT_TYPE AXIS_LABEL_FONT_SIZE Font style used in GIF file X and Y axis labels. Font size used in GIF file X and Y axis labels (in points). 0 Normal 1 Bold 2 Italic (see below) You can define the type of graph that is displayed as a GIF file by editing the definition of the GRAPH_TYPE variable in the default.prf file. You can also define the graph style by editing the definition of the GRAPH_STYLE variable in the default.prf file. The possible combinations of Graph Type with Graph Style are listed below: GRAPH TYPE GRAPH STYLE Pie Chart - 0 Relative - 2 Vertical - 1 Side-by-side - 0; Cumulative - 1; Relative - 2 Horizontal - 2 Side-by-side - 0; Cumulative - 1; Relative - 2 Filled Area - 3 Side-by-side - 0; Cumulative - 1; Relative - 2 Line - 4 Side-by-side - 0 Scatter - 6 Side-by-side - 0 Note: An error dialog box is displayed if the settings for graph type and graph style are incorrect. Report Generator User s Guide Page 254

255 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page You can define the font size and style that appear in the in the HTML file headers, in the X and Y axis labels in the GRF files, and in the header section of the GRF file display. To modify the default font stye and size in the HTML file headers, edit the definitions of the DEFAULT_FONT_TYPE and DEFAULT_FONT_SIZE variables in the default.rptrc file. DEFAULT_FONT_TYPE can be set to such values as Courier New, Helvetica, Times, etc. DEFAULT_FONT_SIZE can be set to such numerical values as 2, 3, 4, etc. No error checking is done on these variables. To define whether or not to use the Report Generator s default fonts, edit the definition in the USER_DEFINED_FONTS parameter of the default.prf file. Setting the definition to 0 tells Report Generator to use its default fonts, whereas setting the definition to 1 tells Report Generator to use user-defined fonts. The HEADER_FONT_TYPE parameter in the default.prf file defines whether the header text will display as normal (0), bold (1), or italic (2). The HEADER_FONT_SIZE parameter in the default.prf file defines the text point size. 12 points corresponds to normal size. The AXIS_LABEL_FONT_TYPE parameter in the default.prf file defines whether the X and Y axis text will display as normal (0), bold (1), or italic (2). The AXIS_LABEL_FONT_SIZE parameter in the default.prf file defines the label text point size. 12 points corresponds to normal size. Once you have created the GIF files, you then need to create an HTML page file that references these GIF files. Most often, these pages are set up so that the page at the top of the hierarchy contains a number of small GIFs (for example, an HTML page for a weekly report would include small GIFs for each day of the week). Clicking on the small GIF then displays a page containing the larger version of that GIF. SPECTRUM Reports automatically generates an HTML page that references the GIF files. The HTML file uses relative path names, so you can move it (along with the GIF files) to any convenient location.you can, however, configure SPECTRUM Reports not to do so. To do this, edit the default.rptrc file to set the variable GENERATE_HTML to N. This will instruct RepGRFtogif not to generate a customized HTML file for you. Report Generator User s Guide Page 255

256 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page SPECTRUM Reports includes a sample HTML page file named webrpt.html, which resides in the SG directory. The webrpt.html file shows you how to reference GIF files created by Report Generator, so those files can appear on a web page. You can use webrpt.html as a template to help you create your own HTML page files. The following are the contents of the webrpt.html file: <HTML> <HEAD> <TITLE>Frame Relay Wide Area Links Reports</TITLE> </HEAD> <BODY> <H1>Frame Relay Wide Area Links</H1> <HR> <TABLE> <TR> <TH ALIGN=LEFT>Monday</TH> <TD><A HREF= frame_relay_tue.gif ><IMG align=middle SRC= frame_relay_small_tue.gif ></A></TD> </TR> <TR> <TH ALIGN=LEFT>Tuesday</TH> <TD><A HREF= frame_relay_wed.gif ><IMG align=middle SRC= frame_relay_small_wed.gif ></A></TD> </TR> Report Generator User s Guide Page 256

257 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page <TR> <TH ALIGN=LEFT>Wednesday</TH> <TD><A HREF= frame_relay_thu.gif ><IMG align=middle SRC= frame_relay_small_thu.gif ></A></TD> </TR> <TR> <TH ALIGN=LEFT>Thursday</TH> <TD><A HREF= frame_relay_fri.gif ><IMG align=middle SRC= frame_relay_small_fri.gif ></A></TD> </TR> <TR> <TH ALIGN=LEFT>Friday</TH> <TD><A HREF= frame_relay_sat.gif ><IMG align=middle SRC= frame_relay_small_sat.gif ></A></TD> </TR> </TABLE> </BODY> </HTML> Figure 76 shows the layout of the HTML page produced from this code. Clicking on any of the small GIFs in an actual HTML page displays a larger version of that GIF. Report Generator User s Guide Page 257

258 Using Report Output in HTML Pages Incorporating GIF Files into an HTML Page Figure 76: Example HTML Page with Small GIF Files Embedded Report Generator User s Guide Page 258