Interface ICICSplex
-
- All Superinterfaces:
ICICSObject
,ICPSMManager
,com.ibm.cics.model.meta.ITypedObject
public interface ICICSplex extends ICPSMManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ICICSplex.AccessTypeValue
Enumeration type for field ACCESSTYPEstatic class
ICICSplex.CMASStatusValue
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 ICICSplex.AccessTypeValue
getAccessType()
Getter for field ACCESSTYPEjava.lang.Long
getBotrsupd()
Getter for field BOTRSUPDICICSplexReference
getCICSObjectReference()
java.lang.String
getCMASName()
Getter for field CMASNAMEICICSplex.CMASStatusValue
getCMASStatus()
Getter for field STATUSjava.lang.String
getCMASSystemID()
Getter for field SYSIDICICSEnums.YesNoValue
getMPStatus()
Getter for field MPSTATUSjava.lang.String
getName()
Getter for field PLEXNAMEICICSType<ICICSplex>
getObjectType()
java.lang.Long
getReadrs()
Getter for field READRSjava.lang.String
getRspoolid()
Getter for field RSPOOLIDjava.lang.Long
getToprsupd()
Getter for field TOPRSUPDjava.lang.String
getTransitCMAS()
Getter for field TRANSITCMASjava.lang.Long
getTransitCMASCount()
Getter for field TRANSITCNTjava.lang.Long
getUpdaters()
Getter for field UPDATERS-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICPSMManager
getCICSContainer
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ICICSplex> 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 PLEXNAMECICSplex
The name of the CICSplex.
- Specified by:
getName
in interfaceICICSObject
-
getCMASName
java.lang.String getCMASName()
Getter for field CMASNAMECMAS
The name of a CMAS associated with the CICSplex.
-
getTransitCMAS
java.lang.String getTransitCMAS()
Getter for field TRANSITCMASFirst transit CMAS
For CMASs with an access type of INDIRECT, the name of the transit CMAS through which the local CMAS communicates.
-
getCMASStatus
ICICSplex.CMASStatusValue getCMASStatus()
Getter for field STATUSCMAS status
The current status of a CMAS as known to the local CMAS. The status will be one of the following:
- ACTIVE - The CMAS is active and available to manage the CICSplex.
- CREATING - Contact with the CMAS is still being established; the CMAS is not yet available for work.
- INACTIVE - The CMAS is not available to manage the CICSplex. A CMAS is considered inactive if it shut down normally.
- LOSTCON - Contact with the CMAS has been lost; the true state of the CMAS is not known. Contact can be lost if the CMAS terminated abnormally or if the CMAS-to-CMAS link failed.
- N/A - The CMAS has never been active or has never made contact with the local CMAS.
-
getAccessType
ICICSplex.AccessTypeValue getAccessType()
Getter for field ACCESSTYPEType of access from this CMAS to local CMAS
The type of access that this CMAS has to the local CMAS, as one of the following:
- ADJACENT - The CMAS has a direct CMAS-to-CMAS link with the local CMAS.
- INDIRECT - The CMAS is connected to the local CMAS via one or more intermediate transit CMASs.
- LOCAL - The CMAS is the local CMAS, which means it is the current context.
- N_A - There is currently no connection between this CMAS and the local CMAS.
-
getMPStatus
ICICSEnums.YesNoValue getMPStatus()
Getter for field MPSTATUSCMAS maintenance point status
Indicates whether this CMAS is the maintenance point for the specified CICSplex.
-
getTransitCMASCount
java.lang.Long getTransitCMASCount()
Getter for field TRANSITCNTThe number of transit CMASs for indirect access
For CMASs with an access type of INDIRECT, the number of transit CMASs through which communications must pass before reaching the target CMAS.
-
getCMASSystemID
java.lang.String getCMASSystemID()
Getter for field SYSIDCMAS system ID
The 4-character system ID of the CICS system.
-
getReadrs
java.lang.Long getReadrs()
Getter for field READRSRS 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 a target region for a dynamic routing request.
The value range is from 0 to 2000, and represents units of milliseconds:
- A value of 0 means that a routing region will request a status update of a target region on every occasion that it examines that target region's status.
- Values between 1 and 2000 specify the minimum time interval that must expire before the status of a target region can be refreshed.
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 coupling facility.
A value of 1000 represents a one second interval. The default value is 200 milliseconds
The value specified 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.
-
getUpdaters
java.lang.Long getUpdaters()
Getter for field UPDATERSRS server update frequency
Within a workload running in optimized mode, this value indicates the frequency with which the CICS CFDT (RS) server will be called to modify the value of the task load within a target CICS region. This value will be the default frequency value for all CICS regions within the current CICSplex definition.
The value range is from 0 to 25:
- A value of 0 means that the RS server is not notified of any task load count changes, which disables the optimized workload function for regions within the scope of this CICSplex.
- Values between 1 and 25 are applied as an arithmetic percentage to a region's MAXTASKS setting. The resultant task count value is used as a numeric threshold to drive an update call to the RS server.
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:
- 23 and 24 tasks - (20%),
- 47 and 48 tasks - (40%),
- 71 and 72 tasks - (60%),
- 95 and 96 tasks - (80%),
- 119 and 120 tasks - (100%).
The RS server would be updated when a regions task load increments or decrements across these boundaries.
If the value reported 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 its 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 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.
-
getToprsupd
java.lang.Long getToprsupd()
Getter for field TOPRSUPDRS server top tier
For sysplex optimized workloads, this value is converted from a task load percentage to an actual task count. That count will be subtracted from the MAXTASKS value for the region to determine top tier task load range.
The value range is from 1 to 25. The value is applied as an 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 default value is 5%. You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.
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.
-
getBotrsupd
java.lang.Long getBotrsupd()
Getter for field BOTRSUPDRS server bottom tier
For sysplex optimized workloads, this value is converted from a task load percentage to an actual task count. That count will be used to define 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 default value is 1%. You should only change this value after giving consideration to the impact that the change may have on your workload and coupling facility throughput.
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.
-
getRspoolid
java.lang.String getRspoolid()
Getter for field RSPOOLIDRS 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 specified 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 specify the same RS server pool name.
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 poolname is defined for the optimized workload function.
-
getCICSObjectReference
ICICSplexReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMManager
-
-