com.ibm.cics.model
Interface ICICSplexDefinition

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

public interface ICICSplexDefinition
extends ICPSMConfigurationDefinition

generated from CICS resourcetable CPLEXDEF


Nested Class Summary
static class ICICSplexDefinition.CommandSecurityCheckingValue
          Enumeration type for field SECCMDCHK
static class ICICSplexDefinition.DaylightSavingValue
          Enumeration type for field DAYLGHTSV
static class ICICSplexDefinition.ResourceSecurityCheckingValue
          Enumeration type for field SECRESCHK
static class ICICSplexDefinition.RSFacilityPopulationValue
          Enumeration type for field RODMPOP
static class ICICSplexDefinition.SecurityExemptionValue
          Enumeration type for field SECBYPASS
static class ICICSplexDefinition.StateValue
          Enumeration type for field STATE
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.IDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ICICSplexDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.Long getBotrsupd()
          Getter for field BOTRSUPD
 ICICSplexDefinitionReference getCICSObjectReference()
           
 java.lang.String getCicsplex()
          Getter for field CICSPLEX
 ICICSplexDefinition.CommandSecurityCheckingValue getCommandSecurityChecking()
          Getter for field SECCMDCHK
 ICICSplexDefinition.DaylightSavingValue getDaylightSaving()
          Getter for field DAYLGHTSV
 java.lang.String getDescription()
          Getter for field DESC
 java.lang.Long getInterval()
          Getter for field INTVL
 ICICSType<ICICSplexDefinition> getObjectType()
           
 java.lang.Long getReadrs()
          Getter for field READRS
 ICICSplexDefinition.ResourceSecurityCheckingValue getResourceSecurityChecking()
          Getter for field SECRESCHK
 ICICSplexDefinition.RSFacilityPopulationValue getRSFacilityPopulation()
          Getter for field RODMPOP
 java.lang.String getRspoolid()
          Getter for field RSPOOLID
 ICICSplexDefinition.SecurityExemptionValue getSecurityExemption()
          Getter for field SECBYPASS
 ICICSplexDefinition.StateValue getState()
          Getter for field STATE
 java.lang.Long getStatus()
          Getter for field STATUS
 java.lang.String getTimezone()
          Getter for field TMEZONE
 java.lang.Long getTimezoneOffset()
          Getter for field TMEZONEO
 java.lang.Long getToprsupd()
          Getter for field TOPRSUPD
 java.lang.Long getUpdaters()
          Getter for field UPDATERS
 
Methods inherited from interface com.ibm.cics.model.ICPSMConfigurationDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<ICICSplexDefinition> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface ICPSMConfigurationDefinition
Specified by:
getObjectType in interface IDefinition
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getCicsplex

java.lang.String getCicsplex()
Getter for field CICSPLEX

CICSplex name

The 1- to 8-character name for the CICSplex. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic.


getCommandSecurityChecking

ICICSplexDefinition.CommandSecurityCheckingValue getCommandSecurityChecking()
Getter for field SECCMDCHK

Simulated CICS-command security checking

Indicates whether CICSPlex SM security is used to simulate CICS command checking for the CICS systems associated with the CICSplex.

Input Values: YES | NO


getResourceSecurityChecking

ICICSplexDefinition.ResourceSecurityCheckingValue getResourceSecurityChecking()
Getter for field SECRESCHK

Simulated CICS-resource security checking

Indicates whether CICSPlex SM security is used to simulate CICS resource checking for the CICS systems associated with the CICSplex.

Input Values: YES | NO


getDescription

java.lang.String getDescription()
Getter for field DESC

Description

A description of the CICSplex.

Input Values: 1- to 58-character description


getInterval

java.lang.Long getInterval()
Getter for field INTVL

Monitor interval (minutes)

The number of minutes in the range 15-1440 after which counters holding monitoring data are reset to zero. The default is 480.

The value used must be evenly divisible into 1440. For example, 60, 120, 240, and so on. If the value entered is in the valid range, but is not evenly divisible into 1440, the number will be rounded up to the next legitimate value.


getSecurityExemption

ICICSplexDefinition.SecurityExemptionValue getSecurityExemption()
Getter for field SECBYPASS

Security checking exemption

Indicates whether CICSPlex SM is to check specific user IDs for exemption from CICS command and resource checking.

Input Values: YES | NO


getStatus

java.lang.Long getStatus()
Getter for field STATUS

Status of attempt to delete CICSplex

Status (deprecated).


getTimezoneOffset

java.lang.Long getTimezoneOffset()
Getter for field TMEZONEO

Time zone offset

A number of minutes, between 0 and 59, that are to be added to the specified time zone. This adjustment is used to resolve time references in areas that do not use a standard zone.


getTimezone

java.lang.String getTimezone()
Getter for field TMEZONE

Time zone

A code identifying the time zone that is associated with this CICSplex.


getDaylightSaving

ICICSplexDefinition.DaylightSavingValue getDaylightSaving()
Getter for field DAYLGHTSV

Daylight saving time

Indicates whether or not the specified time zone is currently recognizing daylight saving time.


getRSFacilityPopulation

ICICSplexDefinition.RSFacilityPopulationValue getRSFacilityPopulation()
Getter for field RODMPOP

Resource status facility population

Indicates whether the CICSplex is to be identified to and monitored by the resource status facility.


getState

ICICSplexDefinition.StateValue getState()
Getter for field STATE

State of CICSplex

The state of the CICSplex:

Active
The CICSplex is active.
Pending
The CICSplex is to be removed when bindings to all member CMASes have been removed.
Recreated
The CICSplex is being recreated.


getReadrs

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

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 a target region 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 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 UPDATERS

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

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 a regions task load increments or decrements across these boundaries.

If you specify a value 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 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 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.


getToprsupd

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

RS 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 MAXTASK 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 BOTRSUPD

RS 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 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 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.

Note: All routers and targets active in the CICSplex when this value is changed will be forced out of the optimized state until they are restarted. If the RSPOOLID is changed by mistake, changing it back to its original value will cause all routers and targets to resume their optimization state.


getCICSObjectReference

ICICSplexDefinitionReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject
Specified by:
getCICSObjectReference in interface ICPSMConfigurationDefinition
Specified by:
getCICSObjectReference in interface IDefinition

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ICICSplexDefinition> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



Copyright © 2008-2013 IBM Corp. All Rights Reserved.