|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITransactionDefinition
generated from CICS resourcetable TRANDEF
Nested Class Summary | |
---|---|
static interface |
ITransactionDefinition.DtimoutValue
Long constants interface for field DTIMOUT |
static class |
ITransactionDefinition.FailactionValue
Enumeration type for field FAILACTION |
static class |
ITransactionDefinition.LocalQueueingValue
Enumeration type for field LOCALQ |
static interface |
ITransactionDefinition.RunawayTimeValue
Long constants interface for field RUNAWAY |
static class |
ITransactionDefinition.TaskDataKeyValue
Enumeration type for field TASKDATAKEY |
static class |
ITransactionDefinition.TaskDataLocationValue
Enumeration type for field TASKDATALOC |
Field Summary |
---|
Fields inherited from interface com.ibm.cics.model.ICICSDefinition |
---|
COPYRIGHT |
Method Summary | ||
---|---|---|
|
findReferences(IReferenceAttribute<From,ITransactionDefinition> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. |
|
java.lang.String |
getAlias()
Getter for field ALIAS |
|
java.lang.String |
getBrexit()
Getter for field BREXIT |
|
ICICSDefinitionReference<ITransactionDefinition> |
getCICSObjectReference()
|
|
ICICSEnums.YesNoValue |
getCmdsec()
Getter for field CMDSEC |
|
java.lang.Long |
getDtimout()
Getter for field DTIMOUT |
|
ICICSEnums.YesNoValue |
getDump()
Getter for field DUMP |
|
ICICSEnums.YesNoValue |
getDynamicRoutingOption()
Getter for field DYNAMIC |
|
ITransactionDefinition.FailactionValue |
getFailaction()
Getter for field FAILACTION |
|
ICICSEnums.YesNoValue |
getIsolation()
Getter for field ISOLATE |
|
ITransactionDefinition.LocalQueueingValue |
getLocalQueueing()
Getter for field LOCALQ |
|
ICICSType<ITransactionDefinition> |
getObjectType()
|
|
java.lang.String |
getOtstimeout()
Getter for field OTSTIMEOUT |
|
java.lang.String |
getPartitionset()
Getter for field PARTITIONSET |
|
java.lang.Long |
getPriority()
Getter for field PRIORITY |
|
java.lang.String |
getProfile()
Getter for field PROFILE |
|
java.lang.String |
getProgramName()
Getter for field PROGRAM |
|
java.lang.String |
getRemotename()
Getter for field REMOTENAME |
|
java.lang.String |
getRemotesystem()
Getter for field REMOTESYSTEM |
|
ICICSEnums.YesNoValue |
getRessec()
Getter for field RESSEC |
|
ICICSEnums.YesNoValue |
getRestart()
Getter for field RESTART |
|
ICICSEnums.YesNoValue |
getRoutable()
Getter for field ROUTABLE |
|
java.lang.Long |
getRunawayTime()
Getter for field RUNAWAY |
|
ICICSEnums.EnablementValue |
getShutdown()
Getter for field SHUTDOWN |
|
ICICSEnums.EnablementValue |
getStatus()
Getter for field STATUS |
|
ICICSEnums.YesNoValue |
getStorageclear()
Getter for field STORAGECLEAR |
|
ICICSEnums.YesNoValue |
getSuppressUserData()
Getter for field CONFDATA |
|
ICICSEnums.YesNoValue |
getSystemPurge()
Getter for field SPURGE |
|
ITransactionDefinition.TaskDataKeyValue |
getTaskDataKey()
Getter for field TASKDATAKEY |
|
ITransactionDefinition.TaskDataLocationValue |
getTaskDataLocation()
Getter for field TASKDATALOC |
|
java.lang.String |
getTaskreq()
Getter for field TASKREQ |
|
ICICSEnums.YesNoValue |
getTerminalPurge()
Getter for field TPURGE |
|
java.lang.String |
getTpname()
Getter for field TPNAME |
|
ICICSEnums.YesNoValue |
getTrace()
Getter for field TRACE |
|
java.lang.String |
getTranclass()
Getter for field TRANCLASS |
|
java.lang.String |
getTrprof()
Getter for field TRPROF |
|
java.lang.Long |
getTwasize()
Getter for field TWASIZE |
|
java.lang.String |
getUserdata1()
Getter for field USERDATA1 |
|
java.lang.String |
getUserdata2()
Getter for field USERDATA2 |
|
java.lang.String |
getUserdata3()
Getter for field USERDATA3 |
|
ICICSEnums.YesNoValue |
getWait()
Getter for field WAIT |
|
java.lang.Long |
getWaittimedd()
Getter for field WAITTIMEDD |
|
java.lang.Long |
getWaittimehh()
Getter for field WAITTIMEHH |
|
java.lang.Long |
getWaittimemm()
Getter for field WAITTIMEMM |
|
java.lang.String |
getXtpname()
Getter for field XTPNAME |
|
java.lang.String |
getXtranid()
Getter for field XTRANID |
Methods inherited from interface com.ibm.cics.model.ICICSDefinition |
---|
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType, getName |
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject |
---|
getAttributeValue |
Method Detail |
---|
ICICSType<ITransactionDefinition> getObjectType()
getObjectType
in interface ICICSDefinition
getObjectType
in interface ICICSObject
getObjectType
in interface IDefinition
getObjectType
in interface com.ibm.cics.model.meta.ITypedObject
java.lang.String getAlias()
Alias name for transaction
An alias transaction name for this transaction. The name may be up to four characters in length.
java.lang.String getProgramName()
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.
java.lang.String getRemotename()
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.
java.lang.String getRemotesystem()
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.
java.lang.String getProfile()
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.
ITransactionDefinition.FailactionValue getFailaction()
CICS failure action
The failure action that CICS takes on the failure of the transaction. The default value is BACKOUT.
ICICSEnums.YesNoValue getCmdsec()
Command level security option
Indicates whether command security checking should be performed for tasks executing this transaction:
ICICSEnums.EnablementValue getShutdown()
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.
ICICSEnums.EnablementValue getStatus()
Enabled status
Indicates whether the transaction is available for use:
ITransactionDefinition.TaskDataKeyValue getTaskDataKey()
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:
ITransactionDefinition.TaskDataLocationValue getTaskDataLocation()
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):
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.
java.lang.String getTaskreq()
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:
ITransactionDefinition.LocalQueueingValue getLocalQueueing()
Queueing on local system
Specifies whether queuing on the local system is to be performed:
ICICSEnums.YesNoValue getRessec()
Resource security checking
Indicates whether resource security checking is required for the transaction.
ICICSEnums.YesNoValue getStorageclear()
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.
ICICSEnums.YesNoValue getRestart()
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.
ICICSEnums.YesNoValue getSystemPurge()
System purgeable option
Specifies whether the transaction is initially system purgeable or not:
ICICSEnums.YesNoValue getTerminalPurge()
Purgeable for terminal error option
Specifies (for non-VTAM terminals only) whether the transaction can be purged because of a terminal error:
ICICSEnums.YesNoValue getWait()
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:
ICICSEnums.YesNoValue getTrace()
Trace transaction activity option
Specifies whether the activity of this transaction is to be traced.
java.lang.String getTrprof()
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.
java.lang.String getTranclass()
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.
java.lang.Long getTwasize()
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.
java.lang.String getPartitionset()
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
java.lang.String getXtranid()
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.
ICICSEnums.YesNoValue getIsolation()
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).
ICICSEnums.YesNoValue getDump()
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.
ICICSEnums.YesNoValue getDynamicRoutingOption()
Dynamic routing option
Indicates whether the transaction can be dynamically routed to a remote region, using the CICS dynamic transaction routing facility:
java.lang.Long getPriority()
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.
java.lang.Long getRunawayTime()
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.
java.lang.Long getDtimout()
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:
java.lang.Long getWaittimedd()
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.
java.lang.Long getWaittimehh()
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.
java.lang.Long getWaittimemm()
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.
java.lang.String getTpname()
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.
java.lang.String getXtpname()
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'.
ICICSEnums.YesNoValue getSuppressUserData()
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 HIDETC.
java.lang.String getUserdata1()
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.
java.lang.String getUserdata2()
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.
java.lang.String getUserdata3()
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.
java.lang.String getBrexit()
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).
ICICSEnums.YesNoValue getRoutable()
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:
java.lang.String getOtstimeout()
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.
ICICSDefinitionReference<ITransactionDefinition> getCICSObjectReference()
getCICSObjectReference
in interface ICICSDefinition
getCICSObjectReference
in interface ICICSObject
getCICSObjectReference
in interface IDefinition
<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ITransactionDefinition> referenceAttribute)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |