GIB Editor User s Guide

Transcription

1 Titlepage GIB Editor User s Guide SPECTRUM Enterprise Manager Customization

2 Notice Aprisma Management Technologies, Inc. (Aprisma) reserves the right to make changes in specifications and other information contained in this document without prior notice. The reader should in all cases consult Aprisma to determine whether any such 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, KNOWN, OR SHOULD HAVE KNOWN, THE POSSIBILITY OF SUCH DAMAGES. Copyright June 2000 by Aprisma Management Technologies, Inc. All rights reserved. Printed in the United States of America. Order Number: Aprisma Management Technologies, Inc. 121 Technology Way Durham NH SPECTRUM, thespectrum IMT/VNM logo, DCM, IMT, and VNM are registered trademarks, and SpectroGRAPH, SpectroSERVER, Inductive Modeling Technology, Device Communications Manager, and Virtual Network Machine are trademarks of Aprisma or its affiliates. C++ is a trademark of American Telephone and Telegraph, Inc. UNIX is a trademark of UNIX System Laboratories, Inc. OSF/Motif and Motif are trademarks of the Open Software Foundation, Inc. XWindowSystemis a trademark of X Consortium, Inc. Ethernet is a trademark of Xerox Corporation. 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% reliable, we strongly caution you to write protect and then verify that the Licensed Software, prior to installing it, is virus-free with an anti-virus system in which you have confidence. Customization Page 2

3 Restricted Rights Notice (Applicable to licenses to the United States Government only.) 1. Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at DFARS Aprisma Management Technologies, Inc., 121 Technology Way, Durham, New Hampshire (a) This computer software is submitted with restricted rights. It may not be used, reproduced, or disclosed by the Government except as provided in paragraph (b) of this Notice or as otherwise expressly stated in the contract. (b) This computer software may be: (1) Used or copied for use in or with the computer or computers for which it was acquired, including use at any Government installation to which such computer or computers may be transferred; (2) Used or copied for use in a backup computer if any computer for which it was acquired is inoperative; (3) Reproduced for archival or backup purposes; (4) Modified, adapted, or combined with other computer software, provided that the modified, combined, or adapted portions of the derivative software incorporating restricted computer software are made subject to the same restricted rights; (5) Disclosed to and reproduced for use by support service contractors in accordance with subparagraphs (b) (1) through (4) of this clause, provided the Government makes such disclosure or reproduction subject to these restricted rights; and (6) Used or copied for use in or transferred to a replacement computer. (c) Notwithstanding the foregoing, if this computer software is published copyrighted computer software, it is licensed to the Government, without disclosure prohibitions, with the minimum rights set forth in paragraph (b) of this clause. (d) Any other rights or limitations regarding the use, duplication, or disclosure of this computer software are to be expressly stated in, or incorporated in, the contract. (e) This Notice shall be marked on any reproduction of this computer software, in whole or in part. Customization Page 3

4 Contents Preface 8 Who Should Read This Guide...8 How This Manual is Organized...8 Typographical Conventions...9 Related SPECTRUM Documentation...10 Other Related Reading...11 Introduction 12 GIB Views...12 GIB Editor...12 GIB Files and Directories...14 Editing Views 16 Editing a View s Fields...16 File and Edit Menus...16 File Menu Options...16 Edit Menu Options...17 Editing and Saving...20 Changing the Dialog Box Text...20 Moving Window Objects...21 Changing Backgrounds...22 Width...24 Height...24 Adding Attribute and Non-Attribute Fields...26 Adding an Attribute Field...26 Controls Panel...29 Adding a Non-Attribute Field...30 Using Field Definition Dialog Boxes...30 Common Dialog Box Entries...31 Creating Table Fields in a GIB View...37 TIB Files...38 Creating a Tib File:...40 Table Column Descriptions...40 Customization Page 4 GIB Editor User s Guide

5 Contents Contents Adding Tables to a GIB View...45 Creating Views 47 Creating and Accessing a New View...47 Creating a Button to Access a New View...47 Accessing a New View with an Icon Subviews Menu...49 Attribute Browser...49 Attribute Fields 54 GIB Views...54 Attributes...54 Attribute Field Types...55 Agent ID...55 Button, New Generic View of Specified Model...56 Button, New Window & Generic View of Specified Model...56 Button Panel, On/Off Toggles...56 Button, Write Polled Data to File...57 Graph...60 Numeric Display, Unsigned...67 Pie Chart Options...72 Tachometer, arc...73 Text, Scrolled...76 Pie Charts - Attribute Field Types...78 Pie Chart, Related Models, with Total, Delta and Accum...82 Pie Chart, Related Models Using Instance ID, with Total, Delta and Accum...83 Tables - Attribute Field Types...83 Buttons, Bar Gauges, and Graphs 85 Button Options...85 Bar Gauges...89 Gauge, Horizontal Bar, Multi-Attribute...91 Graphs...92 Multi-Attribute Graph Dialog Boxes...92 Attribute Selections Dialog Box...93 Describes Attributes Dialog Box...94 Graph, Multi-Attribute...96 Customization Page 5 GIB Editor User s Guide

6 Contents Contents Graph, Multi-Attribute Rate...97 Instance IDs and Related Models...98 Help File...98 List, Related Models Related Models List Creation Related Models List Modification Model Icon Pie Charts 105 Pie Charts Pie Chart Dialog Boxes Attribute Pie Chart Options Pie Chart, Delta, Labeled on Bottom Pie Chart, Delta, Labeled on Left Pie Chart, Total Delta Accum Non-Attribute Pie Chart Options Pie Chart, Related Models Using Instance ID, with Total, Delta and Accum Pie Chart, Related Models, with Total, Delta and Accum Tables 116 Tables Basic Table Nested Table Nested for an Instance Table Sorted Table and Sorted Nested Table Creating Table Fields in a GIB View Creating GIB Files to Define Table Fields To Create a Tib File: Table Column Descriptions Adding Tables to a GIB View Tutorial 128 Editing Fields in an Existing View Accessing New Views Adding a Multi-Attribute Graph Adding a Button to Open a New View Customization Page 6 GIB Editor User s Guide

7 Contents Contents Adding a Table to a View Creating a Table within an Existing Generic View Adding a Table Title to the View Adding an New Field Adding an Option Button Field Changing the Post_IP_Address_Change event file Appendix A 157 Attribute Field Types and Descriptions Appendix B 161 Column Titles and Descriptions Index 165 Customization Page 7 GIB Editor User s Guide

8 Preface This document provides the information necessary to edit the SPECTRUM Generic Information Block (GIB) views. Who Should Read This Guide This manual is intended to be used by experienced network administrators and developers. You should read this manual if you want to: edit view fields create buttons, tables, and other attribute and non-attribute fields create new GIB views Before reading this manual, you should be familiar with SPECTRUM s functions as described in the SPECTRUM Concepts Guide, Getting Started with Level I Toolkits, and the Model Type Editor Users Guide. How This Manual is Organized The following section descriptions outline the organization of the GIB Editor User s Guide. Section Introduction Editing Views Description Briefly introduces the GIB Editor User s Guide. Describes how to edit fields with the GIB Editor. Customization Page 8 GIB Editor User s Guide

9 Preface Typographical Conventions Creating Views Attribute Fields Buttons, Gauges, and Graphs Pie Charts Tables Tutorial Appendix A Appendix B Describes how to create GIB graphic objects. Describes how to choose MIB attributes with the Attribute Browser, and add the attributes to SPECTRUM views. Describes how to add a button to a view, and create tables, pie charts, gauges, and multi-attribute graphs. Describes how to add a pie chart to a view. Describes how to add a table to a view Shows you how to edit a GIB view for a modeled device and create a new view that is accessible from an Icon Subviews menu selection. Also shows you how to create a table with fields and images. This appendix maps Attribute Fields to specific Attribute Types. This appendix describes the parameters and column headings for tables you can create. Typographical Conventions Certain typographical conventions are used throughout this document to distinguish between program names, variables, etc., as follows: Code examples and screen messages appear in Regular Courier type if showing system display or output, in Courier Bold if showing what you should type into the system. Cross-references to other sections, tables, or figures in this publication provide the actual page number and when appropriate give the applicable titles in italic text. Customization Page 9 GIB Editor User s Guide

10 Titles of other publications appear in bold italic text. Executable script and program names appear in Helvetica. For example, the utility named dbtool appears as dbtool. (One significant exception to this convention is the mte utility itself, which is given as mte when clearly talking about the program as a program function but is called MTE when referenced as an entity.) To reduce potential confusion in text, names of model types are set in Courier Bold and names of attributes are set in Courier Bold Italics. Keyboard controls and display-screen nomenclature (labels, button names, etc.) are given in boldface type such as the Return key and the OK button. Command names are printed in bold; for example, Save & Close or Cancel. Menu selections to open a menu or submenu or to open a view or a dialog box are printed bold for example: Examine Attributes or Set Filter. Submenu options are indicated by a right-angle character (>) between the menu and the submenu for example: Activate the File > Toggle Warnings option. Italics are used for emphasis especially in the case of a first-time use of an important term or phrase or when the SPECTRUM-specific meaning of such a term or phrase is being defined. In addition, the following graphical conventions apply for callouts in illustrations throughout this publication: Related SPECTRUM Documentation Refer to the following documentation for more information on using SPECTRUM: SPECTRUM Concepts Guide Model Type Editor User s Guide Customization Page 10 GIB Editor User s Guide

11 Preface Other Related Reading Modeling with GenSNMPDev Toolkit Getting Started with Level I Toolkits Other Related Reading Refer to the following documentation for more information on using SPECTRUM and managing TCP/IP-based networks. LAN Troubleshooting Handbook, Mark Miller (1989, M&T Publishing, Inc.), 2nd Edition, 1993 The Simple Book An Introduction to Management of TCP/IPbased Internets, Marshall T. Rose, Performance Systems International, Inc., 2nd Edition, 1994 Computer Networks, Andrew S. Tanenbaum, Prentice-Hall, Inc. To learn more about FDDI, refer to the following document: A Primer to FDDI: Fiber Distributed Data Interface, Digital Equipment Corporation. Customization Page 11 GIB Editor User s Guide

12 Introduction Introduction This manual is one of several documents comprising the document set for SPECTRUM Level I Developer s Tools. It describes the features and operation of the GIBEditor,whichallowsyoutocreateyourownSPECTRUMviewsorcustomize generic SPECTRUM views. GIB Views Generic Information Block views, or GIB views, allow you to organize and display attribute information and statistics for a modeled entity. The GIB Editor is accessed from the following SPECTRUM views: Application Views Configuration Views Information Views Performance Views You can add, remove, or change information fields and annotations in the GIB Editor, or create new views. For more information on generic SPECTRUM views, refer to the SPECTRUM Views document. For information on icons, refer to the SPECTRUM Icons document. Note: You will not see a Save changes? dialog box for Location, Universe, or Topology views; any changes made in these views will take effect after exiting Edit mode. For more information on these views, refer to SPECTRUM Views. GIB Editor The GIB Editor allows you to customize generic SPECTRUM views to suit your specific network requirements. You can use attributes, nonattributes, and annotations to customize your views. SPECTRUM polls Customization Page 12 GIB Editor User s Guide

13 Introduction each device for the values of these attributes, or Management Information Base (MIB) variables. Non-attributes are features, such as buttons, graphs, gauges, and pie charts, that assist in the presentation of information in GIB views. Annotations are special text or graphics used in the views. Caution: You must have edit privileges to change models or model types and write permission for the GIB files associated with these GIB Views. When either of these conditions is not met, the Edit menu option is grayed-out and access is denied. Refer to User Security and User Maintenance for more information. Some characteristics of the GIB Editor are listed below. You can edit generic views, or any new views that you create. Since GIB view changes do not affect the SpectroSERVER database, you can create unique GIB views for each user without affecting the appearance of the GIB views of other SPECTRUM users accessing the same SpectroSERVER. Attribute and non-attribute values shown in GIB views reflect information retrieved from the SpectroSERVER database. - SpectroSERVER gathers information by polling network devices and stores retrieved information in the database. - SpectroGRAPH, in turn, polls SpectroSERVER to obtain the current information stored in the database. When you edit a GIB view using the GIB Editor, SpectroGRAPH s polling of SpectroSERVER is suspended, and attribute values are not updated to show the most current poll information. (SpectroSERVER s polling of network devices continues without interruption.) When you exit from the GIB Editor, the polling resumes. Each GIB view is unique and fully configurable for each model. Each model type has its own set of GIB files and, unless you save a GIB view for a specific SPECTRUM model, all changes will affect the GIB views for all models of that model type. Customization Page 13 GIB Editor User s Guide

14 Introduction GIB Files and Directories The GIB Editor allows you to select view information attributes from the Management Information Base (MIBs) of a model. Additionally, you can choose the presentation method for displaying information in a GIB view. GIB Editor product features are listed below. GIB views can be annotated to add labels and graphics. Values, such as hexadecimal, binary, or decimal integers, can be presented in a view. Images such as buttons can be added to access other views. Other images used in displaying statistics, such as graphs, pie charts, and gauges, can be created. You can edit an existing view or create new views with the GIB Editor. There are three ways to create new views with the GIB Editor: select attributes using the Attribute Browser create a button to open a new window use the Save GIB option to Model or Model Type menu selection. These options are described in detail in the Creating Views section. GIB Files and Directories The information that defines the appearance and content of GIB views are stored in GIB files. All components of the GIB views, including view annotations, background colors, text fonts, device attributes and polling intervals, are defined within GIB files. GIB files can be saved and applied to a specific model or to all models of one model type. GIB files are standard ASCII text files that are accessible using the GIB Editor or a text editor. When you edit a GIB view using the GIB Editor, the GIB file associated with the view is automatically updated to record the changes. This means that you must have write permission for the GIB file being changed in addition to edit privileges (defined in SPECTRUM security) for the GIB View. All GIB files are organized into sub-directories within a central CsGib directory, which are located in one of the following: Customization Page 14 GIB Editor User s Guide

15 Introduction $SPECROOT/app-defaults/spectrum $SPECROOT/SG-Support/CsGib Refer to the Defining SPECTRUM Resources document for more information on resources. The GIB filename extensions, which denote GIB file classes, are described below..100 filename extensions are create GIB files. These define the contents of the creation dialog which appears when you use the New Model option, selected from the SpectroGRAPH Edit menu to create a model in a view. The create GIB file instantiates a model of a model type. There is only one create GIB file for each model type..30 filename extensions define the contents of a GIB view. There are typically many GIB files having a.30 extension associated with each model type..gtb filename extensions define tables in a GIB view. More detailed descriptions of these GIB files are provided in later sections. Note: GIB files related to a particular model type are contained in a sub-directory of the GIB directory that is named for the model type in question. Chapter 1 Customization Page 15 GIB Editor User s Guide

16 Editing Views Editing Views This section shows you how to edit existing views with the GIB Editor. Editing a View s Fields This section describes how to use the GIB Editor s Edit menu options with examples throughout the section. Note: To perform the following steps, you must be familiar with techniques used in selecting and dragging items in a view. Refer to Defining SPECTRUM Resources in the Administration area of the online documentation for more information on these techniques. File and Edit Menus Select Edit from a GIB view s File menu to open a GIB Editor session. File Menu Options These menu options are unique to the GIB Editor s operations. Edit The navigation mode option begins an editing session for the current GIB view. Edit and Close Edit are complementary options. Close Edit Use this option to end the current GIB Editor session and save the changes made to the GIB View. When you select this option, a dialog box appears; choose OK to save your changes in the associated GIB file. Select Cancel to close the GIB view without saving. Customization Page 16 GIB Editor User s Guide

17 Editing Views Change Instance You can use this function to enter a different instance ID for a specific board or port within a GIB view. For example, instead of converting each character in a string-based instance to decimal notation, just enter the string without the dots. Values can be expressed as Value in Hex, Value in decimal, or Value in ASCII. Note that if you use ASCII, you should not put dots between terms. To change an instance, follow these steps: 1 Select Change Instance from the File menu. A Text Entry dialog box appears requesting the new Instance ID. 2 Enter the board or port number. 3 Click OK, and the GIB view changes to reflect the board or port. Save All Changes Used to save changes from this Edit session. For convenience, a Save All Changes icon (the floppy disk image) appears on the toolbar. Discard All Changes Used to discard changes from this Edit session. Exit Exits SpectroGRAPH. Edit Menu Options The Edit menu provides options for adding/removing fields, modifying existing fields within a view, changing update interval, changing background, and adding annotations to a view. New Attribute Field Allows you to select attributes and the attribute display method. Refer to Adding an Attribute Field for more information. Customization Page 17 GIB Editor User s Guide

18 Editing Views New Non-Attribute Field Allows you to add features to a GIB view, such as buttons that access other GIB views, multi-attribute graphs, and multi-attribute gauges. Refer to Adding a Non-Attribute Field for more information. Cut Removes a selected annotation from a view and places it into the paste buffer. Cut is grayed-out unless an annotation is selected. Copy Allows you to copy an annotation into the paste buffer. Copy is grayedout unless an annotation is selected. Paste Allows you to transfer the contents of the paste buffer into the current view. Erase Allows you to remove a field or annotation from the current view. The paste buffer and database are unaffected by this option. Erase is grayedout unless an item is selected. Snap to Grid Allows you to force graphics to adhere to a predetermined set of grid lines and not free-float within the document view. The Select Grid Value dialog box, Figure 1, opens when this option is selected and allows you to determine the size of the visible and snap grids in pixels, or to select the default of 20 pixels. Visible grids appear in the view. You can place objects on snap grids. If the visible grids are set to 20 pixels, and the snap grids are set to 10 pixels, you can place objects at any intersection of the visible grid lines (20 pixels apart) and at any point half way between grid lines (10 pixels apart). Customization Page 18 GIB Editor User s Guide

19 Editing Views Figure 1: Select Grid Value Dialog Box Select Grid Value Visible Grid: 20 pixels Snap Grid: 20 pixels OK Default Cancel Bring to Front Allows you to bring selected items to the front layer of the view. Send to Back Allows you to send selected items to the back layer of the view. Modify Field Allows you to modify the definition for the currently selected field (grayedout unless a field is selected in the view). Another way to enable the Modify option is to double-click the left mouse button with the pointer in the field. When this option is selected, a Field Definition dialog box opens. See the section Using Field Definition Dialog Boxes for more details. Update Interval Allows you to change the setting of the SpectroGRAPH to SpectroSERVER update interval for this view. The update interval is the number of milliseconds (0.001 second) between GIB view updates. The GIB view cannot be updated by the SpectroSERVER while in Edit mode. Change Background Allows you to change the background color and raster. You can also set the maximum size for this view. The Background Color button accesses the Color Selection palette from which you can select a color and corresponding color number. The Background Raster button allows you to open the Select File dialog box and choose a background raster image Customization Page 19 GIB Editor User s Guide

20 Editing Views file. The selected image becomes the background for the view. The window size change to accommodate the size of the selected raster image Annotation Toolbox & Opens the Annotation Toolbox, which provides access to the color palette and drawing tools (line, box, circle, and text). A variety of options exist for changing colors, line width, and fonts. The Annotation Options view is described in the Annotation Toolbox. The ampersand (&) indicates that the process operates in the background and the view can remain open while other operations are performed. Editing and Saving To edit a GIB view: 1 Navigate to an appropriate generic view, such as Configuration or Model Information view. 2 From the File menu, select the Edit option to access the GIB Editor. Note: The Edit option is grayed-out if you do not have write permission or edit privileges from SPECTRUM security for the selected GIB view. 3 Select, or highlight, a field that you wish to change. Double-click on that field. The appropriate dialog box for changing that particular field will appear. 4 Perform any necessary procedures within the selected GIB View. For more information on the field types that you may use to represent various attributes, refer to the applicable topic sections in this document. 5 From the File menu, select Close Edit. Click OK to save the changes. Click Cancel to end the GIB Editor session without saving your changes. Your changes will still appear in the view until you close the view; when you reopen that view, the changes will not appear. Customization Page 20 GIB Editor User s Guide

21 Editing Views Changing the Dialog Box Text The hard coded strings in the <SPECTRUM directory>/app-defaults/ spectrum.eng file can be modified to reflect different text. You can change the default message to reflect the same message in a foreign language. Table 1 shows text strings and default messages that appear in the appdefaults/spectrum file. The appropriate default message appears in the popup dialog box. Table 1: GIB Change Dialog Box Messages String Title Dialog Box Type Default Message *savegibchangesdialogtitle: *discardgibchangesdialogtitle: *savegibchangesmessage: *discardgibchangesmessage: *helpsavegibchangesmessage: Save GIB Changes Discard GIB Changes Save GIB Changes Discard GIB Changes Saving Changes to the View *helpdiscardgibchangesmessage: Discarding Changes to the View Save Changes? Discard Changes? Do you wish to save the changes made to this view? Do you wish to discard the changes made to this view? Pressing OK will save the changes in the view. Pressing Cancel will discard any change. Pressing OK will discard the changes in the view. Pressing Cancel will leave the view as it is. Customization Page 21 GIB Editor User s Guide

22 Editing Views Moving Window Objects Each GIB View is made up of attribute fields, non-attribute fields, and annotations. Each of these elements can be positioned independently within the view to provide customized information. You can drag fields and annotations to a new position or set into position using X/Y coordinates. Setting the position using X and Y coordinates allows you to accurately align fields vertically or horizontally, and is accomplished by following these steps: 1 Select the field to be positioned. 2 From the Edit menu, select Modify Field or double-click on the field. A Field Definition dialog box appears. 3 Enter the location value, measured in pixels, within the X and Y position fields. (The upper left corner of a window is location: X = 0, Y = 0.) 4 Close the dialog box by selecting OK; confirm the new position. Select Cancel to leave the field position unchanged. Note: X and Y position coordinates are updated automatically each time you drag a field to a new position. 5 Repeat the preceding steps for each of the fields being positioned. Where X or Y axis alignment is critical, enter the same value for that axis into the dialog box for each field being aligned. Changing Backgrounds You can change the dimensions, background color, and the background raster image for a GIB view. Select the Change Background option from the Edit menu to see the Change Background dialog box, shown in Figure 2. Customization Page 22 GIB Editor User s Guide

23 Editing Views Figure 2: Change Background Dialog Box Opens the Select Color Index dialog box which allows you to change the color for this view Opens the Select File dialog box which allows you to. change the background raster graphic for this view Change Background Background Color 176 Min Width: 1035 Min Height: 666 Width Height Screen Width: 1130 Screen Height: 860 Background Raster OK Cancel Help Enter window dimensions in pixels The view buttons and associated fields for the Change Background dialog box are described in the next section. Background Color To change the background color: 1 Click the Background Color button to open the Select Color Index dialog box. SPECTRUM displays color index numbers 77 through 255 within the individual color blocks of the SPECTRUM Color Palette. Refer to Color Mapping in SPECTRUM s Defining SPECTRUM Resources publication for more information. 2 Select the desired color and click OK to confirm your change. Click Cancel to leave the background unchanged. 3 Click OK from the Change Background dialog box to confirm your color change, or click Cancel to leave the background and dimensions unchanged. 4 If these are the only changes being made to the view at this time, then exit Edit mode. Customization Page 23 GIB Editor User s Guide

24 Editing Width Views Enter the view width (measured in pixels) into the Width field of the Change Background dialog box (see Figure 2). You cannot resize the view width past this value. Height Enter the view height (measured in pixels) into the Height field of the Change Background dialog box. You cannot resize the view height past this value. After completing the view size changes, select Close Edit from the File menu to exit Edit mode. Background Raster To change the background graphics: 1 Click the Background Raster button in the Change Background dialog box (see Figure 2). Raster is a term used to describe the background graphics image in a view. The Select File dialog box appears, as shown in Figure 3. The Select File dialog box lists image files available in the CsImage/Background directory. Some image files are solid color background; others are graphic images. The Select File dialog box allows you to select image files written in Cabletron graphics file format (.csi) or Tagged Image File Format (TIFF). SPECTRUM supports commonly used TIFF file formats (noncompressed and PackBits-compressed). You can also use PNG image files anywhere SPECTRUM expects an image. You should use a.png extension for these files. For complete information about PNG image files, visit 2 Copy all background image files into the Spectrum/SG-Support/ CsImage/Background directory. Note: The maximum size of a view is the new default value for the background raster image. Once changed, the view cannot be larger than this raster image value. For more information on converting graphics to.csi format, refer to the IIB Editor Guide. Customization Page 24 GIB Editor User s Guide

25 Editing Views Figure 3: Select File Dialog Box Directories available within currently selected filter Updatable filter name Select File Filter.../Spectrum/SG-Support/CsImage/Background/* Directories Files CsImage/Background/. Bd_GenHi.csi CsImage/Background/.. Bd_GenBd1.csi Bd_GenBd2.csi Bd_GenBd3.csi Bk_Default.csi Bk_DkBlue.csi List of image files in selected directory Selection.../Spectrum/SG-Support/CsImage/Background/ OK Filter Cancel Help 3 Select the directory for the desired graphic file in the left panel. Apply any necessary filters to the file selections. 4 Select an image file by clicking on the file name in the right panel. 5 Click OK to confirm your selection or Cancel to leave the background unchanged. This closes the Select File dialog box. 6 Once back in the Change Background dialog box, click Cancel to leave the background unchanged, or OK to complete changes and exit. 7 If these are the only changes being made to the view at this time, then from the File menu, select Close Edit to exit Edit mode. Customization Page 25 GIB Editor User s Guide

26 Editing Views Adding Attribute and Non-Attribute Fields If you have read-write privileges, you can add attribute (and nonattribute) fields to any GIB view and its associated GIB file. The availability of specific attributes depends on the device represented by the model type for this GIB view. Attributes listed for this model type are inherited from another (base) model type; this GIB view s model type does not necessarily use/support all of these attributes. If you select an attribute that is not supported by the specific device, no error message displays, but the field is red-boxed to indicate an unsupported attribute. Refer to the MIB for the device to determine if the attribute is supported. Adding an Attribute Field To add an attribute field: 1 Select New Attribute Field from the Edit menu. The Attribute/Field Type dialog box appears, as shown in Figure 4. Customization Page 26 GIB Editor User s Guide

27 Editing Views Figure 4: Attribute/Field Type Dialog Box Model Attributes list New Attribute Field Model Attributes RWIntegerAAtest_attrib RWETIntegerAT_If_Index RWETOctet StringAT_Net_Addr RWETOctet StringAT_Phys_Addr RWBooleanAcknowledged RWIntegerActivation_Status Attribute Field Types list Attribute Field Types Button Panel, on/off toggles Button, write polled data to file Graph Graph, filled Graph, filled logarithmic Controls Attribute Flags Controls panel Show Flags Show Data Types Show Attribute IDs Filter: Explode Collapse Database Polled External Readable KeyedShared LoggedTable Attribute Flags panel Explode All Collapse All OK Cancel 2 Select an attribute from the Model Attributes list. The Attribute Field Types list provides a list of field types for the selected model attribute. Customization Page 27 GIB Editor User s Guide

28 Editing Views New Attribute Field Model Attributes Select an Attribute List of available types RWIntegerAAtest_attrib RWETIntegerAT_If_Index RWETOctet StringAT_Net_Addr RWETOctet StringAT_Phys_Addr RWBooleanAcknowledged RWIntegerActivation_Status RWIntegerAgent_Port RWIntegerApps_Created_State Attribute Field Types Button Panel, on/off toggles Button, write polled data to file Graph Graph, filled Graph, filled logarithmic Graph, filled rate 3 Click on an appropriate attribute field type to display the selected attribute. Refer to Attribute Fields for more detailed information. Select the type of field to be used to present the selected Attribute Attribute Field Types Button Panel, on/off toggles Button, write polled data to file Graph Graph, filled Graph, filled logarithmic Once an attribute is selected, its flags are listed in the Attribute Flags panel (see Figure 4). Flags which are not applicable to the given Attribute Field Type are grayed-out. Flags are set using the Model Type Editor and help you determine how to display the attribute. For example, a table flag indicates the attribute is displayed in a table; a writable flag indicates the attribute can be edited via an option button or text entry box. Customization Page 28 GIB Editor User s Guide

29 Editing Views Controls Show Flags Show Data Types Show Attribute IDs Filter : Explode Collapse Attribute Flags Polled ExternalReadable KeyedShared LoggedTable Attribute Flags Explode All Collapse All OK Cancel Controls Panel The Controls panel buttons allow you to display the Model Attributes in different formats. Flags, IDs, and Data Types can be individually selected within the Model Attributes panel using the buttons in the Controls panel. Explode After you make a selection from the Attribute Field Types, click the Explode button to show only that group in an exploded form. Collapse Click this button to display the selected attribute as a group. Explode All Click this button to display Model Attributes in hierarchical order format. Collapse All Click this button to display Model Attributes in major groups format. 4 Select OK to confirm your selection or Cancel to cancel the operation. IF you selected OK, a Field Definition dialog box appears. This dialog box displays different options depending on the specific field type selected. Refer to Using Field Definition Dialog Boxes, to complete the necessary dialog box entries and save the GIB View. Customization Page 29 GIB Editor User s Guide

30 Editing Views Adding a Non-Attribute Field To add a non-attribute field: 1 Select New Non-attribute Field from the Edit menu. The NonAttribute Field dialog box appears as in Figure 5. Figure 5: Non-Attribute Field Dialog Box Select a field type NonAttribute Field Field Type Button, Alarms for the model Button, Attribute Values sensitive New Generic View Button, Events for the model Button, External Application Button, Launch Application from SPMA map Button, Launch a script Button, New Generic View Click OK OK Cancel 2 Select a field type from the Non-Attribute Field dialog box. For more information on the field types, see Buttons, Bar Gauges, and Graphs. 3 Click OK to confirm your selection or Cancel to cancel the operation. If you clicked OK, a Field Definition dialog box appears. This dialog box presents different options, depending on the specific field type selected. Refer to the subsection Using Field Definition Dialog Boxes to complete the necessary dialog box entries and save the GIB View. Using Field Definition Dialog Boxes Attribute fields or non-attribute fields are created or modified by Editing Views. At least one Field Definition dialog box must be used to define the placement and appearance of the field; the specific dialog box depends on the type of field being defined. The dialog boxes, buttons, and entries used to define the GIB view fields are described below. Customization Page 30 GIB Editor User s Guide

31 Editing Views For more detailed descriptions, refer to Attribute Fields or to Buttons, Bar Gauges, and Graphs. An example of a Field Definition dialog box is shown in Figure 6. Figure 6: Field Definition Dialog Box Field X Position Field Y Position Button, Launch a Script These buttons access other dialog boxes These fields will vary dependent on the name of the selected Attribute. In this case, they would read Field Value and Script File. Field Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Script File OK ReadWrite Enumerations Cancel CommonDialogBoxEntries Several entries are common to all Field Definition dialog boxes. These common entries are described below. Field X and Field Y position The X and Y position of the attribute field in relation to the top left corner of the GIB View window. You can change these values by dragging the field to a new position or by entering new coordinates in this field. Field Mode Each attribute and non-attribute field has a Field Mode setting that determines how the attribute can be used. Non-Attribute field modes are automatically entered by SPECTRUM and cannot be edited when creating Customization Page 31 GIB Editor User s Guide

32 Editing Views a Non-Attribute field. Field Mode is presented as a read-only label for Non-Attribute Fields. Attribute field modes correspond to the attribute s flag settings. You can see the flag settings when the Show Flags setting is checked in the New Attribute Field Dialog box. The Field Mode setting is only effective if its corresponding flag is set. For example, an attribute with its Readable flag set but without its writable flag set cannot have its value changed using the Update option from the File menu. The ReadWrite mode option can be selected, but stays the same. Likewise, the mode settings can be used to prohibit writing (Updating) an attribute value even when the attribute s Readable and Writable Flags are set. For more information on setting attribute flags, refer to the Model Type Editor User s Guide. The options available for Field Mode are defined in the following table. Option Read Only ReadInstance ReadWrite ReadWriteAlways ReadWriteInstance AlwaysInstance WriteOnly Description When this mode is selected, the attribute can only be read. It cannot be written or updated from this GIB view. The value for the attribute is read from the currently selected board or port instance for this model. The value cannot be written or updated from this GIB view. Select this mode to make this GIB view attribute updatable. Use this mode to update the attribute s value whenever the Close Edit option is used to exit the GIB Editor from this view. The value for the attribute can only be written to or read from the currently selected instance (board/port) of this model. Use this mode to update the attribute value whenever the Close Edit option is used to exit this view s GIB Editor. When this mode is selected, the value for the attribute can only be written; it cannot be read. Customization Page 32 GIB Editor User s Guide

33 Editing Views Option WriteAlways WriteInstance Description Use this mode to update writes to the attribute whenever the Close Edit option is used to exit the GIB Editor from this view. In this mode, the value for the attribute can only be written to the currently selected board or port instance of this model; it cannot be read. Note: The Write Only, Write Always, and Write Instance modes rarely appear and depend upon the device being modeled. In some cases, the attribute cannot be read but can be written to. Read Mode External attribute fields have a Read Mode setting that determines how the attribute is to be read. The Read Mode determines what value is to be displayed in the attribute field: one from the stored database or one from a poll to the device. The Read Mode choices are described below. Choice ReadMostCurrent ReadMostAvailable ReadTryMostCurrent Description Uses the value from the latest User Interface poll, updated every five seconds. Uses the latest value stored in the database by the last SPECTRUM poll. Polling frequency is a user defined interval. Uses the value from the last User Interface poll. If the value cannot be read from that poll, the last stored value in the database is used. Customization Page 33 GIB Editor User s Guide

34 Editing Views Attribute ID This field displays the hexadecimal equivalent (handle) of the attribute name as used by SpectroSERVER. This hexadecimal value (0x0 for Non- Attribute field types) is assigned to the attribute by the Model Type Editor (MTE) when the attribute is created. This attribute cannot be edited. Field Label The field label or title. Field Font The font for the field label. You can enter the font name, if known, or click the Field Font button to open the Font Options dialog box, as shown in Figure 7. Font names must be the full fixed name or X-variable name. Do not enter the alias name for the font. For simplicity, the dialog box shows the aliases for the fonts. The font name you click on is automatically entered and previewed below the Font, Weight, Slant, and Size panels. The fonts listed in the Font Options dialog box are listed in your system s <Spectrum path>/app-defaults/spectrum.fonts file. Figure 7: Font Options Dialog Box Select the font, weight, slant, and size to be used for the field label. Preview the selected font. Select OK to confirm your choice or Cancel to accept the default font. Font: Weight: Slant: Size: charter bold italic 1 clean demibold oblique 2 courier medium Roman 6 fixed gothic 7 Helvetica 8 palatino 9 Roman Font List OK Font ABCDE abcde Font Name: Helvetica bold Cancel Customization Page 34 GIB Editor User s Guide

35 Editing Views Primary Color scheme The background color, or primary color, for the attribute field is selected here. Enter the desired scheme name, or click the Primary Color scheme button, which opens the Color Scheme dialog box shown in Figure 8. Figure 8: Select a color scheme for the field and field label. (A default text color is automatically selected.) Select OK to confirm your choice or Cancel to accept the default text color. Color Scheme Dialog Box Color Scheme Sample Bright Red Bright Blue Blue Buff Charcoal OK Cancel The Sample bar changes color to match your selection. Note: A Primary Color scheme setting defines a text color as part of the color scheme. If you select a Primary Color scheme after a Text Color Index Override selection, the text color is changed by the Primary Color Scheme definition. Use the Text Color Index Override again to restore the desired text color, if necessary. Text Color Index Override Enter the desired color index number or click the Text Color Index Override button to open the Text Color Override dialog box shown in Figure 9. This index is used to override the default color for foreground text for the selected scheme. Customization Page 35 GIB Editor User s Guide

36 Editing Views Figure 9: Text Color Override Dialog Box To change the default text color, click on another color in the color palette. Text Color Override The Sample bar changes color to match your selection. Click on OK to confirm your choice, or Cancel to display the default. Color Scheme Foreground Color OK Cancel This bar shows the current foreground color. Field Value Width Set the physical width in pixels for images, or in characters for integer and text fields. For example, if you add a text label and set the Field Value Width to 3 the resulting field is three characters wide. Enumerations Enumerations icons (GIBs, IIBs and Table) now read the database enumerations. These could be imported from the MIB or added using MTE. Database enumerations are then specified in the SpectroGRAPH resource files. If there is a match between the database enumerations and the enumerations in the resource files, then the enumeration name in the resource file will take precedence. Customization Page 36 GIB Editor User s Guide

37 Editing Views Should the values in the GIB file override the database values, the user will see the following warning: Warning: The enumeration values from the GIB file are overriding the database values. To address this, remove the enumeration values from the GIB file The button on the GIB editor panel next to the attribute field will be grayed out unless enumerations are present. Selecting the button will result in a further dialog box as depicted in Figure 10. Figure 10: Active Enumerations Button Model_State-Option Button, readwrite Field X Position Field Y Position Read Mode Field Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width OK ReadOnly ReadMostCurrent Enumerations Cancel Enumerations Model_State Initial Active Creating Error Destroyed Unknown OK Creating Table Fields in a GIB View Device Management Information Bases (MIBs) often contain attributes that are part of tables. Attributes whose values are listed in table fields must have their Attribute Flags Table value set (Figure 4). The format Customization Page 37 GIB Editor User s Guide

38 Editing Views and content of a table must be defined by GIB files having a.gtb file extension. Tables in a GIB view are created using both the GIB Editor and a Windows NT or UNIX text editor. At least two procedures must be used for each table being added to a GIB view: 1 Create a GIB file for the new table using a text editor. 2 Use the GIB Editor to add the table to an existing GIB view or create a new GIB view for your new table. If you are creating a nested table, these two procedures must be repeated for each nested table. The following sections detail table creation. TIB Files Files that define the content of tables are special GIB files called Table Information Blocks (or Tibs ). These Tibs generate unique filename extensions that describe the type of table being created. The five types of tables and their associated filename extensions are listed in Table 2. Table 2: Table Type Table Nested Table Table Field Definitions Tib File Extension.GTb.GNT Nested for an Instance Sorted Table Sorted & Nested Table.XNT.GTS.GSN Tib files can be created separately using a text editor, without terminating SpectroSERVER or SpectroGRAPH. All GIB files and Tibs are located in Customization Page 38 GIB Editor User s Guide

39 Editing Views subdirectories within the CsGib directory. The subdirectories containing GIB files are organized according to model type. Table files are placed in the same subdirectory with other GIB files for the applicable model type. To locate the CsGib directory, examine the gibpath resource in your <Spectrum path>/app-defaults/spectrum file. Refer to Defining SPECTRUM Resources for more information on resources. Figure 11 shows a sample TIB file for a basic table (.GTb), which is shown in Figure 12. Each line in a table file defines a column for that table. Attribute values listed in table fields must show the set List flag. Refer to the Model Type Editor User s Guide for more information on setting the List flag. Figure 11: Sample Tib File (.GTb) Column Definitions { ColInt.TEm( 20, 50, 0x1110f, Filter Status, BLUE, 252, 15, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, 0, Disable, 1, Enable, ) ColInt.TEm( 170, 50, 0x11110, Port 1", BLUE, 252, 15, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, 0, Filter, 2, Relay, ) ColInt.TEm( 320, 50, 0x11111, Port 2", BLUE, 252, 15, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, 0, Filter, 1, Relay, ) ColInt.TTx( 470, 50, 0x11112, Destination Address, BLUE, 252, 20, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, ) ColInt.TTx( 665, 50, 0x11113, Source Address, BLUE, 252, 20, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, ) ColInt.TTx( 860, 50, 0x11114, Type, BLUE, 252, 15, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30,) ColInt.TTx( 1010, 50, 0x 0x11115, Data Field, BLUE, 252, 18, 10, Bdg_CSI_CNB25/ CsSpecDbGTb.30, ) } Customization Page 39 GIB Editor User s Guide

40 Editing Views Figure 12: Basic Table Example Find Sort Update Print Filter Status Port 1 Port 2 Destination Address Source Address Type Data Field DisableFilterFilter DisableRelayFilter0001d0c0c0c0001d0cae11c0c0120aaaxxxxxxxxx Creating a Tib File: 1 Create a TIB file with a column definition using a text editor. Refer to the Table Column Descriptions for detailed descriptions of column parameters. Tip: If possible, copy a table file that defines another table and rename the new table. 2 Name the file using an applicable filename extension. Refer to Table 2 for filename extensions. 3 Place the newly created file in an appropriate subdirectory within the CsGib directory. 4 Refer to Adding Tables to a GIB View, to add the new table defined in your Tib file to the GIB view. Table Column Descriptions Table file column definitions consist of an attribute-specific column icon and a parenthetical column definition. Double quotes mark the beginning and end of column definition parameters. Commas are de-limiters, placed between each column parameter. Customization Page 40 GIB Editor User s Guide

41 Editing Views The column parameters (larger, bolded text) are shown in Figure 13, with a definition (smaller, definitive text) just above or below the parameter. Figure 13: Table Columns Decoded Enumerated Pair Column X, Y Position Column Heading Text Color Column Width Attribute Handle Column Color Column Length ColInt.TEm (20, 50, 0x1110f, Filter Status, BLUE, 252, 15, 10, Bdg_CSI_CNB25/CsSpecDbGTb.30, 0, Disable, 1, Enable, ) Enumerated Pair, 0 = disable, 1 = enable Path/Filename to open when entry double-clicked Enumerated Pair Column This parameter identifies the attribute type and any conversion performed on that value before it is displayed as text in the column. For SPECTRUM to properly use the attribute, the extension of this parameter must be correctly identified to match the MIB attribute type. You determine the extension from the attribute type defined in the MIB. Refer to Appendix B, for more information on extensions that can be used. X Position/Y Position X, Y coordinates for the column position are set in pixels. The Y coordinate value remains the same for all columns, which appear at the same vertical position within the table. Coordinates X=0 and Y=0 define the top left corner of the view. The X coordinate is increased for each column definition to allow sufficient space for the column attribute and a separation between each column. Tables have scroll bars so there is no limit to the number of table columns you can use. Attribute Handle Defines the attribute handle (attribute ID) for the attribute. SPECTRUM uses the attribute handle to retrieve the required value from Customization Page 41 GIB Editor User s Guide

42 Editing Views SpectroSERVER. For more information on attribute handles, refer to the Model Type Editor User s Guide. Use the Attribute Browser to view the attribute handle for each attribute. Column Heading This parameter defines the text string that you want to appear at the top of the column. The maximum length of this text string is defined in another parameter. Enter two consecutive quotations ("") with no spaces between when no column heading is being defined. Column Color This parameter allows you to set the background color of the column. It must be entered using uppercase letters. The following entries can be used for this parameter. GRAY IVORY BORDERBLUE ORANGE BLUE BUFF BRIGHTRED CORAL GOLD CHARCOAL BRIGHTBLUE SILVER Text Color This parameter allows you to set the text override color for the column heading and the values displayed in the column. Typical colors are BLACK and WHITE. Note: Each column in the table can be set to a different background and text color. Column Width This parameter allows you to set the maximum number of characters that can be viewed in the column. When the length of the text string being displayed exceeds the column width, a scroll bar appears at the bottom of the column. Customization Page 42 GIB Editor User s Guide

43 Editing Views Column Length This parameter allows you to set the maximum number of rows that can be viewed in the column. This parameter should be the same value for each of the columns being defined for a table. When the number of rows defined for a column exceeds the number of rows defined for any other column, a vertical scroll bar appears at the side of the shorter column. Filename Defines the path and filename (subdirectory/filename.30 within the CsGib directory) for the GIB file. This file links this table with the GIB view containing a Nested Table or Sorted Nested Table. The table files that define these tables (.GNT for a Nested Table or.gsn for a Sorted Nested Table) are created using the same procedures as a.gtb file. The nested table is accessed by double-clicking an entry in a column using a link to the GIB view containing a Nested Table. If there is no GIB view linked to this column, enter two consecutive quotations ("") with no spaces between. Double-clicking on an entry with no GIB view link has no effect. Note: All paths and filenames for GIB files are specified relative to the <Spectrum path>/sg-support /CsGib directory. If your files are in another directory, you will need to specify that path. Enumeration Column icons define enumerated pairs; this parameter translates each integer attribute value to a text description which corresponds to the attribute value condition. Table Enumerated Pair - When the column icon is a Table Enumerated Pair (ColInt.TEm), this parameter defines the pairing of specific numeric values and text strings. The text that appears in the column corresponds to the associated attribute value. For example: 0,Disabled,1, Enabled, 24, Standby If the attribute value is equal to one, the following text appears: Customization Page 43 GIB Editor User s Guide

44 Editing Views <column heading> Enabled Table Bit - When the column icon is a Table Bit (ColInt.TIB), this parameter defines the pairing of specific bits and text strings. Each bit of the attribute value is paired with a text string. When a bit defined by the parameter is set, the corresponding text appears in the column. When multiple defined bits are set, more than one text descriptor appears in the column separated by a vertical bar. This concept is more easily understood by examining the following example: 0,administrator,1, logger, 24, monitor If bit 0 and bit 2 are set, the following text appears: <column heading> administrator monitor Object ID - When the column icon is ColInt.TObEnum, this parameter defines the pairing of object IDs with text. Object IDs may be entered as enumerated pairs; as long object IDs, or with a short cut for long object IDs where the common prefix for all is specified at the end as in the second example below. The following two entries would be equivalent: 1.3.1, One, 1.3.2, Two, 1.3.3, Three 1, One, 2, Two, 3, Three, 1.3 If the attribute value is 1.3.2, the text that appears in the column is: Customization Page 44 GIB Editor User s Guide

45 Editing Views <column heading> Two Adding Tables to a GIB View After creating the appropriate TIB file, you can use the GIB Editor to add the table field to a GIB view. Table fields are non-attribute fields and can be added to the GIB view with the same steps used to create any nonattribute field. However, if you are adding a Nested Table to the GIB view, you must first create a new GIB view where the Nested Table will be located. If necessary, use the GIB Editor to create a new GIB view for the nested table. Refer to Editing Views (Page 16) for more information about creating a new GIB view, then return to this section to add the Nested Table to the view. To add your new table to a GIB view: 1 Open the GIB view and place the view in Edit mode. 2 From the Edit menu, select New Non-Attribute Field, then choose the appropriate table type from the Non-Attribute Field dialog box that appears. The type selected must match the filename extension assigned when you created the TIB file. A table definition dialog box appears, as shown in Figure 14. Customization Page 45 GIB Editor User s Guide

46 Editing Views Figure 14: Table Definition Dialog Box Field X Position Table Field Y Position Field Mode LABEL Attribute ID Field Label Enumerations Field Font Primary Colorscheme Text Color Index Override Field Value Width Field Value Height Table Information Block Default.GTb OK Cancel 3 In the Table Information Block field, enter the following information. a b Enter values for all parameters used to define the appearance of the field. Refer to the Adding an Attribute Field and Adding a Non- Attribute Field subsections for more information. Enter the filename and extension for the table s Tib file (see Table 2). If the Tib file is not located in the CsGib directory, include the file path relative to the CsGib directory in your entry. Click OK to save the table, or Cancel to exit without creating a table Customization Page 46 GIB Editor User s Guide

47 Creating Views Creating Views This section shows you different ways to create new views with the GIB Editor. Creating and Accessing a New View The GIB Editor is used to create new GIB views in any of the following ways: Create a new view which is accessed by a button in an existing view and then customize the new view. Create a new view which is accessed with an Icon Subviews menu option. This new view displays attributes, or characteristics associated with different model types, that you select using SPECTRUM s Attribute Browser. You can now customize the view with the GIB Editor. Creating a Button to Access a New View When you want to create a button in a view to access another view, from the File menu select Edit. Once in Edit mode, from the Edit menu select New Non-attribute Field. This will bring up the NonAttribute dialog box from which you should select one of the following: Button, New Generic View - used to replace the current view with the new blank view Button, New Window Generic View - used to create a new window with the new blank view Button, Secure New Window Generic View - opens a new window with a new blank view to users with admin and edit privileges only Exit Edit mode. Click the button you created to access and customize the new blank view. Customization Page 47 GIB Editor User s Guide

48 Creating Views To create a button for accessing a new blank view: 1 Open the view in which the new button will be located. 2 From the File menu, select Edit. 3 From the Edit menu, select New Non-Attribute Field. 4 Select Button, New Generic View, or Button, New Window Generic View, or Button, Secure Generic New Window View. 5 In the Button dialog box that appears: a b c Enter the X and Y position of the button; or, in the view itself, drag the new button to the desired location. Enter the Field Label name that appears on the button. Choose the Primary Colorscheme and desired text color by clicking on those buttons. Note: Leave the Field Value Width at the default value; the button width is determined by the length of text. d enter the Next GIB Name. This value is a unique name identifying the GIB file associated with the new GIB view. The file name incorporates the.30 file extension. Note: Avoid using the DefaultGIB.30 filename as the name for the new GIB file. If you use DefaultGIB.30, any GIB fields that you define for your new view are entered into this default GIB file. When you create another View Button, you cannot use DefaultGIB.30 without corrupting the previously defined GIB View. 6 Select OK to create the new button or Cancel to return to the view without creating a button. 7 From the File menu choose Close Edit. Customization Page 48 GIB Editor User s Guide

49 Creating Views 8 Click the button to open the new view. The new view can be edited with the GIB Editor, as described previously in Editing Views. Accessing a New View with an Icon Subviews Menu Attribute Browser Another method of creating a new GIB view is to use the Attribute Browser to select attributes that will populate your view. From the Device s Icon Subviews menu select Utilities > Attribute Browser. The attributes for this new view can be selected from the attribute list and saved to a model or model type. Exit and re-enter SpectroGRAPH to access the new menu choice. After opening the new view from the Icon Subviews menu, edit the view with the GIB Editor. To create a new view with the Attribute Browser: 1 Highlight a model of choice. 2 Select Utilities > Attribute Browser. The Attribute Browser dialog box appears, as shown in Figure 15. Customization Page 49 GIB Editor User s Guide

50 Creating Views Figure 15: Attribute Browser Attributes list Attribute description appears in this column Filter field Attribute flags panel Landscape 0x VNM Host - Attribute Browser of Type Model File View Tools Bookmarks Model Attributes Group ID Integer Boolean Integer Tagged Octet Text String Integer Tagged Octet Integer Controls Show Flags Show Data Types Show Attribute IDs Filter: Explode Explode All OK Save - CSIChassis - modulestate - UseChangesCounter - moduletoapplstate - internalslottable -FirmwareRevision - comfpredundenable - pulledboardlist -applicationstate Collapse Collapse All Attribute Flags DatabasePolled ExternalReadable KeyedShared LoggedTable Cancel Repoll Instance ID: 3 Select attributes from the Model Attributes list by double-clicking on the attribute, or clicking on an attribute then clicking on OK. Use the buttons in the Controls panel section of the view to: a b c Show the data types, flags, and attribute IDs. Display the Model Attributes in a hierarchical tree form (click Explode All), or as major groups (click Collapse All). Select and display individual Group IDs in exploded form by clicking Explode, or show the selected Group only by clicking Collapse. Filter attributes by entering text in the Filter field and clicking OK. Attribute Flags can be used for displaying each attribute as the attribute is selected. For more information on Attribute Flags, refer to the Model Type Editor User s Guide. The Instance ID field allows you to specify which board or port attributes the view displays. The selected attributes Customization Page 50 GIB Editor User s Guide

51 Creating Views appear on the right side of the view as they appear in the view. The last entered selection can be removed by clicking the OK button when no attribute is selected. 4 Click Save after selecting all attributes for the new view. A Text Entry dialog box (Figure 16) prompts you for a filename for the new GIB view. Figure 16: Saving Model Attributes Dialog Box Text Entry Enter a filename to save the GIB into: OK Cancel Help 5 Enter the desired name and click OK, or click Cancel to return to the Attribute Browser. A dialog box confirms the view s assigned name, and asks if you would like this view linked to a model or modeltype. Select OK and this will display the Save GIB to Model or Model Type dialog box (as shown in Figure 17). Customization Page 51 GIB Editor User s Guide

52 Creating Views Figure 17: Save GIB to Model or Model Type Dialog Box Each Gib model name entered into the Multidialog box Text Entry appears here Each Gib model type name entered into the Multdialog box Text Entry appears here Clicking OK saves all names entered into the Multi- Text Entry dialog box Save GIB to Model or Model Type GIB for Model Menu option for Model GIB for Model Type Menu option for Model Type I OK Cancel Add Model Add MType Delete The model name entered and saved to the Multi-Text Entry dialog box appears here Each model type name entered and saved to the Multiappears here Text dialog box Click Add MType to enter model, model type, and menu names 6 The new GIB view must be stored with the model type or with the model. If stored with the model type, all models of that type contain this new GIB view Icon Subviews menu choice. To store a GIB view with the model type, select the Add MType button. To store the view with a specific model, select the Add Model button. The Multi Text Entry dialog box appears. 7 Enter a GIB filename into the GIB Name text box. If the name of an existing GIB file is selected, you will be notified that the file exists and prompted whether to overwrite it. Do not use spaces in the GIB filename. The GIB Name can consist of 1 to 11 ascii characters with no extensions. A.30 file extension is added to this name when saved, and the new GIB file is placed in the CsGib directory. The default path name for the new GIB file is defined by the gib path resource in your Customization Page 52 GIB Editor User s Guide

53 Creating Views <SPECTRUM directory path>/app-defaults/spectrum file. The default path is Spectrum/SG-Support/CsGib. 8 Enter a name for the view in the GIB Menu Name field. This name will be listed in the Icon Subviews menu for the individual model or model type, depending on the save option chosen in Step 6. 9 Select the OK button, or Cancel button to cancel without saving. If OK is selected, the entries will be placed into the appropriate areas of the Save GIB to Model or Model Type dialog box. 10 To remove GIB menu options and the associated GIB files: a b Select the item to remove in the Save GIB to Model or Model Type dialog box. Click on the Delete button. A dialog box will prompt you for a response. Click on OK to proceed or Cancel to quit. 11 When you want to save these changes, click on OK. To cancel without saving, click on Cancel. Note: The new GIB file is created with you as the owner and the read/ write permissions on the file are set to your umask. You may change the mode (permissions) of the file or ownership of the file. This is true for all GIB files. If read access is denied to other users, the menu selection will be present, but the other users will not be allowed to display the new GIB file. In this case, the default GIB file is used. To resolve this problem, you can change the mode (permissions) of the file to allow all users to read it. 12 Once the new GIB view is created, exit and re-enter SpectroGRAPH to see the entry on the Icon Subviews menu of the selected model. DO NOT shut down the SpectroSERVER. 13 After restarting SpectroGRAPH, click on the model icon being edited. Select your new GIB View name from the Icon Subviews menu. Using the GIB editor, you can now modify the view and save the changes back to the new GIB file. Customization Page 53 GIB Editor User s Guide

54 Attribute Fields Attribute Fields This section defines all the attribute types supported by the GIB Editor. GIB Views To effectively manage the information contained in a GIB View, you must understand the type of information and presentation methods available in a GIB View. GIB Views can contain Attributes, Non-Attributes, and Annotations. Attributes are Management Information Base (MIB) objects. The attributes are described later in this section. Non-Attributes are images or features that can be added to a GIB view to assist with presenting or using information. Annotations are text, lines, circles, and rectangles that are placed in a GIB view to make the view easier to understand and use. For example, boxes can be used to set off fields in logical groups using annotations. You can also change font style, size, and background color within each view. Annotations are covered in greater detail in the Annotation Toolbox. Attributes SpectroSERVER polls each device for the values of external attributes. Examples of attributes include: IP_Address, Device_Name, SNMP_OutPkts, and EtherCRCErrs. Attribute values can be displayed in a number of different formats, called attribute fields. These fields include text strings, numeric values, and option buttons. Each attribute field shows the current attribute value for a specific model. Several attribute fields can be displayed simultaneously in a GIB View. The same attribute can be displayed more than once in an attribute view, using the same field type (format) or using different formats. Customization Page 54 GIB Editor User s Guide

55 Attribute Fields Attribute Field Types Attribute fields are red-outlined if the values were not obtained from a device by the last poll. This may be caused by the lack of those attributes in the modeled device; some devices may not support all attributes listed in the MIBs. Attribute Field Types The fields and labels that appear within each GIB view display attribute values. The field information may differ depending upon whether the attribute is read/ write or read only. Read/write attributes allow you to make changes within the GIB view. Read only attributes appear as values that cannot be changed; text and buttons are unchangeable labels. Read only and read/write examples are provided with each description; field types are determined by the Attribute type. Note: The GLO icon used by some administrators to display an octet string is now a hidden icon and has been replaced by OLT. Unlike GLO, OLT will read and write octet string values When you select an attribute from the Model Attribute list (see Figure 4), all of the attribute s associated values appear in the Attribute Field Type list. Attribute fields are described below. Agent ID This option displays an Agent ID (usually an IP address) similar to Numeric Display, Decimal, Dot Separated. In the dialog box you must specify the following: Base Specify hexadecimal (16), decimal (10), or ascii (0). Chunks Specify the number of bytes to be displayed. For example, an IP address would have four chunks because it is composed of four dot-separated bytes. Customization Page 55 GIB Editor User s Guide

56 Attribute Fields Button, New Generic View of Specified Model Creates a button that opens a new GIB view for a particular model. The new view replaces the current view. You must specify the absolute path and filename for the GIB file when creating or modifying this field. Button, New Window & Generic View of Specified Model Creates a button that opens another window and GIB view for a model, in addition to the currently open windows.you must specify the absolute path and filename for the GIB file when creating or modifying this field. Button Panel, On/Off Toggles Displays an attribute as a panel with labeled toggle buttons for each bit specified. You can specify labels that correspond to specific bits of the value for the attribute in the dialog box. When these fields are used to present a write attribute, the buttons that appear in the view can be selected to toggle a corresponding function (on off, enable disable, etc.) If the attribute is read only, the buttons are visible, but cannot be toggled. Enumerated pairs of bit masks and text to describe them are entered in the dialog box using the following format: bit-n, text-a, bit-n+1,text-b, bit-n+2,text-c, etc. Commas (,) are used to separate the bit mask definitions from the associated text and between bit mask-text pairs. Bit mask entries must be in the range of 0 through 31. Bit zero is the least significant bit. Spaces cannot be used within the descriptive text. If the text is more than one word, use another character such as a hyphen to separate the words. The dialog box used with Integer attribute types is similar to the one used for Counters and Gauges, however, the Bit ON Values field appears instead of the Enumerated Pairs field. The entry for an Integer button panel is shown below, and the resulting panel in Figure 18. Customization Page 56 GIB Editor User s Guide

57 Attribute Fields Dialog Box Enumerated Pairs Entry Example: 0,On,1,Idle,24,Standby Where: When bit 0 is set, means On When bit 1 is set, means Idle When bit 24 is set, means Standby Bits can be set or reset in any combination. Note: Use the keyboard s left and right arrow keys to view an entire list of enumerated pair entries when the list scrolls beyond the viewing area of the Enumerated Pairs field. Figure 18: Button Panel, on/off toggles example Field Label On Standby Idle Button, Write Polled Data to File This option creates a button in a GIB View that allows users to record previously logged values of an attribute, together with their date/time stamps, into a user-defined log file. The current attribute value is displayed on the button as an absolute decimal number. The Number of Hours to Log Data field is added to the basic dialog box. Number of Hours to Log Data This field specifies the number of hours for which the data is logged to the file. This button uses the specified time interval to establish a time frame for recording values in the file. When the Write Polled Data to File Customization Page 57 GIB Editor User s Guide

58 Attribute Fields button is selected, the attribute values retrieved during the time interval immediately prior to selecting the button, are recorded in the file. There is no polling ratio applied for information recorded in the log file. To reduce the volume of information captured, you must reduce the time interval. Polling continues, even when the view is iconized. The maximum interval is nine hours. Values that have been archived cannot be recorded in the file. The default value that appears in the field is 2 (two hours). After you select a Write Polled Data to File button and specified the saving location and the number of hours to log data, click File>Close Edit. At this point, the newly-created button becomes active. Doubleclicking on the new button brings up a dialog box prompting you to enter a path and filename for the log as in Figure 19. Customization Page 58 GIB Editor User s Guide

59 Attribute Fields Figure 19: Path and Filename Dialog Box Select Filter Filter Enter path and filename to be used to dump data Directories Files Selection OK Filter Cancel Help Note: If possible, when you define the characteristics for this field, enter the word log in the field. This helps to differentiate the button from others having a similar appearance in GIB Views. Date (Ctime Format) This option creates a field presenting the date using the strftime C- library function to format the time and date where hh = hours (0 through 24), mm = minutes, ss = seconds. Customization Page 59 GIB Editor User s Guide

60 Attribute Fields Date/Time, Custom Format This option presents the date and time in a format of your choosing. In the dialog box, you must specify the format using the appropriate variables, as follows: %a = day of the week %b = month %e = day of the month %H:%M:%S = hours (0-24):minutes:seconds %Z = time standard %Y = year Entry Box, Immediate WriteOnly Agent ID This option creates a text entry box that allows you to enter an Agent ID and write it to a device. The Agent ID can be entered by clicking on the box associated with the field and typing in an entry. After entering the Agent ID, press the RETURN key. The Agent ID is written to the device when confirmed by the user. Graph Graphs and Filled Graphs allow you to observe changes to individual attribute values over time. You can specify additional graph parameters in the Graph dialog box. An example of the Graph dialog box appears in Figure 20. Scale, Maximum Value, and Read History are unique to the Graph dialog box, and are described below: Customization Page 60 GIB Editor User s Guide

61 Attribute Fields Figure 20: Graph Multi-Attribute Dialog Box Graph, Multi-Attribute Field X Position Field Y Position Field Mode Attribute ID Enumerations Field Label Field Font Primary Colorscheme Text Color Index Override Graph Width Maximum Value Scale Distance Between Markers Extra Attributes OK Cancel Scale You can change the graph s X-axis default of 10 by increasing/decreasing the numeric value. Maximum Value Enter the maximum value for the X-axis, or use the default value that appears. Customization Page 61 GIB Editor User s Guide

62 Attribute Fields Read History Information retrieved from the statistics database is displayed in this field. Valid entries must be entered as uppercase. HISTORY NO HISTORY Historical data is subject to the Poll to Log Ratio in a 10:1 ratio, thus historical data from the statistics database often has a saw-tooth appearance. With a 10:1 log ratio, some information, such as peak values retrieved by a poll not recorded, may not appear on the graph. 10:1 is a default value that can be adjusted by the Administrator as he sees necessary. Only poll data up to three times the Y-axis time value is displayed. This data is obtained while the view graph is displayed; the graph data is cleared when the view closes. The Graph option shows a line that represents the unsigned value for an attribute plotted over time. Colors, vertical and horizontal size, and units of measure are specified when the view is created or modified. The range of the vertical scale automatically adjusts, or auto-scales, to the highest value being presented. The highest value recorded is marked by a small triangle that appears on the vertical scale. A graph example is shown in Figure 21. Customization Page 62 GIB Editor User s Guide

63 Attribute Fields Figure 21: Graph Example Attribute Name Apr 09, :23:12: SDT Graph, Filled A Filled Graph, shown in Figure 22, differs from the Graph option. The area below the line is filled with the same color specified for the line. Figure 22: Filled Graph Example Apr 09, :23:12: SDT Graph, Filled Logarithmic A Filled Logarithmic Graph field is the same as a Filled Graph, except that it uses a log10 scale for the vertical axis. Customization Page 63 GIB Editor User s Guide

64 Attribute Fields Graph, Filled Rate A Filled Rate Graph is the same as the Rate Graph below, except the area below the plotted line is filled with a solid color that matches the color selected for the line when the field is created or modified. Graph, Rate A Rate Graph is similar to a Graph field, except that it plots a ratio of the previous value and the current value for an integer-type attribute over time. An example is provided in Figure 23. The formula used to calculate the values plotted in a Rate Graph is as follows: Rate = current value - previous value actual interval between polls* * Depending on other SpectroSERVER tasks in process, the interval may differ from the specified GIB polling interval. Figure 23: Rate Graph Example Rate Graph Apr 09, :23:12: SDT Information presented in the graph is retrieved from archived files; the selected attribute should be represented by a logged flag set. You must specify HISTORY in the dialog box. Refer to the SPECTRUM Database Management documentation for more information on archived Error Log and Statistics files. HISTORY adds the SDT (Set Date and Time) button to Customization Page 64 GIB Editor User s Guide

65 Attribute Fields the view. The SDT button allows you to set the reference edge (far right edge of the graph viewing area) to a starting time and date. When NO HISTORY is entered in the dialog box, the date and time are not displayed, and the SDT button is not present. All the values plotted on the graph are retrieved from the database. The graph viewing area can be scrolled to view up to three times the Y-axis scale. List, Multiple Attributes from Specified Model This option creates a list of attributes from some other model (not the one the GIB view is for) that you specify with the model handle. An example is presented in Figure 24. In the dialog box you must specify: Label/Attribute Pairs The list of the attributes that you want to display from the other model, and its label. The default value of this field is: label 1, 0x0, label 2, 0x0 You must enter the pairs of attribute IDs and labels. Use the cursor and left and right arrows to move around to edit the field. You can find the attribute IDs from the Attribute Browser or from a MIB. Spacing The spacing between lines in the list. Figure 24: List, Multiple Attributes from a Specified Model Example Field Label Firmware_version1.1 MAC Address With Vendor Name Displays the first three bytes of the MAC address as text for the vendor name (if resolvable) and the rest of the MAC address in hex following a dash. The table for resolving the first part of the MAC address to a vendor name is in the SG-Support/CsResource/EtherMap file. You may add to or Customization Page 65 GIB Editor User s Guide

66 Attribute Fields alter this file. You must restart SpectroGRAPH after making a change to this file to see the changes. Numeric Display, Binary Format Displays the attribute value in binary. An octet string-type attribute is displayed as a 64-bit binary number. For octets, set the mode for this field to permit updating so that the entire 64 character field can be viewed. Numeric Display, Decimal, Dot Separated The attribute value is displayed in dotted decimal. Numeric Display, Hex, Dot Separated Displays an octet in hexadecimal with dot separations. Numeric Display, Hex Format Displays an attribute value in hexadecimal notation. Numeric Display, Hex or Decimal, Dot Separated Displays the attribute in decimal or hex. Fill in Base in the dialog box as 10 for decimal or 16 for hex. If hex is chosen, the attribute will be displayed as octet in hex with dot separation. If decimal is chosen, the attribute will be displayed as dotted decimal. Numeric Display, Integer Displays the attribute value as an integer. Numeric Display, Signed Displays the attribute value as a positive or negative decimal number. Numeric Display, Signed Delta Displays the difference between the previous value and current value as a positive or negative decimal number. Numeric Display, Signed Rate Displays the rate of change between the previous value and current value for a REAL-type attribute using the formula: Rate = current value - previous value actual interval between polls Customization Page 66 GIB Editor User s Guide

67 Attribute Fields The rate is always a positive number; if the current rate changes to a value less than the previous value, the value will stay the same. Depending on other SpectroSERVER tasks in process, the interval may differ from the specified GIB polling interval. The time displayed here is the actual clock time. Numeric Display, Unsigned Displays the value of an integer-type attribute as an absolute decimal number. Clicking on Numeric Display, Unsigned causes the Numeric Display, Unsigned dialog box, to appear. In this dialog box, typical Change Background fields appear. The Divisor field allows you to enter a specified value to divide an attribute value and then display the result as a specified notation. Example: Example: If an attribute s value is 1000 and the specified divisor value is 2, the new attribute value of 500 is displayed. To double the original value of 1000, change the divisor value to.5 and the result is If an attribute s value is 10000, the specified divisor is 1000, and the result is 10. Numeric Display, Unsigned Counter Displays a counter-type attribute as an absolute value. Numeric Display, Unsigned Delta Displays the absolute value that is the difference between the previous polled value and the current polled value of an attribute. Numeric Display, Unsigned Rate Displays the rate of change between the previous value and current value for COUNTER, GAUGE, and INTEGER-type attributes using the formula: Rate = current value - previous value actual interval between polls Customization Page 67 GIB Editor User s Guide

68 Attribute Fields The rate is always a positive number; if the current rate changes to a value less than the previous value, the value will stay the same. Depending on other SpectroSERVER tasks in process, the interval may differ from the specified GIB polling interval. The time displayed here is the actual clock time. Numeric Display, Vendor Code Displays the vendor code in dotted decimal notation. You must choose the Read Mode in the dialog box; this attribute cannot be changed. Option Button An Option Button is created from enumerated pairs that equate an attribute s numeric value to text that describes the significance of that value (e.g., 0 = Active, 10 = Inactive). You select the Field Mode that controls the presentation as read only or read/write. For write, the value can be changed by clicking on the button associated with the field. When the button is selected, a text options appears in the view. When one of the options is selected from the menu, the enumerated value associated with it is written to the device when the user confirms the change. This is useful when a network device attribute can be written to and also read through the network. If not write, the field appears as a box with the field label and the text equivalent value of the attribute. The enumerated pairs are entered in the dialog box as a list using the following format: value_a, text_a, value_b, text_b, value_c, text_c, etc. Commas (,) are used to separate the value from the associated text and between value-text pairs. Spaces cannot be used within the text. If the text is more than one word, use another character such as a hyphen or underbar to separate the words. A typical example showing the dialog box entry pairing for Condition_Status is shown in the following example: Enumerated Pairs 0, Disable, 1, Enable, 2, Other Customization Page 68 GIB Editor User s Guide

69 Attribute Where: Fields 0 is paired with Disable 1 is paired with Enable 2 is paired with Other Note: Use the keyboard left and right arrow keys to view an entire list of enumerated pair entries when the list scrolls beyond the viewing area of the Enumerated Pairs field. Option Button Toggle An Enumerated Boolean field interprets an attribute value as one of two possible states, such as True False. The specific states are defined when the field is created or modified. When the attribute is writable, the state can be changed by selecting the button and choosing the appropriate state from the pull-down menu. The enumerated value associated with the selected state is written to the device when the change is confirmed by the user. If the attribute is not writable, the field appears as a simple box with the field label and the attribute value. An example is provided in Figure 25. You must specify the following in the dialog box: False String The text to display when the attribute value is false. True String The text to display when the attribute value is true. If the text is more than one word, use another character such as a hyphen or underscore to separate the words. Customization Page 69 GIB Editor User s Guide

70 Attribute Fields Figure 25: Option Button, Boolean Example Read/write Field Label True False Read only Field Label True Option Button, Custom Background Color This option creates a field label with a button that changes color depending on the value selected. You must specify the Enumerated Triples. The three values of the triple are the number returned, the text meaning of this value, and the display color. The color index is a number selected from the SPECTRUM Text Color Index Override. Click on the Text Color Index Override button in the dialog box to see the possible colors and their numbers. For example, the default entry is: 0, Default_0, 244, 1, Default_1, 252. This would create a field with a colored button with selections of Default_0 and Default_1. The Default_0 button would be the color 244, while the Default_1 button would be the color 252. See the introductory discussion on the Option Button for details on entering enumerated pairs. Option Button, Immediate Write This option displays an attribute as a button with selections specified in the enumerated pairs; see Figure 26. This field type is similar to the Option Button except for the timing of the selected action. When the button associated with this field is selected, a menu of text strings appears in the view. When one of the text strings is selected from this menu, its enumerated value is written to the device when confirmed by the user. This field type is typically used to initiate some immediate action in a network device, such as resetting a counter. See Option Button for details on entering enumerated pairs. Customization Page 70 GIB Editor User s Guide

71 Attribute Fields Figure 26: Option Button, Immediate Write Field Label Disable Option Button, Object Id Displays an Object ID attribute, allowing you to assign text to each Object ID value. For example, if a single model represents several different hardware types, you can specify the word server as the server OID. If the OID represents a gateway, it returns the word gateway. You must specify the following in the dialog box: OID Enumerated Pairs The final byte of the OID with the text to define it. See Option Button, for more details on entering the enumerated pairs. OID Enumeration Prefix The OID string that goes before the final byte. Option Button, Readwrite Displays an attribute with text you assign to each value. See Option Button for details on entering enumerated pairs. Option Toggle Button This field is similar to the Boolean Option Button (see Option Button Toggle), except the new button does not present a menu choice, but toggles between two writable choices. In the dialog box, you have the following choices: Need Confirmation (yes/no) If you specify Yes here, the enumerated value associated with the selected state is written to the device when the change is confirmed by the user. If you specify No, confirmation is not required to write the new state to the device. Customization Page 71 GIB Editor User s Guide

72 Attribute Fields Percentage Presents an integer-type attribute value as an unsigned percentage. Two attributes are selected when this field is created. The value (nn.nn) displayed is the result of the following formula: 100 x 1st attribute value 2nd attribute value You must select the second attribute value by clicking on the Extra Attributes button and selecting it from the list. Pie Chart Options Pie charts show a comparison of two or more fields based on one attribute, and can represent the following: Integers Gauges Counters You must select the attributes and assign colors and labels for each slice of the pie. Each attribute value, represented as a part of the whole pie, is reflected in the size of the slice. The dialog box fields for attribute pie charts are similar to those for the non-attribute pie charts, and allow you to specify pie chart width and height values. For more information on each pie chart option, refer to Pie Charts. Scrolled, in Hex, Decimal or Text Displays values in a scrolled box, as seen in Figure 27. Figure 27: Scrolled Example Field Label Customization Page 72 GIB Editor User s Guide

73 Attribute Fields The dialog box for this field contains unique parameters, which are listed below: Number of columns The number of columns presented in the list. Number of rows The number of rows presented in the list. Maximum length The maximum length of the text. Base Indicates whether the data is to be displayed in hex (base = 16), or decimal (base = 10). Chunks The default value is 4 and should not be changed. Chunks are the number of octets. Separator Shows any specified text separators used in the display. A dot is the default. Single Attribute from Specified Model This field shows an attribute value from some other model that you specify. Enter the attribute ID representing attribute value you wish to display. Refer to the Attribute Browser to find the attribute IDs, or to that model s MIB. Tachometer, arc This graphical representation of a tachometer displays attribute values. Figure 28 shows an example of an arc tachometer. In the dialog box you specify: Maximum Value The maximum value displayed on the tachometer. Customization Page 73 GIB Editor User s Guide

74 Attribute Fields Yellow Line (%) The value, as a percent of the maximum attribute value, that you wish to denote with a yellow line to signify approaching critical value. Red Line (%) The value, as a percent of the maximum attribute value, that you wish to denote with a red line to signify the critical value. The tachometer displays the following: Value The current value for this attribute. High The highest value received so far. You can reset this to the current value. Figure 28: Arc Tachometer Example Field Label Value 5 High Yellow line Red line Tachometer, Bar This bar-type tachometer representation displays the attribute value. The dialog box entries are similar to those of the Arc Tachometer; refer to Figure 29 for an example. Customization Page 74 GIB Editor User s Guide

75 Attribute Fields Figure 29: Bar Tachometer Example Field Label Value 5 High Yellow line Red line Text Shows a text string that is not limited to a maximum number of characters. When the length of a text string exceeds the width of the field, the string is not truncated. You can select and move the field right and left using the keyboard arrow keys. (Figure 31.) Figure 30: Text Example Field Label Attribute Value Text Text, Capital Letters Displays the attribute value in all capital text Text, Custom Background Color Displays the attribute value as a box field with your choice of background color. You can change the color scheme background colors by entering the desired background color in Background Color Override. Click the Text Color Index Override button to view a list of colors and numbers. Text Display This option decodes an octet as ASCII and presents it as text. Text, Limited Length Displays a text string that is a limited length as in Figure 31. When the length of the text string exceeds the specified field length, the string is Customization Page 75 GIB Editor User s Guide

76 Attribute Fields truncated to the maximum length. The maximum length is defined when creating or modifying the field. Figure 31: Limited Length Text Example Field Label ValueTruncated if to [value] Text, Scrolled This option creates a scrolled text field. This field can be longer than one line or the provided text block. Refer to Figure 32 for an example. When you select a text attribute, you can also select a new icon which places the values in a scrolled text field block. Figure 32: Scrolled Text Example Field Label This can be as long as you need. Text, Security With this option, you can create a text field that can be viewed only by SPECTRUM users with ADMIN privileges. The string can be changed if the user has write privileges. This is a convenient means of selectively displaying security strings and other sensitive data. If you have ADMIN privileges, the attribute value is visible. If you do not have ADMIN privileges, the attribute value is hidden and asterisks are presented in the field. Text, With Non-printable Symbols as Spaces Displays non-printable characters and carriage returns as spaces in a text field. Customization Page 76 GIB Editor User s Guide

77 Attribute Fields Time, Formatted Elapsed Displays elapsed time attributes as a time value presented in Days + (plus) Hours:Minutes:Seconds format. You must specify the scale factor in the dialog box. Divide the attribute value by the scale factor for the number of seconds. Use the appropriate scale factor depending on how the device stores the value. Figure 33: Formatted Elapsed Time Example Field Label 1+03:21:05 Time (ctime Format) Shows time in the format of Day, Month, Date, Hours:Minutes:Seconds Time Standard, Year. This field can be changed by the user. After making a change, you cannot exit the view without verifying the change. Figure 34: Time Example Read/write Field Label Sun May 10 19:00:01 EST 2000 Time Ticks Displays a numeric value that represents a unit of time, such as seconds or hundredths of a second. The specific unit of measure is determined by the specific attribute selected. Time/Date, Formatted This option creates a box with the time and date. In the dialog box, you enter the format. The default is %a %b %e %H:%M:%S %Z %Y where %a = day of the week, %b = month, %e = date, %H = hour, %M = minutes, %S = seconds, %Z = time standard, %Y = year. You can reorganize these variables to the desired format. Customization Page 77 GIB Editor User s Guide

78 Attribute Fields Pie Charts - Attribute Field Types PieCharts-AttributeFieldTypes Fields that are based on one attribute are listed in the New Attribute Field. Non-attribute pie chart fields that are not based on attributes, such as buttons, are listed under New Non-Attribute fields. For information on non-attribute pie charts, refer to Pie Charts. To use the New Attribute Field options, first select a model attribute that can be displayed in pie-chart form from the New Attribute dialog box. The Attribute Field Types panel shows the selected attribute. Three dialog boxes are used to define these pie charts. The first dialog box (see Figure 35) defines the overall characteristics of the chart. The second dialog box (see Figure 36) lists attributes that can be presented in the pie chart. The third dialog box (see Figure 37) defines the presentation for each attribute selected. These dialog boxes and the common fields are described below. Customization Page 78 GIB Editor User s Guide

79 Attribute Fields Figure 35: Pie Chart Dialog Box Enter overall field definitions directly into the dialog box Select the Extra Attributes button to open the Attribute Selection dialog box. After defining attributes, select OK. Delta_Frames_Delivered_Rcvd--Pie Chart, delta, labeled on left Field X Position Field Y Position Field Mode Read Only Read Mode ReadMostCurrent Attribute ID Enumerations Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width Pie Chart Height Extra Attributes OK Cancel Customization Page 79 GIB Editor User s Guide

80 Attribute Fields Figure 36: Attribute Selection Dialog Box Select pertinent attributes from the alphabetical list and click OK. AAtest_Attrib Activation_Status Agent_Port AppViewZoomFactor App_View_Mode Apps_Created_State Attr_Number Board_Structure Change_Stamp Child_Count Composite_Condition Condition Condition_Value Attribute Selections Selected Item Count 2 OK Cancel Customization Page 80 GIB Editor User s Guide

81 Attribute Fields Figure 37: Describe Attributes Dialog Box The length of this dialog box varies according to the number of attributes selected. These four fields are repeated for each attribute selected. Enter attribute definitions directly into the dialog box fields. Select a different Index Color and Group Number for each pie slice. Select OK to confirm your definitions Attribute ID Field Label Index Color Group Number Attribute ID Field Label Index Color Group Number Attribute ID Field Label Index Color Group Number OK Describe Attributes Enumerations Enumerations Enumerations Cancel Text Color Index Override Allows you to change text color for the different fields in the pie chart. Enter the desired color index number, or select the Text Color Index Override button to open the Text Color Override dialog box, as shown in Figure 9. This index is used to override the default color for foreground text in the selected scheme. Pie Chart Height Set the height in pixels for the pie chart field. Extra Attributes Allows you to select other attributes to be displayed in the pie chart. The Attribute Selection dialog box, which is shown in Figure 36, appears Customization Page 81 GIB Editor User s Guide

82 Attribute Fields when you click this button. An unlimited number of attributes can be placed in a single pie chart. When the list of attributes exceeds five, a scroll bar appears on the right side of the Describe Attributes dialog box, as shown in Figure 37. All entries can now be accessed. Field Label The default is the selected attribute name, but you can enter meaningful label information in the Describe Attributes dialog box. Index Color Enter the color index number for this attribute/pie slice. A different index number should be entered in the text box to differentiate this attribute or group of attributes from others. You can also click the Index color button to access the Select Color Index dialog box. Group Number Assign group numbers to each attribute or group of attributes that will display in the Describe Attributes dialog box as a separate slice of the pie. The default shows all attributes as being in the same group. Multiple attributes can be grouped together to form a single pie slice. Identify all attributes within a group using the same Field Label and group number. Pie Chart, Related Models, with Total, Delta and Accum This option will show the current (total) attribute values, the accumulated attribute values (accumulated from the time the Accum button is clicked) or the difference (delta) between the current and previous attribute values for each related model, depending on which mode is selected. The models presented are determined by the relation selected when the field is created or modified. When Delta is selected, this pie chart can be used to compare the difference between the previously polled value and the current value of an Customization Page 82 GIB Editor User s Guide

83 Attribute Fields Tables - Attribute Field Types attribute. These values are taken from several models, and shows each model s contribution (percentage) to the total of the delta values. When Total is selected, this pie chart provides the current attribute values for each of the related models and each model s contribution (percentage) to the total of values. When Accum is selected, this pie chart provides the accumulated attribute values for all related models since the Accum button was clicked, and each model s contribution (percentage) to the total accumulation of values. To restart the counter, click the Clear button. Values continue to accumulate until cleared, or another presentation mode is chosen. Pie Chart, Related Models Using Instance ID, with Total, Delta and Accum This option is similar to Pie Chart, Related Models, with Total, Delta and Accum, except that it is used when the related models are components of the GIB view device. For example, a hub GIB view can be used to show an attribute of all the boards in the hub. The attribute selected must be a type that requires an instance ID, and it must be an attribute selected from the related models, not the current GIB view model. Attributes that require an instance ID are table type attributes. When determining the attribute ID from the New Attribute field window of the related models, check the Attribute Flags panel and make sure Table is highlighted. HASPART is the usual relation used in this type of pie chart. Tables - Attribute Field Types Device Management Information Blocks (MIBs) often use attributes that appear in tables. Using the GIB editor and a text editor, you can create a table that displays table attributes. Initially, you must set the Table flag for attribute values appearing in table fields. Table, or list, flags are set in the New Attribute Field dialog box. For more information on List flags refer to the Model Type Editor User s Guide. The format and content of a table must be defined by a GIB file with a.gtb file extension. These special GIB files are described in detail in Creating GIB Files to Define Customization Page 83 GIB Editor User s Guide

84 Attribute Fields Tables - Attribute Field Types Table Fields. An example of a table field is shown in Figure 38. For information on tables, refer to Tables. Figure 38: Table Example Find Sort Update Print Special Database Filter Table Filter Status Port 1 Port 2 Destination Address Source Address Type Data Field DisableFilterFilter DisableRelayFilter0001d0c0c0c0001d0cae11c0c0120aaaxxxxxxxxx Chapter 39 Customization Page 84 GIB Editor User s Guide

85 Buttons, Bar Gauges, and Graphs Buttons, Bar Gauges, and Graphs This section defines and provides examples of the various Buttons, Bars and Graphs that can appear in a GIB view. Non-Attributes are features used to present information in a GIB view. Non-attribute fields are represented by generic icons that either do not display an attribute or display more than one attribute for comparison. Some non-attribute fields, such as buttons, link the current GIB view to other views. Button Options Button options are described below. Button, Alarms for the Model Creates a button for opening an Alarm View. This Alarm View has filters set so that alarms only display for the current model. You can change the button name. Button, Attribute Values Sensitive New Generic View This button opens a new generic view if a selected attribute contains one of the specified values. You must specify the attribute ID and attribute value(s) in the dialog box. For example, this button can be used for a single model type representing one or more device versions using different attributes. Create a button with the version number as the sensitive attribute and specify an attribute value or version number to open the new window. If the device does not contain that version number, the buton will be grayed out and no window will be opened. This button becomes sensitive and opens the new generic view of your choice if the model you are looking at has one of the specified attribute values. Customization Page 85 GIB Editor User s Guide

86 Buttons, Bar Gauges, and Graphs In order to create this button, you must specify the attribute ID and attribute value(s) in the dialog box. In addition, the absolute path and filename for the GIB file should be specified in the Next GIB Name field. Suppose a new version of a device contained new information that you wanted to present in a view. You could create a button for the model type that had as its sensitive attribute, the device version number and as its new view, a GIB file that displayed the new information. If a given model of that type had one of the version numbers defined for the button, the button itself would be sensitized and would open the new generic view when pressed. If the device did not have one of the version numbers, the button would be grayed out. Button, Events for the Model This button accesses an Event Log View, which filters events for the current model only. You can display manual log entries, and name this button. Button, External Application Creates a button that starts execution of an external application and saves the administrator from switching back and forth between views. The application selected executes as a separate process. To create and activate the button: 1 create a model. 2 Right click and select a view, such as Device Performance view. 3 Enter Edit mode. Ensure these fields agree -showsplash False and -showservers False are required parameters in this field 4 Select Edit> New Non-Attribute field and highlight the Button, External Application option. The following dialog box appears (Figure 40): 5 Complete the fields making sure the Field Label and External View Type Name agree. 6 Enter -showsplash False and -showservers False in the Optional Command Line Parameters box. Customization Page 86 GIB Editor User s Guide

87 Buttons, Bar Gauges, and Graphs 7 Click OK to brigng back the view with the new button placed on it. Move the button to the desired position and click Save. The button will now activate the required process to display the desired view. Figure 40: Button, External Application Button, External Application Field X Position Field Y Position Field Mode SpectroSERVER Attribute Enumerations Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width External View Type Name Optional Command Line Parameters EVENT EVENT -showsplash Fal These terms need to agree OK Cancel Button, Launch Application from SPMA map This button starts a SPECTRUM Portable Management Application. In the dialog box, you specify the Application Model Type and the SPMA Map Menu Name. These can be found in the CsSPMAMAP file in the Spectrum/ SPMAL directory. For example, a typical line in this file reads: Customization Page 87 GIB Editor User s Guide

88 Buttons, Bar Gauges, and Graphs mtype= Hub_CSI_IRBM menuname= Bridge View command= /usr/ Spectrum/SPMA/bin/Spma_Env_Setup /usr/spectrum bridge {ip} {read} {write} & In this example, Hub_CSI_IRBM is the Application Model Type, and Bridge View is the SPMA Map Menu Name. Button, Launch a Script Creates a button that starts execution of a script. In the dialog box you specify the Script file. Scripts are placed in the CsScript directory. To locate your CsScript directory, examine the scriptpath resource entered in your $SPECROOT/app-defaults/spectrum file. Refer to Defining SPECTRUM Resources for more information on resources. If another path is used, it must be specified with the Script file. Button, Launch a Script w/parameters Starts a script from any executable in the $SPECROOT/SG-Support/ CsScript directory. The script name and parameters are entered into the Script field of the New Non-Attribute dialog box. The name and parameters are broken into tokens by using the space character (" ") as a separator. The tokens are then replaced with attribute values or meta parameters, indicating some specific meaning when invoking a script. If the token attribute value starts with 0x, the GIB Editor fills in the attribute s value when the script is invoked. If the token attribute value is not listed in Table 3, a string is returned to the script. Table 3 shows a list of meta parameters and descriptions. Table 3: Meta Parameters Used in Invoking a Script Command %mh %mth %vnm %vnmport Description Model handle Model type handle VNM name for this model VNM socket Customization Page 88 GIB Editor User s Guide

89 Buttons, Bar Gauges, and Graphs Bar Gauges Table 3: %ui %uiport Meta Parameters Used in Invoking a Script Name of the machine on which the SpectroGRAPH is running Port on which the SpectroGRAPH is listening When the script dialog box appears, enter the meta parameter, attribute id, or other information to be sent to the script. Button, New Generic View Creates a button for replacing the current view with another GIB view. You specify the absolute path and filename for the GIB file for the new view when creating or modifying this field. Button, New Window Generic View Creates a button that opens another window for a GIB view in addition to the currently open windows. You specify the absolute path and filename for the GIB file for the new view when creating or modifying this field. Caution: Avoid using the DefaultGIB.30 filename for a new GIB file. Any GIB fields defined in the new view are entered into this default GIB file. If you create another View Button, you cannot use the previously named DefaultGIB.30 without corrupting the view. Button, Ping Device Creates a button that allows you to ping any device on the server. Button, Secure New Window Generic View Creates a button similar to the Generic New Window View Button; the new window is only accessible by users with admin and edit privileges. Bar Gauges Multi-Attribute Bar Gauges can present several attribute values on the same bar gauge. To create a multi-attribute bar gauge, select Gauge, Customization Page 89 GIB Editor User s Guide

90 Buttons, Bar Gauges, and Graphs Horizontal Bar, Multi-attribute or Gauge, Horizontal Bar, Multiattribute Delta from the New Non-attribute Field option of the Edit menu. A unique maximum unit range and eight-character unit label can be specified for either bar gauge option. Units are specified by the attribute selected: numbers, seconds, packets, etc. Attributes can be presented in the multi-attribute bar gauge. This dialog box is similar to the Multi-Attribute dialog box, shown in Figure 41. Figure 41: Gauge, Horizontal Bar, Multi-attribute Dialog Box Enter field definitions in the dialog boxes. Gauge, Horizontal Bar, Multi-Attribute Field X Position Select the Extra Attributes button to open the Attribute Selections dialog box (Figure 45). After selecting and describing attributes, click OK Field Y Position Field Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Graph Width Extra Attributes OK Enumerations Cancel Select the desired attributes and click OK. Another dialog box, entitled Describe Attributes, defines the presentation for each attribute selected. Figure 42 shows the dialog box, and its fields. Customization Page 90 GIB Editor User s Guide

91 Buttons, Bar Gauges, and Graphs The size of this dialog box varies according to the number of attributes selected. These five fields are repeated for each attribute selected. Enter attribute definitions directly into the dialog box Figure 42: Describe Attributes Dialog Box Describe Attributes Attribute ID Enumerations Attribute Name Maximum Value Name/Units Bar Color Attribute ID Enumerations Attribute Name Maximum Value Name/Units Bar Color OK Cancel Maximum Value Enter the maximum value to appear at the end of the bar gauge. Units Enter the unit-type label that will appear with each bar (seconds, number count, packets, etc., depending on attribute function). Gauge, Horizontal Bar, Multi-Attribute A Multi-Attribute Horizontal Bar Gauge is used to present up to ten attribute values in a bar-graph format, as seen in Figure 43. The rate is measured in seconds. Figure 43: Multi-Attribute Horizontal Bar Gauge Example Errors 5000 Rec Frms Customization Page 91 GIB Editor User s Guide

92 Buttons, Bar Gauges, and Graphs Graphs Gauge, Horizontal Bar, Multi-Attribute Delta This is a horizontal bar gauge that presents the difference between the previously polled value and the current value of up to ten attributes. Delta is the difference measured in seconds. For example, if the last polling value is ten and the current value is fifteen, Delta is five, while the rate for this poll is one. Graphs Graphs are used to display one or more attribute values on the same graph. Three dialog boxes are used to define multi-attribute graphs, and are described below. Graph, Multi Attribute Dialog Boxes The Graph, Multi Attribute dialog box, which appears when you select either option, defines the characteristics of the graph and is shown in Figure 44. Figure 44: Graph, Multi-Attribute Dialog Box Enter overall field definitions directly into the dialog box fields. Select the Extra Attributes button to open the Attribute Selections dialog box (Figure 45). After selecting and describing attributes, click OK Graph, Multi-Attribute Field X Position Field Y Position Field Mode Attribute ID Enumerations Field Label Field Font Primary Colorscheme Text Color Index Override Graph Width Maximum Value Scale Distance Between Markers Extra Attributes OK Cancel Customization Page 92 GIB Editor User s Guide

93 Buttons, Bar Gauges, and Graphs Graph Width Sets the width for the graph portion of the multi-attribute graph field. Maximum Value The limit for the highest attribute value displayed on the graph. When the actual attribute value exceeds the Maximum Value, it is plotted at the maximum value. When the value remains higher than the maximum over time, the value is plotted as a straight horizontal line at the top of the graph. Scale Sets the Y-axis scale divisions shown for the graph. Multi-attribute graphs do not auto-scale. Distance between markers Defines the distance between markers in pixels. Enter a larger number to spread the graph out or a smaller number to reduce the size of the graph. Extra Attributes Accesses the Attribute Selections dialog box, in which you can set the number (between one and ten) of attributes that will appear on a single Multi-Attribute Graph. Note: Six or more attributes may diminish ease of interpretation. The Alternate Attribute feature can be used to clarify multiple attributes. Alternate Attributes are defined in the Describe Attributes dialog box that appears after you select attributes from the Attribute Selections Dialog Box, described below. Attribute Selections Dialog Box The Attribute Selection dialog box lists attributes that can be presented in the multi-attribute graph and is shown in Figure 45. Customization Page 93 GIB Editor User s Guide

94 Buttons, Bar Gauges, and Graphs Figure 45: Attribute Selection Dialog Box Attribute Selections Select the attributes to be displayed by the multi-attribute graph. After selecting attributes, click OK to confirm your choices and open the Describe Attributes dialog box. Click Cancel to return to the previous dialog box. Activation_Status AutoMap AutoPlace AutoPlaceOffsetX AutoPlaceOffsetY AutoPlaceRowOffsetX AutoPlaceRowOffsetY AutoPlaceStartX AutoPlaceStartY Child_Count Composite_Condition Condition Condition_Value Selected Item Count OK 2 Cancel Describes Attributes Dialog Box The Describe Attributes dialog box is similar for both graph options, and defines the attribute ID, label, and graph line/text color for each attribute selected. Figure 46 shows the dialog box and fields. Customization Page 94 GIB Editor User s Guide

95 Buttons, Bar Gauges, and Graphs The size of this dialog box varies according to the number of attributes selected. These five fields are repeated for each attribute. Figure 46: Describe Attributes Dialog Box Describe Attributes Attribute ID Label Index Color Scale Factor Alternate Attr Attribute ID Label Index Color Enter attribute definitions directly into the dialog box fields. Select the Index Color button to open the Color Selection dialog box. OK Scale Factor Alternate Attr Attribute ID Label Index Color Scale Factor Alternate Attr Cancel Scale Factor Enter this attribute s scale information. Each attribute may be scaled differently. Alternate Attr (Label Attr) You can create a button with this field, allowing you to access attribute information without making the graph too complex. Enter the following: Label Attribute ID. Example: You want to differentiate Soft Errors from Hard Errors. Enter Errors as the label name. For Alternate Attr, enter: Hard_Errors 0xA Soft_Errors 0xB Customization Page 95 GIB Editor User s Guide

96 Buttons, Bar Gauges, and Graphs where: 0xA = Hard Errors attribute ID 0xB = Soft Errors attribute ID. Tip: To find Attribute IDs, check the Attribute Browser and record the Attribute IDs for future reference. In the finished graph, an error line and an option button appear, allowing you to chose which hard or soft errors to display. An example of a Multi- Attribute Graph displaying rate percentages is shown below. Multi-Attribute Graph Tue Sep 3 11:54:09: Log % Transmitted Now Average Peak at at 0:20:0 0:15: % Discarded Graph Properties Scroll To Date-Time at at Soft Errors Graph, Multi-Attribute Alternate Attribute field This option allows you to display up to ten attributes simultaneously in a Multi-Attribute graph. If you try to exceed ten attributes, you will see the following error message: At Maximum Selection Count, Selection Ignored This graph also allows you to specify alternate attributes to display instead of primary attributes. The graph is updated during each poll and can be accessed from Performance and Configuration views. Figure 47 Customization Page 96 GIB Editor User s Guide

97 Buttons, Bar Gauges, and Graphs shows a Performance view and rate graph with inbound/outbound packet rates for IP Routing. Figure 47: Multi-Attribute Graph with IP Routing Statistics File View IP Routing of type CtIP2App of Landscape Nestea: Primary Help Administrative Status Enabled Operational Status Enabled Version Administrative Reset Reset Operational Time 76+14:27:17 IP Address Log Total Average Peak Value % Discarded at Mo Day 00:00: %Error %Filtered % Forwarded % Host Bound *In Packet Rate p/s at at at at at Mo Day 00:00:00 Mo Day 00:00:00 Mo Day 00:00:00 Mo Day 00:00:00 Mo Day 00:00:00 0:40:0 0:30:0 0:20:0 0:10:0 Detail *Out Packet Rate p/s *Total Packet Rate p/s % Transmitted at Mo Day 00:00:00 at Mo Day 00:00:00 at Mo Day 00:00:00 * Graph x 1000 Scroll to Date-Time Graph, Multi-Attribute Rate This option allows you to scale those attributes which will appear in a Multi-Attribute graph. The Describes dialog box allows you to specify a scale factor for each attribute chosen. If you try to exceed ten attributes, you will see the following error message: At Maximum Selection Count, Selection Ignored Time/Date, Formatted Allows you to create a field that displays the time and date, as seen in Figure 48. In the Time/Date Formatted dialog box, you enter the format. The default is %a %b %e %H:%M:%S %Z %Y, where %a = day of the week, %b Customization Page 97 GIB Editor User s Guide

98 Buttons, Bar Gauges, and Graphs Instance IDs and = month, %e = date, %H = hour, %M = minutes, %S = seconds, %Z = time standard, %Y = year. You may reorganize these variables to the desired format. Figure 48: Formatted Time/Date Example Field Label Wed Aug 16 16:11:17 EDT 1995 Instance IDs and Related Models Other options listed in the New Non-Attribute list are described below. For more information on Object ID s, refer to the Instance Identifiers section of the SpectroWATCH Operator s Guide. Help File This field creates a scrolled text box with SPECTRUM help messages that relates to the model being displayed, as seen in Figure 49. When creating this field, you must specify the file to be opened. Help files must be placed in the CsHelp directory, unless another complete path name is entered when you create the field. You can locate the CsHelp directory by examining the helppath resource entered in your $SPECROOT/app-defaults/spectrum file. Refer to the Defining SPECTRUM Resources publication for more information on resources. The default path name is Default Path/file. Figure 49: Help File Example Help File Any information you would like to enter into the help file. Customization Page 98 GIB Editor User s Guide

99 Buttons, Bar Gauges, and Graphs Instance ID Area Node Address Portion Displays the Instance ID associated with the current view as the area node address. Instance ID, Displayed in Decimal Creates a field that displays the Instance ID (the number of the board or port) associated with the current view as a decimal value in a field. This field could be used to identify information within a GIB View as associated with a particular board or port when a device has multiple boards or multiple ports. Instance ID Enumeration Portion Displays the Instance ID associated with the current view as an enumerated pair. Instance ID IP Address Portion Displays the Instance ID associated with the current view as an IP address portion. Instance ID Integer Portion Displays the Instance ID associated with the current view as an integer portion. Instance ID, Displayed in Hex Creates a field that displays the Instance ID associated with the current view as a hexadecimal value. Instance ID, for Table Insert Creates a field where the user can specify which instance (board or port) an attribute is to apply to. For example, if you have a table attribute displayed in a GIB view for a device, the field will be red-boxed because SPECTRUM cannot determine which instance should be used. By creating an Instance ID for Table Insert for that attribute, the user can specify which board/port the attribute is to be read from, and the attribute will show up without the red box. In the dialog box, specify the attribute that the instance ID is to be applied to. Customization Page 99 GIB Editor User s Guide

100 Buttons, Bar Gauges, and Graphs Label Creates a field for you to enter a text label with no additional features. List, Polled/Logged Attributes Creates a list of the attributes currently being polled or logged by the SpectroSERVER. In the dialog box, select polled or logged attributes as being represented. Figure 50 illustrates an example. Figure 50: Polled/Logged Attributes List Example LOGGED SoftErrorRate 1001b Contact_Status List, Related Models Creates a list of models that are related to the model for this GIB view (Figure 51). The list includes all models at the same level in the hierarchy. It also includes those models one level above and below that satisfy the relation specified as the association type when the field is created or modified. Customization Page 100 GIB Editor User s Guide

101 Buttons, Bar Gauges, and Graphs Figure 51: Related Models List Example Model 1 Model 2 Model 3 Collects Selected Relation OK Cancel Two buttons appear in the Related Models List. Selecting the OK button (or double-clicking on an entry) opens another GIB view for a model selected from the list, provided a Next GIB View was specified when the field was created. Cancel de-selects a model that has been selected on the list. See Related Models List Modification and Related Models List Creation for more information. List, Related Models for the Model Component Creates a list of instances of models that are related to the model for this GIB view, as seen in Figure 52. The list includes all instances at the same level in the hierarchy and one level above and below this model that satisfy the relation specified as the association type when the field is created or modified. A common use for this panel is in showing the ports or boards that have HASPART relations to a device. Customization Page 101 GIB Editor User s Guide

102 Buttons, Bar Gauges, and Graphs Figure 52: Related Models for Model Component List Example HASPART Port 1 Port 2 Selected Relation Port 3 Instance OK Cancel Two buttons appear in the List. Selecting the OK button (or doubleclicking on an entry) opens another GIB view for a model selected from the list, if the Next GIB View was specified when the field was created. Cancel deselects a model that has been selected on the list. See Related Models List Creation and Related Models List Modification for more information. List, Related Models With Attributes Displays a list of instances of models that are related to the model for this GIB view and other information about these instances that you choose. The dialog box fields are the same as in the Related Models List except for: Table Label The label displayed at the top of the list. Attribute IDs Displays additional list information other than the relation attribute. A list of Attribute IDs displays in the Model Attributes section of the Attribute Browser. Base Indicates whether the data to be displayed is in hex (base = 16) or decimal (base= 10). Customization Page 102 GIB Editor User s Guide

103 Buttons, Bar Gauges, and Graphs Octet Separator Indicates how the octets in the display will be presented. You may choose a colon or other symbol. A dot is the default. List Height Indicates the number of table entries that will be displayed in the table at one time. Related Models List Creation To create a Related Models List on a GIB view: 1 Bring up any GIB view of the selected model (for example, Configuration View). 2 Enter the Edit mode by selecting Edit from the File menu. 3 From the Edit menu, select New Non-Attribute Field. 4 Scroll to and select List, Related Models and click OK. 5 Set the Field Value Width parameter to a desired width. 6 Click in the Next GIB Name field and enter the path and name of the CsGIB file that will display when the OK button is clicked or an entry is double-clicked. The default path is the CsGib directory, and the default file is CsRelWalk Double-click Association type to open the Select Relation dialog box. 8 Select the relation option desired and click on OK. 9 Click on the Relation side field, and enter LEFT or RIGHT. Relations have sides. For example, in the Building CONTAINS Room relation, Building is the left side and Room is the right side. If you select RIGHT, all related objects to the right will be displayed in the panel. See the Model Type Editor User s Guide and the MIB for the particular device for more information on the specific relation being displayed. 10 Click OK in the List, Related Models dialog box. Customization Page 103 GIB Editor User s Guide

104 Buttons, Bar Gauges, and Graphs 11 Once created, save it to the GIB view by selecting Close Edit from the File menu. Related Models List Modification To modify the size of a Related Models List on a GIB view: 1 Open one of your model s GIB views, such as the Configuration View, which contains the Related Models List icon. 2 From the File menu, select Edit. 3 Click in the GIB s model list; it becomes highlighted. 4 Select Modify Field from the Edit menu. 5 Adjust the Field Value Width parameter to a desired width and click OK. 6 Save the changes to the GIB view by selecting Close Edit from the File menu. Model Icon Creates a model icon that appears in a scroll box, as seen in Figure 53. After selecting Model Icon, a dialog box appears and you must enter the perspective information (pib) file for the model icon. You can now map the icons to model types in the database. Mapping is a function of the pib files, and defines the icon that represent model types in each view. Pib files are found in the SG-Support/CsPib directory. Figure 53: Model Icon Example Field Label Customization Page 104 GIB Editor User s Guide

105 Pie Charts Pie Charts This section describes options for displaying information in pie-chart format in a GIB view. Dialog boxes unique to some options are described, and pie chart examples are provided. You can use a pie chart to compare attributes of an unlimited number of models possessing some relationship to the GIB view model. For information on attribute-type pie charts (which are based on two or more attributes), refer to Attribute Fields, under Attribute Pie Chart Options. Nonattribute pie chart fields that are not based on attributes, such as buttons, are described in this section. Pie Charts If you want to compare two or more fields based on one attribute, you should use the New Attribute Field option. Other fields, like buttons, that are not based on attributes, are created using the New Non- Attribute Field option. The dialog box fields for attribute and nonattribute pie charts are similar. These dialog boxes are described below, followed by a description of the non-attribute pie chart options. Pie Chart Dialog Boxes Two types of Select Relation dialog boxes are used to define pie charts. The first defines overall characteristics of the pie chart. The second allows you to select the model relationship for this pie chart. Refer to Figure 54 and Figure 55 respectively. Customization Page 105 GIB Editor User s Guide

106 Pie Charts Figure 54: Relation Pie Chart Dialog Box Enter field definitions into the dialog box fields. Pie Chart, Related Models Using Instance ID with Total, Delta, and Accum Field X position Field Y position Enter the Attribute ID to identify each model. Field Mode Attribute Field Label LABEL Enumerations Field Font Unused Color IVORY Text Color Index Override Pie Chart Width Pie Chart Height Pie Drawing Size Select the Association Type button to open the Select Relation dialog box. Field Length Pie Primary Color Orientation Mode Attribute ID Field Colors Association Type OK Cancel Figure 55: Select Relation Dialog Box Select Relation Select a relation for models represented by the pie chart. After selecting the relation, Click OK to confirm your choice or Cancel to return to the previous dialog box. OK Relation Options ACMS_Controls ACSPM_Attach Application Attach BvDiscover BvLostFound BvSecures Can_Assign Collects Cancel Customization Page 106 GIB Editor User s Guide

107 Pie Charts Pie Chart Width Set the width in pixels for the pie chart field. Pie Chart Height Enter the height in pixels for the pie chart field. Pie Drawing Size Enter the size of the pie. Field Length Enter the character string length for the attribute value. A long Field Length value widens the Pie Chart Width. Pie Primary Color Enter the background color for this pie chart field. Orientation Mode Enter information used to center the pie chart in VERTICAL position or in HORIZONTAL position. Attribute ID Enter the common attribute to all related models that will be displayed in the pie chart. To display the list of attribute IDs, select New Attribute Field from the Edit menu of GIB views for the related models. Select the Show Attribute IDs button in the Controls Panel. The Model Attributes list shows the selected model and attribute ID. The attribute ID can then be noted and used in the Pie Chart dialog box. Attribute Pie Chart Options You can create an attribute pie chart that will show a comparison of two or more values of the same attribute types. Beginning with Version 6.0, support has been added for attribute type Real and 64-Bit Integer. The attribute types are: Integers Gauges Counters Customization Page 107 GIB Editor User s Guide

108 Pie Charts The pie chart options that appear in the New Attribute list are described below. Pie Chart, Delta, Labeled on Bottom This pie chart option can be used to compare up to five attributes, but instead of showing the difference between each attribute s current value and its previous value, it incorporates two buttons that determine how the attribute group values are presented. Refer to Figure 56 for more information. Each button allows you to select one of two options: Clear/ Totals or Count/Percent. If Total is selected, the group values represent the current attribute values. If the values were previously cleared, this selection restores the values to the actual attribute value retrieved by the last poll. If Clear is selected, the current group values are subtracted from the value obtained by the next poll and all subsequent polls until Clear is selected again or until Total is selected. Selecting Clear temporarily resets the values displayed to zero. When counter type attributes are displayed, the Clear button gives the appearance of resetting the counter, but the device s counters are not actually reset. Note: The Clear field is most often used for attributes that represent counters in a device. When the Clear function is used, it is possible to produce a delta value that is negative (when the attributes selected are not counters or when the counters roll over to zero). When this happens, the pie and the numeric values are set to the most recent positive poll value. If Count is selected, group values are presented as absolute values. If Percent is selected, group values are presented as a percentage of the sum of the group values. Percentages are accurate to two decimal places and may appear to differ slightly from their corresponding pie slices. As with the other pie charts, each slice of the pie chart is identified as a group when this field is created, and the value of the group is the sum of the individual attribute values within the group. The colors used to Customization Page 108 GIB Editor User s Guide

109 Pie Charts differentiate the sections of the pie are selectable at the time the field is created or modified. This chart is updated with each poll of the SpectroSERVER database. Figure 56: Pie Chart, Delta, Labeled on Bottom Names and values of attributes being compared. Current values will vary depending on mode selected. Background colors match pie chart sections. Field Label Attribute 1: value Attribute 2: value Attribute 3: value Mode selection buttons. Clear Total Count Percent PieChart,Delta,LabeledonLeft This pie chart compares attribute values taken from the Attribute Selections list (accessed when you click the dialog box s Extra Attributes button.) The values represent the difference between each attribute s current value and its previous value (retrieved during an earlier poll). The attributes are assigned to groups when the field is created or modified. A Clear button allows you to set the counters to zero for each of the selected attribute groups. An example of a pie chart, labeled on left, is provided in Figure 57. Customization Page 109 GIB Editor User s Guide

110 Pie Charts Figure 57: Pie Chart, Delta, Labeled on Left Names and values of attributes being compared. Background colors match pie chart sections. Attribute 1: Attribute 2: Attribute 3: Clear Field Label value value value Each slice of the pie represents a group of one or more attributes. Attributes are selected and assigned to a group when this field is created. The pie slice value represents the sum of the individual attribute values assigned to that group. The list of groups that appear with the pie chart shows the absolute value for each group. Each slice of the pie represents the group value as a percentage of value for the total pie. The colors used to differentiate the sections of the pie are selectable at the time the field is created or modified. This chart is updated with each poll of the SpectroSERVER database. Customization Page 110 GIB Editor User s Guide

111 Pie Charts Chart sections comparing model (board) values Figure 58: Pie Chart Showing Percentages Ethernet Packet Rates Values compared Background colors match chart sections CRCs (group 1) :75 Errors (group 2) :10 OOWs (group 3) :15 Total percent or numeric value of pie are made with mode selection buttons Current values will vary depending on mode selected Clear Total Count Percent In this example, the three Ethernet packet rate statistics are compared. Each slice of the pie chart represents a different packet rate type, and reflect the percentage of the whole. You can also show the total count of each statistic. The pie slices compare each value relative to each other and the total. The relationship and attributes are selected when this field is created. The number of models related to the GIB view model may vary and are not specified during creation. Pie Chart, Total Delta Accum This Pie Chart option allows you to compare an unlimited number of attributes that are in a relation to each other and to the sum of their values. For example, the Pie Chart shown below shows the percentage values of three statistics. Figure 59 shows a comparison of three different attributes. Customization Page 111 GIB Editor User s Guide

112 Pie Charts Figure 59: Pie Chart with a Comparison of Attributes Field Label Current values (will vary depending on mode selected) Attribute 1 value 0.00 % Percent of total pie Attribute 2 Attribute 3 Total value value value 0.00 % 0.00 % Mode selection buttons Total Delta Accum Clear The models presented are determined by the relation selected when the field is created or modified. The colors used to differentiate the sections of the pie are selected at the time the field is created or modified. This chart is updated with each poll of the database. GIB Views poll the database differently from the SpectroSERVER, usually at 10 second intervals. The field labels that appear with the pie chart show the current (total) attribute values, the Delta value, the accumulated attribute values (accumulated from the time the Accum button is clicked), and a Clear button. When Total is selected, this pie chart provides the current attribute values for each of the related models and each model s contribution (percentage) to the total of values. When Delta is selected, this pie chart can be used to compare the difference between the previously polled value and the current value of an Customization Page 112 GIB Editor User s Guide

113 Pie Charts attribute. These values are taken from several models, and shows each model s contribution (percentage) to the total of the delta values. When Accum is selected, this pie chart provides the accumulated attribute values for all related models since the Accum button was clicked, and each model s contribution (percentage) to the total accumulation of values. To restart the counter, click on the Clear button. The values continue to accumulate until you clear, or another presentation mode is chosen. Non-Attribute Pie Chart Options To use the New Non-Attribute Field option, you must select an attribute that is common to all related models. Choose the relation that applies to the models and the attribute to be displayed. Pie Chart, Related Models Using Instance ID, with Total, Delta and Accum This option is used when the related models are components of the GIB view device. For example, a hub GIB view can be used to show an attribute of all the boards in the hub. The attribute selected must be a type that requires an instance ID, and it must be an attribute selected from the related models, not the current GIB view model. Attributes that require an instance ID are table type attributes. When determining the attribute ID from the New Attribute Field window of the related models, check the Attribute Flags panel to confirm Table is highlighted. HASPART is the relation used in this pie chart. Example: In the Performance View of a hub, select the Edit menu option Pie Chart, Related Models using Instance ID, with Total, Delta, Accum. This shows the attribute total frame errors for each board in the hub. Customization Page 113 GIB Editor User s Guide

114 Pie Charts Pie Chart, Related Models, with Total, Delta and Accum This Pie Chart option allows you to compare an unlimited number of attributes that are in a relation to each other and to the sum of their values. Example: In the Information View of an LAN, select the Edit menu option Pie Chart, Related Models, with Total, Delta, Accum, which show the attribute total frame errors for all models it Collects. Figure 60 shows a pie chart that compares the values of three attribute groups. Figure 60: Finished Pie Chart Chart sections comparing attribute (or group) values Hub_Total_Collisions Names and values for attributes or groups being compared. Background colors match chart sections Hub_Trans_Coll Hub_Rec_Coll % % Hub Transmit Collisions = Attribute 1 Hub Receive Collisions = Attribute 2 Hub Out of Window Collisions = Attribute 3 Hub_OOW_Coll Total Total 2 10 Delta % Accum Clear In this example, the fields, Hub_Trans_Coll, Hub_Rec_Coll, and Hub_OOW_Coll are shown as slices of pie, and their respective values are added together to make Total. Each slice of the pie chart represents a group of one or more attributes, selected and assigned to a group when Customization Page 114 GIB Editor User s Guide

115 Pie Charts the field is created. The value of the group equals the sum of the attribute values contained in that group. The list of groups that appears with the pie chart shows the absolute value for each group. Each slice of the pie represents the group value as a percentage of value for the total pie. The colors used to differentiate the sections of the pie are selectable at the time the field is created or modified. This chart is updated with each GIB view poll of the database. GIB view polls are different than SpectroSERVER polls and usually occur every 10 seconds. In this pie chart, you can select the presentation mode of the data. Clicking on Total presents the current attribute values. Clicking on Delta presents the difference between the current values and the last polled values. The pie chart and the column of percentage values display each attribute s contribution to the total difference. Clicking on Accum presents an accumulation of the attributes from the time the button is clicked. This accumulation continues to accrue until the Clear button is clicked, or another presentation mode is selected. Chapter 61 Customization Page 115 GIB Editor User s Guide

116 Tables Tables Tables This section shows you how to create tables and Table Information Block (Tib) files with the GIB Editor. Tables A table s format shows a number of columns, column headings, and selected attributes. The table parameters are defined in a special GIB file called a Table Information Block (Tib), each identified by a.gtb filename extension. Five types of tables can be created in GIB views: Basic Table Nested Table Nested for an Instance Sorted Table Sorted and Nested Each of the tables listed above is described in this section. Basic Table A basic table displays a collection of attribute values arranged in columns. You can create a basic table that will display all attributes for all board ports on a device. Beginning with Version 6.0, support has been added for attribute types Real and 64-Bit Integer. Each port appears as an entry in the table and each entry in the table represents an instance ID. Nested Table A Nested Table field supports attributes that are lists within lists (e.g., port attributes within boards). The table s format is defined in the table file, and appears in a separate view. For more information on table file extensions, refer to Table 2. The view containing the nested table is Customization Page 116 GIB Editor User s Guide

117 Tables accessed through specific entries in a table or nested table. When an entry is selected, a GIB view containing the Nested Table is opened. The characteristics of the nested table (such as the number of columns, column headings, and selected attributes) are defined in a TIB file with.gnt filename extension. You must specify the Table Information Block in the dialog box at creation. For example, suppose your modeled device contains several boards, and you only want to show the ports for Board Four. After creating a nested table, set the view s instance ID field to four; the table shows entries for only those ports belonging to Board Four. Nested for an Instance Table A table nested for an instance displays attributes of a specific instance. For example, the port attributes of a single board are displayed rather than the port attributes of all boards (as a nested table shows). Characteristics of the nested for an instance table (such as the number of columns, column headings, and selected attribute) are defined in a TIB file with.xnt filename extension. The dialog creation box is similar to that for the nested table. Sorted Table and Sorted Nested Table The Sorted Table is similar to the Basic Table but shows one to four buttons. The Nested Table is similar to the Sorted Nested Table, but also shows these buttons. They allow you to sort entries, find specific strings, update the values in the table, or print the table to a file or designated printer. Characteristics for the Table and Nested Table tables are defined in TIB files with.gts and.gsn filename extensions, respectively. The buttons perform the following functions when used on.gts files: Sort Appears whenever a column heading is selected. The Sort button can be used to sort the table (in ascending order) using the selected column as a sort key. Customization Page 117 GIB Editor User s Guide

118 Tables Find Allows you to select a column heading then enter a hex string that is used in a search of the table. This button does not appear if the selected column contains entries that cannot logically be the object of a search. Update Allows you to refresh the table contents. The values in the table do not update dynamically and represent values retrieved when the table was opened. Print Allows you to print a table to an identified printer or a file. When you select any of these table options, a table dialog box appears. The unique table dialog box fields that may appear are described below. Table Information Block Shows the name of the TIB file that defines your table. See Creating Table Fields in a GIB View for more information. File Attribute ID Shows the filename value which contains the instance IDs the table retrieves. Count Attribute ID Shows the total count of retrievable entries. Update Interval Attribute ID Determines the updating method. If the attribute value is 0, updates are done manually. If it is 1, the updates are done automatically with every GIB view poll. If changes are made and you want to return this attribute to its original value, go into edit mode, double-click on the table, and re-enter the attribute value ID information again. Save and close this edit session, and the correct attribute information appears in the table. Customization Page 118 GIB Editor User s Guide

119 Tables Creating Table Fields in a GIB View Note: The Find, Sort, Update, and Print buttons do not appear in all tables. Each button appears in a table in which the button s function is necessary. Note: In.GTb file GIBs, the length of the Table Title field string may negate the Print function because the limited size of the GIB only allows a certain number of characters or pixels to be included in the Table Title field. The Table Title field string has priority over the print function because of the necessary external interfaces of various applications used in SPECTRUM. Creating Table Fields in a GIB View Tables in a GIB view are created using both the GIB Editor and a Windows NT or UNIX text editor. At least two procedures must be used for each table being added to a GIB view: 1 Create a GIB file for the new table using a text editor. 2 Use the GIB Editor to add the table to an existing GIB view or create a new GIB view for your new table. If you are creating a nested table, these two procedures must be repeated for each nested table. The following sections detail table creation. Creating GIB Files to Define Table Fields Files that define the content of tables are special GIB files called Table Information Blocks or Tibs with unique filename extensions that describe the type of table being created. The five types of tables and their associated filename extensions are listed in the table below. Customization Page 119 GIB Editor User s Guide

120 Tables Table 4: Table Field Definitions Table Table Type Nested Table Nested for an Instance Sorted Table Sorted & Nested Table Tib File Extension.GTb.GNT.XNT.GTS.GSN TIB files can be created as a separate process, without terminating SpectroSERVER or SpectroGRAPH. They are created and edited using a text editor. All GIB files, including TIBs, are located in subdirectories in a directory called CsGib. Within the CsGib directory, the subdirectories containing GIB files are organized according to model type. Table files are placed in the same subdirectory with other GIB files for the applicable model type. To find out where the CsGib directory is in your system, examine the gibpath resource entered either in your <Spectrum path>/appdefaults/spectrum file. Refer to Defining SPECTRUM Resources for more information on resources. Figure 11 shows a sample TIB file for a basic table (.GTb). The table that it defines is shown in Figure 12 below it. Each line in a table file defines a column of the table. Attributes whose values are listed in table fields must have their List flag set. Refer to the Model Type Editor User s Guide for more information about the List flag. To Create a Tib File: 1 Create a TIB file (complete with a column definition) for the new table using a text editor. Refer to the Table Column Descriptions for detailed descriptions of column parameters. Customization Page 120 GIB Editor User s Guide

121 Tables Tip: If you know of a table file that defines a similar table, it is often easier to copy and then rename the copy and edit it to serve your needs for this table file. 2 Name the file using the applicable filename extension. Refer to Table 2 for filename extensions. 3 Place the newly created file in the appropriate subdirectory within the CsGib directory. 4 Proceed in accordance with Adding Tables to a GIB View to add the table defined in your Tib file to the GIB view. Table Column Descriptions The format for column definitions in a table file consists of a column icon, specific to the type of attribute being presented in the column, followed by a parenthetical column definition. Double quotes mark the beginning and end of column definition parameters. Commas are delimiters, placed between each column parameter. The format and meaning for the parameters that define columns are: Column Icon (X Position, Y Position, Attribute Handle, Column Heading, Column Color, Text Color, Column Width, Column Length, Filename, Enumeration). An example of a line that may appear in a table extensions file is shown in Figure 62, with a short description of each argument. Customization Page 121 GIB Editor User s Guide

122 Tables Figure 62: Table Column Headings Enumerated Pair Column X, Y Position Column Heading Text Color Column Width Attribute Handle Column Color Column Length ColInt.TEm( 20, 50, 0x1110f, Filter Status, BLUE, 252, 15, 10, Bdg_CSI_CNB25/CsSpecDbGTb.30, 0, Disable, 1, Enable, ) Enumerated Pair, 0 = disable, 1 = enable Path/Filename to open when entry double-clicked Column Icon The first column, which is made up of enumerated pairs, identifies the attribute type and any conversion performed on that value before it is displayed as text in the column. For SPECTRUM to properly use the attribute, the extension of this parameter must be correctly identified to match the MIB attribute type. You determine the extension from the attribute type defined in the MIB. Refer to Appendix B for more information on these table column icons. X Position/Y Position X, Y coordinates that set the position of this column in pixels. The Y coordinate should remain the same value for all columns so that they appear at the same vertical position in the table. Coordinates X=0 and Y=0 define the top left corner of the view. The X coordinate should be increased for each column definition to allow sufficient space for the column attribute and a separation between each column. Tables have scroll bars so there is no limit to the number of table columns you can use. Attribute Handle Defines the attribute handle (attribute ID) for the attribute. SPECTRUM uses the attribute handle to retrieve the required value from the SpectroSERVER. Refer to the Model Type Editor User s Guide on Customization Page 122 GIB Editor User s Guide

123 Tables attribute handles. Use the Attribute Browser to view the attribute handle for each attribute. Column Heading This parameter defines the text string that you want to appear at the top of the column. The maximum length of this text string is defined in another parameter. Enter two consecutive quotations ("") with no spaces between when no column heading is being defined. Column Color This parameter sets the background color of the column. It must be entered using uppercase letters. Any of the following entries can be used for this parameter: GRAY IVORY BORDERBLUE ORANGE BLUE BUFF BRIGHTRED CORAL GOLD CHARCOAL BRIGHTBLUE SILVER Text Color This parameter sets the text override color for the column heading and the values displayed in the column. Note: Each column in the table can be set to a different background and text color. Column Width This parameter sets the maximum number of characters that can be viewed in the column. When the length of the text string being displayed exceeds the column width, a scroll bar appears at the bottom of the column. Customization Page 123 GIB Editor User s Guide

124 Tables Column Length This parameter sets the maximum number of rows that can be viewed in the column. This parameter should be the same value for each of the columns being defined for a table. When the number of rows defined for a column exceeds the number of rows defined for any other column, a vertical scroll bar appears at the side of the shorter column. Filename This parameter is used to define the path and filename (subdirectory/ filename.30 within the CsGib directory) for the GIB file that links this table with the GIB view containing a Nested Table or Sorted Nested Table. The table files that define these tables (.GNT for a Nested Table or.gsn for a Sorted Nested Table) are created using the same procedures as a.gtb file. The nested table is accessed by double-clicking on an entry in a column that has a link to the GIB view containing a Nested Table. If there is no GIB view linked to this column, enter two consecutive quotations ( ) with no spaces between. Double-clicking on an entry with no GIB view link has no effect. Note: All paths and filenames for GIB files are specified relative to the <Spectrum path>/sg-support /CsGib directory. If your files are in another directory, you will need to specify that path. Enumeration This parameter is used with several column icons to define enumerated pairs. This parameter translates an integer attribute value to a text description that corresponds to the condition represented by the attribute value. Table Enumerated Pair - When the column icon is a Table Enumerated Pair (ColInt.TEm), this parameter defines the pairing of specific numeric values and text strings. The text that appears in the column corresponds to the associated attribute value. For example: 0, Disabled; 1, Enabled; 2, Standby If the attribute value is equal to one, the following text appears: Customization Page 124 GIB Editor User s Guide

125 Tables <column heading> Enabled Table Bit - When the column icon is a Table Bit (ColInt.TIB), this parameter defines the pairing of specific bits and text strings. Each bit of the attribute value is paired with a text string. When a bit defined by the parameter is set, the corresponding text appears in the column. When multiple defined bits are set, more than one text descriptor appears in the column separated by a vertical bar. This concept is more easily understood by examining the following example: 0, administrator; 1, logger; 2, monitor If bit 0 and bit 2 are set, the following text appears: <column heading> administrator monitor When the length of the text strings being displayed exceeds the width of the column, a horizontal scroll bar appears for the column to permit viewing the entire column contents. Object ID - When the column icon is ColInt.TObEnum, this parameter defines the pairing of object IDs with text. There are two ways object IDs may be entered as enumerated pairs; as long object IDs as in the first example, or with a short cut for long object IDs where the common prefix for all is specified at the end as in the second example below. The following two entries would be equivalent: 1.3.1, One, 1.3.2, Two, 1.3.3, Three 1, One, 2, Two, 3, Three, 1.3 If the attribute value is 1.3.2, the text that appears in the column is: Customization Page 125 GIB Editor User s Guide

126 Tables <column heading> Two Adding Tables to a GIB View After creating the appropriate TIB file, the table field that it defines can be added to a GIB view using the GIB Editor. Table fields are non-attribute fields and adding a table requires the same steps that are used to create any non-attribute field. However, if you are adding a Nested Table to the GIB view, you must first create a new GIB view where the Nested Table will be located. If necessary, use the GIB Editor to create a new GIB view for the nested table. There are no specific guidelines for this GIB view. Its appearance and content is a matter of the specific network application that it serves. Refer to Creating Views for more information about creating fields in a new GIB view, and then return to this section to add the Nested Table to the view. To add your new table to a GIB view: 1 Open the GIB view where your new table is being located and place the view in Edit mode. 2 Select the New Non-attribute Field option from the Edit menu, then choose the appropriate table type from the NonAttribute Field dialog box that appears. The type selected must match the filename extension that you assigned when you created the TIB file. A table definition dialog box appears, as shown in Figure This dialog box is similar to other dialog boxes. The entry that is specifically related to creating a table field is the TIB. a Enter values for the other parameters as required to define the appearance of the field. Refer to Adding Attribute and Non-Attribute Fields for more information. Customization Page 126 GIB Editor User s Guide

127 Tables b c Enter the filename and extension for the TIB file for this table (see Table 2). If the TIB file is not located in the CsGib directory, include the file path relative to the CsGib directory in your entry. Click OK to save the table, or Cancel to exit without creating a table. Figure 63: Table Definitions Table Field X Position Field Y Position Field Mode LABEL Attribute ID Enumerations Field Label Enter the TIB name and Extension Field Font Primary Colorscheme Text Color Index Override Field Value Width Field Value Height Table Information Block OK Cancel Customization Page 127 GIB Editor User s Guide

128 Tutorial Tutorial This tutorial uses examples to show you how to edit fields, create a menu choice for a new field, and create a graph, buttons pie charts, and tables with the GIB Editor. In order for you to complete this tutorial, you must be familiar with the Model Type Editor and principles for modeling with GenSNMPDev. You should refer to the application s MIB as you complete the exercises. Editing Fields in an Existing View This exercise shows you how to edit fields in existing views. The SmartSwitch 9E133_36 model is used as an example. If you want to change the position, name, font, and color of the Error Source field in the Configuration view, and enlarge the view, follow these steps. 1 Navigate to the Application view for the 9E133_36 model. 2 Select the CsEnetRptr application (Ethernet 1) and click Configuration. This will open the Configuration view for the device. 3 Select Edit from the File menu. You are now in Edit mode. 4 In the Configuration view, click on the Error Source field, which will then become highlighted. Drag the field to where you want it to be located within the view. 5 Select Modify Field from the Edit menu. A definition dialog box appears, as shown in Figure 64. Customization Page 128 GIB Editor User s Guide

129 Tutorial Figure 64: Table Definition Dialog Box RptrAlarmsErrSource-Button Panel, on/off toggles Field X Position Refers the number of options (Bits) turned on in the Error Source Table in the Configuration view Field Y Position Field Mode Read Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width Bit On Values OK Read/write Read Most Current Enumerations 0,CRC,1,Runts Cancel 6 In the Field Label field, shorten the name to Errors from Error Source 7 To change the field fonts, click the Field Font button. In the Font Options dialog box, change the font, weight, slant, and size (Figure 65). Customization Page 129 GIB Editor User s Guide

130 Tutorial Figure 65: Font Options Dialog Box Select a different font, weight, slant, and size to be used for the field label. Preview the selected font. Font Options Font: Weight: Slant: Size: charter clean courier fixed gothic Helvetica bold demibold medium italic oblique roman palatino roman ABCDE abcde Select OK to confirm your choice or Cancel to accept the default font. Font List OK Font Name: Cancel 8 Click on the Primary Colorscheme button and select another color scheme from the Select Color dialog box. Click OK to confirm your choice. Figure 66: Color Scheme Dialog Box Select a different color scheme for the field and field label. Select OK to confirm your choice or Cancel to accept the default color. Color Scheme OK Sample BLUE BRIGHTBLUE BRIGHTRED BUFF CHARCOAL Cancel The Sample bar changes color to match your selections. Customization Page 130 GIB Editor User s Guide

131 Tutorial Accessing New Views 9 Click on the Text Color Index Override button to change text color. After you choose a different text color, and the color appears in the Sample box, click OK. 10 Increase the Field Value Width (to 600) and Field Value Height (to 400), this increases the width and height of the Configuration view. 11 Click OK to confirm your choices, or click Cancel to exit the dialog box without saving your choices. 12 From the File menu, select Close Edit. Your changes will now appear in the Configuration view. To remove the fields you have created, or any other fields, you can follow these steps. 1 From the File menu, select Edit. 2 In Edit mode, select the field you want to remove in the SPECTRUM view. 3 Under Edit, select Erase. A dialog box appears; click OK. The selected field disappears. 4 Under File menu, click Close Edit. Accessing New Views After modifying the previous Configuration view, you can create a new Icon Subviews menu selection from which you can access the view. You can also: use the existing generic view to create a new Performance view create a multi-attribute line graph in the Performance view add a detail button, to access a new Detail view add a pie chart, in the Detail view Refer to the MIB or the Attribute Browser to determine which performance attributes to use for this Performance view. For this tutorial, use the 9E CsEnetRptr statistics. Customization Page 131 GIB Editor User s Guide

132 Tutorial 1 Open the previously edited Configuration view. 2 Click View>Icon Subviews>Utilities>Attribute Browser. This will open the Attribute Browser view for the device. 3 Click Save. 4 Enter a file name and click OK. This will open the Save GIB to Model or Model Type dialog box, as shown in Figure 67. Figure 67: Save GIB to Model or Model Type Dialog Box Each Gib model name entered into the Multi- Text Entry dialog box appears here. The model name entered and saved to the Multi-Text Entry dialog box appears here. Each model type name entered and saved to the Multi- Text Entry dialog box appears here. Delete removes any selected model or model type. Each Gib model type name entered into the Multi- Text Entry dialog box appears here. Click Add MType to enter model, model type, and menu names. Click OK to save all names entered the into Multi-Text Entry dialog box. Save GIB to Model or Model Type GIB for Model GIB for Model Type Menu option for Model Menu option for Model Type OK Cancel Add Model Add MType Delete 5 Click on the Add MType button to open the Multi Text Entry dialog box. Customization Page 132 GIB Editor User s Guide

133 Tutorial 6 Enter the new GIB Name GRAPH, and the GIB Menu Name GRAPH, and click OK. Click on OK in the Save GIB to Model or Model Type dialog box. 7 Close the Attribute Browser. Close the Configuration view, then reopen the Application View. The refreshed view appears. The new Icon Subview GRAPH will appear in the view. Adding a Multi-Attribute Graph In order to display Ethernet repeater packet statistics in graph-format, follow these steps. 1 Open the Application View and highlight the CsEnetRptr icon and select Graph from the Icon Subviews menu. The new GIB view appears. 2 From the File menu, select Edit. 3 Select all view fields by clicking on each successively while holding the Shift key. 4 From the Edit menu, select New Non-attribute Field to open the Non-Attribute Field dialog box. Figure 68: NonAttribute Field Dialog Box Scroll down and select Graph, Multi-attribute Click OK Non-Attribute Field OK Field Type Button, Alarms for the model Button, Events for the model Button, External Application Button, Launch Application from SPMA map Button, Launch a script Button,Launch a script w/parameters Graph, Multi-attribute Cancel Customization Page 133 GIB Editor User s Guide

134 Tutorial 5 If necessary, scroll down to Graph, Multi-Attribute and click on it then click on OK. The Graph, Multi-Attribute dialog box, shown in Figure 69, appears. Figure 69: Multi Attribute Graph Dialog Box Graph, Multi-Attribute Select the Extra Attributes button to open the Attribute Selections dialog box. Field X Position Field Y Position Field Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Graph Width Maximum Value Scale Distance Between Markers Extra Attributes Enumerations OK Cancel 6 Select all the text in the Field Label field and delete. 7 Enter Performance in the Field Label field. 8 Click on the Field Font button and choose the desired font, weight, slant, and size for the text. 9 Click on the Primary Colorscheme button, which opens the Color Scheme dialog box, and choose the desired background and text color (see Figure 66) and click OK. 10 Click on the Extra Attributes button to access the Attribute Selections dialog box. Customization Page 134 GIB Editor User s Guide

135 Tutorial Figure 70: Attribute Selection Dialog Box 1 Select the attributes to be displayed by the multi-attribute graph. 2 After selecting attributes, click OK to confirm your choices and open the Describe Attributes dialog box. AAtest_aatrib Activation_Status Agent_Port AppViewZoomFactor App_View_Mode Apps_Created_State Attr_Number Board_Structure Change_Stamp Child_Count Composite_Condition Condition Condition Value OK Attribute Selections Selected Item Count 2 Cancel 11 Scroll down to the Condition attributes. 12 Select Condition and Condition_Value. The Selected Item Count counter increments by one with each additional selection. 13 Click OK, A Describe Attributes dialog box appears (Figure 71). Customization Page 135 GIB Editor User s Guide

136 Tutorial Figure 71: The size of this dialog box varies according to the number of attributes selected. These five fields are duplicated for each attribute selected; in this case: two. Select the Index Color button to open the Color Selection dialog box. Describe Attributes Dialog Box Describe Attributes Attribute ID Enumerations Label Index Color Scale Factor Alternate Attr Attribute ID Enumerations Label Index Color Scale Factor Alternate Attr OK Cancel 14 Enter Collisions in the Label box for rptrpktstatscolls. 15 Enter Errors in the Label box for rptrpktstatserrors. 16 Click on the Index Color button for each statistic and this opens a Color Selection dialog box. Enter the desired color number. After completing changes in the Describe Attributes dialog box, click OK. 17 Click OK in the Multi Attribute Graph dialog box. The new graph appears. 18 From Edit menu, select Change Background. Change Width to optimal size for your monitor. Click OK. Drag the lower right corner of this view to the maximum width. 19 Exit Edit mode by selecting Close Edit from the File menu and then clicking OK in the dialog box. Customization Page 136 GIB Editor User s Guide

137 Tutorial Adding a Button to Open a New View The following section details how to create a button that when clicked on will open a new view. 1 Open the previously created Performance view and select Edit from the File menu. 2 Select New Non-attribute Field from the Edit menu. The NonAttribute Field dialog box appears. 3 Select Button, New Window Generic View from the Field Type list and then click OK. The Button, New Window Generic View dialog box appears as shown in Figure Delete the Field Label box contents and enter Detail. 5 Click on the Field Font button, which opens the Font Options dialog box as seen in Figure 65, and select the font, weight, slant, and size of the font to be on the button. Figure 72: Button, New Window Generic View Button, New Window Generic View Enter the view filename and extension. Field X Position Field Y Position Field Mode Attribute ID Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width Next GIB Name OK Enumerations Cancel Customization Page 137 GIB Editor User s Guide

138 Tutorial 6 Click OK to make the changes or click Cancel to return to the Button, New Window Generic View dialog box. 7 Click on the Primary Colorscheme button, which opens the Color Scheme dialog box as seen in Figure 66, and select the color scheme for the button. 8 Delete the Next GIB Name box contents and enter Details Click OK and the new button appears in the performance view. 10 Click on the new button in the view with the left mouse button and drag it to the desired position. 11 Exit Edit mode by choosing Close Edit from the File menu and then clicking OK in the dialog box. Figure 73 shows an example of a completed Performance view. Figure 73: A Completed Performance ViewAdding a Pie Chart *File View SpectroGRAPH: Ethernet1 Performance Tue Jul 7 Collisions Value Ave Peak at Errors at Graph Properties Scroll to Date-Time 0:40:00:30:0 Detail Customization Page 138 GIB Editor User s Guide

139 Tutorial In order to display the repeater packet statistics in pie-chart format, follow these steps. 1 Click the Detail button created in the last exercise. A Default GIB view appears. 2 From the File menu, select Edit. If Edit is grayed out, change the write permissions in the Details.30 GIB file within the CsGib directory. 3 To remove the current contents of the view, click on the two fields in the view while holding down the Shift key. 4 From the Edit menu select Erase. Click OK in the Confirm dialog box. 5 From the Edit menu select Change Background. The Change Background dialog box opens. 6 Click on the Background Color window to open the Select Color Index dialog box. Select a color for the background and click OK. 7 Enter 500 in the Width box, and 800 in the Height box to adjust the size of the window for a pie chart. This can be adjusted again later after creating the pie chart. Click OK. 8 From the Edit menu, select New Attribute Field. The New Attribute Field dialog box opens. 9 From the Model Attributes list, select an error attribute, in this case, rptrpktstatscolls. 10 From the Attribute Field Types list, select Pie Chart, delta, labeled on bottom. 11 Click OK. The dialog box appears as shown in Figure 74. Customization Page 139 GIB Editor User s Guide

140 Tutorial Figure 74: Pie Chart Dialog Box Field X Position Pie Chart Field Y Position Field Mode Read Mode Attribute ID Field Label Error Breakdown Enumerations Click Extra Attributes to open the Attribute Selection dialog box. Field Font Primary Colorscheme Text Color Index Override Extra Attributes OK Cancel 12 Erase what is in the Field Label box and enter Error Breakdown. 13 Click the Field Font button and select the font, weight, slant, and size of the font to be on the button. 14 Click the Primary Colorscheme button and select the color scheme for the pie chart. 15 Click Extra Attributes; the Attribute Selections dialog box opens as in Figure 75. Customization Page 140 GIB Editor User s Guide

141 Tutorial Figure 75: Attribute Selection Dialog Box Attribute Selection Scroll down and select attributes to be displayed Click OK to confirm your choices and open the Describe Attributes dialog box. Click Cancel to return to the Pie Chart dialog box without saving attributes Activation_Status AutoMap AutoPlace AutoPlaceOffsetX AutoPlaceOffsetY AutoPlaceRowOffsetX AutoPlaceRowOffsetY AutoPlaceStartX rptrpktstatscrcs rprpktstatserrors rptrpktstatsmulticasts rptrpktstatsoows Selected Item Count 1 OK Cancel 16 Click on any other error attributes to be included in the pie chart. 17 After selecting all the attributes, click OK. The Describe Attributes dialog box appears as in Figure 76. Customization Page 141 GIB Editor User s Guide

142 Tutorial Figure 76: Describe Attributes Dialog Box The size of this dialog box varies according to the number of attributes selected. These five fields are duplicated for each attribute selected. Select the Index Color button to open the Color Selection dialog box. Describe Attributes Attribute ID Enumerations Label Index Color Scale Factor Alternate Attr Attribute ID Enumerations Label Index Color Scale Factor Alternate Attr OK Cancel 18 For each attribute, delete the Field Label box contents and enter a shorter, meaningful name. 19 Click Index Color and enter color numbers for each attribute. Click Cancel to close the Color Selection dialog box. 20 For each attribute, delete the default color number and enter the desired number. 21 Replace the Group Number number with One. Increment the other attributes. You can include summed attributes in the pie chart by assigning attributes the same Field Label, Index Color, and/or Group Number. 22 Click OK in the Define Attributes dialog box. Customization Page 142 GIB Editor User s Guide

143 Tutorial 23 Click OK in the Pie Chart definition window. The pie chart appears in the view. 24 Drag the pie chart to the desired position. Modify any field(s) in the pie chart by double-clicking and editing. 25 You can resize the window with the Change Background option, if desired. 26 From the File menu, exit Edit mode by choosing Close Edit and then clicking OK in the dialog box. Figure 77 shows an example of a completed Detail view with banner information and a pie chart. Figure 77: A Completed Detail View with a Pie Chart Ethernet 1 of type CsEnetRptr of Landscape machine:primary * File View Model Name Contact Description Location Network Address Primary Application System Up Time Manufacturer Device Type Serial Number Ethernet Packet Rates CRCs (group 1) :75 Errors (group 2) :10 OOWs (group 3) :15 Clear Total Count Percent Customization Page 143 GIB Editor User s Guide

144 Tutorial AddingaTabletoaView If you want to add a table to an existing SPECTRUM view, the steps for this process are described below. Creating a Table within an Existing Generic View This process will add a table to the CsEnetRptr Configuration view, that will provide Ethernet monitoring information. To create this table, follow these steps. 1 Navigate to the Application view for the 9E133_36 model. 2 Select the CsEnetRptr application (Cs Ethernet 1), and click Configuration. The Configuration view appears. 3 From the Configuration view s Icon Subviews > Utilities menu, select Attribute Browser (Figure 78). Customization Page 144 GIB Editor User s Guide

145 Tutorial Figure 78: Attribute Browser Click the Show Data Types button to see all data types. Click the Show Attribute IDs to see all model attribute IDs. Landscape 0x VNM Host - Attribute Browser of Type Model *File View Model Attributes Gauge-0x MonBandwidth Integer-0x MonUtilization Integer-0x MonBytesPerSec MonBandwidth Mon Utilization 0 MonBytesPerSec 0 Enter the letters for the model attribute name corresponding to the attributes you want to view. Example: Enter mon to filter for the Ethernet Monitor IDs. Your model attribute choices also appear in this panel. Controls Show Flags \/ Show Data Types \/ Show Attribute IDs Filter: mon Explode Collapse Explode All Collapse All OK Save Instance ID: Attribute Flags DatabasePolled ExternalReadable LoggedShared Memorywritable Cancel Repoll 4 You can filter for Ethernet Monitor statistics by entering mon in the Controls Panel filter. Only Ethernet Monitor group attributes including this name string will appear in the Model Attributes panel, as shown in Figure Click the Show Attribute IDs button in the Controls panel. 6 The attribute IDs are displayed and can be used in the CsConfig.GTB file. The New Attribute Field panel with attributes is shown in Figure 79. Customization Page 145 GIB Editor User s Guide

146 Tutorial Figure 79: New Attribute Field panel Check the attribute IDs for the attributes desired in the table. New Attribute Field Model Attributes Integer-0x MonBandwidth Integer-0x MonUtilization Integer -0x MonBytesPerSec Attribute Field Types Once you have selected the attributes for your table, you must create the table file. 1 Cd to the $INSTALL_root/SG-Support/CsGib directory. If you do not find this directory, check your <Spectrum path>/app-defaults/spectrum file. A Spectrum file near the beginning should refer you to the CsGib directory (e.g., *gibpath: /usr/spectrum/sg-support/csgib/). 2 The CsGib directory contains a directory for each model type in the database. Each application in the Application view represents a model type; check the CsGib directory for the model name appearing in the application icon. If you create a new application using the MTE, the model type displays the name you assigned it. Use the cd command to change to the appropriate directory. 3 Check the list of all views and tables that have been created for that model. The files ending in.30 are views, the files ending in.gtb are tables. You must create a table file that can be opened from the generic view. Use the vi editor or another text editor of choice. Note: If you are using the Windows NT platform, you will need to use another editing program with different commands. However, the end file should look similar. Customization Page 146 GIB Editor User s Guide

147 Tutorial 4 Edit CsConfig.GTb - e.g., vi CsConfig.GTb. 5 While in insert mode, enter the following exactly as shown. Do NOT force a carriage return at the end of a line of type. { ColInt.TIn(23,30,0x , Mtr Bandwidth, BUFF, 232, 16, 12, 9E133_36/newGTb.30 ) ColInt.TIn(173,30, 0x , Mtr Utilization, BUFF, 232, 16, 12, 9E133_36/newGTb.30 ) ColInt.TIn(323,30, 0x , Mtr Packet Rate, BUFF, 232, 16, 12, 9E133_36/newGTb.30 ) ColInt.TIn(473,30, 0x , Bytes/Second, BUFF, 232, 16, 12, 9E133_36/newGTb.30 ) } ~ 6 Save this file. Open the generic view by highlighting the CsEnetRptr application icon and from the Icon Subviews menu, select Configuration. 7 From the File menu select Edit. From the Edit menu, select New Non-attribute Field. Refer to Figure 80 for an example of a NonAttribute Field dialog box. Figure 80: NonAttribute Field Dialog Box Select Table Non-Attribute Field Field Type Pie Chart, Related models, Total, Delta and Accum Table Table, Generic Direct Table, Nested Table, Nested, for an Instance Table, Sorted Click OK OK Cancel 8 From the NonAttribute Field dialog box, select Table as the table type. The Table Definition dialog box is shown in Figure In the Field Label box, enter Ethernet Monitor Table. Customization Page 147 GIB Editor User s Guide

148 Tutorial 10 Click the Field Font, Primary Colorscheme, and Text Color Index Override buttons and make changes as discussed in Editing Fields in an Existing View. Do not change the default Field Value Width and Field Value Height values until after creating the table. 11 Enter Config.GTB in the TIB to point to the table file to use. If the TIB file is not located in the CsGib directory, include the file path relative to the CsGib directory in your entry. 12 Click OK to save the table. A Confirm dialog box will appear; click OK. The new table will now appear in the Configuration view. 13 Use the left mouse button and drag the new table to another location, if desired. If the table does not show all columns, do the following: a b Click on the table to highlight it and from the Edit menu, select Modify Field or double-click on the table. This opens the Table Definition Dialog window that allows you to change any of the table parameters. Type in larger numbers in the Field Value Width and Field Value Height boxes and click OK. 14 If the generic view is not large enough to show the table, do the following: a b From the Edit menu, click Change Backgrounds. The Change Background dialog window appears as in Figure 81. Enter larger numbers in the Width and Height boxes and click OK. The Change Backgrounds dialog box will disappear and the generic view should appear larger. If the view does not look bigger after this procedure, drag the corners of the window out. You can only adjust the sides to the size specified in these Width and Height fields. Customization Page 148 GIB Editor User s Guide

149 Tutorial Figure 81: Change Background Dialog Box Change Background Background Color Width Height Background Raster OK Cancel Help Adding a Table Title to the View If you want to add a title to this table: 1 From the Edit menu, select Annotation Toolbox. The Annotation Toolbox dialog box opens. 2 Click on the letter tool (the letter A). 3 Place the cursor in the generic view just above the Ethernet Monitoring Rates Table. In this case, you can enter Monitoring as the title. 4 From the toolbox window, select the font, weight, slant, and size. 5 Click on the Foreground button to select the color of the letters. The Select Color Index dialog box appears. 6 Select the desired color and click on OK. 7 Click on Close in the Select Color Index dialog box. 8 When the title appears in the generic view, you can click on and drag it to the correct location. Customization Page 149 GIB Editor User s Guide

150 Tutorial Adding an New Field To add the Last Successful Poll name field: 1 From the Edit menu, select New Attribute Field. The Attribute/Field Type dialog box appears ( see Figure 82 ). Figure 82: New Attribute Field Dialog Box New Attribute Field Model Attributes Time Ticks-Last_Successful_Poll Select Time Ticks - Last Successful Poll Scroll down and select Time Ticks Time Ticks Attribute Field Types Time, Formatted Elapsed Filter on Last Controls Show Flags Show Data Types Show Attribute IDs Filter: Last Explode Collapse Explode All Collapse All Attribute Flags DatabasePolled External ReadableShared Logged Table OK Cancel 2 The Model Attribute name taken from the MIB is Last Successful Poll. Enter Last in the Filter field. 3 Select Time Ticks - Last_Successful_Poll in the Attribute Field Types list. Customization Page 150 GIB Editor User s Guide

151 Tutorial 4 Select Time Ticks in the Attribute Field Types list. You can scroll down to this selection. 5 Click OK. The Field Definition dialog window opens as shown in Figure 83. Figure 83: Field Definition Dialog Box for an Attribute Field Definition Dialog Box Field X position Field Y position Field Mode Write Read Mode Field Mode must be Write. Attribute ID Field Label Field Font Last Successful Poll Enumerations Primary Colorscheme Text Color Index Override Field Value Width OK Cancel 6 Delete any text in Field Label, and enter Last Successful Poll. The Field X and Y positions will reset. 7 You can change the Field Font, Primary Colorscheme, and Text Color Index Override fields, as described earlier in this section. 8 Click on OK in the Attribute Definition dialog window. 9 Click on the new field using the left mouse button and drag it to the desired location in the view. 10 Field modifications are made by highlighting the field and from the Edit menu, selecting Modify Field, or by double-clicking the field. Customization Page 151 GIB Editor User s Guide

152 Tutorial This reopens the Attribute Definition dialog window, in which you can make changes. Adding an Option Button Field An option button is based on enumerated pairs. The value that is returned for an attribute can be paired with text you want to associate with that value. For example, for any value representing an operational status, you can replace the field value 1 with Up and 2 with Down. The procedure for creating this type of field is described below. 1 From the Edit menu, select New Attribute Field. The New Attribute Field dialog box appears as in Figure 84. Figure 84: Adding an Option Button New Attribute Field Model Attributes Integer-RptrPortMgmtAdminState Select this Option Attribute Field Types Numeric Display, Unsigned Option Button Controls Attribute Flags Scroll down and select the Option Button button Show flags Show Data Type Show Attribute IDs Filter Admin Explode Collapse Explode All Collapse All DatabasePolled External ReadableShared Logged Table Filter on Admin OK Cancel Customization Page 152 GIB Editor User s Guide

153 Tutorial 2 In the Filter field, enter admin. Several MIB attributes will appear in the Model Attributes panel. 3 From the attribute list, select RptrPortMgmtAdminState. 4 From the Attribute Field Types list, scroll down and select Option Button. Click OK. The Field Definition dialog window opens as depicted in Figure 85. Figure 85: Field Definition Dialog Box for an Option Button RptrPortMgmtAdminState Field X Position Field Y Position Field Mode Read Mode VNM Attribute Field Label Field Font Primary Colorscheme Text Color Index Override Field Value Width Enumerated Pairs Enumerations OK Cancel 5 Delete any text in the Field Label box, and enter Repeater Port Admin Status. The Field X and Y positions will reset. 6 You can change the Field Font, Primary Colorscheme, and Text Color Index Override fields, as described earlier in this section. 7 In the Enumerated Pairs box, delete the default entry and enter each number in the MIB followed by a comma and a single word textual description for that number as follows: 1, Up, 2, Down Customization Page 153 GIB Editor User s Guide

154 Tutorial You change the entry by moving the cursor with the arrows. You are limited to a single character string with no spaces. You can, however, enter an underdash between words: e.g. primary_failure 8 When the field appears, click on it with the left mouse button and drag it to the desired spot in the window. 9 You can change the field by highlighting it and from the Edit menu, selecting Modify Field, or by double-clicking on the field to reopen the Attribute Definition dialog window to make the changes. 10 From the File menu select Close Edit to exit Edit mode and then click OK in the dialog box to save changes. Figure 87 shows a completed Configuration View. Changing the Post_IP_Address_Change event file. Administrators can make use of many of the steps and screens shown previously in this tutorial to make use of a new feature of the GIB Editor: forcing the software to show any change of an IP address on any interface. Follow these steps: 1 From the Universe:Topology view right click in the device icon to be edited. 2 Select DevTop and then Interface view to bring up a view similar to that shown in Figure Right click on the interface to be edited and select Model Information view. 4 Choose File>Edit>New Attribute Field. Type post in the filter box and Post_IP_Address_Change_Event is displayed in the Model Attributes portion of the New Attributes Field box. 5 Highlight the new Attribute and select Option Button from the Option Button Dialog box. Change the Field Mode to read/write and the colors to anything appropriate. In the Model Information view, Save. Close edit mode. 6 Change the default on the new button to True to enable SPECTRUM to notify any IP address change on the selected interface. Customization Page 154 GIB Editor User s Guide

155 Tutorial Figure 86: DevTop view for selected device SpectroGRAPH: Device Topology: SSR8000 File View Tools Bookmarks Help SSR8000 SSR8000 SSR8000 SSR ON 2 ON 3 ON 4 ON Ethernet Ethernet Ethernet Ethernet D.2E.17.AF 02.0B.1D D.E9.1B.AF 02.0C.AD.2E Customization Page 155 GIB Editor User s Guide