CICS system definitions - CSYSDEF

The CICS system definitions (CSYSDEF) views display a CPSM topology definition that describes a CICS system to be managed as part of a CICSPlex.

Supplied views

To access from the main menu, click:

Administration views > CICS system links and related resources > CICS system definitions

Table 1. Views in the supplied **CICS system definitions** (CSYSDEF) view set
View	Notes
CICS system definitions EYUSTARTCSYSDEF.ADDTOGRP	Add one or more CICS system definitions to a CICS system group.
CICS system definitions EYUSTARTCSYSDEF.CREATE	Create a CICS system definition and add it to the data repository.
CICS system definitions EYUSTARTCSYSDEF.DETAILED	Detailed information about a selected CICS system definition.
CICS system definitions EYUSTARTCSYSDEF.REMOVE	Remove a CICS system definition from the data repository. Note: If the CICS system definition name is specified as a SCOPE in a BAS definition, the REMOVE will fail, with an indication that the record is in use.
CICS system definitions EYUSTARTCSYSDEF.TABULAR	Tabular information about all CICS system definitions for the CICSplex identified as the context.

Actions

Table 2. Actions available for CSYSDEF views
Action	Description
ADDTOGRP	Add one or more CICS system definitions to a CICS system group.
CREATE	Create a CICS system definition and add it to the data repository.
REMOVE	Remove a CICS system definition from the data repository. Note: If the CICS system definition name is specified as a SCOPE in a BAS definition, the REMOVE will fail, with an indication that the record is in use.
UPDATE	Update a CICS system definition in the data repository.

Fields

Table 3. Fields in CSYSDEF views
Field	Attribute name	Description
Period definition name	ACTVTIME	The name of the period definition that identifies the hours during which this CICS system is to be running.
BAS install failure action	AINSFAIL	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.
Application ID	APPLID	The application ID of a CICS system is the name by which it is known in the intercommunication network; that is, its netname.
Install BAS resources option	AUTOINST	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.
RS server bottom tier	BOTRSUPD	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.
Last modification agent	CHANGEAGENT	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.
Last modification agent release	CHANGEAGREL	The CICS release level of the agent that made the last modification.
Last modification	CHANGETIME	The local time when the definition was last changed.
Last modification user ID	CHANGEUSRID	The user ID that made the last modification.
Sample interval for CICS region monitoring	CICSSAMP	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.
Sample interval for connection monitoring	CONNSAMP	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.
CSYSDEF context	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.
Definition origin	CREATEORIGIN	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.
Time created	CREATETIME	The local time when the definition was created.
Daylight saving time in effect	DAYLGHTSV	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.
Sample interval for DB2/DBCTRL monitoring	DBXSAMP	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.
Description	DESC	A 1 to 58-character description of the CICS system definition.
Description code page	DESCCODEPAGE	The code page of the description field.
Target region active at startup	DYNROUTE	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.
Sample interval for file monitoring	FILESAMP	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.
Sample interval for global region monitoring	GLBLSAMP	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.
Host name	HOST	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.
Sample interval for journal monitoring	JRNLSAMP	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.
Monitoring status	MONSTATUS	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.
Maintenance point CMAS ID	MPCMASID	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.
Action for CICS-at-maximum-tasks event	MXTACTION	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.
Severity for CICS-at-maximum-tasks event	MXTSEV	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.
CICS system definition name	NAME	The 1- to 8-character name for the CICS system to be associated with the CICSplex identified as the context.
Network ID	NETWORKID	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.
Action for Non-responsive-MAS event	NRMACTION	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.
Severity for Non-responsive-MAS event	NRMSEV	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.
Port number	PORT	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.
Primary CMAS name	PRICMAS	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.
Sample interval for program monitoring	PROGSAMP	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.
RS server read interval	READRS	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.
Time data is kept after monitoring stops (minutes)	RETENTION	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.
Real time analysis status	RTASTATUS	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).
Action for system availability monitoring event	SAMACTION	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.
Severity for system availability monitoring event	SAMSEV	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.
Action for system dump event	SDMACTION	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.
Severity for system dump event	SDMSEV	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.
Exemption from simulated security checks	SECBYPASS	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.
Simulated CICS-command security checking status	SECCMDCHK	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.
Simulated CICS-resource security checking status	SECRESCHK	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.
Action for short on storage (SOS) event	SOSACTION	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.
Severity for short-on-storage (SOS) event	SOSSEV	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.
Action for CICS-stalled event	STLACTION	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.
Severity for CICS-stalled event	STLSEV	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.
System ID	SYSID	The 4-character system ID of the CICS system. The value specified must match the CICS SYSIDNT SIT operand or override.
Action for transaction dump event	TDMACTION	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.
Severity for transaction dump event	TDMSEV	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.
Sample interval for TDQ monitoring	TDQSAMP	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.
Sample interval for terminal monitoring	TERMSAMP	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.
Time zone	TMEZONE	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 .
Time zone offset	TMEZONEO	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 .
RS server top tier	TOPRSUPD	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.
Sample interval for transaction monitoring	TRANSAMP	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.
RS server update frequency	UPDATERS	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.
WLM optimization enablement	WLMOPTEN	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.
Task load queue mode	WLMQMODE	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.
Routing region active at startup	WLMSTATUS	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).
Task load health threshold	WLMTHRSH	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.