Interface ICICSRegionDefinition

    • Method Detail

      • getChangeAgent

        ICICSRegionDefinition.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last modification agent

        The change agent identifier that made the last modification.

        • DREPAPI - Resource was last changed by a CICSPlex SM API command.
        • DREPBATCH - Changed by a CICSPlex SM utility.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getName

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

        CICS system definition name

        The 1- to 8-character name for the CICS system to be associated with the CICSplex identified as the context.

        Specified by:
        getName in interface ICICSObject
      • getDynroute

        ICICSRegionDefinition.DynrouteValue getDynroute()
        Getter for field DYNROUTE

        Target region active at startup

        Indicates whether or not this CICS system is to be active as a target region and accept work for the workload for which it is a target at CICS startup.

        • YES - The CICS system is to be an active target and accept work for the workload for which it is a target at CICS startup.
        • NO - The CICS system is not a target region, or the CICS system is to be quiesced and will not accept work for the workload for which it is a target at CICS startup.

        The Target region in active workload (EYUSTARTWLMAWAOR) view may be used to Activate or Quiesce target regions in a workload.

        A target region would normally have this option set to YES. A routing region may have this option set to YES, if it is also acting as a target region in the workload.

      • getRetention

        java.lang.Long getRetention()
        Getter for field RETENTION

        Time data is kept after monitoring stops (minutes)

        The number of minutes collected data is to be kept after resource monitoring stops. (Resource monitoring stops when the CICS system stops or when the MAS view command is used to stop resource monitoring for the CICS system.) The retention period can be:

        1 - 1440
        Collected data is to be kept the specified number of minutes.
        0
        Collected data is not to be kept.
        INHERIT
        The CICS system is to use the value specified with its associated monitor specification.
      • getCicssamp

        java.lang.Long getCicssamp()
        Getter for field CICSSAMP

        Sample interval for CICS region monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getGlblsamp

        java.lang.Long getGlblsamp()
        Getter for field GLBLSAMP

        Sample interval for global region monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getDbxsamp

        java.lang.Long getDbxsamp()
        Getter for field DBXSAMP

        Sample interval for DB2/DBCTL monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getConnsamp

        java.lang.Long getConnsamp()
        Getter for field CONNSAMP

        Sample interval for connection monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getFilesamp

        java.lang.Long getFilesamp()
        Getter for field FILESAMP

        Sample interval for file monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getJrnlsamp

        java.lang.Long getJrnlsamp()
        Getter for field JRNLSAMP

        Sample interval for journal monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getProgsamp

        java.lang.Long getProgsamp()
        Getter for field PROGSAMP

        Sample interval for program monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getTermsamp

        java.lang.Long getTermsamp()
        Getter for field TERMSAMP

        Sample interval for terminal monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getTdqsamp

        java.lang.Long getTdqsamp()
        Getter for field TDQSAMP

        Sample interval for TDQ monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getTransamp

        java.lang.Long getTransamp()
        Getter for field TRANSAMP

        Sample interval for transaction monitoring

        The number of seconds in the range 0 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of INHERIT means that the CICS system uses the value specified with its associated monitor specification.

      • getMonstatus

        ICICSRegionDefinition.MonstatusValue getMonstatus()
        Getter for field MONSTATUS

        Monitoring status

        Indicates whether resource monitoring is to be active when this CICS system is started. Specify:

        • YES - Resource monitoring is to be active. For this to occur, the CICS system must be associated with a monitor specification.
        • NO - Resource monitoring is not to be active.
        • INHERIT - Inherit the value specified with the monitor specification to which this CICS system is associated.
      • getRtastatus

        ICICSRegionDefinition.RtastatusValue getRtastatus()
        Getter for field RTASTATUS

        Real time analysis status

        Indicates whether or not the system availability monitoring (SAM) and MAS resource monitoring (MRM) components of real-time analysis are to be active when this CICS system is started.

        • YES - System availability monitoring and MAS resource monitoring are active.
        • NO - No RTA monitoring is active. If the MAS has just been initialized or has been updated to turn analysis on, NO is displayed until RTA is fully initialized.
        • SAM - System availability monitoring is active.
        • MRM - MAS resource monitoring is active.
        • N/A - The MAS is not connected to its CMAS (the MAS Status field shows INACTIVE).
      • getWlmstatus

        ICICSRegionDefinition.WlmstatusValue getWlmstatus()
        Getter for field WLMSTATUS

        Routing region active at startup

        Indicates whether or not this CICS system is to participate in its associated workload as a routing region when the CICS system is started. Options are:

        • YES - The CICS system is to join its associated workload as a routing region at CICS startup.
        • NO - The CICS system will not attempt to act as a routing region at CICS startup.

        Use the WLM specifications to CICS systems link (EYUSTARTLNKSWSCS) view, the WLM specifications to CICS system group links (EYUSTARTLNKSWSCG) view, or Workload management Map function to identify the associated workload. If the CICS system is not associated with a workload, it will not be activated as a routing region.

        A routing region would normally have this option set to YES. A target region must also have this option set to YES, if it is to receive requests using the CICS distributed routing model (DSRTPGM).

      • getSeccmdchk

        ICICSRegionDefinition.SeccmdchkValue getSeccmdchk()
        Getter for field SECCMDCHK

        Simulated CICS-command security checking status

        Indicates whether or not CICSPlex SM security checking is to simulate CICS command checking for this CICS system. Specify:

        • YES - Simulate CICS command checking for this CICS system.
        • NO - Do not simulate CICS command checking for this CICS system.
        • INHERIT - Inherit the value assigned to the CICSplex with which this CICS system is associated.
      • getSecreschk

        ICICSRegionDefinition.SecreschkValue getSecreschk()
        Getter for field SECRESCHK

        Simulated CICS-resource security checking status

        Indicates whether CICSPlex SM security checking is to simulate CICS resource checking for this CICS system. Specify:

        • YES - Simulate CICS resource checking for this CICS system.
        • NO - Do not simulate CICS resource checking for this CICS system.
        • INHERIT - Inherit the value assigned to the CICSplex with which this CICS system is associated.
      • getSecbypass

        ICICSRegionDefinition.SecbypassValue getSecbypass()
        Getter for field SECBYPASS

        Exemption from simulated security checks

        Indicates whether CICSPlex SM Exemption security is active for this CICS system. Exemption security allows simulated CICS security checks to be bypassed.

        • YES - Exemption security is active for this CICS system.
        • NO - Exemption security is not active for this CICS system.
        • INHERIT - Inherit the Security checking exemption value assigned to the CICSplex with which this CICS system is associated.
      • getSamsev

        ICICSRegionDefinition.SamsevValue getSamsev()
        Getter for field SAMSEV

        Severity for system availability monitoring event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getSossev

        ICICSRegionDefinition.SossevValue getSossev()
        Getter for field SOSSEV

        Severity for short-on-storage (SOS) event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getSdmsev

        ICICSRegionDefinition.SdmsevValue getSdmsev()
        Getter for field SDMSEV

        Severity for system dump event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getTdmsev

        ICICSRegionDefinition.TdmsevValue getTdmsev()
        Getter for field TDMSEV

        Severity for transaction dump event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getMxtsev

        ICICSRegionDefinition.MxtsevValue getMxtsev()
        Getter for field MXTSEV

        Severity for CICS-at-maximum-tasks event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getStlsev

        ICICSRegionDefinition.StlsevValue getStlsev()
        Getter for field STLSEV

        Severity for CICS-stalled event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getSamaction

        java.lang.String getSamaction()
        Getter for field SAMACTION

        Action for system availability monitoring event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getSosaction

        java.lang.String getSosaction()
        Getter for field SOSACTION

        Action for short on storage (SOS) event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getSdmaction

        java.lang.String getSdmaction()
        Getter for field SDMACTION

        Action for system dump event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getTdmaction

        java.lang.String getTdmaction()
        Getter for field TDMACTION

        Action for transaction dump event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getMxtaction

        java.lang.String getMxtaction()
        Getter for field MXTACTION

        Action for CICS-at-maximum-tasks event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getStlaction

        java.lang.String getStlaction()
        Getter for field STLACTION

        Action for CICS-stalled event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getPricmas

        java.lang.String getPricmas()
        Getter for field PRICMAS

        Primary CMAS name

        The name of the CMAS that is assigned the task of monitoring the availability of this CICS system. When the CICS system is part of a CICSplex that is managed by a single CMAS, specify the name of that CMAS. When multiple CMASs participate in managing the CICSplex, identify the CMAS to which the CICS system normally connects. Naming a CMAS does not prevent the CICS system from connecting to another CMAS when, for example, the primary CMAS is not available.

      • getActvtime

        java.lang.String getActvtime()
        Getter for field ACTVTIME

        Period definition name

        The name of the period definition that identifies the hours during which this CICS system is to be running.

      • getDescription

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

        Description

        A 1 to 58-character description of the CICS system definition.

      • getTmezoneo

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

        Time zone offset

        The adjustment value that is to be applied to the computed time. This value is used to resolve time references in areas that do not use a standard zone. Specify:

        • A value between 0 and 59 to identify the number of minutes to be added to the time for that time zone (for areas that do not use a standard time zone).
        • INHERIT - to inherit the time zone offset assigned to the CMAS to which this CICS system is connected when active. When this CICS system is inactive, the time zone offset is inherited from the CMAS assigned the task of monitoring the availability of this CICS system. INHERIT can only be specified if both the Time zone (TMEZONE) is INHERIT and daylight saving time (DAYLGHTSV) is INHERIT .
      • getTmezone

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

        Time zone

        The time zone in which this CICS system is located. Specify:

        • A time zone code letter in the range B through Z. For details of the time zone codes, see table 'Time zone codes' in the CICSPlex SM Administration manual.
        • INHERIT - to inherit the time zone assigned to the CMAS to which this CICS system is connected when active. When this CICS system is inactive, the time zone is inherited from the CMAS assigned the task of monitoring the availability of this CICS system. INHERIT can only be specified if both the Time zone offset (TMEZONEO) is INHERIT and daylight saving time (DAYLGHTSV) is INHERIT .
      • getDaylghtsv

        ICICSRegionDefinition.DaylghtsvValue getDaylghtsv()
        Getter for field DAYLGHTSV

        Daylight saving time in effect

        Indicates whether you are currently recognizing daylight saving time. Specify:

        • YES - Recognize daylight saving time.
        • NO - Do not recognize daylight saving time.
        • INHERIT - to inherit the value assigned to the CMAS to which this CICS system is connected when active. When this CICS system is inactive, the value is inherited from the CMAS assigned the task of monitoring the availability of this CICS system. INHERIT can only be specified if both the Time zone (TMEZONE) and Time zone offset (TMEZONEO) values are INHERIT.
      • getApplID

        java.lang.String getApplID()
        Getter for field APPLID

        Application ID

        The application ID of a CICS system is the name by which it is known in the intercommunication network; that is, its netname.

      • getAutoinst

        ICICSRegionDefinition.AutoinstValue getAutoinst()
        Getter for field AUTOINST

        Install BAS resources option

        Indicates whether resources associated with the system through a resource description should be automatically installed when the MAS connects to the CMAS:

        • ALWAYS - Install resources every time the MAS connects after a CICS startup.
        • COLDONLY - Install resources only when the MAS connects after a CICS INITIAL or COLD start.
        • NEVER - Resources should never be automatically installed in this CICS system.
        • WARMONLY - Install resources only when the MAS connects after a CICS warm start or emergency restart (AUTO).
        This option does not apply to resources generated by CICS bundles for applications or platforms.
      • getAinsfail

        ICICSRegionDefinition.AinsfailValue getAinsfail()
        Getter for field AINSFAIL

        BAS install failure action

        Indicates the action to be taken in the event of a BAS install failure. Options are:

        CONTINUE
        Continue installing other resources.
        NORMAL
        Shut down the CICS system normally.
        PROMPT
        Prompt the operator console for an action. The resource installation process in the CICS system is suspended until the operator responds, but all other MAS processing continues.
        TERMINATE
        Terminate the resource installation process. No more resources are installed. Any resources that were successfully installed are not removed.
        IMMEDIATE
        Shut down the CICS system immediately.
        This action is not performed when resources generated by CICS bundles for applications or platforms fail to install.
      • getSysID

        java.lang.String getSysID()
        Getter for field SYSID

        System ID

        The 4-character system ID of the CICS system. The value specified must match the CICS SYSIDNT SIT operand or override.

      • getNetworkID

        java.lang.String getNetworkID()
        Getter for field NETWORKID

        Network ID

        The network ID of the system. NETWORKID is used in combination with the APPLID option to ensure unique naming for connecting systems via IPIC. This is used for IPIC SYSLINK connections.

      • getHost

        java.lang.String getHost()
        Getter for field HOST

        Host name

        The 116-character host name of the system decimal IPv4 address (for example, 9.20.181.3), or its colon hexadecimal IPv6 address (for example ABCD:EF01::2345:6789). If an IPv4 address is entered as an IPv4 compatible IPv6 address (deprecated) or an IPv4 mapped IPv6 address (for example ::FFFF:1.2.3.4) it is converted to a standard IPv4 dotted decimal address. IPv6 addresses should not be used for CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases. This is used for IPIC SYSLINK connections.

      • getPort

        java.lang.Long getPort()
        Getter for field PORT

        Port number

        This is used by IPIC SYSLINK processing to override the TCPIPSERVICE port number on which inbound requests are received. Valid values are a decimal number in the range of 1 to 65535.

      • 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 target region status refreshes that a routing region would request from the CICS CFDT server. This value will be used to override the default interval value specified in CICSplex definition, which is the parent of this CICS system definition.

        The value range is from 0 to 2000 or INHERIT, and represents units of milliseconds:

        • A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
        • 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 millisecond time interval that must expire before a target region's status data can be refreshed.

        A low value mean that the router will refresh a target's status from the RS server more often 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 will be applied the next time this CICS region is started. If you want the change to be applied to a running instance of this CICS region, then it may be changed in-flight using the MAS views.

      • 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 within a target CICS region. This value will be used to override the default frequency value specified in CICSplex definition, which is the parent of this CICS system definition.

        The value range is from 0 to 25, or INHERIT:

        • A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
        • 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 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 will be applied the next time this CICS region is started. If you want the change to be applied to a running instance of this CICS region, then it may be changed in-flight using the MAS views.

      • getMpcmasid

        java.lang.String getMpcmasid()
        Getter for field MPCMASID

        Maintenance point CMAS ID

        This is an output only field, identifying the maintenance point CMAS for the CICSplex. It is required to enable the Hyperlinks on the UPDATERS and READRS attributes.

      • getContext

        java.lang.String getContext()
        Getter for field CONTEXT

        CSYSDEF context

        This is an output only field, identifying the CICSplex context for a query. It is required to enable the Hyperlinks on the UPDATERS and READRS attributes.

      • 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. This value will be used to override the default value specified in CICSplex definition, which is the parent of this CICS system definition.

        The value range is from 1 to 25, or INHERIT.

        • A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
        • Values between 1 and 25 are 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. Any change to this value will be applied at the next region startup.

      • 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, or INHERIT.

        • A value of INHERIT means assign the value that is specified for this attribute in the parent CICSplex definition (CPLEXDEF) object for this CICS region. This is the default setting for this attribute.
        • Values between 1 and 25 are applied as an arithmetic percentage to a region's MAXTASKS setting. The task count value from zero up to this value is deemed to be the task load bottom tier. If the task load in a region falls into this range, then it will be broadcast to the coupling facility for every change in the 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. Any change to this value will be applied at the next region startup.

      • getWlmthrsh

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

        Task load health threshold

        This attribute is used by CICSPlex SM Workload Manager. It 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. The value specified here will be applied the next time this CICS region is started.

        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.

      • getWlmqmode

        ICICSRegionDefinition.WlmqmodeValue getWlmqmode()
        Getter for field WLMQMODE

        Task load queue mode

        This attribute is used by CICSPlex SM Workload Manager. This value specifies how the queued task load of a target CICS region is to be evaluated:

        • MAXTASK - specifies that both active and MAXTASK queued tasks are to be included in the task load evaluation for the region.
        • ALL - specifies that the task load evaluation for the region will include active tasks, tasks queued for the MAXTASK limit and tasks that are queued because of a TRANCLASS limit.

        The default value is ALL. Any change to this value will be applied at the next region startup.

      • getWlmopten

        ICICSRegionDefinition.WlmoptenValue getWlmopten()
        Getter for field WLMOPTEN

        WLM optimization enablement

        This attribute controls the enablement of the optimized dynamic routing function.

        When set to ENABLED, the region will attempt to connect to the CICS Region Status server when the CICSplex SM workload management agent starts. If that connection is successful, then the region will be eligible to participate in optimized workload routing requests.

        If this attribute is set to DISABLED, then the region will not connect to the Region Status server when it starts, and optimized dynamic workload routing requests will be suppressed.

        The setting of this definition may be overridden at run time through the MAS views.

      • getNrmsev

        ICICSRegionDefinition.NrmsevValue getNrmsev()
        Getter for field NRMSEV

        Severity for Non-responsive-MAS event

        The severity level that is to be associated with the named condition. The options are:

        • VLS - Very low severe
        • LS - Low severe
        • LW - Low warning
        • HW - High warning
        • HS - High severe
        • VHS - Very high severe
        • NO - The condition is not to be monitored
        • INHERIT - Derive the severity from the analysis specification
        • N_A - The default severity level for this condition is to be used
        Note:

        Workload Manager (WLM) health is assessed independently of SAM and is not influenced by SAM settings.

      • getNrmaction

        java.lang.String getNrmaction()
        Getter for field NRMACTION

        Action for Non-responsive-MAS event

        The name of the action definition to be used when generating a notification about the named condition. Specify * to inherit the action definition from the analysis specification.

      • getCreateOrigin

        ICICSRegionDefinition.CreateOriginValue getCreateOrigin()
        Getter for field CREATEORIGIN

        Definition origin

        Identifies where the definition originated:

        • N_A - The definition has been created by a user or API program.
        • PLATFORM - The definition has been created during the installation of a platform.