EYU9XDBT utility commands

You can use a number of commands in the EYU9XDBT CICSPlex® SM definition utility command stream.

EYU9XDBT reads and processes all commands in the input stream sequentially. Specify the commands in the correct sequence, with commands such as OPTION DUPREC and OPTION FEEDBACK preceding the commands to which they relate and operate on. For example, OPTION DUPREC precedes the IMPORT command on which you want it to operate.
Comments
You can include comments in the EYU9XDBT command stream. An asterisk in column 1 and a blank in column 2 indicates a comment.
Continuation
A hyphen (-) indicates continuation. A continuation character is supported on the DEFINE and REMOVE commands. For example, the DEFINE REGION command has a number of subparameters, which can be on separate lines, shown as follows:
DEFINE REGION    region_name    -
       APPLID    region_applid  -
       SYSID     region_sysidnt

Commands

ADD TOGROUP groupname
Add regions or groups to a CICS group. You specify the object to be added on either a REGION or CICSGRP sub-parameter following the ADD command. For examples of the ADD command, see Parameters used in EYUJXBT1.
CONTEXT {cmas_name |CICSPlex_name}
Set the context for the commands that follow. For examples of the CONTEXT command, see Parameters used in EYUJXBT1.
DEFINE object_type object_name mandatory_identifiers+
Define the specified object, the type of which can be CICSPLEX, REGION, or CICSGRP. The object types, CICSPLEX, REGION, and CICSGRP, are synonyms for the CPLEXDEF, CSYSDEF, and CICSGRP definitions.
  • To define a CICSPLEX, you must specify the object_type as CICSPLEX and specify the object_name; the object name is the 1- to 8-character alphanumeric name of the CICSplex that you are defining. Note that the first character of the object_name must be alphabetic. There are no other mandatory identifiers associated with the CICSPLEX object type. The command takes the following form:
    DEFINE CICSPLEX plexname

    This command creates a CPLEXDEF in the CICSPlex SM CMAS repository.

  • To define a REGION, you must specify the object_type as REGION, the 1- to 8-character alphanumeric name of the CICS region that you are defining as the object_name, and the following mandatory identifiers: APPLID and SYSID. The command takes the following form:
    DEFINE REGION region_name     -
           APPLID region_applid   - 
           SYSID  region_sysidnt

    This command creates a CSYSDEF in the CICSPlex SM CMAS repository.

  • To define a CICSGRP, you must specify the object_type as CICSGRP and specify the object_name; the object name is the 1- to 8-character alphanumeric name of the CICS system group that you are defining. Note that the first character of the object_name must be alphabetic. There are no other mandatory identifiers associated with the CICSGRP object type. The command takes the following form:
    DEFINE CICSGRP group_name

    This command creates a CICSGRP in the CICSPlex SM CMAS repository.

For examples of the DEFINE command, see Parameters used in EYUJXBT1.
DELETE object_type object_name
Delete the specified object, the type of which can be one of CICSPLEX, REGION, or CICSGRP. You can specify an asterisk in object_name as a wildcard character.
EXPORT DDname resource_type resource_id
Write all the definitions of the specified type and identifier in the current context to the specified output file. For resource_type, specify in full one of the CICSPlex SM resource types or an asterisk, *, for all resource types. The valid resource types are any resources that are written to the CICSPlex SM data repository, including all BAS objects, WLM definitions, RTA definitions, topology definitions, or monitor definitions. BAS RESINGRP resource records can't be exported, however each BAS resource definition has an equivalent XXXINGRP resource record that can be exported. You can specify an asterisk in resource_id as a generic (wildcard) character. If you set both the resource type and the resource identifier to asterisks, EYU9XDBT exports all the definitions within the current context.
Note: Trailing blanks are treated as trailing wildcard characters, so EXPORT DDname exports all the definitions in the DDname context.
IMPORT DDname resource_type resource_id
Import into the repository, in the current context, all the definitions of the specified type and identifier from the input file defined on the named DD statement. For resource_type, specify in full one of the CICSPlex SM resource types or an asterisk for all resource types. The valid resource types are any resources that are written to the CICSPlex SM data repository, including all BAS objects, WLM definitions, RTA definitions, topology definitions, or monitor definitions. BAS RESINGRP resource records can't be imported, however each BAS resource definition has an equivalent XXXINGRP resource record that can be imported. You can specify an asterisk in resource_id as a wildcard character. If you set both the resource type and the resource identifier to asterisks, EYU9XDBT imports all the definitions it finds in the input data set.
Note the following rules for imported files:
  • The input records should be 80 bytes records and the data will be truncated to 72 bytes.
  • Double quotation marks (") in the import file are used as string delimiters. Therefore, if you want to include a double quotation mark character in the input file, you must use a consecutive pair of double quotation marks in the text string. For example the following string in the import file, "double""quote""example" becomes double"quote"example when the file is imported into the CICSPlex SM object.
  • Continuation lines are used in import files to represent lines that would otherwise exceed the maximum length. The following example uses the program definition of a JVM class, which is represented as a 255 byte string, to show how continuation lines are represented in an import file:
    PROGDEF_JVMCLASS = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA";
    PROGDEF_JVMCLASS = PROGDEF._JVMCLASS || "AAAAAAAAAAAAAAAAAAABBBBBBBB";
    PROGDEF_JVMCLASS = PROGDEF._JVMCLASS || "BBBBBBBBBBBBBBBBBBBBBBBBBBB";
    PROGDEF_JVMCLASS = PROGDEF._JVMCLASS || "BBBBBBBBBCCCCCCCCCCCCCCCCCC";
    ...
    PROGDEF_JVMCLASS = PROGDEF._JVMCLASS || "ZZZZZZ";

    The program definition statement, PROGDEF_JVMCLASS = "AAA..." overflows the first line and continues on each successive line by appending the next section of the definition to the previous one. The REXX syntax for a stem variable, ., is used to indicate that a line is a continuation line. In this example, PROGDEF_JVMCLASS is replaced with PROGDEF._JVMCLASS for each continuation line. The REXX concatenation bars, ||, on the continuation line append the next section of the string to the existing string.

OPTION [DUPREC | FEEDBACK | REPORT]
Request the action that EYU9XDBT is to take during command processing. This request can be DUPREC, FEEDBACK, or REPORT. To request more than one action, specify each one on separate OPTION command statements. The DUPREC, FEEDBACK, and REPORT actions each have options that you can select:
DUPREC {ABORT | REJECT | SKIP | UPDATE}
DUPREC specifies the action you want EYU9XDBT to take in the event of a duplicate record being found during import processing. This command must precede the IMPORT or DEFINE statement to which it refers. Permitted options are:
  • ABORT: If there is duplication of the name of an object being defined and the name of an existing repository definition when processing a DEFINE or IMPORT command, the duplicate name being defined or imported is skipped and the data repository is not changed. The ABORT option is treated as an unrecoverable error: EYU9XDBT writes a message to the job log and raises return code 12. The job is stopped immediately.
  • REJECT: If there is duplication of the name of an object being defined and the name of an existing repository definition when processing a DEFINE or IMPORT command, the duplicate name being defined or imported is skipped and the data repository is not changed. The REJECT option is handled as an error and EYU9XDBT writes a message to the job log. EYU9XDBT raises return code 8 for a REJECT error. REJECT is the default option.
  • SKIP: If the name of an object being defined is the same as the name of an existing repository definition when processing a DEFINE or IMPORT command, the new definition is skipped, and the data repository is not changed. This is handled as normal (return code 0).
  • UPDATE: If there is duplication of the name of an object being defined and the name of an existing repository definition when processing a DEFINE or IMPORT command, the existing definition is updated with the attributes of the record being defined or imported. If the existing definition cannot be updated by modifying specific attributes, it is deleted and recreated from the DEFINE or IMPORT command. This action is handled as normal (return code 0).
Note: When importing CPLXCMAS records that associate a CICSplex name to the Maintenance Point CMAS in an OPTION DUPREC UPDATE scenario, the command response will always be Record skipped. One CPLXCMAS record is created implicitly whenever a CPLEXDEF record is imported to a CMAS. These records may only be removed implicitly when their corresponding CPLEXDEF records are deleted.
FEEDBACK {QUIET | VERBOSE}
FEEDBACK specifies how EYU9XDBT handles exception condition reporting if an error is returned from the CICSPlex SM API. Permitted options are as follows:
  • QUIET: EYU9XDBT writes only a basic EYU9XDBT message to the job log. QUIET is the default FEEDBACK option.
  • VERBOSE: In addition to the standard message reporting response and reason codes, EYU9XDBT writes any associated CICSPlex SM feedback data to the destination specified on the SYSTSPRT DD statement.
REPORT {FULL | SUMMARY}
  • FULL: This is the default option, and the current reporting state before this change. When the program processes a PRINT, IMPORT, EXPORT, or DELETE command for an EYUDREP object, all attributes of that object are printed in the report. For large data repositories, this report option can generate many thousands of line of data.
  • SUMMARY: This restricts the printed resource table content to just the key field identifiers for the PRINT, IMPORT, EXPORT, and DELETE commands.
You can use the OPTION REPORT command consecutively in a command stream, so that some processes list all attribute data, and others just summarize attribute data. For example:
* Set the context to my CICSplex
CONTEXT myplex01
* Specify that duplicates are to be updated
OPTION DUPREC UPDATE
* Specify that I only want record identifiers printed
OPTION REPORT SUMMARY
* Now import my CSYSDEF records
IMPORT CPSMIO1 CSYSDEF * *
* Now do a detailed print of what was just imported ...
OPTION REPORT FULL
* ... and print all CSYSDEF details.
PRINT CSYSDEF * * 
PRINT resource_type resource_id
Print definitions in the current context from CMAS repository. For resource_type, specify in full one of the CICSPlex SM resource types or an asterisk for all resource types. You can specify an asterisk in resource_id as a wildcard character. If you specify two asterisks for the resource type and resource identifier, EYU9XDBT prints all definitions within the current context.
REMOVE FROMGROUP groupname
Remove the specified object from the named group. You specify the object on either a REGION or CICSGRP sub-parameter following the REMOVE command.


eyua700005.html | Timestamp icon Last updated: Sunday, 4 June 2017