com.ibm.cics.model
Interface IWorkloadTargetStatus

All Superinterfaces:
ICICSObject, ICPSMManager, com.ibm.cics.model.meta.ITypedObject

public interface IWorkloadTargetStatus
extends ICPSMManager

generated from CICS resourcetable WLMATARG


Nested Class Summary
static class IWorkloadTargetStatus.ContactStatusValue
          Enumeration type for field CON_STATUS
static class IWorkloadTargetStatus.HealthDumpValue
          Enumeration type for field HLTHDUMP
static class IWorkloadTargetStatus.HealthMasNonresponsiveValue
          Enumeration type for field HLTHNRM
static class IWorkloadTargetStatus.HealthMaxtasksValue
          Enumeration type for field HLTHMAXT
static class IWorkloadTargetStatus.HealthShortOnStorageValue
          Enumeration type for field HLTHSOS
static class IWorkloadTargetStatus.HealthStallValue
          Enumeration type for field HLTHSTALL
static class IWorkloadTargetStatus.OptimizationEnablementValue
          Enumeration type for field WLMOPTEN
static class IWorkloadTargetStatus.OptimizationStatusValue
          Enumeration type for field OWSTATE
static class IWorkloadTargetStatus.StatusValue
          Enumeration type for field STATUS
static class IWorkloadTargetStatus.TaskLoadQueueModeValue
          Enumeration type for field WLMQMODE
 
Method Summary
 java.lang.Long getCfreadct()
          Getter for field CFREADCT
 java.lang.Long getCfUpdateCount()
          Getter for field CFUPDCNT
 IWorkloadTargetStatus.ContactStatusValue getContactStatus()
          Getter for field CON_STATUS
 java.lang.String getCpsmver()
          Getter for field CPSMVER
 java.lang.Long getEvents()
          Getter for field EVENTS
 IWorkloadTargetStatus.HealthDumpValue getHealthDump()
          Getter for field HLTHDUMP
 IWorkloadTargetStatus.HealthMasNonresponsiveValue getHealthMasNonresponsive()
          Getter for field HLTHNRM
 IWorkloadTargetStatus.HealthMaxtasksValue getHealthMaxtasks()
          Getter for field HLTHMAXT
 IWorkloadTargetStatus.HealthShortOnStorageValue getHealthShortOnStorage()
          Getter for field HLTHSOS
 IWorkloadTargetStatus.HealthStallValue getHealthStall()
          Getter for field HLTHSTALL
 java.lang.Long getMaxtasks()
          Getter for field MAXTASKS
 IWorkloadTargetStatus.OptimizationEnablementValue getOptimizationEnablement()
          Getter for field WLMOPTEN
 IWorkloadTargetStatus.OptimizationStatusValue getOptimizationStatus()
          Getter for field OWSTATE
 java.lang.String getOwningCMAS()
          Getter for field OWNINGCMAS
 java.lang.String getReportingCMAS()
          Getter for field RPTINGCMAS
 java.lang.Long getRouteAbends()
          Getter for field RTABEND
 java.lang.Long getRouteCompletes()
          Getter for field RTCOMPLETE
 java.lang.Long getRouteErrors()
          Getter for field RTERROR
 java.lang.Long getRouteInitiates()
          Getter for field RTINITIATE
 java.lang.Long getRouteNotifies()
          Getter for field RTNOTIFY
 java.lang.Long getRouteSelections()
          Getter for field RTSELECT
 java.lang.Long getRouteTerminates()
          Getter for field RTTERMINATE
 java.lang.Long getRoutingLoad()
          Getter for field ROUTINGLOAD
 java.lang.Long getRoutingWeight()
          Getter for field ROUTEWGHT
 java.lang.String getRsPoolID()
          Getter for field RSPOOLID
 java.lang.Long getRsServerBottomTier()
          Getter for field BOTRSUPD
 java.lang.Long getRsServerReadInterval()
          Getter for field READRS
 java.lang.Long getRsServerTopTier()
          Getter for field TOPRSUPD
 java.lang.Long getRsServerUpdateFreq()
          Getter for field UPDATERS
 IWorkloadTargetStatus.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
 IWorkloadTargetStatus.TaskLoadQueueModeValue getTaskLoadQueueMode()
          Getter for field WLMQMODE
 java.lang.Long getWorkloadCount()
          Getter for field WRKLDCNT
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Method Detail

getTargetRegion

java.lang.String getTargetRegion()
Getter for field AOR

Target region name

The name of an active CICS system, acting as a WLM target region.


getStatus

IWorkloadTargetStatus.StatusValue getStatus()
Getter for field STATUS

Target region status

The current status of the target region associated with the workload, as one of the following:

Input Values: ACTIVE | QUIESCE


getContactStatus

IWorkloadTargetStatus.ContactStatusValue getContactStatus()
Getter for field CON_STATUS

Target region contact status

The status of the connection between the target region and the CMAS. Values are:


getOptimizationStatus

IWorkloadTargetStatus.OptimizationStatusValue getOptimizationStatus()
Getter for field OWSTATE

Optimization status

This field reports the status of the current target region for the optimized workload routing function.

The possible values are:

ACTIVE
This target region is executing in an optimized workload state.
INACTIVE
This region is capable of executing in an optimized workload state, however, it is not currently optimized for one or more of the following reasons:
  • The region has no connection to an RS server
  • The region is connected to an RS server, however, the server has not been able to connect to the z/OS coupling facility
  • The optimised workload routing function is DISABLED for the current target region facility
  • The RS server update frequency value for this region is 0, which means that the optimization capabilities for this region are not enabled
N_A
The target region is not configured to provide optimized workload management. Only non optimized WLM routing decisions can be made.

This value is set to INACTIVE if the reporting CMAS is not connected to a Region Status (RS) server.


getRoutingWeight

java.lang.Long getRoutingWeight()
Getter for field ROUTEWGHT

WLM routing weight for region

This is the calculated routing weight for the current routing target without accounting for outstanding RTA MRM events, router region link speeds and transaction abend probabilities. Only the transaction load and health state of the region are calculated into this value. The health state is a combination of the SOS, Dump, Stall and MAXTASK conditions. The transaction load is the value indicated by the 'Task load percentage' attribute. No workload associated parameters are included in this weight value. To determine routing weights for specific workloads, then use the corresponding attribute returned in the WLMAWAOR 'Target region in active workload' views.

When no affinities are applicable to a dynamic routing request, then the routing weights of all target regions in the routing scope are compared and the region with the lowest weight value will be the one selected. If several regions have the same lowest weight value, then one of that set is randomly selected as the routing target.

Note: 2147483647 is a special value indicating that the target is quiesced.


getWorkloadCount

java.lang.Long getWorkloadCount()
Getter for field WRKLDCNT

Workload count

This is a count of the workloads which have designated this region as a dynamic routing target.

The workload count is set to zero (0) if:


getEvents

java.lang.Long getEvents()
Getter for field EVENTS

RTA event count for target region

This is the count of all outstanding RTA events that are associated with the current region.

This value is set to zero (0) if the reporting CMAS is not the owning CMAS.


getTaskLoadQueueMode

IWorkloadTargetStatus.TaskLoadQueueModeValue getTaskLoadQueueMode()
Getter for field WLMQMODE

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.


getTaskLoad

java.lang.Long getTaskLoad()
Getter for field TASKLOAD

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.


getRouteSelections

java.lang.Long getRouteSelections()
Getter for field RTSELECT

Route selections

The number of times that the current region has been chosen as a routing target by route selection processing.

This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.


getRouteErrors

java.lang.Long getRouteErrors()
Getter for field RTERROR

Route errors

The number of times that the selection of the current region has caused a route error to occur. Route errors occur when CICSPlex SM has selected a target region, and CICS has experienced an error in routing the work to it. For example, the connection is out of service, or no sessions are immediately available for an LU 6.2 connection. CICSPlex SM will attempt to select another target when this occurs.

This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.


getRouteTerminates

java.lang.Long getRouteTerminates()
Getter for field RTTERMINATE

Route terminates

The number of times that route terminate has been driven for this region. Route terminate occurs when a transaction finishes on a target region.

This value is the total for all requests processed by routing regions (dynamic routing) and all requests processed by the target region (distributed routing) while they were connected to the reporting CMAS.


getRouteNotifies

java.lang.Long getRouteNotifies()
Getter for field RTNOTIFY

Route notifies

The number of times that route notify has been driven for this region. Route notify normally occurs when a static routing starts.

This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.


getRouteAbends

java.lang.Long getRouteAbends()
Getter for field RTABEND

Route abends

The number of times that route abend has been returned after selecting this region.

This value is the total for all requests processed by routing regions (dynamic routing) and all requests processed by the target region (distributed routing) while they were connected to the reporting CMAS.


getRouteInitiates

java.lang.Long getRouteInitiates()
Getter for field RTINITIATE

Route initiates

The number of times that routed transactions have been actually started on the target region.

This value is the total for all requests processed by the target region while it was connected to the reporting CMAS.


getRouteCompletes

java.lang.Long getRouteCompletes()
Getter for field RTCOMPLETE

Route completes

The number of times that route complete has been driven for this region. Route complete occurs after the transaction request is dispatched to the waiting queue of the target region.

This value is the total for all requests processed by routing regions while they were connected to the reporting CMAS.


getHealthShortOnStorage

IWorkloadTargetStatus.HealthShortOnStorageValue getHealthShortOnStorage()
Getter for field HLTHSOS

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.


getHealthStall

IWorkloadTargetStatus.HealthStallValue getHealthStall()
Getter for field HLTHSTALL

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.


getHealthDump

IWorkloadTargetStatus.HealthDumpValue getHealthDump()
Getter for field HLTHDUMP

Region is dumping

This indicates whether the routing target is currently issuing a transaction or system dump.


getHealthMaxtasks

IWorkloadTargetStatus.HealthMaxtasksValue getHealthMaxtasks()
Getter for field HLTHMAXT

Region is at MAXTASKS

This indicates whether the routing target is currently running at a task rate that has reached its maximum tasks threshold.


getRoutingLoad

java.lang.Long getRoutingLoad()
Getter for field ROUTINGLOAD

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.


getMaxtasks

java.lang.Long getMaxtasks()
Getter for field MAXTASKS

Maximum task count for region

This is the defined maximum number of active tasks that may concurrently execute in this routing target.


getCfUpdateCount

java.lang.Long getCfUpdateCount()
Getter for field CFUPDCNT

Coupling Facility update count

This is the number of update calls that the RS Server has made to the coupling facility for this target region.

This value is reset to zero whenever the RS Server or the CICS region is started.


getRsPoolID

java.lang.String getRsPoolID()
Getter for field RSPOOLID

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.


getOwningCMAS

java.lang.String getOwningCMAS()
Getter for field OWNINGCMAS

Owning CMAS name

The name of a CMAS that participates in the management of the target region.


getTaskCountIncrement

java.lang.Long getTaskCountIncrement()
Getter for field TASKINC

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.


getRsServerReadInterval

java.lang.Long getRsServerReadInterval()
Getter for field READRS

RS server read interval

Within a region 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 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.


getRsServerUpdateFreq

java.lang.Long getRsServerUpdateFreq()
Getter for field UPDATERS

RS Server update frequency

Within a region 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.


getTaskLoadHealthThreshold

java.lang.Long getTaskLoadHealthThreshold()
Getter for field WLMTHRSH

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.


getRsServerTopTier

java.lang.Long getRsServerTopTier()
Getter for field TOPRSUPD

RS server top tier

This is the arithmetic percentage to a region's MAXTASKS setting. The resultant task count value is subtracted from the region's MAXTASKS setting to establish a task load 'top tier'. If the task load in a region runs up to its MAXTASKS limit, then the task load must drop back below this value before the MAXTASKS state for the region is switched off and broadcast to the coupling facility.

The value shown here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.


getRsServerBottomTier

java.lang.Long getRsServerBottomTier()
Getter for field BOTRSUPD

RS server bottom tier

This is the bottom tier task load range (from zero up to this value).

The value range is from 1 to 25. When a region's task load falls within this range, then the task load will be broadcast to the coupling facility for every change in the task load. Once the load reaches this value, then the 'RS server update frequency' task rules will be activated.

The value shown here at the CICSplex level may be overridden at the CICS definition level to allow fine tuning of the value on an individual CICS region basis.


getOptimizationEnablement

IWorkloadTargetStatus.OptimizationEnablementValue getOptimizationEnablement()
Getter for field WLMOPTEN

Optimization enablement state

This field reports whether the current target region will support the optimized workload routing function.

The possible values are:

ENABLED
This target region will support the optimized workload routing requests.
DISABLED
This region will not allow optimized workload routing requests, and will not contact the Region Status server for querying or broadcasting the current region state.

This value may be modified for this specific region using the 'MASs known to CICSplex' views, or the 'CICS system definition' views.


getReportingCMAS

java.lang.String getReportingCMAS()
Getter for field RPTINGCMAS

Reporting CMAS name

The name of a CMAS that provided this record.


getHealthMasNonresponsive

IWorkloadTargetStatus.HealthMasNonresponsiveValue getHealthMasNonresponsive()
Getter for field HLTHNRM

MAS non responsive

This field indicates the routing target is non responsive at the current time.


getCpsmver

java.lang.String getCpsmver()
Getter for field CPSMVER

CICSPlex SM version

This is the CICSPlex SM version of the target region.


getCfreadct

java.lang.Long getCfreadct()
Getter for field CFREADCT

Coupling Facility read count

This is the number of read calls that have been made by routing regions to the z/OS Coupling Facility for this region's status.



Copyright 2008-2009 IBM Corp. All Rights Reserved.