Control Managers User’s Guide - IBMpublib.boulder.ibm.com/tividd/td/ITIntegRM/GC32-9222-00/en_US/PDF/GC32... · user's system description and the enabled applications. The following

Control Managers User’s GuideIntegrated Resource Manager

Version 500

GC32-9222-00

September 2002

Candle Corporation201 North Douglas Street

El Segundo, California 90245

2 IRM Control Managers User’s Guide Version 500

Registered trademarks and service marks of Candle Corporation: AF/OPERATOR, AF/PERFORMER, AF/REMOTE, Availability Command Center, Candle Command Center, Candle Electronic Customer Support, Candle logo, Candle Management Server, Candle Management Workstation, Candle Technologies, CL/CONFERENCE, CL/SUPERSESSION, CT, CT/Data Server, CT/DS, DB Logo, DB/QUICKCHANGE, DELTAMON, ETEWatch, IntelliWatch, MQSecure, MQView, OMEGACENTER, OMEGAMON, OMEGAMON/e, OMEGAMON II, OMEGAMON Monitoring Agent, OMEGAVIEW, OMEGAVIEW II, Solutions for Networked Businesses, and Transplex.Trademarks and service marks of Candle Corporation: Alert Adapter, Alert Adapter Plus, Alert Emitter, AMS, Amsys, AUTOMATED FACILITIES, Availability Management Systems, Candle Business Partner Logo, Candle Direct Logo, CandleLight, CandleNet, CandleNet 2000, CandleNet Portal, Candle CommandPro, CCC, CECS, CICAT, CL/ENGINE, CL/GATEWAY, CL/TECHNOLOGY, CMS, CMW, Command & Control, CommandWatch, Connect-Two, CSA ANALYZER, CT/ALS, CT/Application Logic Services, CT/DCS, CT/Distributed Computing Services, CT/Engine, CT/Implementation Services, CT/IX, CT/Workbench, CT/Workstation Server, CT/WS, DB/DASD, DB/EXPLAIN, DB/MIGRATOR, DB/QUICKCOMPARE, DB/SMU, DB/Tools, DB/WORKBENCH, Design Network, DEXAN, eBA*ServiceMonitor, End-to-End, Enterprise Candle Command Center, Enterprise Candle Management Workstation, EPILOG, ERPNet, ESRA, ETEWatch, HostBridge, IntelliWatch Pinnacle, Lava Console, Messaging Mastered, MQADMIN, MQEdit, MQEXPERT, MQMON, NBX, OMA, OMC Gateway, OMC Status Manager, OMEGACENTER Bridge, OMEGACENTER Gateway, OMEGACENTER Status Manager, OMEGAMON Management Center, OSM, PC COMPANION, Performance Pac, PowerQ, PQConfiguration, PQEdit, PQScope, Response Time Network, Roma, Roma Application Manager, Roma Broker, Roma BSP, Roma Connector, Roma Developer, Roma FS/A, Roma FS/Access, Roma Network, Roma Object Access, Roma Systems Manager, Roma WF/Access, Roma Workflow Access, RTA, RTN, SentinelManager, Solutions for Networked Applications, Status Monitor, Tracer, Unified Directory Services, and Volcano.Trademarks and registered trademarks of other companies: AIX, DB2, and MQSeries are registered trademarks of International Business Machines Corporation. SAP is a registered trademark and R/3 is a trademark of SAP AG. UNIX is a registered trademark in the U.S. and other countries, licensed exclusively through X/Open Company Ltd. HP-UX is a trademark of Hewlett-Packard Company. SunOS is a trademark of Sun Microsystems, Inc.

All other company and product names used herein are trademarks or registered trademarks of their respective companies.

ProtoView Development Corp. - May contain DataTable Version 3.0 Copyright 1989 - 1996 by ProtoView Development Corp. and distributed under license by Candle Corporation.

Copyright © September 2002, Candle Corporation, a California corporation. All rights reserved. International rights secured.

Threaded Environment for AS/400, Patent No. 5,504,898; Data Server with Data Probes Employing Predicate Tests in Rule Statements (Event Driven Sampling), Patent No. 5,615,359; MVS/ESA Message Transport System Using the XCF Coupling Facility, Patent No. 5,754,856; Intelligent Remote Agent for Computer Performance Monitoring, Patent No. 5,781,703; Data Server with Event Driven Sampling, Patent No. 5,809,238; Threaded Environment for Computer Systems Without Native Threading Support, Patent No. 5,835,763; Object Procedure Messaging Facility, Patent No. 5,848,234; End-to-End Response Time Measurement for Computer Programs, Patent No. 5,991,705; Communications on a Network, Patent Pending; Improved Message Queuing Based Network Computing Architecture, Patent Pending; User Interface for System Management Applications, Patent Pending.

NOTICE: This documentation is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions set forth in the applicable license agreement and/or the applicable government rights clause.

This documentation contains confidential, proprietary information of Candle Corporation that is licensed for your internal use only.Any unauthorized use, duplication, or disclosure is unlawful.

Contents 3

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Adobe Portable Document Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Printing problems? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Panels and figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Revision bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Variables and literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Documentation Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Online Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Printed documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

What’s New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 1. IRM Initialization Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17AF/OPERATOR Start Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Application Processing Mode . . . . . . . . . . . . . . . . . . . . . . 19Automation Application Initialization . . . . . . . . . . . . . . . . . 20

Chapter 2. Application Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21System Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22@APLMSGS - Application Message Table . . . . . . . . . . . . . . . . . . . . . 25@APLAOCM - AF/OPERATOR Command Table . . . . . . . . . . . . . . . 27

Contents

Contents


Controlling Application Manager Resources . . . . . . . . . . . . . . . . . . . 28APL Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Application Command Processor (KAUA@CMD) . . . . . . . 38APL Command On-line Help . . . . . . . . . . . . . . . . . . . . . . 38

Chapter 3. Table Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Table Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Table Management Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Stored Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Created Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Table Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Controlling Table Manager Resources . . . . . . . . . . . . . . . . . . . . . . . . 49TBL Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . 50TBL Command On-line Help . . . . . . . . . . . . . . . . . . . . . . 54

Chapter 4. System Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55System Variable Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56User Variable Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65User Variable Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

User Variable Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Calendar Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Checkpointed Control Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Chapter 5. AF/OPERATOR Commands Definitions . . . . . . . . . . . . . . . . . . 77AF/OPERATOR Commands Definitions . . . . . . . . . . . . . . . . . . . . . . 78

Order of Cmd Execution. . . . . . . . . . . . . . . . . . . . . . . . . . 80

Appendix A. Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Electronic support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Telephone support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Customer support locations and numbers . . . . . . . . . . . . . 86Incident documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . 88Ensuring your satisfaction with customer support . . . . . . . 88

List of Figures 5

FIGURE 1. APL Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29FIGURE 2. Table Format Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45FIGURE 3. Table Format Example - Keyed Tables . . . . . . . . . . . . . . . . . . . . . . . . 47FIGURE 4. TBL Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

List of Figures


Preface 7

Preface

About this DocumentThis guide provides instructions on how to use the Integrated Resource Manager (IRM) version 500 Control Managers.

This guide is directed to the systems operator(s) responsible for using the Integrated Resource Manager. It assumes that you have some previous experience in using mainframe software and knowledge of MVS systems and SMP/E.

IntroductionThe Application Manager establishes the base environment for all IRM automation applications.The base environment is established based on the user's system description and the enabled applications. The following chapters describe the setup of the base environment, a pre-requisite to defining resources to the automation applications and starting the IRM run time environment.

Chapter 1 describes how to enable automation applications and tables, define system and user variables, and define initialization commands and traps.Chapter 2 describes Application Manager facilities, parmlib members, creation of user parmlib members, initialization and the IRM run time environment.Chapter 3 describes how to control Application Manager resources.

P


PrerequisitesThis guide assumes that AF/OPERATOR, or OMEGACENTER Gateway for MVS, and the Integrated Resource Manager has been SMP/E installed and that maintenance has been applied to bring them up to current levels of service. For information on installing AF/OPERATOR refer to Installing Candle Products on MVS (IC51-6057).

Refer to the AF/OPERATOR and the IRM Configuration and Customization Guide for additional information on installing and configuring AF/OPERATOR and IRM respectively.

Preface 9

Adobe Portable Document Format


IntroductionCandle supplies documentation in the Adobe Portable Documentation Format (PDF). The Adobe Acrobat Reader prints PDF documents with the fonts, formatting, and graphics as contained in the original document. To print a Candle document, perform the following:

1. Specify the print options for your system. From the Acrobat Reader Menu bar, select File > Print Setup... and make your selections. A setting of 300 dpi is highly recommended as is duplex printing if your printer supports it.

2. To start printing, select File > Print on the Acrobat Reader Menu bar.3. On the Print popup, select one of the Print Range options for:

– a single page

– a range of pages

– all of the document

(Optional)

4. To fit oversize pages to the paper size currently loaded on your printer, select the Shrink to Fit option.

Printing problems?Your printer usually determines the print quality of your output. Sometimes printing problems can occur. If you experience printing problems, potential areas to check are:

� settings for your printer and printer driver. (The 300 dpi settings for both your driver and printer should be the same. A setting of 300 dpi is recommended.)

� the printer driver you are using. (You may need a different printer driver or the Universal Printer driver from Adobe. This free printer driver is available at www.adobe.com.)



� the halftone/graphics color adjustment for printing color on black and white printers. (Check the printer properties under Start > Settings > Printer. For more information, see the online help for the Acrobat Reader.)

� the amount of available memory in your printer. (Insufficient memory can cause a document or graphics to fail to print.)

For additional information on printing problems, refer to the documentation for your printer or contact your printer manufacturer.

Preface 11

Documentation Conventions


IntroductionCandle documentation adheres to accepted typographical conventions for command syntax. Conventions specific to Candle documentation are discussed in the following sections.

Panels and figuresThe panels and figures in this document are representations. Actual product panels may differ.

Revision barsRevision bars (|) may appear in the left margin to identify new or updated material.

Variables and literalsIn examples of command syntax, uppercase letters are actual values (literals) that the user should type; lowercase letters are used for variables that represent data supplied by the user. Default values are underscored.

LOGON APPLID(cccccccc)

In the above example, you type LOGIN APPLID followed by an application identifier (represented by cccccccc) within parentheses. The number of characters indicates the maximum allowable length of the variable.

Note: In ordinary text, variable names appear in italics.



SymbolsThe following symbols may appear in command syntax.

Table 1. Symbols

Symbol Usage

| The ‘or’ symbol is used to denote a choice. Either the argument on the left or the argument on the right may be used. For example:

YES | NO

In this example, YES or NO may be specified.

[ ] Denotes optional arguments. Those arguments not enclosed in square brackets are required. For example:

APPLDEST DEST [ALTDEST]

In this example, DEST is a required argument and ALTDEST is optional.

{ } Some documents use braces to denote required arguments, or to group arguments for clarity. For example:

COMPARE {workload} -

REPORT={SUMMARY | HISTOGRAM}

The workload variable is required. The REPORT keyword must be specified with a value of SUMMARY or HISTOGRAM.

_ Default values are underscored. For example:

COPY infile outfile -

[COMPRESS=YES | NO}]

In this example, the COMPRESS keyword is optional. If specified, the only valid values are YES or NO. If omitted, the default is YES.

b The symbol b indicates a blank space, when needed for clarity.

Preface 13

Documentation Set

Documentation Set

IntroductionCandle provides a complete set of documentation for the Integrated Resource Manager. Each manual in this documentation set contains a specific type of information to help you use the product.

Candle welcomes your comments and suggestions for changes or additions to the documentation set. A user comment form, located at the back of each manual, provides simple instructions for communicating with Candle's Information Development department. You can also send electronic mail to [email protected]. Please include the product name, version, and book title in the subject line. To order additional manuals, contact Candle Customer Support.

Online DocumentationAll documents in the Integrated Resource Manager documentation set are available online.

Printed documentationThe documentation listed in the following table is available for the Integrated Resource Manager. To order additional product manuals, contact your Candle Support Services representative.

Documentation Set


Table 2. Integrated Resource Manager Documentation

DocumentNumber

Document Name Description

AU51-6292 Integrated Resource Manager Configuration and Customization Guide

Explains how to configure and customize the Integrated Resource Manager after it is installed.

AU54-6514 Integrated Resource Manager Primary Managers User’s Guide

Provides a task-oriented guide to using the Integrated Resource Manager. Explains basic features and navigation methods for the Primary Managers.

AU54-6296 Integrated Resource Manager Control Managers User’s Guide

Provides a task-oriented guide to using the Integrated Resource Manager. Explains basic features and navigation methods for the Control Managers.

AU54-6295 Integrated Resource Manager AF/OPERATOR and Subsystem Managers User’s Guide

Provides a task-oriented guide to using the Integrated Resource Manager. Explains basic features and navigation methods.

AU53-6251 Integrated Resource Manager Functions and Other Facilities Manual

Provides comprehensive reference information about the features of the Integrated Resource Manager.

AU52-6293 Integrated Resource Manager Messages Manual

Provides a reference summary of all Integrated Resource Manager messages.

AU99-6297 Integrated Resource Manager Command Quick Reference Guide

Quick Reference Handbook that explains the format and parameters for the Integrated Resource Manager console commands

OMC99-4833 Candle Products Program Directory

Provides installation instructions and details all other installation consideration.

What’s New

W
Summary
This section summarizes the new features and enhancements incorporated into Version 500 of the Integrated Resource Manager.

IRM Version 500 enhancements include:

� IRM automation support for ARM managed tasks

� Support for use of remote tasks as predecessors

� Sysplex-wide Task Status table

What’s New 15


IRM Initialization Process 17

IRM Initialization Process

IntroductionBefore initializing the Automation Applications, an application base environment must be created. Initialization of the application base environment must be one of the first tasks scheduled when starting AF/OPERATOR.

Chapter ContentsAF/OPERATOR Start Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Application Processing Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Automation Application Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1

AF/OPERATOR Start Process



When AF/OPERATOR is started, the Automation Application environment is established in the following manner:

� AF/OPERATOR reads the initialization parameter deck, KAU0OGxx, specified in the start command:

S AFOPER,SYS=smfid,TYPE=xx,SUB=MSTR

where smfid is the system SMF ID and xx specifies the application processing mode and can be one of the following values:

– AO Automated Mode IPL

– MN Maintenance Mode IPL

– CK Checkpoint IPL

See the following section for more information about the application processing mode.

Once AF/OPERATOR is started, AF/OPERATOR and the Automation Applications can then establish the rest of the system.

� The AF/OPERATOR parameter deck member, KAU0OGxx parameter deck specifies the first command file for AF/OPERATOR to execute, KAUAINIT. A parameter which represents the application processing mode, must be passed to KAUAINIT and must be specified as follows:

– Automated Mode IPL (AO) CMD(‘EXEC KAUINIT “AUTO”’)

– Maintenance Mode IPL (MN) CMD(‘EXEC KAUAINIT “MANUAL”’)

– Checkpoint IPL (CK) CMD(‘EXEC KAUAINIT “CHKP”’)

The parameter passed to the KAUAINIT exec determines the method of initialization for the Automation Applications. This parameter will be made available to all of the automation applications controlled by the Application Manager.

IRM Initialization Process 19


Application Processing ModeThe application processing mode determines how the system will be established after a system IPL. An automated IPL will bring up all resources defined to the system. During a manual IPL, the Automation Applications will bring up only those resources that have been defined with the AUTO keyword. A checkpoint restart is used to restart the Automation Applications where they left off; all checkpointed Automation Application control information will be restored and the applications will respect any previously entered dynamic control information.

The manual IPL option is used to bring up a system in maintenance mode; only those tasks, messages or other controlled resources that are absolutely necessary are activated. For example, in the case of started tasks, LLA, VLF and JES, could be defined as the only tasks that will be activated by the Started Task Manager during a maintenance mode IPL. This allows you to perform whatever system maintenance is necessary before an entire system is established.

The intent of the AUTO keyword is to allow you to specifically designate those resources, controlled by automation, which are absolutely necessary for a skeleton maintenance system. Any resource defined with the AUTO keyword will be automatically started regardless of the application processing mode.

Note: Refer to the documentation for the individual applications to determine how to define resources with the AUTO keyword.

The checkpoint option, CHKP, is used to establish a system in the exact configuration it was in before AF/OPERATOR or the system was brought down or failed. All dynamic control information is re-established from checkpointed AF/OPERATOR system variables and the system is placed in a comparable state to that which it was in the last time the Automation Applications were active.



Automation Application InitializationThe KAUAINIT exec is used to initialize the Automation Application environment. This exec performs the following functions:

� Set the AF/OPERATOR system variables, @APLAUTO and @APLCHKP, that establish the processing mode for the rest of the Automation Applications.

� Start the REXX Table Management Services.

� Create the AF/OPERATOR system variables that describe the system to the Automation Applications.

� Create and initialize the calendar variables.

� Execute the AF/OPERATOR Commands Definitions.

� Create the Application Manager console command.

� Initialize and start the rest of the applications.

Application Manager 21

Application Manager

IntroductionThe Application Manager establishes the base environment for all IRM automation applications.The base environment is established based on the user's system description and the enabled applications. The following chapters describe the setup of the base environment, a pre-requisite to defining resources to the remaining automation applications.

During AF/OPERATOR initialization, KAUAINIT, the Automation Application initialization routine will be called. This command file initializes the Application Manager environment which, in turn, will initialize and start each application that is defined to the system.

Chapter ContentsSystem Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22@APLMSGS - Application Message Table . . . . . . . . . . . . . . . . . . . . . . . . 25@APLAOCM - AF/OPERATOR Command Table . . . . . . . . . . . . . . . . . . . 27Controlling Application Manager Resources . . . . . . . . . . . . . . . . . . . . . . . 28

2

System Definitions


System Definitions

Automation applications are defined to the Application Manager through the ISPF User Interface. All automation applications that are enabled will automatically be started during IRM initialization.Automation application definitions are stored in the Application Control Table, @APLCNTL, which is a member of the table dataset, hilev.RKAUTBLR.

To begin defining automation applications, select option 12, AF/OPERATOR Resources, from the main ISPF User interface panel. Select option 1 for the Systems Definitions panel.If this is the first system definition, the following screen will be blank.Type 'ADD' on the command line to begin the system definition process. If previous system definitions exist, either the Add or Copy process may be used to create subsequent system definitions. The System Add or System Copy panel will be displayed.The following describes the fields contained on the System Definition panel. The name of the table column corresponding to each panel field will be included for reference.

SMF ID The SMF ID field defines the SMF ID of the system that is being defined.The SMF ID is the same as the one specified on the SID statement of member SMFPRMxx in dataset SYS1.PARMLIB.

This is a four character field, which may contain any EBCDIC character with the exception of an asterisk (*) or quotes (' , ") and which must not begin with one of the Rexx Table special characters (*+%-/).

This is the row name of the record in the @APLCNTL table and does not have a corresponding column name.

Description The Description field is used to specify a one line, 'plain English' description of the resource for the user's reference.This information is displayed on the Application Manager System Selection panel.

The @APLCNTL table column name for this field is APL_DESCRIPT.


System Definitions

Enable (Ena) The Enable field is used to define an application to a system.Enter a 1 (one) if you wish to use this application on this system.Enter a 0 (zero) if the application will not be needed, or used, on this system.Repeat this process for each application that should be enabled on this system.The Application and Table Managers and the Command Interface are enabled by default and cannot be disabled by the user.

There is no corresponding column in the @APLCNTL table for this field.

Initialize (Ini) The Initialize Field is used to control whether or not the application is automatically started during Application Manager initialization.

Enter a 1 to start the application automatically. Each application must be started before it can begin to manage the resources under its control; which includes initializing and starting those resources.

Enter a 0 to bypass automatic application start-up. If automatic application start-up is bypassed, the application will not start until an 'APL START xxx' command is manually issued at an MCS console.

The @APLCNTL table column name for these fields is the application mnemonic. The mnemonic for each of the applications is:� Application Manager APL� Table Manager TBL� Started Task Manager RCF� Message Manager MCF� Command Manager CCF� Schedule Manager SCF� VTAM Manager VTM� Device Manager DEV� Console Manager CNS� AF/OPERATOR Manager AOP� AF/REMOTE Manager AFR

System Definitions


� Peer-to-Peer Manager P2P� Omegamon Logon Manager OM2� POVI Session Manager OVI� Communication Manager COM� MVS Manager MVS� JES Manager JES� TSO Manager TSO� CICS Manager CIC� IMS Manager IMS� XRF Manager XRF

Note: The Application and Table Managers must be initialized to start any of the other automation applications. An application cannot be initialized without being enabled. In other words, if an application is not enabled, it cannot be initialized.

Command Prefix (Cmd)

The Command Prefix Field is used to define the command prefix for the application on this system.The application command prefix must be a unique three character alphanumeric string (A-Z, 0-9) with no imbedded blanks.

The default application command prefix is displayed on the panel. If a different command prefix is desired, this field must be changed. If this is a secondary or more copy of the IRM for this system, the command prefix for all applications that will be initialized on this system must be changed. Multiple copies of the IRM on the same system cannot have the same command prefix for an application.For example,� Primary IRM specify command prefix RCF� Secondary IRM specify command prefix RC2� Tertiary IRM specify command prefix RC3


@APLMSGS - Application Message Table


The Application Message table stores information on the messages issued by the Automation Applications. @APLMSGS is a keyed table. The first three fields in the table are the keys by which a message is referenced.

MSG_ID This field identifies the 4-character message ID.

MSG_FRMT This field identifies the format number of the message.

MSG_LINE This field identifies the line number of the message.

MSG_PRFX This field identifies the 3-character message ID prefix.

MSG_SUFX This field identifies the 1-character message ID suffix:� A Action message� E Error message� I Informational message� W Warning message

MSG_NOID This field is used to specify a message that is to be issued without a message ID. Message IDs are constructed from the aforementioned information and concatenated to the message text before the message is displayed. Specify a 1 in this field, if just the message text is to be displayed. The default is 0, a message ID will be generated and attached to the message text before the message is displayed.

MSG_ALOG This field specifies a message that is to be written to the AF/OPERATOR Message Log. Code a 1 in this field if the message is to be logged. The default is 0; the message is not logged.

MSG_MLOG This field specifies a message that is to be suppressed if the @APLMSG flag is off. Code a 1 in this field if the message is a candidate for application message reduction.

MSG_WTOR This field specifies a message that is to be displayed as a WTOR. Code a 1 in this field if the message is a WTOR. The default is 0, the message is not a WTOR.

MSG_DOM This field is used in conjunction with the MSG_WTOR field. If there are messages displayed prior to issuing the WTOR, the messages can be deleted from the operator console after a reply is received by coding a 1 in this field.



MSG_MLW This field flags messages that are part of a multi-line WTO. Code a 1 for primary and intermediate lines of the MLWTO. Code a 2 to designate the last line of the MLWTO. Code a 0 if the message is not part of an MLWTO.

MSG_ROUT This field designates the route code for the message. Code a valid MVS route code.

MSG_DESC This field designates the descriptor code for the message. Code a valid MVS descriptor code.

MSG_CONS This field designates the console ID that is to receive the message.

MSG_TEXT This field is used for the message text. Code the message text, without the message ID, enclosed in double quotes ("). If there are portions of the message text that must be completed at the time the message is issued, code a place holder in the message text. Place holders are designated by an '&n' and are in the range: &1 to &20. Place holders can then be replaced by substitution values when issuing the message.

MSG_SUBL This field is used to hard-code the lengths of substitution values. Normally, when the message text is reformatted with substitution values, excess blanks in the text are removed. This field allows you to specifically designate the space occupied by a substitution value, regardless of its true length. This field should consist of a list of numbers; each number, in order, represents the length of a substitution value.

If a substitution value in a message does not have a pre-defined length, code an asterisk (*):

"8 * 12 * 8"

enclosing the entire string in double quotes (").


@APLAOCM - AF/OPERATOR Command Table

@APLAOCM - AF/OPERATOR Command Table

The AF/OPERATOR Command table is used to store information on the generic AF/OPERATOR commands to issue on each system. These commands are:

AO_SMF This field is used to define the system in which the command is to execute.

AO_CMD This field is used to specify the AF/OPERATOR command. Code a fully qualified AF/OPERATOR command.

Controlling Application Manager Resources



The APL command provides an operator interface to give you on-line control of the applications defined to the Application Manager. It is used to communicate with AF/OPERATOR and the Application Manager service subroutines to control the Automation Applications and display information about the applications from the MVS console. The APL command allows you to:

� Start or Stop an Automation Application.

� Enable or Disable an Automation Application.

� Display the status of an Automation Application.

� Display the status of an Automation Application Control Variable.

� Change the Automation Application system definition Control Variables.



APL Command SyntaxThe following table shows the APL available commands. To protect against unintentional command errors, certain function/appl name/options are prohibited. This includes:

� Functions INIT, START, STOP, INSTALL, REFRESH, ENABLE, or DISABLE with appl name ALL or * with the FORCE option.

� Functions SET or RESET with appl name ALL or * with the VARIABLE option.

FIGURE 1. APL Command Syntax

APL function appl name optionINIT ALL FORCESTART *STOP APPL_NAME CONSOLE=considINSTALL PATTERNREFRESH

ENABLEDISABLE

HELPSHOWSTATUSDISPLAY

HELP MSGID

*ALLAFRC |=addr |AFR2 |=addr |AFR3 |=addr |ARP |=link |



APL function appl name optionAUTO |=ON |=OFF||CA7DCA7ICA7PCA7UCHKP |=ON |=OFF||CITYCLND |=ON |=OFF||CLXNCNTRDENV |=var |DESC |=4 |=6 |=12 ||FOLD |=ON |=OFF ||IPLIPLD

SET JCM |=var |RESET VARIABLE JES |=GLB |=LCL |=SAG ||

JMN |=var |MSG |=ON |=OFF ||MS1 |=var |MS2 |=var |MS3 |=var |MS4 |=var |NRDRPFXAPFXTPFXUPLEX |=var |PLPS |=var |PREFROUT |=rout |SSYS |=JES2 |=JES3||VTAMVTIDVTML



APL function appl name optionVTSAWTOR |=#### |=###|=## ||XRF |=ACT |=ALT |=N/A ||

EXEC=name

|O||A||C||E|

SET TRACE TRACE= |F|DISPLAY |I|

|L||N||R||S|

TRACK= |0||1|

RESET CALENDARDISPLAY

RESET AOCMDSDISPLAY

DISPLAY STATISTIC



Parameters

Function - Required

Objects - Required

Options - Optional

Functions

The function parameter is used to tell the Application Manager which action to perform. Acceptable function abbreviations are noted with the function's description.

INIT Initializes and starts an Automation Application. Refer to the documentation for the individual application to determine what resources it will begin to manage or if any further actions are necessary. No abbreviations of the INIT keyword are acceptable.

START Starts an Automation Application. Automation Applications are automatically started at AF/OPERATOR initialization time. This command is only used after the application has been stopped via an APL STOP command. No abbreviations of the START keyword are acceptable.

STOP Stops an Automation Application. A WTOR will be displayed to confirm the application shutdown. All traps associated with the application will be deleted and all resources under the control of the application will revert to manual control. No further actions will be taken by the Automation Application until it is re-started by the APL START command. No abbreviations of the STOP keyword are acceptable.

INSTALL Installs an Automation Application. All retained system variables for the application are deleted, Automation Application tables are re-loaded from the table dataset, and the application will be initialized and started. No abbreviations of the INSTALL keyword are acceptable.

ENABLE Enables an Automation Application. This command is used to enable an Automation Application that has been previously disabled by an APL DISABLE command. All traps associated with the application will be enabled. Valid abbreviations are: ENA.



Variable Functions

DISABLE Disables an Automation Application. All traps associated with the application will be disabled, including the command trap for the application operator command. No further actions will be taken by the application until it is re-enabled via an APL ENABLE command. No abbreviations of the DISABLE keyword are acceptable.

HELP Displays the Application Manager on-line message help file on the operator console. No abbreviations of the HELP keyword are acceptable.

SHOW Shows all traps associated with the Automation Application. Valid abbreviations are: SH.

STATUS Issues a WTO to the MVS console that indicates the Application Manager status for the specified application. Valid abbreviations are: STAT and S.

An application can be in any one of the following states:� DEFINED The Application Manager knows about the

application, but it is not enabled.� ENABLED The application is enabled.� DISABLED The application is disabled.� UNKNOWN The application's status is unknown.� DISPLAY The DISPLAY and STATUS keywords are

synonyms. Valid abbreviations are: DIS and D.

SET Sets an Automation Application control variable to the specified value. No abbreviations of the SET keyword are acceptable.

DISPLAY Displays the current value of an Automation Application control variable. Valid abbreviations are: DIS and D.



Application Name

The application name parameter is used to tell the Application Manager which application to manage. The aforementioned function will be performed for the applications specified with this parameter.

Standard Options

The standard options are used to alter the normal Application Manager processing of a function for an application.

ALL The ALL keyword is used to specify all applications defined to the system. All applications known to the Application Manager will be interrogated, those that have been defined to this system will be managed. A '*' is a synonym for the ALL keyword.

APPL_NAME An application name. All application names are identical to the application's command. For example, the Started Task Manager is named RCF.

PATTERN An application name pattern, using a '*' as a wild card character. Any application with a name that begins with the letters preceding the asterisk (*) and defined to the system will be managed.

MSGID The MSGID keyword is used with the Application Manager variable function, HELP. No abbreviations of the MSGID keyword are acceptable.

VARIABLE The VARIABLE keyword is used with the Application Manager variable functions, SET and DISPLAY. Valid abbreviations are: VAR and V.

FORCE The FORCE option is used to force an application that is not defined to a system onto that system. Valid abbreviations are: F.

CONSOLE=consid

The CONSOLE option is used to specify the console to receive Application Manager messages for a function. Specify either a valid console ID or the device address of the console for the consid argument. There are no abbreviations for the CONSOLE option.



Variable Options

The variable options are used to specify an Automation Application control variable. When the SET function is specified, the =value option is used to reset the value of the control variable.

AUTO The AUTO keyword specifies the Automation Application processing mode variable. Valid values are: ON and OFF.

CHKP The CHKP keyword specifies the Automation Application checkpoint restart mode. Valid values are: ON and OFF.

IPL The IPL keyword specifies the Automation Application system IPL time. IPL cannot be reset.

IPLD The IPLD keyword specifies the Automation Application system IPL flag. IPLD cannot be reset.

JES The JES keyword specifies the JES3 processor type variable. Valid values are: GLB and LCL.

XRF The XRF keyword specifies the XRF processor type variable. Valid values are: ACT and ALT.

MSn The MS1 through MS4 keywords specify one of the miscellaneous groups defined for the system. Valid values are system specific.

JMN The JMN keyword specifies the system's JES3 main name.

JCM The JCM keyword specifies the JES3 Complex main name; the JES3 main name of the global processor for the complex.

MSG The MSG keyword specifies the Automation Application messaging mode variable. Valid values are: ON and OFF.

FOLD The FOLD keyword specifies the Automation Application messaging fold variable. Valid values are: ON and OFF.

DESC The DESC keyword specifies the Automation Application default descriptor code for messages. A valid MVS descriptor code must be specified.

ROUT The ROUT keyword specifies the Automation Application default route code for messages. A valid MVS route code must be specified.



Trace Functions

CLND The CLND keyword specifies the Automation Application calendering mode. Valid values are: ON and OFF.

AFRC The AFRC keyword specifies the Automation Application AF/Remote console. A valid MCS console address must be specified.

PREF The PREF keyword specifies the Automation Application dataset prefix. A valid dataset prefix must be specified.

CITY The CITY keyword specifies the Automation Application system definition for the city. Specify a 2 character designation for the city.

CNTR The CNTR keyword specifies the Automation Application system definition for the data center. Specify the data center designation, up to 8 characters.

VTAM The VTAM keyword specifies the Automation Application system definition for the VTAM task name. Specify the started task name for VTAM.

VTSA The VTSA keyword specifies the Automation Application system definition for the VTAM subarea number. Specify the 2 character designation for VTAM subarea.

VTID The VTID keyword specifies the Automation Application system definition for the VTAM subarea ID. Specify the 3 character designation for VTAM subarea ID.

SET Set the trace table values for an exec.

DISPLAY Display trace table values for an exec.



Trace Options

Calendar Functions

Commands Functions

EXEC= Name of the exec to be traced/tracked.

TRACE= Type of trace to be enabled for the exec. The options are:� O Turn tracing off.� A Trace al clauses before execution.� C Trace all commands before execution.� E Trace any command resulting in an error after

execution, together with the return code from the command.

� F Trace any command resulting in failure after execution, together with the return code from the command.

� I Trace all clauses before execution and all of the intermediate results during evaluation of expressions and substituted names.

� L Trace only labels passed during execution.� N Trace commands resulting in a negative return code

after execution.� R Trace all clauses before execution. Displays final

results of evaluating an expression.� S Trace remaining clauses without execution.

TRACK= Enable/disable tracking for the exec. Specify 1 to enable tracking and 0 to disable tracking.

RESET Reset the calendar variables for current day.

DISPLAY Display the values of the calendar variables.

RESET Reset the !AO!, SMFID, and !ZZ! AOCMDS

DISPLAY Display the !AO!, SMFID, !ZZ! AOCMDS



Statistic Functions

Application Command Processor (KAUA@CMD)

Function

This function issues the specified command to the specified MVS, CICS, or IMS destination and displays the response on the requesting MCS console.

Format

The format for this command is:

CMD____cmddest___cmdtext______________________

Parameters

APL Command On-line HelpOn-line help for the Application Manager APL command is available anytime. To display on-line help for the APL command, enter the following command at the MVS operator console:

APL HELP

The Application Manager displays the APL command syntax followed by a brief explanation of each of the keywords associated with the command.

DISPLAY Display the requested statistics information.

CMDDEST Destination for the command, required. Valid values for destination are:� MVS System SMF ID� MVS System P2P Link ID� CIC Region Name� CIC Region Alias� CIC Region POVI ID� CIC Region ACB Name

Table Manager 39

Table Manager

IntroductionAll of the Automation Applications use user information stored in tables; each object defined to an Automation Application is described in a set of tables unique to the application. The information held in these tables is an integral part of each of the Automation Applications. None of the Automation Applications can be initialized before the data held in the necessary tables is accessible.

Chapter ContentsTable Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Table Management Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Controlling Table Manager Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

3

Table Definitions


Table Definitions

The table definition describes the tables that are to be enabled by the IRM during initialization. The table definition is automatically generated by the underlying application code when a system definition is added. For any application that is enabled and initialized in the system definition, the corresponding tables will be enabled. Table definitions are defined to the Application Manager through the ISPF User Interface. All tables that are enabled will automatically be loaded into storage during IRM initialization.Table definitions are stored in the Table Control Table, @TBLCNTL, which is a member of the table dataset, hilev.RKAUTBLR.

To begin defining tables, select option 12, AF/OPERATOR Resources, from the main ISPF User interface panel. Select option 2 for the Tables Definitions panel.If this is the first tables definition, the following screen will be blank.Type 'ADD' on the command line to begin the tables definition process. If previous tables definitions exist, either the Add or Copy process may be used to create subsequent tables definitions. The Tables Add or Tables Copy panel will be displayed.The following describes the fields contained on the Tables Definition panel. The name of the table column corresponding to each panel field will be included for reference.

Creating a tables definition for a system without a systems definition will automatically generate the systems definition entry. However, no applications will be automatically enabled or initialized for this system.

SMF ID The SMF ID field defines the SMF ID of the system that is being defined.The SMF ID is the same as the one specified on the SID statement of member SMFPRMxx in dataset SYS1.PARMLIB.

This is a four character field, which may contain any EBCDIC character with the exception of an asterisk (*) or quotes (' , ") and which must not begin with one of the Rexx Table special characters (*+%-/).

This is the row name of the record in the @TBLCNTL table and does not have a corresponding column name.

Table Manager 41

Table Definitions

Description The Description field is used to specify a one line, 'plain English' description of the resource for the user's reference.This information is displayed on the Application Manager Tables Selection panel.

The Description field is contained in the Application Control table, @APLCNTL. The table column name for this field is APL_DESCRIPT.

Enable (Ena) The Enable Field is used to load a table on a system. Enter a 1 if you wish to use the table on this system.Enter a 0 if the table will not be used on this system.

Note: If the application that owns the table has been enabled on this system, the table has been defined to this system automatically and can not be undefined.

Column names for application tables are proprietary. � Peer-to-Peer Manager P2P� Omegamon Logon Manager OM2� POVI Session Manager OVI� Communication Manager COM� MVS Manager MVS� JES Manager JES� TSO Manager TSO� CICS Manager CIC� IMS Manager IMS� XRF Manager XRF

Note: The Application and Table Managers must be initialized to start any of the other automation applications. An application cannot be initialized without being enabled. In other words, if an application is not enabled, it cannot be initialized.

Table Management Services



All of the Automation Applications are designed to use information stored in tables in a state management database. The tables in the state management database are organized by application functionality. The data Data held in the automation tables is used to control the operation of the application and to describe to the application how to manage the resources under its control.

Stored tables are held on DASD as members of a PDS, and are accessible to the AF/OPERATOR task as well as other address spaces, including TSO. Run-time access to the tables is provided by the REXX Table Manager, ASOTABLE, and a set of functions included in the REXX Function PackageThe REXX Table Manager, KAUTABLE, and a set of functions included in the REXX Function Package provide run-time access to the tables. See the Integrated Resource Manager Functions and Other Facilities Manual (Document AU53-6251) for more information on the REXX table functions.

To facilitate optimal performance of data retrieval activities during AF/OPERATOR run-time operation, the tables are loaded into above-the-line storage and managed by the REXX Table Manager.

In-storage tables are referenced by a chained control block called KAUTBLOK. The KAUTBLOK contains pointers to in-storage COLUMN, ROW and CELL tables, which in turn contain references to the actual table data. The internal structure of the tables is used to speed the search for and retrieval of Automation Application data from the tables.

Tables can also be created within the AF/OPERATOR run-time environment to maintain automation data. The data that is held in created tables is temporal in nature, since there is no permanent backup to the data held in a created table. Created tables are used to store current status information for the objects managed by the Automation Applications and other data that is volatile; data that changes over the life span of the table.

Automation applications retrieve data from the individual tables in the state management database by using REXX table functions, such as the TBSELECT function. TBSELECT calls the REXX Table Manager to find the appropriate KAUTBLOK for the desired table. TBSELECT then searches for the desired information and returns that information to the calling REXX exec. Data can be returned to the exec in the form of strings of cells or TBSELECT

Table Manager 43


can optionally be used to create variables or arrays within the calling exec via the REXX variable interface, IRXEXCOM.

Individual tables are controlled during run-time operation by the Table Manager via the REXX TABLE function. TABLE is used to call the REXX Table Manager to LOAD, DELETE, or REFRESH in-storage tables. The Table Manager is used to facilitate table maintenance or changes without the need to bring AF/OPERATOR down.

Stored TablesStored tables are created in a free-form design by the user by creating a member in the Automation Application table dataset. The REXX Table Manager has no restrictions on the number of tables, columnar positions of table data or the length of data held in an individual cell.

There are five simple requirements for designing a table:

� The table dataset can have a maximum LRECL of 255 characters (PDF limitation).

� The name of the member of the table dataset will be used as the name of the table. The table name is specified to the REXX table functions to identify the required table.

� A maximum of 128 columns and 64K rows are allowed.

� All column names must be supplied and can be no longer than 32 characters.

� The column and Cell information can be placed anywhere in the Row and can be as long as needed.

Null cells are not allowed, you must minimally code a single character as a place-holder for cells with no information.

Tables can be created and added on-the-fly. User's can create their own tables outside of the Automation Applications and still use REXX Table Manager services and the REXX table functions to reference the table data.

Multiple tables can be strung together by using equivalent Row names in each table in a set of tables. This is necessary when 255 characters are not sufficient to hold all of the information needed for a particular automation application.

The tables are created and maintained via the PDF editor.



Created TablesCreated tables are created in-storage from information passed from the REXX environment. Created tables are generated by the execution of a REXX exec, in the AF/OPERATOR run-time environment, which calls the TBCREATE function and supplies the necessary information to describe the table to the REXX Table Manager. The following items describe the restrictions for created tables:

� The name of the table must be supplied on the call to the TBCREATE function. The table name can be no longer than 32 characters.

� A maximum of 128 columns and 64K rows are allowed.

� Column names must be supplied and can be no longer than 32 characters.

� Row information is passed to the REXX Table Manager by calling the TBADD function after the table has been created. Cell information for the row must be set in the REXX exec prior to calling the TBADD function. TBADD retrieves the cell information for the row from the REXX environment.

� The information for a cell can be no longer than 1024 characters.

Rows in a created table can be added, deleted or modified by the REXX table functions. A created table cannot be refreshed, since there is no permanent copy of the table held on DASD. If the entire table needs to be modified, the REXX exec must delete the old copy of the table from storage and then re-create the table by calling the TBCREATE function with the new table description.

Table Manager 45


Table Format

FIGURE 2. Table Format Example

The following notes describe the format of a table:

� A unique dataset or member of a PDS, with a fixed block format and a maximum LRECL of 255.

� Comment lines are designated with an asterisk (*) in the first column of the record.

� The Control record (optional) is designated by a '+' in the first column of the record and must specify three tokens each separated by a blank. These tokens specify the variable stems when TBSELECT is called to create arrays. The first token is the variable stem for column name data, the second token is the variable stem for row name data, and the third token is the variable stem for cell data. Each token can be a maximum of 32 characters. All control tokens must be specified in upper case. If no control record is specified, COLUMN, ROW, and CELL will be used for the respective array stems.

An optional fourth token can be specified on the Control record to designate the maximum number of rows for the table. The default number of rows for a table is 256. If the table will be larger than 256 rows, code

1...5...10...15...20...25...30...35...40

Comment: * This is a comment record

*

Control: + SMFID JOBCLASS STATE 512

*

Column Header: - SYS1 SYS2 SYS3 SYS4 SYS5 SYS6

Row Data: A ON ON OFF '' '' ON ''1 2''

B ON * ON ON ON ''ON''

C ON ON ON OFF OFF OFF

D ON OFF '' '' ON ON OFF



the maximum number of rows for the table in the fourth token of the control record. A maximum of 65,536 rows are allowed.

� The Column Header record (required) is designated by a '-' in the first column of the record and is used to specify the names of the columns. A maximum of 128 columns are allowed. Column names can be a maximum of 32 characters.

� Data records must specify the row name as the first token and cell data for the row in the remaining space. A minimum of one data record must be specified. There must be a token for each column in the row representing cell data. Null cells, cells with no applicable data, are designated by a placeholder. The placeholder can be any character or 2 double quotes (") for a null value. All tokens must be delimited by a blank. Cell data with imbedded blanks must be enclosed in double quotes ("). A maximum of 64K rows are allowed. Row names can be a maximum of 32 characters.

� There are no positional restrictions on coding table tokens. The only coding restriction on table tokens is that they must be separated by at least one blank. More than one blank is acceptable.

Note: Created tables have the same logical format as stored tables, and therefore, the format information just described is also applicable to created tables. Identical information on the format of the table will be passed on the call to the TBCREATE function.

Table Manager 47


FIGURE 3. Table Format Example - Keyed Tables

There are two major differences in the format of a keyed table:

� The Column Header record is designated by a '/' in the first column of the record. The number of keys for the table is then concatenated to the control character, /n; specifying /3 indicates that the table is a keyed table with three keys. As in a non-keyed table, the Column Header record is used to specify the names of the columns. The first n columns in the table are treated as the keys for the table.

� Data records DO NOT specify the row name in the first token. Keyed tables do not have user-defined row names; the row names are generated internally by the REXX Table Manager.

Each row of a keyed table specifies column data for the row. The first n tokens in the row are treated as the table keys for the row. The remaining tokens define the rest of the column information for the row.

1...5...10...15...20...25...30...35...40

Comment: * This is a comment record

*

Control: + COLUMN ROW CELL

*

Column Header: /3 KEY1 SMFID CPUID NODE_NAME

Row Data: NODE1 S090 * V15NODE1

NODE1 S090 123456 V15NCPU1

NODE S190 * V16NODE1

NODE1 S190 123456 V16NCPU1



Rows in a keyed table can be reference by either the internally generated row name or by the table keys. Referencing a row by the internally generated row name is accomplished by first calling one of the table search functions to return the internal row name of the row to the calling REXX exec. Referencing a row by its keys is accomplished by setting the value of the keys for the row before a REXX table function is called.

Table Manager 49

Controlling Table Manager Resources


During Automation Application initialization, KAU$INIT@TBLINIT, the Table Manager initialization routine will be called. This command file initializes the Table Manager environment which, in turn, will initialize each table that is defined to the system, allocate its member in the table dataset, and load the table into storage.

The Table Manager console command provides an operator interface to give you on-line control of the tables defined to the Table Manager. It is used to communicate with AF/OPERATOR and the REXX Table Manager to control Automation Application tables and display information about the tables from the MVS console. The console command is defined in the Command Prefix field in the Application Manager System Definition.

Thiscommand allows you to load an automation table into storage, delete a table from storage and refresh the in-storage copy of a table thus refreshing Automation Application processing data.



TBL Command SyntaxThe following table shows the TBL available commands. To protect against unintentional command errors, certain function/object/option combinations are prohibited. This includes:

� Functions INIT, START, STOP, REFRESH, LOAD, DELETE, ALLOC, or FREE with object ALL or * with the FORCE option.

FIGURE 4. TBL Command Syntax

TBL function object optionINIT ALL FORCESTART *STOP APPL_NAME CONSOLE=consid

RXTBLMGR

REFRESH TBL_NAMEPATTERN

LOADDELETEALLOCFREE

HELPSHOWSTATUS

ACTIVITYDISPLAY CPOOLS

DEFINITIONSTATUS

Table Manager 51


Parameters

Function - Required

Objects - Required

Options - Optional

Functions

The function parameter is used to tell the Table Manager which action to perform for a table. Acceptable function abbreviations are noted with the function's description.

INIT Initializes and loads an Automation Application table into storage. Tables are loaded from the Automation Application table dataset, hilev.RKUATBLR. Tables not previously loaded into storage should be initialized rather than just loaded to ensure the table member is allocated before an attempt is made to reference it. No abbreviations of the INIT keyword are acceptable.

LOAD Loads an Automation Application table into storage. Tables are loaded from the Automation Application table dataset, hilev.RKUATBLR. Tables previously loaded and deleted can be reloaded with this command. No abbreviations of the LOAD keyword are acceptable.

DELETE Deletes a previously loaded table from storage. No abbreviations of the DELETE keyword are acceptable.

REFRESH Refreshes the in-storage copy of a stored table. The table is deleted from storage and then re-loaded from the table dataset. No abbreviations of the REFRESH keyword are acceptable.

Note: Created tables can not be refreshed.

ALLOC Allocates a table dataset by member.

FREE Frees a table dataset allocation. The table is not deleted; only the allocation is freed.



Objects

The objects name parameter is used to tell the Table Manager which table to manage. The aforementioned function will be performed for the tables specified with this parameter.

Options

The standard options are used to alter the normal Table Manager processing of a function for a table.

START Starts the REXX table management function. The REXX table services are automatically started at AF/OPERATOR initialization time. This command is only used after the table services have been stopped via a TBL STOP command. No abbreviations of the START keyword are acceptable.

STOP Stops the REXX table management function. A WTOR displays to confirm table management shutdown. All Automation Application tables are deleted and the storage pools will be released. No abbreviations of the STOP keyword are acceptable.

ALL The ALL keyword is used to tell the Table Manager which table to manage. All tables known to the Table Manager will be interrogated. Those that have been defined to this system will be managed. An asterisk (*) is a synonym for the ALL keyword.

APPL_NAME An Automation application name.

TBL_NAME A Table name.

PATTERN A table name pattern, using an ‘*’ as a wild card character. Any table with a name beginning with the letters preceding the asterisk (*) and is defined to the system will be managed.

RXTBLMGR Keyword for RXTBLMGR functions.

FORCE The FORCE option is used to force a table that is not defined to a system onto that system. Valid abbreviations are: F.

Table Manager 53


Display Options

RxTblMgr Functions

CONSOLE= Console to direct TBL messages to. Consid may be the name, device address, or the ID of an MVS console, or one of the following message destination keywords:� LOG AO Message Log� SAY REXX Message Log� STK REXX Program Stack� SEND TSO Session - SEND� TPUT TSO Session - TPUT� NONE Message Bit Bucket� MLG System Message Log� MST MCS Master Console

Note: If the SEND option is specified, the TSO userid to receive the message can also be specified using the following format:

SEND(userid,LOGON).

Note: If the TPUT option is specified, the TSO userid to receive the message can also be specified using the following format:

CONSOLE=TPUT(userid)

ACTIVITY Displays table activity information.

CPOOLS Displays table cpool/strg information.

DEFINITION Displays table definition information

STATUS Displays standard status information.

START Start REXX table management services.

STOP Stop REXX table management services.



TBL Command On-line HelpOn-line help for the Table Manager TBL command is available anytime. To display on-line help for the TBL command, enter the following command at the MVS operator console:

TBL HELP

The Table Manager will then display the TBL command syntax followed by a brief explanation of each of the keywords associated with the command.

System Description 55

System Description

IntroductionAF/OPERATOR system variables are used to describe a system to the Automation Applications. The system variables are used by the automation applications to determine which resources to manage and what options are in effect for the system.

Chapter ContentsSystem Variable Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56User Variable Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65User Variable Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Checkpointed Control Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

4

System Variable Definitions



The System Variables definition is used to describe the user environment to the Application Manager. The Sysvars definition is automatically generated by the underlying application code when a system definition is added. Sysvars definitions are defined to the Application Manager through the ISPF User Interface. An AF/OPERATOR system variable will be created and initialized with the defined value during IRM initialization.System variables are used by the automation applications to determine the resources to manage and the options that are in effect for the system.Sysvars definitions are stored in the System Variable Tables, @SYSVARS, @SYSVAR1, @SYSVAR2 and @SYSVAR3, which are members of the table dataset, hilev.RKAUTBLR.

To begin defining system variables, select option 12, AF/OPERATOR Resources, from the main ISPF User interface panel. Select option 3 for the Sysvars Definitions panel.If this is the first sysvars definition, the following screen will be blank.Type 'ADD' on the command line to begin the sysvars definition process. If previous sysvars definitions exist, either the Add or Copy process may be used to create subsequent sysvars definitions. The Sysvars Add or Sysvars Copy panel will be displayed.The following describes the fields contained on the Sysvars Definition panel. The name of the table column corresponding to each panel field will be included for reference.

Note: Creating a sysvars definition for a system without a systems definition will automatically generate the systems and tables definition entry. However, no applications will be automatically enabled or initialized for this system.

SMF ID The SMF ID field defines the SMF ID of the system that is being defined.The SMF ID is the same as the one specified on the SID statement of member SMFPRMxx in dataset SYS1.PARMLIB.This is a four character field, which may contain any EBCDIC character with the exception of an asterisk (*) or quotes (' , ") and which must not begin with one of the Rexx Table special characters (*+%-/).This is the row name of the record in the @SYSVARx table and does not have a corresponding column name.



@APLCLND Application Calendar Flag

Specifies whether or not to enable the automation application calendaring facility. Valid values are 1 and 0. Specify 1 to enable the calendaring facility; calendar variables will be available for Started Task Manager scheduling and be reset each day at midnight. Specify 0 to disable the calendaring facility. The default is 1.

@APLCLXN Application Calendar Exit

This field identifies the command file name of the user exit to the application calendaring routine for this system.If this system has no user exit to the calendaring routine, leave this field blank.

@APLMSG Application Message Mode

Specifies the automation application-messaging mode. Valid values are 1 and 0. Specifying 0 (zero) will cut down on some of the extraneous messages issued by the automation applications.

@APLFOLD Application Message Fold Mode

Specifies whether or not to foldautomation application messages. Valid values are 1 and 0.Specifying 1 (one) will cause automation application messages to be translated to upper case before they are displayed on the operator console.

@APLDESC Application Message Descriptor Code

Specifies the default descriptor code for application messages.Valid values are 4, 6, and 12.Specify 4 to have application messages issued as System Status messages. Specify 6 to have application messages issued as Job Status messages.Specify 12 to have application messages issued as Important Information messages.The default is descriptor code 4.

Description The Description field is used to specify a one line, 'plain English' description of the resource for the user's reference.This information is displayed on the Application Manager Sysvars Selection panel.The Description field is contained in the Application Control table, @APLCNTL. The table column name for this field is APL_DESCRIPT.



@APLROUT Application Message Route Code

Specifies the default route code for application messages.Valid values are 1 through 128.Specify 2 to have application messages routed as Master Console Informational messages.The default is route code 2.

@APLSSYS Application JES Subsystem Type

Specifies the type of JES subsystem in use on this system. Valid values are JES2 and JES3. The default is JES2.

@APLNRDR Application AF/RDR Task Name

This field is used to specify the name of the AF/RDR started task for this system. The value specified here is used by the @JOBSMIT() and @JOBEDIT() functions to invoke the AF/RDR started task to submit batch jobs:

S AFRDR,MBR=member,LIB=jclib,MAT=matnum

This field is required. The default name is AFRDR.

@APLNTCI Application AF/TCI Task Name

This field is used to specify the name of the AF/TCI started task for this system. The value specified here will be used as input to the AF/OPERATOR ACTIVE() function to determine if the AF/TCI started task is active and to communicate with the AF/TCI started task to issue TSO commands:

F,AFTCI,--text of TSO command to execute-

This field is required. The default name is AFTCI.

@APLARP Application Paging System ID

Specifies the Peer-to-Peer link ID of the system attached to the automation application AF/REMOTE paging PC. This field is optional.

@APLAFRC Application AF/Remote1 Console

Specifies the MCS console address of the AF/REMOTE# PC. This field is optional. The suggested AF/REMOTE configuration is as follows: AF/REMOTE1 is the primary automation PC, AF/REMOTE2 is the backup automation PC, and AF/REMOTE3 is the paging PC. Thisconfiguration is suggested, not required. If only one PC is available, fill in the AF/REMOTE1



field and leave the rest blank. If AF/REMOTE is not installed, leave all of the fields blank.

@APLAFR2

Specifies the MCS console address of the AF/REMOTE# PC. This field is optional. The suggested AF/REMOTE configuration is as follows: AF/REMOTE1 is the primary automation PC, AF/REMOTE2 is the backup automation PC, and AF/REMOTE3 is the paging PC. Thisconfiguration is suggested, not required. If only one PC is available, fill in the AF/REMOTE1 field and leave the rest blank. If AF/REMOTE is not installed, leave all of the fields blank.

@APLAFR3

Specifies the MCS console address of the AF/REMOTE# PC. This field is optional. The suggested AF/REMOTE configuration is as follows: AF/REMOTE1 is the primary automation PC, AF/REMOTE2 is the backup automation PC, and AF/REMOTE3 is the paging PC. Thisconfiguration is suggested, not required. If only one PC is available, fill in the AF/REMOTE1 field and leave the rest blank. If AF/REMOTE is not installed, leave all of the fields blank.

@APLPFXT Application Temporary DSN Prefix

This field is used to specify the Temporary Dataset Name Prefix for this system.The value specified here will be used by the @JOBEDIT() function to create a temporarydatasetfor the edited JCL.The Temporary Dataset Name Prefix is used to create the full name of the temporary dataset in the form:

&@aplpfxt.Dyymmdd.Thhmmss.Mnnnnnn

For example, if SYS2.AFOPER is specified for the Temporary Dataset Name Prefix, the temporary datasets will be named:

SYS2.AFOPER.D990617.T065212.M000105

The Temporary Dataset Name Prefix is a required field.

Note: The AF/OPERATOR started task must be granted ALTER access to the dataset profile specified here.For example, if SYS2.AFOPER is specified for the Temporary Dataset Name Prefix, the AF/OPERATOR task must be granted ALTER access to the SYS2.AFOPER.**dataset profile within your security package.



@APLXRF System XRF Workload

Specifies the XRF Workload type for this system. Valid values are N/A, ACT, and ALT. Specify N/A if this is not an IMS/XRF system. Specify ACT if this system normally runs the IMS/XRF Active workload. Specify ALT if this system normally runs the IMS/XRF Alternate workload. The default is N/A.

@APLJES System JES Workload

Specifies the JES Workload type for this system. Valid values are N/A, GLB, LCL, and SAG. Specify N/A if this is not a JES3 system. Specify GLB if this system normally runs as the JES3 Global processor. Specify LCL if this system normally runs as a JES3 Local processor. Specify SAG if this system is a standalone JES3 Global processor. The default is N/A.

@APLMS1 System MS1 Workload

Specifies the MSn Workload type for this system. Valid values are user definedor N/A. The default is N/A.


Specifies the MSn Workload type for this system. Valid values are user defined or N/A. The default is N/A.





@APLCA7U System CA7 Userid

Specifies the logon userid for the CA7 batch interface. This userid will be passed to CA7 via the U7SVC logon command, /LOGON @aplca7u, when a CA7 batch interface request is made. This field is optional. If the CA7 batch interface is not used, or CA7 is not installed, leave this field blank.

@APLCA7P System CA7 Password



Specifies the logon password for the CA7 batch interface. This password will be passed to CA7 via the U7SVC logon command, /LOGON @aplca7u @aplca7p, when a CA7 batch interface request is made. This field is optional. If the CA7 batch interface is not used or a password is not needed to logon to CA7 via the U7SVC, or if CA7 is not installed, leave this field blank.

Note: To clear an existing password, enter a single asterisk in the field, press ENTER, and save the update.

@APLCA7I System CA7 ICOM Task

Specifies the ICOM task name on this system for the CA7 batch interface. Before a CA7 batch interface request is processed, the interface ensures that ICOM is active by issuing an active check for this task name. If the ICOM task is active, the request will be sent to CA7 via the U7SVC. If ICOM is not active, the request will not be sent. This field is optional. If the CA7 batch interface is not used or CA7 is not installed, leave this field blank.

@APLCA7D System CA7 Dataset Prefix

This field is used to specify the CA7 Dataset Name Prefix for this system.The value specified here will be used to create dataset names when posting external dataset requirements to CA7.For example, if the Started Task Manager batch interface is enabled to post an external dataset requirement for a resource, the name of the dataset that will be posted is:

&@aplca7d.&@rname.RELEASE.G0000V00

This field is optional. The default CA7 Dataset Name Prefix is SCS.AFOPER.

@APLDENV System DASD Environment

Specifies a user chosen name for all of the systems using the same shared DASD environment. If this system uses the same DASD as other systems, choose a name for that shared DASD environment and specify that name in this field for all systems using that shared DASD environment. If this system does not use shared DASD, specify a unique name for the DASD environment for this system; an example would be the SMFID of the system. This is a required field.



@APLJMN System JES3 Main Name

Specifies the JES3 main name for this system. This is a required field if the JES subsystem in use on this system is JES3. If this is a JES2 system, leave this field blank.

@APLJCM System JES3 Complex Main Name

Specifies the JES3 Complex Main Name of the global processor of the JES3 complex in which this system resides. If this system is the global processor, specify its JES3 main name. If this system is a local processor, specify the main name of the JES3 global processor. This is a required field if the JES subsystem in use on this system is JES3. If this is a JES2 system, leave this field blank.

@APLPLEX System Sysplex Name

Specifies the name of the Sysplex in which this system resides. If this system is not in a Sysplex, leave this field blank.

@APLPLPS System Sysplex Primary System

Specifies the Peer-to-Peer link ID of the primary system of the Sysplex in which this system resides. If this system is in a Sysplex, this field is required. If this system is not in a Sysplex, leave this field blank.

@APLSSTR System Sysplex Structure Name

This field is used to specify the name of the Coupling Facility (CF) list structure.The structure name must be defined in the CFRM policy for this system. The IRM connects to this structure and uses the structure for maintaining the IRM status table, the ARM status table and the Global Task status table for each IRM.

The structure name can be up to 16 characters in length. Alphanumeric characters or an underscore are valid. The name must begin with an alphabetic character. Structure names may not begin with the letters A through I or the character string 'SYS'.

If the MVS ARM facility or remote predecessor processing is not used in this Sysplex, leave this field blank.



@APLSMAX System Sysplex Structure Size

This field is used to specify the size of the Coupling Facility (CF) list structure, in kilobytes.This is a 6 character numeric field.The default is the value specified in the CFRM policy. If the value specified in this field is greater than the value in the CFRM policy, the value defined in the CFRM will be used.

The structure size must be large enough to contain an entry for each IRM managed resource running on all systems sharing the same structure.

For example, total number of managed resources within a Sysplex, Column A, would require a structure size of Column B:

Resources Size5124 1024K10517 2048K21258 4096K40078 7680K

Note: If the value is changed after the structure is allocated, any new value will only take effect when the structure is disconnected by all the IRMs using this structure. The current structure will need to be manually deallocated.

@APLVTAM System VTAM Task Name

Specifies the name of the VTAM task on this system. The name specified here will be used as an argument to the ACTIVE() function to ensure that the VTAM task is active prior to issuing VTAM console commands. This is a required field.

@APLVTSA System VTAM Subarea List

Specifies the suffix to the ATCSTRxx VTAMLST member for this system. This is the same value as would be specified on the 'S VTAM,,,(LIST=xx)' command. This is a required field.

@APLVTID System VTAM Subarea ID

Specifies a user chosen value to uniquely identify the VTAM subarea for this system. If you have more than one network, and have reused subarea numbers, choose a unique identifier for this subarea. If all of your subarea numbers are unique, specify the subarea number for this field. This is a required field



@APLVTML System VTAM Message Level

Specifies the VTAM message level for this system. Valid values are BASE, V4R1, V4R2, V4R3, and V4R4. This is the same value as is specified on the MSGLEVEL= parameter in the ATCSTRxx member of VTAMLST for this system. If the MSGLEVEL parameter is not specified in the ATCSTRxx member, the information can be found in the MSGLEVEL parameter contained in the output from a D NET,VTAMOPTS command. This is a required field.

@APLWTOR System WTOR Pattern

Specifies the WTOR number pattern value for this system. Valid values are ##, ###, and ####. If 2 digit replies are used on this system, specify ##. If 3 digit replies are used on this system, specify ###. If 4 digit replies are used on this system, specify ####. This is a required field. The default is ##.

@APLCITY System Omview City

Specifies the OMEGAVIEW city value for this system. This value will be used for the OMEGAVIEW city information when creating status items for automation resources. This is a required field.

@APLCNTR System Omview Center

Specifies the OMEGAVIEW center value for this system. This value will be used for the OMEGAVIEW center information when creating status items for automation resources. This is a required field.


User Variable Definitions


The User Variables definition is used to create user defined AF/OPERATOR system variables. The Usrvars definition is automatically generated by the underlying application code when a system definition is added. Usrvars definitions are defined to the Application Manager through the ISPF User Interface. An AF/OPERATOR system variable will be created and initialized with the defined value during IRM initialization.User variables may be used in a resource definition in any of the automation applications or by user created code. Usrsvars definitions are stored in the User Variable Tables, @USRVARS, @USRVAR1, @USRVAR2 and @USRVAR3, which are members of the table dataset, hilev.RKAUTBLR.

To begin defining user variables, select option 12, AF/OPERATOR Resources, from the main ISPF User interface panel. Select option 4 for the Usrvars Definitions panel.If this is the first usrvars definition, the following screen will be blank.Type 'ADD' on the command line to begin the usrvars definition process. If previous usrvars definitions exist, either the Add or Copy process may be used to create subsequent usrvars definitions. The Usrvars Add or Usrvars Copy panel will be displayed.The following describes the fields contained on the Usrvars Definition panel. The name of the table column corresponding to each panel field will be included for reference.

Note: Creating a usrvars definition for a system without a systems definition will automatically generate the systems and tables definition entry. However, no applications will be automatically enabled or initialized for this system.

SMF ID The SMF ID field defines the SMF ID of the system that is being defined.The SMF ID is the same as the one specified on the SID statement of member SMFPRMxx in dataset SYS1.PARMLIB.This is a four character field, which may contain any EBCDIC character with the exception of an asterisk (*) or quotes (' , ") and which must not begin with one of the Rexx Table special characters (*+%-/).This is the row name of the record in the @SYSVARx table and does not have a corresponding column name.



@USRV001 - @USRV008

Use these fields to create a system variable whose value is 1 character in length. Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of single quotes ('), double quotes (") and imbedded blanks. Any variable value left blank results in the @USRV### variable being set to null.

Table column names for these fields are @USRV001-@USRV008.

@USRV101 - @USRV116

Use these fields to create a system variable whose value is 1-2 characters in length. Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of single quotes ('), double quotes (") and imbedded blanks.

The value may be less than the maximum length of the field. Any variable value left blank results in the @USRV### variable being set to null.


@USRV201 - @USRV224

Use these fields to create a system variable whose value is 1-4 characters in length.

Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of single quotes ('), double quotes (") and imbedded blanks.



Description The Description field is used to specify a one line, 'plain English' description of the resource for the user's reference.This information is displayed on the Application Manager Usrvars Selection panel.The Description field is contained in the Application Control table, @APLCNTL. The table column name for this field is APL_DESCRIPT.



@USRV301 - @USRV332


Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of single quotes ('), double quotes (") and imbedded blanks.



@USRV401 - @USRV408


Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of double quotes ("). The value may be less than the maximum length of the field. Any variable value left blank results in the @USRV### variable being set to null.


@USRV501 - @USRV504


Specify the value in the Usrvars Value field. The value may contain any valid EBCDIC character with the exception of double quotes ("). The value may be less than the maximum length of the field. Any variable value left blank results in the @USRV### variable being set to null.


User Variable Description



A user-defined description of a variable may be set using the Change User Variables option from the main selection panel Actions Pull-Down. The description for the variable is displayed on the Usrvars Definition panel in place of the leader dots separating the variable name and value.Upon selection of the Change User Variables option, scroll down until the user variable description lines are displayed. Specify a description for the desired variable. The value may contain any valid EBCDIC character with the exception of double quotes (").

User variable descriptions are stored in member @APLMVAR of dataset, hilev. RKAUCMDS.User variable descriptions are not automatically moved if there is more than 1 copy of the hilev.RKAUCMDS dataset.If table definitions are copied from system to system, the @APLMVAR member of dataset, hilev.RKAUCMDS, must be copied to preserve the user variable descriptions.

User Variable NamesA user defined variable name, other than @USRV###, may be defined using the Set Variable Names pull-down from the Application Manager Usrvars Selection panel Actions Pull-Down. Specify a name for the desired variable.A user variable name must begin with an alphabetic character (A-Z, $, or #). The rest of the characters in the name must be alphanumeric (A-Z, 0-9, $, @, or #). A user variable name can not begin with the @ character.User variable names are stored in the @USRVARx tables in a special row named "__NM__".

Calendar VariablesThe following calendar variables are created during automation application initialization: � @APLCLND Application Calendar Flag. This variable has a value of 1 if

calendaring is to be enabled and a value of 0 if calendaring is disabled.

� @APLBDAY Business Day Flag. This variable has a value of 1 on business days and a value of 0 on non-business days.

� @APLHDAY Holiday Flag. This variable has a value of 1 on holidays and a value of 0 on business days.



� @APLYDAY Business Day Flag - Yesterday. This variable has a value of 1 if yesterday was a business day and 0 if not.

� @APLTDAY Business Day Flag - Tomorrow. This variable has a value of 1 if tomorrow will be a business day and 0 if not.

� @APLNDAY Application Weekend Day Flag. This variable has a value of 1 if the current day is either a Saturday or a Sunday and 0 if not.

� @APLWDAY Application Weekday Day Flag. This variable has a value of 1 if the current day is a weekday (Monday - Friday), and 0 if not.

� @APLCXRF Application XRF Calendar Flag. This variable has a value of 1 if @APLXRF is equal to 'ACT' and 0 if not.

� @APLCL01 Calendar date in the form MMDDYYYY.

� @APLCL02 Numeric day-of-week. Valid values are: 1-7 (Sunday=1, Saturday=7).

� @APLCL03 Number of times this day-of-week has occurred this month, including today. Returns a whole number, N.

� @APLCL04 Numeric week-of-month. Returns a whole number, N. (Sunday =1,Saturday=7)

� @APLCL05 Business day-of-month. Returns a whole number, NN, or a 0 (zero) if the day is not a business day.

� @APLCL06 Number of business days left in this month, including today. Returns a whole number, NN.

� @APLCL07 Date of last business date, in the form YYYYMMDD.

� @APLCL08 Day-of-week of last business date. Returns a whole number, N. (Sunday=1,Saturday=7)

� @APLCL09 Number of times the day-of-week of the last business day has occurred this month. Returns a whole number, N.

� @APLCL10 Date of next business day, in the form YYYYMMDD.

� @APLCL11 Day-of-week of the next business date. Returns a whole number, N.

� @APLCL12 Date of the last business day of the prior week, in the form YYYYMMDD.



� @APLCL13 Number of business days in this week. Returns a whole number, N.

� @APLCL14 Calendar date 6 months prior to supplied date, in the form YYYYMMDD.

� @APLCL15 Calendar date 6 months prior to the date of the next business day, in the form YYYYMMDD.

� @APLCL16 Numeric quarter information, in the form: AABBCC.

– AA Number of days in quarter

– BB Number of days in second and third months of quarter

– CC Number of days in third month of quarter

� @APLCL17 Numeric quarter information for the quarter 6 months ago, in the form: AABBCC (see above).

� @APLCL18 Numeric quarter information for the prior quarter, in the form: AABBCC (see above).

� @APLCL19 Numeric quarter information for the next quarter, in the form: AABBCC (see above).

� @APLCL20 Leap year indicator. This variable has a value of 1 if this is a leap year and 0 if not.

� @APLCL21 Business Day - Yesterday. This variable has a value of 1 if yesterday was a business day and 0 if not.

� @APLCL22 Business Day - Tomorrow. This variable has a value of 1 if tomorrow will be a business day and 0 if not.

� @APLCL23 Number of days before the next business day.

� @APLCL24 Day-of-week and the date of the first business day of the next week, in the form NYYYYMMDD where N=numeric day of week. (Sunday=1,Saturday=7)

� @APLCL25 Number of business days in the month.

� @APLCL26 Numeric business day of the year.

� @APLCL27 Prior week indicators, in the form: NSMTWTFS where:

– N Number of business days in the week.



– SMTWTFS Days of the week: 1 if the day is a business day and 0 if not.

� @APLCL28 Number of calendar days this month and next, in the form AABB.

� @APLCL29 This week indicators, in the form NSMTWTFS.

� @APLCL30 Next week indicators, in the form NSMTWTFS.

� @APLCL31 Reserved



� @APLCL34 Number of the quarter. Returns a whole number, N.

� @APLCL35 Number of business days left in this quarter.

� @APLCL36 Last business day of the last quarter, in the form YYYYMMDD.

� @APLCL37 Yesterday's date, in the form YYYYMMDD. Returns a 0 if the day was not a business day.

� @APLCL38 Date 2 days ago, in the form YYYYMMDD. Returns a 0 if the day was not a business day.











� @APLCL47 Number of days before the next business day. Returns a 0 if the day was not a business day.

� @APLCL48 Calendar date, in the form: 'DDD, MMM DD, YYYY' (WED, AUG 18, 1971).

� @APLCL49 Julian date in the form YYYYDDD.

� @APLCL50 The numeric business day of the month in the form NN.

� @APLCL51 The number of the business day of the year in the form NNN.

� @APLCL52 Two weeks from now indicators in the form NSMTWTFS.

� @APLCL53 Three weeks from now indicators in the form NSMTWTFS.

� @APLCL54 Four weeks from now indicators in the form NSMTWTFS.

� @APLCL55 Date of the 3rd business day from the date in the form YYYYMMDD.

� @APLCL56 Date of the 2nd business day from the date in the form YYYYMMDD.

� @APLCL57 Day indicator for current day, in the form: 1 = business day, 0 = non-business day.




� @APLCL61 The date argument value in the form: USA

� @APLCL62 The date argument value in the form: XUSA

� @APLCL63 The date argument value in the form: EUR.

� @APLCL64 The date argument value in the form: XEUR.

� @APLCL65 The date argument value in the form: JUL.



� @APLCL66 The date argument value in the form: XJUL.

� @APLCL67 The date argument value in the form: ORD.

� @APLCL68 The date argument value in the form: XORD.

� @APLCL69 The date argument value in the form: NORM.

� @APLCL70 The date argument value in the form: SORT.

� @APLCL71 Date argument value in the form: DD.

� @APLCL72 Date argument value in the form: DDD.

� @APLCL73 Date argument value in the form: MM.

� @APLCL74 Date argument value in the form: YY.

� @APLCL75 Date argument value in the form: YYYY.

� @APLCL76 Date argument value in the form: BASE.

� @APLCL77 Date argument value in the form: WEEKDAY.

� @APLCL78 Date argument value in the form: WEEKDAY token.

� @APLCL79 Date argument value in the form: MONTH.

� @APLCL80 Date argument value in the form: MONTH token.

Checkpointed Control Variables



A subset of system variables, the control variables,must be validated before being set. The control variables are:� @APLXRF

� @APLJES

� @APLMS1

� @APLMS2

� @APLMS3

� @APLMS4

� @APLJMN

� @APLJCM

� @APLARP

� @APLDENV

� @APLPLEX

� @APLPLPS

For a non-IPL, non-checkpoint start (AUTO or MANUAL) of AF/OPERATOR/IRM, the value of the variable in the table is compared to the last check-pointed value of the variable before AF/OPERATOR came down. The variable will not automatically be reset unless the two values are equivalent. If the check-pointed value is not the same as the defined value in the table, a WTOR will be issued to the console, which allows the operator to choose the correct value:� ASOA015W Application Control Variable mis-match:

– ASOA015W Variable = @APLJES

– ASOA015W Check-point value = LCL

– ASOA015W Table definition = GLB

– xx ASOA015A Enter correct value for @APLJES: LCL or GLB

This WTOR is used to ensure that temporary system description changes remain in effect, even if AF/OPERATOR should fail. For example, if a system



is re-defined as a JES3 Global processor because of a DSI and AF/OPERATOR fails before the next IPL, the default data in the system description table will not automatically override the temporary definition.

During a checkpoint restart of AF/OPERATOR/IRM, the last check-pointed value of the control variables will be used instead of the value stored in the Sysvars table.All non-control system variables will be re-initialized during a checkpoint restart. After a system IPL, the value of the control variables will revert back to that specified in the Sysvars table.



AF/OPERATOR Commands Definitions 77

AF/OPERATOR CommandsDefinitions

IntroductionAF/OPERATOR commands interface provides a facility to issue AF/OPERATOR or simple system commands prior to the initialization of the remaining Automation Applications.

Chapter ContentsAF/OPERATOR Commands Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . 78Order of Cmd Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

5

AF/OPERATOR Commands Definitions



The AO Cmds definition is used for issuing AF/OPERATOR commands.The definitions can be used to alter the default AF/OPERATOR traps, issue AO commands such as AO QUIET and AO NOAUTOREF, and issue simple operator commands.

AO Cmds definitions are defined to the Application Manager through the ISPF User Interface. The AF/OPERATOR command will be issued during IRM application initialization.AO Cmds definitions are stored in the Application AO Cmd Table, @APLAOCM, which is a member of the table dataset, hilev.RKAUTBLR.

To begin defining AO Cmds, select option 12, AF/OPERATOR Resources, from the main ISPF User interface panel. Select option 5 for the AO Cmds Definitions panel.If this is the first AO Cmds definition, the following screen will display the default definitions provided with the product.Use either the Add or Copy process to create subsequent AO Cmds definitions. The Application Manager AO Cmds Definition panel will be displayed.The following describes the fields contained on the AO Cmds Definition panel.



The name of the table column corresponding to each panel field will be included for reference.

SMF ID The SMF ID field defines the SMF ID of the system where this AF/OPERATOR command is to be executed.The SMF ID is the same as the one specified on the SID statement of member SMFPRMxx in dataset SYS1.PARMLIB.

A Keyword value can be specified instead of a system SMF ID.The valid keywords and their meanings are:� !AO! The !AO! Keyword defines a default command. The

command will be executed on every system.� !SV! The !SV! Keyword defines a saved command. The

command will not be executed on any system.� !ZZ! The !ZZ! Keyword defines a default command. The

command will be executed on every system.

Definitions with a keyword of SMF ID or !AO! will be executed before the initialization of the remaining automation applications.Definitions with a keyword of !ZZ! will not be executed until the completion of automation application initialization.

The table column name for this field is AO_SMF.

Description The Description field is used to specify a one line, 'plain English' description of the resource for the user's reference.This information is displayed on the Application Manager AO Cmds Selection panel.

The table column name for this field is AO_DESC.

Command Text

The Command Text field is used to specify the text of the AF/OPERATOR command to be issued. The text specified here is passed to AF/OPERATOR unaltered. The command text is not syntax checked; the user is responsible for specifying a valid AF/OPERATOR command with valid syntax.

The table column name for this field is AO_CMD.



Order of Cmd ExecutionAO Cmds are executed sequentially in the order in which they appear on the Application Manager AO Cmds Selection panel. Sequentially ordered execution will allow for the definition of commands which must be executed in a specific order, such as the AF/OPERATOR DCL and LET commands.

Cmd placement is determined as the last step in the definition of a new cmd.Once the new cmd definition is complete and function key F3 is depressed, the Application Manager - AO Cmds Placement panel is displayed. Placement is determined by entering an 'A' on the appropriate line to specify execution after the selected command or a 'B' to specify execution before the selected command. Pressing the 'Enter' key will complete the definition and placement of the new cmd.

Note: If there is no existing definition with the same SMF ID specification, the placement panel will not be displayed.

Supplied Commands

A set of pre-defined AF/OPERATOR commands are supplied with the product. Following is a brief description of the supplied commands: � AO QUIET - Suppress AF/OPERATOR messages to the operator console

� AO NOAUTOREF - Specifies that Rexx execs are not to be automatically reloaded

� AO RXSEARCH(REXX) - Determines the search order used to locate functions and subroutines

� AO TODSTART - Begins scheduling of restored TOD traps added by the RELOAD(TODS) command

� TRAP CHA(OGSUBSYS) CMD ACT('EX @AFOAOCM) ENA LOG AOTRAP - Pre-process AF/OPERATOR commands.

– Allows AF/OPERATOR command prefix AO to be specified in place of prefixes 'AF', 'AFOPER' and 'OG'

– Allows AF/OPERATOR command AO FREE(AOMSGLOG) to be specified in place of commands 'AO FREE(RKOGLOGM)' and 'OG FREE(OGMSGLOG)'

– The following commands are suppressed and not executed:



– AO NOCMD - Stops AF/OPERATOR from monitoring console commands for possible matches

– AO NODOM - Suspends delete operator message (DOM) processing

– AO NOLOG - Specifies that normally logged AF/OPERATOR messages will not be recorded to the AF/OPERATOR message log

– AO NORECOVER - Disables abend recovery by AF/OPERATOR

– AO NOWTO - Stops AF/OPERATOR from monitoring messages for possible matches

– AO SNAP - Obsolete AF/OPERATOR command that could cause unpredictable results

– AO SSIDRAIN - Suspends CMD, WTO and DOM processing

– AO WARN - Puts AF/OPERATOR into warn processing mode, where no trap actions are taken

– SHOW TRAPS(*) - Shows all current AF/OPERATOR traps on the operator console. This command could seriously degrade system performance.

– SHOW VARS(*) - Shows all current AF/OPERATOR variables and their values. This command could seriously degrade system performance.

� OPER &AOSUBSYS DCL AOBLANK CHAR(1) SYSTEM DUPOK INIT('' '') NOTRUNC - Allows for a blank pattern matching character

� "OPER &AOSUBSYS DCL AOCOMMA CHAR(1) SYSTEM DUPOK INIT('','') NOTRUNC - Allows for a comma pattern matching character

� OPER &AOSUBSYS DCL AOSLASH CHAR(1) SYSTEM DUPOK INIT(''/'') NOTRUNC - Allows for a forward slash pattern matching character

� OPER &AOSUBSYS DCL AOBSLASH CHAR(1) SYSTEM DUPOK INIT(''\'') NOTRUNC - Allows for a backward slash pattern matching character

� OPER &AOSUBSYS DCL AOCOLON CHAR(1) SYSTEM DUPOK INIT('':'') NOTRUNC - Allows for a colon pattern matching character



� OPER &AOSUBSYS DCL AOSEMI CHAR(1) SYSTEM DUPOK INIT('';'') NOTRUNC - Allows for a semicolon pattern matching character

� OPER &AOSUBSYS DCL AOSQTE CHAR(1) SYSTEM DUPOK INIT(''"'') NOTRUNC - Allows for a single quote pattern matching character

� OPER &AOSUBSYS DCL AODQTE CHAR(1) SYSTEM DUPOK INIT(''"'') NOTRUNC - Allows for a double quote pattern matching character

� OPER &AOSUBSYS DCL AOHLPDSN CHAR(44) SYSTEM DUPOK INIT(''-tkogpfx-.TKOGHELP'') - Specify the name of the user's AF/OPERATOR help dataset.

� OPER &AOSUBSYS DCL COMPANY CHAR(25) SYSTEM DUPOK INIT(''Company Name'') - Specify the user's company name.

� OPER &AOSUBSYS DCL COADDR1 CHAR(25) SYSTEM DUPOK INIT(''Company address '') - Specify the user's company address.

� OPER &AOSUBSYS DCL COADDR2 CHAR(25) SYSTEM DUPOK INIT(''Company City, State Zip'') - Specify the user's company city, state, and zip code.

� OPER &AOSUBSYS DCL ZMSGLOG CHAR(44) SYSTEM DUPOK - Declare a system variable that will contain the name of the current AF/OPERATOR message log dataset.

� OPER &AOSUBSYS DCL ZMSGLST CHAR(44) SYSTEM DUPOK - Declare a system variable that will contain the name of the last used (-1) AF/OPERATOR message log dataset.

� OPER &AOSUBSYS LET AORO = $SUBSTR(''&AOSUBSYS'',4,1) - Set the value of AORO to the last character of the AF/OPERATOR system variable AOSUBSYS.

� OPER &AOSUBSYS LET ZCPUSER = $SUBSTR(''&AOCPUSER'',3,4) - Set the value of ZCPUSER to the last 4 characters of AF/OPERATOR system variable AOCPUSER.

� EXECLOAD @AFOAOCM - Load the exec to pre-process AF/OPERATOR commands



� EXECLOAD @AFOMSGL - Load the exec to process AF/OPERATOR message log datasets

� TRAP DEL(AOSTOPIT) - Delete the trap to suppress AF/OPERATOR !AOP015#* messages during initialization.

� TRAP DEL(AOSHUTUP) - Delete the trap to suppress AF/OPERATOR !AOP0201* messages during initialization.

� TRAP ADD(@AFOSLIP) TOD(*) ACT('EXEC @AFOSLS0') ENA LOG- Example of a saved command

� TRAP ADD(@AFOSLIP) TOD(*) ACT('EXEC @AFOSLIP') ENA LOG - Example of a saved command

� TRAP ADD(@AFOCMDS) TOD(*) ACT('EXEC @AFOCMDS') ENA NOL - Allows the primary address space to trap and process unqualified automation console commands, in the style accepted by pre-OG120/AO240 subsystems. If this exec is not executed, all automation console commands must be prefixed with the subsystem name that was assigned to this address space. If 2 or more AF/OPERATOR address spaces are run on any 1 system, include this command in the primary address space only. It cannot be active on more that 1 address space per system.

� AO NOQUIET(MSG(0095)) - Specifies that message !AOP0095 will not be suppressed when AF/OPERATOR is running in QUIET mode








Note: The user should not delete or alter the execution order of any of the supplied commands without careful analysis or without consulting a Candle Automation specialist.

Customer Support 85

Customer Support

IntroductionCandle Corporation offers a comprehensive maintenance and support plan to ensure you realize the greatest value possible from your Candle software investments. We have more than 200 technicians worldwide, committed to providing you with prompt resolutions to your support requests.

Customer Support hours of operation are from 5:30 A.M. – 5:00 P.M., Pacific Time. In the event of an after-hours or weekend emergency, Candle's computerized call management system ensures that a technician will return your call within one hour. For customers located outside of North America, after-hours and weekend support is provided by Candle Customer Support locations in the United States.

Electronic supportCandle provides information and support services through

n Candle's home page at www.candle.com. You can use the Candle Worldwide Web Site to– open problem records– access maintenance information – order products or maintenance– access IBM compatibility information– download fix packs for distributed products– read news and alerts– scan a list of scheduled Candle education classes

A


n Candle Electronic Customer Support (CECS), an electronic customer support facility. You can access this facility using the IBM Global Network. You can use CECS to:

– open problem records– search our database for solutions to known problems– look for answers to commonly asked questions– read news and alerts– scan a list of scheduled Candle education classes

Both CECS and the Candle Worldwide Web Site are available 24 hours a day, 7 days per week.

Telephone supportOur support network consists of product specialists who work with you to solve your problem.

Candle uses an on-line problem management system to log and track all support requests. Your support request is immediately routed to the appropriate technical resource.

When you call to report a problem, please have the following information:

n your Candle personal ID (PID) numbern the release level of the Candle product n the release level of IBM or other vendor software n identifying information and dates of recently applied maintenance to your

Candle product or IBM productn a detailed description of the problem (including the error message) and

the events preceding the problemn a description of any unusual events that occurred before the problem

Customer support locations and numbersTo contact a Customer Support representative, refer to the following list. While these phone numbers were accurate at the time this document was published, the current numbers can be found on the Candle Web site, www.candle.com, under Customer Support.

http://www.candle.com

Customer Support 87

Table 1. Customer Support Phone Numbers

Office Telephone FAX

North America (800) 328-1811 (310) 535-3636

(310) 727-4204

Europe

Belgium/Luxembourg +32 (0) 3 270 95 60 +32 (0) 3 270 95 41

France +33 (0) 1 53 61 60 60 +33 (0) 1 53 61 06 16

Germany/Switzerland/Austria

+49 (0) 89 54 554 333 +49 (0) 89 54 554 170

Italy – Freephone 800 780992

Netherlands +31 (0) 30 600 35 50 +31 (0) 30 600 35 10

Scandinavia +46 (0)8 444 5940 +46 (0)8 623 1855

United Kingdom +44 (0)161 437 5224 +44 (0)161 437 5225

(Southern Europe, Middle East and South Africa Agents call United Kingdom)

Asia Pacific – English Hub +61 2 9954 1818

Australia +61 2 8912 9898

Hong Kong 800 908 457

India +61 2 8912 9898

Indonesia 0018 03061 2061

Malaysia 1800 803 459

New Zealand 0800 449 596

Philippines 1800 1612 0096

Singapore 800 616 2075

Thailand 0018 00612 1045

Asia Pacific – Japanese Hub +81 3 3595 7150 +81 3 3595 7110

Asia Pacific – Korean Hub +82 2 552 8744 +82 2 552 8746

Asia Pacific – Mandarin Hub +88 62 2739 3223 +88 62 2378 5993

Asia Pacific – e-mail address:[email protected]


When your local support office is unavailable, you can contact Candle's North America support center. If USADirect® service is available in your country, use the 800 telephone number. If USADirect® service is not available, ask your international operator for assistance in calling Candle's local (310) number.

Incident documentationYou may be asked to send incident documentation to the Candle Customer Support Center. On the outside of all packages you send, please write the incident number given to you by the Customer Support representative.

Send tapes containing the incident information to the following address, unless directed otherwise by your Customer Support representative:

Candle Customer SupportCandle Support Center, Incident number201 North Douglas StreetEl Segundo, California 90245

Send all other relevant documentation, such as diskettes or paper documentation, to the address provided by your Customer Support representative.

Ensuring your satisfaction with customer supportCandle Customer Support is committed to achieving high customer satisfaction ratings in all areas. These include

n connecting you to a support representative promptlyn providing you with the appropriate fixesn answering support questionsn filling your shipping ordersn supplying documentation

If you have a concern that has not been resolved to your satisfaction, you can open a complaint ticket. All tickets are logged and tracked to ensure responsiveness and closure. Using the ticket information, a manager will contact you promptly to resolve your problem.

Index 89

Symbols@APLAOCM Command Table 27@APLMSGS Control Table 25

AAbout this Document 7Adobe Portable Document Format 9AF/OPERATOR

IRM start process 18AF/OPERATOR Commands Definitions 78APL

Application Name 34Calendar Functions 37Commands Functions 37Functions 32Standard Options 34Statistic Functions 38Trace Functions 36Trace Options 37Variable Functions 33Variable Options 35

Application Command Processor 38Application Manager 21

Application Name 34Calendar Functions 37Commands Functions 37Functions 32Parameters 32Standard Options 34Statistic Functions 38Trace Functions 36Trace Options 37Variable Functions 33Variable Options 35

Application Manager Resources 28Automation Application Initialization 20

CCandle Electronic Customer Support

(CECS) 86Candle home page 85Candle Internet site 85Candle Worldwide Web site 85Checkpointed Control Variables 74Command Syntax

APL 29APL Command 29TBL 50

Creatingapplication base environment 17

customer supportelectronic support 85Internet 85locations 86numbers 86telephone support 86

DDocumentation

supplied format 9Documentation Conventions 11Documentation Set 13

Hhome page

Candle 85

Iinitialization parameter deck 18Initializing

application base environment 17Internet site

Candle 85IRM Initialization Process 17

Index

Index


KKAU0OGAO parameter deck 18KAUA@CMD 38

OOnline Documentation 13On-line Help

APL Command 38TBL Command 54

PPanels and figures 11Prerequisites 8Printed documentation 13Printing problems 9

RREXX Table Manager 43

SSymbols 12System Variable Definition 56

TTable Management Services 42Table Manager 39

Command Syntax 50Created Tables 44Display Options 53Functions 51Objects 52Options 52Parameters 51RxTblMgr Functions 53Stored Tables 43Table Format 45

Table Manager Resources 49TBL

Command Syntax 50Created Tables 44

Display options 53Functions 51Objects 52Options 52Parameters 51RxTblMgr functions 53Stored Tables 43Table Format 45

typographical conventions 11

UUser Variable Definitions 65User Variable Description 68User Variable Names 68

VVariables and literals 11

WWorldwide Web site

Candle 85

Documents

Control Managers User’s Guide - IBMpublib.boulder.ibm.com/tividd/td/ITIntegRM/GC32-9222-00/en_US/PDF/GC32... · user's system description and the enabled applications. The following