Data set naming template

A data set naming template provides flexibility for naming output image copy data sets that IMS HP Image Copy allocates dynamically.

Data set naming template supports generation data groups (GDG).

Subtopics:

Considerations for using the data set naming template

The following considerations apply when using the data set naming template:

  • A naming template is available for the Image Copy function and the Create Image Copy function.
  • A naming template can be specified only in the GLOBAL statement.
  • DSN3-DSN7 can be used only for the Create Image Copy function.
  • The templates for DSN, DSN2, DSN3, DSN4, DSN5, DSN6, and DSN7 must each be unique. The same naming pattern cannot be used for any two of these templates.
  • When you use the naming template in making two or more image copies, one template is required for each copy.
  • A naming template must be used when dynamically allocating GDG data sets.
  • When a template is specified, the default naming rule and the ICNMRULE keyword are ignored.

Specifications of the data set naming template

The data set naming template is enabled by specifying the DSN keyword in the ICEIN GLOBAL statement. The data set naming convention that is applied depends on which naming template you specify. The specification of a naming template is a combination of naming patterns provided.

Specification syntax

The naming template conventions you must follow apply to:

  • DSN
  • DSN2
  • DSN3
  • DSN4
  • DSN5
  • DSN6
  • DSN7
  • SHDWDSN

The naming template conventions are as follows:

  • Every symbolic variable must end with a period (.). If your data set name is ICHLQ.DBD.DDN, you specify DSN=&ICHLQ..&DBD..&DDN.
  • The first period of the two periods between &ICHLQ and &DBD is part of the first parameter &ICHLQ; the second period separates the second parameter from the first.
  • If you specify &ICHLQ.&DBD. (without the second period), the names of &ICHLQ. and &DBD will be merged. The result is ICHLQDBD.
  • The rule for specifying the naming template is the same as that for the JCL symbolic parameter.

    Subparameters are provided for the &DBD, &PART, &DBDPART, and &DDN parameters:

    Read syntax diagramSkip visual syntax diagram &DBD&PART&DDN&DBDPART (n,length)(1n,length)

    These symbolic parameters with subparameters return the substring of name string that begins at the nth character and is of length in length.

    The meanings of the name strings are as follows:

    • The DBD name for &DBD
    • The PART name for &PART
    • The DD/AREA name for &DDN
    • The DBD name of non-HALDB or PART name of HALDB for &DBDPART

    For n and length, you can specify the following values:

    • For &DBD or &DDN, n and length are integer values in the range of 1 - 8, respectively.
    • For &PART, n and length are integer values in the range of 1 - 7, respectively.
    • For &DBDPART, length is an integer value in the range of 1 - 8.

    If you omit n, it means 1. If you omit length, the rest of the name string is returned. You cannot omit both n and length at the same time.

Symbolic parameters

Symbolic parameters of IMS HP Image Copy are listed in the following table.

Table 1. Symbolic parameters
Symbol Meaning
&ICHLQ The data set prefix specified by the ICHLQ operand in the GLOBAL statement
&ICHLQ2 The data set prefix specified by the ICHLQ2 operand in the GLOBAL statement
&ICHLQ3 The data set prefix specified by the ICHLQ3 operand in the GLOBAL statement
&ICHLQ4 The data set prefix specified by the ICHLQ4 operand in the GLOBAL statement
&ICHLQ5 The data set prefix specified by the ICHLQ5 operand in the GLOBAL statement
&ICHLQ6 The data set prefix specified by the ICHLQ6 operand in the GLOBAL statement
&ICHLQ7 The data set prefix specified by the ICHLQ7 operand in the GLOBAL statement
&DBD
&DBD(n,length)		 DBD name.

When the organization of the database is HALDB, &DBD symbol is interpreted as the master DBD name.

If you want to extract a part of a string in the DBD name, use the &DBD() parameter.
&GROUP DBRC group name.
This symbol is used if the database data sets to process are identified from the GROUP statement or when the Image Copy function is called from IMS Database Recovery Facility jobs. This symbol is not applicable to database data sets that are not identified by the GROUP statement.
  • If the GROUP statement is specified, this symbol is interpreted as the DBRC group name.
  • If the Image Copy function is called from an IMS Database Recovery Facility job, this symbol is interpreted as the DBRC CA group name.
If this symbol is used in other conditions, it is ignored.
&PART
&PART(n,length)		 The partition name of the HALDB.

If you want to extract a part of a string in the partition name of the HALDB, use the &PART() parameter.

If the database is not a HALDB and if &PART is specified, strings are not expanded and the qualifier is omitted.
&DBDPART
&DBDPART(n,length)		 When the database is a non-HALDB, the DBD name of the database is used.
When the database is a HALDB, partition name of the HALDB is used.

If you want to extract a part of a string in the DBD name or the partition name of a HALDB, use the &DBDPART() parameter.
&DDN
&DDN(n,length)		 DB data set ddname

When the organization of the database is HALDB, the &DDN symbol is interpreted as the DD name of the partition database data set.

When the organization of the database is DEDB, the &DDN symbol is interpreted as the AREA name of the DEDB database. If you want to extract a part of a string in the DD name or the AREA name, use the &DDN() parameter.

&IC The string 'IC' or 'CRC'
&DATE The Julian date (yyyyddd)
&SDATE The Julian date, in short format (yyddd)
&YEAR The year (yyyy)
&SYEAR Two digits of the year (yy)
&MONTH The month (mm)
&DAY The day of the month (dd)
&JDAY The day of the year (ddd)
&JDAY2 Lower two digits of the date in the day of the year (dd)
&TIME The time stamp (hhmmss)
&HOUR The hour (hh)
&MINUTE The minute (mm)
&SECOND The second (ss)
&GDG The identifier of the GDG data set. IMS HP Image Copy processes the output data set name as GDG. (See notes.)
Notes:
  1. This pattern is an identifier for the GDG data set.
  2. &GDG must be specified in the last position in the pattern.
  3. &GDG cannot be specified with a symbol related to date or time.
  4. n is the position of the first character that is to appear in the result, length is the length of the result.

Examples

Refer to the following examples to learn how to use the naming template.

Example 1
Names of the image copy data sets that IMS HP Image Copy is expected to produce: 
IC1: AAA.BBB.IC1.dbdname.ddname.GggggVvv
IC2: AAA.BBB.IC2.dbdname.ddname.GggggVvv

The naming templates available are:

GLOBAL
ICHLQ=AAA.BBB.IC1,
ICHLQ2=AAA.BBB.IC2,
DSN=&ICHLQ..&DBD..&DDN..&GDG.,
DSN2=&ICHLQ2..&DBD..&DDN..&GDG.

or

GLOBAL
ICHLQ=AAA.BBB,
DSN=&ICHLQ..&IC.1.&DBD..&DDN..&GDG.,
DSN2=&ICHLQ..&IC.2.&DBD..&DDN..&GDG.
Example 2

Names of the image copy data sets that IMS HP Image Copy is expected to produce:

IC1: AAA.BBB.COPY1.ddname.GggggVvv
IC2: AAA.BBB.COPY2.ddname.GggggVvv

The naming templates available are:

GLOBAL
ICHLQ=AAA.BBB.COPY1,
ICHLQ2=AAA.BBB.COPY2,
DSN=&ICHLQ..&DDN..&GDG.,
DSN2=&ICHLQ2..&DDN..&GDG.

or

GLOBAL
ICHLQ=AAA.BBB,
DSN=&ICHLQ..COPY1.&DBD..&DDN..&GDG.,
DSN2=&ICHLQ..COPY2.&DBD..&DDN..&GDG.
Example 3

Names of the image copy data sets that IMS HP Image Copy is expected to produce:

IC1: ICPRI.dbdname.ddname.GggggVvv
IC2: ICSEC.dbdname.ddname.GggggVvv

The naming template available is:

GLOBAL
ICHLQ=IC,
DSN=&ICHLQ.PRI.&DBD..&DDN..&GDG.,
DSN2=&ICHLQ.SEC.&DBD..&DDN..&GDG.
Example 4
Names of the image copy data sets that IMS HP Image Copy is expected to produce: 
IC1: AAA.dbdname.ddname.GggggVvv
IC2: BBB.dbdname.ddname.GggggVvv
The naming template available is: 
GLOBAL
DSN=AAA.&DBD..&DDN..&GDG.,
DSN2=BBB.&DBD..&DDN..&GDG.
Example 5

Names of the image copy data sets that IMS HP Image Copy is expected to produce:

IC1: AAA.dbdname.ddname.Dyyyyddd.Thhmmss
IC2: BBB.dbdname.ddname.Dyyyyddd.Thhmmss
The naming templates available are: 
GLOBAL
DSN=AAA.&DBD..&DDN..D&DATE..T&TIME.,
DSN2=BBB.&DBD..&DDN..D&DATE..T&TIME.
or 
GLOBAL
ICHLQ=AAA, ICHLQ2=BBB
DSN=&ICHLQ..&DBD..&DDN..D&DATE..T&TIME.,
DSN2=&ICHLQ2..&DBD..&DDN..D&DATE..T&TIME.
Example 6

Names of the image copy data sets that IMS HP Image Copy is expected to produce:

IC1 of non-HALDB: AAA.dbdname.ddname.ICDS
IC1 of HALDB: AAA.partname.ddname.ICDS
The naming template available is:
GLOBAL
DSN=AAA.&DBDPART..&DDN..ICDS
Example 7

Names of the image copy data sets that IMS HP Image Copy is expected to produce:

IC1 of non-HALDB: AAA.dbdname.ddname.ICDS
IC1 of HALDB: AAA.masterdbdname.partname.ddname.ICDS
The naming template available is:
GLOBAL
DSN=AAA.&DBD..&PART..&DDN..ICDS