WLMATAFF Resource Table

A CICSPlex® SM Workload Manager object that describes an active affinity relationship for a dynamic transaction. An instance of this object exists for the duration of the affinity, which in many cases is a very short period of time.

This object is referenced within the scope of a workload. The workload name must be explicitly identified in the PARM option of the API GET command by coding the following text string: 

   PARM('WORKLOAD(workload).')

workload is the name of an active workload and is required. Alternatively, you can code the following text string:

PARM('WORKLOAD(*).')

You can specify a workload name of * as a wildcard. Using this wildcard returns a WLMATAFF record for every workload with which the target region is associated. No other generic form of workload name can be specified. You must use an explicit workload name or the wildcard.

The Primary key field for this resource class is WORKLOAD.

The Secondary key field for this resource class is WRKLOWNER.

The Tertiary key field for this resource class is TRANGRP.

The Fourth key field for this resource class is USERID.

The Fifth key field for this resource class is LUNAME.

The Sixth key field for this resource class is TORNAME.

The Seventh key field for this resource class is TERMID.

The Eighth key field for this resource class is RESERVD2.

The Ninth key field for this resource class is AFFKEY.

The following action is supported:
FORCE
Force an affinity to be broken.

This action is provided for use when system failures occur and manual recovery of a workload is required. It is not intended for general use and may cause damage if used in an inappropriate manner. CICSPlex SM makes no checks before the forced removal of an affinity relation.

External resource name(CMCI)
CICSWLMActiveAffinity
Object type
CICSPlex SM Manager
Length
240
Usage
API, WUI, CICS Management Client Interface(CMCI)
API view
No
CMAS context
No
SCOPE applies
No
Only query CMASs in workload
Yes
Copybook identifier
EYUt2487
Security Class
WORKLOAD.DEF
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   WORKLOAD(value) No
PERFORM SET FORCE None N/A
Table 2. WLMATAFF FEEDBACK error codes
Value Code Description
21 WLMATAFF_AFFINITY_NOT_FOUND Affinity not found
22 WLMATAFF_WORKLOAD_NOT_FOUND Workload not found
23 WLMATAFF_TRANGRP_NOT_FOUND Transaction group not found
24 WLMATAFF_NO_WORKLOAD No workload
25 WLMATAFF_NO_TRANGRP No transaction group
26 WLMATAFF_WORKLOAD_FROZEN Workload frozen
Table 3. WLMATAFF resource table attributes
Name Datatype Source Len Sum Description Offset
 WORKLOAD-1  CHAR CPSM 8 DIFF Workload name 8
 WRKLOWNER-2  CHAR CPSM 4 DIFF System ID of workload owner 84
 TRANGRP-3  CHAR CPSM 8 DIFF Transaction group 0
 USERID-4  CHAR CPSM 8 DIFF User identifier 24
 LUNAME-5  CHAR CPSM 17 DIFF Terminal LU name 32
 TORNAME-6  CHAR CPSM 8 DIFF Routing region 49
 TERMID-7  CHAR CPSM 8 DIFF Routing region terminal 57
 RESERVD2-8  CHAR CPSM 11 DIFF The activity ID of the CBTS activity 65
 AFFKEY-9  HEX CPSM 64 LIKE Key that identifies creator of affinity 175
AFFINITY EYUDA CPSM 4 LIKE Affinity relationship 16
AFFINITY Input/output valid values
  • LOCKED
AFFINITY Output valid values
  • GLOBAL
  • LUNAME
  • USERID
  • BAPPL
AOR CHAR CPSM 8 DIFF Target region 76
CBTSKEY HEX CPSM 52 LIKE BTS activity ID 88
LIFETIME EYUDA CPSM 4 LIKE Affinity lifetime 20
LIFETIME Input/output valid values
  • UOW
LIFETIME Output valid values
  • LOGON
  • PCONV
  • PERMANENT
  • SIGNON
  • SYSTEM
  • DELIMIT
  • ACTIVITY
  • PROCESS
LOCUOWID HEX CPSM 8 LIKE Local unit-of-work ID 140
NETUOWID HEX CPSM 27 LIKE Network unit-of-work ID 148