Start of changeCreating workload management definitions using the end user interfaceEnd of change

This section contains descriptions of the EUI workload management views and their associated tasks.

DTRINGRP (Transactions in transaction groups)

To display information about the transactions associated with one or more transaction groups, issue the command:

   DTRINGRP [trangroup]

where trangroup is a specific or generic transaction group name. If you omit this parameter, the view, illustrated in Figure 12, includes information about all existing transaction groups within the current context.

Figure 12. The DTRINGRP view
 27FEB2005  18:29:11 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =DTRINGRP==========EYUPLX01=EYUPLX01=27FEB2005==18:29:11=CPSM==========6===
 CMD Trangrp  Trans    PCONV
 --- Name---- Name---- Mode----
     EYUTRG01 ETVP
     EYUTRG05 ETD1
     EYUTRG05 ETD2
     EYUTRG05 ETD3
     EYUTRG06 ETL1     START
     EYUTRG06 ETL2     END
 

Action commands

Table 6 summarizes the action commands you can use with the DTRINGRP view.

Table 6. DTRINGRP view action commands
Primary command Line command Description
n/a MAP Display a visual map of workload management definitions using the specified transaction group as a starting point.
n/a REM Remove a transaction from a transaction group.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.

Hyperlink fields

There are no hyperlink fields on the DTRINGRP view.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions

TRANGRP (Transaction groups)

A transaction group is an association of logically similar transactions. The similarity may be based on affinity requirements, common shared processing requirements, or any other user-determined characteristic.

Examples of how to use this view can be found in:

By including transaction groups as part of a workload definition, you can identify one or more transactions that are to be routed to a specific set of target regions. For example, suppose you want to route only occurrences of the transaction PAY that are initiated from certain terminals to a target region in the CICS® system group EYUCSG99. To do this, create a transaction group that contains the transaction identifier PAY and indicates the order in which the user and terminal names associated with that transaction are to be evaluated. Then associate the transaction group with a workload definition, where the workload definition identifies EYUCSG99 as the target region scope.

Any transaction may be identified in a transaction group, but CICSPlex® SM routes only eligible transactions. The conditions that need to be fulfilled for a transaction to be eligible for dynamic routing are in CICS Intercommunication Guide.

Transactions scheduled as a result of automatic transaction initiation (ATI) and transactions defined as static are routed to the target region identified in their resource definitions.

Default transaction group

Any transaction that is not explicitly associated with a user-defined transaction group is routed according to the default transaction group. The default transaction group ($$DTGA$$) is based on the attributes of the workload specification that is associated with the CICS system. If the default transaction group is not associated with any workload definitions, the names of the terminal and user associated with such a transaction are not evaluated.

To display information about existing transaction groups, issue the command:

   TRANGRP [trangroup]

where trangroup is a specific or generic transaction group name. If you omit this parameter, the view, illustrated in Figure 13, includes information about all existing transaction groups within the current context.

Figure 13. The TRANGRP view
 27FEB2005  21:41:53 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
 >W1 =TRANGRP===========EYUPLX01=EYUPLX01=27FEB2005==21:41:53=CPSM==========3===
 CMD Trangrp  Affinity Affinity  Cre Match   State    Event    Description
 --- Name---- Relation Lifetime- Aff Key---- -------- Name---- -----------------
     EYUTRG01                    NO  USERID  ACTIVE            SSet - Related to
     EYUTRG05                    NO  USERID  ACTIVE   EYURTD20 SSet - Applicatio
     EYUTRG06 USERID   PCONV     NO  USERID  ACTIVE            SSet - Existing a
 
 

Action commands

Table 7 summarizes the action commands you can use with the TRANGRP view.

Table 7. TRANGRP view action commands
Primary command Line command Description
n/a ADD Add a transaction to a transaction group, as described in topic Adding a transaction to a transaction group.
n/a BRO Browse a transaction group definition in the data repository.

The format of the resulting panel is similar to that shown in Figure 14. The panel fields are not modifiable.

CREate CRE Create a transaction group definition and add it to the data repository, as described in Creating a transaction group.

When you use the primary command CREate, some fields in the new view may contain values supplied by CICSPlex SM; you may change these values. When you enter the line command CRE next to the name of a transaction group definition, fields in the new view contain values to be modelled (from the existing transaction group definition).

n/a MAP Display a visual map of workload management definitions using the specified transaction group as a starting point.
n/a REM Remove a transaction group definition from the data repository.
Note:
Removing a transaction group causes all transactions associated with it to be removed also.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update a transaction group definition in the data repository.

The format of the resulting input panel is similar to that shown in Figure 14. You can change the contents of any field in the panel except Trangroup Name.

Hyperlink fields

Table 8 shows the hyperlink field on the TRANGRP view.

Table 8. TRANGRP view hyperlink fields
Hyperlink field View displayed Description
Trangrp Name DTRINGRP Detailed information about the transactions comprising the designated transaction group.

Creating a transaction group

Figure 14 shows the format of the panel produced when you use the create primary (CREate) or line (CRE) action command from the TRANGRP view.

Figure 14. Creating a transaction group
 ---------------------- Create Trangroup for EYUPLX01 --------------------------
 COMMAND  ===>
 
  Trangroup name    ===>
  Description       ===> SSet - Related transactions
 
  Status            ===> ACTIVE        Transaction Group Status
                                   (ACTIVE,DORMANT)
  Match Key         ===> USERID        Primary WLMDEF search criterion
                                   (USERID,LUNAME)
  Affinity Relation ===>               Optional affinity relation may be:
                                   (USERID,LUNAME,GLOBAL,BAPPL)
  Affinity Lifetime ===>               Optional affinity lifetime  may be:
                                   (SIGNON,LOGON,PCONV,DELIMIT,SYSTEM,PERMANENT,
                                    ACTIVITY,PROCESS)
  Create Affinity   ===>               Create Auto Affinity (YES, NO, N/A)
  Event Name        ===>               RTADEF/STATDEF or generic
 
  Abend Health      ===> 0             Target ABEND Health Factor (0 - 99)
  Abend Load        ===> 0             Target ABEND Load Factor (0 - 99)
Press Enter to create Trangroup.
Type END or CANCEL to cancel without creating.

Provide the following information, as appropriate:

Trangroup Name
Specify a 1- to 8-character name for the transaction group. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic.
Description
(Optional.) Specify a 1- to 30-character description of the transaction group.
Status
Specify whether the affinity relation and lifetime values are to be used when processing a transaction associated with this transaction group:
ACTIVE
Start of changeSelect a target region from the target region scope identified with the associated workload definition.

If the AORSCOPE specified in a WLMDEF is to be used for route selection, the TRANGRP status must be ACTIVE.

End of change
DORMANT
Start of changeRecognize the affinity settings only when the lifetime is pseudoconversation (PCONV). Otherwise, do not recognize the affinity relation and lifetime settings.

If a TRANGRP with no affinity defined was defined as DORMANT instead of ACTIVE, the AORSCOPE defined to the WLMDEF will not be used for routing selecion. The transasction will be routed to the SYSID defined in the REMOTESYSTEM of CICS TRANSACTION definition

End of change
Match Key
Designate whether a user name (USERID) or logical unit name (LUNAME) is to be used as the search criteria for the transaction group. This field is ignored if the associated workload definition specifies separation by process type rather than by luname and user id.
Note:
The specific or generic user and terminal names that are to be used as the search criteria are defined as part of the workload definition to which this transaction group is associated.
Affinity Relation
(Optional.) Indicate the affinity relation that is to be used when processing the transactions associated with this transaction group. Specify:
USERID
Base transaction affinity on the user ID.
LUNAME
Base transaction affinity on the terminal logical unit name.
GLOBAL
Base transaction affinity on all users at all terminals.
BAPPL
Base transaction affinity on the CICS BTS application.
If you do not specify a value, no affinity relation is recognized for transactions associated with this transaction group. All dynamic transactions in the group that are initiated from any routing region by any user can be routed to any CICS system associated with the target scope.
Affinity Lifetime
(Required when you specify a value in the Affinity Relation field.) Indicate the affinity lifetime to be used when processing transactions associated with this transaction group. Specify:
DELIMIT
Maintain transaction affinity until a transaction with a pseudoconversation mode of END is encountered.
LOGON
Maintain transaction affinity for the duration of the terminal session.
PCONV
Maintain transaction affinity for the duration of the pseudoconversation. That is, as long as each transaction ends with an EXEC CICS RETURN TRANSID command to invoke the next transaction in the sequence and no pseudoconversation mode of END is encountered.

CICS does not support pseudoconversations for APPC (LUTYPE 6.2) devices.

PERMANENT
Maintain transaction affinity as long as the workload containing this transaction group is active.
SIGNON
Maintain transaction affinity as long as the user's session is active.
SYSTEM
Maintain transaction affinity as long as the target region to which transactions are directed remains active.
ACTIVITY
Maintain transaction affinity until the associated BTS activity ends.
PROCESS
Maintain transaction affinity until the associated BTS process ends.
Note:
The Affinity Relation and Affinity Lifetime fields are related. If you specify a value in the Affinity Relation field, you must specify a value in the Affinity Lifetime field. See Valid affinity relation and lifetime combinations and their meanings for valid affinity and lifetime combinations.
Create Affinity
Start of change(Required when you specify a value in the Affinity Relation and Affinity Lifetime fields.) Indicate whether CICSPlex SM should automatically create an affinity relationship for transactions associated with this transaction group. End of change
YES (or blank)
CICSPlex SM creates an affinity using the values specified in the Affinity Relation and Affinity Lifetime fields.
NO
CICSPlex SM does not automatically create an affinity. However, you can create one by using the SM_CREAFF function in the dynamic routing program (EYU9WRAM). The SM_CREAFF function provides greater control over the creation of affinities. For example, you can create an affinity to a target region that CICSPlex SM might not ordinarily select for dynamic routing. Refer to Dynamic routing with CICSPlex SM for details on EYU9WRAM and SM_CREAFF.
N/A
Affinity not defined (Affinity Relation and Affinity Lifetime fields are blank).
Event Name
(Optional.) Enter the specific or generic name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect transactions associated with this transaction group. If you enter a generic value, a list of valid definitions is displayed.

If a real-time analysis event is generated by this definition during the target region selection process, the severity level, if any, associated with the definition is used as part of the criteria in selecting a target region.

Abend Health
(For CICS/ESA 4.1 or later.) Specify the abend probability for a transaction associated with this group that should cause a target region to be considered unhealthy:
0
Ignore target region abend probability calculations.
Start of changevalueEnd of change
Start of changeSpecify a value between 2 and 99 (inclusive) that indicates an unacceptable abend probability. For example, if you specify 25, a target region with a 25% or greater probability of abending for a transaction associated with this group is considered unhealthy and is avoided, if possible.End of change
Abend Load
(For CICS/ESA 4.1 or later.) Specify the abend probability for a transaction associated with this group that should cause a target region's load level to be doubled:
0
Required when the Abend Health field is set to 0.
value
Start of changeSpecify a value that is greater than 0 and less than the Abend Health value.

For example, if you specified 25 as the Abend Health value, you must specify a value, x, between 1 and 24 (inclusive) as the Abend Load value. Then, if the probability of abend for a transaction being routed to a given target region is between 0% and x%, the perceived load on that target region is adjusted upward. Once the abend probability reaches x%, the perceived load is doubled, which means the target region is considered to have twice the load that it really has. This loading factor makes the region less desirable as a target for routing.

End of change
Notes:
  1. Once an affinity is active, all subsequent transactions are routed to the same target region for as long as the affinity remains active, regardless of its abend probability.
  2. For additional information about specifying abend health and abend load values, see Taking abend probabilities into consideration.

Press Enter to add the transaction group definition to the data repository.

Valid affinity relation and lifetime combinations and their meanings
USERID
All dynamic requests identified in the transaction group that are both: are to be directed to the same target region.

The following affinity lifetime values are valid for the USERID affinity relation:

SIGNON
The affinity continues as long as the user's terminal session is active.
DELIMIT
The affinity continues until a transaction with a pseudoconversation mode of END is encountered.
PCONV
The affinity continues as long as the pseudoconversation transaction is active. That is as long as each transaction ends with an EXEC CICS RETURN TRANSID and no pseudoconversation mode of END is encountered.
SYSTEM
The affinity continues as long as that target region is active.
PERMANENT
The affinity continues as long as any CMAS involved in managing the CICSplex using the workload is active.
LUNAME
All dynamic requests identified in the transaction group that are either initiated from, or associated with (using the EXEC CICS START command), the same terminal are to be directed to the same target region.

The following affinity lifetime values are valid for the LUNAME affinity relation:

LOGON
The affinity continues as long as the terminal session is active.
DELIMIT
The affinity continues until a transaction with a pseudoconversation mode of END is encountered.
PCONV
The affinity continues as long as the pseudoconversation transaction is active. That is, as long as each transaction ends with an EXEC CICS RETURN TRANSID and no pseudoconversation mode of END is encountered.
SYSTEM
The affinity continues as long as that target region is active.
PERMANENT
The affinity continues as long as any CMAS involved in managing the CICSplex using the workload is active.
GLOBAL
All dynamic requests identified in the transaction group that are either initiated from, or associated with (using the EXEC CICS START command), any terminal by any user, or by any BTS process, are to be directed to the same target region.

The following affinity lifetime values are valid for the GLOBAL affinity relation:

SYSTEM
The affinity continues as long as that target region is active.
PERMANENT
The affinity continues as long as any CMAS involved in managing the CICSplex using the workload is active.
BAPPL
All dynamic requests identified in the transaction group that are associated with the same BTS process are to be directed to the same target region.

The following affinity lifetime values are valid for the BAPPL affinity relation:

ACTIVITY
The affinity continues as long as the associated activity exists.
PROCESS
The affinity continues as long as the associated process exists.
SYSTEM
The affinity continues as long as that target region is active.
PERMANENT
The affinity continues as long as any CMAS involved in managing the CICSplex using the workload is active.

Adding a transaction to a transaction group

Figure 15 illustrates the panel produced when you use the add (ADD) line action command from the TRANGRP view.

Figure 15. Adding a transaction to a transaction group
 ------------------- Add Transaction to Trangroup for EYUPLX01 ---------------
 COMMAND  ===>
 
  Trangroup               EYUWMT03
 
      Transaction     PCONV Mode        Error
 ===> INV1            ===> START
 ===> INV2            ===> END
 ===> PAY1            ===>
 ===> PAY2            ===>
 ===>                 ===>
 ===>                 ===>
 ===>                 ===>
 ===>                 ===>
 ===>                 ===>
 ===>                 ===>
 
 
Press Enter to add Transaction to Trangroup.
Type END or CANCEL to cancel without adding.

Provide the following information, as appropriate:

Transaction
Specify a 1- to 4-character transaction identifier. The transaction ID is automatically converted to upper case characters. To add a transaction ID in mixed or lower case characters, you must use the batched repository-update facility, as described in CICSPlex SM Administration.
PCONV Mode
(Required for only the first or last transaction participating in a pseudoconversation.) Identify the location of the transaction in the pseudoconversation. Specify:
START
Identifies the transaction as starting a new pseudoconversation and ending any previous pseudoconversation.
END
Identifies the transaction as ending the current pseudoconversation.

Press Enter. Before adding the transactions to the transaction group definition in the data repository, the group is checked to determine if either of the following conditions is true:

   Tran already in a group
   Tran already in group
   Group no longer exists

If either condition is true, the appropriate message is displayed in the panel. Correct the condition before continuing.

Notes:
  1. To include more than ten transactions in a transaction group, reissue the ADD action command.

    Although there is no limit to the number of transactions you can associate with a transaction group, a transaction can be associated with only one transaction group in a single CICSplex.

  2. Although you can include static transactions and transactions scheduled as a result of ATI, only transactions defined to CICS as dynamic are eligible for routing.

Pseudoconversational transaction considerations:

Related concepts
Workload management definitions and their related views
Related tasks
Routing a specific transaction to a specific target region
Routing particular transactions from a given user to a specific target region
Honoring a pseudoconversational transaction
Related reference
Taking abend probabilities into consideration
Dynamic routing with CICSPlex SM

WLMDEF (Workload definitions)

You can use workload definitions to route work requests to a specific set of target regions based on the terminal and user names, or the process types, associated with those work requests. The terminal and user names may be either specific or generic. For example, you can create a workload definition that causes all transactions initiated by any user from terminals with logical unit names starting with NET to be routed to the target scope identified as EYUCSG01.

Examples of how to use this view can be found in:

To display information about existing workload definitions, issue the command:

   WLMDEF [wlmdef]

where wlmdef is a specific or generic workload definition name. If you omit this parameter, the view, illustrated in Figure 16, includes information about all existing workload definitions within the current context.

Figure 16. The WLMDEF view
 27FEB2005  22:02:37 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
 >W1 =WLMDEF============EYUPLX01=EYUPLX01=27FEB2005==22:02:37=CPSM==========3===
 CMD Def      Trangrp  Luname            Userid   Process  Target   Description
 --- Name---- Name---- ----------------- -------- Type---- Scope--- -------------
     EYUWLD01 EYUTRG01 *                 *        *        EYUCSG04 SSet - Separa
     EYUWLD05 EYUTRG05 *                 *        *        EYUCSG03 SSet - Applic
     EYUWLD06 EYUTRG06 *                 *        *        EYUMAS1B SSet - Existn
 
Note:
Scroll to the right in the view to see all of the Description field.

Action commands

Table 9 summarizes the action commands you can use with the WLMDEF view. Table 10 identifies the overtype fields you can modify when you use the SET action command.

Table 9. WLMDEF view action commands
Primary command Line command Description
n/a ADD Add an association between a workload definition and a workload group, as described in topic Adding an association to a workload group.
n/a BRO Browse a workload definition in the data repository.

The format of the resulting panel is similar to that shown in Figure 17. The panel fields are not modifiable.

CREate CRE Create a workload definition and add it to the data repository, as described in topic Creating a workload definition.

When you use the primary command CREate, some fields in the new view may contain values supplied by CICSPlex SM; you may change these values. When you enter the line command CRE next to the name of a workload definition, fields in the new view contain values to be modelled (from the existing workload definition).

n/a INS Install a workload definition into a workload, as described in topic Installing a workload definition in a workload.
n/a MAP Display a visual map of workload management definitions using the specified definition as a starting point.
n/a REM Remove a workload definition from the data repository.
n/a SET Change a workload definition using overtype fields (see Table 10.)
Note:
The value you specified in the Require Set field on the CICSPlex System Manager entry panel determines whether or not you must use the SET command when you overtype a field.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update a workload definition in the data repository.

The format of the resulting input panel is similar to that shown in Figure 17. You can change the contents of any field in the panel except Entry Name.

Table 10. WLMDEF view overtype fields
Field name Value
Trangrp Name 1- to 8-character name of a transaction group.
Luname Specific or generic logical unit name.
Userid Specific or generic user ID.
Process type Specific or generic process type.
Target Scope Name of a CICS system or CICS system group.
Description 1- to 30-character description of the workload definition.

Hyperlink fields

Table 11 shows the hyperlink field on the WLMDEF view.

Table 11. WLMDEF view hyperlink fields
Hyperlink field View displayed Description
Trangrp Name DTRINGRP Detailed information about the transactions in the specified transaction group.
Note:
The Trangrp Name field is recognized as a hyperlink field only when it contains a value.

Creating a workload definition

Figure 17 shows the format of the panel produced when you use the create primary (CREate) or line (CRE) action command from the WLMDEF view.

Figure 17. Creating a workload definition
 ----------------------- Create Workload Definition for EYUPLX01 ---------------
 COMMAND  ===>
 
  Definition Name  ===>
  Description      ===> SSet Separate ETUP
 
  Trangroup Name   ===> EYUTRG01       Specific Trangroup, Generic, or Blank
  Terminal Luname  ===> *              Specific or pattern Luname
  User ID          ===> *              Specific or pattern Userid
  Process Type     ===> *              Specific or pattern Process Type
  Target Scope     ===> EYUCSG04       CICS System, Group, or Generic
 
Press Enter to create definition.
Type END or CANCEL to cancel without creating.

Provide the following information, as appropriate:

Definition Name
Specify a 1- to 8-character name for the workload definition. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic.
Description
(Optional) Specify a 1- to 30-character description of the definition.
Trangroup Name
(Optional) Enter the specific or generic name of a transaction group. If you enter a generic value, a list of valid transaction groups is displayed.

If you do not identify a transaction group, the default transaction group for the specification is assumed. (For a description of this transaction group, see TRANGRP (Transaction groups).)

Terminal Luname
Enter a specific logical unit name or a pattern, using the format:
   [network_qualifier_name.]luname
where both the network_qualifier_name and the luname are between 1 and 8 characters in length.

A pattern can include the characters + (plus sign), * (asterisk), or both.

User ID
Enter a specific user ID or a pattern. A pattern can include the characters + (plus sign), * (asterisk), or both.
Note:
The Terminal Luname and User ID values are used when CICSPlex SM attempts to match a transaction with this definition. (See topic Transaction match criteria for additional information.)
Process Type
Enter a specific process type or a pattern. A pattern may include + (plus sign), * (asterisk), or both.
Note:
If you specify anything other than an * in this field, the luname and user id fields must be set to an *. Similarly, if there is anything other than an * in either luname and user id, this field must be set to *. You cannot separate a workload by process type, luname and user id.
Target Scope
Enter the specific or generic name of a CICS system or CICS system group to be used as target regions for dynamic routing requests. If you enter a generic value, a list of valid CICS systems and CICS system groups is displayed.
Note:
The specified CICS system or CICS system group must be accessible to the CICS systems identified as the routing scope with the workload specification to which this definition is associated. Therefore, you should verify that the appropriate CICS connections exist between each routing region and all of the CICS systems identified here as the target scope.

Press Enter to add the workload definition to the data repository.

Transaction match criteria

The criteria CICSPlex SM uses to determine if a transaction should be routed are:

The rules for establishing terminal and user name patterns are:

  1. When there are multiple workload definitions, the field containing the name identified as the primary filter can contain the same specific or generic pattern; the contents of the field used as the secondary filter must always be unique. For example, the following definitions are valid when USERID is the primary filter and LUNAME is the secondary filter. They are not valid, however, when LUNAME is the primary filter because the user identifiers are not unique.
      Entry Name     :  EYUWMD01  EYUWMD02  EYUWMD03
      Trangroup Name :  EYUTNG01  EYUTNG01  EYUTNG01
      Terminal Luname:  LUR*    LUL*    LUT*
      User ID        :  PIE*    PIE*    PIE*
  2. When a generic name is specified, the pattern with the most matching leading characters has precedence. For example, with the patterns:
      A37AR*
      A37+R*
    Pattern A37AR* is selected when the input is A37AR123. Pattern A37+R* is selected when the input is A37RTAP.
  3. Luname patterns are matched on the concatenated values of network name and luname. The following are valid luname patterns:
       NETWORK1.LU12345678   - A specific luname
       NETWORK1.LU1*         - Generic lunames in the network
       NETWORK1.*            - All lunames in the network
       NET*                  - All lunames in a generic network
       .LU12345678           - A specific luname within all networks
       .* or *               - All lunames within all networks

Adding an association to a workload group

Figure 18 illustrates the panel produced when you use the add (ADD) line action command from the WLMDEF view.

Figure 18. Adding an association between a workload definition and a workload group
 ------------------- Add WLM Definition to Workload Group for EYUPLX01 --------
 COMMAND  ===>
 
  Workload Definition        EYUWMD05
  Description                Test workload definition
 
  Workload Group       ===>             Group Name or Generic
 
Press Enter to add WLM Definition to Workload Group.
Type END or CANCEL to cancel without adding.

Provide the following information:

Workload Group
Enter the specific or generic name of an existing workload group. If you enter a generic value, a list of valid workload groups is displayed.

Press Enter to add the workload group to the designated workload definition.

To remove a workload definition from a workload group, use the WLMINGRP view, as described in topic WLMINGRP (Workload definitions in workload groups).

Note:
If an appropriate workload group does not currently exist, you must first create the group, as described in topic Creating a workload group. Then add the workload definition to the workload group using either this action command or the one described in topic Adding a workload definition to a workload group.

Installing a workload definition in a workload

You can install a workload definition into the workloads in one or more active CICS systems that are within the CICSplex identified as the context.

Note:
A workload definition can be automatically installed in a workload when the CICS system using that workload starts. For this to occur, associate the definition with a workload group. Then associate that workload group with a workload specification that is associated with a CICS system.

Figure 19 illustrates the panel produced when you use the install (INS) line action command from the WLMDEF view.

Figure 19. Installing a workload definition
 ---------------------------- Install WLMDEF for EYUPLX01 ----------------------
 COMMAND  ===>
 
  Name            EYUWMD01
  Description     Test workload definition
 
  Type            WLMDEF
 
  Workload ===>          Active Workload in which to install the WLMDEF
                          Or Generic
  Owner    ===>          Owner of the Workload in which to install the WLMDEF
                          Or Generic
 
 Press Enter to install Workload Definition.
 Type END or CANCEL to cancel without installing.

Provide the following information:

Workload
Enter the specific or generic name of an active workload into which the workload definition is to be installed. If you enter a generic value, a list of valid workloads is displayed.
Owner
Enter a 1- to 4-character, specific or generic SYSID of the system on which the workload was initially created. If you enter a generic value, a list of valid SYSIDs is displayed.

Press Enter to install the workload definition into the CICS system or CICS system group associated with the designated workload specification.

For information about workload management requirements that must be met in order for an installation to succeed, see Activating workload management.

To deactivate an installed workload definition, use the WLMAWDEF view, as described in Table 5.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions
Routing a specific transaction to a specific target region
Routing particular transactions from a given user to a specific target region
Honoring a pseudoconversational transaction
Updating an active workload definition
Related reference
TRANGRP (Transaction groups)

WLMGROUP (Workload groups)

A workload group is used to associate one or more related workload definitions. An example of how to use this view can be found in Routing a specific transaction to a specific target region

To display information about workload groups, issue the command:

   WLMGROUP [wlmgroup]

where wlmgroup is a specific or generic name of a workload group. If you omit this parameter, the view, illustrated in Figure 20, includes information about all workload groups within the current context.

Figure 20. The WLMGROUP view
 27FEB2005  22:02:49 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =WLMGROUP==========EYUPLX01=EYUPLX01=27FEB2005==22:02:49=CPSM==========3===
 CMD Workload Description
 --- Group--- ------------------------------
     EYUWLG01 SSet - EYUA AOR groupings
     EYUWLG04 SSet - All AOR groupings
     EYUWLG05 SSet - EYUB AOR grouping
 

Action commands

Table 12 summarizes the action commands you can use with the WLMGROUP view. Table 13 identifies the overtype field you can modify when you use the SET action command.

Table 12. WLMGROUP view action commands
Primary command Line command Description
n/a ADD Add an association between a workload group and a workload specification, as described in topic Adding a workload group to a workload specification.
n/a ASC Add an association between a workload definition and a workload group, as described in topic Associating a workload definition with a workload group.
n/a BRO Browse a workload group in the data repository.

The format of the resulting panel is similar to that shown in Figure 21. The panel fields are not modifiable.

CREate CRE Create a workload group and add it to the data repository, as described in topic Creating a workload group.
n/a INS Install the workload definitions associated with a workload group into a workload, as described in topic Installing a workload group.
n/a MAP Display a visual map of workload management definitions using the specified group as a starting point.
n/a REM Remove a workload group from the data repository.
Note:
Any associations that exist between the workload group and its workload definitions are also removed when you perform this action.
n/a SET Change a workload group description using an overtype field. (See Table 13).
Note:
The value you specified in the Require Set field on the CICSPlex System Manager entry panel determines whether or not you must use the SET command when you overtype a field.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update a workload group in the data repository.

The format of the resulting input panel is similar to that shown in Figure 21. You can change the Description field.

Table 13. WLMGROUP view overtype field
Field name Value
Description 1- to 30-character description of the workload group.

Hyperlink fields

Table 14 shows the hyperlink field on the WLMGROUP view.

Table 14. WLMGROUP view hyperlink field
Hyperlink field View displayed Description
Workload Group WLMINGRP Detailed information about the associations that exist between the designated workload group and workload definitions.

Creating a workload group

Figure 21 shows the format of the panel produced when you issue the create primary (CREate) or line (CRE) actions command from the WLMGROUP view.

Figure 21. Creating a workload group
 --------------------- Create WLM Group for EYUPLX01 -------------------
 COMMAND  ===>
 
  Group Name          ===>
  Description         ===>  Test Workload Group
 
 
 
 
 
Press Enter to create Workload Group.
Type END or CANCEL to cancel without creating.

Provide the following information, as appropriate:

Group Name
Specify a 1- to 8-character name for the workload group. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic.
Description
(Optional.) Specify a 1- to 30-character description of the workload group.

To add the workload group to the data repository, press Enter.

Adding a workload group to a workload specification

Figure 22 illustrates the panel produced when you use the add (ADD) line action command from the WLMGROUP view.

Figure 22. Associating a workload group with a workload specification
 -------------- Add WLM Group to Workload Specification for EYUPLX01 -----------
 COMMAND  ===>
 
  Workload Group            EYUWMG01
  Description               Test workload group
 
  Specification Name  ===>              Specification Name or Generic
 
 
Press Enter to add WLM Group to WLM Specification.
Type END or CANCEL to cancel without adding.

Provide the following information:

Specification name
Enter the specific or generic name of an existing workload specification. If you enter a generic value, a list of valid workload specifications is displayed.

Press Enter to add the workload group to the designated workload specification in the data repository.

If a workload specification appropriate for this workload group does not currently exist, you must first create one, as described in topic Creating a WLMSPEC specification. You can then use either this ADD action command or the ADD action command described in topic Adding a workload group to a workload specification to associate the workload group with a workload specification.

Associating a workload definition with a workload group

Figure 23 illustrates the panel produced when you use the associate (ASC) line action command from the WLMGROUP view.

Figure 23. Associating a workload definition with a workload group
 --------------- Add Workload Definition to Group for EYUPLX01 -----------------
 COMMAND  ===>
 
 Workload Group Name           EYUWOG01
 Description                   Sample workload group
 
 Workload Definition Name ===> EYUMOD01    Workload Definition or Generic
 
 
 Press Enter to add Workload Definition to Group.
 Type END or CANCEL to cancel without adding.

Provide the following information, as appropriate:

Workload Definition Name
Enter the specific or generic name of an existing workload definition that is to be associated with the workload group. If you specify a generic value, a list of valid workload definitions is displayed.

Press Enter to associate the workload definition with the workload group in the data repository.

Installing a workload group

When you install a workload group, all of the workload definitions associated with that group are installed in the designated workload.

The workload definitions associated with a workload group can be automatically installed in a workload when the CICS system using that workload starts. For this to occur, the workload group must be associated with a workload specification that is defined to the CICS system.

Figure 24 illustrates the panel produced when you use the install (INS) line action command from the WLMGROUP view.

Figure 24. Installing a workload group
 ----------------------- Install WLMGROUP for EUPLX01 --------------------------
 COMMAND  ===>
 
 Name             EYUWMG01
 Description      Test workload group
 
 Type             WLMGROUP
 
 Workload    ===>        Active Workload in which to install the WLMGROUP
                          Or Generic
 Owner       ===>        Owner of the Workload in which to install the WLMGROUP
                          Or Generic
 
 Press Enter to install definitions.
 Type END or CANCEL to cancel without installing.

Provide the following information:

Workload
Enter the specific or generic name of an active workload into which the workload definitions associated with this workload group are to be installed. If you enter a generic value, a list of valid workloads is displayed.
Owner
Enter a 1- to 4-character, specific or generic SYSID of the system on which the workload was initially created. If you enter a generic value, a list of valid SYSIDs is displayed.

Press Enter to install the workload definitions, within the workload group, into the CICS system or CICS system group associated with the designated workload.

For information about workload management requirements that must be met in order for an installation to succeed, see Activating workload management.

To deactivate an installed workload definition, use the WLMAWDEF view, as described in Table 5.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions
Routing a specific transaction to a specific target region

WLMINGRP (Workload definitions in workload groups)

To display the names of workload groups and the workload definitions associated with them, issue the command:

   WLMINGRP [wlmgroup [wlmdef]]

where:

wlmgroup
Is a specific or generic name of a workload group, or a blank or an * (asterisk) for all workload groups.
wlmdef
Is a specific or generic name of a workload definition. If you omit this parameter, the view includes information about all workload definitions associated with the designated workload group.

If you do not specify any parameters, the view, illustrated in Figure 25, includes information about all workload groups and their associated workload definitions within the current context.

Figure 25. The WLMINGRP view
 27FEB2005  22:03:07 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =WLMINGRP==========EYUPLX01=EYUPLX01=27FEB2005==22:03:07=CPSM==========3===
 CMD Group    Def
 --- Name---- Name----
     EYUWLG01 EYUWLD01
     EYUWLG04 EYUWLD05
     EYUWLG05 EYUWLD06
 

Action commands

Table 15 summarizes the action commands you can use with the WLMINGRP view.

Table 15. WLMINGRP view action commands
Primary command Line command Description
n/a ADD Add an association between a workload definition and a workload group, as described in topic Adding a workload definition to a workload group.
n/a BRO Browse the association between a workload definition and a workload group.

The format of the resulting panel is similar to that shown in Figure 26. The panel fields are not modifiable.

n/a MAP Display a visual map of workload management definitions using the specified group as a starting point.
n/a REM Remove the association between a workload definition and a workload group.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.

Hyperlink fields

Table 16 shows the hyperlink fields on the WLMINGRP view.

Table 16. WLMINGRP view hyperlink fields
Hyperlink field View displayed Description
Group Name WLMGROUP Detailed information about the designated workload group.
Def Name WLMDEF Detailed information about the designated workload definition.

Adding a workload definition to a workload group

Figure 26 illustrates the panel produced when you use the add (ADD) line action command from the WLMINGRP view.

Figure 26. Adding a workload definition to a workload group
 ------------- Add WLM Definition to Workload Group for EYUPLX01 -------
 COMMAND  ===>
 
  Workload Group      ===>  EYUWMG01   Workload Group or Generic
 
  Workload Definition ===>  EYUWMD01   Workload Definition or Generic
 
 
 
Press Enter to add WLM Definition to Workload Group.
Type END or CANCEL to cancel without adding.

Provide the following information:

Workload Group
Enter the specific or generic name of an existing workload group. If you enter a generic value, a list of valid workload groups is displayed.
Workload Definition
Enter the specific or generic name of an existing workload definition that is to be associated with the workload group. If you enter a generic value, a list of valid workload definitions is displayed.

Press Enter to add the workload definition to the workload group.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions

WLMINSPC (Workload groups in workload specifications)

To display the names of workload specifications and the workload groups associated with them, issue the command:

   WLMINSPC [wlmspec [wlmgroup]]

where:

wlmscope
Is a specific or generic name of a workload specification or * (asterisk) for all workload specifications.
wlmgroup
Is a specific or generic name of a workload group. If you omit this parameter, the view includes information about all workload groups associated with the designated workload specifications.

If you do not specify any parameters, the view, illustrated in Figure 27, includes information about all workload specifications and their associated workload groups within the current context.

Figure 27. The WLMINSPC view
 27FEB2005  22:03:22 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =WLMINSPC==========EYUPLX01=EYUPLX01=27FEB2005==22:03:22=CPSM==========3===
 CMD Spec     Group
 --- Name---- Name----
     EYUWLS01 EYUWLG01
     EYUWLS01 EYUWLG04
     EYUWLS01 EYUWLG05
 

Action commands

Table 17 summarizes the action commands you can use with the WLMINSPC view.

Table 17. WLMINSPC view action commands
Primary command Line command Description
n/a ADD Add an association between a workload group and a workload specification, as described in topic Adding a workload group to a workload specification.
n/a BRO Browse the association between a workload group and a workload specification.

The format of the resulting panel is similar to that shown in Figure 28. The panel fields are not modifiable.

n/a MAP Display a visual map of workload management definitions using the designated specification as a starting point.
n/a REM Remove the association between a workload group and a workload specification.
Note:
Any associations that exist between the workload group and its the workload definitions are also removed when you perform this action.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.

Hyperlink fields

Table 18 shows the hyperlink fields on the WLMINSPC view.

Table 18. WLMINSPC view hyperlink fields
Hyperlink field View displayed Description
Spec Name WLMSPEC Detailed information about the designated workload specification.
Group Name WLMGROUP Detailed information about the designated workload group.

Adding a workload group to a workload specification

Figure 28 illustrates the panel produced when you use the add (ADD) line action command from the WLMINSPC view.

Figure 28. Adding a workload group to a workload specification
 ------------------ Add WLM Group to Specification for EUPLX01 ----------------
 COMMAND  ===>
 
  Specification Name   ===> EYUWMS01   Spec Name or Generic
 
  WLM Group Name       ===> EYUWMG01   Group Name or Generic
 
Press Enter to add WLM Group to Specification.
Type END or CANCEL to cancel without adding.

Provide the following information:

Specification Name
Enter the specific or generic name of an existing workload specification. If you enter a generic value, a list of valid workload specifications is displayed.
WLM Group Name
Enter the specific or generic name of an existing workload group. If you enter a generic value, a list of valid workload groups is displayed.

Press Enter to add the workload group to the designated workload specification in the data repository.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions

WLMSCOPE (Workload specifications assigned a scope)

To display information about the CICS systems or CICS system groups acting as routing regions that are associated with a workload specification, issue the command:

   WLMSCOPE [wlmspec]

where wlmspec is a specific or generic name of a workload specification. If you omit this parameter, the view, illustrated in Figure 29, includes information about all workload specifications, and the associated routing scope information, within the current context.

Figure 29. The WLMSCOPE view
 27FEB2005  22:03:43 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
  W1 =WLMSCOPE==========EYUPLX01=EYUPLX01=27FEB2005==22:03:43=CPSM==========1===
 CMD WLM      Scope    Scope    Scope    Scope    Update
 --- Spec---- Name---- Type---- Mode---- Link---- Option--
     EYUWLS01 EYUMAS1A CICSSYS  EXPLICIT
 
 

Action commands

Table 19 summarizes the action commands you can use with the WLMSCOPE view. Table 20 identifies the overtype fields you can modify when you use the SET action command.

Table 19. WLMSCOPE view action commands
Primary command Line command Description
n/a BRO Browse the association between a routing region scope and a workload specification.

The format of the resulting panel is similar to that shown in Figure 30. The panel fields are not modifiable.

n/a MAP Display a visual map of workload management definitions using the designated specification as a starting point.
n/a REM Remove the association between a routing region scope and a workload specification, as described in topic Removing a scope-to-workload specification association.
n/a SET Change the association between a routing scope and a workload specification using overtype fields (see Table 13).
Note:
The value you specified in the Require Set field on the CICSPlex System Manager entry panel determines whether or not you must use the SET command when you overtype a field.
TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update the association between a routing scope and a workload specification, as described in Updating a scope-to-workload specification association.

When you change or remove the workload specification associated with a CICS system group, you must indicate how the CICS systems comprising that group are to be affected.

Based on the value you specify, the number of entries shown in the WLMSCOPE view may increase or decrease. For example, you might specify a value that causes a CICS system within a CICS system group to be explicitly associated with a specification rather than inherit it from its CICS system group. When this happens, the resulting WLMSCOPE view still contains a line identifying the CICS system group (which retains its association with a specification) and a new line identifying the CICS system that is now explicitly associated with a specification (which may be the same as or different from the specification with which the CICS system group is associated).

Table 20. WLMSCOPE view overtype fields
Field name Value
WLM Spec 1- to 8-character name of an existing workload specification that is to be associated with the CICS system or CICS system group.
Update Option FORCE | KEEP | NAME | NULL
Notes:
  1. When the scope of the workload specification is a CICS system group, you must indicate how the CICS systems comprising the CICS system group are to use the specification by overtyping the contents of the Update Option field.

    If the CICS system group includes other CICS system groups, all of the CICS systems, including those in the subordinate CICS system groups, are affected by the value specified in the Update Option field.

  2. If you update the workload specification for a CICS system that is already active, you must restart the CICS system for the new specification to become active.

Hyperlink fields

Table 21 shows the hyperlink field on the WLMSCOPE view.

Table 21. WLMSCOPE view hyperlink fields
Hyperlink field View displayed Description
WLM Spec WLMSPEC Detailed information about the designated workload specification.

Updating a scope-to-workload specification association

Figure 30 illustrates the panel produced when you use the update (UPD) line action command from the WLMSCOPE view.

Figure 30. Updating the association between a scope and a workload specification
 ----------- Update WLM Specification to Scope for EYUPLX01 -------------------
 COMMAND  ===>
 
   Specification Name   ===> EYUWMS01   Specification name or Generic
   Scope                     EYUCSG01
   Scope Type                SYSGROUP
 
   Option               ===>            FORCE, KEEP, NAME, or NULL
 
 
  Press ENTER to update.
  Type END or CANCEL to cancel without updating.

The Option field does not appear on this panel when the scope is a CICS system (CICSSYS).

Change the following information, as appropriate:

Specification Name
Enter the specific or generic name of an existing workload specification. If you enter a generic value, a list of valid workload specifications is displayed.
Option
When the scope of the workload specification is a CICS system group, you must indicate how the CICS systems comprising the CICS system group are to use the specification. To do this, specify one of the following:
FORCE
All CICS systems in the CICS system group are to inherit the new specification.
KEEP
Any CICS system that inherited a specification from the CICS system group is to be explicitly assigned the old specification; all other CICS systems in the group are to be unaffected.
NAME
Any CICS system that inherited a specification from the CICS system group is to be explicitly assigned the new specification; all other CICS systems in the group are to be unaffected.
NULL
Any CICS system in the CICS system group that is not explicitly associated with a specification is to inherit the new specification; all other CICS systems in the group are to be unaffected.
Notes:
  1. If the CICS system group includes other CICS system groups, all of the CICS systems, including those in the subordinate CICS system groups, are affected by the value specified in the Option field.
  2. For the new specification to become active, you must restart the CICS systems with which it is associated.

Removing a scope-to-workload specification association

Figure 31 illustrates the panel produced when you use the remove (REM) line action command from the WLMSCOPE view.

Figure 31. Removing the association between a scope and a workload specification
 ----------- Confirm Removal of WLM Spec to Scope from EYUPLX01 ---------------
 COMMAND  ===>
 
   Specification Name         EYUWMS01
   Scope                      EYUCSG01
   Scope Type                 SYSGROUP
 
   Option                ===>            KEEP or Blank
 
   WARNING:  For this definition type, removal will cascade through
             related associations.
 
  Press ENTER to remove.
  Type END or CANCEL to cancel without removing.

The Option field does not appear on this panel when the scope is a CICS system (CICSSYS).

Provide the following information when the scope is a CICS system group:

Option
Indicate how the CICS systems comprising the CICS system group are to use the workload specification associated with that CICS system group. Specify:
KEEP
Those CICS systems that inherited the specification from the CICS system group are explicitly assigned that specification.
blank
Those CICS system that inherited the specification from the CICS system group are not to use that specification.

If the CICS system group includes other CICS system groups, all of the CICS systems, including those in the subordinate CICS system groups, are affected by the value specified in this field.

Press Enter to remove the scope from the designated workload specification in the data repository.

Related concepts
Workload management definitions and their related views
Related tasks
Creating workload management definitions

WLMSPEC (Workload specifications)

A workload specification identifies a workload and one or more CICS systems acting as target regions. It also defines the attributes of the default transaction group. The default transaction group ($$DTGA$$) is used for routing any transaction that is not explicitly associated with a user-defined transaction group. Once the workload specification is associated with a routing scope, it is automatically activated when the first routing region in the scope connects to the CICSplex.

Examples of how to use this view can be found in:

To display information about existing workload specifications, issue the command:

   WLMSPEC [wlmscope]

where wlmscope is a specific or generic workload specification name. If you omit this parameter, the view, illustrated in Figure 32, includes information about all existing workload specifications within the current context.

Figure 32. The WLMSPEC view
 27FEB2005  22:03:16 ----------- INFORMATION DISPLAY ---------------------------
 COMMAND  ===>                                                 SCROLL ===> PAGE
 CURR WIN ===> 1        ALT WIN ===>
 >W1 =WLMSPEC===========EYUPLX01=EYUPLX01=27FEB2005==22:03:16=CPSM==========1===
 CMD Name     Affinity Affinity Target   Cre Match  Event    Description
 --- -------- Relation Lifetime Scope--- Aff Key--- Name---- -------------------
     EYUWLS01                   EYUCSG03     USERID          SSet - Basic worklo
 
 

Action commands

Table 22 summarizes the action commands you can use with the WLMSPEC view.

Table 22. WLMSPEC view action commands
Primary command Line command Description
n/a ADD Add an association between a workload specification and a scope identified as one or more routing regions, as described in topic Adding a scope to a workload specification.
n/a BRO Browse a workload specification in the data repository.

The format of the resulting panel is similar to that shown in Figure 33. The panel fields are not modifiable.

CREate CRE Create a workload specification and add it to the data repository, as described in Creating a WLMSPEC specification.

When you use the primary command CREate, some fields in the new view may contain values supplied by CICSPlex SM; you may change these values. When you enter the line command CRE next to the name of a workload specification, fields in the new view contain values to be modelled (from the existing workload specification).

n/a MAP Display a visual map of workload management definitions using the designated specification as a starting point.
n/a REM Remove a workload specification from the data repository.

When you remove a workload specification, associations with workload groups and the CICS system and CICS system group identified as the scope are also removed.

TEMPMP cmasid n/a Change the temporary maintenance point CMAS to a specific CMAS or display a selection list based on a generic CMAS ID.
n/a UPD Update a workload specification in the data repository.

The format of the resulting panel is similar to the panel shown in Figure 33. You can change the contents of any field in the panel except WLM Spec Name.

Hyperlink fields

Table 23 shows the hyperlink field on the WLMSPEC view.

Table 23. WLMSPEC view hyperlink field
Hyperlink field View displayed Description
Name WLMINSPC Detailed information about the associations that exist between the designated workload specification and its workload groups.

Creating a WLMSPEC specification

Figure 33 shows the format of the panel produced when you use the create primary (CREate) or line (CRE) action command from the WLMSPEC view.

Figure 33. Creating a workload specification
 -------------------- Create WLM Specification for EYUPLX01 -----------------------
 COMMAND  ===>
 
  WLM Spec Name       ===>
  Description         ===> SSet - Basic Workload
 
  Affinity Relation   ===>              Default Affinity Relation
                                (USERID, LUNAME, GLOBAL,BAPPL)
  Affinity Lifetime   ===>              Default Affinity Lifetime
                                (SIGNON, LOGON, SYSTEM, PERMANENT, PCONV, DELIMIT 
                                 ACTIVITY, PROCESS)
  Match Key           ===> USERID       Default Primary search criterion
                                (USERID, LUNAME)
  Create Affinity     ===>              Create Auto Affinity (YES, NO, N/A)
  Target Scope        ===> EYUCSG03     Default CICS System,Group or Generic
  Event Name          ===>              RTADEF, STATDEF, or Generic
 
  Abend Health        ===> 0            Target ABEND Health Factor (0 - 99)
  Abend Load          ===> 0            Target ABEND Load Factor (0 - 99)   - 99) 
  Algorithm Type      ===> Queue        Algorithm Type (GOAL, QUEUE)
 
Press Enter to create WLM Specification.
Type END or CANCEL to cancel without creating.

Provide the following information, as appropriate:

WLM Spec Name
Specify a 1- to 8-character name for the workload specification. This name also becomes the name of the workload. The name can contain alphabetic, numeric, or national characters. However, the first character must be alphabetic. This name becomes the name of the workload and must be unique within the CICSplex.
Description
Specify a 1- to 30-character description of the workload specification.
Affinity Relation
(Optional.) Indicate the default affinity relationship that is to be used if a transaction cannot be matched to a transaction group. Specify:
USERID
Base transaction affinity on the user ID.
LUNAME
Base transaction affinity on the terminal logical unit name.
GLOBAL
Base transaction affinity on all users at all terminals.
BAPPL
Base transaction affinity on the CICS BTS application.
If you do not specify a value, no affinity relation is recognized for transactions associated with the default transaction group.

For workload management of enterprise beans, this field must be blank.

Affinity Lifetime
(Required when you specify a value in the Affinity Relation field.) Indicate the default affinity lifetime that is to be used when a transaction cannot be matched to a transaction group. Specify:
DELIMIT
Maintain transaction affinity until a transaction with a pseudoconversation mode of END is encountered.

Because an END pseudoconversation mode cannot be assigned to a transaction by default, using DELIMIT as a default is comparable to specifying a lifetime of SIGNON or LOGON.

LOGON
Maintain transaction affinity for the duration of the terminal session.
PCONV
Maintain transaction affinity for the duration of the pseudoconversation. That is, as long as each transaction ends with an EXEC CICS RETURN TRANSID command to invoke the next transaction in the sequence and no pseudoconversation mode of END is encountered.

CICS does not support pseudoconversations for APPC (LUTYPE6.2) devices.

PERMANENT
Maintain transaction affinity as long as the workload containing the default transaction group is active.
SIGNON
Maintain transaction affinity as long as the user’s session is active.
SYSTEM
Maintain transaction affinity as long as the target region to which transactions are directed remains active.
ACTIVITY
Maintain transaction affinity until the BTS activity ends.
PROCESS
Maintain transaction affinity until the BTS process ends.

For workload management of enterprise beans, this field must be blank.

Note:
The Affinity Relation and Affinity Lifetime fields are related. If you specify a value in the Affinity Relation field, you must specify a value in the Affinity Lifetime field. See Valid affinity relation and lifetime combinations and their meanings for valid affinity and lifetime combinations.
Match Key
Designate whether the user name (USERID) or logical unit name (LUNAME) is to be used as the default primary search criterion for a transaction that cannot be matched to a transaction group.
Create Affinity
Start of change(Required when you specify a value in the Affinity Relation and Affinity Lifetime fields.) Indicate whether CICSPlex SM should automatically create an affinity relationship for transactions that cannot be matched to a transaction group. End of change
YES (or blank)
CICSPlex SM creates an affinity using the values specified in the Affinity Relation and Affinity Lifetime fields.
NO
CICSPlex SM does not automatically create an affinity. However, you can create one by using the SM_CREAFF function in the dynamic transaction routing program (EYU9WRAM). The SM_CREAFF function provides greater control over the creation of affinities. For example, you can create an affinity to a target region that CICSPlex SM might not ordinarily select for dynamic routing. Refer to Dynamic routing with CICSPlex SM for details on EYU9WRAM and SM_CREAFF.
N/A
Affinity not defined (Affinity Relation and Affinity Lifetime fields are blank).
Target Scope
Enter the specific or generic name of a CICS system or CICS system group that is to be used as target regions for dynamic routing requests. The CICS system or CICS system group must be within the CICSplex identified as the current context. If you enter a generic value, a list of valid CICS systems and CICS system groups is displayed.
Event Name
(Optional.) Enter the specific or generic name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect transactions associated with the default transaction group. If you enter a generic value, a list of valid definitions is displayed.

If a real-time analysis event is generated by this definition during the target region selection process, the severity level, if any, associated with the definition is used as part of the criteria for selecting a target region.

Abend Health
(For CICS/ESA 4.1 or later.) Specify the abend probability for a transaction associated with the default transaction group that should cause a target region to be considered unhealthy:
0
Ignore target region abend health calculations.
value
Start of changeSpecify a value between 2 and 99 (inclusive) that indicates an unacceptable abend probability. For example, if you specify 25, a target region with a 25% or greater probability of abending for a transaction associated with the default transaction group is considered unhealthy and is avoided, if possible.End of change
Abend Load
(For CICS/ESA 4.1 and later.) Specify the abend probability for a transaction associated with the default transaction group that should cause a target region’s load level to be doubled:
0
Required when the Abend Health field is set to 0.
value
Start of changeSpecify a value that is greater than 0 and less than the Abend Health value.

For example, if you specified 25 as the Abend Health value, you must specify a value, x, between 1 and 24 (inclusive) as the Abend Load value. Then, if the probability of abend for a transaction being routed to a given target region is between 0% and x%, the perceived load on that target region is adjusted upward. Once the abend probability reaches x%, the perceived load is doubled, which means the target region is considered to have twice the load that it really has. This loading factor makes the region less desirable as a target for routing.

End of change
Notes:
  1. For additional information about specifying abend health and abend load values, see Taking abend probabilities into consideration.
  2. Once an affinity is active, all subsequent transactions are routed to the same target region for as long as the affinity remains active, regardless of its abend probability.
Algorithm Type
Identify the algorithm to be used when selecting the best target region in the Target Scope to which a transaction should be routed. Specify:
QUEUE
Route the transaction to the target region that:
  • Is the healthiest
  • Has the least queue depth (or load)
  • Has the fastest CICS link from the routing region
  • Has the least transaction abend probability, when calculated
GOAL
Supported in MVS™ 5.1 and higher where the MVS Workload Manager (MVS/WLM) is also supported. Additionally, the CICS system(s) specified in the target region Scope field must be CICS/ESA 4.1 and later. Route the transaction to the target region that:
  • Is the healthiest
  • Has the least load
  • Has the fastest CICS link from the routing region
  • Has the least transaction abend probability, when calculated
  • Is the most likely to allow the transaction to meet the response time goal set for it and other transactions in its MVS workload management class
For additional information about this type of algorithm, see the MVS/ESA SP Version 5 Planning: Workload Management book.

Press Enter to add the workload specification to the data repository.

Adding a scope to a workload specification

Each workload specification has a target and routing scope associated with it. The target scope is identified when you create the specification; the routing scope is identified when you add the routing region to the specification.

Note:
While WLMSPEC is active, you cannot directly modify the default target scope. However, you can create a new WLMDEF with an luname of * (asterisk), a user id of * (asterisk), a process type of * (asterisk), no transaction group name, and a new target scope. If you then install the new WLMDEF, transactions will be routed according to the default transaction group for the new target scope.

Once you add a routing scope to a workload specification, the specification is automatically installed whenever a CICS system associated with that scope is started. Any workload definitions associated with the specification through workload groups are also automatically installed.

However, if you associate the workload specification with a CICS system that is already active, the new specification is not immediately available. To turn workload management on, you must display the MAS view and use the UPD action command. Specify YES in the WLM Active field and press Enter; workload management becomes active using the new workload specification.

Figure 34 illustrates the panel produced when you use the add (ADD) line action command from the WLMSPEC view.

Figure 34. Adding a scope to a workload specification
 ------------------- Add Scope for Specification for EYUPLX01 ------------------
 COMMAND  ===>
 
  WLM Spec Name           EYUWMS04
  Description             Test workload specification
 
  Scope              ===>              CICS System, Group or Generic
  Option             ===>              FORCE, NULL, or NONE for System Group
 
Press Enter to add Workload Specification Scope.
Type END or CANCEL to cancel without adding.

Provide the following information, as appropriate:

Scope
Enter the specific or generic name of an existing CICS system or group that represents one or more routing regions. If you enter a generic value, a list of valid CICS systems and CICS system groups is displayed.

All routing regions represented by the specified CICS system or group must be local MASs. That is, they must be running on an MVS image on which there is a CMAS.

A CICS system or CICS system group acting as a routing region can be associated with only one workload specification at a time. A specification, however, can be associated with any number of CICS systems and CICS system groups.

Option
(Required when the scope is a CICS system group.) Indicate how the CICS systems that make up the CICS system group are to use the workload specification associated with the CICS system group. Specify:
FORCE
All CICS systems in the CICS system group are to use the workload specification. (The workload specification attribute for each CICS system changes to INHERIT, indicating that the specification was acquired from the CICS system group.)
NULL
Those CICS systems in the CICS system group that are not associated with a workload specification are to use this workload specification. (The workload specification attribute for those CICS systems changes to INHERIT, indicating that the specification was acquired from the CICS system group.)
NONE
Only the CICS system group is to be associated with the workload specification. The CICS systems in the CICS system group are not affected. That is, if there is no association between a CICS system and a workload specification, none is established; if there is an association, either explicitly established or inherited from another CICS system group, it is unchanged.
Notes:
  1. If the CICS system group identified as the scope includes other CICS system groups, all of the CICS systems, including those in subordinate CICS system groups, are affected by the value specified in this field. Press Enter to add the scope to the designated workload specification in the data repository.
  2. The CICS systems designated as the target scope when you created the workload specification must be accessible to the CICS systems identified as the routing scope. Therefore, you should verify that the appropriate CICS connections exist between each routing region and all of the CICS systems in the target scope identified here.

Related concepts
Workload management definitions and their related views
Taking abend probabilities into consideration
Related tasks
Creating workload management definitions
Balancing a workload
Adding a routing region to an active workload
Updating a workload specification
Using real-time analysis to select a target region for workload balancing
[[ Contents Previous Page | Next Page Index ]]