Interface ITransactionDefinition

    • Method Detail

      • getChangeAgent

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

        java.lang.String getAlias()
        Getter for field ALIAS

        Alias name for transaction

        An alias transaction name for this transaction. The name may be up to four characters in length.

      • getProgramName

        java.lang.String getProgramName()
        Getter for field PROGRAM

        First program name

        The name of the program to which CICS gives control to process this transaction. The name can be up to eight characters in length. If this transaction definition is for use on a remote program link request, the program name you specify in this attribute must be the name of the CICS mirror program, DFHMIRS.

      • getRemotename

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

        Remote transaction name

        The name of this transaction as it is known in a remote system, if it is to be executed in a remote system or region using intersystem communication. The remote system can be another CICS region or an IMS system. REMOTENAME can be 1 through 4 characters in length if the REMOTESYSTEM attribute specifies another CICS region, or 1 through 8 characters in length if REMOTESYSTEM specifies an IMS system. If you specify a remote name, CICSPlex SM uses that name when assigning the transaction to a related system. If you specify a remote system but not a remote name, the local name (that is, the name of this transaction definition) is used in both the target and related systems.

      • getRemotesystem

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

        Remote system name

        (Optional) The name of the connection that links the target system to the related system where the transaction resides. If this parameter is not supplied, the connection name is derived directly from the CICS system ID of the related system. The name may be up to 4 characters in length. CICSPlex SM uses this system ID only if the transaction is part of a resource group that is directly associated with a resource description (via RESINDSC). If the transaction is being assigned by a resource assignment (RASGNDEF), CICSPlex SM uses the actual CICS system ID of the related system.

        • For IPIC connections, the first 4 characters of the IPCONN definition should be used. Any IPIC connection to be referenced in this way must have the last 4 characters blank.
        • For MRO and APPC connections, the CONNECTION name on the CONNECTION definition should be used.
      • getProfile

        java.lang.String getProfile()
        Getter for field PROFILE

        Transaction profile

        The 8-character name of the profile definition for this transaction. The profile defines attributes that govern the interaction between a task executing the transaction and the terminal or session which is its principal facility.

      • getFailaction

        ITransactionDefinition.FailactionValue getFailaction()
        Getter for field FAILACTION

        CICS failure action

        The failure action that CICS takes on the failure of the transaction. The default value is BACKOUT.

      • getCmdsec

        ICICSEnums.YesNoValue getCmdsec()
        Getter for field CMDSEC

        Command level security option

        Indicates whether command security checking should be performed for tasks executing this transaction:

        • NO - Command security checking should not be performed.
        • YES - Command security checking should be performed.
      • getShutdown

        ICICSEnums.EnablementValue getShutdown()
        Getter for field SHUTDOWN

        Shutdown run status

        Indicates whether the transaction can be run during CICS shutdown. This supplements the XLT option on EXEC CICS PERFORM SHUTDOWN. For a transaction to be attached during shutdown, it must either be defined as SHUTDOWN(ENABLED) or be named in the XLT specified in the EXEC CICS SHUTDOWN command.

        • DISABLED The transaction is disabled from running during CICS shutdown.
        • ENABLED The transaction is enabled to run during CICS shutdown.
      • getStatus

        ICICSEnums.EnablementValue getStatus()
        Getter for field STATUS

        Enabled status

        Indicates whether the transaction is available for use:

        • DISABLED - The transaction is not available for use.
        • ENABLED - The transaction is available for use
      • getTaskDataKey

        ITransactionDefinition.TaskDataKeyValue getTaskDataKey()
        Getter for field TASKDATAKEY

        Task data key

        The storage key of the storage CICS allocates at task initialization for the duration of the task (task-lifetime storage), and which is accessible by the application. These storage areas are the EXEC interface block (EIB) and the transaction work area (TWA). This also specifies the key of the storage that CICS obtains on behalf of all programs that run under the transaction:

        • CICS - CICS obtains CICS-key storage for this transaction. Application programs executing in CICS key can both read and modify these storage areas. Application programs executing in user key can only read these storage areas.
        • USER - CICS obtains user-key storage for this transaction. Application programs executing in any key can both read and modify these storage areas.
      • getTaskDataLocation

        ITransactionDefinition.TaskDataLocationValue getTaskDataLocation()
        Getter for field TASKDATALOC

        Task data location

        Specifies whether task life-time storage acquired by CICS for the duration of the transaction can be located above the 16MB line in virtual storage. These areas, which relate to specific CICS tasks, include the EXEC interface block (EIB) and the transaction work area (TWA):

        • BELOW - Storage areas that CICS acquires for the transaction must be located below the 16MB line.
        • ANY - Storage areas that CICS acquires for the transaction can be located above the 16MB line in virtual storage.

        You must specify BELOW if any of the programs that make up the transaction runs in 24-bit addressing mode (this also applies to task-related user exits running on behalf of the transaction).

        For transactions that do not satisfy any of these conditions, you can specify ANY to obtain the associated virtual storage constraint relief.

      • getTaskreq

        java.lang.String getTaskreq()
        Getter for field TASKREQ

        Transaction initiation

        Specifies whether a transaction is to be initiated by pressing a PF key, by using a light pen, or by using a card. Possible values are:

        • PA1, PA2, or PA3 for PA keys.
        • PF1 through PF24 for PF keys.
        • OPID for the operator identification card reader.
        • LPA for a light-pen-detectable field on a 3270 device.
        • MSRE for the 10/63 character magnetic slot reader.
      • getLocalQueueing

        ITransactionDefinition.LocalQueueingValue getLocalQueueing()
        Getter for field LOCALQ

        Queueing on local system

        Specifies whether queuing on the local system is to be performed:

        • NO - No local queuing is to be performed.
        • YES - Local queuing can be attempted for an EXEC START NOCHECK request when the system is not available and the system name is valid.
        • N_A - The Localq attribute will use the default value at installation.
      • getRessec

        ICICSEnums.YesNoValue getRessec()
        Getter for field RESSEC

        Resource security checking

        Indicates whether resource security checking is required for the transaction.

      • getStorageclear

        ICICSEnums.YesNoValue getStorageclear()
        Getter for field STORAGECLEAR

        Storage clearance status

        Specifies whether task-lifetime storage for this transaction is to be cleared on release. This can be used to prevent other tasks accidentally viewing any confidential or sensitive data that was being stored by this transaction in task lifetime storage.

      • getRestart

        ICICSEnums.YesNoValue getRestart()
        Getter for field RESTART

        Transaction restart facility

        Specifies whether the transaction restart facility is to be used to restart those tasks that terminate abnormally and are subsequently backed out by the dynamic transaction backout facility. If YES is specified, the task that failed is restarted from the beginning of the initial program. If dynamic transaction backout fails, or if restart is suppressed dynamically, DFHPEP is invoked in the normal way. The transaction restart facility is especially useful in such situations as a program isolation deadlock, where the task can be restarted automatically rather than resubmitted manually.

      • getSystemPurge

        ICICSEnums.YesNoValue getSystemPurge()
        Getter for field SPURGE

        System purgeable option

        Specifies whether the transaction is initially system purgeable or not:

        • NO - Prevents a transaction being purged by the deadlock time-out (DTIMOUT) facility, an EXEC CICS ... PURGE command, TWAOCT (Cancel Task) being set in the node error program (NEP), or a CEMT SET ... PURGE command.
        • YES - Allows such purges to go ahead as far as the user is concerned. CICS may, however, prevent the purge if it is not safe to allow a purge at the point the transaction has reached.
      • getTerminalPurge

        ICICSEnums.YesNoValue getTerminalPurge()
        Getter for field TPURGE

        Purgeable for terminal error option

        Specifies (for non-VTAM terminals only) whether the transaction can be purged because of a terminal error:

        • NO - The task cannot be purged when a terminal error occurs.
        • YES - The task can be purged when a terminal error occurs.
      • getWait

        ICICSEnums.YesNoValue getWait()
        Getter for field WAIT

        In-doubt wait option

        Specifies whether an in-doubt unit of work (UOW) is to wait, pending recovery from a failure that occurs after the UOW has entered the in-doubt state:

        • YES - The UOW is to wait, pending recovery from the failure, to resolve its in-doubt state and determine whether recoverable resources are to be backed out or committed. In other words, the UOW is to be shunted.
        • NO - The UOW is not to wait. CICS immediately takes whatever action is specified on the ACTION attribute.
      • getTrace

        ICICSEnums.YesNoValue getTrace()
        Getter for field TRACE

        Trace transaction activity option

        Specifies whether the activity of this transaction is to be traced.

      • getTrprof

        java.lang.String getTrprof()
        Getter for field TRPROF

        Transaction routing profile

        The name of the profile for the session that carries intersystem flows during ISC transaction routing. The name can be up to eight characters in length.

      • getTranclass

        java.lang.String getTranclass()
        Getter for field TRANCLASS

        Transaction class name

        The name of the transaction class to which the transaction belongs. Transactions belonging to a transaction class are subject to scheduling constraints before they are allowed to execute. The reserved TRANCLASS name DFHTCL00 is used to indicate that the transaction does not belong to any transaction class. The name can be up to 8 characters in length.

      • getTwasize

        java.lang.Long getTwasize()
        Getter for field TWASIZE

        Size in bytes of transaction work area (TWA)

        The size (in bytes) of the transaction work area to be acquired for this transaction. Specify a 1-to 5-digit decimal value in the range 0 through 32767.

      • getPartitionset

        java.lang.String getPartitionset()
        Getter for field PARTITIONSET

        Default application partition set

        Specifies the name of the partition set that is to be the default application partition set. The name can be up to eight characters in length. Special values are

        • KEEP - The transaction uses the application partition set for this terminal.
        • OWN - The transaction performs its own partition management.
      • getXtranid

        java.lang.String getXtranid()
        Getter for field XTRANID

        Alternate name (in hex) for initiating transaction

        (Optional) Another name to be used instead of the TRANSACTION name for initiating transactions. The name may be up to eight hexadecimal digits in length. Because XTRANID is specified in hexadecimal form, you can use a name that contains characters that you cannot specify in the TRANSACTION attribute.

      • getIsolation

        ICICSEnums.YesNoValue getIsolation()
        Getter for field ISOLATE

        Transaction isolation option

        Specifies whether CICS is to isolate the transaction's user-key task-lifetime storage to provide transaction-to-transaction protection. Isolation means that the user-key task-lifetime storage is protected from both reading and writing by the user-key programs of other transactions-that is, from programs defined with EXECKEY(USER).

      • getDump

        ICICSEnums.YesNoValue getDump()
        Getter for field DUMP

        Transaction dump option

        Specifies whether a call is to be made to the dump domain to produce a transaction dump if the transaction terminates abnormally.

      • getDynamicRoutingOption

        ICICSEnums.YesNoValue getDynamicRoutingOption()
        Getter for field DYNAMIC

        Dynamic routing option

        Indicates whether the transaction can be dynamically routed to a remote region, using the CICS dynamic transaction routing facility:

        • NO - Creates a local or remote definition according to the REMOTESYSTEM attribute.
        • YES - Allows the dynamic transaction routing program to determine the local or remote status dynamically at invocation time.
      • getPriority

        java.lang.Long getPriority()
        Getter for field PRIORITY

        Transaction priority

        The priority of a transaction relative to other transactions. When a transaction is running as a CICS task, the priority of a task is the sum of the transaction priority, the terminal priority, and the operator priority. The 'value' must be in the range 0-255, where 255 is the highest priority.

      • getRunawayTime

        java.lang.Long getRunawayTime()
        Getter for field RUNAWAY

        Runaway timeout value

        The amount of time, in milliseconds, for which any task running under this transaction definition can have control of the processor before it is assumed to be in a runaway condition (logical loop). When this interval expires, CICS can abnormally terminate the task.

        • SYSTEM - CICS is to use the ICVR system initialization parameter value as the runaway time limit for this transaction.
        • 0 - There is no limit and no runaway task detection is required for the transaction.
        • 250-2700000 - The runaway time limit in the range 250 through 2700000.
        If this field is blank CICSPlex SM uses the default value for your CICS environment if there is one.
      • getDtimout

        java.lang.Long getDtimout()
        Getter for field DTIMOUT

        Deadlock timeout value

        Specifies whether deadlock time-out is be applied to the task. If the execution of the task gets suspended (for example, through lack of storage), a purge of the task is initiated if the task stays suspended for longer than the DTIMOUT value. If the purge leads to a transaction abend, the abend code used depends on which part of CICS suspended the task. When using CEDF, the user task should, if possible, specify DTIMOUT(NO), or a large value. This is also now used as the timeout on all RLS file requests if DTIMOUT is non-zero, otherwise the request gets the SIT FTIMEOUT value. FTIMEOUT applies to transactions that do not have a deadlock timeout interval active. If the DTIMOUT keyword of the TRANSACTION definition is specified, it is used as the file timeout value for that transaction.

        Note: When using CEDF, if any DTIMOUT value has been specified for the user task, the DTIMOUT value is ignored while the user task is suspended and a CEDF task is active. Therefore the suspended user task cannot terminate with a deadlock timeout (abend AKCS) while a CEDF task is waiting for a user response.

        For DTIMOUT to be effective in non-RLS usage, SPURGE must be set to YES.

        CICS inhibits deadlock time-out at certain points.

        DTIMOUT is not triggered for terminal I/O waits. Because the relay transaction does not access resources after obtaining a session, it has little need for DTIMOUT except to trap suspended allocate requests. However, for I/O waits on a session, the RTIMOUT attribute can be specified on PROFILE definitions for transaction routing on MRO sessions and mapped APPC connections.

        It is important that you define some transactions with a DTIMOUT value, because deadlock time-out is the mechanism that CICS uses to deal with short-on-storage (SOS) situations.

        Valid values are:

        • NO - The deadlock time-out feature is not required.
        • mmss - The length of time (mmss for minutes and seconds) after which the deadlock time-out facility terminates a suspended task. The maximum value that you can specify is 68 minutes(6800); this is accurate to one second.
      • getWaittimedd

        java.lang.Long getWaittimedd()
        Getter for field WAITTIMEDD

        In-doubt wait time (days)

        How long in days a transaction is to wait before taking an arbitrary decision about an in-doubt unit of work, based on what is specified in the ACTION attribute. The maximum value is 99. If you leave the 3 wait time fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.

      • getWaittimehh

        java.lang.Long getWaittimehh()
        Getter for field WAITTIMEHH

        In-doubt wait time (hours)

        How long in hours a transaction is to wait before taking an arbitrary decision about an in-doubt unit of work, based on what is specified in the ACTION attribute. The maximum value is 23. If you leave the 3 wait time fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.

      • getWaittimemm

        java.lang.Long getWaittimemm()
        Getter for field WAITTIMEMM

        In-doubt wait time (minutes)

        How long in minutes a transaction is to wait before taking an arbitrary decision about an in-doubt unit of work, based on what is specified in the ACTION attribute. The maximum value is 59. If you leave the 3 wait time fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.

      • getTpname

        java.lang.String getTpname()
        Getter for field TPNAME

        APPC partner transaction name

        The name of the transaction that can be used by an APPC partner if the 4-character length limitation of the TRANSACTION attribute is too restrictive. This name can be up to 64 characters in length.

      • getXtpname

        java.lang.String getXtpname()
        Getter for field XTPNAME

        Alternate partner transaction name (in hex)

        (Optional) An alternative to TPNAME. Enter a hexadecimal string up to 128 characters in length, representing the name of the transaction that may be used by an APPC partner. All hexadecimal combinations are acceptable except X'40'.

      • getSuppressUserData

        ICICSEnums.YesNoValue getSuppressUserData()
        Getter for field CONFDATA

        Suppress user data in trace entries

        Specifies whether CICS is to suppress user data from CICS trace entries when the CONFDATA system initialization parameter specifies HIDE (HIDETC for CICS TS 5.5 and earlier).

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

      • getBrexit

        java.lang.String getBrexit()
        Getter for field BREXIT

        Bridge exit name

        The 8-character name that defines the default bridge exit to be associated with this transaction, if it is started in the 3270 bridge environment with a START BREXIT command and BREXIT specifies no name.

        The presence of a value identifies the transaction as a bridge transaction. This should not be specified for a user transaction. If you specify a value, you must not also specify a value for Remotename or Remotesystem. You also must not specify Dynamic(YES) or Restart(YES).

      • getRoutable

        ICICSEnums.YesNoValue getRoutable()
        Getter for field ROUTABLE

        Dynamic routing status

        Indicates whether, if the transaction is the subject of an eligible START command, it is routed using the enhanced routing method. Values are:

        • NO - If the transaction is the subject of a START command, it is routed using the 'traditional' method.
        • YES - If the transaction is the subject of an eligible START command, it will be routed using the enhanced method.
      • getOtstimeout

        java.lang.String getOtstimeout()
        Getter for field OTSTIMEOUT

        Object transaction service (OTS) timeout (HHMMSS)

        The default period in hours, minutes and seconds that an OTS transaction created in an EJB environment executing under this CICS transaction, is allowed to execute prior to syncpoint.

        • NO - OTS transactions will not time out. This is the default.
        • hhmmss - The period of time (in HHMMSS format) before the task is purged. The maximum period is 24 hours (240000).