Interface ITerminalDefinition

    • Method Detail

      • getChangeAgent

        ITerminalDefinition.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last modification agent

        The change agent identifier that made the last modification.

        • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CSDBATCH - The resource was last changed by a DFHCSDUP job.
        • DREPAPI - Resource was last changed by a CICSPlex SM API command.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getAlternatePrinterName

        java.lang.String getAlternatePrinterName()
        Getter for field ALTPRINTER

        Alternate printer name

        The name of a 3270 printer to be used, if the printer named in the PRINTER attribute of this terminal definition is unavailable. The name may be up to four characters in length. For further details, see the PRINTER attribute. If you specify an ALTPRINTER without specifying a PRINTER, ALTPRINTER is ignored.

      • getAltprintcopy

        ICICSEnums.YesNoValue getAltprintcopy()
        Getter for field ALTPRINTCOPY

        Hardware COPY feature for alternate printer

        Indicates whether CICS is to use the hardware copy feature to satisfy a print request on the printer named in the ALTPRINTER option. Values are:

        • YES - CICS is to use the hardware copy feature.
        • NO - CICS is not to use the hardware copy feature.
      • getAttachsec

        ITerminalDefinition.AttachsecValue getAttachsec()
        Getter for field ATTACHSEC

        Level of attach-time security

        The level of attach time user security required for the connection:

        • LOCAL - The authority of the user is taken to be that of the link itself, and you rely on link security alone to protect your resource.
        • IDENTIFY - Incoming attach requests must specify a user identifier. Specify IDENTIFY when the connecting terminal has a security manager.
        • MIXIDPE - A connection is able to support attaches using either or both of the IDENTIFY and PERSISTENT security types. The security type used depends on the incoming attach.
        • PERSISTENT - This 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's ID and password are passed only on the first (sign-on) attach. Subsequent attach requests require only the user's 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.
      • getAutoinsmodel

        ITerminalDefinition.AutoinsmodelValue getAutoinsmodel()
        Getter for field AUTOINSMODEL

        Model for autoinstall option

        Specifies whether this terminal definition can be used as a model terminal definition for autoinstall:

        • 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.
      • getAutoinsname

        java.lang.String getAutoinsname()
        Getter for field AUTOINSNAME

        Name of autoinstall model definition

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

      • getBindsecurity

        ICICSEnums.YesNoValue getBindsecurity()
        Getter for field BINDSECURITY

        Bind-time security

        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, an ESM is called.
      • getConsole

        java.lang.Long getConsole()
        Getter for field CONSOLE

        Console ID

        Indicates, for an MVS console only, the identifier for the console.

      • getConsname

        java.lang.String getConsname()
        Getter for field CONSNAME

        Console name

        The unique name of the console device within a CICS region, regardless of the MVS image to which it is connected. 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. The length of CONSNAME must be 2-8 characters and must begin with an alphabetic character or one of #,

      • getModename

        java.lang.String getModename()
        Getter for field MODENAME

        Logmode name

        The name that is passed to VTAM as the LOGMODE name (APPC single session terminals only) .

      • getNetname

        java.lang.String getNetname()
        Getter for field NETNAME

        VTAM network name

        The network name that identifies the terminal to ACF/VTAM. The name may be up to 8 characters in length and must start with an alphabetic character. 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 VTAM dynamic LU alias (that is, LUAPFX=xx is specified on the CICS region's 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 VTAM on a CDRSC definition with a predefined LUALIAS (LUALIAS=netname) to override VTAM dynamic allocation. In this case, netname on the LUALIAS parameter must match the NETNAME defined on this terminal resource definition.
      • getPool

        java.lang.String getPool()
        Getter for field POOL

        Pool name for pipeline terminal

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

      • getPrinter

        java.lang.String getPrinter()
        Getter for field PRINTER

        Printer name

        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 may be up to four characters in length.

      • getRemotesystem

        java.lang.String getRemotesystem()
        Getter for field REMOTESYSTEM

        Remote system name

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

        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 then one path is possible, REMOTESYSTEM specifies the first link in the preferred path.

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

      • getRemotesysnet

        java.lang.String getRemotesysnet()
        Getter for field REMOTESYSNET

        Remote system network name

        The network name (APPLID) of the region that owns the terminal. This is used where there is no direct link between the region in which this definition is installed and the terminal-owning region.

      • getRemotename

        java.lang.String getRemotename()
        Getter for field REMOTENAME

        Terminal name in the remote system

        The 4-character name of this terminal in the remote CICS region in which it is defined. This applies only to terminals defined as remote; for others the value returned is blanks.

      • getSecurityname

        java.lang.String getSecurityname()
        Getter for field SECURITYNAME

        Security name of the remote system

        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. 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.

      • getTransaction

        java.lang.String getTransaction()
        Getter for field TRANSACTION

        Fixed transaction ID

        The 4-character identifier of the transaction being executed by the task for which this terminal is the principal facility. Blanks are returned if no task is currently running at the terminal

      • getTypeterm

        java.lang.String getTypeterm()
        Getter for field TYPETERM

        Typeterm definition name

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

      • getUserid

        java.lang.String getUserid()
        Getter for field USERID

        User ID

        The 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.

      • getBindpassword

        java.lang.String getBindpassword()
        Getter for field BINDPASSWORD

        Bind password

        A password of up to 16 hexadecimal characters (0-9, A-F) (APPC only).

      • getTasklimit

        java.lang.Long getTasklimit()
        Getter for field TASKLIMIT

        Concurrent task limit for pipeline session

        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 through 32767.
      • getTermpriority

        java.lang.Long getTermpriority()
        Getter for field TERMPRIORITY

        Terminal priority

        The priority of the terminal relative to other terminals, in the range 0-255.

      • getPrintercopy

        ICICSEnums.YesNoValue getPrintercopy()
        Getter for field PRINTERCOPY

        Hardware copy feature

        Indicates whether CICS is to use the hardware copy feature to satisfy a print request. Values are:

        • YES - CICS is to use the hardware copy feature.
        • NO - CICS is not to use the hardware copy feature.
      • getInservice

        ICICSEnums.YesNoValue getInservice()
        Getter for field INSERVICE

        Terminal inservice

        The status of the terminal that is being defined:

        • YES - Transactions may be initiated and messages may automatically be sent to the terminal.
        • NO - The terminal can neither receive messages nor transmit input.
      • getNatlang

        java.lang.String getNatlang()
        Getter for field NATLANG

        Language for NLS-enabled messages

        A 1-character alphanumeric value that identifies the national language originally defined for use with this terminal. If you leave this blank, CICS uses the system default as specified in the system initialization table (SIT).

      • getAssocprntr

        java.lang.String getAssocprntr()
        Getter for field ASSOCPRNTR

        Associated printer

        The 4-character TERMINAL name of the definition for the printer.

      • getUserdata1

        java.lang.String getUserdata1()
        Getter for field USERDATA1

        User data area 1

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getUserdata2

        java.lang.String getUserdata2()
        Getter for field USERDATA2

        User data area 2

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getUserdata3

        java.lang.String getUserdata3()
        Getter for field USERDATA3

        User data area 3

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getUsedfltuser

        ITerminalDefinition.UsedfltuserValue getUsedfltuser()
        Getter for field USEDFLTUSER

        Use default user

        Indicate whether the terminal should use the default user ID specified for a CICS system, therefore specifying the kind of security checking that will take place for each inbound attach FMH:

        • N/A - The USEDFLTUSER value does not apply to this definition and should not be validated by CICSPlex SM.
        • NO - Do not use the default user ID. Each inbound attach FMH will be checked for the presence of those fields required by the ATTACHSEC option and if the required fields are not present a protocol violation message will be issued and the attach will fail.
        • YES - Use the default user ID specified on the DFLTUSER SIT parameter for the CICS system. Some checks on the validity of the attach FMH are bypassed. This provides the same level of security as in releases of CICS prior to CICS/ESA 4.1.