TeamQuest SMFII and TeamQuest Online for Unisys MCP Systems

Transcription

1 TeamQuest SMFII and TeamQuest Online for Unisys MCP Systems ADMINISTRATION GUIDE Copyright 2012 TeamQuest Corporation. All Rights Reserved. April 2012 Levels and TQ

2 The names, places and/or events used in this publication are purely fictitious and are not intended to correspond to any real individual, group, company or event. Any similarity or likeness to any real individual, company or event is purely coincidental and unintentional. NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THE DOCUMENT. Any product and related material disclosed herein are only furnished pursuant and subject to the terms and conditions of a license agreement. The only warranties made, remedies given, and liability accepted by TeamQuest, if any, with respect to the products described in this document are set forth in such license agreement. TeamQuest cannot accept any financial or other responsibility that may be the result of your use of the information in this document or software material, including direct, indirect, special, or consequential damages. You should be very careful to ensure that the use of this information and/or software material complies with the laws, rules, and regulations of the jurisdictions with respect to which it is used. The information contained herein is subject to change without notice. Revisions may be issued to advise of such changes and/or additions. U.S. Government Rights. All documents, product and related material provided to the U.S. Government are provided and delivered subject to the commercial license rights and restrictions described in the governing license agreement. All rights not expressly granted therein are reserved. TeamQuest, the TeamQuest logo, TeamQuest Alert, TeamQuest Analyzer, TeamQuest Baseline, TeamQuest CMIS, TeamQuest Harvest, TeamQuest IT Service Analyzer, TeamQuest IT Service Reporter, TeamQuest Manager, TeamQuest Model, TeamQuest On the Web, TeamQuest Predictor, TeamQuest Online, TeamQuest Surveyor, TeamQuest View, and Performance Surveyor are trademarks or registered trademarks of TeamQuest Corporation in the US and/or other countries. Unisys and ClearPath are registered trademarks of Unisys Corporation in the US and/or other countries. All other trademarks and service marks are the property of their respective owners.

3 About This Guide Purpose Scope Audience TeamQuest SMFII and TeamQuest Online are Unisys Master Control Program (MCP) software packages that address the capacity management, performance analysis, and performance monitoring needs of your system. TeamQuest SMFII and TeamQuest Online are installed on a Unisys MCP host system and use the TeamQuest View software installed on a workstation for data display and analysis. The TeamQuest SMFII and TeamQuest Online Administration Guide for Unisys MCP Systems describes TeamQuest SMFII and TeamQuest Online. It tells you how to use the TeamQuest SMFII software as a tool for performing capacity management and performance analysis tasks on your system and how to use the TeamQuest Online software as a performance monitoring tool. This guide describes the TeamQuest SMFII and TeamQuest Online software. It tells how to use the TeamQuest SMFII and TeamQuest Online probes to collect and store performance data in the history database and the monitor file. It provides conceptual information on the TeamQuest Performance Management Architecture and the database structure. This guide is intended for those who are interested in performance analysis and capacity management of Unisys MCP systems. TeamQuest Online addresses the needs of the performance analyst. TeamQuest SMFII addresses the needs of the performance analyst and the capacity planner. The performance analyst can use TeamQuest SMFII or TeamQuest Online to view performance data that has been collected at a high granularity. The capacity planner can use TeamQuest SMFII to view data across long periods of time. Marketing representatives and technical managers who are interested in the capacity management of Unisys MCP systems can also use TeamQuest SMFII. TQ iii

4 About This Guide How to Use This Guide This guide contains information specific to the host component of the TeamQuest SMFII and TeamQuest Online software. This guide is intended to be used with the TeamQuest View User Guide, the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems and the TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems. These manuals provide information about the data collection and database management programs for use with TeamQuest SMFII and TeamQuest Online. Organization This guide contains the following: Section 1. Introduction This section provides an introduction to TeamQuest SMFII and TeamQuest Online. It describes the products, provides an overview of TeamQuest SMFII and TeamQuest Online processing, and tells how the products work. It also lists the hardware and software requirements for using TeamQuest SMFII and TeamQuest Online. Section 2. TeamQuest SMFII and TeamQuest Online Concepts This section explains the history database structure and the monitor file structure. It also describes workload management and alarm definition. Section 3. Probe Manager This section describes the Probe Manager program and the data it collects about system resource usage. It includes information on resource requirements and data file organization. It describes the Probe Manager commands and provides a description of each command, as well as the command syntax and examples. This section also includes information on the Library and Portfile Communications interfaces for use with TeamQuest SMFII. Section 4. TeamQuest SMFII Administration Interface This section provides information on how to use the TeamQuest SMFII Administration Interface. It also provides information on configuring alarms and defining workloads. Appendix A. Understanding Railroad Diagrams This appendix explains how to read and interpret the diagrams used to represent the syntax of commands. iv TQ

5 About This Guide Results After reading and using this guide, you will be able to use TeamQuest SMFII or TeamQuest Online on the host system, maintain the history database or monitor file, and use the data collection probes to gather measurement data in the database. Related Product Information The following related documents may be helpful to you when using TeamQuest SMFII or TeamQuest Online. Use the version that corresponds to the level of software in use at your site. TeamQuest Product Documentation If you are using TeamQuest manuals, you can find related product information in the following documents: TeamQuest Express User Guide for Unisys MCP Systems (TQ 02262) This guide provides information about the TeamQuest Express software as a tool for performing capacity management and performance analysis tasks on your Unisys MCP system. TeamQuest Products Installation Guide for Unisys MCP Systems (TQ 02212) This guide provides information about installing the TeamQuest SMFII, TeamQuest Online, TeamQuest Probes, TeamQuest View, TeamQuest Model, TeamQuest Express, and TeamQuest PMPlus software on your Unisys MCP system. TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems (TQ 02261) This manual provides information about Query, the LOGCONSOLIDATOR program, File Maintenance Utility (FMU), and the Datamapper utility for use with the TeamQuest SMFII or TeamQuest Online software. TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems (TQ 02228) This manual describes the data collection probes available for use with the TeamQuest SMFII, TeamQuest Online, and TeamQuest Probes products. TeamQuest View User Guide (TQ 01401) This guide describes how to use the TeamQuest View software. TeamQuest View is the user interface to TeamQuest SMFII and TeamQuest Online. You use TeamQuest View to view history and real-time monitor reports from data collected by TeamQuest SMFII or TeamQuest Online. TQ v

6 About This Guide Unisys Product Documentation If you are using Unisys manuals, you can find related product information in the following documents: GETSTATUS/SETSTATUS Programming Reference Manual ( ) This manual explains the function of GETSTATUS and SETSTATUS and provides both input information needed to write the call and output information that can help interpret the results that are returned. I/O Subsystem Programming Guide ( ) This guide contains information about how to program for various types of peripheral files and how to program for interprocess communication using port files. System Commands Operations Reference Manual ( ) This manual contains a complete description of the system commands you use to control system resources and work flow. Task Attributes Programming Reference Manual ( ) This manual documents the SYSTEMSTATUS function of the DCALGOL programming language. Work Flow Language (WFL) Programming Reference Manual ( ) This manual presents the complete syntax and semantics of WFL. You can use this language to construct jobs that compile or run programs written in other languages and that perform library maintenance such as copying files. vi TQ

7 About This Guide How to Access Portable Document Format (PDF) Files All TeamQuest product documentation is available as PDF files. PDF files can either be downloaded from the TeamQuest Web site or they can be viewed from your product DVD. You must have the Adobe Reader software from installed on your workstation to view the PDF files. To download product documentation from the Web site: 1. Access the TeamQuest Web site at 2. Click the Support tab, then Customer Area. 3. Log in to the Customer Area. 4. Click the Downloads link. 5. Click the Product Documentation link for the desired release level and product platform. 6. Select the document you wish to download. When the download is complete, the PDF file will open. 7. Select the Save As command from the File menu to save a copy of this document. To access product documentation from your product DVD: 1. Load the DVD in your disk drive. The disk contents dialog box is displayed. 2. Open the welcome.pdf file. The welcome.pdf file can be used to navigate to the desired PDF file. You may wish to copy the welcome.pdf file and the pdfdocs folder to your server so multiple users have convenient access to the product documentation. Note: When copying the welcome file and the pdfdocs folder, you must maintain the established directory structure. If the directory structure is not maintained, the navigation links within the welcome.pdf file will not open the documents located in the pdfdocs folder. TQ vii

8 About This Guide Notation Conventions The examples in this guide show, as nearly as possible, how your input, system output, and screens appear on a video display terminal. All command syntax appears as railroad diagrams. For more information on how to use these diagrams, see Appendix A. When using TeamQuest SMFII or TeamQuest Online on the host system, the following conventions apply: You can enter commands or other required input in either uppercase or lowercase letters. Both ways are shown in the examples in this manual. Brackets are used to indicate optional entries. For example: COPY = [AS <usercode>= ] FROM <tape name> TO <packname>(pack) This shows that the AS <usercode>= is optional. A pair of less than and greater than signs (< >) are used to indicate values that you supply. For example: COPY = [AS <usercode>= ] FROM <tape name> TO <packname>(pack) This example indicates that you must supply an optional usercode, a tape name, and a packname. For TeamQuest PC software menu selections, a command sequence is shown as Start > Programs > TeamQuest > TeamQuest View This sequence indicates that to perform the necessary function, you select Programs from the Start menu, and then select TeamQuest from the Programs submenu, and TeamQuest View from the TeamQuest submenu. viii TQ

9 Contents About This Guide Section 1. Introduction 1.1. What Is TeamQuest Software for Unisys MCP Systems? What Can You Do With TeamQuest Software for Unisys MCP Systems? What Is TeamQuest SMFII? What Is TeamQuest Online? What Can You Do with TeamQuest SMFII and TeamQuest Online? Processing Overview How Do TeamQuest SMFII and TeamQuest Online Work? The Host Software Component TeamQuest SMFII Administration Interface TeamQuest View Software Section 2. TeamQuest SMFII and TeamQuest Online Concepts 2.1. History Database Structure Monitor File Structure Data References with TeamQuest View Workload Management Using Workload Probes Specifying Workload Definitions Example Workload Set Definition Workload Definition Language Post-Collection Workload Characterization Alarms Management TQ ix

10 Contents Section 3. Probe Manager 3.1. Data File Organization Probe Manager Commands ALARMS AUTOQUIT AUTOTF CLOSE CONFIGURE DATABASE HISTORY IOTRACE LIBRARY MONITOR MONITORDATABASE PORT PRIORITY QUIT SAMPLE or COLLECT STATUS TIMING TRANSFER or TF VERSION Probe Manager Interfaces LIBRARY Interface Data Types Probe Manager Program Control Flow Define_Dbitem Define_Key_Dbitem Define_Key_Value Define_Characteristics Define_Weight_Factor Smfii_Write Get_Config_Info Get_Workload_Info Initialize_Probe Enable_Probe Disable_Probe Terminate_Probe Sample_Probe Configure_Probe Installing the Probe PORTFILE Communications Interface PORTFILE Characteristics Specifying Data Items Validating PORT Declarations PORT Application Example x TQ

11 Contents Section 4. TeamQuest SMFII Administration Interface 4.1. Performing Administrative Tasks Logging In Selecting a Database Using the Interface Using the Task Entry Pages Using the Edit Pages Using the Alarm Policy TeamQuest SMFII Probe Manager Default Alarm Definitions Configuring Alarms Viewing the Alarm List Adding an Alarm Definition Editing an Alarm Definition Deleting an Alarm Definition Changing the Status of an Alarm Activating Changes Configuring Aliases Viewing the Alias List Adding an Alias Definition Editing an Alias Definition Deleting an Alias Definition Configuring Actions Viewing the Actions List Adding an Action Definition Editing an Action Definition Deleting an Action Definition Using the Workload Policy Viewing the Workload Set List Adding a Workload Set Adding a Workload to a Workload Set Specifying the Order of Workloads Changing the Status of a Workload Set Editing a Workload Set Editing a Workload Definition Deleting a Workload Set Deleting a Workload Analyzing a Workload Set Activating Changes TQ xi

12 Contents 4.5. Using the Probe Manager Policy Initiating Probe Manager Terminating the Probe Manager Executing Probe Manager Commands ALARMS Command AUTOQUIT Command AUTOTF Command CLOSE Command CONFIGURE Command DATABASE Command HISTORY Command IOTRACE Command LIBRARY Command MONITOR Command MONITORDATABASE Command PORT Command PRIORITY Command SAMPLE Command STATUS Command TIMING Command TRANSFER Command VERSION Command Editing Parameter Files Maintaining System Licenses Viewing License Information Editing the License File Appendix A. Understanding Railroad Diagrams A.1. What Are Railroad Diagrams?... A 1 A.1.1. Constants and Variables... A 2 A.1.2. Constraints... A 3 A.2. Following the Paths of a Railroad Diagram... A 7 A.3. Railroad Diagram Examples with Sample Input... A 8 Glossary... 1 Bibliography... 1 Index... 1 xii TQ

13 Figures 1 1. TeamQuest SMFII and TeamQuest Online Components Workload Characterization Post-Collection Workload Characterization Probe Manager and Probe Library Routines Initializing the Probe Starting the Probe Sampling Performance Data Stopping the Probe Terminating the Probe Configuring the Probe TQ xiii

14

15 Tables 2 1. History Database Modules and Corresponding Data Files Probe Relationships Default Alarm Descriptions A 1. Railroad Constraints... A 6 TQ xv

16

17 Section 1 Introduction This section provides an introduction to the TeamQuest software for Unisys Master Control Program (MCP) systems. Read the following topics to learn more about these products and how you can use them for performance analysis and capacity planning tasks. What Is TeamQuest Software for Unisys MCP Systems? (see 1.1) What Can You Do With TeamQuest Software for Unisys MCP Systems? (see 1.2) What Is TeamQuest SMFII? (see 1.3) What Is TeamQuest Online? (see 1.4) What Can You Do with TeamQuest SMFII and TeamQuest Online? (see 1.5) Processing Overview (see 1.6) How Do TeamQuest SMFII and TeamQuest Online Work? (see 1.7) TQ

18 Introduction 1.1. What Is TeamQuest Software for Unisys MCP Systems? TeamQuest software for Unisys MCP systems is a family of products which addresses the needs of capacity management and performance analysis of your computer systems. This integrated family of products allows you to choose the tools that you need to manage the performance at your site. The TeamQuest software for Unisys MCP systems consists of the following products: TeamQuest SMFII TeamQuest SMFII is a performance tool for Unisys MCP systems. It collects a comprehensive set of statistics for real-time monitoring of system activity, historical performance reporting, performance problem diagnosis and resolution, and trend analysis. This product consists of two parts: the TeamQuest SMFII Administration Interface and TeamQuest View. The TeamQuest SMFII Administration Interface provides a user interface for alarms, workloads, and inquiring and controlling the run-time behavior of the Probe Manager. TeamQuest View provides a graphical user interface for detailed data reporting and analysis. TeamQuest Online TeamQuest Online is a performance management tool for Unisys MCP systems specifically focused on real-time monitoring of system activity. This product consists of TeamQuest View and a subset of the services provided by TeamQuest SMFII. TeamQuest Probes TeamQuest Probes is a set of data collectors that supplements the data provided in TeamQuest SMFII or TeamQuest Online. These additional data collectors measure performance information from Data Management Systems II (DMSII) databases, Communications Management Systems (COMS) transaction programs, Logic and Information Network Compiler (LINC) applications, BNAV2 network components, and Terminal Control Protocol (TCPIP) collects TCP/IP connection statistics for various network entities. TeamQuest Extended Network Application Platform (NAP) Probes TeamQuest Extended NAP Probes is a set of data collectors that supplement the NAP data collectors provided in TeamQuest SMFII. These additional data collectors provide status information on various components within the NAP system. TeamQuest Express TeamQuest Express is a performance tool ideally suited for small to medium-sized sites. It helps sites with limited technical resources track historical trends of system-wide performance statistics, analyze program resource usage, and measure file and tape activity. 1 2 TQ

19 Introduction TeamQuest Model TeamQuest Model provides capacity planning and what-if analysis. TeamQuest Model obtains its data from TeamQuest products running on Unisys MCP systems, OS 2200 systems, UNIX systems, or Microsoft Windows systems. It provides an easy-to-use interface into a set of powerful modeling algorithms. An interface to Hewlett-Packard OpenView Performance is also available. TeamQuest PMPlus TeamQuest PMPlus bundles performance management software for Unisys MCP systems, Microsoft Windows systems, or UNIX systems, giving you total control of your Unisys MCP configuration. This cross-platform solution combines TeamQuest SMFII, TeamQuest Probes, and TeamQuest View for UNIX and Microsoft Windows systems. Together these products provide a comprehensive solution unique to your Unisys MCP environment What Can You Do With TeamQuest Software for Unisys MCP Systems? The TeamQuest software for Unisys MCP systems allows you to address a wide range of performance and capacity problems in your enterprise: Use alarms to detect complex situations and provide event-based performance management. Monitor one or more systems in detail with graphical and textual reports. Typical users include operators, system administrators, and performance analysts. Analyze historical data with powerful time selection and reporting, including trend analysis. Typical users are performance analysts and capacity planners. Characterize workloads along business lines to understand and monitor resource usage and requirements. Typical users are performance analysts and capacity planners. Model your systems for hardware sizing, capacity planning, and what-if tuning scenarios. Typical users include performance analysts and capacity planners. TQ

20 Introduction 1.3. What Is TeamQuest SMFII? TeamQuest SMFII for Unisys MCP software provides the services for the TeamQuest software on your Unisys MCP system. TeamQuest SMFII must be installed on every monitored host and consists of the components that collect, store, manage, and administer the performance data. TeamQuest SMFII performs the following functions for the TeamQuest software: Data collection and storage Data is collected by probes and stored in the history database and a monitor file. You can select from a predefined set of data collection probes. Administration You can control the data that is collected, how often it is collected, and how it is stored. You can also characterize workloads and manage your license keys. Alarms You can specify conditions and actions for TeamQuest SMFII to test and act upon. Application interfaces TeamQuest SMFII makes the collected and stored data available to the performance applications, such as TeamQuest View and TeamQuest Model, using secure application interfaces What Is TeamQuest Online? TeamQuest Online is a performance monitoring tool for Unisys MCP systems. TeamQuest Online gathers measurement data into a monitor file and makes it available for real-time monitor reports. TeamQuest Online operates like TeamQuest SMFII; however, it contains only a subset of the functionality of TeamQuest SMFII. 1 4 TQ

21 Introduction 1.5. What Can You Do with TeamQuest SMFII and TeamQuest Online? TeamQuest SMFII is the required product within the TeamQuest software. TeamQuest Online is a subset of TeamQuest SMFII. These products allow you to perform the following tasks: Analyze and view system performance data using a real-time monitor Present reports simultaneously from multiple hosts View predefined reports from a real-time monitor Perform correlation analysis between performance statistics Produce hard-copy output of reports, using a printer Cut and paste reports to software packages such as spreadsheets or word processors Export report data into ASCII files, which can be used in other software packages such as spreadsheets or word processors TeamQuest SMFII provides the additional capabilities to perform the following tasks: Build and maintain a performance history database, containing performance analysis data Generate and present reports in textual or graphic format, showing historical data from the performance database Define reports to reflect site-specific configurations Track hardware configurations Build and report workload characterizations Perform threshold checking on performance data and generate alarms when values exceed predefined thresholds TQ

22 Introduction 1.6. Processing Overview TeamQuest SMFII and TeamQuest Online processing consists of two phases: data collection and data display. These phases include the various activities involved in creating the history database or the monitor file, maintaining the history database or monitor file, and using the data stored in the history database or monitor file for report generation and graphics displays. TeamQuest SMFII and TeamQuest Online control the activities for data collection and data display processing. Data Collection TeamQuest SMFII and TeamQuest Online use software probes to gather data from the MCP by using standard system software interfaces. Data collection depends on the probe parameters set in the parameters file. Data Display During the data display phase, TeamQuest View retrieves data from the history database or the monitor file. You can then use this data to generate reports and display them in textual or graphic format. See the TeamQuest View User Guide for more information. Reports can also be generated on the host system using SYSTEM/TQ/SMFII/QUERY or SYSTEM/TQ/ONLINE/QUERY. See the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems for additional information. 1 6 TQ

23 Introduction Figure 1 1 shows the components of TeamQuest SMFII and TeamQuest Online. MCP Datamapper Probes FMU Probe Manager LOG- CONSOLIDATOR Monitor File History Database Query TQDATA TeamQuest View Administration Interface Reports Exported Report Data Files Figure 1 1. TeamQuest SMFII and TeamQuest Online Components TQ

24 Introduction 1.7. How Do TeamQuest SMFII and TeamQuest Online Work? TeamQuest SMFII and TeamQuest Online consist of a host software package and the TeamQuest View user interface software. The host software collects performance data, stores this data in the history database or monitor file, and maintains the history database or the monitor file. TeamQuest View requests performance data from the history database or the monitor file and creates reports The Host Software Component The TeamQuest SMFII and TeamQuest Online host software runs on your Unisys MCP system, collecting data and maintaining the history database or the monitor file. TeamQuest SMFII and TeamQuest Online use probes to collect data, with each probe collecting data from a different source. Once the data is collected, TeamQuest SMFII and TeamQuest Online store the data for future retrieval. TeamQuest SMFII also stores hardware configurations in the database so that as you are looking at past performance data, you can also view the hardware configuration that produced the performance data. You can monitor the performance data of your system in real time by using TeamQuest SMFII or TeamQuest Online. TeamQuest SMFII and TeamQuest Online collect monitor data at a short time interval and make this data available to TeamQuest View for reporting. TeamQuest SMFII or TeamQuest Online updates the monitor reports on a regular timed basis so you can see what is currently happening on your system. 1 8 TQ

25 Introduction The TeamQuest SMFII and TeamQuest Online host components consists of the following parts: Data collection TeamQuest SMFII and TeamQuest Online have three programs that perform data collection: Probe Manager The Probe Manager controls collection of real-time performance information on system resource usage by a number of probes. Each probe collects data at various intervals. The Probe Manager schedules these probes. For information on the Probe Manager program, see Section 3. Probes The probes collect performance data about the computer system. This data is stored in the history database and the monitor file for future retrieval and reporting. Four probes are available with TeamQuest Online: Globals, I/O, Family I/O, and Task Monitor. The following probes are available with TeamQuest SMFII: Globals, I/O, Family I/O, Task Monitor, Mixtrace, Mix Workload, Mix Workload I/O, I/O Trace, Environment, Configuration, License, and NAP. For detailed information on these probes, see the TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems. LOGCONSOLIDATOR The LOGCONSOLIDATOR program is designed to process the SUMLOG files and create TeamQuest SMFII database files. The information extracted from the log files is condensed and placed in data files by type, such as task history, file activity, mainframe errors, or I/O errors. For information on the LOGCONSOLIDATOR program, see the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems. Monitor file The TeamQuest SMFII and TeamQuest Online monitor file is a circular file that allows monitor data to be stored and retrieved quickly. When the maximum amount of data has been stored in the file, the oldest set of collected data items for a given time is dropped and replaced with the new set of data items. TeamQuest View can generate monitor reports from data in the monitor file. TQ

26 Introduction Host to TeamQuest View interface The host to TeamQuest View interface handles all communications to and from TeamQuest View. The host program retrieves data from a history database or a monitor file and returns that data to TeamQuest View for display. During the process of starting TeamQuest View, you are required to run the host interface. The host program must be active before making any data requests from TeamQuest View. History database The TeamQuest SMFII history database consists of multiple files containing data on past system performance. TeamQuest View can generate history reports from data in the TeamQuest SMFII history database. See 2.1 for additional information on the history database. The TeamQuest Online history database consists of multiple files containing data dealing with mainframe and peripheral error analysis. The TeamQuest Online history database can only be reported on by using the Query program. Host report generation Host-generated reports are generated through the Query interface using either the default reports contained with TeamQuest SMFII or custom-generated reports. File Maintenance Utility (FMU) The FMU can remove old history files or parts of files, archive files, sort files, merge files, and report on the timestamps in those files. For information on FMU, see the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems. Datamapper utility The Datamapper utility can convert data collected by previous TeamQuest SMFII releases into a form acceptable to the new release. For information on the Datamapper utility, see the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems TQ

27 Introduction TeamQuest SMFII Administration Interface Note: This feature is not available in TeamQuest Online. The TeamQuest SMFII Administration Interface is a browser-based interface that allows you to perform the following administrative tasks: Manage Alarms The TeamQuest SMFII Administration Interface is used to manage the alarm definitions in your performance database. Manage Workloads The TeamQuest SMFII Administration Interface is used to manage the workload sets and the workload definitions used in your performance database. Control the Probe Manager The TeamQuest SMFII Administration Interface can initiate and terminate the Probe Manager and send commands to a running Probe Manager TeamQuest View Software The TeamQuest View software provides the user interface to the TeamQuest SMFII and TeamQuest Online host software. TeamQuest View lets you access the host system, retrieve data, and create reports. See the TeamQuest View User Guide for information on using TeamQuest View. Using TeamQuest View, you can generate reports showing historical data, view system performance data by using the real-time monitor, and define site-specific reports. Each of the probes is released with a set of predefined reports. Custom reports can also be designed by creating your own report definition files using the TeamQuest View > File > New option or by using the Prompt and Nprompt report definitions. See the TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems for information on the predefined reports released with TeamQuest View. TQ

28

29 Section 2 TeamQuest SMFII and TeamQuest Online Concepts TeamQuest SMFII consists of the components that collect, store, manage, and administer the performance data. Read the following topics to learn more about the major concepts of TeamQuest SMFII and TeamQuest Online: History Database Structure (see 2.1) Monitor File Structure (see 2.2) Data References with TeamQuest View (see 2.3) Workload Management (see 2.4) Alarms Management (see 2.5) TQ

30 TeamQuest SMFII and TeamQuest Online Concepts 2.1. History Database Structure TeamQuest SMFII and TeamQuest Online generate and use a collection of files containing data about system performance. Data collectors such as the Probe Manager and LOGCONSOLIDATOR programs produce files that can be analyzed by the TeamQuest View or Query programs. The term history database, in the context of TeamQuest SMFII and TeamQuest Online, refers to a collection of files with many common characteristics. These characteristics are interrelated and grouped according to module. The SYMBOLTABLE file provides information that identifies which files belong to a particular module. Performance data is not stored in the SYMBOLTABLE. For ease of operation, you can address the TeamQuest SMFII database on a module basis rather than on an individual file basis. Files in the TeamQuest SMFII history database belong to one of the following modules: Probe Manager Hardware Workload Files in the TeamQuest Online history database belong to the Hardware module. 2 2 TQ

31 TeamQuest SMFII and TeamQuest Online Concepts Table 2 1 shows possible files that can exist in the history database. They are grouped according to module, with each module having its own SYMBOLTABLE file. Table 2 1. History Database Modules and Corresponding Data Files Module Probe Manager* Hardware Workload* File CONFIGURATION ENVIRONMENT FAMILYIO GLOBALS IO IOTRACE LICENSE MIXWORKLOAD MIXWORKLOADIO MIXTRACE NAPNARESPONSETIME NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPRESOURCEGRP NAPVFBUFFER NAPVOICEFILE SYMBOLTABLE ASYSMFERRORS CP2KERRORS HALTLOAD MCSERRORS MLIPERRORS SYMBOLTABLE TAPEACTIVITY BNAACTIVITY BNAV2ACTIVITY FILEACTIVITY MCSACTIVITY PRINTS SECURITY SYMBOLTABLE SYSACT TASKHISTORY TASKHISTORY/TANKFILE** * These modules are not available for TeamQuest Online. ** These files cannot be analyzed by the Query program. TQ

32 TeamQuest SMFII and TeamQuest Online Concepts The names of the data files created by the TeamQuest SMFII and TeamQuest Online programs are important. You must follow a naming convention to ensure proper identification. Your role in assigning proper names is minimal; however, it is important to be familiar with the naming convention to keep the history database error-free. The name of each data file has at least three nodes. The last node uniquely identifies the data file with a descriptive name. The next to last node is the name of the module currently being generated or used. You normally need only be concerned with assigning names to directory nodes that precede the last two nodes. If you do not specify directory nodes, then the default directory of TQ/SMFII/DATA/<system serial number> or TQ/ONLINE/DATA/<system serial number> is used, where <system serial number> is the system serial identification number field [23:16] of TIME(23). The following list indicates how to specify the directory nodes for each module: Probe Manager module Specify the directory node and module name for this module with the Probe Manager program SET DATABASE command in the Probe Manager Parameters file. The Probe Manager program allows greater flexibility in the naming convention of the database by allowing you to specify the module node in addition to the directory node. Hardware and Workload modules Specify the directory node for this module with the LOGCONSOLIDATOR program ADD command. Note: The Probe Manager program differs from LOGCONSOLIDATOR because the module name is not hard-coded. You specify the module name in the declaration of the database for the Probe Manager. An example of file names for a database is TQ/SMFII/DATA/1234/PROBEMGRDB/SYMBOLTABLE TQ/SMFII/DATA/1234/PROBEMGRDB/GLOBALS TQ/SMFII/DATA/1234/PROBEMGRDB/IOTRACE TQ/SMFII/DATA/1234/HARDWARE/SYMBOLTABLE TQ/SMFII/DATA/1234/HARDWARE/ASYSMFERRORS TQ/SMFII/DATA/1234/HARDWARE/HALTLOAD TQ/SMFII/DATA/1234/WORKLOAD/SYMBOLTABLE TQ/SMFII/DATA/1234/WORKLOAD/BNAACTIVITY TQ/SMFII/DATA/1234/WORKLOAD/FILEACTIVITY In this example the directory node is TQ/SMFII/DATA/1234 and the module names are PROBEMGRDB, HARDWARE, and WORKLOAD. 2 4 TQ

33 TeamQuest SMFII and TeamQuest Online Concepts 2.2. Monitor File Structure The TeamQuest SMFII SYSTEM/TQ/SMFII/PROBEMGR program or the TeamQuest Online SYSTEM/TQ/ONLINE/PROBEMGR program generates and uses a collection of files containing data about system performance. These files can only be analyzed by the TeamQuest View program. The Query program cannot be used to analyze the monitor file. The term monitor file, in the context of TeamQuest SMFII and TeamQuest Online, refers to a collection of files with many common characteristics. Some characteristics of the monitor file are similar to those in the history database. Differences between the monitor file and history database include The performance data in the monitor file is retained up to 24 hours. The performance data in the history database is retained on an ongoing basis. The TeamQuest View program is the only means of reporting data in the monitor file. TQ

34 TeamQuest SMFII and TeamQuest Online Concepts 2.3. Data References with TeamQuest View TeamQuest View uses a hierarchy of key values to organize and describe performance and capacity information in the TeamQuest SMFII history database, as well as the monitor file. The hierarchy used by TeamQuest View is structured around the following key values: Filename A filename corresponds to the probe or port program name that performs the data collection. The data in the history database or the monitor file is segregated by the probe or port program that collected it. Workload Set For a workload probe, the workload set identifies the collection of workloads that represent all the work performed on the system. Workload For a workload probe, the workload defines a logical unit of work. Dbitem A dbitem describes some actual information that is being stored. PCTMCP and AVAILMEM are examples of dbitems. Value Type A value type describes how the dbitem data is presented to the user. Value types include: average, minimum, maximum, standard deviation, summation, count, and default. Resource A resource is a component of the system that does work, such as a disk unit (physical resource) or a task (logical resource). Throughout this manual, the term parameter is used to refer to one specific performance data item in the database. A parameter is defined to be a unique combination of key values. The keys are defined such that a user can select one item from a list of filenames, one item from a list of workload sets, multiple items from a list of workloads, multiple items from a list of dbitems, multiple items from a list of value types, and multiple items from a list of resources. A parameter value is defined to be a specific instance of data for a parameter. A parameter value is identified by parameter, aggregation set, and time and date of the data point. 2 6 TQ

35 TeamQuest SMFII and TeamQuest Online Concepts 2.4. Workload Management TeamQuest SMFII allows you to track the activity on your system based on a logical classification of the work performed on the system. This logical classification of work is called workload characterization. Workload characterization is the process whereby groups of related performance data are organized into meaningful units called workloads. You define workloads for your TeamQuest SMFII database and the TeamQuest SMFII probes distribute the data they collect according to the defined workloads. Note: The workload capability is not available with TeamQuest Online. Workload characterization is used to summarize a large set of data in ways that reduce the level of detail required to understand the operation of the computer system and its relationship to the various business operations it supports. This process is essential to understanding how well your computer system is meeting the requirement of providing acceptable levels of service to the users. Workload characterization allows you to identify the workloads and track their use of system resources. Each workload is uniquely identified and defines a criteria for distributing the system resources used by each activity. For example, you can define your workload to track how much of the system resources are used by payroll, order entry, or a software development project. The Mix Workload probe uses the workload definitions to distribute the statistics for the work performed by each activity to the appropriate workload. TeamQuest SMFII supports the definition of multiple workload sets, each containing unique workload definitions. A workload set is defined as a set of workloads, which represents the system resources used by all activities on the system. TeamQuest SMFII uses each workload set for distributing the work performed by each activity. This allows you to track the activities on the system, using a different view of the system. Creating multiple workload sets is useful for testing new workload definitions because they can be used without affecting the existing production workloads. Workload characterization can be done in two different ways with TeamQuest SMFII: During data collection, the workload probes perform workload characterization concurrent with the collection of nonworkload characterized data. The workload characterized data and raw data is stored into the TeamQuest SMFII database. During reporting with TeamQuest View, the host to TeamQuest View interface program (TQDATA) can perform workload characterization during the processing of a report request. The report request causes workload characterization to be done by processing the nonworkload characterized data in the TeamQuest SMFII database. TQ

36 TeamQuest SMFII and TeamQuest Online Concepts Using Workload Probes A TeamQuest SMFII probe that collects workload-characterized data is tightly coupled with another TeamQuest SMFII probe that collects the raw data (for example, task information or response time information). The workload probe takes the raw information and passes it through a filter to determine what workload set and workload the raw information should be added to. Figure 2 1 shows the workload characterization process. Data Source Raw Data Probe (Mixtrace) TeamQuest SMFII Database Workload Data Probe (Mixworkload) Workload Definitions Figure 2 1. Workload Characterization Table 2 2 shows the relationship between the raw data collection probes and their associated workload data collection probes. Table 2 2. Probe Relationships Information Type Raw Data Probe Workload Data Probe Task information Mixtrace Mix Workload Mix Workload I/O Response time information COMS* COMS Workload* * These probes are part of the TeamQuest Probes software product. It is not necessary to actually store the raw data in the TeamQuest SMFII database for the workload data to be collected and stored. However, for the current set of workload probes, it is typically desirable to have both the raw data and workload data available in the TeamQuest SMFII database. 2 8 TQ

37 TeamQuest SMFII and TeamQuest Online Concepts To collect data with a workload probe, you must: 1. Register the workload probe in the TeamQuest SMFII database. 2. Use the TeamQuest SMFII Administration Interface to create workload definitions. 3. Activate the workload probe through the Probe Manager. To register a workload probe, you must: 1. Update the TQ/SMFII/PROBEMGR/PARAMETERS file to include a LIBRARY statement to identify the new workload probe (see 3.2.9). The Parameters file provided on the release media specifies the Mix Workload and Mix Workload I/O probes. 2. Start the SYSTEM/TQ/SMFII/PROBEMGR program. During the initialization of the Mix Workload probe, the characteristics are automatically registered with the TeamQuest SMFII database. The workload probe does not immediately begin collecting data using the new workload definitions. The process of activating the workload probe causes the probe to access the database for the new workload definitions. If the Probe Manager is not running, start the SYSTEM/TQ/SMFII/PROBEMGR program. This activates the workload probe. If the Probe Manager is running, use the following steps to activate the workload probe: 1. Stop the workload probe. This is done by either shutting off the Probe Manager program using the AX QUIT command or resetting the probe using the AX RESET HISTORY PROBES = (MIXWORKLOAD) command. 2. Restart the probe. If you shut off the Probe Manager, restart the SYSTEM/TQ/SMFII/PROBEMGR program again. If you reset the MIXWORKLOAD probe, use the AX SET HISTORY PROBES = (MIXWORKLOAD) command. TQ

38 TeamQuest SMFII and TeamQuest Online Concepts Specifying Workload Definitions The Mix Workload probe uses workload definitions for creating parameters and assigning data values. The Mix Workload probe has a unique set of workload characteristics. See the TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems for more information on the Mix Workload probe. The order in which workloads are defined is very important. When a probe processes an input record, the workloads are evaluated in the order specified when they are defined. Once a probe determines that the data record belongs to a workload, the data is assigned to only that workload. The remaining workloads are not evaluated. If the record does not belong to any defined workload, it is assigned to a default workload named OTHER. The sum of all workloads, including OTHER, represents all the work performed on the system. You create your workload definitions using the TeamQuest SMFII Administration Interface (see 4.4) Example Workload Set Definition When the Probe Manager creates a new database, or opens an existing database which contains no workload set definitions, an example workload set is automatically generated. This workload set is named TQ_EXAMPLE_WLS. It consists of workloads: Usercode EXAMPLE, Workload Group TEAMQUEST, Networking Software, and System Software. The example workload set and its workloads cannot be edited or deleted. It is disabled by default, and can be enabled. It can be duplicated, and the duplicate can be edited to suit your needs. These workloads are intended to give an example of how to use the Workload Definition Language so that you can create workload sets and workloads which meet the needs of your site Workload Definition Language You use the workload definition language to specify your workloads. A definition is expressed as the combination of a characteristic name, an operator, and a value. This combination is referred to as a condition. A condition can be either a numerical condition or a string condition, depending on the characteristic used in the definition. A numerical condition is used when the values for the characteristic must be numeric. A string condition is used when the values for the characteristic must be a string. Conditions can be combined using the Boolean operators OR, AND, and NOT to form complex definitions TQ

39 TeamQuest SMFII and TeamQuest Online Concepts The following are examples of workload definitions: PRIORITY = 50 TASKNAME = "(BILLING)SYSTEM/BILLING ON BILLING" Numerical Condition A numerical condition is expressed as an integer or real type characteristic name, a numerical operator, and a numerical value set. Numerical operators can be =, < >, <, >, <=, or >=. A numerical value set is a single integer, a real number, or many numbers separated by commas and enclosed in braces. The following are examples of numerical conditions: PCTCPU <= 2.5 WFLQNUMBER = {1, 5, 10} String Condition A string condition is expressed as a string type characteristic name, a string operator, and a string value set. String operators can be = and < >. A string value set is a single string with the characters enclosed in double quotation marks (" ") or in single quotation marks (' '), a single pattern consisting of a regular expression enclosed in slashes (/ /), or several strings and patterns separated by commas (,) and enclosed in braces ({ }). The following are examples of string conditions: TASKNAME = "(BILLING)SYSTEM/BILLING" USERCODE = {"PRODUCTION",/TEST.*/} A string condition containing a string enclosed in double quotation marks (" ") or single quotation marks (' ') indicates that an exact match is required when the definition is evaluated. An example is USERCODE="TQSYS". USERCODE is the characteristic name; the equal sign is the string operator; TQSYS is the string value. This condition is met only when the USERCODE identifier is TQSYS. A string value enclosed in slash marks indicates the use of text pattern matching, also called regular expression matching. The string value is made up of regular expressions. An example using a regular expression is USERCODE=/TQ.*/. USERCODE is the characteristic name; the equal sign is the string operator; TQ.* is the regular expression. The regular expressions are defined using the following rules: Single character A sequence of characters (other than special characters that follow) is a regular expression that matches itself. For example, TQZ matches TQZ. Backslash (\) A backslash (\) followed by a single character is a regular expression that matches the single character. For example, TQ\*. matches the string TQ*. TQ

40 TeamQuest SMFII and TeamQuest Online Concepts Period (.) A period (.) is a regular expression that matches any single character. For example, TQ.. matches the strings TQaa and TQab. It does not match the string TQ. The regular expression TQ..Z matches the strings TQaaZ and TQabZ. Brackets [...] A set of characters enclosed in brackets [...] is a regular expression that matches any one of the characters enclosed within the brackets. For example, TQ[ab] matches TQa or TQb. TQ[ab]Z matches the strings TQaZ and TQbZ. A range of consecutive characters can be specified by using a hyphen (-) to separate the first and last character desired. For example, TQ[a-m] matches the strings TQa and TQb through TQm. If a caret (^) is the first character in the brackets, the regular expression matches any character except those found in the brackets. For example, TQ[^b-m] matches the strings TQa, TQn, and TQo. It does not match strings TQb and TQc through TQm. Asterisk (*) An asterisk (*) matches zero or more occurrences of the regular expression that immediately precedes it. For example, TQa* matches TQ, TQa, and TQaa. The regular expression TQ.*Z matches the strings TQZ, TQaZ, TQabZ, and TQabcZ. Plus (+) A plus (+) matches one or more occurrences of the regular expression that immediately precedes it. For example, TQa+ matches TQa, and TQaa. The regular expression TQ.+Z matches the strings TQaZ, TQabZ, and TQabcZ. Question mark (?) A question mark (?) matches zero or one occurrence of the regular expression that immediately precedes it. For example, TQ[a-z?] matches the strings TQ, TQa, and TQb through TQz. Parentheses ( ) A set of characters enclosed in parentheses (...) matches the characters enclosed within the parentheses. For example, TQ(ab)? matches TQ or TQab. The parentheses can be used to build complex regular expressions. Note: Be careful when specifying a regular expression for the TASKNAME, JOBNAME, or MCSNAME characteristics in the MIXWORKLOAD probe. Legal characters in these characteristics, such as the parentheses and forward slash, have special meaning in a regular expression. The backslash character followed by the special character must be used such as: /\(BILLING\)SYSTEM\/BILLING.*/ 2 12 TQ

41 TeamQuest SMFII and TeamQuest Online Concepts Use of Boolean Expressions The Boolean operators OR, AND, and NOT can be used to combine numerical conditions and string conditions to form a definition. Parentheses can be used to override the default precedence. The following example shows the use of Boolean operators: PRIORITY = 50 OR (CHARGECODE = "10100" AND USERCODE=/TQ.*/) In the preceding example, the numerical condition PRIORITY=50 must be true or both string conditions CHARGECODE = "10100" and USERCODE = /TQ.*/ must be true. The operators use the following default order of precedence: Operator Order of Precedence () left to right <, >, <=, >=, =, <> left to right NOT AND right to left left to right OR Example The following example shows a definition using characteristics for USERCODE, CHARGECODE, and PRIORITY. USERCODE = "VENCTL" OR left to right (USERCODE = /VEN.*/ AND (CHARGECODE = /102[0-9]9/ AND CHARGECODE <> "10229")) OR PRIORITY = 50 OR (PRIORITY >= 90 AND PRIORITY <= 99) This workload contains information for the following: Usercode VENCTL Usercodes that begin with VEN and have chargecodes 10209, 10219, and through PRIORITY 50 and 90 through 99 TQ

42 TeamQuest SMFII and TeamQuest Online Concepts Post-Collection Workload Characterization Post-collection workload characterization provides workload reporting without storing workload-characterized data in the TeamQuest SMFII database. The workload characterization is done as part of the processing of the report request from the TeamQuest View user interface. Figure 2 2 shows post-collection workload characterization. TeamQuest SMFII Database Raw Data TQDATA Workload Definitions Figure 2 2. Post-Collection Workload Characterization To use this capability, you must 1. Run the Probe Manager to collect the nonworkload characterized data (for example, the Mixtrace probe). 2. Use the TeamQuest SMFII Administration Interface to create workload set and workload definitions for the workload collection probe (for example, the Mix Workload probe). 3. Use the TeamQuest View user interface to request a report specifying the post-collection workload characterization probe name as the value of the Filename key (for example, MIXWORKLOADRPT) TQ

43 TeamQuest SMFII and TeamQuest Online Concepts 2.5. Alarms Management Note: The alarms capability is not available with TeamQuest Online. The TeamQuest SMFII probes collect data from various data sources. The probes can also check the data obtained at each sample interval to determine if the data values exceed user-specified threshold limits. If a data value for a parameter is found to exceed a threshold, the probe can generate an alarm to alert you that a threshold condition has been met. The Probe Manager handles all alarms generated by the probes, sends console messages, makes the alarm messages available for display by TeamQuest View, and performs site-specific actions for each alarm. The TeamQuest SMFII Administration Interface defines the threshold conditions and actions to be taken as a result of exceeding the threshold limits. The threshold and alarm feature in TeamQuest SMFII provides the capability of sending a Simple Network Management Protocol (SNMP) trap as an alarm action. The file TQ/SMFII/ETC/SNMPREADME documents the configuration changes necessary for the Unisys MCP systems (see 4.3). TQ

44

45 Section 3 Probe Manager The TeamQuest SMFII and TeamQuest Online Probe Manager is a program designed to collect real-time performance information from the operating system. This information is periodically sampled by probes at intervals that are controlled by the Probe Manager. The performance data is stored in disk files for subsequent analysis. If you are using TeamQuest Online, this performance data can be analyzed using the TeamQuest View software. If you are using TeamQuest SMFII, the performance data can be analyzed using both the TeamQuest View software and host-based Query program. Read the following topics to learn about the Probe Manager: Data File Organization (see 3.1) Probe Manager Commands (see 3.2) Probe Manager Interfaces (see 3.3) LIBRARY Interface (see 3.4) PORTFILE Communications Interface (see 3.5) TQ

46 Probe Manager 3.1. Data File Organization To minimize the operating overhead, you can use various techniques to sample performance-related information. The sampling rate at which data is collected depends upon the stability of that information and the overhead necessary to acquire it. The behavior of the Probe Manager is governed by a Parameters file containing various commands. The first 72 characters of each record in the file are interpreted as free-form input text. Each command must be terminated with a semicolon and can span multiple records. The Parameters file must be available at the time of execution; it is expected to be named TQ/SMFII/PROBEMGR/PARAMETERS or TQ/ONLINE/PROBEMGR/PARAMETERS and to reside under the same usercode and family in which all other TeamQuest SMFII or TeamQuest Online files are installed. The default Parameters file provided on the release tape is a CANDE sequence data file, but other file types (such as ALGOL or DATA) are acceptable. The Probe Manager DATABASE command is optional in the Probe Manager Parameters file (see 3.2.6). This command allows you to specify the directory name and disk family on which the history data files are to reside. This specification overrides any task-level family substitution related to the Probe Manager. If the family is not specified, the Probe Manager defaults to the family DISK. If you do not specify a directory name, the data files are created under the following default directory: TQ/SMFII/DATA/<system serial number>/probemgrdb The Parameters file on the TeamQuest SMFII release media specifies a DATABASE command. The directory name specified on that DATABASE command differs slightly from the default. The directory name specified on the release media is TQ/SMFII/DATA/PROBEMGRDB. While the Probe Manager is running, it continues to store data in the history files until one of the following occurs: The TRANSFER FILES command is entered. The SET AUTOTF command is used to automatically close and transfer files. The Parameters file is modified between executions of the Probe Manager, so that different probes are defined and the user has elected to transfer the database. In any of these situations, the history data files in the TQ/SMFII/DATA/<system serial number>/<probemgr> directory are closed and renamed under the following directory: TQ/SMFII/DATA/<system serial number>/<date>/<time>/probemgrdb When the directory change is completed, data storage is resumed in a new set of files. The old files are not opened by the Probe Manager under any circumstances. Thus, data files can be closed, backed up, and removed without terminating the Probe Manager. 3 2 TQ

47 Probe Manager If a name change is necessary because of a change in the Parameters file, the following message is issued before any directory changes are made: DISPLAY:***** PROBE MISMATCH: A PROBE WAS ADDED OR DELETED FROM EXISTING DATABASE. ACCEPT:ENTER OK TO USE EXISTING DATABASE, TF TO TRANSFER, OR QUIT. At this point, you must either respond with an AX OK, AX TF, or AX QUIT. If you respond OK, the Probe Manager continues to use the existing database including the data items collected by the new probe. If you respond TF, the Probe Manager transfers the files in the previously described manner. If you respond QUIT, the Probe Manager terminates Probe Manager Commands The commands described in this subsection control the behavior of the Probe Manager program. Specifications can be made at initialization time and possibly during execution, depending on the command. When the Probe Manager begins execution, it opens its input Parameters file (TQ/SMFII/PROBEMGR/PARAMETERS or TQ/ONLINE/PROBEMGR/PARAMETERS) and processes a list of specifications. The INTNAME for the Parameters file is PARAMSFILE. An example of a Parameters file appears in the TeamQuest Products Installation Guide for Unisys MCP Systems. All specifications are written in free-form input language and belong to one or more of the following categories: Those that must be provided in the Parameters file and cannot be adjusted during program execution Those that can optionally appear in the Parameters file and cannot be adjusted during program execution Those that can be entered using AX (Accept) ODT commands during program execution and can optionally appear in the Parameters file For TeamQuest SMFII, these commands may be issued using the Probe Manager Policy feature of the TeamQuest SMFII Administration Interface when the Probe Manager is running. The commands are presented alphabetically in this section. Each command description contains the following: The syntax diagram The SET, RESET, and INQUIRE capability unless it is an immediate command that you can enter at any time An explanation of the command Examples of user input (shown in bold type) with the program response TQ

48 Probe Manager ALARMS Syntax SET ALARMS RESET ALARMS? SET RESET INQUIRE At any time At any time At any time Explanation The ALARMS command is used to establish alarms based upon the alarm definitions defined in the Profile File. The SET ALARMS command enables alarm checking by interpreting the alarm definitions in the Profile File and evaluating the alarms conditions during execution. The RESET ALARMS command disables alarm checking while ALARMS? displays the current status of the command. Examples 1761 AX SET ALARMS 1761 DISPLAY:ALARMS STATE IS ENABLED AX ALARMS? 1761 DISPLAY:ALARMS STATE IS ENABLED AX RESET ALARMS 1761 DISPLAY:ALARMS STATE IS DISABLED. 3 4 TQ

49 Probe Manager AUTOQUIT Syntax SET AUTOQUIT = <time> TOMORROW TODAY DAYSFROMNOW <date> ( <integer> ) <day of week> RESET AUTOQUIT AUTOQUIT <day of week>? SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SET RESET INQUIRE At any time At any time At any time Explanation The AUTOQUIT command is used to specify the desired time of day to terminate the Probe Manager. The RESET option cancels a pending termination condition, while AUTOQUIT? displays the current status of the command. The <date> can be entered as a 2-digit or 4-digit year. To use 2-digit years, enter to represent the years or enter to represent the years To use 4-digit years, enter the entire 4-digit year. For example, 1997 can be represented as 97 or TQ

50 Probe Manager Examples 1223 AX SET AUTOQUIT = 12:30 TOMORROW 1223 DISPLAY:#AUTOQUIT OPTION CHANGED & ACTIVATED DISPLAY:#PROBEMGR WILL TERMINATE AT: 12:30:00 01/06/12 (FRIDAY) AX AUTOQUIT? 1223 DISPLAY:#PROBEMGR WILL TERMINATE AT: 12:30:00 01/06/12 (FRIDAY) AX RESET AUTOQUIT 1223 DISPLAY:#AUTOQUIT OPTION DE-ACTIVATED. 3 6 TQ

51 Probe Manager AUTOTF Note: This command is not available for TeamQuest Online. Syntax SET AUTOTF ( /1\ TFTIME = <time> /1\ MAXSIZE =, DAILY TOMORROW TODAY DAYSFROMNOW (<integer>) <date> <day of week> <integer> /1\ /1\ /1\ FILEFULL PROBECHANGE NEGATIVETIMESTAMP, DIRECTORY = <directory name> ) <day of week> SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SET RESET INQUIRE At any time At any time At any time Explanation TQ

52 Probe Manager The AUTOTF command permits the automatic closing and transferring of the history data files. The SET AUTOTF command causes an automatic transfer when one of the following conditions are met: The accumulation of current data exceeds the specified number of segments. The specified time of day occurs. A history data file is full and cannot be expanded. Upon detection of a database file being full, the probe manager looks to see if FILEFULL has been specified on the AUTOTF command and determines if the database is automatically transferred. If FILEFULL has been specified, the database is automatically transferred in the normal manner. If FILEFULL has not been specified, a message is issued and the probe is suspended. You must take appropriate action prior to restarting the probe. The default for FILEFULL is not set. The Probe Manager detects that a probe has been added or deleted from the existing database. Upon detection of a probe being added or deleted from an existing database, the Probe Manager looks to see if PROBECHANGE has been specified on the AUTOTF command and determines if the database is automatically transferred. If PROBECHANGE has been specified, then the database is automatically transferred in the normal manner. If PROBECHANGE has not been specified, then the Probe Manager automatically recognizes the added or deleted probe and continues to write records into the existing database. The default for PROBECHANGE is not set. The Probe Manager detects a database record with a timestamp out of order. Upon detection of a database record with a timestamp out of order, the Probe Manager looks to see if NEGATIVETIMESTAMP has been specified on the AUTOTF command and determines if the database is automatically transferred. If NEGATIVETIMESTAMP has been specified, then the database is automatically transferred in the normal manner. If NEGATIVETIMESTAMP has not been specified, then the Probe Manager discards the database records until a valid time stamped database record is detected. The default for NEGATIVETIMESTAMP is not set. 3 8 TQ

53 Probe Manager The <date> can be entered as a 2-digit or 4-digit year. To use 2-digit years, enter to represent the years or enter to represent the years To use 4-digit years, enter the entire 4-digit year. For example, 1997 can be represented as 97 or If DIRECTORY is specified, the database is transferred to the specified directory; otherwise, it is transferred to the default directory name. See for more information on transferring data. Note: The DIRECTORY specification can only be used if TFTIME, MAXSIZE, FILEFULL, PROBECHANGE, or NEGATIVETIMESTAMP has been specified. Examples 1223 AX SET AUTOTF (TFTIME=16:00 01/06/12, MAXSIZE=10000, DIRECTORY=TQ/SMFII/ARCHIVE/=) 1223 DISPLAY:#AUTOTF OPTION CHANGED AND ACTIVATED AX AUTOTF? 1223 DISPLAY:#AUTOTF OPTION ACTIVE: DISPLAY: (TFTIME=16:00 01/06/12 (FRIDAY), MAXSIZE=10000 SEGMENTS, DIRECTORY=TQ/SMFII/ARCHIVE/=) AX RESET AUTOTF 1223 DISPLAY:#AUTOTF OPTION DE-ACTIVATED CLOSE Note: This command is not available for TeamQuest Online. Syntax CLOSE FILES This command can be entered at any time. Explanation The CLOSE command locks all history data files. It is used to update the last records of the data files to allow concurrent execution of the TeamQuest View or Query programs. You can continue to run the Probe Manager and gather additional data while you examine previous data through the TeamQuest View or Query program. Example 1223 AX CLOSE FILES 1223 DISPLAY:#PROBEMGR FILES CLOSED. TQ

54 Probe Manager CONFIGURE Syntax SET CONFIGURE <probe name> ( <configure list> ) CONFIGURE <probe name>? <configure list>, INFO = TYPE = " <probe specific text> " <type list> <type list>, ( HISTORY ) MONITOR SET RESET INQUIRE At any time At any time At any time Explanation The CONFIGURE command allows you to provide configuration information to a probe. The TeamQuest Online and TeamQuest SMFII I/O probe is designed to use this configuration information. The <probe name> option identifies the probe that is notified of the configuration information. The <probe specific text> option is a sequence of EBCDIC characters enclosed in quotes. The TYPE parameter identifies if the configuration information applies to the history database, monitor file, or both. If the TYPE parameter is not specified, the configuration information applies to both the history database and monitor file. The SET CONFIGURE form of the command is used to pass configuration information to the probe. The CONFIGURE? form of the command inquires about the configuration information and displays the information from the most recent SET CONFIGURE command TQ

55 Probe Manager Example 1223 AX SET CONFIGURE IO (INFO ="RESET UNITTYPE = (NP,DC,SC,LP,CD)") 1223 DISPLAY:#CONFIGURE IO COMPLETED 1223 AX CONFIGURE IO? 1223 DISPLAY:#CONFIGURE PROBE IO: 1223 DISPLAY:# HISTORY: 1223 DISPLAY:# RESET UNITTYPE = (NP,DC,SC,LP,CD) 1223 DISPLAY:# MONITOR: 1223 DISPLAY:# RESET UNITTYPE = (NP,DC,SC,LP,CD) DATABASE Note: This command is not available for TeamQuest Online. Syntax SET DATABASE ( <files option> ) DATABASE? <files option> FAMILYNAME, = <family name> DIRECTORY = <directory name> SET RESET INQUIRE At initialization Never At any time Explanation The DATABASE command controls disk storage for the TeamQuest SMFII history data files. The SET DATABASE form of this command allows you to specify the disk family or directory name for the history data files. The DATABASE form of this command allows you to inquire where the history database files are written. If FAMILYNAME is not specified, the Probe Manager uses the default family of DISK. If the DIRECTORY is not specified, the Probe Manager generates the data files under the default directory TQ/SMFII/DATA/<serial number>/probemgrdb. Using the TeamQuest View program to report performance data in the history database requires a DATABASE command in the TQ

56 Probe Manager TQ/SMFII/TQDATA/PARAMETERS file, naming the history database directory and family name. The <directory name> and <family name> on the DATABASE command in the TQDATA Parameters file must match the <directory name> and <family name> specified on the DATABASE command in the Probe Manager Parameters file. Using the SYSTEM/TQ/SMFII/QUERY program to report performance data in the history database requires using an OPEN command. The OPEN command requires <directory name> to be broken into the components of <directory node> and <module name>. <module name> is defined to be the last node of <directory name>. The format of <directory name> is <directory node>/<module name> Using the default <directory name> of TQ/SMFII/DATA/<serial number>/probemgrdb, the <directory node> is TQ/SMFII/DATA/<serial number> and the <module name> is PROBEMGRDB. The correct OPEN syntax for the Query program would be OPEN PROBEMGRDB IN TQ/SMFII/DATA/<serial number>; Example 1223 AX DATABASE? 1223 DISPLAY:#HISTORY DATABASE (DIRECTORY=TQ/SMFII/DATA/PROBEMGRDB/= FAMILY=TQ). For additional information on the OPEN command, see the TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems TQ

57 Probe Manager HISTORY Note: This command is not available for TeamQuest Online. Syntax SET RESET HISTORY HISTORY? PROBES = (<probe-list>) <probe-list> <probe name>, <probe name> CONFIGURATION ENVIRONMENT FAMILYIO GLOBALS IO IOTRACE LICENSE MIXTRACE MIXWORKLOAD MIXWORKLOADIO NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPVFBUFFER NAPVOICEFILE NAPRESOURCEGRP NAPNARESPONSETIME <user defined probe name> TQ

58 Probe Manager SET RESET INQUIRE At any time At any time At any time Explanation The HISTORY command is used to activate or suspend probes that write performance data to the history database. The number of probes sampling and the frequency of sampling impacts the resource usage by the Probe Manager. You can control the disk space and the Probe Manager overhead, by indicating which types of data are to be collected. By default all probes are SET (activated) when the Probe Manager is started. The probes can be activated or suspended collectively or individually. If the PROBES option is not selected, all probes are SET or RESET. The SET command activates a probe that is not running, and the RESET command suspends a running probe. If a probe is in an error state, the SET and RESET commands have no effect. To restart a probe that has been suspended due to an error, terminate and restart the Probe Manager. The user-defined probe name is 1 to 17 alphanumeric characters and must match the probe name specified on the SET LIBRARY command in the Parameters file. Examples 1223 AX SET HISTORY PROBES =(GLOBALS,IO) 1223 DISPLAY:#HISTORY PROBE GLOBALS HAS BEEN STARTED DISPLAY:#HISTORY PROBE IO HAS BEEN STARTED AX HISTORY? 1223 DISPLAY:#HISTORY PROBE(S): DISPLAY:# GLOBALS : ACTIVE DISPLAY:# IO : ACTIVE AX RESET HISTORY 1223 DISPLAY:#HISTORY PROBE GLOBALS HAS BEEN SUSPENDED DISPLAY:#HISTORY PROBE IO HAS BEEN SUSPENDED TQ

59 Probe Manager IOTRACE Note: This command is not available for TeamQuest Online. Syntax SET IOTRACE ( <iotrace parameter list> ) RESET IOTRACE IOTRACE? <iotrace parameter list>, /1*\ /1*\ UNITS = ( <integer list> ) BLOCKS = <integer> /1*\ QUITTIME = <time> <date> <day of week> <integer list>, <integer> <integer> - TO <integer> <day of week> SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY TQ

60 Probe Manager SET RESET INQUIRE At any time At any time At any time Explanation The IOTRACE command controls the IOTRACE facility of the MCP. The following three additional parameters must be specified when the SET IOTRACE command is used: UNITS This is a list of unit numbers for which detailed I/O information is collected. For Universal I/O (UIO) systems, this is the physical unit number. BLOCKS This is the maximum number of 7-word I/O control blocks accumulated in each second of elapsed time. The number is used to specify an IOTRACE tank size within the MCP. QUITTIME This is the time at which the IOTRACE facility should be terminated. These mandatory parameters allow site control of the operating overhead associated with the use of this function. The <date> can be entered as a 2-digit or 4-digit year. To use 2-digit years, enter to represent the years or enter to represent the years To use 4-digit years, enter the entire 4-digit year. For example, 1997 can be represented as 97 or The RESET IOTRACE command terminates the IOTRACE function. The IOTRACE? command results in a display of current status information regarding the IOTRACE task. Examples 1223 AX SET IOTRACE (BLOCKS=1200,UNITS=(96-100),QUITTIME=11:15) 1223 DISPLAY: #IOTRACE INITIATED AX RESET IOTRACE 1223 DISPLAY: #IOTRACE ACTIVITY TERMINATED AX IOTRACE? 1223 DISPLAY: #IOTRACE NOT RUNNING TQ

61 Probe Manager LIBRARY Syntax SET LIBRARY <library name> = LIBRARY <library name>? ( <library attributes> ) PROBES = ( <probe list> ) <library attributes> TITLE FUNCTIONNAME = = <file title> <name> <probe list> <probe name>, ( AREASIZE = <integer> ) TQ

62 Probe Manager <probe name> CONFIGURATION ENVIRONMENT FAMILYIO GLOBALS IO IOTRACE LICENSE MIXTRACE MIXWORKLOAD MIXWORKLOADIO NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPVFBUFFER NAPVOICEFILE NAPRESOURCEGRP NAPNARESPONSETIME TASKMON <user defined probe name> SET RESET INQUIRE At initialization Never At any time Explanation The LIBRARY command is used to specify a probe library to be linked into the Probe Manager. This allows a probe library to use the database access routines for the history database and the monitor file. It is required that at least one SET LIBRARY statement be specified in the Probe Manager Parameters file. The LIBRARY command requires that the library attributes are specified. Either the TITLE or FUNCTIONNAME statements are required. The library name and user-defined probe name is 1 to 17 alphanumeric characters. All library names and all probe names must be unique. TeamQuest Online probe names include GLOBALS, IO, FAMILYIO, and TASKMON TQ

63 Probe Manager AREASIZE represents the number of records per area of the file (range 0 to ). The AREASIZE takes effect when a new file is created or the database is transferred. For additional information on AREASIZE, see the File Attributes Programming Reference Manual. Example AX LIBRARY? 1223 DISPLAY:#LIBRARY : TQLIBRARY DISPLAY:# PROBE : GLOBALS, HISTORY DATABASE AND MONITOR FILES Example AX LIBRARY? 1223 DISPLAY:#LIBRARY : TQLIBRARY DISPLAY:# PROBE : GLOBALS, MONITOR FILE DISPLAY:# PROBE : IO, MONITOR FILE DISPLAY:# PROBE : TASKMON, MONITOR FILE. TQ

64 Probe Manager MONITOR Syntax SET RESET MONITOR MONITOR MONITOR? ( <monitor-list> ) PROBES = ( <probe-list> ) <monitor list>, PROBES = (<probe-list>) TIMING = <integer> DEFAULT RETAINDATA = <integer> <probe list>, <probe name> 3 20 TQ

65 Probe Manager <probe name> FAMILYIO GLOBALS IO LICENSE MIXTRACE MIXWORKLOAD MIXWORKLOADIO NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPVFBUFFER NAPVOICEFILE NAPRESOURCEGRP NAPNARESPONSETIME TASKMON <user defined probe name> SET RESET INQUIRE At any time At any time At any time Explanation The MONITOR command is used to activate or suspend probes that write performance data to the monitor file. The number of probes sampling and the frequency of sampling impacts the resource usage by the Probe Manager. You can control the disk space and the Probe Manager overhead by indicating which types of data are to be collected. By default, all probes are SET (activated) when the Probe Manager is started. The probes can be activated or suspended collectively or individually. If the PROBES option is not selected, all probes are SET or RESET. The SET command activates a probe that is not running, and the RESET command suspends a running probe. If a probe is in an error state, the SET and RESET commands have no effect. To restart a probe that has been suspended due to an error, terminate and restart the Probe Manager. TQ

66 Probe Manager Data in the monitor file is saved for a set length of time, the Probe Manager defaults to 4 hours. When the monitor file becomes full and new data is added, old data is removed. The length of time data is retained can be specified by the RETAINDATA option. The <integer> is the number of hours greater than or equal to 1 and less than or equal to 24. All active monitor probes sample at the same rate. The TIMING option allows you to specify the number of seconds between samples, the default being 60 seconds. The sample interval cannot exceed the interval specified on the RETAINDATA option. The user-defined probe name is 1 to 17 alphanumeric characters and must match the probe name specified on the SET LIBRARY command in the Parameters file. TeamQuest Online probes names include GLOBALS, FAMILYIO, IO, and TASKMON. Examples 1223 AX SET MONITOR (PROBES = (GLOBALS), TIMING = DEFAULT, RETAINDATA =6) 1223 DISPLAY:#MONITOR PROBE GLOBALS HAS BEEN STARTED DISPLAY:#MONITOR SAMPLING INTERVAL CHANGED TO 60 SECONDS (DEFAULT) DISPLAY:#MONITOR FILE CHANGED TO RETAIN 6 HOURS OF DATA AX MONITOR? 1223 DISPLAY:#MONITOR PROBE(S): DISPLAY:# GLOBALS : ACTIVE DISPLAY:#MONITOR TIMING = 60 SECONDS (DEFAULT) 1223 DISPLAY:#MONITOR RETAINDATA = 6 HOURS AX RESET MONITOR 1223 DISPLAY:#MONITOR PROBE GLOBALS HAS BEEN SUSPENDED TQ

67 Probe Manager MONITORDATABASE Syntax SET MONITORDATABASE ( <files option> ) MONITORDATABASE? <files option> FAMILYNAME, = <family name> DIRECTORY = <directory name> SET RESET INQUIRE At initialization Never At any time Explanation The MONITORDATABASE command controls disk storage for the TeamQuest SMFII monitor data files. The SET MONITORDATABASE command allows you to specify the disk family or directory name for the monitor data files. The MONITORDATABASE form of this command allows you to inquire where the monitor database files are written. If FAMILYNAME is not specified, the Probe Manager uses the default family of DISK. If the DIRECTORY is not specified, the Probe Manager generates the data files under the default directory TQ/SMFII/MONITOR/ACTIVE_ or TQ/ONLINE/MONITOR/ACTIVE_. Note: The <directory name> and <family name> specified on the MONITORDATABASE command must be different than the <directory name> or <family name> specified on the DATABASE command. Example SET MONITORDATABASE (DIRECTORY=TQ/SMFII/MONITOR/PROBEMGRDB/=,FAMILYNAME=USERPACK); TQ

68 Probe Manager PORT Note: This command is not available for TeamQuest Online. Syntax SET PORT <id> = ( <port spec list> ) RESET PORT <id> <port numeric list> PORT? <id> <letter> /16\ <letter> <digit> <port numeric list>, <unsigned integer> <unsigned integer> - <unsigned integer> <port spec list> <port attribute part> <record layout part> <port attribute part> <required attributes> <optional attributes> 3 24 TQ

69 Probe Manager <required attributes> SAMPLERATE = <unsigned integer> ; PORTFILENAME = <quoted string> ; <unquoted string> <optional attributes> DKFILERECSIZE = DEFAULT ; PORTRECSIZE MAXCENSUS <unsigned integer> PORTUSERCODE = DEFAULT <id> <record layout part> DATAITEMS = ( <numeric item list> ; ) ; <bitbucket item list> <time item list> <string item list> <numeric item list>, NUMERIC <id> <location> ( <numeric attributes> ) <numeric attributes> FORMAT = U HEX TQ

70 Probe Manager <bitbucket item list> BITBUCKET <id> <location>, ( <numeric attributes> ) <time item list> TIME <id> [ <location> ], ( <time attributes> ) <time attributes> FORMAT = TIMEANDDATE DATEONLY TIMEONLY <string item list> SUBSTANDARD STRING LONG SUBSTANDARD DISPLAY, <id> <location> ( <string attributes> ) <string attributes> MAXSIZE = <integer>, FORMAT = A Z 3 26 TQ

71 Probe Manager <location> [ <integer> ]. [ <integer> : <integer> ] SET RESET INQUIRE At initialization At any time At any time Explanation The SET PORT command causes the Probe Manager to collect specified PORT information and store it in a designated disk file. If the RESET PORT command is used during run time, information is no longer collected for the appropriate port file during this run of the Probe Manager. The PORT command is RESET by default. For more information, see Examples Command in PARAMETERS file: SET PORT MCSINFO = (SAMPLERATE = 15; PORTFILENAME = "SYSTEM/CANDE/PORTINTERFACE"; DKFILERECSIZE = 13; PORTRECSIZE = DEFAULT; PORTUSERCODE = DEFAULT; DATAITEMS = ( % Timestamp in [0] % Cardinality in [1].[47:08] % Word[1] is reserved NUMERIC NUM1 [2] (FORM = HEX); TIME % Time 7 words TIME1 [3] (FORM = TIMEANDDATE), TIME2 [4] (FORM = TIMEONLY), TIME3 [5] (FORM = DATEONLY); BITBUCKET BUCKET1 [6] (FORM = HEX), BUCKET2 [7].[23:13] (FORM = U); TQ

72 Probe Manager % % Display strings have fixed length and are % considered part of the fixed location items. % They can begin on word or byte boundaries. % DISPLAY STRING DSTR1 [8].[39:08] (MAXSIZE = 6), % 6 Chars. DSTR2 [9].[07:08] (MAXSIZE = 12, FORM = A); % % Substandard strings have variable length. The slot % reserved for substandard strings contains the character % offset to the actual string. The first byte of the % actual string contains its length in characters. % SUBSTANDARD STRING SUBSTR1 [7].[09:10] (MAXSIZE = 20), % --- Contains the char offset to start of string SUBSTR2 [11].[07:08] (MAXSIZE = 50, FORM = Z); % % Long substandard strings have variable length. % The slot reserved for long substandard strings contains % the character offset to the actual string. The first % 2 bytes of the actual string contain its length in % characters. Long substandard strings are used for % those strings whose length might exceed 255 characters. % LONG SUBSTANDARD STRING LSTR1 [12].[45:15] (MAXSIZE = 310), % --- Contains the char offset to start of string LSTR2 [12].[20:10] (MAXSIZE = 300, FORM = A); ); % End of data items for this subfile. ); % End of this port declaration. Acknowledgment: 1223 DISPLAY: #PORT (1): SYSTEM/CANDE/PORTINTERFACE ACTIVATED AX RESET PORT <id> 1223 DISPLAY: #PORT (1): SYSTEM/CANDE/PORTINTERFACE DEACTIVATED AX PORT? 1223 DISPLAY: #PORT NOT RUNNING TQ

73 Probe Manager PRIORITY Syntax SET PRIORITY = <integer> PRIORITY? SET RESET INQUIRE At any time Never At any time Explanation The PRIORITY command is used to display or specify the priority of the Probe Manager. With this capability, the Probe Manager can run at an appropriate priority (usually high) without concern for usercodes, WFL queues, or operator intervention. The priority must be an integer value greater than or equal to 2, but less than or equal to 99. Examples 1223 AX SET PRIORITY = DISPLAY:#PRIORITY CHANGED TO AX PRIORITY? 1223 DISPLAY:#PRIORITY = QUIT Syntax QUIT This command can be entered at any time. Explanation The QUIT command terminates the Probe Manager. It provides an orderly termination of any associated programs and locks the output files. Example 1223 AX QUIT 1223 DISPLAY:#PROBEMGR WILL BE TERMINATED. TQ

74 Probe Manager SAMPLE or COLLECT Note: This command is not available for TeamQuest Online. Syntax SAMPLE COLLECT <probe name> <port id> ALL <probe name> CONFIGURATION ENVIRONMENT FAMILYIO GLOBALS IO IOTRACE LICENSE MIXTRACE MIXWORKLOAD MIXWORKLOADIO NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPVFBUFFER NAPVOICEFILE NAPRESOURCEGRP NAPNARESPONSETIME <user defined probe name> This command can be entered at any time TQ

75 Probe Manager Explanation The SAMPLE or COLLECT command instructs the Probe Manager to collect and store the specified set of information immediately into the history database. This command does not alter any timing variables previously specified. This command does not affect any sampling for the monitor file. The <probe name> must match a <probe name> specified on a SET LIBRARY statement in the Parameters file. The user-defined probe name is 1 to 17 alphanumeric characters and must match the <probe name> specified on the SET LIBRARY command in the Parameters file. Examples 1223 AX SAMPLE ALL 1223 DISPLAY:#PROBE GLOBALS DATA WILL BE COLLECTED AX COLLECT GLOBALS 1223 DISPLAY:#PROBE GLOBALS DATA WILL BE COLLECTED. TQ

76 Probe Manager STATUS Syntax STATUS? This command can be entered at any time. Explanation The STATUS command results in a display of the current resource usage of the Probe Manager. Statistics regarding sample counts and disk usage are also displayed. Example AX STATUS? 1223 DISPLAY:#TQ/SMFII/PROBEMGR Level : DISPLAY:#PROBEMGR OVERHEAD: 1.013% PROCESSOR,.0222% I/O DISPLAY:#TOTAL SEGMENTS WRITTEN SINCE LAST TF = DISPLAY:#HISTORY PROBE(S) SAMPLE COUNTS: DISPLAY: ENVIRONMENT = DISPLAY: GLOBALS = DISPLAY: IO = DISPLAY: IOTRACE = DISPLAY:#STORING HISTORY DATA UNDER TQ/SMFII/DATA/PROBEMGRDB ON DISK DISPLAY:#MONITOR PROBE(S): DISPLAY: GLOBALS : ACTIVE DISPLAY: IO : ACTIVE DISPLAY: TASKMON : ACTIVE DISPLAY:#MONITOR TIMING = 60 SECONDS (DEFAULT) DISPLAY:#MONITOR RETAINDATA = 4 HOURS (DEFAULT). Example AX STATUS? 1223 DISPLAY:#TQ/ONLINE/PROBEMGR Level : DISPLAY:#PROBEMGR OVERHEAD: 1.275% PROCESSOR,.0090% I/O DISPLAY:#MONITOR PROBE(S): DISPLAY:# GLOBALS :ACTIVE DISPLAY:# IO :ACTIVE DISPLAY:# TASKMON :ACTIVE DISPLAY:#MONITOR TIMING = 60 SECONDS (DEFAULT) DISPLAY:#MONITOR RETAINDATA = 4 HOURS (DEFAULT) TQ

77 Probe Manager TIMING Note: This command is not available for TeamQuest Online. Syntax SET TIMING = DEFAULT TIMING <timing specs>? ( <timing specs> ), <probe name> = DEFAULT <integer> <probe name> CONFIGURATION ENVIRONMENT FAMILYIO GLOBALS IO IOTRACE LICENSE MIXTRACE MIXWORKLOAD MIXWORKLOADIO NAPNETAPP NAPNIUUTIL NAPPORTUTIL NAPVFBUFFER NAPVOICEFILE NAPRESOURCEGRP NAPNARESPONSETIME <user defined probe name> TQ

78 Probe Manager SET RESET INQUIRE At any time Never At any time Explanation The TIMING command is used to specify rates for probes writing data to the history database. All values are specified in seconds and must be greater than 0. The frequency of sampling impacts the resource usage by the Probe Manager. The <probe name> must match a probe name specified on a SET LIBRARY statement in the Parameters file. The user-defined <probe name> is 1 to 17 alphanumeric characters and must match the <probe name> specified on the SET LIBRARY command in the Parameters file. Examples 1223 AX SET TIMING (GLOBALS = 15, IO = DEFAULT) 1223 DISPLAY:#HISTORY PROBE GLOBALS INTERVAL CHANGED TO 15 SECONDS DISPLAY:#HISTORY PROBE IO INTERVAL CHANGED TO 900 SECONDS (DEFAULT) AX SET TIMING = DEFAULT 1223 DISPLAY:#HISTORY PROBE GLOBALS INTERVAL CHANGED TO 60 SECONDS (DEFAULT) DISPLAY:#HISTORY PROBE IO INTERVAL CHANGED TO 900 SECONDS (DEFAULT) AX TIMING? 1223 DISPLAY:#HISTORY PROBE(S): DISPLAY:# GLOBALS :TIMING = 60 SECONDS (DEFAULT), ACTIVE DISPLAY:# IO :TIMING = 900 SECONDS (DEFAULT), ACTIVE TQ

79 Probe Manager TRANSFER or TF Note: This command is not available for TeamQuest Online. Syntax TRANSFER TF DIRECTORY = <directory name> <directory name> / <identifier> /= This command can be entered at any time. Explanation The TRANSFER or TF command closes the current data files without terminating the data collection process and changes the top-level directory names. If DIRECTORY is not specified, the nodes <date>/<time> are inserted into the current database directory name. For example, the directory TQ/SMFII/DATA/PROBEMGRDB/= is changed to ( <usercode> ) TQ/SMFII/DATA/<date>/<time>/PROBEMGRDB/= If DIRECTORY is specified, the database is transferred to the specified directory on the same family. The <directory name> is the same as on the DATABASE command, the module name must be specified. The keyword $HOSTNAME may be used anywhere in the <directory name> and the Probe Manager substitutes the actual hostname for $HOSTNAME. If a database is detected in the directory specified with the same $HOSTNAME, the transfer does not occur, the data is not overwritten. The TRANSFER command can be used in the Probe Manager PARAMETERS file. If used in the PARAMETERS file, a file transfer occurs before data collection is initiated. TQ

80 Probe Manager Examples 1223 AX TRANSFER 1223 PK150 2 FILES CHANGED IN (ABC)TQ/SMFII/DATA/PROBEMGRDB/= TO (ABC)TQ/ SMFII/DATA/110203/163059/PROBEMGRDB/= ON CMF 1223 DISPLAY:#PROBEMGR DISKFILE DIRECTORY NAME CHANGED AX TF DIRECTORY=TQ/SMFII/$HOSTNAME/PROBEMGRDB/= 1223 PK150 2 FILES CHANGED IN (ABC)TQ/SMFII/DATA/PROBEMGRDB/= TO (ABC)TQ/ SMFII/MARS/PROBEMGRDB/= ON CMF 1223 DISPLAY:#PROBEMGR DISKFILE DIRECTORY NAME CHANGED VERSION Syntax VERSION? This command can be entered at any time. Explanation The VERSION command displays the current version (Mark.Cycle.Patch) of the Probe Manager. The current version of the Probe Manager is also displayed when the Probe Manager is initialized and when the STATUS command is used. Example AX VERSION? 1223 DISPLAY:#TQ/SMFII/PROBEMGR Level : DISPLAY:#Copyright (C) TeamQuest Corporation. All Rights Reserved. Example AX VERSION? 1223 DISPLAY:#TQ/ONLINE/PROBEMGR Level : DISPLAY:#Copyright (C) TeamQuest Corporation. All Rights Reserved TQ

81 Probe Manager 3.3. Probe Manager Interfaces Despite the volume of data collected by the Probe Manager, some types of information are not measured. In particular, quantities such as response time and transaction processing volume are not provided by the MCP. These data items typically lie in the domain of the Message Control System (MCS) or the application program. For this reason, the Probe Manager provides two interfaces which allow the collection of arbitrary application data, the LIBRARY interface and the PORTFILE communications interface. The Probe Manager does not have any semantic knowledge of this data, it simply collects the data and stores it in the TeamQuest SMFII history database or monitor file. The following subsections describe the functions of the LIBRARY interface and the PORTFILE communications interface. Note: This feature is not available for TeamQuest Online LIBRARY Interface The LIBRARY interface provides a programmatic interface for adding information to the TeamQuest SMFII historical database, as well as the monitor file. Figure 3 1 represents the routines provided by the Probe Manager and each probe. Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Sample_Probe Define_Weight_Factor Get_Workload_Info Define_Key_Value Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 1. Probe Manager and Probe Library Routines TQ

82 Probe Manager The TeamQuest SMFII Probe Manager routines provide The Define_Dbitem routine to define the database items supplied by a probe for the TeamQuest SMFII historical database and monitor file The Define_Key_Dbitem and Define_Key_Value routines to define resource and workload information supplied by a probe for both the historical database and monitor file The Smfii_Write routine to write information to the TeamQuest SMFII database or the monitor file The Get_Config_Info routine to obtain specific probe text specified on the CONFIGURE command The Define_Characteristics routine to register the characteristic values that may be used in a workload definition in the TeamQuest SMFII database The Get_Workload_Info routine to retrieve the workload definitions from the TeamQuest SMFII database The TeamQuest SMFII Probe Manager expects each probe to provide a set of routines that allows the Probe Manager to control the activities of the probe. You determine if the probe is used to save data to the TeamQuest SMFII historical database, the monitor file, or both. Each probe provides The Initialize_Probe routine to describe the probe to the Probe Manager The Sample_Probe routine to call when a data sample is requested The Enable_Probe, Disable_Probe, and Terminate_Probe routines to supply execution control information to the probe The Configure_Probe routine to inform the probe that a configuration change has occurred These routines are described in through Each routine includes a description, the associated return values, input and output parameters, and the ALGOL interface. The source code for an example of the Probe Library is supplied on the release tape and is named TQ/SMFII/PROBE/EXAMPLE TQ

83 Probe Manager Data Types The LIBRARY interface supports numeric, string, and time and date formats for data items. Numeric data can be stored in either a full word or a partial word. Two default display formats for the Query program are supported. The universal (U) format provides a decimal display of either fixed or exponential format, depending on the data value. The hexadecimal format allows Query to display the data as hexadecimal digits. The following numeric data types are supported: Value Description Full word, display format U Bit field, display format U Bit field, display format hex String data types can be used to store character information in the TeamQuest SMFII database. Three string data types are provided: display, substandard, and long substandard. Display strings have a fixed length. The location information for a display string identifies the position in the data record of the first character of the string. Substandard strings and long substandard strings are variable in length. The location information points to a link bit field in the data record that specifies the byte offset to the start of the string. A substandard string consists of a one-byte length field followed by the actual string characters. A long substandard string consists of a two-byte length field followed by the actual string characters. The length specified in the length field, for a substandard or long substandard string includes the length of the string and the length of the length field. A substandard or long substandard string should be placed after all fixed length items in the data record. The following identifies the supported string data types: Value Description Display string Substandard string Long substandard string TQ

84 Probe Manager Time and date information can be stored in the TeamQuest SMFII database. The time and date information must be supplied in TIME(7) format. The following time and date data types are supported: Value Description Timestamp with date-only Timestamp with time-only Timestamp with date and time Probe Manager Program Control Flow During the course of the Probe Manager execution, several routines are called. This subsection describes a sequence of procedure calls that can occur. Various tasks, such as program initialization, have been described separately. Initializing the Probe Starting the Probe Sampling Performance Data Stopping the Probe Terminating the Probe Configuring the Probe Initializing the Probe During the initialization of the Probe Manager, the Initialize_Probe routine is called by the Probe Manager library. The Initialize_Probe routine calls the Define_Dbitem routine to identify the database items supplied by the probe. The database item information provided on the Define_Dbitem call is used to create the SYMBOLTABLE file, which is used by the TeamQuest View and Query programs. If the optional resource key value (see 2.3) is used, the probe calls the Define_Key_Dbitem routine. Information for the CONFIGURE command in the Probe Manager Parameters file is also available with the Get_Config_Info routine. If the optional workload set and workload key values (see 2.3) are used, the probe calls the Define_Key_Dbitem and Define_Characteristics routines TQ

85 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Define_Weight_Factor Get_Workload_Info Define_Key_Value Sample_Probe Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 2. Initializing the Probe Starting the Probe Before data collection begins, the Probe Manager calls the Enable_Probe routine. This call informs the probe that sampling is about to begin. At this time, the probe may need to perform some initialization. If the optional resource key value is used, the probe calls the Define_Key_Value routine with a complete list of the resources it is sampling. If the optional workload set and workload key values are used, the probe calls the Get_Workload_Info routine to obtain the list of workload sets and workloads to be processed. The probe can be started at any time while the Probe Manager is running. The Enable_Probe routine is called when the Probe Manager has received a SET HISTORY or SET MONITOR command. TQ

86 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Define_Weight_Factor Get_Workload_Info Define_Key_Value Sample_Probe Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 3. Starting the Probe Sampling Performance Data The Probe Manager schedules when the probe samples the performance data. When a sample is to be taken, the Probe Manager calls the Sample_Probe routine. When the performance data has been collected, the probe calls the Smfii_Write routine to store the performance data in the history database or monitor file. If the optional resource key value is used, the probe may detect new resources which need to be sampled. The probe lists the new resources, and using the Define_Key_Value routine, the Probe Manager merges this list with the existing set of resource keys. The probe can immediately begin writing data for the new resource TQ

87 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Define_Characteristics Define_Weight_Factor Get_Workload_Info Define_Key_Value Enable_Probe Sample_Probe Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 4. Sampling Performance Data Stopping the Probe The probe can be stopped at any time while the Probe Manager is running. The Disable_Probe routine is called when the Probe Manager receives a RESET HISTORY or RESET MONITOR command. TQ

88 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Sample_Probe Define_Weight_Factor Get_Workload_Info Define_Key_Value Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 5. Stopping the Probe Terminating the Probe The Probe Manager calls the Terminate_Probe routine when the AUTOQUIT option has expired or when you enter a QUIT command. The Terminate_Probe routine is a final chance for the probe to perform any clean-up work TQ

89 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Define_Weight_Factor Get_Workload_Info Define_Key_Value Sample_Probe Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 6. Terminating the Probe Configuring the Probe The Configure_Probe routine is called when the CONFIGURE command is issued to the Probe Manager. This informs the probe that you have changed the configuration for the probe. The probe then calls the Get_Config_Info routine to retrieve the new configuration information. The use of the CONFIGURE information is optional. A probe may require additional information to properly collect performance data. The text provided on the INFO field of the CONFIGURE command is defined by the probe. The probe is responsible for parsing the string of EBCDIC characters. TQ

90 Probe Manager Probe Manager Library Probe Library Define_Dbitem Initialize_Probe Define_Key_Dbitem Enable_Probe Define_Characteristics Sample_Probe Define_Weight_Factor Get_Workload_Info Define_Key_Value Disable_Probe Terminate_Probe Configure_Probe Smfii_Write Get_Config_Info Figure 3 7. Configuring the Probe 3 46 TQ

91 Probe Manager Define_Dbitem The Define_Dbitem routine describes a database item to the Probe Manager. This procedure is called from an Initialize_Probe procedure within a probe library. An attempt to call Define_Dbitem other than during Initialize_Probe results in error. Define_Dbitem must be called for each database item and database type. If a probe supports both the history database and monitor file, the database item can be defined for both database types on the same Define_Dbitem call or separate calls. The probe is not required to collect the same data for history reporting as opposed to monitor reporting. The database item TIMESTAMP should not be defined by any probe. This is automatically defined by Query. Any attempt to define a previously defined database item results in an error. This applies to database items defined by all probes. Words 0 and 1 are reserved for use by the Probe Manager. Word 0 is reserved for the timestamp in TIME(7) format of the sample. The probe has the option of supplying the timestamp or letting the Probe Manager add it. Word 1 is reserved for a cardinality field and a field reserved for future use. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num an internal identifier of the probe that is defining database items. Dbitem_Name points to a structure with the name of the database item being defined. The structure is a length byte followed by 17 or fewer EBCDIC characters. TQ

92 Probe Manager Smfii_Type identifies the data type of the database item. Valid values are Word indicates the word offset of the database item in the record written to the database. For Smfii_Type of Smfii_Stringv and Smfii_Longstringv, this indicates the word offset of the string link field. Start indicates the bit index within Word where the database item starts. For Smfii_Type of Smfii_Stringv and Smfii_Longstringv, this indicates the bit index within the word where the string link field starts. Len Define Value Description Smfii_Wordv 0 Full word, display format U Smfii_Fieldv 1 Bit field, display format U Smfii_Bitv 2 Bit field, display format hex Smfii_Displayv 3 Fixed length string Smfii_Stringv 4 Variable length string, one-byte length field Smfii_Longstringv 5 Variable length string, two-byte length field Smfii_Datev 6 Timestamp with date only Smfii_Timev 7 Timestamp with time only Smfii_Dateandtimev 8 Timestamp with date and time indicates the length in bits of the field within Word. For Smfii_Type of Smfii_Stringv and Smfii_Longstringv, Len is the length of the string link field. Maxlen indicates the maximum length of the database item when Smfii_Type is Smfii_Displayv, Smfii_Stringv, or Smfii_Longstringv. Default_Consolidation_Type identifies the consolidation characteristics of a numeric database item (Smfii_Types of Smfii_Wordv, Smfii_Fieldv, and Smfii_Bitv). The remainder of the Smfii_Types are assumed to have a default_consolidation_type of 0. These definitions are used When correlating, database items with a default_consolidation_type equal to 0 are not correlated against. When correlating, numeric data is grouped together based on the default_consolidation_type for the database item TQ

93 Probe Manager When DEFAULT is specified for a value type key in a report request, the value returned is calculated as specified by the default_consolidation_type. Valid default consolidation types are 0 Consolidation types do not apply to this database item 1 Average 2 Minimum 3 Maximum 4 Summation 5 Last Database_Type identifies that the database item is to be defined for either the history database, monitor file, or both. The fields within Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None TQ

94 Probe Manager ALGOL Interface BOOLEAN PROCEDURE DEFINE_DBITEM (PROBE_NUM,DBITEM_NAME,SMFII_TYPE,WORD,START,LEN,MAXLEN,DEFAULT_CONSOLIDATION_TYPE,DATABASE_TYPE ); VALUE PROBE_NUM,DBITEM_NAME,SMFII_TYPE,WORD,START,LEN,MAXLEN,DEFAULT_CONSOLIDATION_TYPE,DATABASE_TYPE ; POINTER DBITEM_NAME ; INTEGER PROBE_NUM,SMFII_TYPE,WORD,START,LEN,MAXLEN,DEFAULT_CONSOLIDATION_TYPE ; REAL DATABASE_TYPE ; 3 50 TQ

95 Probe Manager Define_Key_Dbitem The Define_Key_Dbitem routine identifies the database item that is used as the selection key by TeamQuest View. If this probe is to support workloads, it must define both a workload set and a workload key dbitem. This procedure is called from the Initialize_Probe procedure within a probe library. An attempt to call Define_Key_Dbitem other than during Initialize_Probe results in an error. The Key Dbitem is a database item that was previously defined by Define_Dbitem. Dbitems of Smfii_Types (Smfii_Wordv, Smfii_Fieldv, Smfii_Bitv, Smfii_Displayv, Smfii_Stringv, and Smfii_Longstringv) are legal Key Dbitems. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe that is defining the Key_Dbitem. Key_Type is an integer that identifies the key that is being defined. The following values represent the current keys (other than the file name, Dbitem, and Value Type keys), which TeamQuest SMFII supports: Value Meaning Resource key Workload key Workload set key TQ

96 Probe Manager Key_Dbitem points to a structure with the name of the resource item being defined. The structure is a length byte followed by 17 or fewer EBCDIC characters. Define_Dbitem must be called previously identifying the attributes for this database item. Database_Type identifies that the key database item is to be defined for the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE DEFINE_KEY_DBITEM (PROBE_NUM,KEY_TYPE,KEY_DBITEM,DATABASE_TYPE ); VALUE PROBE_NUM,KEY_TYPE,KEY_DBITEM,DATABASE_TYPE ; POINTER KEY_DBITEM ; INTEGER PROBE_NUM,KEY_TYPE ; REAL DATABASE_TYPE ; 3 52 TQ

97 Probe Manager Define_Key_Value The Define_Key_Value routine identifies a valid value or values for the database item that is used as a selection key by TeamQuest View. This procedure is implemented in the Probe Manager and is called from the probe library. For the Probe Manager to maintain a complete list of key values for a probe, the probe must call Define_Key_Value with the entire list of key values during Enable_Probe. As key values are added, the probe can call Define_Key_Value with a list of additional key values. An error results if the probe attempts to call Define_Key_Value during Initialize_Probe. Return Value True if successful. False if an error detected. Input Parameter Probe_Num is an internal identifier of the probe that is defining key values. Key_Type is an integer that identifies the key being defined. The following values represent the current keys (other than the Filename, Dbitem, and Value Type keys), which TeamQuest SMFII supports: Value Meaning 1 Resource key Key_Value_List is a structure with the name of the key values being defined. The structure of the key value list has the following format: Word n Description Number of key value list entries Size (in words) of each key value entry First key value entry The probe identifies the number of entries in the list and the size (in words) of each entry. The entry size is determined by the attributes of the key database item, defined on the Define_Dbitem call. The entry length of Smfii_Types (Smfii_Wordv, Smfii_Fieldv, Smfii_Bitv, Smfii_Datev, Smfii_Timev, and Smfii_Dateandtimev) should be one word. All partial word Smfii_Types are assumed to be right-justified and zero-filled for the remainder of the word. TQ

98 Probe Manager The entry length for Smfii_Types (Smfii_Displayv, Smfii_Stringv, and Smfii_Longstringv) is defined by the Maxlen parameter on the Define_Dbitem call. Since Maxlen is specified in characters (bytes), Maxlen must be converted to a word size. The field size is calculated as entry_len = (Maxlen + 5) DIV 6 All strings are left-justified EBCDIC characters and space-filled. Smfii_Stringv and Smfii_Longstringv have the length bytes precede the string as it is written in the database record. Database_Type identifies that the key values are to be defined for the history database, monitor file, or both. Fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE DEFINE_KEY_VALUE (PROBE_NUM,KEY_TYPE,KEY_VALUE_LIST,DATABASE_TYPE ); VALUE PROBE_NUM,KEY_TYPE,DATABASE_TYPE ; ARRAY KEY_VALUE_LIST [0] ; INTEGER PROBE_NUM,KEY_TYPE ; REAL DATABASE_TYPE ; 3 54 TQ

99 Probe Manager Define_Characteristics The Define_Characteristics routine allows a probe to identify valid characteristics which the probe allows in a workload definition. See for information to assist you in creating a workload definition. This procedure is implemented in the Probe Manager and is called from the probe library. This routine is called during the Initialize_Probe procedure from within a probe library. An attempt to call Define_Characteristics other than during the Initialize_Probe routine results in an error. The probe must have previously called Define_Key_Dbitem to identify both a workload set dbitem and a workload dbitem. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe that is defining characteristics. Characteristic_List is a structure with the number of characteristics and the names of the characteristics being defined. The structure of the characteristic list has the following format: Word 0 1 n Description Number of characteristics in list First characteristic entry Each characteristic entry has the following format: Word Description 0 3 Characteristic name. Can be up to 23 EBCDIC left-justified, space-filled characters. A characteristic name may not include a space. 4 Kind: 0=value, 1=identifier. For example, a taskname is an identifier, cpu time would be a value. 5 Type: 0=integer, 1=real, 2=string. 6 For type=2 (string), the maximum length allowed for the string. TQ

100 Probe Manager Output Parameters None ALGOL Interface BOOLEAN PROCEDURE DEFINE_CHARACTERISTICS (PROBE_NUM,CHARACTERISTIC_LIST ); VALUE PROBE_NUM ; INTEGER PROBE_NUM ; ARRAY CHARACTERISTIC_LIST [0] ; 3 56 TQ

101 Probe Manager Define_Weight_Factor The Define_Weight_Factor routine identifies how TQDATA should consolidate the database values when computing a statistic by the Average value type. Multiple probe samples may fall within a report interval, in which case TeamQuest View reports an average value for that report interval. In consolidating an average value, the following algorithm is used: where: Average Value = Σ(dbitem * weight factor) / Σ(weight factor) dbitem weight factor is the parameter for the report. is defined in the symbol table for the parameter. This procedure is called from an Initialize_Probe procedure within a probe library. An attempt to call Define_Weight_Factor other than during Initialize_Probe results in error. Define_Weight_Factor identifies two dbitems, both of which need to be previously defined through a Define_Dbitem call. If either dbitem has not been previously defined, Define_Weight_Factor returns an error. Define_Weight_Factor must be called for each database item and database type for which you want a weight factor. If a probe supports both the history database and monitor file, the weight factor can be defined for both database types on the same Define_Weight_Factor call or separate calls. If a weight factor is not defined, TQDATA calculates a simple average value for a statistic; the sum of the samples divided by the number of samples. For the majority of the statistics, a simple average value is acceptable. There are some statistics where a simple average does not produce the correct result. For example, response time statistics, such as COMSAVGRESP from the COMS probe, should be weighted by the number of transactions. Define_Weight_Factor allows the probe to identify an optional weight factor for a statistic to be used when TQDATA calculates an Average value type. Depending upon the definition of the dbitem, one of the following four weight factors can be used to compute the Average value type: Simple Average This is the default method for computing an Average value type statistic. The average calculation is Average Value = Σdbitem / number of samples Report Interval This is the length of the sample used to weight the value. A reserved field in the database record [1].[31:32] contains the time, in seconds, since the previous sample. This field is maintained by the probe. This factor allows TQDATA to properly weight samples that are not the same as the length of the report interval. The average calculation is Average Value = Σ(dbitem * sample time) / report granularity TQ

102 Probe Manager Sample Interval This uses the internal sample time field which is maintained by the probe in the database record. The average calculation is Average Value = Σ(dbitem * sample time) / Σsample time Dbitem This is another dbitem in the database record that is specified as the weight factor. The COMSAVGRESP example is weighted by the dbitem COMSTRANCOUNT. The calculation is then the total response time divided by the number of transactions. The average calculation is Average Value = Σ(dbitem * weight dbitem) / Σweight dbitem Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe that is defining the weight factor. Weight_Factor a real array that identifies the weight factor for a dbitem when consolidating data by average. The weight factor is one of four types allowed by the Probe Manager that affects how TQDATA computes the Average value type for the specified dbitem. The format for Weight_Factor is Word Description 0 Weight type (0=simple average, 1=by report, 2=by sample, 3=by dbitem). 1 3 Source dbitem in which TeamQuest View uses the weight factor when computing an Average value type. Consists of up to 17 EBCDIC left-justified, null (48"00") terminated characters. Length byte followed by 17 or fewer EBCDIC characters. 4 6 Weighting dbitem (only specified for weight type=3). Consists of up to 17 EBCDIC left-justified, null (48"00") terminated characters TQ

103 Probe Manager Database_Type identifies that the weight factor is to be defined for the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE DEFINE_WEIGHT_FACTOR (PROBE_NUM,WEIGHT_FACTOR,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; ARRAY WEIGHT_FACTOR [0] ; REAL DATABASE_TYPE ; TQ

104 Probe Manager Smfii_Write The Smfii_Write routine writes a record to the TeamQuest SMFII history database or monitor file. This procedure is called from the Sample_Probe procedure within a probe library. The Probe Manager writes the record to the appropriate history database or monitor file. Using the Database_Type parameter, the probe signals the Probe Manager which database to select. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe that has collected the data to be written to the TeamQuest SMFII history database or monitor file. Record_Len is the number of words in the record that is to be written to the TeamQuest SMFII history database or monitor file. Record_Buff is an array that contains the data to be written to the TeamQuest SMFII history database or monitor file. If Record_Len exceeds the MAXRECSIZE for the file, Smfii_Write breaks the record into multiple physical records. In this case, the contents of Record_Buff are altered by Smfii_Write. Database_Type identifies that the database item is to be defined for either the history database, monitor file, or both. The fields within Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None 3 60 TQ

105 Probe Manager ALGOL Interface BOOLEAN PROCEDURE SMFII_WRITE (PROBE_NUM,RECORD_LEN,RECORD_BUFF,DATABASE_TYPE ); VALUE PROBE_NUM,RECORD_LEN,DATABASE_TYPE ; INTEGER PROBE_NUM,RECORD_LEN ; ARRAY RECORD_BUFF [0] ; REAL DATABASE_TYPE ; TQ

106 Probe Manager Get_Config_Info The Get_Config_Info routine provides a probe with the information supplied by the CONFIGURE command. Use of the information supplied by the CONFIGURE command is optional and is not required by many probes. If the probe does support the CONFIGURE command, this procedure is typically called from the Configure_Probe procedure within a probe library. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe. This number is assigned by the Probe Manager during initialization. Database_Type identifies whether the database item is to be defined for either the history database, monitor file, or both. The fields within Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Info_Buf contains the <probe specific text> supplied by the user on the CONFIGURE command. Word 0 of Info_Buf contains the number of characters. The characters contained in Info_Buf start in word 1. Output Parameters None 3 62 TQ

107 Probe Manager ALGOL Interface BOOLEAN PROCEDURE GET_CONFIG_INFO (PROBE_NUM,DATABASE_TYPE,INFO_BUF ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; ARRAY INFO_BUF [0] ; Get_Workload_Info The Get_Workload_Info routine provides a probe with the workload set and workload information defined in the history database. The workload set and workload information had previously been defined using the TeamQuest View interface. The probe only calls this routine if it supports workload sets and workloads. Typically, the probe calls this routine during the Enable_Probe routine. It is possible that workloads are not defined in the database. The probe must account for this case and handle it appropriately. Return Value True if successful. False if an error is detected. Input Parameter Probe_Num is an internal identifier of the probe that is defining characteristics. TQ

108 Probe Manager Output Parameters Workload_List is a structure with the names of active workload sets, names of workloads, and the workload definitions as they are defined in the database. Get_Workload_Info resizes the array, if necessary. The structure of the workload list has the following format: Word 0 1 n Description Number of workload sets in list First workload set entry Each workload set entry has the following format: Word Description 0 Entry size (in words including size word) 1 9 Workload set name. Up to 51 EBCDIC left-justified, zero-filled characters. 10 Active (0=inactive, 1=active). Typically, a probe only collects data for an active workload set. 11 Workload count 12 n First workload entry Each workload entry has the following format: Word Description 0 Entry size (in words including size word) 1 9 Workload name. Up to 51 EBCDIC left-justified, zero-filled characters. 10 Workload definition size (in characters) 11 n Workload definition. Up to 8,192 EBCDIC left-justified, zero-filled characters TQ

109 Probe Manager ALGOL Interface BOOLEAN PROCEDURE GET_WORKLOAD_INFO (PROBE_NUM,WORKLOAD_LIST ); VALUE PROBE_NUM ; INTEGER PROBE_NUM ; ARRAY WORKLOAD_LIST [0] ; Initialize_Probe The Initialize_Probe routine describes certain attributes of a probe to the Probe Manager. This procedure is implemented within a probe library but called by the Probe Manager. The probe needs to inform the Probe Manager to which database it intends to write its data. The probe can be designed to save data in the TeamQuest SMFII history database, TeamQuest SMFII monitor file, or both. The Probe Manager routines Define_Dbitem, Define_Key_Dbitem, and Define_Characteristics should only be called during Initialize_Probe. Define_Key_Dbitem should only be called if the probe supports keys in addition to a database item. The Define_Characteristics routine should only be called if the probes support the workload set and workload keys. The probe should not call Smfii_Write during Initialize_Probe. The Probe Manager maintains a separate SYMBOLTABLE file for the history database and monitor file. Define_Dbitem and Define_Key_Dbitem must be called to build both symbol tables. The database items are not required to be the same for both the history database and monitor file, if both are supported. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe being initialized. Probe_Name points to a structure with the name of the probe. The structure is a length byte followed by 17 or fewer EBCDIC characters. TQ

110 Probe Manager Output Parameters History_Support is set to TRUE to indicate the probe supports writing of data to the TeamQuest SMFII history database. History_List is a structure that provides information about how the probe intends the data to be written to the TeamQuest SMFII history database. History_List does not need to be initialized if History_Support is FALSE. The format is WORD 0 WORD 1 WORD 2 WORD 3 Maxrecsize Blocksize Sample_Interval Do_Timestamp where: Maxrecsize Blocksize Sample_Interval Do_Timestamp is the number of words in a TeamQuest SMFII history database record for this probe. The probe can pass Smfii_Write a buffer larger than Maxrecsize, and Smfii_Write breaks the logical record into smaller physical records. is the number of words in a block for the TeamQuest SMFII history database file for this probe. is the default number of seconds between each sample for this probe. is set to TRUE to indicate that the Probe Manager puts a timestamp in records written by this probe. Do_Timestamp is set to FALSE to indicate that this probe puts a TIME(7) timestamp in each record. The timestamp is placed in word 0 of the record. It is suggested that the probes that write more than one logical record per sample, write the timestamp. The timestamp is then guaranteed to be the same across every record for that sample. Monitor_Support is set to TRUE to indicate the probe supports writing of data to the TeamQuest SMFII monitor file TQ

111 Probe Manager Monitor_List is a structure that provides information about how the probe intends the data to be written to the TeamQuest SMFII monitor file. Monitor_List does not need to be initialized if Monitor_Support is FALSE. The format is WORD 0 WORD 1 WORD 2 WORD 3 Maxrecsize Blocksize Reserved Do_Timestamp where: Maxrecsize Blocksize Reserved Do_Timestamp is the number of words in a TeamQuest SMFII monitor file record for this probe. Maxrecsize must be set to the absolute maximum buffer size, which can be sent to Smfii_Write. The TeamQuest SMFII monitor file does not allow the logical record to be broken into multiple physical records. is the number of words in a block for the TeamQuest SMFII monitor file for this probe. is reserved for future use. is set to TRUE to indicate that the Probe Manager puts a timestamp in records written by this probe. Do_Timestamp is set to FALSE to indicate that this probe puts a TIME(7) timestamp in each record. The timestamp is placed in word 0 of the record. It is suggested for the probes that write more than one logical record per sample write the timestamp. The timestamp is then guaranteed to be the same across every record for that sample. TQ

112 Probe Manager ALGOL Interface BOOLEAN PROCEDURE INITIALIZE_PROBE (PROBE_NUM,PROBE_NAME,HISTORY_SUPPORT,HISTORY_LIST,MONITOR_SUPPORT,MONITOR_LIST ); VALUE PROBE_NUM,PROBE_NAME ; INTEGER PROBE_NUM ; POINTER PROBE_NAME ; BOOLEAN HISTORY_SUPPORT,MONITOR_SUPPORT ; ARRAY HISTORY_LIST [0],MONITOR_LIST [0] ; Enable_Probe The Enable_Probe routine is used by the Probe Manager to inform the probe that the probe should be available to respond to sampling requests. This procedure is implemented within a probe library but called by the Probe Manager. If the probe supports both the history database and the monitor file, Enable_Probe must handle enabling both functions. The Define_Key_Value routine should be called for probes that support the Resource selection key. The Get_Workload_Info routine should be called for probes that support the workload set and workload keys. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe being enabled TQ

113 Probe Manager Database_Type identifies that the probe is to be enabled for either the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE ENABLE_PROBE (PROBE_NUM,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; TQ

114 Probe Manager Disable_Probe The Disable_Probe routine is used by the Probe Manager to inform the probe that the Probe Manager has stopped requesting samples. This procedure is implemented within a probe library but called by the Probe Manager. If the probe supports both the history database and the monitor file, Disable_Probe must handle disabling both functions. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe being disabled. Database_Type identifies that the probe is to be disabled for either the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE DISABLE_PROBE (PROBE_NUM,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; 3 70 TQ

115 Probe Manager Terminate_Probe The Terminate_Probe routine is used by the Probe Manager to inform the probe that the Probe Manager has stopped requesting samples and is terminating. This procedure is implemented within a probe library but called by the Probe Manager. If the probe supports both the history database, as well as the monitor file, Terminate_Probe must handle terminating both functions. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe being terminated. Database_Type identifies that the record is to be terminated for either the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE TERMINATE_PROBE (PROBE_NUM,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; TQ

116 Probe Manager Sample_Probe The Sample_Probe routine is used by the Probe Manager to request a data sample from the probe. The probe typically collects data and calls the Smfii_Write routine to add a record to the TeamQuest SMFII database or monitor file. This procedure is implemented within a probe library but called by the Probe Manager. If the probe supports both the history database, as well as monitor file, Sample_Probe must handle sampling both functions. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe being sampled. Database_Type identifies that the record is to be sampled for either the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE SAMPLE_PROBE (PROBE_NUM,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; 3 72 TQ

117 Probe Manager Configure_Probe The Configure_Probe routine is called by the Probe Manager program when you have issued the SET CONFIGURE command. Use of the information provided by the CONFIGURE command is optional and not required by many probes. If the probe requires the information provided by the CONFIGURE command, the probe typically calls the Get_Config_Info routine to retrieve the information and then processes it accordingly. This procedure is implemented within a probe library but called by the Probe Manager. Return Value True if successful. False if an error is detected. Input Parameters Probe_Num is an internal identifier of the probe that is notified of the configuration information. Database_Type identifies that the configuration information is available for either the history database, monitor file, or both. The fields in Database_Type are defined as Field [00:01] [01:01] Meaning monitor_support history_support A value of 1 in a field indicates the database type is supported. A value of 0 indicates the database type is not supported. Output Parameters None ALGOL Interface BOOLEAN PROCEDURE CONFIGURE_PROBE (PROBE_NUM,DATABASE_TYPE ); VALUE PROBE_NUM,DATABASE_TYPE ; INTEGER PROBE_NUM ; REAL DATABASE_TYPE ; TQ

118 Probe Manager Installing the Probe To establish a link between the Probe Manager library and the probe library, the TQ/SMFII/PROBEMGR/PARAMETERS file needs to be updated. To update this file, add a LIBRARY statement (see 3.2.9), which identifies the file title of the probe library object file. The Probe Manager now includes the new probe to collect performance data PORTFILE Communications Interface TeamQuest SMFII provides the PORTFILE Communications interface that allows the collection of data into the TeamQuest SMFII history database. This data is available for reporting by TeamQuest View or Query. This interface does not allow an application to save information in the monitor file. PORTFILE Characteristics (see 3.5.1) Specifying Data Items (see 3.5.2) Validating PORT Declarations (see 3.5.3) PORT Application Example (see 3.5.4) PORTFILE Characteristics PORTFILE is used as the communication interface between the Probe Manager and other tasks in the mix. One port file is declared in the Probe Manager with a maximum of five subfiles allowed. This allows up to five application programs or MCS to asynchronously communicate with the Probe Manager. For more information, see the I/O Subsystem Programming Guide. The PORTFILE interface has the following capabilities: Up to five subfiles are allowed for communication with other tasks in the system. The Probe Manager polls each subfile at a user-specified rate by transmitting a message containing a timestamp. The Probe Manager then reads any messages queued for each active subfile. If a message is not available, processing continues. Each message is timestamped and stored on disk. The Probe Manager functions are never affected by the port file interface; that is, the Probe Manager never waits for PORTFILE. Port file partners can come and go in the mix without affecting the Probe Manager. Data items obtained from subfiles are named by the user and are contained in the SYMBOLTABLE. The data collected can be stored in separate files. Disk file handling parallels the handling of the current Probe Manager data files TQ

119 Probe Manager The mapping of port file data into physical disk records, along with the timestamping and cardinality flagging of disk records, is controlled solely by the Probe Manager. You can specify the following interface attributes: Sampling rate in seconds Bottom node identifiers of the disk files being used to store port file data The MAXRECSIZE of each port disk file in words The subfile name (one for each partner task) The USERCODE for each partner task The MAXRECSIZE of each port file in words Names, data types, and physical locations in the port buffer of all data items to be passed Specifying Data Items The names and types of the data items to be collected are controlled by the Probe Manager PORT command (see ). These specifications define the physical layout of the buffer that is transmitted from an application program to the Probe Manager. Space must be reserved in WORD 0 and WORD 1 for the TIMESTAMP and CARDINALITY items that are stored by the Probe Manager. This rule is checked at parse time. By adopting this convention, data can be mapped into disk records without an additional string transfer operation Validating PORT Declarations Validation of the PORT declarations is done in the initialization phase of the Probe Manager. Errors result in termination of the Probe Manager. Validation includes the following: Space must be left for TIMESTAMP and CARDINALITY items. Item names must not conflict with other data items, including items in a different port or items collected by the Probe Manager. The port file record size must be consistent with the buffer layout. The disk file record size must be sufficient to hold all fixed-location items, including string link words. TQ

120 Probe Manager PORT Application Example To use the PORTFILE interface, follow these steps: 1. Include the PORT command in the TQ/SMFII/PROBEMGR/PARAMETERS file. 2. Modify the target application to communicate through the port. This normally involves declaring the port file and inserting the necessary logic to read and write data through it. Note: The TITLE of the target application PORTFILE must be set to SMFIIPORT and the YOURNAME file attribute must be set to SMFII/SAMPLER/PORT for the application port to match the Probe Manager port. The MYNAME of the target application PORTFILE must be set to match the PORTFILENAME set in the parameters file. PORT Command The following PORT command and example program demonstrate how port communications can be achieved between the Probe Manager and a target application. The Probe Manager PORT command (see ). For more information, see the I/O Subsystem Programming Guide. SET PORT EXAMPLEDATA = (SAMPLERATE = 10; PORTFILENAME = "PORT/EXAMPLE/DATA"; DKFILERECSIZE = DEFAULT; PORTRECSIZE = 12; PORTUSERCODE = DEFAULT; MAXCENSUS = 20; DATAITEMS = (TIME POLLTIME [2] (FORM = TIMEANDDATE), RESPONSETIME [3]; SUBSTANDARD STRING MESSAGE [4] (MAXSIZE = 40); ); ); 3 76 TQ

121 Probe Manager Example Program The following example shows a port example: BEGIN FILE PORTFILE (KIND = PORT, BLOCKSTRUCTURE = FIXED, FRAMESIZE = 48, MAXRECSIZE = 100, MAXSUBFILES = 1, SECURITYTYPE = PUBLIC, % So usercodes don t matter. TITLE = "SMFIIPORT." % Title of PROBEMGR port ); % must match PROBEMGR title. ARRAY BUFF [0:12], TEMP [0:44]; INTEGER COUNT, SUBINX, INX; POINTER PT; % % Set the YOURUSERCODE attribute to default, so that the usercode of % the subfile being looked for is the same as mine (MYSELF.USERCODE). % REPLACE PORTFILE(1).YOURUSERCODE BY "."; % % Set the YOURNAME attribute to the name of the subfile declared in % the SMFII PROBEMGR program. % REPLACE PORTFILE(1).YOURNAME BY "SMFII/SAMPLER/PORT."; % % Set the MYNAME attribute to match the PORTFILENAME. % REPLACE PORTFILE.MYNAME BY "PORT/EXAMPLE/DATA."; % % Fill the port buffer with blanks. % REPLACE POINTER(BUFF) BY ""FOR SIZE(BUFF) WORDS; % % Open the port file and wait until a matching subfile has been found. % OPEN(PORTFILE[SUBFILE 1],WAIT); % % While the subfile is open, loop % doing a READ(WAIT) and WRITE(DONTWAIT). % WHILE PORTFILE.FILESTATE EQL 3 DO BEGIN % TQ

122 Probe Manager % Wait for and read any messages sent from PROBEMGR. % READ(PORTFILE[SUBFILE SUBINX],3,BUFF); COUNT := * + 1; % % Build a message to send back to PROBEMGR. % PT := POINTER(TEMP); REPLACE PT:PT BY "PORT MSG # ", COUNT FOR * DIGITS, " FROM: PORT/EXAMPLE/DATA"; % % Assemble all the components of the message in the port buffer. % % WORD 0: EMPTY - Reserved. % WORD 1: EMPTY - Reserved. % WORD 2: Contains the TIMESTAMP sent by PROBEMGR. % WORD 3: A current TIME 7 entry. % WORD 4: The character offset to the string message being sent. % (Zero-Relative in this array) % WORD 5: The string message being sent, where.[47:08] is the % size of the string message. % BUFF[3] := TIME(7); BUFF[4] := 30; REPLACE POINTER(BUFF[5]) BY (OFFSET(PT) + 1).[7:48] FOR 1, POINTER(TEMP) FOR OFFSET(PT); % % Write the port buffer to PROBEMGR, but don t wait for I/O. % IF WRITE(PORTFILE[SUBFILE SUBINX,DONTWAIT],12,BUFF) THEN BEGIN % SUBFILEERROR - Include error handling code here if desired. END; END; END TQ

123 Section 4 TeamQuest SMFII Administration Interface Note: The TeamQuest SMFII Administration Interface is not available for TeamQuest Online. The TeamQuest SMFII Administration Interface is a browser-based interface that allows you to perform administrative tasks for workloads, alarms, and Probe Manager Policy. Read the following topics to learn more about the TeamQuest SMFII Administration Interface. Performing Administrative Tasks (see 4.1) Using the Interface (see 4.2) Using the Alarm Policy (see 4.3) Using the Workload Policy (see 4.4) Using the Probe Manager Policy (see 4.5) Maintaining System Licenses (see 4.6) TQ

124 TeamQuest SMFII Administration Interface 4.1. Performing Administrative Tasks To perform administrative tasks, the Probe Manager must be run on the Unisys MCP host system. The Probe Manager will create a Profile File that contains information for creating alarms and workloads. Once the Probe Manager is running on your host system, you will need to log in to the TeamQuest SMFII Administration Interface and select the appropriate database before you can perform the administrative tasks for the database Logging In To access the login screen for the TeamQuest SMFII Administration Interface, use the following Uniform Resource Locator (URL): where: system port Note: is the name of the system where TeamQuest SMFII is installed. is the port number assigned for TeamQuest http requests (port 2700 by default). For information on changing port numbers, see the TeamQuest Products Installation Guide for Unisys MCP Systems. If the port number has been changed during the start up of the TQDATA daemon, that port number must be used in the URL instead of the default port number of For more information, see the TeamQuest Products Installation Guide for Unisys MCP Systems. 4 2 TQ

125 TeamQuest SMFII Administration Interface After you enter the URL, the TeamQuest Login page is displayed. To begin a session, enter a valid Usercode and Password for the Unisys MCP system you are administrating. Your session remains active until you log out or exit your browser. Note: Usercode security attributes required to log in to the Administration Interface may be specified in the TQDATA/PARAMETERS file. For more information, see the TeamQuest Products Installation Guide for Unisys MCP Systems. TQ

126 TeamQuest SMFII Administration Interface When you have successfully logged in, the TeamQuest SMFII Administration Interface is displayed. The TeamQuest SMFII Administration Interface is automatically selected when you log in. The navigation bar on the left side of the page contains the links to the various pages of the TeamQuest SMFII Administration Interface where you will perform your administrative tasks. 4 4 TQ

127 TeamQuest SMFII Administration Interface Selecting a Database If you have more than one TeamQuest database on a system, you must select a database after you log in. When you click a link in the navigation bar for the first time in your session, TeamQuest SMFII displays the following page for you to select the database. The following is only an example of what might appear. If you have more than one TeamQuest SMFII database, all databases will be listed. Click the link of the database for which you are performing administrative tasks. TeamQuest SMFII redisplays the navigation bar on the left and displays the appropriate page for performing your task on the right. The Database field with the same name of the selected database will appear under the Welcome message in the logo/menu area. You can change your database selection at any time during your session by selecting the Database link in the logo/menu area at the top of each page. TQ

128 TeamQuest SMFII Administration Interface 4.2. Using the Interface All screens displayed within the TeamQuest SMFII Administration Interface have the following basic layout: Logo/Menu Area The logo/menu area contains information about your TeamQuest session. On the right side of the logo/menu area, the following are displayed: Host Welcome Database Contains the name of the host currently being accessed. Displays the user name that logged in to this session. Contains the name of the currently selected database. The Database link allows you to change the database for the session. 4 6 TQ

129 TeamQuest SMFII Administration Interface The TeamQuest menu bar appears at the bottom of logo/menu area. It provides access to the following: TeamQuest SMFII Help Site Map Logout Perform administrative tasks for your TeamQuest databases. Open a window containing the help topic for the particular page you are on. From the topic window, you can access the complete set of online documentation for TeamQuest SMFII. Display the list of all the links available through TeamQuest SMFII Administration Interface. Terminate and log out from your current TeamQuest session. Navigation Bar The navigation bar appears on the left side of the browser window and contains navigational links for the item you selected from the TeamQuest menu bar. The following navigation bar is displayed for TeamQuest SMFII. You can use the links to navigate to the various parts of TeamQuest SMFII Administration Interface. When you click a link, the appropriate pages are displayed in the content area. Many of the links have sublinks that are not visible when the navigation bar is initially displayed. For example, when you click the Alarm Policy link, you see additional links for Aliases and Actions. TQ

130 TeamQuest SMFII Administration Interface Content Area The content area contains the actual pages for performing administrative tasks. The content area can contain the task entry pages for viewing current administrative settings or the edit pages where the settings can actually be changed. The following shows how the content area appears when the Alarm List link is clicked in the navigation bar. For a description of the layout and controls that may appear in the content area, see the following: Using the Task Entry Pages (see 4.2.1) Using the Edit Pages (see 4.2.2) 4 8 TQ

131 TeamQuest SMFII Administration Interface Using the Task Entry Pages When you click a link in the navigation bar, the entry page for performing the tasks for that part of the interface is displayed. The following example shows a typical entry page. This particular page is the entry page for the Alarm Policy. Most entry pages contain the following elements: The title is displayed in the top left of the content area of the page. The main content of the page is displayed as tabular text with information about the particular administrative area. Above the main content table is a menu that provides links for performing the specific administrative tasks for the item you selected from the navigation bar. When you click a menu link, you enter edit mode for the particular task and additional pages are displayed that allow you to carry out the task. Within the main content table, some items appear in a different color. These items are links to additional pages. When you click one of these links, an edit page appears allowing you to edit the definition of the item or to modify the settings of the item. TQ

132 TeamQuest SMFII Administration Interface Using the Edit Pages When you click one of the links on a task entry page, TeamQuest SMFII displays the edit pages that allow you to perform the administrative task for that part of the interface. You may be presented with a sequence of pages that lead you through the particular choices for carrying out the task, or you may simply see a single edit page with the fields required to edit the various settings. For example, the following page is displayed for editing a workload set: Most edit pages contain the following elements: The title is displayed in the top left of the content area of the page. Under the title, confirmation messages will be displayed in red as you carry out the administrative tasks. The various fields that define the item (in this case, the workload set) are displayed with their current values. Next to the fields that can be modified, an Edit link (or another link such as Add or Order) appears. When you click the Edit link, the field opens to allow you to make your changes TQ

133 TeamQuest SMFII Administration Interface The buttons that appear at the bottom of the page allow you to actually carry out a task. The buttons that appear depend on the task you are performing. The Add and Save buttons apply your changes for the current page to the TeamQuest SMFII database. The Cancel button returns you to the edit page without saving any changes for the current page. The Finish button returns you to the entry page where you started. As you save your changes, the specifications are validated. If a field is not valid, an error message will be displayed under the field and the changes will not be saved until the field is corrected. Typical Edit Page Controls When you click an Edit link, various types of controls will appear depending on the type of setting you are editing. The following types of controls are the most common: Text box The text box, which is the most common control, allows you to type in free-form text. This text is validated on the server side to make sure it is correct for the setting. Check box A check box is used to select an item or to set or clear a setting. In some cases, where there is a list of check boxes, there may be a select-all check box at the top of the column. TQ

134 TeamQuest SMFII Administration Interface List box A list box allows you to select the appropriate setting from a list of available choices. Two list boxes From time to time, you may see two list boxes that you will use to make your specifications. The list box on the left contains all of the available items for the field. The list box on the right contains the items that you have selected for the specification. The Append button between the two boxes let you move selected items from one box to the other. If JavaScript is turned on, you can double-click an item to move it from one box to the other TQ

135 TeamQuest SMFII Administration Interface 4.3. Using the Alarm Policy TeamQuest SMFII Administration Interface Alarm Policy is used to manage the alarm definitions in your performance database. To learn more about configuring and managing alarms, read the following topics: TeamQuest SMFII Probe Manager (see 4.3.1) Default Alarm Definitions (see 4.3.2) Configuring Alarms (see 4.3.3) Configuring Aliases (see 4.3.4) Configuring Actions (see 4.3.5) TeamQuest SMFII Probe Manager The TeamQuest SMFII Probe Manager monitors the data being stored in the TeamQuest SMFII database and checks it against user-defined alarm conditions. If the data values meet the criteria in the user-defined alarm conditions, the Probe Manager generates an alarm to alert you that the condition has been met. When an alarm is generated, it is recorded by the Probe Manager for use with the other TeamQuest performance applications. You can view a history of the alarms that have been generated by looking at the table. Alarms can be viewed using TeamQuest View. TQ

136 TeamQuest SMFII Administration Interface Default Alarm Definitions A set of default alarm definitions is included with each performance database. You should carefully review and adjust the definitions to meet your needs. Use TeamQuest SMFII Administration Interface to modify the default alarms or to define additional alarms. Whenever a new TeamQuest SMFII database is created, the default set of alarm definitions is automatically included in the new database. By default, all of these alarm definitions are disabled. You can use TeamQuest SMFII to enable the alarm definitions (see ). The Probe Manager does not check the alarm conditions for alarm definitions that are disabled. Table 4 1 provides a description of the default alarms. Table 4 1. Default Alarm Descriptions Alarm Name Example_CPU_Busy Example_Sectors_In_Use Description The CPU usage exceeds a specified threshold. The sectors in use for a family exceeds a specified threshold TQ

137 TeamQuest SMFII Administration Interface Configuring Alarms The Alarm Policy of TeamQuest SMFII contains the alarm definitions for the selected database. The alarm definitions consist of the alarm name, the list of conditions that the Probe Manager checks to determine whether to raise or clear an alarm, and the list of actions that should be taken when the conditions are true for any of the condition listed in the alarm definition. Each alarm definition has one or more severity conditions (Critical, Major, Minor, and Warning) and an optional action specification for each severity condition. All administrative tasks for configuring alarms are performed through the Alarm List page of TeamQuest SMFII. From the Alarm List page, you can perform the following tasks: Viewing the Alarm List (see ) Adding an Alarm Definition (see ) Editing an Alarm Definition (see ) Deleting an Alarm Definition (see ) Changing the Status of an Alarm (see ) Activating Changes (see ) Notes: An alarm definition references alias and action definitions. You must define aliases and actions before referencing them in an alarm definition. There can be no embedded spaces in alarm, alias, and action names. TQ

138 TeamQuest SMFII Administration Interface Viewing the Alarm List To view the Alarm List: From the TeamQuest SMFII navigation bar, click the Alarm Policy link. The Alarm List page is displayed allowing you to perform your administrative tasks. Alarm List Field Descriptions The Alarm List page contains a summary of the alarms that are currently defined in the Alarm Policy of the selected database. The Alarm List page contains the following fields: Alarm Name Each alarm name appears as a link. If you click the link, you can view the details of the alarm definition or edit the alarm. Status The Status column contains the status of the alarm. The status can be either Enabled or Disabled. If an alarm is Enabled, the Probe Manager checks the conditions defined for the alarm to determine whether an alarm should be raised or cleared. A disabled alarm is not used for alarm checking by the Probe Manager. Severity The Severity column contains the severity of the alarm. Severity can be Critical, Major, Minor, or Warning. The severity is defined by specifying a set of conditions and an optional alarm action for that severity. An alarm definition can have more than one severity level. Each severity level has a different set of conditions. Condition The Condition column shows the set of expressions that are used to determine whether an alarm is to be raised. Each severity level has its own set of condition expressions. Action The Action column contains the name of the alarm action that is to be performed when the alarm is raised. Each severity level of the alarm can have its own action TQ

139 TeamQuest SMFII Administration Interface Adding an Alarm Definition Note: Before you begin to add an alarm definition to your Alarm Policy, make sure you have defined the aliases and actions that you will reference in the definition. See and To add a new alarm definition to the Alarm Policy: 1. From the Alarm List page, click the Add Alarm link. The Add Alarm Definition page is displayed. 2. Choose the type of alarm condition you want to define (Critical, Major, Minor, or Warning). Click the appropriate link. The next page in the Add Alarm Definition sequence is displayed allowing you to define the alarm. 3. In the Alarm Name field, type a name for the new alarm. This name cannot contain any embedded spaces. TQ

140 TeamQuest SMFII Administration Interface 4. In the Conditions field for the severity that you selected on the previous page, enter the information to define the conditions for the specific severity. You can enter multiple expressions to be checked for the alarm if needed, but you must enter at least one expression for each severity that is defined. The field can consist of one or more condition expressions. Each expression has an alias, an operator, and a value. a. From the Alias list box, select one of the predefined alias names. This field contains a list of the aliases that you have previously defined in the Alarm Policy. b. From the operator list box, select an operator for the expression. c. In the Value text box, type the numeric or string value to be tested when the Probe Manager performs condition checking. 5. In the Actions field for the severity that you selected, select one of the predefined actions from the list box. This field contains a list of the actions that you have previously defined in the Alarm Policy TQ

141 TeamQuest SMFII Administration Interface 6. When the condition expression for the severity level is complete, click the Add button. Your changes are saved to the alarm definition in the Alarm Policy. The Edit Alarm Definition page is displayed containing a summary of the new alarm. Using this page, you can make additional specifications for the new alarm. 7. To define additional severity conditions and actions: a. Click the Edit link located next to the appropriate Conditions field. The field opens to allow you to enter the new information. b. Enter the condition expression for the severity level. c. Select the predefined action for the severity level from the Actions list box. d. Click the Save button to save the information to the Alarm Policy. TQ

142 TeamQuest SMFII Administration Interface 8. To define the action to be taken when the alarm condition returns to normal: a. In the Normal Action field, click the Edit link. The field opens to allow you to enter the new information. b. From the list, select the predefined action. c. Click Save to save the information to the Alarm Policy. 9. To enter text that can be output in a console or SNMP message: a. In the Contact field, click the Edit link. This field opens to allow you to enter text that will be displayed on a console, command, or SNMP message. b. Click Save to save the information to the Alarm Policy. 10. To enter text that documents the alarm: a. In the Comment field, click the Edit link. This field opens to allow you to enter text that describes specific information about this alarm definition. b. Click Save to save the information to the Alarm Policy TQ

143 TeamQuest SMFII Administration Interface 11. To specify the amount of time to wait before or after raising an alarm: a. In the Delay Factors field, click the Edit link. The field opens to allow you to make your changes. b. In the Delay Before text box, type the number of seconds that the alarm conditions must be true before an alarm is raised. c. In the Delay After text box, type the number of seconds to wait to resume alarm checking after the alarm has been raised. d. Click Save to save the changes to the Alarm Policy. 12. To specify scheduling information for alarm checking: a. In the Schedule field, click the Edit link. The field opens to allow you to make your changes. b. In the Start and Stop text boxes, type the start and stop times in hh:mm format of 00:00 through 23:59. If start and stop times have been specified for an alarm, the Probe Manager only checks for the alarm during that time period. c. Click Save to save the changes to the Alarm Policy. 13. When the alarm definition is complete, click the Finished button. You are returned to the Alarm List page. The new alarm appears on the Alarm List page with its status set to Disabled. TQ

144 TeamQuest SMFII Administration Interface Add and Edit Alarm Definition Field Descriptions The Add and Edit Alarm Definition pages contain the following fields: Alarm Name This field cannot contain any embedded spaces. A default name of untitled_alarm is initially displayed in this field. This name is used for your alarm if you do not enter another value for Alarm Name. This name is also referred to as $(ALARM_ID) alarm identifier when used in an Action macro. severity Conditions A separate Conditions field appears for each severity (Critical Conditions, Major Conditions, Minor Conditions, and Warning Conditions). These fields contain the condition expressions that the Probe Manager checks to determine whether to raise or clear an alarm. The field consists of one or more condition expressions. Each expression has an alias, an operator, and a value. Alias contains a list of the predefined aliases that can be used in the condition expression. Operator contains the valid operators that can be used in the expression. Value is a numeric value that is to be tested for the expression. You must enter at least one expression for each severity that is defined. If needed, you can enter multiple expressions. severity Action A separate Action field exists for each severity level (Critical Action, Major Action, Minor Action, and Warning Action). This field indicates what action is to be taken when the conditions for the severity are true. The list box contains the action names that have been defined in the Alarm Policy of the selected database. This field is optional. Normal Action This field indicates what action is to be taken when the alarm clears (that is, all of the defined alarm conditions have returned to normal). The list box contains the action names that have been defined in the Alarm Policy of the selected database. This field is optional TQ

145 TeamQuest SMFII Administration Interface Contact This field is used to enter text that can be output to a console, command, or SNMP message. The text field can be used to send a message that indicates who should be contacted when this alarm is generated. This field is optional. Comment This field is used to enter text that describes specific information about this alarm definition that will not appear at reporting time. This field is optional. Delay Factors This field specifies Delay Before and Delay After values to be used for the alarm. Delay Before indicates how long the alarm conditions must be true before an alarm is raised. Delay After indicates how long alarm checking should be disabled for this alarm once an alarm is raised. These values are specified in number of seconds. One or both of the values can be specified. Schedule This field specifies the start and stop times for when the Alarm Service performs condition checking for the alarm. The times are specified using an hh:mm format of 00:00 through 23:59. If an alarm has start and stop times, the Probe Manager only checks the alarm conditions during that time period. TQ

146 TeamQuest SMFII Administration Interface Editing an Alarm Definition The Alarm List page contains the list of alarms that are defined in the Alarm Policy of the selected database. Each name is a link that can be selected to update, duplicate, or rename the alarm. To edit an alarm definition: 1. From the Alarm List page, click the name of the alarm in the Alarm Name column. The Edit Alarm Definition page is displayed. 2. To update any of the fields of the selected alarm: a. Click the Edit link next to the field. The field opens to allow you to make your changes. For a description of these fields, see Add and Edit Alarm Definition Field Descriptions on page b. Make your changes and click the Save button. The alarm definition is updated in the Alarm Policy TQ

147 TeamQuest SMFII Administration Interface 3. To give the alarm definition a different name: a. From the Edit Alarm Definition page, click the Rename button. The Rename page is displayed. b. In the New Name text box, type a new name for the alarm. The new name must be unique and cannot contain any embedded spaces. c. Click Save. The alarm is saved with its new name to the Alarm Policy. The old alarm definition no longer exists in the Alarm Policy. You are returned to the Edit Alarm Definition page with the new alarm name and definition displayed. 4. To create an alarm that is identical to the selected alarm: a. From the Edit Alarm Definition page, click the Duplicate button. The Duplicate page is displayed. b. In the New Name text box, type a new name for the alarm. The new name must be unique and cannot contain any embedded spaces. c. Click Save. The duplicate alarm is saved with a new name to the Alarm Policy. The old alarm definition remains in the Alarm Policy. You are returned to the Edit Alarm Definition page with the duplicate alarm definition displayed. 5. When your updates are complete, click Finished. You are returned to the Alarm List page Deleting an Alarm Definition To delete an alarm definition from the Alarm Policy: 1. From the Alarm List page, click the alarm name in the Alarm Name column. The Edit Alarm Definition page is displayed. 2. Click Delete. The Delete confirmation page is displayed. 3. Click Delete to permanently remove the alarm. The alarm definition is removed from the Alarm List page and from the Alarm Policy of the selected database. You are returned to the Alarm List page. TQ

148 TeamQuest SMFII Administration Interface Changing the Status of an Alarm The status of an alarm can be either Enabled or Disabled. When the alarm is enabled, the Probe Manager monitors the database, checks the data against your user-defined alarm conditions, and generates an alarm when the conditions are met. When the alarm is disabled, the Probe Manager does not check the alarm conditions for that alarm. By default, all alarm definitions are disabled. TeamQuest SMFII allows you to change the status of your alarms. To change the status of the alarms defined in the Alarm Policy of the selected database: 1. From the TeamQuest SMFII menu, click Alarm Policy. The Alarm List page is displayed. 2. On the Alarm List page, click the Change Status link. The Change Alarm Status page is displayed. 3. To enable or disable an individual alarm, select or clear the check box next to the alarm name. 4. To enable or disable all of the alarms, select or clear the check box next to the Status heading at the top of the column. Note: 5. Click Save. Any alarm that does not have any conditions defined will always have a status of Disabled. If you try to enable the alarm, it will be set to disabled. Your changes are saved to the Alarm Policy and you are returned to the Alarm List page TQ

149 TeamQuest SMFII Administration Interface Activating Changes Note: Enable alarms from the Control Center if alarms are not enabled by the Probe Manager. The TeamQuest SMFII database is constantly updated with new information as you make changes using the TeamQuest SMFII Administration interface. Your changes, however, are not actually activated until you notify the Probe Manager of the new specifications. To notify the Probe Manager of the changes you have made, you must click Activate Changes. The Probe Manager is sent the commands RESET ALARMS and SET ALARMS. This enables the alarm checking by interpreting the alarm definitions in the Profile File and evaluates the alarm condition. TQ

150 TeamQuest SMFII Administration Interface Configuring Aliases An alias definition provides a way to assign a short name for a parameter reference. Alias names are required in the conditions list of an alarm definition and can optionally be referenced in an alarm action specification. You must define an alias before it can be used in an alarm definition. All administrative tasks for configuring aliases are performed through the Alias List page of TeamQuest SMFII. From the Alias List page, you can perform the following tasks: Viewing the Alias List (see ) Adding an Alias Definition (see ) Editing an Alias Definition (see ) Deleting an Alias Definition (see ) Notes: An alarm definition references alias and action definitions. You must define aliases and actions before referencing them in an alarm definition. There can be no embedded spaces in alarm, alias, and action names TQ

151 TeamQuest SMFII Administration Interface Viewing the Alias List To view the Alias List: 1. From the TeamQuest SMFII navigation bar, click the Alarm Policy link. 2. Click the Aliases link under the Alarm Policy link. The Alias List page is displayed allowing you to perform your administrative tasks. Alias List Field Descriptions The Alias List page contains a summary of the alarm aliases that are currently defined in the Alarm Policy of the selected database. The Alias List page contains the following fields: Alias Name Each alias name appears as a link. If you click the link, you can view the details of the alias definition or edit the alias. Filename The filename column contains the file name that corresponds to the probe program name that performs the data collection. Dbitem The Dbitem column contains the name of the statistic stored in the TeamQuest SMFII database file. TQ

152 TeamQuest SMFII Administration Interface Adding an Alias Definition To add a new alias definition: 1. From the Alias List page, click the Add Alias link. The Add Alias Definition page is displayed. 2. From the list box, select the Filename for which you are creating the alias. 3. Click Select. The list of dbitems available for the selected Filename is displayed. 4. From the list box, select the Dbitem name for which you want to create the alias. 5. Click Select TQ

153 TeamQuest SMFII Administration Interface 6. If the Resource page appears, enter the resource for the alias. This page ony appears for some Filenames. a. Select the Resource from the list of resources. or b. Type the resource name in the edit box. c. Click Select. 7. If the Workload Set page appears, select the workload set from the list box. This field is only required for workload statistics. If there are multiple workload sets defined in your performance database, you must select the appropriate workload set for this alias from the list box. TQ

154 TeamQuest SMFII Administration Interface 8. If the Workload page appears, select the workload from the list box. This field is only required for workload statistics. 9. When the alias definition is complete, click the Add button. The final page of the Add Alias Definition sequence is displayed. This page provides a summary of the selection you have made for your new alias. An alias definition always requires an Alias Name, Filename, and Dbitem. Depending on the statistic you selected, the Workload Set, Workload, and Resource fields may also appear. 10. When your updates are complete, click Add. You are returned to the Alias List page. Add Alias Definition Field Descriptions The Add Alias Definition pages contain the following fields: Alias Name A unique name that cannot contain any embedded spaces. TeamQuest Manager supplies a default name. You can use this name or supply your own name. Filename The probe name that performs the data collection. Dbitem The statistic stored in the TeamQuest SMFII database file. Workload Set Specifies the workload set name. This field is only required for workload statistics TQ

155 TeamQuest SMFII Administration Interface Workload Specifies the workload name. This field is only required for workload statistics. Resource This field is only required for statistics that have resources Editing an Alias Definition The Alias List page contains the list of alias names that are defined in the Alarm Policy of the selected database. Each name is a link that can be selected to update, duplicate, or rename the alias. To edit an alias definition: 1. From the Alias List page, click the name of the alias in the Alias Name column. The Edit Alias Definition page is displayed. 2. To update any of the fields of the selected alias: a. Click the Edit link next to the field. The field opens to allow you to make your changes. For a description of these fields, see Edit Alias Definition Field Descriptions on page b. Make your changes and click Save. The alias definition is updated in the Alarm Policy. 3. To give the alias definition a different name: a. From the Edit Alias Definition page, click Rename. The Rename page is displayed. b. In the New Name text box, type a new name for the alias. The new name must be unique and cannot contain any embedded spaces. TQ

156 TeamQuest SMFII Administration Interface c. Click Save. The alias is saved with its new name to the Alarm Policy. The old alias definition no longer exists in the Alarm Policy. You are returned to the Edit Alias Definition page with the new alias definition displayed. Note: Any references to the alias name are updated to use the new alias name. 4. To create an alias that is identical to the selected alias: a. From the Edit Alias Definition page, click Duplicate. The Duplicate page is displayed. b. In the New Name text box, type a new name for the alias. The new name must be unique and cannot contain any embedded spaces. c. Click Save. The alias is saved with its new name to the Alarm Policy. The old alias definition remains in the Alarm Policy. You are returned to the Edit Alias Definition page with the new alias definition displayed. 5. When your updates are complete, click Finished. You are returned to the Alias List page. Edit Alias Definition Field Descriptions The Edit Alias Definition pages contain the following fields: Alias Name A unique name that cannot contain any embedded spaces. TeamQuest Manager supplies a default name. You can use this name or supply your own name. Filename The probe name that performs the data collection. Dbitem The statistic stored in the TeamQuest SMFII database file. Workload Set Specifies the workload set name. This field is only required for workload statistics. Workload Specifies the workload name. This field is only required for workload statistics. Resource This field is only required for statistics that have resources TQ

157 TeamQuest SMFII Administration Interface Deleting an Alias Definition To delete an alias definition from the Alarm Policy: 1. From the Alias List page, click the alias name in the Alias Name column. The Edit Alias Definition page is displayed. 2. Click Delete. The Delete confirmation page is displayed. If the alias is used by an alarm or action definition, TeamQuest SMFII displays the names of the alarms or actions that reference the alias. In addition, two options are displayed that allow you to indicate how you want TeamQuest SMFII to handle the references to the deleted alias. 3. Select one of the options. If you select Remove all references to this alias, TeamQuest SMFII will remove all references to the alias from all alarm or action definitions. If an alarm has no alarm conditions when the alias is removed, the alarm status is set to Disabled. If you select Leave the references to this alias, TeamQuest SMFII will leave any references to the alias in the alarm or action definitions. All alarm or action definitions that use the alias are no longer valid. You may want to leave the references to the alias in the alarm or action definitions so you can create a new definition for the alias. The alarm or action definition will use the new alias definition. 4. Click Delete to delete the alias. The alias definition is deleted from the Alias List page and from the Alarm Policy of the selected database. You are returned to the Alias List page. Note: If you delete an alias and leave the references to the alias, make sure that you update any alarm or actions definitions that use the alias or that you create a new alias definition with the same alias name. Alarm or action definitions that reference an undefined alias will be ignored during alarm checking. TQ

158 TeamQuest SMFII Administration Interface Configuring Actions An action definition specifies what the Probe Manager should do when the conditions of the alarm are met. Actions can include executing user commands, sending console messages, and sending SNMP traps. You define the alarm action and then reference it by name in the alarm definition. You must define an action before it can be used in an alarm definition. All administrative tasks for configuring actions are performed through the Actions List page of TeamQuest SMFII. From the Actions List page, you can perform the following tasks: Viewing the Actions List (see ) Adding an Action Definition (see ) Editing an Action Definition (see ) Deleting an Action Definition (see ) Notes: An alarm definition references alias and action definitions. You must define aliases and actions before referencing them in an alarm definition. There can be no embedded spaces in alarm, alias, and action names TQ

159 TeamQuest SMFII Administration Interface Viewing the Actions List To view the Actions List: 1. From the TeamQuest SMFII navigation bar, click the Alarm Policy link. 2. Click the Actions link under the Alarm Policy link. The Actions List page is displayed allowing you to perform your administrative tasks. Actions List Field Descriptions The Actions List page contains a summary of the alarm actions that are currently defined in the Alarm Policy of the selected database. The Actions List page contains the following fields: Action Name Each action name appears as a link. If you click the link, you can view the details of the action definition or edit the action. Action The Action column lists the actions that are defined for the named action. An action can be one of the following types: Console Message, SNMP Message, or Command Message. The actions are listed by type and are followed by the action definition. TQ

160 TeamQuest SMFII Administration Interface Adding an Action Definition To add a new action definition: 1. From the Actions List page, click the Add Action link. The Add Action Definition page is displayed. 2. In the Action Name field, type a name for the new action. The name cannot contain any embedded spaces. 3. In the Console Message text box, type the message text that will be displayed on the system console. The Common macros list on the right side of the page provides command macros that can be used in the text box. 4. In the SNMP Message text box, type the contents of the SNMP Message that is sent with an SNMP trap for the alarm. The Common macros list on the right side of the page provides command macros that can be used in the text box TQ

161 TeamQuest SMFII Administration Interface 5. In the Command Message text box, enter the WFL jobs which are to be started when the alarm occurs. Each job must be on a separate line. Each line is prefaced with START and submitted to the WFL complier. The job name must be include the usercode and family where the WFL file resides if they differ from those under which the Probe Manager is running. The job is started under the usercode of the Probe Manager. For example, entering the line (TQ)ALARMJOB ON TQPACK would cause WFL to execute START (TQ)ALARMJOB ON TQPACK when the alarm is triggered. The Common macros list on the right side of the page provides command macros that can be used in the text box. 6. When the action definition is complete, click Add. The new action definition is added to the Alarm Policy and can now be used in an alarm definition. You are returned to the Actions List. Add and Edit Action Definition Field Descriptions The Add and Edit Action Definition pages contain the following fields: Action Name A unique name to all alarms, alias, and action names; and cannot contain any embedded spaces. Console Message The message text that is displayed on the system console. SNMP Message Specifies the contents of the SNMP message that is sent with an SNMP trap for the alarm. Command Message Specifies the list of WFL jobs which are to be executed when the alarm occurs. Each job must be on a separate line. Each line is prefaced with START and submitted to the WFL complier. The job name must be include the usercode and family where the WFL file resides if they differ from those under which the Probe Manager is running. The job is started under the usercode of the Probe Manager. For example, entering the line (TQ)ALARMJOB ON TQPACK would cause WFL to execute START (TQ)ALARMJOB ON TQPACK when the alarm is triggered. Common Macros This is a list of the macros that you can use in the Console Message, SNMP Message, and Command Message specifications. When these macros are encountered in an alarm action, they are expanded into information that is specific to the alarm that has occurred. For example, using the $(SYSTEM) macro in a Console Message causes the name of the system where the alarm occurred to be inserted into the message. TQ

162 TeamQuest SMFII Administration Interface Editing an Action Definition The Actions List page contains the list of action names that are defined in the Alarm Policy of the selected database. Each name is a link that can be selected to update, duplicate, or rename the action. To edit an action definition: 1. From the Actions List page, click the name of the action in the Action Name column. The Edit Action Definition page is displayed. 2. To update any of the fields of the selected action: a. Click the Edit link next to the field. The field opens to allow you to make your changes. For a description of these fields, see Add and Edit Action Definition Field Descriptions on page b. Make your changes and click the Save button. The action definition is updated in the Alarm Policy. 3. To give the action definition a different name: a. From the Edit Action Definition page, click the Rename button. The Rename page is displayed. b. In the New Name text box, type a new name for the action. The new name must be unique and cannot contain any embedded spaces. c. Click Save. The action is saved with its new name to the Alarm Policy. The old action definition no longer exists in the Alarm Policy. You are returned to the Edit Action Definition page with the new action definition displayed. Note: Any references using the action are updated to use the new action name TQ

163 TeamQuest SMFII Administration Interface 4. To create an action that is identical to the selected action: a. From the Edit Action Definition page, click the Duplicate button. The Duplicate page is displayed. b. In the New Name text box, type a new name for the action. The new name must be unique and cannot contain any embedded spaces. c. Click Save. The action is saved with its new name to the Alarm Policy. The old action definition remains in the Alarm Policy. You are returned to the Edit Action Definition page with the new action definition displayed. 5. When your updates are complete, click the Finished button. You are returned to the Actions List page Deleting an Action Definition To delete an action definition from the Alarm Policy: 1. From the Actions List page, click the action name in the Action Name column. The Edit Action Definition page is displayed. 2. Click Delete. The Delete confirmation page is displayed. If the action is used by an alarm definition, TeamQuest SMFII displays the names of the alarms that reference the action. 3. Click Delete. The action definition is removed from the Actions List page and from the Alarm Policy of the selected database. You are returned to the Actions List page. TQ

164 TeamQuest SMFII Administration Interface 4.4. Using the Workload Policy TeamQuest SMFII Administration Interface is used to administer the Workload Policy for your performance database. The Workload Policy contains the workload sets and workload definitions that are used by TeamQuest SMFII to distribute the data it collects. TeamQuest SMFII uses the workload definitions for creating parameters and assigning the data values that it stores in the performance database. TeamQuest SMFII allows you to configure your workload definitions to meet the needs of your site. All administrative tasks for configuring workload sets and workload definitions are performed through the Workload Set List page. You can perform the following tasks: Viewing the Workload Set List (see 4.4.1) Adding a Workload Set (see 4.4.2) Adding a Workload to a Workload Set (see 4.4.3) Specifying the Order of Workloads (see 4.4.4) Changing the Status of a Workload Set (see 4.4.5) Editing a Workload Set (see 4.4.6) Editing a Workload Definition (see 4.4.7) Deleting a Workload Set (see 4.4.8) Deleting a Workload (see 4.4.9) Analyzing a Workload Set (see ) Activating Changes (see ) 4 42 TQ

165 TeamQuest SMFII Administration Interface Viewing the Workload Set List To view the Workload Set List: From the TeamQuest SMFII navigation bar, click the Workload Policy link. The Workload Set List page is displayed. Workload Set List Field Descriptions The Workload Set List page contains the list of workload sets and their associated workloads that are defined in the Workload Policy of the selected database. The Workload Set List is divided into two sections that represent the list of workload sets for the data collectors MIXWORKLOAD and COMSWORKLOAD. Workload Set The Workload Set column contains the name of the workload set. Each workload set name appears as a link. If you click the link, you can view the details of the workload set or edit the workload set. Status The status can be either Enabled or Disabled. If a workload set is Enabled, the workload set is available for receiving data from the collection agents. A disabled workload set does not receive data. TQ

166 TeamQuest SMFII Administration Interface Workload The Workload column contains the list of workload definitions included in the workload set. The workloads appear in the order that they are evaluated by the collection agent. You can change the order of the workloads within the workload set. Each workload appears as a link. If you click the link, you can view the details of the workload definition or edit the workload definition Adding a Workload Set To add a new workload set: 1. From the Workload Set List page, click the Add Workload Set link. The Add Workload Set page is displayed. 2. In the Workload Set field, type a name for the workload set. This field is limited to 51 characters in length. Note: It is best to use only alphanumeric characters in a workload set name. Otherwise, problems could arise when the name is used in a table report filter statement in TeamQuest View. 3. In the Data Collector field, select the data collector type from the list box. 4. Click Add. The workload set is added to the Workload Policy of the selected database TQ

167 TeamQuest SMFII Administration Interface The Edit Workload Set page is displayed providing a summary of the new workload set and allowing you to complete the workload set definition. 5. To change the status: a. Click the Edit link next to the Status field. b. Select the appropriate option. When the status is set to Enabled, the workload set is active and available to receive data from the workload probes. When the status is set to Disabled, the workload set is inactive and cannot receive data from the probes. c. Click Save. The status is updated in the Workload Policy. 6. To add workload definitions to the workload set, click the Add link next to the Workload field. The Add Workload Definition page is displayed. See When the workload set is complete, click Finished. You are returned to the Workload Set List page. The new workload set appears on the Workload Set List page. Add and Edit Workload Set Field Descriptions The Add and Edit Workload Set pages contain the following fields: Workload Set The workload set name can be up to 51 characters in length. Note: It is best to use only alphanumeric characters in a workload set name. Otherwise, problems could arise when the name is used in a table report filter statement in TeamQuest View. Data Collector The probe that collects workload-characterized data. TQ

168 TeamQuest SMFII Administration Interface Workload A list of the workload definitions that are included in the workload set. The order that the workload definitions appear in this field is the order that they will be evaluated by the Probe Manager for distributing the collected data. To add a workload definition to the workload set, see To change the order of the workloads within the workload set, see Adding a Workload to a Workload Set Workloads are added to the Workload Policy within the context of the workload set. That is, you must add a workload definition to a workload set. You can add a workload definition to a new workload set during the creation process or you can add a workload definition to an existing workload set. To add a workload definition to a workload set: 1. To access the Add Workload Definition page, do one of the following: After you have added a new workload set to the Workload Policy from the Edit Workload Set page that is displayed, click the Add link next to the Workload field. For an existing workload set, click the workload set name from the Workload Set List page. From the Edit Workload Set page that is displayed, click the Add link next to the Workload field TQ

169 TeamQuest SMFII Administration Interface The Add Workload Definition page is displayed that allows you to add your workload definition. 2. In the Workload Name field, type the name of the new workload. 3. In the Definition field, enter the workload definition. The definition must be expressed using the workload and reduction definition language. a. Select the statistic from the Characteristics list box and click the Append button. The statistic appears in the Definition box. b. Type an operator. Valid operators appear under the text box. c. Type the numerical condition or string condition to complete the definition. d. If you want multiple definitions, type a logical operator and enter another workload definition. Note: The statistics in the Characteristics list box are case-sensitive. These statistics must appear in the Definition box exactly as they appear in the Characteristics list box. 4. When the definition is complete, click the Add button. The Edit Workload Set page is displayed. The new workload is inserted at the bottom of the workload list on the Edit Workload Set page. If necessary, you can rearrange the order of your workloads, see When all updates are complete, click Finished. You are returned to the Workload Set List page. TQ

170 TeamQuest SMFII Administration Interface Add and Edit Workload Definition Field Descriptions The Add and Edit Workload Definition pages contain the following fields: Workload Name The name of the workload. The workload name is limited to 51 characters in length. Workload Set The name of the workload set to which you are adding the workload. Data Collector The probe that collects workload-characterized data. Definition Specifies the workload definition. The workload definition must be expressed using the workload definition language, see TQ

171 TeamQuest SMFII Administration Interface Specifying the Order of Workloads The order that workloads appear in the workload list of the workload set is very important. When the Probe Manager processes a data record, the workloads are evaluated in the order that they appear in the workload list. Once the data probe determines that the data record belongs to a specific workload, the data is assigned only to that workload. The remaining workloads are not evaluated. If the data record does not belong to any defined workload, it is assigned to a default workload named OTHER. The sum of all workloads, including OTHER, represents all the work performed on the system. Note: You can use the order of the workload list to streamline the evaluation process. If the workloads that record the most records are placed near the top of the workload list, fewer evaluation steps are required. To specify the order of the workloads within the workload set: 1. From the Workload Set List page, click the Workload Set name. The Edit Workload Set page is displayed. 2. Click the Order link next to the Workload field. The Workload field is opened to allow you to rearrange the list. 3. Click the workload name and use the up and down arrows to move the workload to the correct position in the list. TQ

172 TeamQuest SMFII Administration Interface 4. Click Save. Your changes are saved to the Workload Policy and you are returned to the Edit Workload Set page. 5. Click Finished to return to the Workload Set List page Changing the Status of a Workload Set The Workload Set List page indicates the status of each workload set defined in the Workload Policy. The status of a workload set can be either Enabled or Disabled. Enabled indicates that the workload set is active and is available for receiving data from the data probes. If the status is Disabled, the workload set is inactive and does not receive data. To change the status of the workload sets in your performance database: 1. From the TeamQuest SMFII navigation bar, click Workload Policy. The Workload Set List page is displayed. 2. On the Workload Set List page, click the Change Status link. The Change Workload Set Status page is displayed. 3. To enable or disable workload sets, do one of the following: Select or clear the check box next to an individual workload set name. Select the check box next to the Status heading at the top of the column to enable all workload sets. Clear the check box next to the Status heading at the top of each Data Collector Section to disable all workload sets for that Data Collector TQ

173 TeamQuest SMFII Administration Interface 4. Click Save. Your changes are saved to the Workload Policy and you are returned to the Workload Set List page Editing a Workload Set The Workload Set List page contains a list of the workload sets that are defined in the Workload Policy of the selected database. Each workload set name is a link that can be selected to update, rename, or duplicate the workload set. To edit a workload set: 1. From the Workload Set List page, click the name of the workload set. The Edit Workload Set page is displayed. 2. To change the status of the workload set: a. Click the Edit link next to the Status field. The field opens to allow you to change the status. b. Select the Enabled or Disabled option button. When the status is set to Enabled, the workload set is active and available to receive data from the probes. When the status is set to Disabled, the workload set is inactive and cannot receive data from the probes. c. Click Save. The workload set is updated in the Workload Policy. TQ

174 TeamQuest SMFII Administration Interface 3. To add a workload to the workload set: a. Click the Add link next to the Workload field. The Add Workload Definition page is displayed. b. Complete the fields on the page to define the new workload. For more information, see c. Click Add. The workload set is updated in the Workload Policy. 4. To change the order of the workloads in the workload set: a. Click the Order link next to the Workload field. The field opens to allow you to make your changes. b. Click a workload and use the up and down arrows to change the order. For more information, see c. Click Save. The workload set is updated in the Workload Policy. 5. To analyze the workload set: From the Edit Workload Set page, click Analyze. The Analyze Workload Set page is displayed. For more information, see Note: The Analyze button is only available for the MIXWORKLOAD data collector. 6. To give the workload set a different name: a. From the Edit Workload Set page, click Rename. The Rename Workload Set page is displayed. b. In the New Name text box, type a new name for the workload set. c. Click Save. The workload set is saved with its new name to the Workload Policy. You are returned to the Edit Workload Set page with the new workload set displayed TQ

175 TeamQuest SMFII Administration Interface 7. To create a workload set that is identical to the selected workload set: a. From the Edit Workload Set page, click Duplicate. The Duplicate Workload Set page is displayed. b. In the New Name text box, type a new name for the workload set. c. Click Save. The workload set is saved with its new name to the Workload Policy. You are returned to the Edit Workload Set page with the new workload set displayed. 8. When the updates to the workload set are complete, click Finished. You are returned to the Workload Set List page Editing a Workload Definition The Workload Set List page contains a list of the workload sets and their associated workloads that are defined in the Workload Policy of the selected database. Each workload name is a link that can be selected to update or rename the workload. To edit a workload definition: 1. From the Workload Set List page, click the name of the workload in the Workload column. The Edit Workload Definition page is displayed allowing you to change any of the workload specifications or the name of the workload. 2. To change any of the workload specifications: a. Click the Edit link next to the field. The field opens to allow you to make your changes. For a description of these fields, see Add and Edit Workload Definition Field Descriptions on page b. Make the changes as required and click Save. The workload definition is updated in the Workload Policy. TQ

176 TeamQuest SMFII Administration Interface 3. To give the workload a different name: a. From the Edit Workload Definition page, click Rename. The Rename Workload page is displayed. b. In the New Name field, type a new name for the workload. c. Click Save. The workload is saved with its new name to the Workload Policy. You are returned to the Edit Workload Definition page. 4. When all updates to the workload definition are complete, click the Finished button. The Edit Workload Set is displayed. 5. Click Finished to return to the Workload Set List page Deleting a Workload Set To delete a workload set from the Workload Policy of the selected database: 1. From the Workload Set List page, click the workload set name in the Workload Set column. The Edit Workload Set page is displayed showing the details of the workload set. 2. Click Delete. The Delete Workload Set confirmation page is displayed TQ

177 TeamQuest SMFII Administration Interface 3. If you want to delete the parameters associated with this workload set, select the check box. 4. Click Delete to permanently remove the workload set. The workload set name is removed from the Workload Set List page. The selected workload set and all associated workloads are removed Deleting a Workload To delete a workload from a workload set: 1. From the Workload Set List page, click the workload name in the Workload column. The Edit Workload Definition page is displayed showing the details of the workload definition. 2. Click Delete. The Delete Workload confirmation page is displayed. 3. Click the Delete button to permanently remove the workload from the workload set. The workload definition is removed from the workload set and the Edit Workload Set page is displayed. 4. Click Finished to return to the Workload Set List page. TQ

178 TeamQuest SMFII Administration Interface Analyzing a Workload Set The Analyze Workload Set page provides a way to easily determine whether your workload definitions are working as intended. It gives you a list of all tasks included in each workload set. This allows you to determine whether tasks are aggregated into the correct workload. Task data collected by the Mixtrace probe is retrieved from the currently selected history database (see 4.1.2), and the workload definitions are applied to the data. From the Analyze Workload Set page, you can specify the time when the data you want to use was collected, reorder your workloads, edit your workload definitions, and list all the tasks in each workload. Task data is extracted and analyzed on the MCP host only when you click the Analyze button. After you use the Analyze button, you can view the tasks included in each workload. If the tasks are not distributed correctly, you can edit the workload definition and reorder the tasks. You then use the Analyze button again to see the new task distribution. You can also check your workload definitions against data collected during several different time periods by changing the time setting and then using the Analyze button again to see the data for the new time period. To analyze a workload set: 1. From the Workload Set List page, click the name of the workload set you want to analyze. The Edit Workload Set page is displayed TQ

179 TeamQuest SMFII Administration Interface 2. Click the Analyze link. The Analyze Workload Set page is displayed showing the list of workloads. 3. To select a time range: a. Click the Edit link next to the Time Range field. The time range fields are initialized using the time information from the selected database. The end time is set to the timestamp of the last Mixtrace sample in the database. The start time is set to the timestamp of the next-to-last Mixtrace sample in the database. Some fields may only have 1 value and cannot be changed as that field is limited to the time range available in the database. TQ

180 TeamQuest SMFII Administration Interface b. Select the values for the Year, Month, Day, Hour, Minute, and Second fields. The values which may be selected are derived from the timestamp of the first and last samples in the database. c. Click Save. The Save button verifies the Starting and Ending intervals. If an invalid Starting interval or Ending interval is specified, an error message is displayed in red to indicate the incorrect entry. If a valid Time Range is specified, the results or any previous analyze actions are cleared and you are returned to the Analyze Workload Set page. The Cancel button returns you to the Analyze Workload Set page with no changes. 4. To expand and contract the task data being analyzed: a. To expand the list of tasks, click the + (plus) button for the selected workload. The expanded task list contains a column for the Taskname and a column for each of characteristics that are defined in all of the workload definitions combined for this workload set. Use the scroll bars on the side or bottom to see all columns and tasks TQ

181 TeamQuest SMFII Administration Interface b. To contract the list of tasks, click the - (minus) button for the selected workload. Only the workload order and number of tasks are displayed for the selected workload. If tasks are not included in the intended workloads, you can edit the workload definitions or reorder and then analyze again using the new definitions. You are returned to the Edit Workload Set page. 5. To change the workload definition, click the workload link. The Edit Workload Definition page is displayed. See for more information about editing a workload definition. Editing a workload definition clears the results of any previous analyze actions. 6. To change the order of the workloads in the workload set: a. Click OrderWL. The Edit Workload Set page is displayed. b. Click a workload and use the up and down arrows to change the order. For more information, see c. Click Save. The workload set is updated with the new order for the workloads, the results of any previous Analyze actions are cleared, and you are returned to the Analyze Workload Set page. 7. To exit the Analyze Workload Set page, click Finished. The Finished button returns you to the Edit Workload Set page. Analyze Workload Set Field Descriptions The Analyze Workload Set page contains the following fields: Workload Set Name The name of the workload set to analyze. Data Collector The name of the probe used to collect the data for the workload set. Status Indicates whether the workload set data is being collected. The status is Disabled when data is not collected and Enabled when data is being collected. Time Range Indicates the time range for available data for the workload set. Workload Name The names of the workloads within the selected workload set. TQ

182 TeamQuest SMFII Administration Interface Activating Changes Note: Configure the MIXWORKLOAD or COMSWORKLOAD probes with the Probe Manager parameters file if these probes are not already configured. Enable these probes from the Control Center if they are not enabled by the Probe Manager. The TeamQuest SMFII database is constantly updated with new information as you make changes using the TeamQuest SMFII Administration interface. Your changes, however, are not actually activated until you notify the Probe Manager of the new specifications. To notify the Probe Manager of the changes you have made, you must click Activate Changes. The Probe Manager is sent the commands RESET HISTORY PROBES=(COMSWORKLOAD) and SET HISTORY PROBE=(COMSWORKLOAD). The Probe Manager is also sent the commands RESET HISTORY PROBES=(MIXWORKLOAD) and SET HISTORY PROBE=(MIXWORKLOAD) TQ

183 TeamQuest SMFII Administration Interface 4.5. Using the Probe Manager Policy TeamQuest SMFII Administration Interface Probe Manager Policy is used to communicate with the Probe Manager. The Probe Manager Policy provides a browser-based interface for executing Probe Manager commands, editing the Probe Manager parameter file, initiating the Probe Manager, and terminating the Probe Manager. The Probe Manager allows you to perform most administrative tasks through the Probe Manager Policy page of TeamQuest SMFII. You can perform the following tasks: Initiating Probe Manager (see 4.5.1) Terminating the Probe Manager (see 4.5.2) Executing Probe Manager Commands (see 4.5.3) Editing Parameter Files (see 4.5.4) TQ

184 TeamQuest SMFII Administration Interface Initiating Probe Manager The Probe Manager Policy provides a browser-based interface for initiating the Probe Manager. To intiate the Probe Manager: From the Probe Manager Policy page, click Initiate PROBEMGR. Probe Manager Policy Field Descriptions The Probe Manager Policy page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Probe Manager Parameter File The parameter file that is being used by the Probe Manager. Probe Manager Job The name of the job initiating the Probe Manager. Control Center button Provides a table for selecting Probe Manager commands. Each command may include additonal pages to define any parameters required to execute the command. For information on Probe Manager commands, see TQ

185 TeamQuest SMFII Administration Interface Parameter File button Provides a copy of the Probe Manager parameter file where updates can be made and the syntax can be verified. Initiate PROBEMGR button Initates the Probe Manager if it is not running. The browser waits until the PROBEMGR is initiated before allowing you to continue with other administrative functions. Terminate PROBEMGR button Terminates the Probe Manager. The browser waits until the PROBEMGR is terminated before allowing you to continue with other administrative functions Terminating the Probe Manager The Probe Manager Policy provides a browser based interface for terminating the Probe Manager. To terminate the Probe Manager: From the Probe Manager Policy page, click Terminate PROBEMGR. TQ

186 TeamQuest SMFII Administration Interface Executing Probe Manager Commands The Probe Manager Control Center page provides a table of Probe Manager commands. You can use this page to execute Probe Manager commands. Each command link that you select will either execute the command immediately or provide additional pages for parameter input. To select a command: 1. From the Probe Manager Policy page, click the Control Center button. The Probe Manager Control Center Page is displayed. 2. Click the link for the Probe Manager command you want to execute. Some commands will execute immediately, others may require more input and display additional pages are displayed. 3. Click Finished after you have completed all your administrative tasks. Probe Manager Control Center Field Descriptions The Probe Manager Control Center Page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Probe Manager command links This table provides links to execute Probe Manager commands TQ

187 TeamQuest SMFII Administration Interface ALARMS Command The Probe Manager Command - ALARMS page controls the enabling or disabling of alarm checking by the Probe Manager. For more information on the ALARMS command, see Probe Manager Command - ALARMS Field Descriptions The Probe Manager Command - ALARMS page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The status of the ALARM command. Use the Set button to change the alarm status to enable or the Reset button to change the alarm status to disabled. TQ

188 TeamQuest SMFII Administration Interface AUTOQUIT Command The Probe Manager Command - AUTOQUIT page is used to specify the desired time of day to terminate the Probe Manager. For more information on the AUTOQUIT command, see To specify the time or date to terminate the Probe Manager: 1. From the Probe Manager Control Center page, click the AUTOQUIT link. The Probe Manager Command - AUTOQUIT page is displayed. 2. Specify the time or date to terminate the Probe Manager. Use the Hour, Minute, and Second list boxes to select the time to terminate the Probe Manager. Use the Year, Month, and Day list boxes to select the date and time to terminate the Probe Manager. Use the option buttons to select the specific time, the specific date, or a relative date to terminate the Probe Manager TQ

189 TeamQuest SMFII Administration Interface 3. Click Set when you have finished. The AUTOQUIT command is enabled and you are returned to the Probe Manager Control Center page. Probe Manager Command - AUTOQUIT Field Descriptions The Probe Manager Command - AUTOQUIT page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The status of the AUTOQUIT command. Use the Set or Reset buttons to change the status. AUTOQUIT Time This field specifies the exact time of day, the date, or a relative date to terminate the Probe Manager. Options are Date Time Only Tomorrow Today DaysFromNow Sunday Monday Tuesday Wednesday Thursday Terminates the Probe Manager on the date specified in the Year, Month, and Day list boxes and the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager at the time specified in the Hour, Minute, and Second list boxes on the day you select in the Days From Now list box. Terminates the Probe Manager on Sunday at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager on Monday at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager on Tuesday at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager on Wednesday at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager on Thursday at the time specified in the Hour, Minute, and Second list boxes. TQ

190 TeamQuest SMFII Administration Interface Friday Saturday Terminates the Probe Manager on Friday at the time specified in the Hour, Minute, and Second list boxes. Terminates the Probe Manager on Saturday at the time specified in the Hour, Minute, and Second list boxes AUTOTF Command The Probe Manager Command - AUTOTF page is used to specify the desired time of day and location to transfer the Probe Manager database. For more information on the AUTOTF command, see Probe Manager Command - AUTOTF Field Descriptions The Probe Manager Command - AUTOTF page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The status of the AUTOTF command. Use the Set or Reset buttons to change the status. Directory Specifies the directory name where the Probe Manager database is transfered TQ

191 TeamQuest SMFII Administration Interface TFTIME Specifies the time and date for Probe Manager database transfer. Max Size Specifies the maximum database segment size to transfer. File Full Specifies a condition for database transfer. Probe Change Specifies a condition for database transfer. Negative Time Stamp Specifies a condition for database transfer. TQ

192 TeamQuest SMFII Administration Interface To enter a directory name to transfer the database to: 1. From the Probe Manager Command - AUTOTF page, click the Edit link next to the Directory field. The AUTOTF Directory page is displayed. 2. In the AUTOTF Directory field, type the full directory name where the database is transfering. An example of the syntax for the directory name is provided above the field. The directory name must end with the backslash (/) and equal sign (=) characters. (SMFII)/TEST/Directory/Archive/= 3. Click Enter. You are returned to the Probe Manager Command - AUTOTF page. AUTOFT Directory Field Descriptions The AUTOTF Directory page contains the following fields: Example This is an example of the syntax for the directory name is provided above the entry box. The directory name must end with the backslash (/) and equal sign (=) characters. (SMFII)/TEST/Directory/Archive/= 4 70 TQ

193 TeamQuest SMFII Administration Interface To specify the time or date to transfer a database: 1. From the Probe Manager Command - AUTOTF page, click the Edit link next to the TFTime field. The AUTOTF Time page is displayed. 2. Specify the time or date to transfer the database. Use the Hour, Minute, and Second list boxes to select the time to transfer the database. Use the Year, Month, and Day list boxes to select the date and time to transfer the database. Use the options to select the specific time, the specific date, or a relative date for the database transfer. 3. Click Enter. TQ

194 TeamQuest SMFII Administration Interface AUTOTF Time Field Descriptions The AUTOTF Time page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. AUTOTF Time This field specifies the exact time of day, the date, or a relative date for the database transfer. Options are Date Time Only Daily Tomorrow Today DaysFromNow Sunday Monday Tuesday Wednesday Thursday Friday Saturday Transfers the database on the date specified in the Year, Month, and Day list boxes and the time specified in the Hour, Minute, and Second list boxes. Transfers the database at the time specified in the Hour, Minute, and Second list boxes. Transfers the database everyday at the time specified in the Hour, Minute, and Second list boxes. Transfers the database at the time specified in the Hour, Minute, and Second list boxes once. Transfers the database at the time specified in the Hour, Minute, and Second list boxes once. Transfers the database at the time specified in the Hour, Minute, and Second drop down lists once on the day you select in the Days list box. Transfers the database every Sunday at the time specified in the Hour, Minute, and Second list boxes. Transfers the database every Monday at the time specified in the Hour, Minute, and Second list boxes. Transfers the database every Tuesday at the time specified in the Hour, Minute, and Second list boxes. Transfers the database every Wednesday at the time specified in the Hour, Minute, and Second drop down lists. Transfers the database every Thursday at the time specified in the Hour, Minute, and Second drop down liss. Transfers the database every Friday at the time specified in the Hour, Minute, and Second drop down lists. Transfers the database every Saturday at the time specified in the Hour, Minute, and Second drop down lists TQ

195 TeamQuest SMFII Administration Interface To specify the maximum database segment size: 1. From the Probe Manager Command - AUTOTF page, click the Max size edit link. The AUTOTF Maxsize page displays. 2. In the AUTOTF Maxsize, type the maximum segment size to transfer. 3. Click Enter. You are returned to the Probe Manager Command - AUTOTF page. AUTOTF Maxsize Field Descriptions The AUTOTF Maxsize page contains the following fields: AUTOTF Maxsize The maximum segment size of the Probe Manager database to transfer. TQ

196 TeamQuest SMFII Administration Interface CLOSE Command The Probe Manager Command - CLOSE page is used to lock all history data files. It is used to update the last records of the data files to allow the latest collected data to be analyzed using TeamQuest View or Query. For more information on the CLOSE command, see Probe Manager Command - CLOSE Field Descriptions The Probe Manager Command - CLOSE page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Status The status of the CLOSE command TQ

197 TeamQuest SMFII Administration Interface CONFIGURE Command The Probe Manager Command - CONFIGURE page is used to provide configuration information for a probe. For more information on the CONFIGURE command, see Probe Manager Command - CONFIGURATION Field Descriptions The Probe Manager Command - CONFIGURATION page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Enabled Probe Configurations A list of enabled probes and the configuration status of each. When you click Edit links for a specific probe, additional pages are displayed to allow you to make configuration changes. TQ

198 TeamQuest SMFII Administration Interface To configure a probe: 1. From the Probe Manager Command - CONFIGURE page, click the Edit link. The CONFIGURE Name PROBE page is displayed. 2. In the History Configuration, enter the configuration input. 3. In the Monitor Configuration, enter the configuration input. 4. Click Enter when you are finished. You are returned to the Probe Manager Command - CONFIGURE page. CONFIGURE Name Probe Field Descriptions The CONFIGURE Name Probe page contains the following fields: History Configuration Configuration information for a probe to collect data for the history database. Monitor Configuration Configuration information for a probe to collect data for the monitor database TQ

199 TeamQuest SMFII Administration Interface DATABASE Command The Probe Manager Command - DATABASE page provides location information. For more information on the DATABASE command, see Probe Manager Command - DATABASE Field Descriptions The Probe Manager Command - DATABASE page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The current history database directory name and active probes. TQ

200 TeamQuest SMFII Administration Interface HISTORY Command The Probe Manager Command - HISTORY page allows you to activate or suspend probes that write performance data into the history database. For more information on the HISTORY command, see Probe Manager Command - HISTORY Field Descriptions The Probe Manager Command - HISTORY page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Suspend All Probes This link suspends all active probes listed in the History Probes table. Activate All Probes This link activates all suspended probes listed in the History Probes table. History Probes This table contains a list of probes that write performance data into a history database. The links in the Action column allow you to activate or suspend individual probes TQ

201 TeamQuest SMFII Administration Interface IOTRACE Command The Probe Manager Command - IOTRACE page controls the IOTRACE facility of the MCP. For more information on the IOTRACE command, see Probe Manager Command - IOTRACE Field Descriptions The Probe Manager Command - IOTRACE page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The status of the IOTRACE command. Quit Time The time of day to terminate the collection of data by the IOTRACE probe. This field can be changed by clicking the Edit link. Blocks The maximum number of 7-word I/O control blocks accumulated in each second of elapsed time. This field can be changed by clicking the edit link. Units A list of available units to collect IOTRACE data. TQ

202 TeamQuest SMFII Administration Interface To specify the time to terminate data collection: 1. From the Probe Manager Command - IOTRACE page, click the Edit link next to the Quit Time field. The IOTRACE Quit Time page is displayed. 2. Specify the time to transfer the database. Use the IOTRACE Quit Time Hour, Minute, and Second list boxesto select the time to terminate the IOTRACE probe. Use the Date Year, Month, and Day drop down lists to select the date to terminate the IOTRACE probe. Use the options to select the specific time, the specific date, or a relative date to terminiate the IOTRACE probe. 3. Click Enter TQ

203 TeamQuest SMFII Administration Interface IOTRACE Quite Time Field Descriptions The IOTRACE Quit Time page contains the following fields: IOTRACE Quit Time Specifies the hour, minute, and second to terminate the IOTRACE probe. Date Specifies the year, month, and day to terminate the IOTRACE probe. Relative Time option buttons Options used to specify the exact time of day, the date, or a relative date for the database transfer. Options are Date Time Only Sunday Monday Tuesday Wednesday Thursday Friday Saturday Terminates the IOTRACE probe on the date specified in the Year, Month, and Day list boxes and the time specified in the Hour, Minute, and Second drop down list boxes. Terminates the IOTRACE probe at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Sunday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Monday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Tuesday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Wednesday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Thursday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Friday at the time specified in the Hour, Minute, and Second list boxes. Terminates the IOTRACE probe on Saturday at the time specified in the Hour, Minute, and Second list boxes. TQ

204 TeamQuest SMFII Administration Interface To specify the maximum number of blocks: 1. From the Probe Manager Command - IOTRACE page, click the Edit link next to the Blocks field. The IOTRACE Blocks page is displayed. 2. In the IOTRACE Blocks field, type the maximum number of 7-word I/O control blocks. The range for IOTRACE Blocks is Click Enter. You are returned to the Probe Manager Command - IOTRACE page IOTRACE Blocks Field Descriptions The IOTRACE Blocks page contains the following fields: IOTRACE Blocks The maximum number of 7-word I/O control blocks accumulated in each second of elapsed time. This value can be any number from TQ

205 TeamQuest SMFII Administration Interface To specify the units to collect: 1. From the Probe Manager Command IOTRACE page, click the Units edit link. The IOTRACE Units page is displayed. 2. From the Available Units list, double-click the unit or select the unit and click Append to move the unit to the Unit List. 3. Click Enter. You are returned to the Probe Manager Command IOTRACE page IOTRACE Unit Field Descriptions The IOTRACE Unit page contains the following fields: Unit List Contains the list of units specified to collect IOTRACE data. Available Units Contains the list of all units that are available to collect IOTRACE data. TQ

206 TeamQuest SMFII Administration Interface LIBRARY Command The Probe Manager Command - LIBRARY page provides current probe information. For more information on the LIBRARY command, see Probe Manager Command - LIBRARY Field Descriptions The Probe Manager Command - LIBRARY page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry Lists the current probes and whether it is collecting to a history database or a monitor file TQ

207 TeamQuest SMFII Administration Interface MONITOR Command The Probe Manager Command - MONITOR page allows you to activate or suspend probes that write performance data into the monitor database. For more information on the MONITOR command, see Probe Manager Command - MONITOR Field Descriptions The Probe Manager Command - MONITOR page contains the following fields: Probe Manager Task The task number and name of the Probe Manager process. TQ

208 TeamQuest SMFII Administration Interface Suspend All Probes This link suspends all active probes listed in the Monitor Probes table. Activate All Probes This link activates all suspended probes listed in the Monitor Probes table. Monitor Probes This table contains a list of probes that write performance data into a monitor database. The links in the Active column allow you to activate or suspend an individual probe. Monitor Timing The rate which data is stored into the monitor database. The default is 60 seconds. This field can be updated by clicking the Edit link. Monitor Retain Date The length of time data is retained in the monitor database. This field can be updated by clicking the Edit link. To specify a new timing rate: 1. From the Probe Manager Command - MONITOR page, click the Edit link next to the Monitor Timing field. The MONITOR Timing page is displayed. 2. In the Establish Timing Rate field, type the new timing rate in seconds for data to be stored in the monitor database. 3. Click Enter. The timing rate for the monitor database is set and you are returned to the Probe Manager Command - MONITOR page TQ

209 TeamQuest SMFII Administration Interface To specify return to the default timing rate: 1. From the Probe Manager Command - MONITOR page, click the Edit link next to the Monitor Timing field. The MONITOR Timing page is displayed. 2. Select the Revert to Default (60 Seconds) option. 3. Click Enter when you are finished. The timing rate for the monitor database is reset to the default of 60 seconds and you are returned to the Probe Manager Command - MONITOR page MONITOR Timing Field Descriptions The MONITOR Timing page contains the following fields: Curent Monitor Timing Rate The current timing rate for data to be stored into the monitor database. Current Monitor Retention The current length of time data is retained in the monitor database. Establish Timing Rate Specifies a new timing rate in seconds. Revert to Default (60 Seconds) Returns the timing rate for the monitor database to 60 seconds. TQ

210 TeamQuest SMFII Administration Interface To specify a retention rate: 1. From the Probe Manager Command - MONITOR page, click the Edit link next to the Monitor Retain Data field. The MONITOR Retaindata page is displayed. 2. In the Establish Retention Rate field, select a retention rate (in hours) for data in the monitor database. 3. Click Enter. The data retention rate for the monitor database is set and you are returned to the Probe Manager Command - MONITOR page. MONITOR Retaindata Field Descriptions The MONITOR Retaindata page contains the following fields: Curent Monitor Timing Rate The current timing rate for data to be stored into the monitor database. Current Monitor Retention The current length of time data is retained in the monitor database. Establish Retention Rate Specifies a retention rate (in hours) for the data in the monitor database TQ

211 TeamQuest SMFII Administration Interface MONITORDATABASE Command The Probe Manager Command - MONITORDATABASE page provides location information. For more information on the MONITORDATABASE command, see Probe Manager Command - MONITORDATABASE Field Descriptions The Probe Manager Command - MONITORDATABASE page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The current monitor database directory name. TQ

212 TeamQuest SMFII Administration Interface PORT Command The Probe Manager Command - PORT page is used to collect specific port information and store it into a history database. For more information on the PORT command, see Probe Manager Command - PORT Field Descriptions The Probe Manager Command - PORT page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Port Name and Description Information about each port. A check box for each port allows you to reset the port and stop collecting the statistics. You must click the Reset button for your changes to take effect TQ

213 TeamQuest SMFII Administration Interface PRIORITY Command The Probe Manager Command - PRIORITY page is used to display or to specify the Probe Manager priority. For more information on the PRIORITY command, see Probe Manager Command - PRIORITY Field Descriptions The Probe Manager Command - PRIORITY page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry Shows the current priority of the Probe Manager. Priority Value Allows you to change the priority of the Probe Manager. You must click the Set button for your changes to take effect. TQ

214 TeamQuest SMFII Administration Interface SAMPLE Command The Probe Manager Command - SAMPLE page instructs the Probe Manager to collect and store data from one or more probes immediately into the history database. For more information on the SAMPLE command, see TQ

215 TeamQuest SMFII Administration Interface Probe Manager Command - SAMPLE Field Descriptions The Probe Manager Command - SAMPLE page contains the following field: Probe Manager Task The task number and task name of the currently running Probe Manager. Probes Specifies that all the probes or specific probes store data into the history database. You must click the Sample button for your changes to take effect. Probe Manager will run immediately rather than waiting for the next scheduled time. TQ

216 TeamQuest SMFII Administration Interface STATUS Command The Probe Manager Command - STATUS page shows the current resource usage of the Probe Manager, probe status and sample counts, and disk usage. For more information on the STATUS command, see TQ

217 TeamQuest SMFII Administration Interface Probe Manager Command - STATUS Field Descriptions The Probe Manager Command - STATUS page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Probe Manager Level The current level of Probe Manager that is running. PROBEMGR Processor Overhead The Probe Manager processor overhead in percent. PROBEMGR I/O Overhead The Probe Manager I/O overhead in percent. PROBEMGR Total Segments Written Since Last TF The number of segments written to since the last transfer to the database. History Probes This table contains a list of the history probes, the probe status, and the number of samples. Port Probes This table contains a list of the port probes and the number of samples. History Database Location The location of the history database. Monitor Probes This table contains a list of the monitor probes and the probe status. Monitor Timing The timing of the sample collection (in seconds) for the monitor database. Monitor Retention The length of time (in hours) that the data is retained in the monitor database. TQ

218 TeamQuest SMFII Administration Interface TIMING Command The Probe Manager Command - TIMING page is used to specify the rate that the probes write data into the history database. For more information on the TIMING command, see Probe Manager Command - TIMING Field Descriptions The Probe Manager Command - TIMING page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Default Rate All Probes Sets all history probes to the default timing rate. History Probes This table contains a list of the history probes. The name, status, and sample rate for each history probe is shown. You can establish a timing rate for each probe by clicking the Establish Rate link in the Action column TQ

219 TeamQuest SMFII Administration Interface To set the sample timing rate: 1. From the Probe Manager Command - TIMING page, click the Establish Rate edit link for the probe. The HISTORY Timing page is displayed. 2. In the Establish NEW Probe Rate field, type a sample timing rate in seconds. 3. Click Enter. The sample timing rate for the probe is set and you are returned to the Probe Manager Command - TIMING page. To reset the sample timing rate to the default value: 1. From the Probe Manager Command - TIMING page, click the Establish Rate edit link for the probe. The HISTORY Timing page is displayed. 2. Select the Revert to Default option. 3. Click Enter. The sample timing rate for the probe is reset to the default value and you are returned to the Probe Manager Command - TIMING page. TQ

220 TeamQuest SMFII Administration Interface HISTORY Timing Field Descriptions The HISTORY Timing page contains the following fields: Current Probe Name Probe Rate The current sample timing rate (in seconds) for that probe. Establish New Probe Rate Specifies a new sample timing rate (in seconds). Revert to Default Returns to the default sample timing rate TRANSFER Command The Probe Manager Command - TRANSFER page is used to close the current data files without terminating the data collection process and to change the top-level directory names. For more information on the TRANSFER command, see Probe Manager Command - TRANSFER Field Descriptions The Probe Manager Command - TRANSFER page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Directory The directory name where the database is to be transferred to. This field can be changed by clicking the Edit link TQ

221 TeamQuest SMFII Administration Interface To change the transfer database directory name: 1. From the Probe Manager Command - TRANSFER page, click the edit link. The Transfer Database Directory page is displayed. 2. In the Transfer Directory field, type the full directory name where the database is to be transferred. An example of the syntax for the directory name is provided above the entry box. The directory name must end with the backslash (/) and equal sign (=) characters. (SMFII)/TEST/Directory/Archive/= 3. Click Enter. You are returned to the Probe Manager Command - TRANSFER page Transfer Database Directory Field Descriptions The Transfer Database Directory page contains the following fields: Example An example of the syntax needed for the directory name specifying where the Probe Manager database is transferred. The directory name needs to end with the characters /=. (SMFII)/TEST/Directory/Archive/= Directory The directory name where the database is to be transferred to. TQ

222 TeamQuest SMFII Administration Interface VERSION Command The Probe Manager Command - VERSION page is displayed with the current version (Mark.Cycle.Patch) of the Probe Manager. For more information on the VERSION command, see Probe Manager Command - VERSION Field Descriptions The Probe Manager Command - VERSION page contains the following fields: Probe Manager Task The task number and task name of the currently running Probe Manager. Inquiry The title of the Probe Manager with the current version and copyright information TQ

223 TeamQuest SMFII Administration Interface Editing Parameter Files The Probe Manager Parameter File page allows you to edit the Probe Manager parameter file through the browser. To edit the parameter file: 1. From the Probe Manager Policy page, click the Parameter File button. The Probe Manager Parameter File page is displayed. 2. Make updates to the parameter file text. For descriptions and syntax for all the commands, see Select Save, Verify, or Cancel when you have made your changes. TQ

224 TeamQuest SMFII Administration Interface Probe Manager Parameter File Field Descriptions The Probe Manager Parameter File page contains the following fields: Parameter File The title of the Probe Manager parameter file. Last Alter Date The date and time of the last changes applied to the parameter file. Save button Verifies the parameter file syntax and rewrites the parameter file if no errors are detected. If an error is detected, the command line and syntax error is displayed. Verify button Verifies the parameter file syntax and displays the following message if no errors are detected. Probe Manager has verified the parameter file. If an error is detected, the command line and syntax error is displayed. Cancel button Returns to the Probe Manager Policy page without saving the parameter file. Syntax Error The following example shows the message displayed in red print when the input line of XXXXX causes a syntax error in the parameter file. Command XXXXX; Syntax Error >>>>COMMAND KEY WORD EXPECTED, INSTEAD OF: 'XXXXX' If the Probe Manager is not running, the following message is displayed: The Probe Manager is currently not running TQ

225 TeamQuest SMFII Administration Interface 4.6. Maintaining System Licenses TeamQuest SMFII requires a product license key to function correctly after installation. This license key is obtained from your software distributor. The data collector and reporting programs will not run until the license key is installed. For more information on license keys, see the TeamQuest Products Installation Guide for Unisys MCP Systems. The TeamQuest SMFII Administration Interface allows you to perform maintenance tasks for the license-key file, TQ/SOFTWARE-KEY. You can perform the following administrative tasks: Viewing License Information (see 4.6.1) Editing the License File (see 4.6.2) TQ

226 TeamQuest SMFII Administration Interface Viewing License Information The TeamQuest SMFII Administration Interface allows you to view information for each TeamQuest license key installed on your monitored systems. Using this information you can quickly see what TeamQuest products are licensed on which system and expiration dates of the license keys. To view a report of license key information: From TeamQuest SMFII Administration Interface navigation bar, click License Management. The License Management page is displayed showing a list of all the TeamQuest license keys from the license-key file TQ

227 TeamQuest SMFII Administration Interface License Management Field Descriptions The License Management page contains the following fields: Key File Identifies the TQ/SOFTWARE-KEY file location. Number of Keys Indicates how many keys are contained in the license-key file. License Key Information A list of all the TeamQuest licenses keys, with information pertaining to those keys, contained in the license-key file. Line Number The line number of the current license key in the license-key file. Status The status of the license key for the local system. Note: The license management report cannot authenticate a license from a remote system. System Serial The serial number for the system for which the license key is valid. Expiration The expiration month and year of the license key. If the license key does not have an expiration date, None is displayed. Product(s) A list of the TeamQuest products authorized with the license key. TQ

228 TeamQuest SMFII Administration Interface Editing the License File The TeamQuest SMFII Administration Interface allows you to edit each TeamQuest license key installed on your monitored systems. You can add a license key, add comments, comment out expired license keys, and delete license keys. To edit a license key in your TQ/SOFTWARE-KEY file: 1. From the TeamQuest SMFII Administration Interface navigation bar, click License Management. The License Management page is displayed TQ

229 TeamQuest SMFII Administration Interface 2. Click the Edit link on the right side of the license key. The Edit Software-Key File page is displayed. 3. Make your changes to the license-key file. To add a new license key, copy the key as received from your distributor or TeamQuest Corporation and paste it into the text field. Each key must appear on a separate line. When adding a license key, place it at the top of the list. If you want to keep older license keys, comment out these by placing the number sign (#) in front of the first character of the license key. To delete a license key, select the complete license key and press the Delete key. 4. Click Save. Your changes are saved to the license-key file and you are returned to the License Management page. TQ

230

231 Appendix A Understanding Railroad Diagrams This appendix provides information about the railroad diagrams found in this guide. Read the following topics to learn more about railroad diagrams: What Are Railroad Diagrams? (see A.1) Following the Paths of a Railroad Diagram (see A.2) Railroad Diagram Examples with Sample Input (see A.3) A.1. What Are Railroad Diagrams? Railroad diagrams are diagrams that show you the rules for putting words and symbols together into commands and statements that the computer can understand. These diagrams consist of a series of paths that show the allowed structure, constants, and variables for a command or a statement. Paths show the order in which the command or statement is constructed. Paths are represented by horizontal and vertical lines. Many railroad diagrams have a number of different paths you can take to get to the end of the diagram. Example REMOVE SOURCE OBJECT If you follow this railroad diagram from left to right, you discover three acceptable commands. These commands are the following: REMOVE REMOVE SOURCE REMOVE OBJECT If all railroad diagrams were this simple, this explanation could end here. However, because the allowed ways of communicating with the computer can be complex, railroad diagrams sometimes must also be complex. TQ A 1

232 Understanding Railroad Diagrams Regardless of the level of complexity, all railroad diagrams are visual representations of commands and statements. Railroad diagrams are intended to Show the mandatory items Show the user-selected items Present the order in which the items must appear Show the number of times an item can be repeated Show the necessary punctuation To familiarize you with railroad diagrams, this explanation describes the elements of the diagrams and provides examples. Some of the actual railroad diagrams you will encounter might be more complex. However, all railroad diagrams, simple or complex, follow the same basic rules. They all consist of paths that represent the allowed structure, constants, and variables for commands and statements. By following railroad diagrams, you can easily understand the correct syntax for commands and statements. Once you become proficient in the use of railroad notation, the diagrams serve as quick references to the commands and statements. A.1.1. Constants and Variables A constant is an item that cannot be altered. You must enter the constant as it appears in the diagram, either in full or as an allowable abbreviation. If a constant is partially underlined, you can abbreviate the constant by entering only the underlined letters. In addition to the underlined letters, any of the remaining letters can be entered. If no part of the constant is underlined, the constant cannot be abbreviated. Constants can be recognized by the fact that they are never enclosed in angle brackets (< >) and are in uppercase letters. A variable is an item that represents data. You can replace the variable with data that meets the requirements of the particular command or statement. When replacing a variable with data, you must follow the rules defined for the particular command or statement. Variables appear in railroad diagrams enclosed in angle brackets. Example In the following example, BEGIN and END are constants while <statement list> is a variable. The constant BEGIN can be abbreviated since it is partially underlined. Valid abbreviations for BEGIN are BE, BEG, and BEGI. BEGIN <statement list> END A 2 TQ

233 Understanding Railroad Diagrams A.1.2. Constraints Constraints are used in a railroad diagram to control progression through the diagram. Constraints consist of symbols and unique railroad diagram line paths. They include the following: Vertical Bar Percent Sign Right Arrow Required Items User-Selected Items Loop Bridge Table A 1 summarizes these constraints. Vertical Bar The vertical bar symbol ( ) represents the end of a railroad diagram and indicates the command or statement can be followed by another command or statement. SECONDWORD ( <arithmetic expression> ) Percent Sign The percent sign (%) represents the end of a railroad diagram and indicates the command or statement must be on a line by itself. STOP % Right Arrow The right arrow symbol (>) is used when the railroad diagram is too long to fit on one line and must continue on the next. A right arrow appears at the end of the first line; and another right arrow appears at the beginning of the next line. SCALERIGHT ( <arithmetic expression>, <arithmetic expression> ) TQ A 3

234 Understanding Railroad Diagrams Required Items A required item can be either a constant, a variable, or punctuation. A required item appears as a single entry, by itself or with other items, on a horizontal line. Required items can also exist on horizontal lines within alternate paths or nested (lower-level) diagrams. If the path you are following contains a required item, you must enter the item in the command or statement; the required item cannot be omitted. In the following example, the word EVENT is a required constant and <identifier> is a required variable: EVENT <identifier> User-Selected Items User-selected items appear one below the other in a vertical list. You can choose any one of the items from the list. If the list also contains an empty path (solid line), none of the choices are required. A user-selected item can be either a constant, a variable, or punctuation. In the following railroad diagram, either the plus sign (+) or minus sign (-) can be entered before the required variable <arithmetic expression>, or the symbols can be disregarded because the diagram also contains an empty path. + - <arithmetic expression> Loop A loop represents an item or group of items that you can repeat. A loop can span all or part of a railroad diagram. It always consists of at least two horizontal lines, one below the other, connected on both sides by vertical lines. The top line is a right-to-left path that contains information about repeating the loop. Some loops include a return character. A return character is a character often a comma (,) or semicolon (;) required before each repetition of a loop. If there is no return character, the items must be separated by one or more blank spaces. ; <field value> A 4 TQ

235 Understanding Railroad Diagrams Bridge Sometimes a loop also includes a bridge, which is used to show the maximum number of times the loop can be repeated. The bridge can precede the contents of the loop, or it can precede the return character (if any) on the upper line of the loop. The bridge determines the number of times you can cross that point in the diagram. The bridge is an integer enclosed in sloping lines (/~\). Not all loops have bridges; those that do not can be repeated any number of times until all valid entries have been used. In the first bridge example, you can enter LINKAGE or RUNTIME no more than two times. In the second bridge example, you can enter LINKAGE or RUNTIME no more than three times., /2\ LINKAGE RUNTIME /2\ LINKAGE RUNTIME In some bridges an asterisk (*) follows the number. The asterisk means that you must select one item from the group., /1*\ LINKAGE RUNTIME TQ A 5

236 Understanding Railroad Diagrams Table A 1 shows the types of constraints used in railroad diagrams. Table A 1. Railroad Constraints Symbol/Path Explanation Vertical bar. Indicates that the command or statement can be followed by another command or statement. % Percent sign. Indicates that the command or statement must be on a line by itself. Right arrow. Indicates that the diagram occupies more than one line. <required> YES NO Required items. Indicates the constants, variables, and punctuation that must be entered in a command or statement. User-selected items. Indicates the items that appear one below the other in a vertical list. You select which item or items to include. A loop. Indicates an item or group of items that can be repeated. /2\ A bridge. Indicates the maximum number of times a loop can be repeated. A 6 TQ

237 Understanding Railroad Diagrams A.2. Following the Paths of a Railroad Diagram The paths of a railroad diagram lead you through the command or statement from beginning to end. Some railroad diagrams have only one path, while others have several alternate paths. The following railroad diagram indicates there is only one path that requires the constant LINKAGE and the variable <linkage mnemonic>: LINKAGE <linkage mnemonic> Alternate paths provide choices in the construction of commands and statements. Alternate paths are provided by loops, user-selected items, or a combination of both. More complex railroad diagrams can consist of many alternate paths, or nested diagrams, that show a further level of detail. For example, the following railroad diagram consists of a top path and two alternate paths. The top path includes an ampersand (&) and the constants (that are userselected items) in the vertical list. These constants are within a loop that can be repeated any number of times until all options have been selected. The first alternate path requires the ampersand and the required constant ADDRESS. The second alternate path requires the ampersand followed by the required constant ALTER and the required variable <new value>., & TYPE ASCII BCL DECIMAL EBCDIC HEX OCTAL ADDRESS ALTER <new value> TQ A 7

238 Understanding Railroad Diagrams A.3. Railroad Diagram Examples with Sample Input The following examples show five railroad diagrams and possible command and statement constructions based on the paths of these diagrams. Example 1 <lock statement> LOCK ( <file identifier> ) Sample Input LOCK (FILE4) %LOCK is a constant and cannot be altered. %Because no part of the word is underlined, %the entire word must be entered. The %parentheses are required punctuation and %FILE4 is a sample file identifier. Example 2 <open statement> OPEN <database name> INQUIRY UPDATE Sample Input OPEN DATABASE1 OPEN INQUIRY DATABASE1 OPEN UPDATE DATABASE1 %The constant OPEN is followed by the %variable DATABASE1, which is a database %name. The railroad diagram shows two %user-selected items, INQUIRY and UPDATE. %However, because there is an empty path %(solid line), these entries are not %required. %The constant OPEN is followed by the %user-selected constant INQUIRY and the %variable DATABASE1. %The constant OPEN is followed by the %user-selected constant UPDATE and the %variable DATABASE1. A 8 TQ

239 Understanding Railroad Diagrams Example 3 <generate statement> GENERATE <subset> = NULL <subset> AND <subset> OR + - Sample Input GENERATE Z = NULL GENERATE Z = X GENERATE Z = X AND B GENERATE Z = X + B %The GENERATE constant is followed by the %variable Z, an equal sign (=), and the %user-selected constant NULL. %The GENERATE constant is followed by the %variable Z, an equal sign, and the %user-selected variable X. %The GENERATE constant is followed by the %variable Z, an equal sign, the %user-selected variable X, the AND command %(from the list of user-selected items in %the nested path), and a third variable, B. %The GENERATE constant is followed by the %variable Z, an equal sign, the %user-selected variable X, the plus sign %(from the list of user-selected items in %the nested path), and a third variable, B. Example 4 <entity reference declaration>, ENTITY REFERENCE <entity ref ID> ( <class ID> ) TQ A 9

240 Understanding Railroad Diagrams Sample Input ENTITY REFERENCE ADVISOR1 (INSTRUCTOR) ENTITY REFERENCE ADVISOR1 (INSTRUCTOR), ADVISOR2 (ASST_INSTRUCTOR) %The required item ENTITY %REFERENCE is followed by the %variable ADVISOR1 and the %variable INSTRUCTOR. The %parentheses are required. %Because the diagram contains a %loop, the pair of variables can %be repeated any number of times. Example 5 PS MODIFY, <request number> <request number> - <request number> ALL EXCEPTIONS <file attribute phrase>, - <print modifier phrase> + A 10 TQ

241 Understanding Railroad Diagrams Sample Input PS MODIFY PS MODIFY 11159,11160,11163 PS MOD DESTINATION = "LP7" PS MOD ALL EXCEPTIONS %The constants PS and MODIFY are %followed by the variable 11159, %which is a request number. %Because the diagram contains a %loop, the variable can be %followed by a comma, the variable %11160, another comma, and the %final variable %The constants PS and MODIFY are %followed by the user-selected %variables , which are %request numbers, and the %user-selected variable %DESTINATION = "LP7", which is a %file attribute phrase. Note that %the constant MODIFY has been %abbreviated to its minimum %allowable form. %The constants PS and MODIFY are %followed by the user-selected %constants ALL and EXCEPTIONS. TQ A 11

242

243 Glossary A abnormal termination The type of termination that results when a process encounters a run-time error or is discontinued by an operator command or a statement in another process. abort active The abnormal termination of an active program or session, sometimes followed by an attempt to restart it. The state of a process that is executing normally, and is neither scheduled nor suspended. actual segment A group of contiguous words in main memory or on the disk subsystem. An actual segment can be a virtual segment or a single page of a paged virtual segment. address ALGOL area The identification of a location in storage (memory). Also, a sequence of bits, a character, or a group of characters that identifies a network station or a group of stations, a user, or an application. An address can also be the location of a device in the system configuration or the identification of the location of a disk sector. Algorithmic Language. A structured, high-level programming language that provides the basis for systems programming. The amount of contiguous disk space that is allocated at one time to a disk file as it is being created or expanded. An area is also referred to as a row. attached The adjective used to describe a station that is under the control of the CANDE message control system (MCS). attached station A station under the control of an MCS. TQ Glossary 1

244 Glossary B backup A copy of a file on a cataloging system that has been saved with the COPY & BACKUP Work Flow Language (WFL) statement. Also, a copy of a file that is stored offline so that it can be copied back in if the original file becomes corrupted or inaccessible. batch job An operation that contains all commands needed to accomplish a task or series of tasks. A batch job is executed through WFL or a CANDE command. batch mode An execution mode in which a group of commands or other input is transmitted and processed by the computer with no user interaction. BNAv2 A Unisys software architecture and associated software that connects ClearPath Enterprise Servers, A Series Enterprise Servers, and other devices so that the resources at one can be used at another. These resources include files, programs and processors. Boolean C An adjective that describes variables, data items, and attributes having a value of TRUE or FALSE. CANDE See Command and Edit. central processor module (CPM) The central processor for data processing in the MCP environment. channel In data communications, a communication path used to transmit signals between two or more points. CM (Change MCP) An operator display terminal (ODT) command that specifies a particular Master Control Program (MCP) code file on an optionally specified disk pack family as the MCP code file to be used at the next halt/load. Command and Edit (CANDE) A time-sharing MCS that enables a user to create and edit files, and to develop, test, and execute programs interactively. Communications Management Systems (COMS) A general MCS that controls online environments on MCP systems. COMS can support the processing of multi-program transactions, single-station remote files and multistation remote files. Glossary 2 TQ

245 Glossary COMS See Communications Management Systems. configuration A set of hardware resources in an installed system. In particular, a configuration is a representation of the devices in the I/O subsystem and memory subsystem. construct An element in the structure of a programming language. control character Any extra transmitted character used to control or facilitate data transmission over communication networks or between data terminal equipment (DTE) units. control command A CANDE input message that begins with a specific character, usually a question mark (?), and is used to control or interrogate the CANDE operating environment. A control command can be entered from any attached CANDE station. control program (CP) A program that has been marked by the CP system command. A control program runs at a higher priority than ordinary tasks and is less likely to be held scheduled. core-to-core overlay One of the processes the system uses to make memory space for program execution. To make enough space, the system moves code and data within memory. CP CPM See control program. See central processor module. D daemon A process that performs system-wide functions, such as administration and control of networks, execution of time-dependent activities, and line printing spooling. data collection That portion of TeamQuest SMFII or TeamQuest Online processing in which data for the TeamQuest SMFII database or TeamQuest Online monitor file is collected from MCP calls on the host system. data display That portion of TeamQuest SMFII or TeamQuest Online processing in which TeamQuest View accesses data in the TeamQuest SMFII database or the TeamQuest Online monitor file and displays the data in graphic or tabular format. TQ Glossary 3

246 Glossary Data Management Systems II (DSMII) The system responsible for storing and retrieving data while protecting its security and integrity. database An integrated, centralized system of data files and program utilities designed to support an application. The data sets and associated index structures are defined by a single description. Ideally, all the permanent data pertinent to a particular application resides in a single database. The database is considered a global entity that several applications can access and update concurrently. DCALGOL Data Communications ALGOL. A programming language that is specific to large system data communications environments. It is one of the languages supported by the SNA program-to-program communications for ClearPath MCP for local transaction programs. default The condition under which the system assigns a value for a process when the user does not specify an alternative value. dependent process A process that depends on the continued existence of another process, called the parent process. A dependent process is also referred to as a task. DMSII See Data Management Systems II. E EBCDIC F Extended Binary Coded Decimal Interchange Code. An 8-bit code representing 256 graphic and control characters that are the native character set for most mainframe systems. family One or more disks logically grouped together and treated as a single entity by the system. Each family has a name, and all disks in the family must have been entered into the family with the Reconfigure Disk (RC) system command. family name The name (label) of the disk or disk pack on which a physical file is located. The family name of a file is given by the value of the FAMILYNAME file attribute. file A named group of related records. Glossary 4 TQ

247 Glossary file attribute An element that describes the characteristic of a file and provides information the system needs to handle the file. Examples of file attributes are the file title, record size, number of areas, and date of creation. For disk files, permanent file attribute values are stored in the disk file header. file equation A mechanism for specifying the values of file attributes when a program is compiled or executed. File equations implicitly assign values to the FILECARDS task attribute. filename G A unique identifier for a file consisting of name constants separated by slashes. Each name constant consists of letters, digits, and selected special characters. GETSTATUS An intrinsic available to some programming languages that can be used to obtain the status of a job or task mix, the status of peripheral and disk units, and the status of the operating system and mainframe configuration. H halt/load A system-initialization procedure that temporarily halts the system and loads the operating system from disk to main memory. halt/load family The disk family that contains the current operative MCP object code file. header A data structure that contains information about a disk file, such as the physical location of the file on the disk and various file attributes. A header is also referred to as a disk file header. Also, a sequence of characters preceding the text of a message, containing routing or other communications-related information. host processor A central processing unit. One or more host processors can run together as part of a multiprocessor system. TQ Glossary 5

248 Glossary host software The part of TeamQuest SMFII or TeamQuest Online that resides on the MCP system and is responsible for collecting performance data, storing the data in the TeamQuest SMFII database or the TeamQuest Online monitor file, and maintaining the database or monitor file. The host software is the server in the client-server model. host system The system where the TeamQuest SMFII and TeamQuest Online software resides. hostname A unique name that identifies each host in a BNA network. A hostname consists of from 1 to 17 alphanumeric characters, inclusive. I I/O Input/output. An operation in which the system reads data from or writes data to a file on a peripheral device such as a disk drive. I/O control block (IOCB) A data structure used for communication between the host system and the I/O subsystem. I/O control word (IOCW) The area in the IOCB where information about the I/O operation to be performed resides. I/O processor (IOP) A specialized processor for moving data between system memory and the I/O subsystem. I/O subsystem The hardware and software that manage all transfers of information between the operating system and peripheral devices. installation A single computer configuration, facility, center, or system consisting of one or more mainframes and any possible combination of peripheral, communications, I/O, and other types of support devices. interactive mode An execution mode in which each command or item of data is validated and executed at the time it is entered at a terminal or workstation, allowing the user to see immediate results and correct errors as they are made. intrinsic A system-supplied program routine for common mathematical and other operations that is loaded onto the system separately. An intrinsic can be invoked by the operating system or user programs. Glossary 6 TQ

249 Glossary IOCB IOCW IOP See I/O control block. See I/O control word. See I/O processor. J job An independent process. The job of a particular task is the independent process that is the eldest ancestor of that task. Also, a group of one or more tasks, under the control of a single WFL program. The system assigns each job a mix number and treats each job as a discrete unit of work. job queue A structure in the system software that stores a list of WFL jobs that have been compiled and are waiting to be initiated. L library LINC log file logging A collection of one or more named routines or library objects that are stored in a file and can be called by other programs. See Logical and Information Network Compiler. A file that contains a record of system activity, including system utilization, messages, and peripheral activity. The process of recording events and, often, their times of occurrence. Logical and Information Network Compiler (LINC) A fourth-generation software development tool that enables programmers to create application programs at less cost and up to 10 times faster than by conventional programming methods. TQ Glossary 7

250 Glossary M MCP MCS mix The Master Control Program. The operating system that supports the Actual Segment Descriptor (ASD) memory architecture. Its functions include memory management, job selection, peripheral management, system utilization, program segmentation, subroutine linkage, and error logging. The message control system. A program that controls the flow of messages between terminals, application programs, and the operating system. MCS functions can include message routing, access control, audit and recovery, system management, and message formatting. The set of processes that currently exist on a particular computer. The mix can include active, scheduled, and suspended processes. mix number A unique, externally visible number that identifies a process while it is executing. This number is stored in the MIXNUMBER task attribute. MLI The message-level interface. The interface between the host system, the I/O subsystem, and the data communications subsystems. monitor file The files in the TeamQuest SMFII and TeamQuest Online database that hold data for real-time monitoring. monitor reports Monitor reports show real-time performance data as the activity occurs on the system. N NAP See Network Application Platforms. Network Applications Platform (NAP) A combination of software and hardware that facilitates the development and deployment of network applications. normal termination The termination of a process that has executed successfully, without any errors and without being terminated prematurely by an operator command or another process. Glossary 8 TQ

251 Glossary O ODT online See operator display terminal. Capable of immediate communication with a central computer, as in online documentation. Characterizing a disk mounted on a drive that is ready and has not been made inaccessible to the system with the UR (Unit Reserved), SV (Save), CLOSE (Close Pack), or FREE (Free Resources) ODT command, and whose label and flat directory (if it has one) have been read successfully. operator display terminal (ODT) A terminal or other device that is connected to the system in such a way that it can communicate directly with the operating system. The ODT allows operations personnel to accomplish system operations functions through either of two operating modes: system command mode or data command mode. overlay To load code or data into a memory area that was previously allocated to other code or data, and to write any data that previously occupied the area to a disk file, if necessary. P pack (PK) A random-access data storage device consisting of one or more circular platters that contain information recorded in concentric paths called tracks. Data on a pack are accessed by movable read/write heads. Some packs are removable. Packs are also referred to as disk packs. parameter A unique performance data item in the TeamQuest SMFII or TeamQuest Online database. parameter value A specific instance of data for a parameter in the TeamQuest SMFII or the TeamQuest Online database. A parameter value is identified by the parameter name, time, and date of the point. performance evaluation The analysis of system statistics to provide information on system activities and to identify any required corrective actions. PK See pack. TQ Glossary 9

252 Glossary port file A type of file for which file operations occur between a local user process and another process on the same host or on a remote host that is reachable through a network. A port file is made up of one or more subfiles, each of which supports one dialog. predefined reports The set of reports that are part of the TeamQuest View software released on CD-ROM. priority A characteristic associated with a task that determines its precedence in the use of system resources. A task with higher priority executes more quickly than a task with lower priority. privilege The ability to invoke actions that are not ordinarily allowed, such as accessing private files stored under other usercodes or invoking privileged functions such as SETSTATUS. The concept of privilege applies to usercodes, programs, and processes. privileged process A process that bypasses normal system security checks, thereby gaining access to a large number of system resources. A process initiated by a privileged program or run under a privileged usercode is a privileged process. privileged program An object code file marked as privileged with the PU of the Mark Program (MP) system command. privileged user A user with the PU usercode attribute assigned to his or her usercode in the USERDATAFILE. No file-access security checking is normally performed for actions taken under a usercode with privileged status. probe The components of the TeamQuest Manager that collect performance data from the operating system. processor A hardware component that executes programs and procedures. processor time The accumulated time a task has utilized a central processing unit (CPU) or central processing module (CPM) resource. This excludes time spent waiting for I/O operations or waiting for other events. program A specification of the sequence of computational steps that solve a computational problem. The steps are written (coded) in a particular programming language. Also, an object code file. Glossary 10 TQ

253 Glossary R railroad diagram A graphic representation of the syntax of a command statement. record A group of logically related items of data within a file which are treated as a unit. remote device An I/O unit or other piece of equipment that is physically removed from the computer but connected by a communications line. S session SL The interactions between a user and an MCS during a particular period of time that is assigned an identifying session number. Logging on initiates a new session; logging off terminates a session. Each MARC or CANDE dialog at a terminal accesses a different session. Also, in CANDE, the time from when a CANDE user enters a valid usercode/password combination until that user enters a CANDE SPLIT, BYE, or HELLO command. Each CANDE session is assigned a unique number. No output is printed until the session is ended. A system command that maps a function name to a library files. support library A library that is associated with a function name. User programs can access a support library by way of its function name instead of its code file title. The operator uses the SL (Support Library) system command to link function names with libraries. symbol table An internal table of a program usually used to keep track of all identifiers known to the program. syntax The rules or grammar of a language. system command Any of a set of commands used to communicate with the operating system. System commands can be entered at an ODT, in a Menu-Assisted Resource Control (MARC) session, or by way of the DCKEYIN function in a privileged DCALGOL program. system log file A file that contains a record of events for a particular system. system software The Master Control Program (MCP) and all other object code files necessary for system operation. TQ Glossary 11

254 Glossary T task A single, complete unit of work performed by the system, such as compiling or executing a program or copying a file from one disk to another. Tasks are initiated by a job, by another task, or directly by a user. TeamQuest Online A software product that is used to monitor system performance. TeamQuest Online uses software monitors to gather measurement data into a monitor file and makes it available for real-time monitor reports. TeamQuest Probes A host software product, which gathers performance data for TeamQuest SMFII or TeamQuest Online products. TeamQuest SMFII A software product used to monitor system performance. TeamQuest SMFII accepts input from existing standard system software interfaces and maintains selected data in its database. TeamQuest View The software product that provides the graphical user interface to the host software. TIME(7) TIME is an ALGOL function that makes various system time values available. A parameter value of 7 returns a word containing the current date and time in the following form: Field Meaning timestamp An encoded, 48-bit numerical value for the time and date. Various timestamps are maintained by the system for each disk file. Timestamps note the time and date a file was last created, last altered, and last accessed. U [47:12] [35:06] [29:06] [23:06] [17:06] [11:06] [05:06] Year ( ) Month (1 12) Day (1 31) Hour (0 23) Minute (0 59) Second (0 59) Day of the week (0 =Sunday, 1=Monday, and so on) usercode An identification code used to establish user identity, control security, and provide for segregation of files. Usercodes can be applied to every task, job, session, and file on the system. A valid usercode is identified by an entry in the USERDATAFILE. Glossary 12 TQ

255 Glossary W WFL See Work Flow Language. WFL job A WFL program or the execution of such a program. Also a collection of WFL statements that enable the user to run programs or tasks. Work Flow Language (WFL) The language used for constructing jobs that compile and run programs. WFL includes variables, expressions, and flow-of-control statements that offer the programmer a wide range of capabilities with regard to task control. TQ Glossary 13

256

257 Bibliography File Attributes Programming Reference Manual ( ). Unisys Corporation. GETSTATUS/SETSTATUS Programming Reference Manual ( ). Unisys Corporation. I/O Subsystem Programming Guide ( ). Unisys Corporation. SNMP Agent Implementation and Operations Guide ( ) Unisys Corporation. System Commands Operations Reference Manual ( ). Unisys Corporation. Task Attributes Programming Reference Manual ( ). Unisys Corporation. TeamQuest Express User Guide for Unisys MCP Systems (TQ 02262). TeamQuest Corporation. TeamQuest Products Installation Guide for Unisys MCP Systems (TQ 02212). TeamQuest Corporation. TeamQuest SMFII and TeamQuest Online Data Collectors Reference Manual for Unisys MCP Systems (TQ 02228). TeamQuest Corporation. TeamQuest SMFII and TeamQuest Online Utilities Reference Manual for Unisys MCP Systems (TQ 02261). TeamQuest Corporation. TeamQuest View User Guide (TQ 01401). TeamQuest Corporation. Work Flow Language (WFL) Programming Reference Manual ( ). Unisys Corporation. TQ Bibliography 1

258

259 Index A adding alarm action definition 4 38 alarm alias definition 4 30 alarm definition 4 17 workload set 4 45 workload to workload set 4 47 Administration Interface Alarm Policy 4 13 configuring alarms 4 15 default alarm definitions 4 14 edit pages 4 10 introduction 4 1 logging in 4 2 Probe Manager 4 13 selecting a database 4 5 task entry pages 4 9 using the interface 4 6 alarm actions adding definition 4 38 deleting definition 4 41 editing definition 4 40 viewing list of 4 37 alarm aliases adding definition 4 30 deleting 4 35 editing 4 33 viewing list of 4 29 alarm configuration adding alarm aliases 4 30 alarm definition 4 17 changing alarm status 4 26 deleting action definition 4 41 alarm definition 4 25 alias definition 4 35 editing action definition 4 40 alarm definition 4 24 alias definition 4 33 viewing action list 4 37 alarm list 4 16 alias list 4 29 alarm definitions, default 4 14 Alarm Policy overview 4 13 ALARMS command 3 4, 4 64 alarms, description 2 15 analyze workload set 4 56 AUTOQUIT command 3 5, 4 65 AUTOTF command 3 7, 4 67 C capabilities of TeamQuest SMFII 1 5 changing alarm status 4 26 workload set status 4 50 CLOSE command 3 9, 4 72 COLLECT command 3 30 commands ALARMS 3 4, 4 64 AUTOQUIT 3 5, 4 65 AUTOTF 3 7, 4 67 CLOSE 3 9, 4 72 COLLECT 3 30 CONFIGURE 3 10, 4 73 DATABASE 3 11, 4 75 HISTORY 3 13, 4 75 IOTRACE 3 15, 4 76 LIBRARY 3 17, 4 81 MONITOR 3 20, 4 82 MONITORDATABASE 3 23, 4 86 PORT 3 24, 3 76, 4 87 PRIORITY 3 29, 4 88 TQ Index 1

260 Index QUIT 3 29 SAMPLE 3 30, 4 89 STATUS 3 32, 4 91 TF 3 35 TIMING 3 33, 4 93 TRANSFER 3 35, 4 95 VERSION 3 36, 4 97 CONFIGURE command 3 10, 4 73 Configure_Probe routine 3 73 configuring alarms 4 15 constants, description A 2 constraints, description A 3 content area 4 8 creating alarm aliases 4 30 D data collection description 1 6, 1 9 program description 1 9 data display 1 6 data file organization 3 2 data items, PORTFILE interface 3 75 DATABASE command 3 11, 4 75 database selection 4 5 Datamapper utility, description 1 10 dbitem, description 2 6 Define_Characteristics routine 3 55 Define_Dbitem routine 3 47 Define_Key_Dbitem routine 3 51 Define_Key_Value routine 3 53 Define_Weight Factor routine 3 57 deleting alarm action definition 4 41 alarm alias definition 4 35 alarm definition 4 25 workload definition 4 55 workload set 4 54 Disable_Probe routine 3 70 E edit pages controls 4 11 description 4 10 editing alarm action definition 4 40 alarm alias definition 4 33 alarm definition 4 24 license-key file workload definition 4 53 workload set 4 51 Enable_Probe routine 3 68 F File Maintenance Utility (FMU), description 1 10 filename, description 2 6 G Get_Config_Info routine 3 62 Get_Workload_Info routine 3 63 H HISTORY command 3 13, 4 75 history database definition 2 2 description 1 10 modules and data files 2 3 structure 2 2 host software description 1 8 host-generated reports 1 10 I Initialize_Probe routine 3 65 initiating Probe Manager 4 61 installation, probe 3 74 interface format 4 6 IOTRACE command 3 15, 4 76 K key value, hierarchy 2 6 L LIBRARY command 3 17, 4 81 LIBRARY interface Configure_Probe routine 3 73 data types 3 39 Define_Characteristics routine 3 55 Index 2 TQ

261 Index Define_Dbitem routine 3 47 Define_Key_Dbitem routine 3 51 Define_Key_Value routine 3 53 Define_Weight_Factor routine 3 57 Disable_Probe routine 3 70 Enable_Probe routine 3 68 Get_Config_Info routine 3 62 Get_Workload_Info routine 3 63 Initialize_Probe routine 3 65 overview 3 37 probe installation 3 74 Probe Manager tasks 3 38 program flow 3 40 Sample_Probe routine 3 72 Smfii_Write routine 3 60 Terminate_Probe routine 3 71 license-key file editing viewing LOGCONSOLIDATOR program description 1 9 directory node 2 4 logging in to administration interface 4 2 logo/menu area 4 6 M MONITOR command 3 20, 4 82 monitor file, description 1 9, 2 5 MONITORDATABASE command 3 23, 4 86 N navigation bar, description 4 7 P parameter value, definition 2 6 parameter, definition 2 6 paths of railroad diagrams A 7 PORT command 3 24, 3 76, 4 87 PORTFILE interface characteristics 3 74 data items 3 75 example program 3 77 overview 3 74 PORT application example 3 76 PORT command 3 76 PORT declarations 3 75 PRIORITY command 3 29, 4 88 probe data collection 1 8 description 1 9 Probe Manager 4 86 ALARMS command 3 4, 4 64 AUTOQUIT command 3 5, 4 65 AUTOTF command 3 7, 4 67 CLOSE command 3 9, 4 72 COLLECT command 3 30 commands 3 3 CONFIGURE command 3 10, 4 73 configuring 3 45 data file organization 3 2 DATABASE command 3 11, 4 75 default alarm definitions 4 14 description 1 9, 4 13 directory node 2 4 HISTORY command 3 13, 4 75 initialization 3 40 interfaces 3 37 IOTRACE command 3 15, 4 76 LIBRARY command 3 17, 4 81 LIBRARY interface Configure_Probe routine 3 73 data types 3 39 Define_Characteristics routine 3 55 Define_Dbitem routine 3 47 Define_Key_Dbitem routine 3 51 Define_Key_Value routine 3 53 Define_Weight_Factor routine 3 57 Disable_Probe routine 3 70 Enable_Probe routine 3 68 Get_Config_Info routine 3 62 Get_Workload_Info routine 3 63 Initialize_Probe routine 3 65 overview 3 37 probe installation 3 74 Probe Manager tasks 3 38 program flow 3 40 Sample_Probe routine 3 72 Smfii_Write routine 3 60 Terminate_Probe routine 3 71 License Management editing the license-key viewing the license-key MONITOR command 3 20, 4 82 MONITORDATABASE command 3 23 overview 3 1 PORT command 3 24, 4 87 TQ Index 3

262 Index PORTFILE interface characteristics 3 74 data items 3 75 example program 3 77 overview 3 74 PORT application example 3 76 PORT command 3 76 PORT declarations 3 75 PRIORITY command 3 29, 4 88 QUIT command 3 29 SAMPLE command 3 30, 4 89 sampling performance data 3 42 starting 3 41 STATUS command 3 32, 4 91 stopping 3 43 terminating 3 44 TF command 3 35 TIMING command 3 33, 4 93 TRANSFER command 3 35, 4 95 VERSION command 3 36, 4 97 Probe Manager Policy overview 4 60 Probe Manager commands 4 63 initiating 4 61 terminating 4 62 product capabilities 1 5 program flow, LIBRARY interface 3 40 Q QUIT command 3 29 R Railroad Constraints, (table) A 6 railroad diagrams constants and variables A 2 constraints A 3 examples A 8 following the paths A 7 understanding A 1 registering probe characteristics 2 9 resource, description 2 6 S SAMPLE command 3 30, 4 89 Sample_Probe routine 3 72 selecting a database 4 5 Smfii_Write routine 3 60 specifying order of workloads 4 49 workload definitions 2 10 workload probe characteristics 2 9 STATUS command 3 32, 4 91 SYMBOLTABLE file, description 2 2 T task entry pages, description 4 9 TeamQuest Express, product overview 1 2 TeamQuest Extended NAP Probes, product overview 1 2 TeamQuest Model, product overview 1 3 TeamQuest Online components 1 6 product overview 1 2 TeamQuest PMPlus, product overview 1 3 TeamQuest Probes, product overview 1 2 TeamQuest SMFII capabilities 1 5 components 1 6 product overview 1 2 TeamQuest SMFII Administration Interface Alarm Policy 4 13 configuring alarms 4 15 default alarm definitions 4 14 edit pages 4 10 introduction 4 1 logging in 4 2 Probe Manager 4 13 selecting a database 4 5 task entry pages 4 9 using the interface 4 6 TeamQuest View database objects 2 6 description 1 11 hierarchy 2 6 Terminate_Probe routine 3 71 Index 4 TQ

263 Index terminating Probe Manager 4 62 TF command 3 35 TIMING command 3 33, 4 93 TRANSFER command 3 35, 4 95 U understanding railroad diagrams A 1 V validating PORT declarations 3 75 value type, description 2 6 variables, description A 2 VERSION command 3 36, 4 97 viewing alarm actions list 4 37 alarm alias list 4 29 alarm list 4 16 license-key file workload set list 4 44 W workload definition adding to workload set 4 47 analyze 4 56 deleting 4 55 editing 4 53 field descriptions 4 48 workload definition language Boolean expressions 2 13 description 2 10 numerical conditions 2 11 operators 2 13 string conditions 2 11 Workload Policy overview 4 43 workload set adding 4 45 changing the status 4 50 deleting 4 54 editing 4 51 field descriptions 4 46 viewing list of 4 44 workload order 4 49 workloads registering probe characteristics 2 9 specifying probe characteristics 2 9 specifying workload definitions 2 10 workload definition language 2 10 workload characterization 2 7 workload configuration adding workload set 4 45 workload to workload set 4 47 analyze workload set 4 56 changing workload set status 4 50 deleting workload definition 4 55 workload set 4 54 editing workload definition 4 53 workload set 4 51 specifying workload order 4 49 viewing workload set list 4 44 TQ Index 5

264