|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkloadTarget
generated from CICS resourcetable WLMAWAOR
Nested Class Summary | |
---|---|
static class |
IWorkloadTarget.ContactStatusValue
Enumeration type for field CON_STATUS |
static class |
IWorkloadTarget.EventsValue
Enumeration type for field EVENTS |
static class |
IWorkloadTarget.HealthDumpValue
Enumeration type for field HLTHDUMP |
static class |
IWorkloadTarget.HealthMaxtasksValue
Enumeration type for field HLTHMAXT |
static class |
IWorkloadTarget.HealthShortOnStorageValue
Enumeration type for field HLTHSOS |
static class |
IWorkloadTarget.HealthStallValue
Enumeration type for field HLTHSTALL |
static class |
IWorkloadTarget.HlthnrmValue
Enumeration type for field HLTHNRM |
static class |
IWorkloadTarget.OptimizationStatusValue
Enumeration type for field OWSTATE |
static class |
IWorkloadTarget.StatusValue
Enumeration type for field STATUS |
static class |
IWorkloadTarget.TaskLoadQueueModeValue
Enumeration type for field WLMQMODE |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
java.lang.Long |
getCfUpdateCount()
Getter for field CFUPDCNT |
IWorkloadTarget.ContactStatusValue |
getContactStatus()
Getter for field CON_STATUS |
java.lang.String |
getCpsmver()
Getter for field CPSMVER |
IWorkloadTarget.EventsValue |
getEvents()
Getter for field EVENTS |
IWorkloadTarget.HealthDumpValue |
getHealthDump()
Getter for field HLTHDUMP |
IWorkloadTarget.HealthMaxtasksValue |
getHealthMaxtasks()
Getter for field HLTHMAXT |
IWorkloadTarget.HealthShortOnStorageValue |
getHealthShortOnStorage()
Getter for field HLTHSOS |
IWorkloadTarget.HealthStallValue |
getHealthStall()
Getter for field HLTHSTALL |
IWorkloadTarget.HlthnrmValue |
getHlthnrm()
Getter for field HLTHNRM |
java.lang.Long |
getMaxtasks()
Getter for field MAXTASKS |
IWorkloadTarget.OptimizationStatusValue |
getOptimizationStatus()
Getter for field OWSTATE |
java.lang.Long |
getRoutingLoad()
Getter for field ROUTINGLOAD |
java.lang.Long |
getRoutingWeight()
Getter for field ROUTEWGHT |
java.lang.String |
getRsServerPoolId()
Getter for field RSPOOLID |
java.lang.Long |
getRsServerReadInterval()
Getter for field READRS |
java.lang.Long |
getRsServerUpdateFreq()
Getter for field UPDATERS |
IWorkloadTarget.StatusValue |
getStatus()
Getter for field STATUS |
java.lang.String |
getTargetRegion()
Getter for field AOR |
java.lang.Long |
getTaskCountIncrement()
Getter for field TASKINC |
java.lang.Long |
getTaskLoad()
Getter for field TASKLOAD |
java.lang.Long |
getTaskLoadHealthThreshold()
Getter for field WLMTHRSH |
IWorkloadTarget.TaskLoadQueueModeValue |
getTaskLoadQueueMode()
Getter for field WLMQMODE |
java.lang.String |
getWorkload()
Getter for field WORKLOAD |
java.lang.String |
getWorkloadOwner()
Getter for field WRKLOWNER |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType, getName, getObjectType |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
java.lang.String getWorkload()
Workload name
The name of the workload specification.
java.lang.String getTargetRegion()
Target region name
The name of an active CICS system, acting as a target region, to which the workload is associated.
IWorkloadTarget.StatusValue getStatus()
Target region status
The current status of the target region associated with the workload, as one of the following:
Input Values: ACTIVE | QUIESCE
IWorkloadTarget.ContactStatusValue getContactStatus()
Target region contact status
The status of the connection between the target region and the CMAS. Values are:
java.lang.String getWorkloadOwner()
System ID of workload owner
The 4-character CICS system ID of the CMAS that created the workload.
java.lang.Long getRsServerReadInterval()
RS server read interval
Within a workload running in optimized mode, this value specifies the minimum interval between refreshes of a target region status from a CICS CFDT Server. These refresh requests will be issued by a routing region that is evaluating this region as a possible target for a dynamic routing request.
The value range is from 0 to 2000, and represents units of milliseconds:
A low interval value means that the CFDT Server will be polled more often for a status update, than for a higher value. For workloads in QUEUE mode, this will result in a task load more evenly balanced across the CICS regions in the workload target scope (assuming all other health and link factors are equal) . However, the utilization of the RS server will be correspondingly increased, which may consequently result in a higher utilization of your z/OS Coupling Facility.
A value of 1000 represents a one second interval. The default value is 200 milliseconds
This value may be modified for this specific region using the MASs known to CICSplex views, or the CICS system definition views.
java.lang.Long getRsServerUpdateFreq()
RS Server update frequency
Within a workload running in optimized mode, this value specifies the frequency with which the CICS CFDT (RS) server will be called to modify the value of the task load within this target region.
The value range is from 0 to 25:
For example , with a MAXTASKS setting of 120, and with this attribute set to 20, the RS Server will be called to update the WLM load count when the regions task count changes between:
The RS Server would be updated when the task load increments or decrements across these boundaries.
If a value is specified that is at the lower end of the 1-25 scale, then that will cause an increase in the frequency of updates to the RS Server across the task load range. For workloads in QUEUE mode, this will result in a task load more evenly balanced across the CICS regions in the workload target scope (assuming all other health and link factors are equal) . However, the utilization of the RS server will be correspondingly increased, which may consequently result in a higher utilization of your z/OS Coupling Facility.
This value may be modified for this specific region using the MASs known to CICSplex views, or the CICS system definition views.
java.lang.Long getTaskLoadHealthThreshold()
Task load health threshold
This specifies a percentage threshold of the current region's task load, which is calculated by dividing the current task count by the maximum task count. When the load for a target region reaches this threshold, then WLM considers the region to be relatively unhealthy. This will cause higher link weights to be applied to the WLM routing algorithm when evaluating this region.
When a target scope covers local and remote regions relative to the router, then WLM will favour local targets over remote ones. The effect of this attribute is that when this load threshold in the local regions is achieved, then WLM will start to favour remote targets instead. When all targets in the scope achieve this load threshold, then WLM will revert to favouring local targets again.
The value range is from 1 to 100, and the default value is 60. This value is specified within the CICSPlex SM CICS System Definition object. If you want this value to be changed, you must modify the system definition for the current region and then restart it. You may change the value in an active CICS region by using the CICSPlex SM MAS object. When the region restarts it will revert to the value specified in the system definition.
If this value is set to 0, then the current region is not at a high enough level to support the use of this attribute. You will not be able to change it, and the WLM route decision process will ignore it.
Note: this value is nullified when applied to the routing factor of link neutral dynamic routing requests. This is because the link weight itself is ignored for the LNQUEUE and LNGOAL algorithms.
IWorkloadTarget.TaskLoadQueueModeValue getTaskLoadQueueMode()
Task load queue mode
This attribute specifies how the queued task load of a target CICS region is to be evaluated:
The default value is ALL. This value is specified within the CICSPlex SM CICS system definition object. If you want this value to be changed, you must modify the system definition for the current region and then restart it. You may change the value in an active CICS region by using the CICSPlex SM MAS object. When the region restarts it will revert to the value specified in the system definition.
java.lang.Long getTaskCountIncrement()
Task count increment value
This is the translation of the RS Server update frequency value to an actual task count value for the current target region. Each time the current task count reaches a boundary that is a factor of this value, then an update is sent to the RS server.
java.lang.Long getTaskLoad()
Task load percentage
This is the normalized task load for this target region. It is calculated from dividing the current task routing count by the MAXTASKS value for the region, and multiplying by 100.
IWorkloadTarget.OptimizationStatusValue getOptimizationStatus()
Optimization status
This field reports the status of the current target region for the optimized workload routing function.
The possible values are:
If the CMAS that your WUI is using is not connected to a Region Status (RS) server, the optimization status for remote regions will not be updated and defaults to INACTIVE. Where this situation occurs, either connect all reporting CMASs to the RS server or use the Active target regions view to check the optimization state.
IWorkloadTarget.HealthShortOnStorageValue getHealthShortOnStorage()
Short on storage
This field indicates the SOS status of this routing target at the current time. Note that a CICS region can change from being in and out of SOS status very rapidly.
IWorkloadTarget.HealthStallValue getHealthStall()
Region has stalled
This indicates whether the routing target is in a stall condition. If the region is stalled, use the Active task views to determine which tasks are suspended, and determine why. Note: Stall here means a task has been waiting for the same resource for a specific time.
IWorkloadTarget.HealthDumpValue getHealthDump()
Region is dumping
This indicates whether the routing target is currently issuing a transaction or system dump.
IWorkloadTarget.HealthMaxtasksValue getHealthMaxtasks()
Region is at MAXTASKS
This indicates whether the routing target is currently running at a task rate that has reached its maximum tasks threshold.
java.lang.Long getRoutingLoad()
Routing Load
This is the routing load used by WLM route decision making for the target region. Note that this will not match the real CICS task count at the time of this query.
For an ACTIVE System Optimized WLM routing region this will be the approximate task load in the target region, taking into account 'Task Count Increment Value', 'RS Server Bottom Tier' and 'RS Server Top Tier'. The accuracy of this value is also affected by the RS Read Interval and RS Update frequency settings.
For target regions that are not connected to a RS Server, and are therefore in a non-optimized WLM state, this value will appear to be less accurate, when compared to the actual task count. This is because this is the normalized routing load for this region. It should be noted that when running in a non-optimized WLM state, this value can exceed the MAX TASK value, without the MAX TASK flag being set on, and is correct behaviour as the MAX TASK indicator is related to the target region's health status taken from actual task counts.
It is possible that a region could be the target for multiple workloads and show different routing weight values. This is not abnormal behaviour - it is a symptom of the synchronization latencies within workload manager. Workload optimization will nullify this effect. The workload manager runtime processes will continue to execute normally in spite of this disparity in the load values. To suppress these observed load differences, try to ensure that all MASes and CMASes that participate in the workload have a connectable region status server available.
java.lang.Long getMaxtasks()
Maximum task count for region
This is the defined maximum number of active tasks that may concurrently execute in this routing target.
java.lang.Long getRoutingWeight()
WLM routing weight for region
This is the calculated routing weight for the current routing target according to a specified transaction name. This value will be combined with the link weight from a Router to determine an overall normalized routing weight for this CICS region. This value will be compared with the same value for other potential routing targets. Assuming no affinities are outstanding, then the target with the lowest routing weight will be chosen as the actual route target.
If the workload associated with this target region specifies that RTA MRM events should influence a route decision for certain transaction codes, then different transaction names will result in different routing weights because of the effects of outstanding RTA events.
Note: 2147483647 is a special value indicating that the target is quiesced.
Generally speaking, the Link weight is used to prefer faster connections over slower ones. Weighting is as follows;
java.lang.Long getCfUpdateCount()
Coupling Facility update count
This is the number of update calls that the RS Server has made to the z/OS Coupling Facility for this target region.
This value is reset to zero whenever the RS Server or the CICS region is started.
IWorkloadTarget.EventsValue getEvents()
RTA event active
This is the indicator of an outstanding RTA event for the current region, that is associated with the TRANGRP in the current workload which manages a specific transaction. This value may vary for each workload that targets the current region, and will cause corresponding variations of the routing weight for that region.
java.lang.String getRsServerPoolId()
RS server pool name
For sysplex optimized workloads, region status data is maintained within a coupling facility data table. That table will be contained within a CFDT pool identified by this attribute. For an optimized workload to activate, there must be an active Region Status server which manages data for the pool name identified here.
If your CICSplex identifiers are not unique within your sysplex, you must ensure that the RS server pool names are unique. If your Sysplex comprises unique CICSplex identifiers, then they may all share the same RS server pool.
This attribute is defined in the parent CICSplex definition of the current target region. The default name is DFHRSTAT. You may choose to employ an existing CFDT pool for containing your CICSplex data tables. If you do, be aware that the throughput of your optimized workloads may be impeded by any user application activity to the specified pool name. Likewise, any application throughput to the pool may be impacted by sysplex optimized workloads. It is recommended that a discrete RS server and pool name is defined for the optimized workload function.
IWorkloadTarget.HlthnrmValue getHlthnrm()
MAS non responsive
This field indicates the routing target is non responsive at the current time.
java.lang.String getCpsmver()
CICSPlex SM version
This is the CICSPlex SM version of the target region.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |