Typeterm definition attributes

The typeterm definition attribute descriptions are:

Altpage
specifies the page size to be used by BMS for this terminal entry when the alternate screen size is specified in a profile definition (PROFDEF). The default is the PAGESIZE. The values for both rows and columns must be in the range 0 through 999. The product of rows and columns must not exceed 32767. If you leave these fields blank, CICSPlex® SM uses the default values for your CICS® environment, if there are any.
AltScreen
specifies the 3270 screen size to be used for a transaction that has an alternate screen size specified in its profile definition. The row and column values must each be in the range 0 through 999. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
Altsuffix
A 1-character numeric suffix that BMS is to append to map set names.
blank
Leave this attribute blank if you do not want a suffixed map set.
number
BMS appends this suffix to map set names if the screen size being used is the same value as the alternate screen size; that is, if the transaction has an alternate screen size specified in the PROFILE definition, or if the default and alternate screen size are the same.
Aplkybd
specifies whether the 3270 device has the APL keyboard feature:
YES
The 3270 device has the APL keyboard feature.
NO
The 3270 device does not have the APL keyboard feature.
Apltext
specifies whether the 3270 device has the APL text feature:
YES
The 3270 device has the APL text feature.
NO
The 3270 device does not have the APL text feature.
Ascii
specifies whether the terminal has an ASCII feature.
NO
This terminal does not have an ASCII feature.
7
Specify this to communicate with ASCII-7 terminals.
8
Specify this to communicate with ASCII-8 terminals.
If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.
Ati
specifies whether transactions can start at the terminal by automatic transaction initiation:
YES
Transactions can start at the terminal by automatic transaction initiation.
NO
Transactions cannot start at the terminal by automatic transaction initiation.
Audiblealarm
specifies whether the audible alarm feature is installed for a 3270 display or for a 3270 printer attached to a 3651 controller:
YES
The audible alarm feature is installed.
NO
The audible alarm feature is not installed.
Autoconnect
specifies whether autoconnect processing is to occur for the terminal.
NO
CICS does not attempt to bind sessions when the connection is established.
YES
CICS attempts to bind as a contention winner session, when the connection is established.
Autopage
specifies whether BMS autopaging is to be used. Specify YES for printers and NO for display devices.
Backtrans
specifies whether the device has the background transparency feature:
NO
The device does not have the background transparency feature.
YES
The device does have the background transparency feature.
Bracket
specifies whether bracket protocol is to be enforced for this logical unit.
YES
Bracket protocol is to be used.
NO
Bracket protocol is not to be used.
Buildchain
specifies whether CICS is to perform chain assembly prior to passing the input data to the application program.

NO
Any terminal input/output area (TIOA) received by an application program from this logical unit contains one request unit (RU).
YES
Any TIOA received by an application program from this logical unit contains a complete chain.
Cgcsgid
Specify a coded graphic character set global identifier (CGCSGID), in the range 0 through 655335.

If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

Color
specifies whether the 3270 device or the SCS printer has the extended color feature, which allows colors to be selected for each field or character:
NO
The device does not have the extended color feature.
YES
The device has the extended color feature.
Copy
specifies whether the copy feature for a 3270 display or printer is included in the 3270 control unit:
NO
The copy feature is included.
YES
The copy feature is not included.
Createsess
specifies whether sessions are to be created.
NO
Specify this to prevent internally generated session requests from actually creating a session.
YES
Specify this for a status that allows internally generated session requests to create a session.
DefScreen
specifies the 3270 screen size or 3270 printer page size to be used on this device when attached to a transaction for which the default screen size has been specified in the profile definition. The row and column values must each be in the range 0 through 999. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
Description
(Optional.) Specifies a 1- to 30-character description of the resource.
Device
specifies the device type which this TYPETERM defines.
Discreq
specifies whether disconnect requests are to be honored.
YES
CICS is to honor a disconnect request for a VTAM device.
NO
CICS is not to honor a disconnect request for a VTAM device.
Dualcasekybd
specifies whether a 3270 display has a typewriter keyboard or an operator console keyboard. Both uppercase and lowercase data can be transmitted with either of these keyboards
NO
The device does not have a dual-case keyboard.
YES
The device has a dual-case keyboard.
Errcolor
specifies whether the error message is to be displayed in color.

The colors you can specify are:

      BLUE
      RED
      PINK
      GREEN
      TURQUOISE
      YELLOW
      NEUTRAL
Errhilight
specifies the highlighting, if any, with which error messages are to be displayed. The forms of highlighting you can specify are:
Errintensify
specifies whether the error message is to be displayed in an intensified field.
Errlastline
specifies where error messages are to be displayed.
NO
An error message is displayed at the current cursor position and without any additional attributes.
YES
An error message is displayed starting at the beginning of the line nearest the bottom of the screen so that the whole message fits on the screen.

Because all error messages occupy the same line, if the messages are received in quick succession, they overlay one another and earlier messages may disappear before they have been read.

Extendedds
specifies whether the 3270 device or the SCS printer supports extensions to the 3270 data stream:
NO
The device does not support 3270 data stream extensions.
YES
The device supports 3270 data stream extensions.
FMHparm
specifies whether BMS is to accept user-supplied parameters for inclusion in the function management header built by BMS:
NO
Do not accept user-supplied parameters for inclusion in the function management header built by BMS.
YES
Accept user-supplied parameters for inclusion in the function management header built by BMS.
Formfeed
specifies whether or not the device has the forms feed feature, which means that BMS uses the form-feed character when formatting output documents:
NO
The device does not have the form feed feature.
YES
The device has the form feed feature.
Hilight
specifies whether the 3270 device or SCS printer has the extended highlight facility, which enables fields or characters to be displayed in reverse-video, underline mode, or blink (3270 only):
NO
The device does not have the extended highlight facility.
YES
The device has the extended highlight facility.
Horizform
specifies whether or not the device has the horizontal form feature, which means that BMS should use the horizontal tabbing when formatting output documents:
NO
The device does not have the horizontal form feature.
YES
The device has the horizontal form feature.
NO
The HTAB option in the BMS map definition is ignored.
YES
BMS uses horizontal tabbing when formatting output documents.
Ioarealen
specifies the length in bytes of a terminal input/output area to be passed to a transaction.

If you specify ATI(YES), you must specify an IOAREALEN of at least one byte.

value1
Value1 specifies the minimum size of a terminal input/output area to be passed to an application program when a RECEIVE command is issued.
value2
You can specify value2 as greater than or equal to value1. In this case, when the size of an input message exceeds value1, CICS uses a terminal input/output area value2 bytes long. If the input message size also exceeds value2, the node abnormal condition program sends an exception response to the terminal.

If value2 is not specified, or is less than value1, it defaults to the value of value1.

The maximum value that may be specified for IOAREALEN is 32767 bytes. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.

Katakana
specifies whether Katakana support is required. Katakana terminals cannot display mixed case output; uppercase characters appear as uppercase English characters, but lowercase characters appear as Katakana characters.
NO
Katakana support is not required.
YES
Katakana support is required.
LDClist
Lightpen
specifies whether a 3270 display has the selector pen feature:
NO
The 3270 display does not have the selector pen feature.
YES
The 3270 display has the selector pen feature.
Logmode
specifies how CICS is to build the BIND to be sent to the logical unit.
blank
A defined terminal definition uses the BIND image generated by the CICS definitions for this device by means of this TYPETERM definition and its associated terminal definitions.
name
This is the LOGMODE name from a VTAM logon mode table that has been set up for use by this logical unit. The name may be up to eight characters in length.
0 (zero)
This causes CICS to use some of the information from the BIND image contained in the CINIT coming from the logical unit.
Logonmsg
specifies whether the ‘good morning’ transaction, specified in the GMTRAN system initialization parameter, will be: If you have specified ERRLASTLINE(YES), the messages written by the transaction do not overwrite the error message line.
Msrcontrol
specifies whether the terminal, an 8775 or 3643, has a magnetic slot reader.
Name
Specify a 1- to 8-character name for the typeterm definition.
Nepclass
specifies the node error program transaction class.
0
This results in a link to the default node error program module.
value
The transaction class for the (nondefault) node error program module. Value can be in the range 1 through 255. For programming information about the node error program, see the CICS Customization Guide.
Obformat
specifies whether outboard formatting is used. Obformat can be specified for two device types only:
OBoperid
specifies whether CICS uses the outboard operator identifiers to support the BMS routing facilities required for this terminal. This option applies only to the 3790 and 3770 batch data interchange logical units.
NO
CICS does not use the outboard operator identifiers.
YES
CICS uses the outboard operator identifiers.
Outline
specifies whether the device supports field outlining:
NO
The device does not support field outlining.
YES
The device supports field outlining.
Pagesize
specifies the default page size for this printer. The default page size is used by BMS when the default screen size has been specified in a profile definition (PROFDEF)..

The product of rows and columns must not exceed 32767.

If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.

Partitions
specifies whether a device is to use partitions. This option is not valid for SCS printers.
NO
The device is not to use partitions.
YES
The device is to use partitions.
Printadapter
For the 3275: specifies whether the printer adapter feature and corresponding 3284 Printer Model 3 are present on the 3275 Display Station.
NO
The printer adapter feature and corresponding 3284 Printer Model 3 are not available.
YES
The printer adapter feature and corresponding 3284 Printer Model 3 are available.

For LUTYPE2 logical units: specifies whether, for print requests initiated by the PRINT key or by an ISSUE PRINT command, printer allocation is handled by the 3790, or by the 3274 or 3276, according to the printer authorization matrix for both VTAM and non-VTAM attachments.

NO
Print requests are not handled according to the printer authorization matrix for both VTAM and non-VTAM attachments.
YES
Print requests are handled according to the printer authorization matrix for both VTAM and non-VTAM attachments.
Progsymbols
specifies whether the programmed symbol (PS) facility can be used on this 3270 device or SCS printer.
NO
Programmed symbol (PS) facility cannot be used.
YES
Programmed symbol (PS) facility can be used.
Query
specifies whether CICS should use the QUERY structured field to determine the characteristics of the device.
NO
CICS does not use the QUERY function.
COLD
CICS uses the QUERY function to determine the characteristics of the device only when the device is first connected after an initial or a cold start of CICS. The device characteristics are stored in the CICS global catalog for use on subsequent warm and emergency starts.
ALL
CICS uses the QUERY function to determine the characteristics of the device each time the device is connected.
Receivesize
Specify the maximum size of a request unit that can satisfy a VTAM RECEIVE request. The RECEIVESIZE value is transmitted to the connected logical unit, and must be in the range 0 through 30720. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
Recnotify
Specify how a terminal user should be notified of a system restart (in the case of VTAM persistent sessions support) or an XRF takeover:
NONE
No notification is given.
MSG
A message is sent to the terminal screen.
TRAN
A transaction is initiated at the terminal.
Recovoption
This option applies to the recovery of sessions in a CICS region running with VTAM persistent sessions, or with XRF.

SYSDEFAULT
VTAM persistent sessions: In a CICS region running with persistent sessions support, this specifies that CICS is to select the optimum procedure to recover a session on system restart within the persistent session delay interval, depending on the session activity and on the characteristics of the terminal.

XRF: In a CICS region running with XRF support, this specifies that CICS is to select the optimum procedure to recover a busy session at takeover, depending on the session activity and on the characteristics of the terminal.

CLEARCONV
Prevents CICS from sending an end-bracket indicator to close an in-bracket session. Instead CICS sends a CLEAR request, to reset the conversation states. If the session does not support the CLEAR request, CICS sends an UNBIND request. The CLEAR or UNBIND is sent only if the session was busy at the time of system restart (in the case of persistent sessions) or takeover (in the case of XRF).
RELEASESESS
Requires CICS to send an UNBIND request to release the active session. The UNBIND is sent only if the session was busy at the time of system restart (in the case of persistent sessions), or takeover (in the case of XRF).
UNCONDREL
Requires CICS to send an UNBIND request to release the active session. The UNBIND is sent whether or not the session was busy at the time of system restart (in the case of persistent sessions support) or the takeover (in the case of XRF).
NONE
VTAM persistent sessions: In a CICS region running with persistent sessions support, this specifies that the terminal session is not to be recovered at system restart within the persistent session delay interval: in effect, the terminal has no persistent sessions support.
Relreq
specifies whether CICS is to release the logical unit upon request by another VTAM application program.
NO
CICS is not to release the logical unit.
YES
CICS is to release the logical unit, if the logical unit is not currently part of a transaction.
RESGROUP
(Optional.) Specify the name of an existing resource group to which the definition is to be automatically added.
Routedmsgs
specifies which messages are to be routed to this terminal by an EXEC CICS ROUTE command.
ALL
BMS routes to this terminal messages that are destined for all terminals as well as those specifically destined for this terminal.
NONE
BMS does not route any messages to this terminal, whether they are destined for all terminals or for this terminal specifically.
SPECIFIC
BMS routes messages to this terminal when they are destined specifically for this terminal, but not when they are destined for all terminals.
Rstsignoff
specifies the sign-on characteristics of a group of terminals in the event of a persistent sessions restart or an XRF takeover. It supersedes the XRFSIGNOFF attribute, which is obsolete.

If you have a collection of terminals in a security-sensitive area, for example, you might choose to force sign off of those terminals after a persistent sessions restart or an XRF takeover, to prevent the use of the terminal in the absence of the authorized user. (This could happen if the authorized user left the terminal during the restart or takeover, and the terminal became active again while it was unattended.)

This option works in conjunction with the RSTSIGNOFF system initialization parameter and the XRFSOFF entry in the CICS segment of the RACF® user profile.

FORCE
This group of terminals will be signed off after a persistent sessions restart or XRF takeover.
NOFORCE
This group of terminals will be signed on after a persistent sessions restart or XRF takeover, provided that both the RSTSIGNOFF system initialization parameter and the XRFSOFF entry in the CICS segment of the RACF user profile are also set to NOFORCE.
Sendsize
Specify the maximum size of a request unit that can satisfy a VTAM SEND request, in the range 0 through 30720. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.
SessionType
specifies the type of session that can be used for a VTAM SNA logical unit.
Shippable
specifies whether the definition is allowed to be sent to a remote system if this device tries to initiate a remote transaction.
NO
This definition cannot be shipped to a remote system.
YES
This definition can be shipped to a remote system.
Signoff
specifies whether the terminal should be timed out automatically.
YES
When the specified time has elapsed after the last input from the operator, the terminal is automatically signed off from CICS.
NO
The terminal is not timed out.
LOGOFF
When the specified time has elapsed after the last input from the operator, the terminal is automatically signed off from CICS and then logged off from VTAM.
Sosi
specifies whether the device supports mixed EBCDIC and double-byte character set (DBCS) fields.
NO
The device supports mixed EBCDIC and double-byte character set (DBCS) fields.
YES
The device supports mixed EBCDIC and double-byte character set (DBCS) fields.
Termmodel
specifies the model number of the terminal. If the device is a component of the 3270 Information Display System, specify the model number of the terminal:
1
Specify 1 for the 3270 Model 1 displays and printers (for example, 3277 Model 1) with a default screen or buffer size of 12x40 (480 bytes/characters). TERMMODEL(1) is the default for 3270 Model 1 printers and displays.

Specify 1 for the 3275 Display Station Model 11. The CICS support obtained is identical to that obtained by coding TERMMODEL(1) for 3275 Display Station Model 1.

2
Specify 2 for the 3270 displays and printers (for example, 3278 Model 4) with a default screen or buffer size of 24x80 (1920 bytes/characters). TERMMODEL(2) is the default for the 3286 printer in 3270 compatibility mode.

Specify 2 for the 3275 Display Station Model 12. The CICS support obtained is identical to that obtained by coding TERMMODEL(2) for 3275 Display Station Model 2.

If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.
Textkybd
specifies whether the 3270 device has the text-keyboard feature.
NO
The 3270 device does not have the text-keyboard feature.
YES
The 3270 device has the text-keyboard feature.
Textprint
specifies whether the 3288 printer has the text-print feature.
NO
The 3288 printer doe not have the text-print feature.
YES
The 3288 printer has the text-print feature.
Tti
specifies whether transactions can be initiated at the terminal by a user.
Uctran
specifies whether the input data stream from a terminal is to be translated to uppercase.
NO
No uppercase translation is performed.
YES
All the data input from the terminal, both the transaction identifier if present and the program data, is translated to uppercase before any processing.
TRANID
When the input data stream includes a transaction identifier, CICS translates it to uppercase before attempting to locate its definition. However, all the input data, both the transaction identifier and the program data, is passed to the program without any translation.
Userarealen
specifies the length in bytes (0 to 255) of the user area for this terminal. If you leave this field blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
User data
(Optional.) Three 8-character fields provided for any site-specific data related to the typeterm. CICSPlex SM makes no use of this user data.
Validation
specifies whether or not an 8775 or 3290 device the extended validation feature:
NO
The device does not have the extended validation feature.
YES
The device has the extended validation feature.
specifies whether the 8775 device has the extended validation feature, which allows fields to be defined as TRIGGER, MANDATORY FILL, or MANDATORY ENTER.
Version
(Optional.) Specify an integer in the range 1 through 15. Specify 0 or leave blank for CICSPlex SM to assign the first available version id in the range 1 through 15.
Vertical form
specifies whether the device has the vertical form feature.
NO
The device does not have the vertical form feature.
YES
The device has the vertical form feature.
Xrfsignoff
This attribute is obsolete, and superseded by the RSTSIGNOFF attribute. It is supported to provide compatibility with earlier releases of CICS.

You cannot specify both XRFSIGNOFF and RSTSIGNOFF; if you specify XRFSIGNOFF on CICS TS for z/OS®, Version 2.1 or earlier, you must specify RSTSIGNOFF on CICS TS for z/OS, Version 2.2 or later.

If you define a TYPETERM with this attribute, you can only install it on CICS TS for z/OS, Version 2.1 or an earlier version. See CICS Resource Definition Guide for more information.

Related concepts
Typeterm resource definitions
CICS Resource Definition Guide
Related tasks
Accessing BAS typeterm definitions
Working with the TYPTMDEF view
Defining typeterms using BAS
Installing BAS typeterm definitions
[[ Contents Previous Page | Next Page Index ]]