Interface IWorkloadSpecification
-
- All Superinterfaces:
ICICSObject,ICPSMDefinition,IDefinition,com.ibm.cics.model.meta.ITypedObject
public interface IWorkloadSpecification extends ICPSMDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceIWorkloadSpecification.AbendcritValueLong constants interface for field ABENDCRITstatic interfaceIWorkloadSpecification.AbendthreshValueLong constants interface for field ABENDTHRESHstatic classIWorkloadSpecification.AffinityLifetimeValueEnumeration type for field AFFLIFEstatic classIWorkloadSpecification.AlgorithmTypeValueEnumeration type for field ALGTYPEstatic classIWorkloadSpecification.AutomaticAffinityCreationValueEnumeration type for field AFFAUTOstatic classIWorkloadSpecification.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIWorkloadSpecification.DefaultAffinityValueEnumeration type for field AFFINITYstatic classIWorkloadSpecification.MatchValueEnumeration type for field MATCH
-
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<IWorkloadSpecification> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfaceICPSMDefinition- Specified by:
getObjectTypein interfaceIDefinition- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IWorkloadSpecification.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 workload specification (which is also the name of the workload).
- Specified by:
getNamein interfaceICICSObject
-
getTargetScope
java.lang.String getTargetScope()
Getter for field AORSCOPEDefault target scope
The name of the CICS system or CICS system group that is to be the target for any transactions not associated with an installed transaction group.
-
getDefaultAffinity
IWorkloadSpecification.DefaultAffinityValue getDefaultAffinity()
Getter for field AFFINITYDefault affinity relationship
The default affinity relationship to be used for transactions that are not associated with any installed 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 relationship 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. For a list of valid affinity relationship and lifetime combinations, see 'Relations and Lifetimes' in the CICS TS documentation.
-
getAffinityLifetime
IWorkloadSpecification.AffinityLifetimeValue getAffinityLifetime()
Getter for field AFFLIFEDefault affinity lifetime
The default affinity lifetime to be used with the default affinity relationship. This value is used for transactions that are not associated with any installed 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 pseudoconversation.
- 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 Relationship field are closely related. If you update this value, make sure an appropriate affinity relation value is also specified. For a list of valid affinity relationship and lifetime combinations, see 'Relations and Lifetimes' in the CICS TS documentation.
-
getMatch
IWorkloadSpecification.MatchValue getMatch()
Getter for field MATCHPrimary search criterion
Identifies whether the user name (USERID) or the logical unit name (LUNAME) is used as the primary search criteria for transactions that are not associated with an installed transaction group.
-
getAlgorithmType
IWorkloadSpecification.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 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 - 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 MVS 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 MVS workload management class
- LNGOAL - 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 MVS 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 MVS workload management class
- QUEUE - Route the transaction to the target region with best combination of:
-
getDescription
java.lang.String getDescription()
Getter for field DESCDescription
A description of the workload specification.
-
getEventName
java.lang.String getEventName()
Getter for field EVENTNAMERTA event
The name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect transactions using the default transaction group for this workload specification. 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 default transaction group.
-
getAbendcrit
java.lang.Long getAbendcrit()
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.
-
getAbendthresh
java.lang.Long getAbendthresh()
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.
-
getAutomaticAffinityCreation
IWorkloadSpecification.AutomaticAffinityCreationValue getAutomaticAffinityCreation()
Getter for field AFFAUTOAutomatic affinity creation option
Indicates whether CICSPlex SM is to automatically create an affinity relationship for transactions that are not associated with a 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.
-
getRegionGroupDefinitionReference
ICICSRegionGroupDefinitionReference getRegionGroupDefinitionReference()
-
getRegionDefinitionReference
ICICSRegionDefinitionReference getRegionDefinitionReference()
-
getFromWLMSpecificationsToSystemGroups
ICICSObjectSet<IWLMSpecificationsToSystemGroup> getFromWLMSpecificationsToSystemGroups()
-
getFromWLMSpecificationsToSystems
ICICSObjectSet<IWLMSpecificationsToSystem> getFromWLMSpecificationsToSystems()
-
getGroupsMembers
ICICSObjectSet<IWorkloadGroupInWorkloadSpecification> getGroupsMembers()
-
getCICSObjectReference
IWorkloadSpecificationReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICPSMDefinition- Specified by:
getCICSObjectReferencein interfaceIDefinition
-
-