The CBDZUDT macro defines one entry in the UDT.

The syntax of the CBDZUDT macro is as follows:

  CBDZUDT   UDT=name,UIM=name,DESC='text'[,LANG=name]
    or
  CBDZUDT   UNIT='description'[,HELP=name]
    or
  CBDZUDT   FEAT=feature,TEXT='description'[,HELP=name]
    or
  CBDZUDT   CFEAT={feature|(feature,feature[,feature]...  .)}
    or
  CBDZUDT   PARA=(parameter[,nn]),TEXT='description'
                   [,PARATYPE=(type[,length])][,HELP=name]
    or
  CBDZUDT   MID='CBDBnnnI',TEXT='description'[,HELP=name][,ID=parameter]
    or
  CBDZUDT   DEVICE=unit[,MODEL=model],HELP=name,TYPE=type,ID=parameter

UDT

Specifies the eight-character name of the UDT. Follow the naming convention as described in How to Write a UDT.

UIM

Specifies the eight-character name of the UIM associated with this UDT.

DESC

Specifies the description of the UIM. Enter no more than 60 characters.

LANG

Specifies a one-character code for the language supported by the UDT. Currently, a UDT can have one of the following language codes:

• E (English)
• J (Japanese)

UNIT

Specifies the description of the unit (device). Enclose the description in apostrophes. Enter no more than 60 characters.

HELP

Specifies the name of the help panel associated with this feature, parameter, message, or unit (device associated with this UDT).

FEAT

Specifies the name of the feature supported by the device associated with the UDT. Enter no more than 10 characters. (Entering “*” creates a place holder for FEAT in this UDT.) The order of features must be the same as in the UIM and UIP.

TEXT

Specifies the feature, parameter, or message text. You must code this parameter if you also code FEAT, PARA, or MID. You must enclose the text in apostrophes. For FEAT and PARA, enter no more than 44 text characters. For MID, enter no more than 120 text characters.

CFEAT

Specifies the name of one or more obsolete, but compatible, features supported by the device associated with the UDT. If you specify two or more compatible features, enclose them in parentheses. Enter no more than 10 characters per feature name.

PARA

Specifies the common or private parameter, “parameter(,nn),” where “parameter” is the parameter name and “nn” is the private parameter identifier, a decimal number from 33 through 64.

Note:

You may use the same private parameter identifiers in each of many UIMs, because UIMs do not share private parameters.

Valid required and optional common parameter names are:

• ADAPTER
• DYNAMIC
• LOCANY
• NUMSECT
• OFFLINE
• OWNER
• PCU
• SETADDR
• TCU

For migration, additional valid common parameter names are:

• ADDRESS
• FEATURE
• MODEL
• UNIT

Private parameter names cannot exceed eight characters.

PARATYPE

Specifies the type of private parameter. (You cannot use PARATYPE with any common parameter.) You must specify PARATYPE as follows:

PARATYPE=(type[,length][,LIST,count][,RANGE,first,last])

TYPE

“type” can be one of the following:

NUM

Parameter value must be numeric (0-9)

HEX

Parameter value must be hexadecimal (0-9,A-F)

ALPHANUM

Parameter value must be alphanumeric

ALPHANUM*

Parameter value must be alphanumeric or *

CHAR

Parameter value can contain any characters

YESNO

Parameter value must be either YES or NO

NAME

Parameter value must be a name

NAME*

Parameter value must be a name or *

length

Maximum length allowed for the value on the HCD panel.

LIST

To specify more than one value for parameter.

count

Maximum number of values.

RANGE

To specify a subrange.

first

Minimum value of range.

last

Maximum value of range.

Examples:

  CBDZUDT   PARA=CLASS,TEXT='Printer output spooling class',
            PARATYPE=(ALPHANUM*,4,LIST,8),HELP=CBDEH13

  CBDZUDT   PARA=CLASS,TEXT='Size of delayed purge queue',
            PARATYPE=(NUM,1,RANGE,1,9)

MID

Specifies the message identifier, “CBDBnnnI,” where “nnn” is a decimal number from 500 through 999.

Note:

Because many languages have different noun and verb relationships, message variables are numbered instead of sequenced. Specify a message variable by including an @n in the message text, where “n” is a number from 1 to 9.

This is a message text example: “Number of units must be @1 for the @2 device.”

ID

Specifies the parameter associated with the message or help panel.

If ID is associated with a message, it specifies the parameter associated with that message.

If ID is associated with a help panel overwrite table (HPOT), it specifies the parameter associated with that help panel, and the CBDZUDT macro also uses the TYPE parameter to specify the type of help. For TYPE=SPECIAL, the ID parameter must specify one of the following:

DEVNUM

Specifies device number help for the device defined through DEVICE and MODEL parameters.

DEVRANGE

Specifies device range (number of devices) help for the device defined through DEVICE and MODEL parameters.

DEVTYPE

Specifies device type help.

DEVUA

Specifies unit address help.

DEVICE

Specifies the name of the device (unit) for which the default help panel name should be overwritten by the name specified in the HELP parameter. This help panel overwrite table (HPOT) allows you to provide device-specific help for a parameter. (See HCD Help Support.)

MODEL

Specifies the model number (optional) of the unit (device).

TYPE

Specifies the type of help:

PARA

Specifies parameter help. The ID parameter specifies which parameter is associated with this help.

FEAT

Specifies feature help. The ID parameter specifies which feature number is associated with this help.

SPECIAL

Specifies special help. The ID parameter specifies what special help is associated with this help:

DEVNUM

Specifies device number help for the device defined through DEVICE and MODEL parameters.

DEVRANGE

Specifies device range (number of devices) help for the device defined through DEVICE and MODEL parameters.

DEVTYPE

Specifies device type help.

DEVUA

Specifies unit address help.

Figure 5 shows the UDT for a channel to channel (CTC) device. Also, see the sample UDT in SYS1.SAMPLIB(CBDSUDT).

CBDZUDT UDT=CBDES014,UIM=CBDUS014,
      DESC='UIM for CTC Devices'
CBDZUDT
      UNIT='Channel-to-channel Adapter'
CBDZUDT
      UNIT='Multisystem Channel Communication Unit'
CBDZUDT
      UNIT='Serial Channel-to-channel Adapter'
CBDZUDT
      UNIT='Remote Channel-to-channel Unit'
CBDZUDT
      UNIT='Basic Mode ESCON Channel-to-channel Adapter'
CBDZUDT PARA=OFFLINE,
      TEXT='Device considered online or offline at IPL',
      HELP=CBDFP08
CBDZUDT PARA=DYNAMIC,
      TEXT='Device has been defined to be dynamic',
      HELP=CBDFP12
CBDZUDT PARA=LOCANY,
      TEXT='UCB can reside in 31 bit storage',
      HELP=CBDFP15
CBDZUDT FEAT=370,
      TEXT='Attached to System/370',
      HELP=CBDEB01
CBDZUDT DEVICE=3088,
      TYPE=SPECIAL,
      ID=DEVRANGE,
      HELP=CBDEB02
END