Interface IWorkload
-
- All Superinterfaces:
ICICSObject
,ICPSMManager
,com.ibm.cics.model.meta.ITypedObject
public interface IWorkload extends ICPSMManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IWorkload.AlgorithmTypeValue
Enumeration type for field ALGTYPEstatic class
IWorkload.AutomaticAffinityCreationValue
Enumeration type for field AFFAUTOstatic class
IWorkload.DefaultAffinityLifetimeValue
Enumeration type for field AFFLIFEstatic class
IWorkload.DefaultAffinityTypeValue
Enumeration type for field AFFINITYstatic class
IWorkload.OptimizationStatusValue
Enumeration type for field OWSTATEstatic class
IWorkload.SharedValue
Enumeration type for field SHAREDstatic class
IWorkload.WorkloadStatusValue
Enumeration type for field STATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICPSMManager
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Long
getAbendcrit()
Getter for field ABENDCRITjava.lang.Long
getAbendthresh()
Getter for field ABENDTHRESHjava.lang.Long
getActiveRoutingRegions()
Getter for field TORCNTjava.lang.Long
getActiveTargetRegions()
Getter for field AORCNTIWorkload.AlgorithmTypeValue
getAlgorithmType()
Getter for field ALGTYPEIWorkload.AutomaticAffinityCreationValue
getAutomaticAffinityCreation()
Getter for field AFFAUTOIWorkloadReference
getCICSObjectReference()
IWorkload.DefaultAffinityLifetimeValue
getDefaultAffinityLifetime()
Getter for field AFFLIFEIWorkload.DefaultAffinityTypeValue
getDefaultAffinityType()
Getter for field AFFINITYjava.lang.String
getDefaultTargetScope()
Getter for field AORSCOPEjava.lang.String
getDescription()
Getter for field DESCjava.lang.String
getEventName()
Getter for field EVENTNAMEjava.lang.String
getName()
Getter for field WORKLOADICICSType<IWorkload>
getObjectType()
IWorkload.OptimizationStatusValue
getOptimizationStatus()
Getter for field OWSTATEjava.lang.String
getOwningSystemID()
Getter for field WRKLOWNERjava.lang.String
getReportingCMAS()
Getter for field RPTCMASIWorkload.SharedValue
getShared()
Getter for field SHAREDjava.lang.Long
getWaffcnt()
Getter for field WAFFCNTjava.lang.Long
getWdefcnt()
Getter for field WDEFCNTIWorkload.WorkloadStatusValue
getWorkloadStatus()
Getter for field STATUSjava.lang.Long
getWtgpcnt()
Getter for field WTGPCNTjava.lang.Long
getWtrncnt()
Getter for field WTRNCNT-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICPSMManager
getCICSContainer
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IWorkload> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMManager
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field WORKLOADName
The name of the workload. This is also the name of the installed workload specification definition.
- Specified by:
getName
in interfaceICICSObject
-
getDefaultAffinityType
IWorkload.DefaultAffinityTypeValue getDefaultAffinityType()
Getter for field AFFINITYDefault affinity relation
The default affinity relation applied to transactions not associated with any installed transaction group. The affinity relation values are:
- GLOBAL - All users at all terminals
- LUNAME - Terminal logical unit name
- USERID - User ID
- BAPPL - 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.
- NONE - No affinity relation was defined
-
getDefaultAffinityLifetime
IWorkload.DefaultAffinityLifetimeValue getDefaultAffinityLifetime()
Getter for field AFFLIFEDefault affinity lifetime
The default affinity lifetime used with the default affinity relation. This value is applied to transactions that are not associated with any installed transaction group. After the first instance of a transaction, subsequent instances of the transaction are run on the same target region:
- DELIMIT - Until the pseudoconversation mode is END
- LOGON - For the duration of the terminal session
- PCONV - For the duration of the pseudoconversation
- PERMANENT - For as long as the workload is active
- SIGNON - Until the terminal user signs off
- SYSTEM - Until the target region terminates
- ACTIVITY - For as long as the CICS BTS activity is active
- PROCESS - For as long as the CICS BTS process is active
- UOW - For as long as the unit-of-work is active
- NONE - No affinity lifetime was defined
-
getActiveRoutingRegions
java.lang.Long getActiveRoutingRegions()
Getter for field TORCNTActive routing regions
The number of active CICS systems, identified as routing regions, that are associated with the workload.
-
getActiveTargetRegions
java.lang.Long getActiveTargetRegions()
Getter for field AORCNTActive target regions
The number of active CICS systems, identified as target region for the workload.
-
getDefaultTargetScope
java.lang.String getDefaultTargetScope()
Getter for field AORSCOPEDefault target scope
The name of the CICS system or CICS system group that is to be the target for any dynamic transactions or programs not associated with a transaction or program group.
-
getDescription
java.lang.String getDescription()
Getter for field DESCDescription
The description of the workload.
-
getWorkloadStatus
IWorkload.WorkloadStatusValue getWorkloadStatus()
Getter for field STATUSWorkload status
The status of the workload:
- ACTIVE - All the target and routing region connections that this workload depends upon are available
- FROZEN - A target or routing region connection that this workload depends upon has been lost
- Transactions will continue to be routed according to any existing affinities
- New affinities can be created as long as they do not involve other CMASs. Global or permanent affinities, which require other CMASs to be notified, cannot be created
- Install and discard action commands are not allowed for any aspect of the workload
- Check the contact status in the Target region in active workload (WLMAWAOR) and Active workload routing regions (WLMAWTOR) views to determine which target or routing region is affected
- Check the MAS view to determine the status of the target or routing region
- Check the status of all connections for the target or routing region
-
getAlgorithmType
IWorkload.AlgorithmTypeValue getAlgorithmType()
Getter for field ALGTYPEDefault algorithm type
The algorithm to be applied to all transactions that are not associated with any installed transaction group:
-
QUEUE - Routes transactions to the target region that has the lowest routing weight at the time of the routing evaluation. The routing weight of a target region is a combination of factors that include:
- The current task load
- The current target health state
- The link speed from the router to the target
- The probability of transaction abend at the target
- The effect of any outstanding RTA events at the target
-
LNQUEUE - Routes transactions to the target region that has the lowest routing weight at the time of the routing evaluation. The routing weight of a target region is a combination of factors that include:
- The current task load
- The current target health state
- The effect of any outstanding RTA events at the target
- The probability of transaction abend at the target
Note - The link speed from the router to the target is not factored into the routing weight calculation for the LNQUEUE algorithm
-
GOAL - Routes transactions to the target region which is best able to meet the transaction's average response time goal, as predefined using z/OS Workload Manager.
-
If a specific target region cannot be resolved from the evaluated GOAL set, then the QUEUE algorithm is applied to the remaining target set.
-
-
LNGOAL - Routes transactions to the target region which is best able to meet the transaction's average response time goal, as predefined using z/OS Workload Manager.
-
If a specific target region cannot be resolved from the evaluated GOAL set, then the LNQUEUE algorithm is applied to the remaining target set.
-
-
-
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.
A value of 0 means WLM is not calculating abend probabilities for the workload.
-
getAbendthresh
java.lang.Long getAbendthresh()
Getter for field ABENDTHRESHAcceptable target region load level
The abend probability for a transaction associated with the default transaction group that should cause a target region's load level to be doubled.
A value of 0 means WLM is not calculating abend loads for the workload.
-
getEventName
java.lang.String getEventName()
Getter for field EVENTNAMEEvent name
The name of a real-time analysis event that will affect the routing of transactions in this workload. If a real-time analysis event is generated, WLM uses the information as part of the target selection criteria.
An event can optionally be associated with a workload when the workload specification is created. If this field is blank, no event is associated with the workload.
The name of an event is the same as an installed real-time analysis definition (RTADEF) or status definition (STATDEF)
-
getOwningSystemID
java.lang.String getOwningSystemID()
Getter for field WRKLOWNEROwning system ID
The CICS system ID of the CMAS that created the workload.
-
getAutomaticAffinityCreation
IWorkload.AutomaticAffinityCreationValue getAutomaticAffinityCreation()
Getter for field AFFAUTOAutomatic affinity creation
Indicates whether CICSPlex SM is to automatically create an affinity relationship for transactions that are not associated with any installed 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.
-
getShared
IWorkload.SharedValue getShared()
Getter for field SHAREDShared status
Indicates whether the workload has been shared with a back level CMAS which does not support the installation of CICS BTS related definitions.
-
getOptimizationStatus
IWorkload.OptimizationStatusValue getOptimizationStatus()
Getter for field OWSTATEOptimization status
This field reports the sysplex optimization status of the current workload. The value is an amalgamation of all of the workload router optimization statuses, and all of the workload target optimization statuses.
The possible values are:
- ACTIVE
- All targets and routers in the workload are executing in optimized workload state.
- PARTIAL
- At least one target and one router are executing in optimized workload mode. Use the Active routing regions and Active target regions hyperlinks to determine which regions are not running in an optimized state.
- INACTIVE
- The workload is not running in an optimized state, for one or more of the following
reasons:
- No routing regions in the workload are running in an optimized state
- No target regions in the workload are running in an optimized state
- No regions in the workload are running in an optimized state
- The optimised workload routing function is DISABLED for the current target region
- The workload was designated as being non optimized by specifying a value of 0 for the RS server update frequency on the CICSplex definition or CICS system definition for this workload.
-
getWdefcnt
java.lang.Long getWdefcnt()
Getter for field WDEFCNTActive workload definitions
The number of active workload definitions that are associated with the workload.
-
getWtrncnt
java.lang.Long getWtrncnt()
Getter for field WTRNCNTActive dynamic transactions
The number of active dynamic transactions that are associated with the workload.
-
getWtgpcnt
java.lang.Long getWtgpcnt()
Getter for field WTGPCNTActive transaction groups
The number of active transactions groups that are associated with the workload.
-
getWaffcnt
java.lang.Long getWaffcnt()
Getter for field WAFFCNTActive transaction group affinities
The number of active transaction group affinities that are associated with the workload.
-
getReportingCMAS
java.lang.String getReportingCMAS()
Getter for field RPTCMASReporting CMAS
The name of the CMAS that provided the information in this record.
If the GET operation optional parameter EXPLODE is not specified or is specified as NO, then this attribute will be set to blanks and only one record will be returned for the workload.
If the GET operation optional parameter EXPLODE is specified as YES, then this attribute will be set with the name of the CMAS that provided the information in this record. A separate record will be returned for the workload from each CMAS that manages the workload.
When the IBM distributed WUI menus and views are used to request the WLMAWORK tabular view, the EXPLODE parameter will be set to YES.
-
getCICSObjectReference
IWorkloadReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMManager
-
-