Interface ISessionDefinition

    • Method Detail

      • getChangeAgent

        ISessionDefinition.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.
      • getAutoconnect

        ISessionDefinition.AutoconnectValue getAutoconnect()
        Getter for field AUTOCONNECT

        Autoconnect option

        Specifies how connections are to be established.

        For a APPC VTAM-connected system that has Autoconnect set to YES or ALL on the connection definition:

        • NO - CICS does not attempt to bind any sessions when the connection is established.
        • YES or ALL - A contention-winner session is established (that is, BIND is performed) during CICS initialization, or when communication with VTAM is started using the CEMT SET VTAM OPEN command.

        For a APPC VTAM-connected system that has Autoconnect set to NO on the CONNECTION definition:

        • ALL - All sessions, not just contention winners, are established when the connection is acquired by issuing CEMT SET CONNECTION(name) ACQUIRED, or when the remote system itself initiates communication.
        • NO - CICS does not attempt to bind any sessions when the connection is established.
        • YES - Contention-winner sessions are established when the connection is acquired by issuing CEMT SET CONNECTION(sysid) ACQUIRED, or when the remote system itself initiates communication

        For LU6.1 sessions:

        • NO - The connection is not established at initialization or CEDA install.
        • YES - The connection is established at initialization or CEDA install.

      • getBuildchain

        ICICSEnums.YesNoValue getBuildchain()
        Getter for field BUILDCHAIN

        Chain assembly required

        Specifies whether CICS is to perform chain assembly before 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.
      • getConnection

        java.lang.String getConnection()
        Getter for field CONNECTION

        Connection definition name

        The name of the connection definition to be used with this session definition. The name can be up to four characters in length.

      • getDiscreq

        ICICSEnums.YesNoValue getDiscreq()
        Getter for field DISCREQ

        Honor disconnect reqeusts

        Specifies whether disconnect requests are to be honored. DISCREQ applies to LUTYPE6.1 ISC sessions, but not to MRO sessions where CICS is not dealing with VTAM devices.

      • getIoarealen

        java.lang.Long getIoarealen()
        Getter for field IOAREALEN

        Minimum terminal input output area (TIOA) size

        The minimum size, in bytes, of the terminal input/output area to be used for processing messages transmitted on the MRO link.

      • getIoarealen2

        java.lang.Long getIoarealen2()
        Getter for field IOAREALEN2

        Alternate terminal input output area (TIOA) size

        The length, in bytes, of the terminal input/output area to be used for processing messages transmitted on the MRO link. If the alternative TIOA value is not specified, or is less than the minimum TIOA value (IOAREALEN) , it defaults to the value of the minimum TIOA.

      • getMaxingrp

        java.lang.Long getMaxingrp()
        Getter for field MAXINGRP

        Maximum number of sessions in the group

        The maximum number of sessions in the group. This value can be in the range 1 through 999. The default is 1. This value must be more than the maximum number of contention winner sessions (MAXTWIN).

      • getMaxctwin

        java.lang.Long getMaxctwin()
        Getter for field MAXCTWIN

        Maximum number of contention winner sessions

        The maximum number of sessions that are to be supported as contention winners. This value can be in the range 0 to 999. The default is 0. Note that this operand has no meaning for a single session connection. This value must be less than the maximum number of sessions in the group (MAXINGRP).

      • getModename

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

        Mode name

        The name that identifies a group of sessions for use on an APPC connection. The name can be up to eight characters in length, and must be the name of a VTAM LOGMODE entry defined to VTAM (APPC only).

      • getNepclass

        java.lang.Long getNepclass()
        Getter for field NEPCLASS

        Network error program transaction class

        The transaction class for the node error program:

        • 0 - This results in a link to the default node error program module.
        • value - The transaction class for the node error program module. The value can be in the range 1 through 255
        If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
      • getNetnameq

        java.lang.String getNetnameq()
        Getter for field NETNAMEQ

        Name IMS system uses to identify session

        The name by which the remote IMS system knows this particular session. This is used for CICS-IMS sessions.

      • getProtocol

        ISessionDefinition.ProtocolValue getProtocol()
        Getter for field PROTOCOL

        Intercommunication link protocol

        The type of protocol that is to be used for an intercommunication link (ISC or MRO):

        • APPC (LUTYPE6.2) - Advanced program-to-program communication (APPC) protocol. Specify this for CICS-CICS ISC.
        • EXCI - The external CICS interface. Specify this to indicate that the sessions are for use by a non-CICS client program using the external CICS interface. If you specify EXCI, you must leave SENDCOUNT blank.
        • LU61 - LUTYPE6.1 protocol.
        • NOTAPPLIC - The session does not represent an intercommunication link.
      • getReceivecount

        java.lang.Long getReceivecount()
        Getter for field RECEIVECOUNT

        Receive count

        For MRO, and VTAM LU6.1 sessions, and for sessions with EXCI clients, specifies the number of sessions that normally receive before sending.

      • getReceivesize

        java.lang.Long getReceivesize()
        Getter for field RECEIVESIZE

        Receive buffer size

        The maximum VTAM request unit (RU) size that the session is capable of receiving. The value must be between 1 and 30720 for LU61 sessions, or 256 and 30720 for APPC sessions. The default is 4096.

      • getRecovoption

        ISessionDefinition.RecovoptionValue getRecovoption()
        Getter for field RECOVOPTION

        Recovery option

        Specifies the type of recovery for sessions in a CICS region running with VTAM persistent sessions.

      • getRelreq

        ICICSEnums.YesNoValue getRelreq()
        Getter for field RELREQ

        Honor release requests

        Specifies whether CICS is to release the logical unit upon request by another VTAM application program.

      • getSendcount

        java.lang.Long getSendcount()
        Getter for field SENDCOUNT

        Send count

        For MRO, and VTAM LU6.1 sessions, and for sessions with EXCI clients, specifies the number of send sessions; that is, sessions that normally send before receiving.

      • getSendsize

        java.lang.Long getSendsize()
        Getter for field SENDSIZE

        Send buffer size

        The maximum VTAM request unit (RU) size that these sessions are capable of sending, in the range 1 through 30720 for LU 6.1 sessions, or 256 through 30720 for APPC sessions.

      • getSessname

        java.lang.String getSessname()
        Getter for field SESSNAME

        Session name

        The symbolic identification to be used as the local half of a session qualifier pair in a CICS intercommunication parallel session. The name can be up to four characters in length.

      • getSesspriority

        java.lang.Long getSesspriority()
        Getter for field SESSPRIORITY

        Session priority

        The terminal priority - this decimal value (0 through 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; this must not exceed 255.) If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

      • getUserarealen

        java.lang.Long getUserarealen()
        Getter for field USERAREALEN

        User area size

        The length, in bytes, of the user area for this session, in the range 0 through 255. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.

      • getUserid

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

        User signon ID

        A user identifier used for sign-on (SEC=YES or MIGRATE) and referred to in security error messages, security violation messages, and the audit trail. The name can be up to eight characters in length.

      • getReceivepfx

        java.lang.String getReceivepfx()
        Getter for field RECEIVEPFX

        Receive prefix

        A 1-or 2-character prefix that CICS is to use as the first one or two characters of the receive session names (the names of the terminal control table terminal entries (TCTTEs) for the sessions).

      • getSendpfx

        java.lang.String getSendpfx()
        Getter for field SENDPFX

        Send prefix

        A 1-or 2-character prefix that CICS is to use as the first one or two characters of the send session names (the names of the terminal control table terminal entries (TCTTEs) for the sessions). The prefix you select must not result in any duplicate session or terminal names.

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