TERMINAL attributes

Describes the syntax and attributes of the TERMINAL resource.

APPC attributes

ALTPRINTCOPY({NO|YES})

Specifies whether the hardware COPY feature is to be used to satisfy a print request on the printer named in the ALTPRINTER attribute. For more details, see the PRINTERCOPY attribute.

NO: CICS® will use the hardware COPY feature.
YES: CICS will not use the hardware COPY feature.

ALTPRINTER(printer)

Specifies the name of a 3270 printer to be used, if the printer named in the PRINTER attribute of this terminal definition is not available. The name can be up to 4 characters in length. For more details, see the PRINTER attribute. If you specify an ALTPRINTER without specifying a PRINTER, ALTPRINTER is ignored.

The printer that you name must be owned by the CICS system that owns this terminal definition.

To specify the hardware COPY feature for the alternative printer, specify YES for ALTPRINTCOPY on this terminal definition.

ATTACHSEC({LOCAL|IDENTIFY|VERIFY| PERSISTENT|MIXIDPE}) (APPC only)

Specifies the level of attach time user security required for the connection. PERSISTENT and MIXIDPE are valid only with z/OS® Communications Server as the access method and when APPC is used.

LOCAL: The authority of the user is taken to be the authority of the link itself, and link security protects only the resource.
IDENTIFY: Incoming attach requests must specify a user identifier. Specify IDENTIFY when the connecting terminal has a security manager.
MIXIDPE: A connection can support attaches using either or both of the IDENTIFY and PERSISTENT security types. The security type used depends on the incoming attach.
As in previous releases, IDENTIFY implies a degree of trust between the two systems that allows this system to accept the sign-on logic of the other system. In effect, you have a distributed security manager, with one system performing the sign-on function and the other system performing the security check.
PERSISTENT: This option involves a user sign-on to a remote system that persists over multiple conversations until the user signs off from the remote system. In this way, the user ID and password are passed only on the first (sign-on) attach. Subsequent attach requests require only the user ID.
VERIFY: Incoming attach requests must specify a user identifier and a user password. Specify VERIFY when the connecting terminal has no security manager and therefore requires verification.

AUTINSTMODEL({NO|YES|ONLY})

Specifies whether this terminal definition can be used as a model terminal definition for autoinstall. For more information on autoinstall and model terminal definitions, see Autoinstalling VTAM terminals.

NO: This definition is not used as a model for autoinstall. It is used only as a definition for a specific device that is not autoinstalled.
ONLY: This definition is used only as a model for autoinstall. It is not used as a definition for a specific device.
YES: This definition is used for a specific device that is not autoinstalled. The definition is also used as a model for automatic installation.

AUTINSTNAME(autinstname)

Specifies the name by which this model definition is known in the autoinstall control program. The name can be up to 8 characters in length.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

You specify this name only if AUTINSTMODEL is YES or ONLY. You can default to the terminal name followed by four blanks, if this name is acceptable to the autoinstall control program. For more information about autoinstall models, autoinstall names, and the autoinstall control program, see Autoinstall control program.

BINDPASSWORD

This attribute is obsolete, but is supported to provide compatibility with earlier releases of CICS.

BINDSECURITY({NO|YES}) (APPC only)

Specifies whether an external security manager (ESM) is being used for bind-time security.

NO: No external bind-time security is required.
YES: If security is active and the XAPPC system initialization parameter is set to YES, CICS attempts to extract the session key from RACF® to carry out bind-time security. If no RACF profile is available, the bind fails.

CONSOLE

This attribute is obsolete, but is supported to provide compatibility with earlier releases of CICS.

CONSNAME(console)

Using CONSNAME, you can install a CICS console definition without having an existing console, and without the console being previously defined in the CONSOLnn member of the MVS™ SYS1.PARMLIB. However, before you can use the console, you must define the name to MVS, either in the CONSOLnn member of SYS1.PARMLIB or by dynamic allocation. The length of CONSNAME must be 2 - 8 characters and must begin with an alphabetic character or one of #, @, or $. It uniquely identifies the console device in a CICS region, regardless of the MVS image to which it is connected; that is, you cannot install two console definitions with the same CONSNAME. The CONSNAME corresponds to the name defined for the console in the MVS SYS1.PARMLIB member, CONSOLnn.

To define a TSO user as a console device, specify CONSNAME(name), where name is the TSO user ID. This definition enables a TSO user authorized to use the TSO CONSOLE command to initiate CICS transactions. The TSO user ID does not have to be defined in the CONSOLnn member of SYS1.PARMLIB member.

The equivalent of CONSOLE(00) is CONSNAME(INTERNAL) or CONSNAME(INSTREAM), depending on the service level of CICS and the release of MVS being used; specify this option if you want to initiate a CICS transaction and issue a command to it in a JCL statement. For guidance about using JCL to issue CICS commands, see Using JCL to initiate CICS commands.

DESCRIPTION(text)

You can provide a description of the resource that you are defining in this field. The description text can be up to 58 characters in length. There are no restrictions on the characters that you can use. However, if you use parentheses, ensure that for each left parenthesis there is a matching right parenthesis. If you use the CREATE command, for each single apostrophe in the text, code two apostrophes.

GROUP(groupname)

Every resource definition must have a GROUP name. The resource definition becomes a member of the group and is installed in the CICS system when the group is installed.

Acceptable characters: `A-Z 0-9 $ @ #` Any lowercase characters you enter are converted to uppercase.

The GROUP name can be up to eight characters in length. Lowercase characters are treated as uppercase characters.

INSERVICE({YES|NO})

Specifies the status of the terminal that is being defined.

YES: Transactions can be initiated and messages are automatically sent to the terminal.
NO: The terminal cannot receive messages or transmit input.

MODENAME(modename) (APPC single session terminals only)

Specifies the name that is passed to z/OS Communications Server as the LOGMODE name. The name can be up to 8 characters in length, but cannot have the reserved name SNASVCMG. The name follows assembler language rules and must start with an alphabetic character.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

For further guidance on the LOGMODE name, see Coding entries in the z/OS Communications Server LOGON mode table.

NATLANG(code)

Specifies the language in which all globalization-enabled messages are displayed for this terminal. Specify one of the following NATLANG codes. The default is the value specified in NATLANG system initialization parameter.

E: English, which is the system default (that is, is provided even if you do not specifically code E).
C: Simplified Chinese, a Double-Byte Character Set language. Translation is performed by IBM®.
K: Japanese, a Double-Byte Character Set language. Translation is performed by IBM.

NETNAME(netname)

Specifies the network name that identifies the terminal to ACF/Communications Server. The name can be up to 8 characters in length. The name follows assembler language rules and must start with an alphabetic character.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

If you do not specify a name, the NETNAME defaults to the TERMINAL name.

The NETNAME must be unique except in the case of a remote terminal. That is, you cannot install two local terminals with the same NETNAME, or a local terminal and any connection with the same NETNAME. However, the NETNAME for a remote terminal can be the same as the NETNAME for any other terminal or the NETNAME for any connection.

If the CICS region supports z/OS Communications Server dynamic LU alias; that is, LUAPFX=xx is specified on the CICS region APPL statement, the terminal with this NETNAME is assumed to be in the same network as the CICS region. If the terminal is in another network, it must be defined to z/OS Communications Server on a CDRSC definition with a predefined LUALIAS (LUALIAS=netname) to override z/OS Communications Server dynamic allocation. In this case, netname on the LUALIAS parameter must match the NETNAME defined on this terminal resource definition.

OPERID

OPERPRIORITY

OPERRSL

OPERSECURITY

These attributes are obsolete, but are supported to provide compatibility with earlier releases of CICS.

POOL(poolname)

Specifies the pool name for a 3600 or 3650 pipeline terminal pooled with other pipeline terminals.

When you define a 3600 pipeline logical unit, you generate a TCTTE that is associated with a pool of TCTTEs. A pool of pipeline TCTTEs can be used by one pipeline logical unit, or it can be shared by a number of pipeline logical units.

The pool name is used only as a method of identifying the related TERMINAL definitions on the CSD file. It is not used in the active CICS system. The name can be up to 8 characters in length.

Acceptable characters:

A-Z 0-9 $ @ #

Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

For a pipeline terminal, you must specify a TYPETERM with SESSIONTYPE(PIPELINE) specified. You must specify a TASKLIMIT on at least one of the pool of pipeline terminals. You must name the same group for each of the pipeline terminals in a pool.

Here is an example of the definitions for a pool of pipeline terminals:

DEFINE TERMINAL(ttt1) GROUP(g) POOL(poolid)
       TYPETERM(xxxxxxxx) NETNAME(nnnnnnn1)...
DEFINE TERMINAL(ttt2) GROUP(g) POOL(poolid)
       TYPETERM(xxxxxxxx) NETNAME(nnnnnnn2)...
DEFINE TERMINAL(ttt3) GROUP(g) POOL(poolid)
       TYPETERM(xxxxxxxx) NETNAME(nnnnnnn3)...
DEFINE TERMINAL(ttt4) GROUP(g) POOL(poolid)
       TASKLIMIT(nn) TYPETERM(xxxxxxxx)
       NETNAME(nnnnnnn4)...
DEFINE TYPETERM(xxxxxxxx) GROUP(g)
       DEVICE(3650) SESSIONTYPE(PIPELINE)

PRINTER(printer)

Specifies the name of the primary 3270 printer to be used to respond to an ISSUE PRINT command or a PRINT request from an operator pressing a program access (PA) key. The name can be up to 4 characters in length. The name is the TERMINAL name on the definition for the printer. If you name a PRINTER here, the TYPETERM referenced by this TERMINAL definition must have PRINTADAPTER(NO).

The printer that you name must be owned by the same CICS system that owns this TERMINAL definition.

You can name a PRINTER if this TERMINAL definition is for one of the following:

A 3270 display without the printer-adapter feature
A 3270 display attached to a 3274 control unit
A 3276 control unit display station
A 3790 in 3270 compatibility mode

If you want to specify the hardware COPY feature, specify PRINTERCOPY(YES) on this TERMINAL definition.

Note that SNA character string (SCS) printers accept only 3790 data streams; they do not accept 3270 data streams. They therefore cannot be used to print the buffer contents of a display unit.

If you use a program attention key, for example, PA1, to print the contents of the screen on an associated z/OS Communications Server printer, the screen size of the printer is chosen according to the SCRNSIZE operand as defined in the CICS-supplied default profile DFHCICST. This profile is defined with SCRNSIZE(DEFAULT) and, if you want to use the alternate screen size of the printer, you have to change the profile entry for transaction CSPP.

PRINTERCOPY({NO|YES})

Specifies whether the hardware COPY feature is to be used to satisfy a print request on the printer named in the PRINTER attribute of this terminal definition.

CICS uses the hardware COPY feature of the 3270 to perform the print, unless a task is currently attached to the display.

You do not need to specify COPY(YES) on the TYPETERM definition, because it is implied by PRINTERCOPY(YES) on the terminal definition.

If you have named an ALTPRINTER as well as a PRINTER, you can specify ALTPRINTCOPY(YES).

To use the COPY feature, both the printer and the display terminal must be on the same 3270 control unit. Otherwise, either the COPY might fail, raising an error condition, or, if the display device address is valid for the printer control unit, copying might be performed from a different display.

Do not specify PRINTERCOPY(YES) if, in a networking environment, the 3270 control unit is connected to a TCAM system in one domain, and a CICS system in another domain has access to the control unit through z/OS Communications Server. The hardware COPY address is not available to CICS and cannot therefore be used by terminals attached to such a control unit.

The COPY command is invalid for a 3270 compatibility mode display.

REMOTENAME(terminal)

Specifies the name by which the terminal is known in the system or region that owns the terminal. The name can be up to 4 characters in length.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

REMOTESYSNET(netname)

Specifies the network name (APPLID) of the region that owns the terminal. The name can be up to 8 characters in length. It follows assembler language rules, and must start with an alphabetic character.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

REMOTESYSNET is used where there is no direct link between the region in which this definition is installed and the terminal-owning region. You do not need to specify REMOTESYSNET if either of the following is true:

You are defining a local terminal; that is, REMOTESYSTEM is not specified, or specifies the sysid of the local system.
REMOTESYSTEM names a direct link to the terminal-owning region. However, if the terminal-owning region is a member of a z/OS Communications Server generic resources group and the direct link is an APPC connection, you might need to specify REMOTESYSNET. REMOTESYSNET is needed in this case if the NETNAME specified on the CONNECTION definition for the direct link is the generic resource name of the TOR (not the applid).

REMOTESYSTEM(connection)

Specifies the name that identifies the intercommunication link to the system that owns the terminal. The name can be up to 4 characters in length.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

REMOTESYSTEM is one of these identifiers:

For IPIC connections, the first 4 characters of the IPCONN name on the IPCONN definition, which is in service and acquired.
For MRO and APPC connections, the CONNECTION name on the CONNECTION definition. If the CONNECTION name is not specified, or if the name is specified as the sysid of the local system, the terminal is local to this system. If the name is the name of another system, the terminal is remote. You can therefore use the same definition for the terminal in both the local system and a remote system.

If you have intermediate systems between this CICS and the terminal-owning region, REMOTESYSTEM specifies the first link in the path to the TOR. If more than one path is possible, REMOTESYSTEM specifies the first link in the preferred path.

REMOTESYSTEM is ignored if you specify AUTINSTMODEL(YES) or AUTINSTMODEL(ONLY).

SECURITYNAME(securityname)

Specifies the security name of the remote system.

In a CICS system with security initialized (SEC=YES), the security name is used to establish the authority of the remote system.

If USERID is specified in the session definition (DEFINE SESSIONS command) associated with the connection definition, the user ID overrides the user ID specified in the SECURITYNAME attribute, and is used for link security.

The security name, or USERID on the sessions definition, must be a valid RACF user ID on your system. Access to protected resources on your system is based on the RACF user profile and its group membership.

For more information on defining security for MRO, LUTYPE6.1, and APPC connections, see Intercommunication security.

SOLICITED(NO|YES)

Specifies whether CICS messages issued to a console will be treated by NetView® as solicited or unsolicited.

NO: CICS messages will be treated as unsolicited
YES: CICS messages will be treated as solicited. When SOLICITED(YES) is specified for a console, CICS adds the console name or the console identification number and a command and response token to each console message.

The SOLICITED attribute applies only to consoles; it is ignored for other TERMINAL definitions.

TASKLIMIT({NO|number})

Specifies the number of concurrent tasks allowed to run in a pipeline session or in a pool of pipeline sessions.

NO: No concurrent tasks are allowed.
number: The number of concurrent tasks allowed to run, in the range 1 - 32767.

When you define a 3600 pipeline logical unit, you generate a TCTTE that is associated with a pool of TCTTEs. When messages enter CICS from the 3600 pipeline logical unit, a task is attached to process this message, using as an anchor block one of the TCTTEs from the pool. In this way, consecutive messages sent using the pipeline logical unit can be processed concurrently, the number of concurrent transactions being limited by the number of TCTTEs in the pool. The number of TCTTEs in the pool should represents the high-water mark of inquiry activity. In this way, the pipeline facility allows fewer TCTTEs to be defined to CICS than the total number of pipeline inquiry terminals.

TERMINAL(name)

Specifies the terminal identifier. For a terminal, the name can be up to 4 characters in length.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

For an APPC LU6.2 single session terminal, the valid characters are as follows:

Acceptable characters: `A-Z a-z 0-9 $ @ #`

If the name supplied is fewer than 4 characters, it is left-justified and padded with blanks up to 4 characters. You should not have a TERMINAL definition and a CONNECTION definition with the same name.

Note: If you use a comma (,) in a name, you cannot use commands such as:

CEMT INQUIRE TERMINAL(value1,value2)
CEMT SET     TERMINAL(value1,value2)

where the comma serves as a list delimiter. See List of resource identifiers for information about using lists of resource identifiers.

Also, if you are allowing CICS to automatically generate session names or terminal IDs for consoles, avoid using any of the following symbols as the first or fourth character in the terminal name:

-: The hyphen is used by CICS for automatically generated terminal names for APPC sessions
> and <: The > (greater than) and < (less than) symbols are used by CICS for automatically generated terminal names for IRC sessions
¬: The ¬ (logical not) symbol is used by CICS for automatically generated terminal names for MVS consoles.

The name specified becomes the name of the TCT entry, when this TERMINAL definition is installed. For this reason, the TERMINAL name must be unique. Note that the value CERR is reserved for the identification generated for the error console. If you specify AUTINSTMODEL(ONLY), you do not need a unique TERMINAL name, because it is not used as the name of a TCT entry. If you specify AUTINSTMODEL(YES), the TERMINAL name is used as the name of the TCT entry that is installed in the TCT when the TERMINAL definition is installed; the names of the TCT entries for the autoinstalled terminals are determined by the autoinstall user program.

If the terminal is to be associated with a transient data destination, the terminal name and the transient data queue name in the TDQUEUE resource definition must be the same.

TERMPRIORITY({0|priority})

Specifies the terminal priority. This decimal value (0 - 255) is used in establishing the overall transaction processing priority. Transaction processing priority is equal to the sum of the terminal priority, transaction priority, and operator priority, not exceeding 255.

TRANSACTION(transaction)

Specifies a 1- to 4-character name of the transaction that is to be initiated each time input is received from the terminal when there is no active task.

Acceptable characters: `A-Z a-z 0-9 $ @ # . / - _ % & ? ! : \| " = ¬ , ; < >`

For z/OS Communications Server non-3270 devices, a TRANSACTION name of fewer than 4 characters requires a delimiter.

For information on what happens when a transaction is initiated, see Terminal control.

If you specify this operand for a 3270 display, the only CICS functions the operator can start, other than this transaction, are paging commands and print requests.

You are unlikely to specify the TRANSACTION attribute for a 3270 display or SCS printer. It is optional for 3601 logical units, but is mandatory for 3614 logical units.

If this operand is specified for a 3790 Communication System, and multiple sessions are used to connect the same 3791, specify the same TRANSACTION name for all sessions.

TYPETERM(typeterm)

Specifies the name of the TYPETERM definition to be associated with this TERMINAL definition. The name can be up to 8 characters in length.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

The TYPETERM definition specifies many attributes for a number of similar terminals. For more information, see TYPETERM attributes and Ways of defining CICS resources. The TYPETERM attribute is mandatory for all TERMINAL definitions.

The TYPETERM definition must already be installed when you install this TERMINAL definition.

USEDFLTUSER ({NO|YES}) (APPC only)

Specifies the kind of security checking that will take place for each inbound attach FMH.

NO: Indicates that each inbound attach FMH will be checked for the presence of those fields required by the ATTACHSEC option. If the required fields are not present, a protocol violation message is issued and the attach fails. NO is the default.
YES: Indicates that some checks on the validity of the attach Function Management Header (FMH) are bypassed. See Implementing LU6.2 security.

USERID({name|*EVERY|*FIRST})

Specifies a user identifier used for sign-on and referred to in security error messages, security violation messages, and the audit trail. It must be a valid user ID defined to the security manager.

The USERID attribute provides the only way to specify a user identifier for devices such as printers that are unable to sign on using CESN. You can also specify USERID for a display device; if so, the display is permanently signed on. Operators are unable to sign on. All access to protected resources depends on the authorizations permitted by RACF for the specified USERID.

For an APPC single session terminal, USERID overrides any SECURITYNAME that you have specified for the connection.

name

This name can be up to 8 characters in length.

Acceptable characters: `A-Z 0-9 $ @ #` Unless you are using the CREATE command, any lowercase characters that you enter are converted to uppercase.

*EVERY

This special operand is for autoinstalled consoles only. It means that CICS is to use the user ID passed on the MVS MODIFY command every time a MODIFY command is received. The console is signed on using the MVS user ID as the preset user ID for the console being autoinstalled. The console remains signed on with this user ID until the console is deleted or another MODIFY is received with another user ID. If a MODIFY command is received without a user ID, CICS signs on the default CICS user ID until a MODIFY command is received that has a valid user ID. For non-console terminals, or if security is not enabled, this value is ignored.

*FIRST

This special is operand for autoinstalled consoles only. It means that CICS is to use the user ID passed on the first MVS MODIFY command that requires the console to be autoinstalled. The console is signed on with the MVS user ID as the preset user ID. The console remains signed on with this user ID until the console is deleted. If a MODIFY command is received without a user ID, CICS signs on the default CICS user ID. For non-console terminals, or if security is not enabled, this value is ignored.

If this terminal definition defines a console, the user ID must be authorized to the appropriate profile in the CONSOLE general resource class. See Defining port of entry profiles for information about preset security on consoles and terminals.