Creating an input file

A batched repository-update facility input file consists of control statements that describe the updates you want to make to the data repository. The input file must adhere to the following requirements:

When creating your input file, you must first identify the context (CMAS or CICSplex) to which the updates apply. To do this, use the control statement:

   CONTEXT [plexid]
Start of change where plexid is the name of the local CMAS or of a CICSplex associated with the local CMAS End of change

(the local CMAS is the CMAS on which the batched repository-update job runs). If you specify a CICSplex as the context for the update, the local CMAS must be the maintenance point for that CICSplex. If you omit this parameter, the local CMAS is assumed to be the context.

Once you have established a context, it remains in effect for the batched repository-update job until you explicitly change it with another CONTEXT statement.

The rest of the control statements in an input file vary according to the type of updates you are making. The following sections describe the control statements for each type of update in detail.

Creating and maintaining CICSPlex SM definitions

To create, update, remove, or review CICSPlex® SM definitions in the data repository, use one or more control statements in the form:

   command object keyword1(value) keyword2

where:

command
Is the name of a batched repository-update facility command, in uppercase letters. Specify one of the following:
CREATE
To create a record and add it to the data repository associated with the local CMAS.
UPDATE
To update an existing record in the data repository.
Note:
You cannot update LNKSxSCG records using the batched repository-update facility, although you can do so through the end-user interface.
REMOVE
To remove an existing record from the data repository.

When you remove a record, all associations between that record and other records in the data repository are lost. For example, if you remove a CICS® system definition, associations between that CICS system and any CICS system groups or component specifications are also removed.

When removing BAS definitions the DEFVER( ) keyword must be specified.

LIST
To list a record from the data repository.
DUMP
To list a record from the data repository and insert a CREATE control statement in front of it.

You can use the output resulting from a DUMP command as input to another batched repository-update job that creates definitions. The output of a DUMP command is formatted as follows:

  • Data lines are broken at column 72
  • Continuation characters are placed in column 1.

By default, the output is written to a spool file and must be extracted from the spool, and edited, before it can be used as input to the batched repository-update facility. The extracted records contain ANS control characters in column 1, therefore you must shift the records one character to the left to align the data for processing by CICSPlex SM. You also have to remove all the page header information from the data set. For an example of a listing, see Figure 11. However, you can use the OUTPUT command to write the output in the correct format, direct to a data set. For details, see Creating a data set for re-input to the batched repository-update facility.

CICSPlex SM requires certain definitions to exist before others can be created. Therefore, you should adhere to the following guidelines when dumping data repository records:

  • Always dump CICS system (CSYSDEF) and CICS system group (CSYSGRP) records first.
  • Dump basic CICSPlex SM definition records (such as, xxxDEF, xxxGROUP, and xxxSPEC) before association records (such as, LNKxxxxx, xxxINGRP, or xxxINSPC).
  • For Business Application Services:
    • Dump RESGROUP records before RESDESC and RASGNDEF records.
    • Start of changeDump RESDESC and RASGNDEF records before RESINDSC and RASINDSC records.End of change
    • Dump resource definition records (such as FILEDEF) before xxxINGRP records (such as FILINGRP).
    • Dump CONNDEF and SESSDEF records before SYSLINK records.

If you follow these guidelines, the output from a DUMP command will be in the correct order for the batched repository-update facility to create new definitions. For an example of using the DUMP command output to create new definitions, see Examples of managing records in the data repository.

Note:
Start of change
Output from the DUMP and LIST commands contains a visible record of any passwords associated with CICS resources (such as connections or files). To prevent possible security exposures, you should restrict access to such output.
End of change
object
Is one of the resource table names shown in Table 6.

For a detailed description of each of these resource tables, their fields, and valid values, see the CICSPlex System Manager Resource Tables Reference.

keyword1(value)
Is the name of a field in the specified resource table and the data that is appropriate for that field, in uppercase letters. The required input for the various commands is as follows:
Start of changeCREATEEnd of change
Start of changeProvide all of the information required to define the resource, for example the same type of information as required by the equivalent end-user interface CREate view.

Start of changeYou can derive the input to the CREATE statement from the output of a DFHCSDUP EXTRACT or BATCHREP DUMP request. See Creating a data set for re-input to the batched repository-update facility, Example 6 - Dumping records as input to create new records for further information. If you do not create your input in this way, you must specify all the required attributes.

Note:
For some definition records you should not specify certain operands; for example, for CPLEXDEF, do not specify the STATUS operand.
End of changeEnd of change
Start of changeUPDATEEnd of change
Start of changeIdentify the specific record to be updated. For CICS resource definitions created as part of business application services (BAS), this must include the version (DEFVER) of the resource. Specify the attributes that will be updated.End of change
REMOVE
Identify the specific record to be removed. For CICS resource definitions created as part of business application services (BAS), this must include the version (DEFVER) of the resource.
LIST and DUMP
Provide a specific or generic record name, where generic names can contain the plus sign (+), asterisk (*), or both.
keyword2
Indicate how the creation or removal of a specification-to-CICS system group link record (LNKSxSCG) should affect the current members of the CICS system group. The keywords for the CREATE and REMOVE commands must be entered in uppercase letters and are as follows:
CREATE
Start of changeSpecify one of the following:
FORCE
All current members of the CICS system group should have implicit links established to the named specification. When a link already exists, it is replaced with the newly CREATEd link.
NULL
Current members of the CICS system group should have implicit links established to the named specification only if no link already exists.
NONE
No implicit links should be established.
Start of changeWhen you use the CREATE command, the default value for keyword2 is NONE End of changeEnd of change
REMOVE
Start of changeSpecify one of the following:
KEEP
All implicit links are to be converted to explicit links.
NONE
No implicit links are to be converted to explicit links.
There is no default value for keyword2 when you use the REMOVE command; you must specify a value.End of change

When you submit the batched repository-update job, the syntax of each command is checked for validity. If multiple commands are being issued, syntax checking can have the following results:

Creating CICS resource definitions

To create CICS resource definitions and optionally add them to a resource group in the data repository, use one or more control statements in the form:

   CREATE object NAME(defname) [RESGROUP(resgroup)]

where:

object
Is one of the resource table names shown in Table 6 that represent a CICS resource type (such as CONNDEF).
defname
Is the name of the resource definition you are creating.
resgroup
Is the name of an existing resource group in the data repository to which the resource definition should be added.

Producing a map of CICSPlex SM definitions

In addition to creating and maintaining CICSPlex SM definitions, you can produce a visual map of the definitions in the data repository. The map is similar to the one displayed when you issue the MAP action command from an end-user interface view.

To produce a map, use one or more control statements in the form:

   command object NAME(defname)

where:

command
Is the name of a batched repository-update facility command, in uppercase letters. Specify one of the following:
MAPLEFT
To produce a map of the definitions to the left of the starting point; that is, those definitions that refer to the starting point.
MAPRIGHT
To produce a map of the definitions to the right of the starting point; that is, those definitions that are referred to by the starting point.
object
Is a resource table name that identifies the type of definition to be displayed in the map.

You can produce a map of the following definitions:

Topology
  • CSYSDEF
  • CSYSGRP
  • PERIODEF
Workload management
  • TRANGRP
  • WLMDEF
  • WLMGROUP
  • WLMSPEC
Real-time analysis
  • ACTION
  • APSPEC
  • EVALDEF
  • RTADEF
  • RTAGROUP
  • RTASPEC
  • STATDEF
Resource monitoring
  • MONDEF
  • MONGROUP
  • MONSPEC
Business application services
  • xxxxDEF (resource definitions such as FILEDEF)
  • RESGROUP
  • RESDESC
  • RASGNDEF
Start of changeNAMEEnd of change
Start of changeStart of changeIs the field name of the key field for the resource being mapped. For all resources the key field name is NAME, with the following exceptions: End of changeEnd of change
defname
Is the specific or generic name of a definition that is to be the starting point for a map. If you enter a generic name, a map is produced for each definition whose name matches the pattern.

For an example of a visual map of definitions, see Displaying a map of CICSPlex SM definitions.

Start of change

Setting processing options for repository-update commands

The default behavior of batched repository-update commands can be modified by the OPTION command. The format of the OPTION command is:

OPTION type keyword [keyword ...]

where

The following option types are currently supported:

DUPREC
Specify how the CREATE command will handle the RECORD_EXISTS condition. One of the following keywords must be specified:
REJECT (default)
The existing record is not be modified; the BATCHREP input stream is flushed and no more commands are processed.
SKIP
The existing record is not modified; processing continues with the next BATCHREP command.
UPDATE
The existing record is updated by redriving the CREATE command as if it were an UPDATE.
Notes:
  1. Several link type CICSPlex SM resource tables do not support the UPDATE action. If a BATCHREP input stream that creates any of the following resource types must be restarted, OPTION DUPREC SKIP must be specified or the command retry will fail. Affected resource tables are:
      Start of change
    • CMDMPAPS - APSPEC to Primary CMAS
    • CMDMSAPS - APSPEC to Secondary CMAS
    • CSGLCGCG - CICSGRP in CICSGRP
    • CSGLCGCS - CICSSYS in CICSGRP
    • LNKSxSCG - xxxSPEC to CICSGRP, where xxx is MON, RTA or WLM
    • LNKSxSCS - xxxSPEC to CICSSYS, where xxx is MON, RTA or WLM
    • End of change

If a STATUS other than RECORD_EXISTS is returned by the CREATE command, the command is not retried and all remaining commands in the input file are flushed.

Multiple OPTION commands can be placed in the BATCHREP input stream. An OPTION command affects all commands until another OPTION command is encountered for the same option type or the input command stream reaches end-of-file.

End of change [[ Contents Previous Page | Next Page Index ]]