¨ Data Export User’s Guide Version 5.
Notice Cabletron Systems 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 Cabletron Systems to determine whether any such changes have been made. The hardware, firmware, or software described in this manual is subject to change without notice.
Virus Disclaimer Cabletron 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. Restricted Rights Notice (Applicable to licenses to the United States Government only.) 1.
Contents Preface Who Should Read This Guide .............................................................................................. xi Prerequisites for Users......................................................................................................... xi How to Use This Guide........................................................................................................ xii Typographical Conventions...................................................................................
Historical Data ....................................................................................................................2-7 Describing Historical Data Section Fields and Buttons.............................................2-7 Current Data .......................................................................................................................2-9 Describing Current Data Section Fields and Buttons..............................................
Leftover Lock Files....................................................................................................... 5-2 Leftover SAS Processes................................................................................................ 5-3 Incomplete impoinfo File Update ................................................................................ 5-3 SAS Log Files ............................................................................................................... 5-3 SAS Work Area .
Appendix B Data Structure of SAS Data Sets SPECTRUM Data Types.................................................................................................... B-2 Associations ................................................................................................................. B-2 Attributes .................................................................................................................... B-3 Events..........................................................................
Figures Figure 2-1. Figure 2-2. Figure 2-3. Figure 2-4. Figure 2-5. Figure 3-1. Figure 3-2. Figure 3-3. Figure 3-4. Figure 3-5. Figure 3-6. Figure 3-7. Figure 3-8. Figure 3-9. Figure 3-10. Figure 3-11. Figure 3-12. Figure 3-13. Figure 4-1. Figure 4-2. Figure 4-3. Figure D-1. Figure F-1. Figure F-2. Figure F-3. Accessing Data Export from the SpectroGRAPH File Menu ............................. 2-2 Data Export Window ............................................................................................
Figures viii Data Export User’s Guide Version 5.
Tables Table A-1. Table A-2. Table A-3. Table A-4. Table A-5. Table A-6. Table A-7. Table A-8. Table A-9. Table A-10. Table A-11. Table A-12. Table B-1. Table B-2. Table B-3. Table B-4. Table B-5. Table B-6. Table B-7. Table B-8. Table B-9. Table B-10. Table B-11. Table B-12. Table C-1. Table C-2. Table C-3. Table C-4. Table C-5. Table C-6. Table C-7. Table C-8. Table C-9. Table C-10. Table C-11. Table C-12. Table C-13. ASCII File Format for Associations.....................................................
Tables x Data Export User’s Guide Version 5.
Preface Describes this manual’s audience, organizational structure, and typographical conventions, user prerequisites, elated SPECTRUM documentation, and how to get information or submit comments about SPECTRUM documentation. Welcome to the SPECTRUM Data Export User’s Guide. This guide describes how to use SPECTRUM Data Export (Data Export) to extract data from SPECTRUM databases and convert it to either ASCII, SAS, or SQL format.
How to Use This Guide How to Use This Guide This guide is organized as follows: Chapter Description Chapter 1 Introduction to Data Export Provides an overview of SPECTRUM Data Export capabilities. Chapter 2 Accessing the Data Export Window Describes how to access and work with the SPECTRUM Data Export window. Chapter 3 Describes how to create and save Data Export Creating Definition Files definition files.
Typographical Conventions Appendix Description Appendix C Data Structure of SQL Tables Provides SQL (Ingres, Sybase, Oracle, and Microsoft SQL Server) format specifications for SPECTRUM data types using sample data. Appendix D Data Export Resource File Describes the Data Export resource file and how to configure it before and after installing Data Export. Appendix E Exporting To Other Databases Describes how a post export script can be used to export data to other databases.
Related SPECTRUM Documentation Calls your attention to information of special importance. NOTE ! Calls your attention to any action that may adversely effect application performance. CAUTION Related SPECTRUM Documentation Refer to the following documentation (see http://www.cabletron.com) for detailed information on using SPECTRUM resources referenced in this manual: • SPECTRUM Operator’s Reference Describes how to work with SPECTRUM.
Chapter 1 Introduction to Data Export Provides an overview of SPECTRUM Data Export capabilities. Overview Data Export is a data extraction and export application. Data Export can extract data from one or more SPECTRUM databases and convert it to the data format that you specify — either ASCII, SAS, or SQL. You can then import the reformatted data into a report generator, database, spreadsheet, or statistical analysis application of your choice.
Data Export Files - Relations — Objects that identify the type of associations between models. - Rules — Objects that define the restrictions governing relationships. • Historical Data - Events — Instances of events recorded by SPECTRUM for SPECTRUM models. - Statistics — Performance indices for a model.
The Data Export Process Data Export Script (dtxscript) File Data Export Script (dtxscript) File You will set environment variables for SAS and SQL exports in the dtxscript file. Resource File Data Export reads the Data Export resource file, SDE, at startup to determine and establish various Data Export operational settings, such as field values, color schemes, and text fonts in the Data Export window and windows that can be derived from it.
Special Considerations Special Considerations This section discusses special considerations involved in using Data Export. For All Users You should create new definition files each time you use a new SPECTRUM database. This is necessary because SPECTRUM assigns new model handles every time it starts with a new database. Data Export extracts statistical and event information based on these model handles.
Special Considerations For SAS Users Only For SAS Users Only Before using Data Export, SAS users should consider the items in the following sections. SAS Packaged Reports During installation, Data Export installs several SAS packaged reports in the directory, sas_reports, under the ...Spectrum/SG-Tools directory. Each report file includes comments about the local changes that may be required.
Special Considerations For SAS Users Only Introduction to Data Export 1-6 Data Export User’s Guide Version 5.
Chapter 2 Accessing the Data Export Window Describes how to access and work with the SPECTRUM Data Export window. Overview You invoke Data Export when you access the Data Export window (see Accessing Data Export on Page 2-2). The window enables you to create, save, open, and modify definition files for data export as well as execute or schedule the data export.
Accessing Data Export Accessing Data Export To access Data Export: Select the Export Data option from the SpectroGRAPH File menu, as indicated in Figure 2-1. The Data Export window (Figure 2-2) opens. Figure 2-1. Accessing Data Export from the SpectroGRAPH File Menu * File View Edit ARS Gateway Export Data... MALT Reports SpectroRx Print Close Exit Help Ctrl+e Select Alt+F4 Accessing the Data Export Window 2-2 Data Export User’s Guide Version 5.
Application Commands Figure 2-2. Data Export Window Unnamed.sde Ð SPECTRUM Data Export Application Commands File Edit Help Description Export Definition Description General Information Landscapes... sunbird2 Output Format ASCII Custom... ASCII Output Directory... Post Export Script... Format Options... Data Type Historical Data spectrum stat Output Mode Export Range Events... event stat Custom... Overwrite Custom... Custom... Statistics... stat stat Overwrite Custom...
Application Commands Command Icons Describing File Menu Options The File menu includes the following command options: Open Opens an existing definition file. See Chapter 3 for details. Save Saves a new file or a file that you have modified. See Chapter 3 for details. Save As Saves another version of an existing file. See Chapter 3 for details. Export Now Executes a data export. See Chapter 4 for details.
General Information Describing Icons This section describes icon functions. The Open icon opens a definition file selection window. See Chapter 3 for details. The Save icon saves a new file or changes you have made to a file. See Chapter 3 for details. The Export Now icon starts an export. See Chapter 4 for details. The Schedule Export icon opens the Scheduler window. It enables you to schedule an export at a future time. See Chapter 4 for details.
General Information Describing General Information Section Fields and Buttons Describing General Information Section Fields and Buttons This section describes the fields and buttons included in the General Information section. Description Enables you to enter comments (optional) about a definition file. Landscapes Enables you to select the landscape(s) from which you want to export data. Output Format Enables you to specify the format for the exported data.
Historical Data Historical Data The Historical Data section (Figure 2-4) enables you to specify the types of events and/or statistics data to export from your choice of the SPECTRUM models included in your choice of the landscapes specified in the Preferred Landscapes list (see Describing General Information Section Fields and Buttons on Page 2-6). It also enables you to specify the historical period from which to export data, the previous day, week, or month, or a more precise range (e. g.
Historical Data Describing Historical Data Section Fields and Buttons Data Type Enables you to specify if you want to export events (Events button) and/or statistics (Statistics button) data. Output File (ASCII) Enables you to provide the name for the output file, data set, or table to which the data you want to export is saved.
Current Data Export Range Enables you to specify a time range from which to export events and statistics data. The toggle button offers the following selections: • Custom — Opens the Events Data Range dialog box, which you can use to specify precisely the export time range. See Specifying a Custom Data Range on Page 3-19 for details. • Day — Specifies the preceding 24-hour period. • Week — Specifies the preceding 7-day period. • Month — Specifies the preceding 30-day period.
Current Data Describing Current Data Section Fields and Buttons Describing Current Data Section Fields and Buttons This section describes the functions of the fields and buttons in the Current Data section. Data Type NOTE Enables you to specify the types of data you want to export by clicking on their corresponding buttons. For a models export, Data Export acknowledges only the first 32 characters of model names by default.
Chapter 3 Creating Definition Files Describes how to create and save Data Export definition files. Overview Before you can export data with Data Export, you must first either open an existing definition file, open and save new definition file, or save a modified version of an existing definition file. See Opening and Saving Definition Files on Page 3-2.
Opening and Saving Definition Files Opening and Saving Definition Files This section describes how to open and save definition files. Opening a Definition File To open a new file: Invoke Data Export (see Chapter 2). The Data Export window appears. It displays default or empty settings that you can configure and save for the export. Until you name the file, the default filename, Unnamed.sde, appears on the window’s title banner. To open an existing file: 1.
Opening and Saving Definition Files Saving a Definition File Saving a Definition File To save a definition file: 1. Click the Save icon, or select Save or Save As from the File menu. • Select Save if you want to save an original file or changes to an existing file. • Select Save As if you want to save a new version of the original file and retain the original file. Whenever you select Save As or select Save to initially save a new file, the Save As dialog box (Figure 3-2) appears.
Setting General Information Parameters Setting General Information Parameters To specify General Information parameters: • Enter information (optional) about the file in the Description field. You can use this field to describe the purpose or scope of the definition file. This information appears in the field whenever you re-open the file and in the log file (chronicle of export activities) Data Export writes to the output directory when you export data with the file.
Setting General Information Parameters Specifying Landscapes Specifying Landscapes The Landscapes... field lists the default landscape(s) specified by the PreferredLandscapes parameter in the SDE resource file. To specify landscapes, click the Landscapes... button to open the Landscapes dialog box (Figure 3-3). The dialog box enables you to add or remove landscapes from the list. Figure 3-3.
Setting General Information Parameters Specifying an Output Directory With Filter, you type the name or a character string contained in the item you are searching for. As you type characters, all items in the list that do not contain the characters are temporarily deleted. Unlike a search operation, the characters you are filtering on do not have to be at the beginning of an item. By default, the Search and Filter operations are case sensitive.
Setting General Information Parameters Specifying a Post Export Script Specifying a Post Export Script The Post Export Script... displays a default script if one has been specified for the PostExportDefault parameter in the SDE resource file. To specify another script, click the Post Export Script... button to open the Post Export Script dialog box (Figure 3-5). It enables you to select a script. Figure 3-5. Post Export Script Dialog Box SDE: SDE: Post Export Script Filter Hansel/Spectrum/5.
Setting General Information Parameters Setting ASCII Format Options Figure 3-6.
Setting Historical Data Parameters Date/Time Format ! The buttons in this section let you specify how you want the date/time data to appear in the ASCII output file. If you select Separate, the time and date are split into two fields, one for date and one for time. If you select Combined, the time and date (separated by a space) are represented in one field. If you select Time Ticks, the time and date are represented in UNIX time ticks in one field.
Setting Historical Data Parameters Specifying Events Data • Specifying the SPECTRUM statistics data to include in the export See Specifying Statistics Data on Page 3-15. • Specifying the output parameters for both types of historical data See Specifying Output Parameters on Page 3-18. Specifying Events Data You use the Events Filter dialog box (Figure 3-7) to define events data for an export. To open the dialog box: Click the Events...
Setting Historical Data Parameters Specifying Events Data Specifying Models This section describes how to specify the models for which you want to export events data. You select models from the Model Types/Models list (Figure 3-8) in the Events Filter dialog box. Figure 3-8.
Setting Historical Data Parameters Specifying Events Data By default, the Search and Filter operations are case sensitive. To specify a case insensitive operation, click on the Case Sensitive button to deselect the option.
Setting Historical Data Parameters Specifying Events Data Selecting Filter Criteria This section describes how to specify the types of SPECTRUM events and alarms data you want to export for the models you have selected. The Select Filter Criteria list includes three filtering options: • Select All Events — All events and alarms for the selected models are exported. This is the default setting.
Setting Historical Data Parameters Specifying Events Data Figure 3-9. Select Event Code(s) Dialog Box SDE: SDE: Select Event Code(s) Path ta/Spectrum/5.0/SG-Support/CsEvFormat/* Directories ormat/. ormat/.. ormat/EventTables Files Event00010001 Event00010002 Event00010003 Event00010004 Event00010005 Event00010006 Event00010007 Event00010008 Wildcard Choice ata/Spectrum/5.
Setting Historical Data Parameters Specifying Statistics Data Figure 3-10. Alarm Filter Options Dialog Box Alarm Filter Options All Alarms Yellow Orange Red Brown Gray Initial OK Cancel Specifying Statistics Data You use the Statistics Filter dialog box (Figure 3-11) to define statistics data for an export. To open the Statistics Filter dialog box: Click the Statistics... button in the Historical Data section (Figure 2-4) of the Data Export window.
Setting Historical Data Parameters Specifying Statistics Data Figure 3-11. Statistics Filter Dialog Box SDE: Statistics Filter Model Types/Models Common Attributes GnSNMPDev Host_SGI HubCSIEMME HubCSISEHI HubCSITR HubCSITRMM2 HubCSITRMM4 Hub_CSI_MRXi LAN_802_3 LAN_802_5 Case Sensitive Search OK Cancel Specifying Models and Model Attributes This section describes how to specify the models for which you want to export statistics data.
Setting Historical Data Parameters Specifying Statistics Data When you choose a list attribute, the output format of the expected data will be in a format compatible with attributes of this type. See Appendix A, Appendix B, and Appendix C for information on how standard statistics output and list attribute statistics output differ. You can specify that all statistics output be formatted in the list attribute format by changing the value of the ListAttrFormat parameter in the SDE resource file.
Setting Historical Data Parameters Specifying Output Parameters Specifying Output Parameters This section describes how to specify the following output parameters for events or statistics data or both: • Output file, data set, or table name • Output mode (overwrite or append data to an existing file, data set, table, or create a new file, data set, or table) • Export Range (time period from which data was extracted) Specifying an Output File/Data Set/Table Name This section describes how to specify a name
Setting Historical Data Parameters Specifying Output Parameters Specifying an Export Range This section describes how to use the Export Range button to specify the time period from which you want to export events or statistics data. To specify an export range: Select one of the following options from the Export Range button. Custom Data Export exports data from the specified start date and time to the specified end date and time. (See Specifying a Custom Data Range on Page 3-19.
Setting Historical Data Parameters Specifying Output Parameters Figure 3-13. Events/Statistics Data Range Dialog Box SDE: Events Data Range Start Date: End Date: OK Month Day Year Jun 23 1997 Month Day Year Jun 23 1997 Start Time: End Time: Available Range Hours Minutes 11 05 Hours Minutes 11 05 Now Now Cancel 2. Specify the Start Date and End Date: • Use each Month button to select the start and end months.
Setting Current Data Parameters Setting Current Data Parameters To specify current data: 1. Select the Data Type you want to export — Model Types, Model Type Hierarchy, Models, Attributes, Associations, Relations, Rules, and Extended Attributes. You can select as many data types as you want for a single definition file. Notice that a default file name, data set name, or table name is provided for each data type. 2.
Setting Current Data Parameters Creating Definition Files 3-22 Data Export User’s Guide Version 5.
Chapter 4 Exporting Data Describes how to immediately start a data export and how to schedule an export with the Scheduler utility; discusses NT scheduling requirements; describes the output produced from ASCII, SAS, and SQL data exports. Overview This chapter describes the two methods available from the Data Export window (Figure 2-2) for starting an export: • Using the Export Now command to start an export See Starting an Export Now on Page 4-2.
Starting an Export Now Starting an Export Now You can export data immediately with the Export Now command once you have created and saved a definition file (see Chapter 3) for the export. To start an export: 1. Open a definition file in the Data Export window. 2. Click on the Export Now icon, or select Export Now from the File menu to start the export.
Scheduling an Export Working with the Scheduler Figure 4-1. Scheduler Window SDE: Scheduler July 23 Definition File Command /5.0/export.output/dayexport.sde Scheduled Entries 11:32 Thu Jul 23 1998 at 11:30 */gretel/Spectr Frequency Once July 1998 Sun Mon Tue Wed Thu Fri Sat 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 At 11 : 30 Save Add Modify Reset Remove Close 3. Specify the scheduled export in the Scheduler window.
Scheduling an Export Working with the Scheduler The window enables you to perform the following tasks: • Create and include in a scheduled queue export commands that specify the definition file for each export and when and how often you want the data export to occur See Creating Scheduled Export Commands on Page 4-4. • Change scheduled export command parameters See Modifying Scheduled Export Commands on Page 4-6. • Delete scheduled export commands See Removing Scheduled Export Commands on Page 4-7.
Scheduling an Export Working with the Scheduler Click the Add button to include the entry in the list. Then click the Save button to save the entry to the scheduled queue before you exit the Scheduler. Repeat these procedures for subsequent entries. If you exit without saving, your command entries will not be executed. See Describing Scheduled Export Command Entries on Page 4-6 for additional information. Figure 4-2.
Scheduling an Export Working with the Scheduler Describing Scheduled Export Command Entries A scheduled export command entry in the Scheduled Entries list consists of two parts: the scheduling information, which indicates when the command will be executed, followed by the command, which is enclosed in quotation marks. Example command entries with available frequency options are listed as follows: Once frequency option entry Tue Jul 28 1998 at 08:52 Ó/gretel/Spectrum/5.
Checking Export Output Special Scheduler Requirements for NT Removing Scheduled Export Commands The Scheduler enables you to remove an entry from the Scheduled Entries list before or after you have saved it to the scheduled queue. To remove all entries you have added to the list but not saved to the scheduled queue: Click the Reset button. To remove a single entry you have added to the list but not saved to the scheduled queue: Highlight the entry and click the Remove button.
Checking Export Output Log File Log File Data Export writes a log file (Figure 4-3) for each export to the export output directory. The log file provides information about the export. It indicates whether or not Data Export was able to export the data you want from the landscapes you specified in the definition file, the date and the elapsed time for the export, and any other event notification related to the export.
Checking Export Output Output Files, Data Sets, and Tables Output Files, Data Sets, and Tables This section describes the types of output for the data formats supported by Data Export. Sample ASCII Output An export using a definition file, which specifies that all current data and statistics and events data should be exported, will produce the following output files in the output directory: ¥ modtyp ¥ stat ¥ modtyp.sch ¥ stat.sch ¥ assoc ¥ model ¥ assoc.sch ¥ model.sch ¥ mthier ¥ rules ¥ mthier.
Checking Export Output Output Files, Data Sets, and Tables Sample SQL Output In addition to data tables, schema files, and the export log file, SQL output also includes the following files: ¥ ingresExport.sprm ¥ ingresExport_import.log The .sprm file includes information about temporary ASCII-formatted files used by the Data Export scripts, SDEIngImport, SDEOraImport, and SDESybImport, to import data tables to an SQL database See Appendix E for more information. The _import.
Chapter 5 SAS Exports Provides information about SAS export requirements and considerations. Configuring the dtxscript File To export to SAS data sets, you must configure the dtxscript file, which is located in the .../Spectrum/SG-Tools directory. Modify the script’s “Necessary SAS additions” section as follows: • The SASROOT variable must be uncommented (remove the # character). Add the complete path of the SAS root directory to the right of the = sign. • The export SASROOT command must be uncommented.
Minimum Requirements for Exports to SAS Data Sets Minimum Requirements for Exports to SAS Data Sets To export SPECTRUM data to SAS data sets, the SAS core components must be installed and executable from the machine from which the export is run. This does not imply that the SAS core components must actually reside on the machine itself, merely that they be executable from that machine.
SAS Export Errors Leftover SAS Processes Leftover SAS Processes When an export fails, it is possible that a child process running SAS still remains in the background. This process should be killed and the output data set(s) and the log file(s) should be examined for completeness (see Checking Export Output on Page 4-7 and SAS Log Files on Page 5-3).
SAS Exports on the NT Platform If you suspect that this is the case, check the SAS work area and delete any temporary non-essential files. It may also be desirable to change the work directory specified in the config.sas609 file to an area with more available space. Once there is adequate work space, this problem should not occur again. SAS Exports on the NT Platform When a SAS export is executed on the NT platform, an informational dialog box appears on the screen at the start of the export.
Chapter 6 Ingres Exports Provides information about Ingres export requirements and considerations. Configuring the dtxscript File To export to Ingres tables, you must configure the dtxscript file, which is located in the .../Spectrum/SG-Tools directory. Modify the script’s “Necessary Ingres additions” section as follows: • The II_SYSTEM variable must be uncommented (remove the # character). Add the complete path of the Ingres root directory to the right of the = sign.
SQL Error Recognition During Ingres Database Imports SQL Error Recognition During Ingres Database Imports When you export to Ingres, initially an export to ASCII is performed. Next, a series of SQL commands is generated to create tables, copy data and add indices. The commands are executed and a log of the execution is stored in _import.log (where is the name of the definition file). This log file is searched for errors. If any errors are found, they are placed in the .
Chapter 7 Sybase Exports Provides information about Sybase export requirements and considerations. Configuring the dtxscript File To export to Sybase tables, you must configure the dtxscript file, which is located in the .../Spectrum/SG-Tools directory. Modify the script’s “Necessary Sybase additions” section as follows: • The SYBASE variable must be uncommented (remove the # character). Add the complete path of the Sybase root directory to the right of the = sign.
SQL Error Recognition During Sybase Database Imports SQL Error Recognition During Sybase Database Imports When you export to Sybase, initially an export to ASCII is performed. Next, a series of SQL commands is generated to create tables, copy data and add indices. The commands are executed and a log of the execution is stored in _import.log (where is the name of the definition file). This log file is searched for errors. If any errors are found, they are placed in the .
Chapter 8 Oracle Exports Provides information about Oracle export requirements and considerations. Configuring the dtxscript File To export to Oracle tables, you must configure the dtxscript file, which is located in the .../Spectrum/SG-Tools directory. Modify the script’s “Necessary Oracle additions” section as follows: • The ORACLE_HOME variable must be uncommented (remove the # character). Add the complete path of the Oracle root directory to the right of the = sign.
SQL Error Recognition During Oracle Database Imports • On the NT platform only, the ORALOAD_VER variable must be uncommented. Add the version number of Oracle SQL*Loader to the right of the = sign. Only the first two digits are required, and they must be enclosed in quotes. For example, the variable line for SQL*Loader version number 7.1.4.0.0 should read ORALOAD_VER=Ò7.1Ó.
Installation Considerations After you run Data Export, the spectrum user ID owns the newly created tables. Your database administrator should use the Oracle grant command to allow access to the tables. Data Export uses the Oracle SQL*Loader utility to load database tables. Refer to your Oracle documentation for other restrictions and recommendations about the SQL*Loader utility.
Installation Considerations Oracle Exports 8-4 Data Export User’s Guide Version 5.
Chapter 9 Microsoft SQL Server Exports (NT) Provides information about Microsoft SQL Server export requirements. NOTE Microsoft SQL Server is available as on output format option on the NT platform only. Configuring the dtxscript File To export to Microsoft SQL Server tables, you must configure the dtxscript file, which is located in the SG-Tools directory. Modify the script’s “Necessary SQL Server additions” section as follows: • The SERVERNAME variable must be uncommented (remove the # character).
Configuring the dtxscript File Microsoft SQL Server Exports (NT) 9-2 Data Export User’s Guide Version 5.
Appendix A Data Structure of ASCII Files Describes ASCII file format specifications for SPECTRUM data types using sample data. The ASCII export option lets you export SPECTRUM data to ASCII delimited files. These files are created in the directory specified in the Output Directory field in the SPECTRUM Data Export main window and are formatted according to the options specified in the ASCII Format Options dialog box.
SPECTRUM Data Types SPECTRUM Data Types Associations Table A-1. ASCII File Format for Associations Landscape Handle Relation Handle Left Model Handle Right Model Handle 400000 10010 400000 40000f 400000 10010 400000 400010 400000 10010 400000 400012 handle handle handle handle Attributes Table A-2.
SPECTRUM Data Types Events Events Table A-3. ASCII File Format for Events Landscape Model Handle Handle Event Type Event Alarm Alarm ConNumSevber* dition* erity Event Message Date Time 04/15/ 1998 09:13:33 400000 400076 10701 020 290 3 Wed 15 Apr, 1998 9:13:33 - Alarm number 290 generated for device IPA.DDR.ES.SS of type Hub_CSI_IRM2. Current condition is RED.
SPECTRUM Data Types Extended Attributes Extended Attributes Table A-4. ASCII File Format for Extended Attributes Landscape Handle Model Type Handle Attribute ID Extended Flags* OID Prefix Polling Group 400000 290000 11048 0000 1.3.6.1.2.1.8.6.0 0 400000 290000 10c48 0030 400000 290000 d01d1 0000 1.3.6.1.4.1.52.1.6.1.2.2.1.1.1 0 400000 290000 100d1 0000 1.3.6.1.4.52.1.6.2.2.4.
SPECTRUM Data Types Model Types Model Types Table A-6. ASCII File Format for Model Types Landscape Handle Model Type Handle Model Type Name 400000 10000 Root 400000 10080 Gen_Rptr_Prt 400000 10300 CmipPif 400000 10380 PC_CSI_TRDNI … … … handle handle character Þeld Models Table A-7. ASCII File Format for Models Landscape Handle Model Handle Model Type Handle Model Name MAC Address 400000 40025f 290000 my_mod 0.0.12.3.45.
SPECTRUM Data Types Relations Relations Table A-8. ASCII File Format for Relations Landscape Handle Relation Handle Relation Name 400000 10008 Passes_Through 400000 10010 Lost_and_Found 400000 10018 Owns 400000 10020 Provides … … … handle handle character Þeld Rules Table A-9.
SPECTRUM Data Types Statistics Statistics Table A-10. ASCII File Format for Statistics (Standard Format) Date Time Landscape Handle Model Handle Attribute Values 1 through n* 04/15/1998 08:59:04 400000 400076 17451 .... 7373 04/15/1998 09:09:03 400000 400076 17610 .... 7518 04/15/1998 09:19:04 400000 400076 17714 ....
SPECTRUM Data Types Statistics Table A-12.
Schema Format Schema Format The schema may be in a separate file (separate) or in the same file (combined) as the data depending on the ASCII format option you selected.
Schema Format The following are repeated for each field in the corresponding ASCII output file: Field Name Field Separator Field Type (Refer to Table A-12 for a description of Field Types.) Record Separator 1. 2. 3. 4. 5. 6. 7. Time Format 0 = Time Ticks (seconds since 1/1/70) 1 = One Field (MM/DD/YY HH:MM:SS) 2 = Two Fields (MM/DD/YY Field Separator HH:MM:SS) Format depends on Time Format Applies to Events and Statistics only, 0 for all other Data Types.
Appendix B Data Structure of SAS Data Sets Describes SAS format specifications for SPECTRUM data types using sample data. The SAS export option lets you export SPECTRUM data to SAS data sets. These SAS data sets are created in the directory specified in the Output Directory field in the SPECTRUM Data Export main window.
SPECTRUM Data Types SPECTRUM Data Types Associations Table B-1.
SPECTRUM Data Types Attributes Attributes Description: List of attribute descriptions for all attributes Variables: lh attrid attrname attrtype groupid flags The landscape handle, a 6-byte SAS numeric The attribute ID, a 6-byte SAS numeric The attribute name, a 32-byte string The attribute type, a 6-byte SAS numeric The group ID, a 6-byte SAS numeric The flags describing the attribute, a 6-byte SAS numeric.
SPECTRUM Data Types Events Events Description: Event data collected during the specified period Variables: ts The time stamp, a 6-byte SAS numeric lh The landscape handle, a 6-byte SAS numeric mh The model handle, a 6-byte SAS numeric eventypeThe event type, a 6-byte SAS numeric severityThe event severity, a 6-byte SAS numeric alarmThe alarm number, a 6-byte SAS numeric condThe event condition code, a 6-byte SAS numeric eventmsgThe event message, a 200-byte string Indexed by: Compressed: Table B-3.
SPECTRUM Data Types Extended Attributes Extended Attributes Description: List of extension flags and object identifiers for all attributes Variables: lh mth attrid xflags oid pollgrp Table B-4. The landscape handle, a 6-byte SAS numeric The model type handle, a 6-byte SAS numeric The attribute ID, a 6-byte SAS numeric The attribute’s extension flags, a 6-byte SAS numeric.
SPECTRUM Data Types Model Type Hierarchy Model Type Hierarchy Description: The model type hierarchy Variables: lh pmth cmth dforder Table B-5.
SPECTRUM Data Types Model Types Model Types Table B-6.
SPECTRUM Data Types Models Models Description: List of all models Variables: lh mh mth mname macaddr ipaddr Table B-7.
SPECTRUM Data Types Relations Relations Table B-8.
SPECTRUM Data Types Rules Rules Table B-9.
SPECTRUM Data Types Statistics Statistics Description: Statistical data collected during the specified time period Standard Format Table B-10.
SPECTRUM Data Types Statistics List Attribute Format Table B-11.
SPECTRUM Data Types Statistics Table B-12.
Imported Data Information Imported Data Information Description: List of the time stamps and ranges for the imported data sets Variables: type ts dsname dsdir lh ssname rs re NOTE The type of data (Rules, Models, etc.
Appendix C Data Structure of SQL Tables Provides SQL (Ingres, Sybase, Oracle, and Microsoft SQL Server) format specifications for SPECTRUM data types using sample data. The various SQL export options let you export SPECTRUM data to SQL tables. These tables are created in the database you specify in the Database Name field in the SPECTRUM Data Export main window.
SPECTRUM Data Types SPECTRUM Data Types Associations Table C-1.
SPECTRUM Data Types Attributes Attributes Table C-2. Description: List of attribute descriptions for all attributes Columns: lh attrid attrname attrtype groupid flags Indexed by: lh + attrid+ attrname The landscape handle, a 4-byte integer The attribute ID, a 4-byte integer The attribute name, a 31-byte string The attribute type, a 2-byte integer The group ID, a 4-byte integer The flags describing the attribute, a 4-byte integer.
SPECTRUM Data Types Events Events Description: Event data collected during the specified time period Columns: ts lh mh eventype severity alarm _num The time stamp, a date field The landscape handle, a 4-byte integer The model handle, a 4-byte integer The event type, a 4-byte integer The event severity, a 4-byte integer The alarm number, a 4-byte integer, nulls allowed The event condition code, a 2 byte integer, nulls allowed The event message, a database-dependent varying character string, as follows:
SPECTRUM Data Types Extended Attributes NOTE For event exports involving multiple landscapes, the data is sorted by landscape, by model type, and by model. For example, data for Landscape1 occurs first by order of model type, and by order of model within each model type (for example, ModelType1, Model1, Model2, ModelType2, Model1, Model2, etc.). Data for Landscape2 occurs next in the same manner, and so on for all additional landscapes.
SPECTRUM Data Types Model Type Hierarchy Table C-4. Format for Extended Attributes Landscape Handle (lh) Model Type Handle (mth) Attribute ID (attrid) Extension Flags (xflags) Object Identifier for Attribute (oidstr) 4194304 65751 71644 0 1.3.6.1.4.1.52.3.158.0.98 .3.1.0.0 0 4194304 65751 69817 0 1.3.6.1.4.1.52.3.130.0.13 0.1.2.0 0 4194304 65751 70347 0 1.3.6.1.4.1.52.3.148.0.10 2.1.2.1 0 4194304 65751 70350 0 1.3.6.1.4.1.52.3.148.0.10 4.1.2.
SPECTRUM Data Types Model Type Hierarchy Table C-5.
SPECTRUM Data Types Model Types Model Types Table C-6.
SPECTRUM Data Types Models Models Description: List of all models Columns: lh mh mth mname The landscape handle, a 4-byte integer The model handle, a 4-byte integer The model type handle, a 4-byte integer The model name, a user-defined varying character string, defaults to 31 bytes, nulls allowed The MAC address of the model, a 17-byte string, nulls allowed The IP address of the model, a 15-byte string, nulls allowed macadr ipadr Indexed by: Table C-7.
SPECTRUM Data Types Relations Relations Table C-8.
SPECTRUM Data Types Rules Rules Table C-9.
SPECTRUM Data Types Statistics Statistics Description: Statistical data collected during the specified time period Standard Format Columns: ts lh mh at#1 at#2 at#n * Indexed by: Table C-10.
SPECTRUM Data Types Statistics List Attribute Format Columns: ts lh mh attrid inst attrval The time stamp, a date field The landscape handle, a 4-byte integer The model handle, a 4-byte integer Attribute ID, a hex value Instance ID, a varying length character field Attribute value, a varying length character field* Indexed by: ts + lh + mh Table C-11.
SPECTRUM Data Types Statistics Table C-12.
Imported Data Information Imported Data Information Description: Table containing export criteria for tables in the database Variables: vnm The SpectroSERVER name, a 32-byte string The landscape handle, a 4-byte integer The table name, an 18-byte string The SPECTRUM data type, a 16-byte string The date field The starting date (Statistics and Events only), a date field, nulls allowed The end date (Statistics and Events only), a date field, nulls allowed lh table_name export_type export_ts range_start r
Imported Data Information Data Structure of SQL Tables C-16 Data Export User’s Guide Version 5.
Appendix D Data Export Resource File Describes the Data Export resource file and how to configure it before and after installing Data Export. The Data Export resource file, SDE, consists of parameters that define the appearance and operational features of Data Export running in the X Window System environment.
! CaseSensitive determines the default sensitivity for searches and ! filters. ! 0 = case insensitive, 1 = case sensitive. *CaseSensitive: 1 ! SearchDefault determines the search/filter default. ! 0 = filter default, 1 = search default. *SearchDefault: 1 ! SearchHighlightColor is the color used to indicate whether search ! or filter is active. Default 128 (yellow).
! This is the Model Type Hierarchy Default Text Value. *MTHierarchyName: mthier ! This is the Relations Default Text Value. *RelationsName: relation ! This is the Models Default Text Value. *ModelName: model ! This is the Rules Default Text Value. *RulesName: rules ! This is the Attributes Default Text Value. *AttrsName: attr ! This is the External Attributes Default Text Value. *ExtAttrsName: extattr ! This is the FieldSeparator as chosen from the ASCII Options menu.
! If user defined was selected above for IngresFieldSeparator, then ! IngresUserDefinedFieldSepChar is a one-character entry that describes ! the desired field separator character. *IngresUserDefinedFieldSepChar: % ! This is the RecordSeparator used for temporary Ingres export files. ! The following choices may be made: ! 0 = CR, 1 = LF, 2 = CR/LF, 3 = tab, 4 = user defined.
! This is the RecordSeparator used for temporary Oracle export files. ! The following choices may be made: ! 0 = CR, 1 = LF, 2 = CR/LF, 3 = tab, 4 = user defined. *OracleRecordSeparator: 2 ! If user defined was selected above for OracleRecordSeparator, then ! OracleUserDefinedRecordSepChar is a one-character entry that ! describes the desired record separator character. *OracleUserDefinedRecordSepChar: & ! DateTime Format used for temporary Oracle export files.
! This is the color of the text that appears in the text boxes. ! Default 245 (black). *WindowTextColor: 245 ! This is the color of the text that appears in menus. ! (black). *MenuTextColor: 245 Default 245 ! This is the color of text that appears in editable text areas. ! Default 254 (light gray). *EditableTextColor: 254 ! This is the font for the Menu Bars at the top of the screens.
Configuring Default Resource File Parameters During Installation Configuring Default Resource File Parameters During Installation During Data Export installation, you can select the Enable Custom Script Prompting option from the SPECTRUM Installation Configuration window to establish the following default SDE operational settings: Preferred Landscape Default landscapes from which data is Handle List exported (PreferredLandscapes) Definition File Directory (DefFileDefaultDir) Default directory for definiti
Configuring Default Resource File Parameters During Installation Figure D-1. Installation Custom Script Prompting ******* Begin Installing Data Export (datex.cus) ******* Is "0x11c000" the correct preferred landscape value (Hex) (y/n) ?n Enter a landscape handle/list separated by commas:0x11c000, 0x440000 Is "0x11c000,0x440000" the correct preferred landscape handle/list (y/n) ?y Is "/usr/data3/Spectrum/5.0/export.output" the correct Definition File directory (y/n) y Is "/usr/data3/Spectrum/5.0/export.
Appendix E Exporting To Other Databases Describes how a post export script can be used to export data to other databases. Data exports from SPECTRUM to a third party database can be readily accomplished using a post-export script that uses SQL commands to copy ASCII delimited data files to the designated database. To export to SQL output formats, Data Export internally exports to ASCII delimited files and then runs a script to import the data.
Organization Of The Post-Export Parameter File Organization Of The Post-Export Parameter File The .sprm file contains the following items, each on a separate line: Output directory path The location of any output generated during export. For ASCII exports, this is the location of the ASCII delimited files.
Appendix F SAS Graph Examples of Exported SPECTRUM Data Shows examples of how data exported from SPECTRUM with Data Export is depicted in SAS GRAPHs. Figure F-1, Figure F-2, and Figure F-3 are examples of graphs produced by SAS/GRAPH from SPECTRUM data. The data for these graphs was extracted by Data Export into a SAS data set, which was then used as input to SAS’s proc gplot. Figure F-1.
Figure F-2. Example SAS Graph — Load and Software Rates SAS Graph- WORK GPLOT File Edit View Locals Globals Help Two Attributes and One Model Model Name= EttleLAN.3 100 90 30 Load 80 70 l a n d 20 60 50 10 30 SoftErrorRate 0 20 10 08MAY 1997 : 21:00 09MAY 1997 : 10:53 10MAY 1997 : 00:46 11MAY 1997 : 04:33 SpectroSERVER: Goalie Figure F-3.
Index Symbols .log file 4-8 .sch file 4-9 .sde file 3-3 .snx01 file 4-10 .sprm file 4-10, E-1, E-2 .
Definition file 1-2 configuring default settings D-1 naming 3-3 opening 2-4, 3-2 providing description 2-6, 3-4 saving 2-4, 3-3 special considerations 1-4 specifying a post export script 2-6, 3-4, 3-7 specifying an output directory 2-6, 3-4, 3-6 specifying an output format 2-6, 3-4 specifying an SQL database name 2-6, 3-4 specifying ASCII format options 2-6, 3-7 specifying events and statistics data 2-7, 3-10 to 3-17 specifying landscapes 2-6, 3-4, 3-5 specifying SPECTRUM data types 2-9, 3-21 Document acces
Ingres user considerations restrictions and regulations 6-2 SQL error recognition 6-2, 7-2 Ingres, specifying an SQL database name 2-6, 3-4 L Landscapes 2-6, 3-4, 3-5 Log file 4-8 M Microsoft SQL Server (NT) export, dtxscript file configuration 9-1 Microsoft SQL Server (NT) output.
SAS output format, selecting 2-6, 3-4 SAS user considerations error handling 1-5 export errors 5-2, 5-3 using packaged reports 1-5 Schedule Export command 2-4, 4-2 Scheduled exports creating entries for 4-4 modifying entries for 4-6 NT requirements 4-7 removing entries for 4-7 Scheduler window 4-3 accessing 4-2 frequency options 4-6 managing scheduled entries 4-3 to 4-7 Schema files 4-9 specifying generation of for ASCII output 3-9 SDE (resource file).
