com.ibm.cics.model
Interface IWorkload

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

public interface IWorkload
extends ICPSMManager

generated from CICS resourcetable WLMAWORK


Nested Class Summary
static class IWorkload.AlgorithmTypeValue
          Enumeration type for field ALGTYPE
static class IWorkload.AutomaticAffinityCreationValue
          Enumeration type for field AFFAUTO
static class IWorkload.DefaultAffinityLifetimeValue
          Enumeration type for field AFFLIFE
static class IWorkload.DefaultAffinityTypeValue
          Enumeration type for field AFFINITY
static class IWorkload.OptimizationStatusValue
          Enumeration type for field OWSTATE
static class IWorkload.SharedValue
          Enumeration type for field SHARED
static class IWorkload.WorkloadStatusValue
          Enumeration type for field STATUS
 
Method Summary
 java.lang.Long getAbendcrit()
          Getter for field ABENDCRIT
 java.lang.Long getAbendthresh()
          Getter for field ABENDTHRESH
 java.lang.Long getActiveRoutingRegions()
          Getter for field TORCNT
 java.lang.Long getActiveTargetRegions()
          Getter for field AORCNT
 IWorkload.AlgorithmTypeValue getAlgorithmType()
          Getter for field ALGTYPE
 IWorkload.AutomaticAffinityCreationValue getAutomaticAffinityCreation()
          Getter for field AFFAUTO
 IWorkload.DefaultAffinityLifetimeValue getDefaultAffinityLifetime()
          Getter for field AFFLIFE
 IWorkload.DefaultAffinityTypeValue getDefaultAffinityType()
          Getter for field AFFINITY
 java.lang.String getDefaultTargetScope()
          Getter for field AORSCOPE
 java.lang.String getDescription()
          Getter for field DESC
 java.lang.String getEventName()
          Getter for field EVENTNAME
 java.lang.String getName()
          Getter for field WORKLOAD
 IWorkload.OptimizationStatusValue getOptimizationStatus()
          Getter for field OWSTATE
 java.lang.String getOwningSystemID()
          Getter for field WRKLOWNER
 IWorkload.SharedValue getShared()
          Getter for field SHARED
 java.lang.Long getWaffcnt()
          Getter for field WAFFCNT
 java.lang.Long getWdefcnt()
          Getter for field WDEFCNT
 IWorkload.WorkloadStatusValue getWorkloadStatus()
          Getter for field STATUS
 java.lang.Long getWtgpcnt()
          Getter for field WTGPCNT
 java.lang.Long getWtrncnt()
          Getter for field WTRNCNT
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Method Detail

getName

java.lang.String getName()
Getter for field WORKLOAD

Name

The name of the workload. This is also the name of the installed workload specification definition.

Specified by:
getName in interface ICICSObject

getDefaultAffinityType

IWorkload.DefaultAffinityTypeValue getDefaultAffinityType()
Getter for field AFFINITY

Default affinity relation

The default affinity relation applied to transactions not associated with any installed transaction group. The affinity relation values are:


getDefaultAffinityLifetime

IWorkload.DefaultAffinityLifetimeValue getDefaultAffinityLifetime()
Getter for field AFFLIFE

Default 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:


getActiveRoutingRegions

java.lang.Long getActiveRoutingRegions()
Getter for field TORCNT

Active 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 AORCNT

Active target regions

The number of active CICS systems, identified as target region for the workload.


getDefaultTargetScope

java.lang.String getDefaultTargetScope()
Getter for field AORSCOPE

Default 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 DESC

Description

The description of the workload.


getWorkloadStatus

IWorkload.WorkloadStatusValue getWorkloadStatus()
Getter for field STATUS

Workload status

The status of the workload:

As long as a workload remains frozen: The cause of a lost connection could be the target or routing region, one of the CMASs that manage the workload or a connection between the CMASs. To determine why a workload is frozen: Determine which connection(s) were lost and take appropriate action to re-establish the connections.


getAlgorithmType

IWorkload.AlgorithmTypeValue getAlgorithmType()
Getter for field ALGTYPE

Default algorithm type

The algorithm to be applied to all transactions that are not associated with any installed transaction group:


getAbendcrit

java.lang.Long getAbendcrit()
Getter for field ABENDCRIT

Acceptable 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 ABENDTHRESH

Acceptable 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 EVENTNAME

Event 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 WRKLOWNER

Owning system ID

The CICS system ID of the CMAS that created the workload.


getAutomaticAffinityCreation

IWorkload.AutomaticAffinityCreationValue getAutomaticAffinityCreation()
Getter for field AFFAUTO

Automatic 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 SHARED

Shared status

Indicates whether the workload has been shared with a pre-CICS TS 1.3 CMAS. If it has installs of CICS BTS related definitions are inhibited.


getOptimizationStatus

IWorkload.OptimizationStatusValue getOptimizationStatus()
Getter for field OWSTATE

Optimization 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 WDEFCNT

Active workload definitions

The number of active workload definitions that are associated with the workload.


getWtrncnt

java.lang.Long getWtrncnt()
Getter for field WTRNCNT

Active dynamic transactions

The number of active dynamic transactions that are associated with the workload.


getWtgpcnt

java.lang.Long getWtgpcnt()
Getter for field WTGPCNT

Active transaction groups

The number of active transactions groups that are associated with the workload.


getWaffcnt

java.lang.Long getWaffcnt()
Getter for field WAFFCNT

Active transaction group affinities

The number of active transaction group affinities that are associated with the workload.



Copyright 2008-2009 IBM Corp. All Rights Reserved.