SUITE
Syntax
SID=<comma-separated System ID list>
SCL=<comma-separated service class name list or keyword OTHER>
RCL=<comma-separated report class name list or keyword OTHER>
CLASS=<initiator classes string as ABCD>
JOB=<pattern>
ALIAS=<suite alias name>
RACFGRP=<pattern>
RACFUSER=<pattern>
ACCNT=pattern | ACCNT=(1=pattern1,., x=patternx)
SS_NAME=<IMS subsystem name>
SEP_SUBSYS=<comma-separated subsystem type list or keyword NO>
DETAIL=<YES or NO>
Syntax explanations
- Name is a one to eight-character name to be assigned to the suite.
- SID is a comma-separated list of system IDs.
- SCL is a comma-separated list of Service Classes. The keyword OTHER in the SCL parameter means that all Service Classes satisfy this SUITE definition.
- RCL is a comma-separated list of Report Classes. The keyword OTHER in the RCL parameter means that all Report Classes satisfy this SUITE definition.
- CLASS is a string of one to eight characters that identifies initiator classes.
- JOB is a one to eight character jobname or jobname pattern.
- ALIAS is the one to thirty character alias name for the suite. The default alias name is the existing suite name.
- RACFGRP is the IBM RACF or TopSecret group name or pattern.
- RACFUSER is a IBM RACF USERID, ACF2, TopSecret, or pattern.
- ACCNT is a one to sixteen character value or pattern found in the SMF 30 Account field. Jobs can have multiple account values, which are separated by commas and combined into one ACCOUNT field on the type 30 record. UIE parses the ACCOUNT field and recognizes the separate subfields contained within it. On the ACCNT parameter of the SUITE command, you can specify subfields within the type 30 ACCOUNT field. If a number precedes the value (such as 2=PROD*), UIE matches the number to the corresponding subfield in the ACCOUNT field. If no number precedes the value (such as ACCNT=PROD*), UIE checks the first subfield in the ACCOUNT field. If you specify multiple subfield values, enclose the values in parentheses.
- SS_NAME is a one to four character IMS subsystem name.
- SEP_SUBSYS is a comma-separated list of subsystem types or the keyword NO. This list can include the values CICS, Db2, IMS, MQ, CICSUTL, DB2UTL, IMSUTL, HTTP, IRLM, OMVS, and WAS.
- DETAIL specifies whether a separate SUITE should be created for each CICS region. The default is DETAIL=NO.
When UIE processes information about each individual active task, UIE checks all SUITE commands that you specified in the order that they are encountered in the command file. If this particular task matches the SUITE definition rules, the SUITE name is assigned to the task, and parsing of the SUITE command stops. If the particular task does not match any SUITE command, the SUITE name is assigned to the task by default rules.
When matching a job to a SUITE, if UIE determines that this particular address space is a subsystem address space, UIE checks the list of subsystem types in the SEP_SUBSYS parameter. If this subsystem type is found in the SEP_SUBSYS list, the SUITE name is assigned as
<SUITEName>_<SubsystemType>If the subsystem is Db2 or MQ, the name of the subsystem is concatenated as
<SUITEName>_<SubsysType>_<SubsysName>If the IMS subsystem name is known (that is, it was specified in the SS_NAME command or it was found in the BMC AMI Ops Monitor for IMS Offline records for this subsystem), the name of the subsystem is concatenated as
<SUITEName>_<SubsysType>_<SubsysName>If the subsystem type is not found in SEP_SUBSYS list, the address space will not be assigned to its own SUITE (<SUITEName>_<SubsystemType>). In this case, UIE cannot create application data for this subsystem type and you will receive a warning message that the SUITE could not be found for some application data.
Rules
All parameters in the SUITE command, except the SUITE name, are optional. The absence of a particular parameter means that this parameter is not used. Any value corresponding to this parameter is considered as matching this SUITE definition. For example, if the SID parameter is not specified, all tasks in ALL z/OS images matching the other specified parameters are assigned this SUITE name. As a result, specifying:
SUITE XXXXaggregates all tasks that are not assigned to a SUITE before that, to SUITE xxxx. All SUITE definitions, which are placed in a command file after this line, are ignored.
- The maximum number of SUITE commands that you can specify is 32,768.
The pattern in JOB, ACCNT, RACFGRP, and RACFUSER parameters can be:
- A character string without an asterisk (*), which means an exact match.
- A string containing asterisk (*) at the beginning, at the end, or at the beginning and at the end.
- A character string containing one of more question marks (?).
An asterisk (*) character in the pattern string denotes zero or more characters. A question mark (?) character within the pattern string denotes one and only one (positional) character.
Patterns, such as *ABC or ABC* or *ABC* are permitted
Patterns, such as *ABC*DEF or ABC*DEF are not permitted.
A question mark (?) cannot follow an asterisk (*). This syntax is not treated as an error, but is processed as if the question mark (?) were not present. The correct syntax for specifying one or more characters is a question mark followed by an asterisk (?*). To specify two or more characters, use two question marks followed by an asterisk (??*) and so on.
The full length of the pattern, including all asterisk (*) and question mark (?) characters must be less than or equal to 8 characters for the JOB, RACFGRP, and RACFUSER parameters and less than 16 characters for the ACCNT parameter.
- Parameters SS_NAME, SEP_SUBSYS, and DETAIL are not used as matching rules. These parameters specify the way UIE should handle Subsystem Address Spaces assigned to this SUITE.
The SS_NAME parameter is used primarily for specifying the four-character IMS Subsystems name for all IMS regions that are assigned to the SUITE. Because the IMS Subsystem name is crucial for the correct allocation of IMS transactions, and unlike other transactional subsystems (Db2, CICS, and MQ) it cannot be determined reliably from SMF input data. It must be specified in the SS_NAME parameter.
- The SEP_SUBSYS parameter is used for overriding the default subsystem separation rules for an individual SUITE command. Use the SEP_SUBSYS parameter to specify only those subsystems that you want to be separated into their own suite. If the keyword NO is specified for this parameter, then UIE does not separate any subsystems into their own suites for this particular SUITE command.
The DETAIL parameter specifies whether a separate SUITE should be created for each CICS region. For the DETAIL parameter to have any effect, the SEP_SUBSYS=CICS parameter must also be specified for the SUITE command. If you specify DETAIL=YES and SEP_SUBSYS=CICS, the CICS region name is added to the SUITE name. This is useful when many CICS regions are in a single Service Class, and you do not want to specify each of them in individual SUITE commands.
Examples
For examples of the use of the SUITE command, see UIE-command-examples.