Logical Field Names for the Control-M/Tape Repository

The tables in this section list fields that can be

  • specified in utility INCLUDE/EXCLUDE statements to determine which records are processed when the utility runs

  • For a complete explanation of INCLUDE/EXCLUDE statements, see the ControlM/Tape utilities chapter in the INCONTROL for z/OS Utilities Guide.

  • manually updated in the Media Database with the CTTMUP utility

  • included in utility-generated reports

These tables specify field names according to record type. Each table contains data for every field.

Table 300 Field Names According to Record Type

Field

Description and Valid Values

External Name

Field name as specified by the user. Either of two types of data can be specified. Valid values:

Keyword value - Specific valid values. Shown in uppercase (for example, CYCLE, DATE, JCL). Non-trivial values are accompanied by a description in the Description column of the table.

Value type - Shown in lowercase (for example, char, integer, date). The following table describes these value types. If relevant, the maximum length of the value is displayed in parentheses next to the value type.

Note: Hexadecimal values must be prefixed with an X (for example, DVLRBA=X01234567 instead of DVLRBA=01234567) except in relation to VER and REP fields.

Description

Brief description of the field. This column also contains a description of any specific values specified in the Valid Values column.

Internal Name

Name used in the macro to reference the field.

The following table briefly describes the value types that can be specified in the Valid Values column:

Table 301 Value Types in the Valid Values Column

Type

Description

hex

Hexadecimal character format (valid characters: 0 through 9, A through F). Maximum length indicated in parentheses.

date

Valid formats are: yymmdd or yyyymmdd. The following keywords are also valid:

  • %CDAY - Current day (today).

  • %PDAY - Previous day (yesterday).

  • %NDAY - Next day (tomorrow).

  • %PWEEK - Previous week.

  • %NWEEK - Next week.

  • %PMONTH - Previous month (30 days).

char

Free character format. Maximum length indicated in parentheses. The specified character string can include masking characters. For more information about masking characters, see the online facilities chapter in the Control‑M/Tape User Guide.

%NMONTH - Next month (30 days).

time

The valid format is hhmmss.

julian date

Valid formats are yyddd or yyyyddd. Special values (for example, 98000, 99000) are also supported.

integer

Numeric value.

date/integer

Either a date value or an integer value can be specified. Date values must be prefixed by D (for example, format Dyyyymmdd). Integer values must be prefixed by I (for example, I35). By default (that is, if no prefix is specified), the value is assumed to be a date.

The foregoing values can be used in the following table types:

Dataset record tableLink copied to clipboard

The following table describes the fields of dataset records:

Table 302 Keywords Used With Dataset Type Records

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

ACCOUNT

char (50)

Job’s accounting information

DDSACCT

BLKSIZE

integer

Dataset’s block size

DDSBLK

BLOCKCT

integer

Block count

DDSBLKC

CRECC

char (4)

Condition code of creating step

DDSCCC

CRECPU

char (4)

CPU in which dataset was created

DDSCCPU

CREDDN

char (8)

Creating DD name

DDSCDDN

CREDT

date

Creation date

DDSCDT

CREJBN

char (8)

Creating job name

DDSCJBN

CREJOBID

char (8)

Creating job ID (format JOBxxxxx)

DDSCJID

CREPGM

char (8)

Creating program name

DDSCPGM

CRESTEP

char (8)

Creating step name

DDSCSTP

CRETM

time

Creation time

DDSCTM

CREUAD

hex (4)

Unit address on which the dataset was created

DDSCUAD

CREUSER

char (8)

User ID that created the dataset

DDSCUSER

DCHANGED

date

Last change date

DDSMDT

DCHANGET

time

Last change time

DDSMTM

DCHANGEU

char (8)

Last user ID that changed the entry

DDSLUSER

DDSRBA

hex(8)

Record’s RBA

DDSRBA

DSCSIZE

integer

Compressed size in kilobytes

DDSCSIZE

DSENDSZE

integer

Ending size in kilobytes on the volume

DDSECSZE

DSEXCP

integer

EXCP count since dataset was created

DDSEXCP#

DSEXPDT

date/integer

Dataset’s expiration date, number of cycles or number of days according to DSEXPTYP

DDSEXPD1

DSEXPTYP

CYCLE

DATE

EDM

LACCS

CATALOG

PERM

VLTRET

SMS

Dataset’s expiration type:

Number of cycles

Actual date

EDM controlled

Number of days since last accessed

MVS Catalog Control

Permanent dataset

Controlled by vaulting

Controlled by SMS Management Class

DDSEXPT1

DSFLAGSa

DISPMOD

DYNDEF

RECREATE

MANUPDAT

JCLRETPD

DELRTM

DSRSTRT

Dataset flag byte:

Dataset opened with DISP=MOD

Dataset dynamically defined

Dataset recreated

Dataset manually updated (Online/Utility CTTMUP)

RETPD specified in the JCL for the dataset

Dataset marked to be deleted by CTTRTM

Dataset processed under MVS RESTART

DDSFLG1

DSFLAG2 (b)

GRACECAT GRACECYC

Additional status flag: Dataset retention was extended based on catalog grace period Dataset retention was extended based on cycle grace period

DDSFLG2

DSLABEL

integer

Dataset label number

DDSLBLNM

DSNAME

char (44)

Dataset name

DDSDSN

DSPOS

hex (4)

Block ID of current dataset Header1 block

DDSPOS

DSSIZE

integer

Uncompressed size in kilobytes

DDSUSIZE

DSSTATb

DACTIVE

DINUSE

DPENDSCR

DSCRATCH

DSTACKED

DEDM

DABEND

DNSTK

Dataset status:

Active dataset

In-use dataset

Pending scratch dataset

Scratched dataset

Stacked dataset

EDM controlled dataset

Closed under abend dataset

Unstackable dataset

DDSSTAT

DSTKGRP

char(8)

Dataset Stacking Group

DDSSTKG

DSUSECT

integer

Dataset usage count

DDSUSED#

DSVOLSER

char (6)

Dataset’s first volume

DDSVOLSR

DUSRDATA

char (20)

User data

DDSUSER2

JCLEXPDT

Julian date

JCL EXPDT value

DDSJEXPD

LASTACCS

C, R, W

Last access type (create, read, write)

DDSLACS

LRECL

integer

Dataset logical record length

DDSRECL

READCPU

char (4)

CPU in which dataset was last read

DDSRCPU

READDDN

char (8)

Last read DD name

DDSRDDN

READDT

date

Last read date

DDSRDT

READJBN

char (8)

Name of the last job that read the dataset

DDSRJBN

READPGM

char (8)

Name of last program that read the dataset

DDSRPGM

READSTEP

char (8)

Name of the last step that read the dataset

DDSRSTP

READTM

time

Last read time

DDSRTM

READUAD

hex (4)

Unit address on which the dataset was last read

DDSRUAD

RECFM

U, F, FB, FBA, FBM, FBS, V, VB, VS, VBA, VBM, VBS, D

Dataset’s record format

DDSRECFM

RFORMAT

Recording format of the data on the volume

DDSRFMT

  

BPI200

200 bits per inch

  

BPI556

556 bits per inch

  

BPI800

800 bits per inch

  

BPI1600

1600 bits per inch

  

BPI6250

1625 bits per inch

  

TRACK18

18 tracks

  

TRACK36

36 tracks

  

TRACK128

128 tracks

  

TRACK256

256 tracks

  

TRACK384

384 tracks

  

EFMT1

Enterprise Recording Format 1

  

RTNFROM

DEFAULT

JCL

RULE

SMS

SMSDFLT

SMSLIMIT

SMSJCL

CTTMUP

CHKIN

ONLUPD.

Dataset Retention origin:

From CTTPARM

From JCL

From Control‑M/Tape rules

From SMS Management Class

From SMS default

From SMS limit

From SMS JCL

Updated by utility CTTMUP

External Volume Check-In (TC Screen) Online facility

DDSRTORG

SMSMC

char (8)

SMS Management Class

DDSSMCL

TRTCH

COMP, NOCOMP

Indication of whether the data is compressed (for example, IDRC)

DDSTRTCH

VOLSNUM

integer

Number of volumes on which the dataset resides (multi-volume dataset)

DDSVOLS#

WRITECCC

char (4)

Condition code of the last step that wrote to the dataset

DDSWCC

WRITECPU

char (4)

CPU in which the dataset was last written

DDSWCPU

WRITEDDN

char (8)

Last write DD name

DDSWDDN

WRITEDT

date

Last write date

DDSWDT

WRITEJBN

char (8)

Name of the last job that wrote to the dataset

DDSWJBN

WRITEPGM

char (8)

Name of last program that wrote to the dataset

DDSWPGM

WRITESTP

char (8)

Name of the last step that wrote to the dataset

DDSWSTP

WRITETM

time

Last write time

DDSWTM

WRITEUAD

hex (4)

Unit address on which the dataset was last written

DDSWUAD

a This field can be used normally in INCLUDE/EXCLUDE statements of a report. It cannot, however, be used in a report’s FIELDS and SORTBY statements; use fields DSSTAT and DSTATX instead. For more information, see the CTTRPT utility in the INCONTROL for z/OS Utilities Guide.

b This field has a special meaning when used in the FIELDS and SORTBY statements of a report. For more information, see the CTTRPT utility in the INCONTROL for z/OS Utilities Guide.

Volume record tableLink copied to clipboard

The following table describes the fields of volume records:

Table 303 Keywords Used With Volume Type Records

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

ACTIVEDS

integer

Number of active datasets

DVLACTD#

BOXID

char (6)

Box ID

DVLBOXID

CHKINDT

date

Check-in date

DVLFCDT

CLNCOUNT

integer

Volume’s Clean Count

DVLCLN#

DVLRBA

hex (8)

RBA of the record

DVLRBA

EXPDSNUM

integer

Expiration dataset number

DVLEXPDS

EXPRTRN

date

Expected return date from out location

DVLRTRN

FIRSTVOL

char (6)

First volser for multi-volume chains

DVLFIRST

IOERPRM

integer

Read permanent errors count

DVLRPER

IOERPRMC

integer

Read permanent errors count since last clean

DVLRPERC

IOERTMP

integer

Read temporary errors count

DVLRTER

IOERTMPC

integer

Read temporary errors count since last clean

DVLRTERC

IOEWPRM

integer

Write permanent errors count

DVLWPER

IOEWPRMC

integer

Write permanent errors count since last clean

DVLWPERC

IOEWTMP

integer

Write temporary errors count

DVLWTER

IOEWTMPC

integer

Write temporary errors count since last clean

DVLWTERC

LACCDT

date

Date of last volume access

DVLADT

LACCJBN

char (8)

Name of last job that accessed the volume

DVLJBN

LACCTM

time

Time of last volume access

DVLATM

LBLNUM

integer

Last label number on the volume

DVLLBLNM

LBLTYP

SL, NL, NSL, SUL, AL, AUL, BLP

Label type

DVLLTYP

LCLNDT

date

Last clean date

DVLCLN

LDSCSIZE

integer

Compressed size in kilobytes of the last dataset on the volume

DVLLDCSZ

LDSPOS

hex (4)

Block ID of the last dataset starting on this tape

DVLPOSLD

LDSPOSLB

integer

Label number for LDSPOS (above)

DVLPOSLB

LIBRARY

char (8)

LIBRARY NAME (ATL LIBRARY)

DVLLIBR

LOCATION

char (8)

Current location of the volume

DVLCODE

LOCSEQ

integer

Vault sequence number

DVLVTSQ

MEDIA

char (8)

Volume’s media type

DVLMEDIA

MOVEDATE

date

Last move date

DVLMVDT

NEXTVOL

char (6)

Next volser for multi-volume chains

DVLNEXT

PHYSVLSR

char(6)

VTS physical volser

DVLPHYVL

PREVVOL

char (6)

Previous volser for multi-volume chains

DVLPREV

RECVLNUM

integer

Vault number (in pattern) from which the volume recalled

DVLVLTI

RETVLTDT

date

Return to vault date

DVLVRTRN

SCRDT

date

Last volume scratch date

DVLSCRDT

SLNAME

char (6)

Volume’s SL-NAME

DVLSLNAME

SLOTNUM

integer

Vault slot number

DVLVSLOT

SMSSG

char (8)

DFSMS Storage Group

DVLSMSSG

UNITGNAM

char (8)

Generic unit name

DVLUGNAM

USERDATA

char (20)

User data

DVLUSER2

VAULT

char (8)

First vault name in vault vaulting pattern information

DVLVLTNM

VAULT2

char (8)

Second vault name in vault vaulting pattern information

—

VAULT3

char (8)

Third vault name in vault vaulting pattern information

—

VCHANGED

date

Last change date

DVLMDT

VCHANGET

time

Last change time

DVLMTM

VCHANGEU

char (8)

Last user ID that changed the entry

DVLUSER

VENDOR

char (8)

Name of vendor who manufactured the volume

DVLVNDOR

VFREE

integer

Available kilobytes on the volume

DVLFREE

VLT2EXPD

date/integer

Second vault expiration in the vaulting pattern

—

VLT3EXPD

date/integer

Third vault expiration in the vaulting pattern

—

VLTDSNUM

integer

Vaulting dataset number

DVLVLTDS

VLTENTDT

date

Entry date to the vault

DVLVENDT

VLTENTNM

integer

Number of vault entries for the volume

DVLVLTT

VLTEXPDT

date/integer

Vault expiration date, number of cycles or number of days in the first vaulting pattern

DVLVXPD1

VLTEXTYP

 

VCYC

VDATE

 

VLACC

 

VCAT

VPERM

VEXP

VOLEXP

VDAYS

Vault expiration type:

Number of cycles

Actual date (in yyyymmdd format)

Number of days since last access

MVS Catalog Control

Permanent

Until dataset expiration

Until volume expiration

Number of days in vault

DVLVXPT1

VLTPREFL

integer

Vaulting dataset name prefix length

DVLPRFLN

VLTVEXP

integer

Vaulting pattern sequence number of the volume that holds the expiration type "VOL EXPIRE".

DVLVEXP#

VOLEDMID

char (4)

EDM-ID for EDM controlled volumes:

HSM - DFSMShsm

ADSM - ADSM

HPDM - ExHPDM

DVLEDMID

VOLEXCP

integer

EXCP count since last scratched

DVLEXCP#

VOLEXPDT

date

Expiration date

DVLEXPD

VOLEXPTY

DATE, PERM, UNKNOWN

Expiration date type

DVLEXPT

VOLFLAGSa

 

 

RETURNVL

DYNDEF

MANUPDAT

 

VLRSTRT

 

EXTDEL

 

MANVLT

 

SNGLVOL

INATL

Additional volume status flags:

Volume returned from vault

Volume dynamically defined

Volume manually updated (Online/Utility CTTMUP)

Volume processed under MVS RESTART

Volume is deleted when expired

Volume manually moved to vault

Single volume (out of multi-volume group) in VAULT/RECALL

Volume resides in an automated tape library

DVLFLG1

VOLFLAG2a

 

VLTBYBOX

 

EXPORT

WORM

Additional status flags:

Volume can be vaulted by boxes

Volume exported from VTS

WORM volume

DVLFLG2

VOLINDa

 

 

PVLT

PENDVLT

RECALL

HOLD

NOSTACK


INUSE

Additional volume status indications:

Potential vault

Pending vault

Recalled back from a vault

Hold before return to vault

Stacked datasets not accepted
Volume is in-use

DVLSTA2

VOLODESC

char (20)

Volume’s description

DVLDESC

VOLOWNER

char (8)

Volume’s owner

DVLOWNR

VOLSEQ

integer

Volume sequence number

DVLVSEQ

VOLSER

char (6)

Volume serial number

DVLVOLSR

VOLSTATb

 

ACTIVE

SCRATCH

PENDSCR

OUT

 

VAULTED

EXTERNAL

EDM

DELETED

Status of volume:

Active

Scratch

Pending scratch

Out of library (but not vaulted)

Vaulted

External volume

EDM controlled volume

Deleted volume

DVLSTAT

VOLTYPE

 

PHYSICAL
LOGICAL

Volume types:

Physical

Logical

DVLTYPE

VOLUSECT

integer

Volume usage count from last scratch

DVLUSED#

VOLUSETC

integer

Volume usage count from date of entry to the library

DVLUSET#

VRFORMAT

Tape recording format of the data on the volume

DVLRFMT

BPI200

200 bits per inch

  

BPI556

556 bits per inch

  

BPI800

800 bits per inch

  

BPI1600

1600 bits per inch

  

BPI6250

1625 bits per inch

  

TRACK18

18 tracks

  

TRACK36

36 tracks

  

TRACK128

128 tracks

  

TRACK256

256 tracks

  

TRACK384

384 tracks

  

EFMT1

Enterprise Recording Format 1

  

VSTKGRP

char (8)

Volume Stacking Group

DVLSTKG

VTRTCH

COMP
NOCOMP

Indicates whether data is compressed (for example, IDRC)

DVLTRTCH

VUSED

integer

Kilobytes used on the volume

DVLUSED

WORMWWID

hex (24)

WORM World Wide ID

DVLWWID

WORMWMC

integer

WORM Write Mount Count

DVLWMC

a This field can be used normally in INCLUDE/EXCLUDE statements of a report. It cannot, however, be used in a report’s FIELDS and SORTBY statements; use fields DSSTAT and DSTATX instead. For more information, see the CTTRPT utility in the INCONTROL for z/OS Utilities Guide.

b This field has a special meaning when used in the FIELDS and SORTBY statements of a report. For more information, see the CTTRPT utility in the INCONTROL for z/OS Utilities Guide.

Stacking record tablesLink copied to clipboard

The following table describes stacking records:

Table 304 Keywords Used with Stacking Type Records

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

AVGSIZE

integer

Average dataset size in kilobytes (compressed)

STKAVCSZ

AVGSIZEU

integer

Average dataset size in kilobytes (uncompressed)

STKAVUSZ

DATEUPD

date

Last update date of the stacking record

STKSTAMP

RFORMAT

Dataset recording format

STKRFMT

  
 

BPI200

200 bits per inch

  
 

BPI556

556 bits per inch

  
 

BPI800

800 bits per inch

  
 

BPI1600

1600 bits per inch

  
 

BPI6250

1625 bits per inch

  
 

TRACK18

18 tracks

  
 

TRACK36

36 tracks

  
 

TRACK128

128 tracks

  
 

TRACK256

256 tracks

  
 

TRACK384

384 tracks

  
 

EFMT1

Enterprise Recording Format 1

  

DSNAME

char (44)

Dataset name

STKDSN

JOBNAME

char (8)

Job name

STKJBN

LIFEOBS

integer

Total number of observations of the dataset (including observations not used to calculate dataset statistics)

This field is relevant only for datasets with nonspecific retention (for example, CATALOG or LAST ACCESS)

STKLSOBS

LIFESPAN

integer

Average life span of the dataset in days

This field is relevant only for datasets with non‑specific retention (for example, CATALOG or LAST ACCESS)

STKLSPAN

MAXSIZE

integer

Maximum dataset size in kilobytes (compressed)

STKMAXCS

MINSIZE

integer

Minimum dataset size in kilobytes (compressed)

STKMINCS

OBSERVE

integer

Number of observations of the dataset that were used to determine dataset statistics

STKOBS

PREDICTD

integer

Predicted dataset size in kilobytes (compressed)

STKPREDC

PREDICTU

integer

Predicted dataset size in kilobytes (uncompressed)

STKPREDU

STATUS

STK

NOSTK

Indication whether the dataset can be stacked

STKFLAG1

STDDEV

integer

Standard deviation (in kilobytes) of dataset size for all observations

STKSTDEV

TOTSIZQ

integer

Square of accumulated length of all dataset observations in kilobytes

STKTOTSQ

TIMEUPD

time

Last update time of the stacking record

STKSTAMP+4

UNIT

char (8)

Generic unit name

STKUNAM

Trace record tablesLink copied to clipboard

The following table describes trace type records, and the table that follows it describes trace data records:

Table 305 Keywords Used With Trace Type Records

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

CPUID

char (4)

CPU-ID

ARCCPUID

DATE

date

Date

ARCDATE

DSVOLSER

char(6)

Volser of the data set (or the first volser of a multi-volume data set)

DDSVOLSR

DSLABEL

integer

Label number (data set sequence number on the tape)

DDSLBLNM

ENV

DLD5

EDM

MUP

ONL

ONLC

RTM

STK

SVCT

UTL

VTM

$RCV

CTTDLD utility

External Data Manager

Manual update utility (CTTMUP)

Online facility

External Volume Check-In (TC Screen)

Retention management utility (CTTRTM).

Dynamic Stacking Facility

Real-time environment

Volume expiration utility

Vault management utility (CTTVTM)

Utility CTTRCV Recover Media Database using Trace file

ARCIDENT

FUNCTION

ADD, DELETE, CHANGE

Activity type

ARCTYPE

When they appear in output, ADD, DELETE, and CHANGE are represented by the following Trace file records:

  • The ADD value is represented by REC–ADD.

  • The DELETE value is represented by REC–DEL.

  • The CHANGE value is represented by the following two records: REC–OLD (the state of the record before the change) and REC–NEW (the state of the record after the change)

JOBID

char (8)

Job ID (format depends on JES definitions; either JOBn..n, where n..n is the job number containing 5 digits or Jn..n, where n..n is the job number containing 7 digits)

ARCJOBID

TIME

time

Time

ARCTIME

JOBNAME

char (8)

User ID/Job name

ARCUSRID

Table 306 Keywords Used With Trace Data

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

RECTYPE

V, D

MDB Record Type

DVLRTYPE, DDSRTYPE

VOLSER

char (6)

Volume serial number

DVLVOLSR

DSNAME

char (44)

Dataset name

DDSDSN

RBA

hex (8)

Record’s RBA

DVLRBA, DDSRBA

SMF record tableLink copied to clipboard

The following table describes SMF records processed by the CTTSCA utility:

Table 307 Keywords for Selecting SMF Records to be Processed by Utility CTTSCA

EXTERNAL NAME

VALID VALUES

DESCRIPTION

INTERNAL NAME

CPUID

char (4)

CPU ID

SCACPUID

JOBNAME

char (8)

Job name

SCAJBNAM

DSNAME

char (44)

Dataset name

SCADSNAM

DATE

date

Dataset creation date

SCADATE

TIME

time

Dataset creation time

SCATIME