Interface ITransactionGroup
-
- All Superinterfaces:
ICICSObject
,ICPSMDefinition
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface ITransactionGroup extends ICPSMDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ITransactionGroup.AbendLoadLevelValue
Long constants interface for field ABENDTHRESHstatic class
ITransactionGroup.AffinityLifetimeValue
Enumeration type for field AFFLIFEstatic class
ITransactionGroup.AffinityRelationValue
Enumeration type for field AFFINITYstatic class
ITransactionGroup.AlgorithmTypeValue
Enumeration type for field ALGTYPEstatic class
ITransactionGroup.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
ITransactionGroup.CreateAffinityValue
Enumeration type for field AFFAUTOstatic class
ITransactionGroup.MatchKeyValue
Enumeration type for field MATCHstatic class
ITransactionGroup.StatusValue
Enumeration type for field STATE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICPSMDefinition
COPYRIGHT
-
-
Method Summary
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICPSMDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ITransactionGroup> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMDefinition
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
ITransactionGroup.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- 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.
-
getName
java.lang.String getName()
Getter for field NAMEName
The name of the transaction group.
- Specified by:
getName
in interfaceICICSObject
-
getAffinityRelation
ITransactionGroup.AffinityRelationValue getAffinityRelation()
Getter for field AFFINITYAffinity relationship
The affinity relationship to be used when processing transactions in this transaction group. The affinity relationship values are:
- Global - All users at all terminals.
- Luname - Terminal logical unit name.
- Userid - User ID.
- Bappl - CICS BTS business application.
- Locked - LOCKED affinities can arise only between dynamically linked programs. A LOCKED affinity is created when a called program retains state data that is to be preserved after returning to its caller. Programs with this type of affinity are routed to the same target region until end of unit of work occurs. LOCKED can be used only for dynamic program link (DPL) requests with an associated affinity lifetime of UOW.
- N_a - No affinity relationship is defined
If this field is blank, no affinity relation was defined.
This field and the Affinity Lifetime field are closely related. If you update this value, make sure an appropriate lifetime value is also specified.
-
getAffinityLifetime
ITransactionGroup.AffinityLifetimeValue getAffinityLifetime()
Getter for field AFFLIFEAffinity lifetime
The affinity lifetime to be used when processing transactions in this transaction group. The affinity lifetime values are:
- Delimit - Until the pseudoconversation mode is END.
- Logon - For the duration of the terminal session.
- Pconv - For the duration of the pseudo conversation.
- Permanent - As long as the workload is active.
- Signon - As long as the user session is active.
- System - As long as the AOR to which transactions are routed is active.
- Activity - As long as the CICS BTS activity is active.
- Process - As long as the CICS BTS process is active.
- Uow - For as long as the unit-of-work is active
- N_a - No affinity lifetime is defined
If this field is blank, no affinity lifetime was defined.
This field and the Affinity Relation field are closely related. If you update this value, make sure an appropriate affinity relation value is also specified.
-
getMatchKey
ITransactionGroup.MatchKeyValue getMatchKey()
Getter for field MATCHPrimary search criterion
Identifies whether the user name (USERID) or the logical unit name (LUNAME) is to be used as the primary search criteria for transactions associated with the transaction group.
-
getStatus
ITransactionGroup.StatusValue getStatus()
Getter for field STATETransaction group status
Indicates how an AOR is to be selected for transactions associated with the transaction group:
- ACTIVE - Selects an AOR from the AOR scope identified with the associated workload definition.
- DORMANT - Uses the AOR associated with the transaction when it was defined to CICS.
-
getDescription
java.lang.String getDescription()
Getter for field DESCDescription
A description of the transaction group.
-
getRtaEvent
java.lang.String getRtaEvent()
Getter for field EVENTNAMERTA event
The name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect transactions associated with this transaction group. If a real-time analysis event is generated by this definition, WLM uses the information to select the best routing for those transactions.
If this field is blank, no analysis or status definition is associated with the transaction group.
-
getAbendProbability
java.lang.Long getAbendProbability()
Getter for field ABENDCRITAcceptable level of abend probability
The abend probability for a transaction associated with the default transaction group that should cause a target region to be considered unhealthy.
-
getAbendLoadLevel
java.lang.Long getAbendLoadLevel()
Getter for field ABENDTHRESHAcceptable abend load threshold
The abend probability for a transaction associated with the default transaction group that should cause a target region's load level to be doubled.
-
getCreateAffinity
ITransactionGroup.CreateAffinityValue getCreateAffinity()
Getter for field AFFAUTOAutomatic affinity creation
Indicates whether CICSPlex SM is to automatically create an affinity relationship for transactions associated with the transaction group.
- YES - An affinity is created using the values in the Affinity Relation and Affinity Lifetime fields.
- NO - An affinity is not automatically created (but can be created by a customized version of the dynamic routing program EYU9WRAM).
- N/A - There are no values in the Affinity Relation and Affinity Lifetime fields, therefore, no affinity is created.
-
getAlgorithmType
ITransactionGroup.AlgorithmTypeValue getAlgorithmType()
Getter for field ALGTYPEAlgorithm type
The algorithm to be used when selecting the best target region in the Target Scope to which a transaction in the current transaction group should be routed. Valid options are:
- QUEUE - Route the transaction to the target region with best combination of:
- Health (MaxTask, Short-on-storage, Dumping, Stalled)
- Task queue depth (or load)
- Link speed from the routing region
- Abend probability, when calculated
- RTA event impact, when defined
- LNQUEUE - (Link Neutral Queue) Route the transaction to the target region with
best combination of:
- Health (MaxTask, Short-on-storage, Dumping, Stalled)
- Task queue depth (or load)
- Abend probability, when calculated
- RTA event impact, when defined
- GOAL - Route the transaction to the target region that:
- Is the most likely to allow the transaction to meet the response time goal set for it and
other transactions in its z/OS workload management class
- When a specific target cannot be identified, apply the QUEUE algorithm to the remaining set of target regions
- Is the most likely to allow the transaction to meet the response time goal set for it and
other transactions in its z/OS workload management class
- LNGOAL - (Link Neutral Goal) Route the transaction to the target region that:
- Is the most likely to allow the transaction to meet the response time goal set for it and
other transactions in its z/OS workload management class
- When a specific target cannot be identified, apply the LNQUEUE algorithm to the remaining set of target regions
- Is the most likely to allow the transaction to meet the response time goal set for it and
other transactions in its z/OS workload management class
- INHERIT - Use the algorithm type specified in the WLM specification (WLMSPEC) to which this transaction group is associated.
- QUEUE - Route the transaction to the target region with best combination of:
-
getTransactionsInGroup
ICICSObjectSet<ITransactionGroupEntry> getTransactionsInGroup()
-
getFromWorkloadDefinitions
ICICSObjectSet<IWorkloadDefinition> getFromWorkloadDefinitions()
-
getCICSObjectReference
ITransactionGroupReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMDefinition
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-