Documentation boxes
The
BMC AMI Ops Automation
solutions EXECs are distributed with a documentation box.
The following figure shows an example of a documentation box.
/* DOC GROUP(MVS) FUNC(MONITORS) CODE(MN) */
/* DOC DISP(YES) AUTHOR(B&B) */
/* DOC DESC(RESOLVE WTO BUF SHORTAGE) */
/*--------------------------------------------------------------------------*/
/* NAME: */
/* IEE249I */
/* */
/* DESCRIPTION: */
/* RESOLVE THE WTO BUFFER SHORTAGE SITUATION */
/* */
/* SEE ALSO: */
/* IEA404A */
/* IEA405E */
/* */
/* INVOKED BY: */
/* IEA404A */
/* IEA405E */
/* */
/* INPUT PARAMETERS: */
/* NONE */
/* */
/* OUTPUT: */
/* NONE */
/* */
/* OUTBOARD CALLS: */
/* NONE */
/* */
/* EXTERNAL ROUTINES CALLED: */
/* MVS 'K' OR 'Control' COMMANDS ARE ISSUED. */
/* NOTE: FOR THE 'K' COMMANDS TO BE PROPERLY AUTHORIZED, THEY MUST BE */
/* ---- ISSUED FROM A NON-SUBSYSTEM CONSOLE. EDIT THE MEMBER, */
/* BBISSP00, IN YOUR BBPARM DATA SET AND ADD THE KEY WORD, */
/* CMDCON=1; THIS WILL DIRECT ALL COMMANDS WHICH DO NOT REQUIRE */
/* A RESPONSE TO CONSOLE ID 1. */
/* */
/* ALERTS ISSUED: */
/* NONE */
/* */
/* VARIABLES USED: */
/* NAME: DESCRIPTION: DEFAULT VALUE: */
/* MSG MESSAGE ID IEE249I */
/* P1 WORD 1 CUA OF CONSOLE OR SYSLOG */
/* P2 WORD 2 CONSOLE ID */
/* P3 WORD 3 COND= */
/* P4 WORD 4 AUTH= */
/* P5 WORD 5 NBUF= */
/* */
/* TEST SCRIPT INFO: */
/* GENERATE A WTO FROM A TEST EXEC TO TRIGGER A CALL TO EITHER OF */
/* THE DRIVER EXECS: IEA404A OR IEA405E */
/* */
/* RETURN CODES: */
/* NONE */
/* */
/* CHANGE LOG: */
/* 03-05-90 BY MDR: ADDED DOCUMENTATION BOX */
The information contained at the top of the documentation box is used by the BMC AMI OpsA EXEC Management Application to display information about the EXECs in the SYSPROC libraries. GROUP, FUNC, CODE, DISP, AUTHOR, and DESC are displayed on one line by the BMC AMI OpsA EXEC Management Application (see to Using-Rules-with-BMC-AMI-Ops-Automation for more information). The rest of the information in the documentation box is for self-documentation and easy reference.
The following table describes the documentation box fields.
Field | Description |
|---|---|
GROUP | group to which this EXEC belongs (for example, MVS, CICS, DB2 , or IMS) |
FUNC | functional category within the group |
CODE | two-character function code |
DISP | whether information about this EXEC should be displayed under the EXEC Management Application (refer to Using-Rules-with-BMC-AMI-Ops-Automation) |
AUTHOR | author of the EXEC |
DESC | description of what the EXEC does (25 characters or fewer) |
NAME | name of the EXEC |
DESCRIPTION | detailed description of what the EXEC does |
SEE ALSO | cross-reference listing |
INVOKED BY | list of other EXECs that call this one |
INPUT PARAMETERS | parameter name, description, and default value required for input parameters |
OUTPUT | information or names of variables that are returned |
OUTBOARD CALLS | whether any pager calls have been placed |
EXTERNAL ROUTINES CALLED | other routines or services called, along with any special considerations for those calls |
ALERTS ISSUED | brief text of long EXECs where ALERTs are issued; otherwise, a YES or NO is returned |
VARIABLES USED | variable name, description, and default value of any variables used |
TEST SCRIPT INFO | necessary environment and steps that are needed to test the EXEC if changes are required |
RETURN CODES | what return codes (if any) are returned |
CHANGE LOG | chronology of changes |
Related topic