Output parameters

Output parameters for the function routine are:

ITSMHDR (JES2 only)
SSOBRETN
SSJPRETN
Various output data areas (mapped by IAZJPITD macro) are chained to JPITD - Initiator Information Service parameter list

ITSMHDR: System Information Header. See System Information for more information.

SSOBRETN Contents: When control returns to the caller and register 15 contains a zero, the Initiator Information services function places one of the following decimal values in the SSOBRETN field:

Value (Decimal)

Meaning

SSJPOK (0)

Request successful.

SSJPERRW (4)

Request completed with possible errors, see SSJPRETN for reason code.

SSJPERRU (8)

Request cannot be completed because of user error, see SSJPRETN for reason code.

SSJPERRJ (12)

Request cannot be completed, SSJPRETN contains internal reason code.

SSJPPARM (16)

SSJP extension is in an invalid format.

It is not an SSJP.
The service version number is not supported.
The SSJP is not large enough

SSJPSTOR (20)

Request cannot be processed because required storage cannot be obtained. No data can be returned to the caller.

SSJPRETN Contents: In addition to the return code in SSOBRETN, the field SSJPRETN contains the service related error or more specific information about the error. SSJPRETN can be set to one of the following values if SSOBRETN is not zero:

Value (Decimal): Meaning
SSJPUNSF (4): Unsupported subfunction requested.
SSJPNTDS (8): SSJPUSER does not point to the correct control block.
SSJPUNSD (12): Version number in the control block pointed to by SSJPUSER is not correct.
SSJPSMLE (16): Length field in the control block pointed to by SSJPUSER is too small.
SSJPEYEE (20): Eyecatcher in the control block pointed to by SSJPUSER is not correct.
SSJPGETM (128): $GETMAIN failed.
SSJPSTGO (132): STORAGE OBTAIN failed.
SSJPINVA (136): Invalid filter arguments were specified.
SSJPGLBL (140): Function not supported on the global (JES3 only).
JPITJ2SC (256): User supplied group of JES2 is not valid with the service class
JPITWLJC (260): User supplied group of WLM is not valid with the job class
JPITWLST (264): User supplied group of WLM is not valid with a status filter other than ‘Active’
JPITEYLN (268): User provided bad storage for the Initiator Information service specific data area. Either the eyecatcher was incorrect, or the length of the data area was incorrect.
JPITJCLN (272): User supplied jobclass for the JES2 group filter is longer than one character.
JPITSAF (276): Internal error extracting caller's security token.
JPITINTE (280): Internal error building system information data area.
JPITSTRE (284): Not enough storage to return all data.
JPITDSRV (288): Internal DSERV error.
JPITASDS (292): ASDS not accessible.
JPITCMNE (296): JESPLEX communication error.

Initiator Information parameter list JPITD contents: For the Initiator Information service (function code SSJPITOD), the following parameters are returned in JPITD:

Field Name: Description
JPITVERO: Subsystem version number (X'0100' for z/OS® release V1R11, X'0200' for z/OS release V1R12 (JES2), X'0200' for z/OS release V1R13 (JES3)).
JPITDPTR: Pointer to the first Initiator Group data area in a chain.
JPITNIG: Number of Initiator data areas returned.
JPITMPTR: Pointer to the first system information data area.
JPITMNUM: Number of system information data areas returned.

For each initiator group that passes the filter requirements, an element is added to the chain pointed to by JPITDPTR. Each element is composed of the following sections:

DSECT Name: DSECT Description
ITGHDHDR: Initiator Group Header Section
ITGPDGRP: Initiator Group Prefix Section
ITGGDGGI: Initiator Group General Information Section

In addition to the common sections listed above, JES3 returns these additional initiator group sections:

DSECT Name: DSECT Description
IT3GDG3I: JES3 Initiator Group Information Section
IT3HDG3S: JES3 Initiator Group System Information Section will contain one or more IT3SDISY JES3 System Information Entry sections.
IT3SDISY: JES3 System Information Entry
IT3JDG3J: IT3JDG3J JES3 Initiator Group Jobclass Information Section will contain one or more IT3CD3JC JES3 Jobclass Entry sections.
IT3CD3JC: JES3 Jobclass Entry

Each Initiator Group has a chain of zero or more initiator entries. The first initiator is pointed to by field ITGHINIT in the Initiator Group Header section. A count of the number of initiators returned for the group is stored in field ITGHNINT in the Initiator Group Header section.

The data returned for each Initiator contains these sections:

DSECT Name: DSECT Description
ITIHDIHD: Initiator Header Section
ITIPDINT: Initiator Prefix Section
ITIGDIGI: Initiator General Information Section
IT2IDI2I: JES2 Initiator Information Section
IT2JDI2J: JES2 Initiator Jobclass Information Section will contain one or more of the IT2CDIJC entries.
IT2CDIJC: JES2 Jobclass Entry

The following example is a layout of the various sections of the Initiator Information output data area.

          INITIATOR GROUP HEADER SECTION                    
          +----------------+                                
 ITGHDHDR | ITGHNEXT  =-----------> POINTER TO THE NEXT     
          |                |        ITGHDHDR IN THE CHAIN.  
          | ITGHINIT  =--------+    ZERO IF END OF CHAIN.   
          | . . .          |   |                            
          +----------------+   |    NOTE: JES2 will always  
 ITGPDGRP | Prefix Section |   |          have 2 groups,    
          | . . .          |   |          one for JES2      
          +----------------+   |          and one for WLM   
 ITGGDGGI | General        |   |          initiators.       
          | Information    |   |          JES3 can have     
          | Section        |   |          multiple groups.  
          | . . .          |   |                            
          +----------------+   |                            
 IT3GDG3I | Optional JES3  |   |                            
          | Group          |   |                            
          | Info Section   |   |                            
          | . . .          |   |                            
          +----------------+   |                            
 IT3HDG3S | Optional JES3  |   |    NOTE: # elements is     
          | Group System   |   |          IT3H3SNS          
          | Info Section   |   |                            
          | . . .          |   |                            
          +----------------+   |                            
 IT3SDISY | Optional JES3  |   |                            
  (1..N)  | System Info    |   |                            
          | Array Elements |   |                            
          |                |   |                            
          +----------------+   |                            
 IT3JDG3J | Optional JES3  |   |    NOTE: # elements is     
          | Group Jobclass |   |          IT3JJCCT          
          | Info Section   |   |                            
          | . . .          |   |                            
          +----------------+   |                            
 IT3CD3JC | Optional JES3  |   |                            
  (1..N)  | Jobclass       |   |                            
          | Array Elements |   |                            
          |                |   |                            
          +----------------+   |                            
                               |                            
                               |                            
       +-----------------------+                            
       |                                                    
       |                                                    
       |  INITIATOR HEADER SECTION                         
       +->+----------------+                                
 ITIHDIHD |                |                                
          | ITIHNEXT -------------> POINTER TO THE NEXT     
          | . . .          |        ITIHDIHD IN THE CHAIN.  
          |                |        ZERO IF END OF CHAIN.   
          | ITIHSYSI  =-----------> Pointer to IAZJPLXI     
          |                |        for this initiator.     
          +----------------+          
 ITIPDINT | Prefix Section |                                
          | . . .          |                                
          +----------------+                                
 ITIGDIGI | General Info   |                                
          | Section        |                                
          | . . .          |                                
          +----------------+                                
 IT2IDI21 | Optional JES2  |        
          | Initiator Info |                                
          | Section        |                                
          | . . .          |                                
          +----------------+                                
 IT2JDI2J | Optional JES2  |        
          | Initiator      |                                
          | Jobclass Info  |                                
          | Section        |                                
          +----------------+                                
IT2CDIJC  | Optional JES2  | NOTE: # of elements is         
  (1..N)  | Jobclass       |       IT2JJCCT                 
          | Array Elements |                                
          |                |                                
          +----------------+                                


          SYSTEM/MEMBER INFORMATION AREA
          +----------------+
 ITSMHDR  |                | 
          | ITSMNEXT -------------> POINTER TO THE NEXT  
          |                |        ITSMHDR IN THE CHAIN.  
          |                |        ZERO IF END OF CHAIN.
          | ...            |
          +----------------+
 JPSYSPRF | Prefix Section |  
          | . . .          |  
          +----------------+
 JPSYSINF | System Info    |  
          | Section        |
          | . . .          |
          +--  --  --  -- -+ 
 JPSYSIFE | System         | NOTE: # of elements is
  (1..N)  | Information    |       JPSYNENT
          | Array Elements | 
          |                | 
          +----------------+

Initiator Group Header Section: Each Initiator Group information element begins with a Group Header. This section holds an offset to the group, system and class details, and holds a pointer to the initiator section, which is a chain of the initiators that pertain to this group.

The fields in the ITGHDHDR section are:

Field Name: Description
ITGHEYE: Eyecatcher. Is set to ‘DINITGRP'.
ITGHOHDR: Offset to first group section.
ITGHNEXT: Address of the next Initiator Group Information element.
ITGHINIT: Address of the first Initiator data area for this group.
ITGHNINT: The number of initiator data areas for this group.

Initiator Group Prefix Section: This holds the length of all the information reported for this group. This length does not include the length of the Group Header section. This length does include all storage needed to report both the Group, Class and System information.

The fields in the ITGPDGRP section are:

Field Name: Description
ITGPGLEN: Length of the entire element, not including the length of the Group Header.
ITGPGTYP: Type of this section.
ITGPGMOD: Modifier for this section.

Initiator Group General Information Section: The Group Name field ITGGGAM is set to ‘JES2’ when JES2 is reporting its initiators, and to ‘WLM’ when JES2 is reporting the WLM initiators. When JES3 is reporting its initiators, this field will be set to the configured JES3 Group Name.

The fields in the ITGGDGGI section are:

Field Name

Description

ITGGLEN

Length of this section.

ITGGTYPE

Type of this section

ITGGMOD

Modifier for this section

ITGGGNAM

Group Name

ITGGFLAG

Group Flags

Bit Name: Description
ITGGWLM: ON for WLM mode initiator group
OFF for JES mode initiator group

JES3 Group Information Section: This section contains general information about a JES3 group. It contains the group barrier definition, and reports if this is the JES3 default group.

The fields in the IT3GDG3I section are:

Field Name

Description

IT3GLEN

Length of this section

IT3GTYPE

Type of this section

IT3GMOD

Modifier for this section

IT3G3IBR

JES3 group barrier

Barrier: value
0-15: job priority
16: no barrier
PRTY: each job priority is a barrier

IT3GFLAG

JES3 group flag

Bit Name

Description

IT3GDEFG

ON if this is the JES3 default group

OFF if this is not the JES3 default group

JES3 Group System Information Section: This section contains an offset to the first JES3 System Information section, as well as the number of the JES3 System Information Entry sections.

The fields in the IT3HDG3S section are:

Field Name: Description
IT3HLEN: Length of this section
IT3HTYPE: Type of this section
IT3HMOD: Modifier for this section
IT3H3SOS: Offset to the first of the JES3 System Information Entry sections
IT3H3SNS: Number of JES3 System Information Entry sections
IT3H3SLS: Length of a JES3 System Information entry

JES3 System Information Entry: This section holds information about one of the systems on which the group is enabled to run.

The fields in the IT3SDISY section are:

Field Name

Description

IT3SSYSN

System Name

IT3SDICT

Count of initiators defined for this system

IT3SAICT

Count of initiators allocated for this system

IT3SUICT

Count of initiators in use for this system

IT3SFLAG

Flag Byte

Bit Name: Description
IT3SMANA: ON for Manual allocation
OFF for Dynamic Allocation
IT3SMANU: ON for Manual unallocation
OFF for Dynamic unallocation
IT3SENBS: ON - Group is enabled for scheduling on this system
OFF - Group is disabled for scheduling on this system

IT3SJSIE

Address of JPSYSIFE associated with this JES3 System Information entry.

JES3 Group Job-Class Information Section: This section contains an offset to the first JES3 Job-Class Information, as well as the number of the JES3 Job-Class Entry sections contained by this group.

The fields in the IT3JDG3J section are:

Field Name: Description
IT3JLEN: Length of this section
IT3JTYPE: Type of this section
IT3JMOD: Modifier for this section
IT3JJCOF: Offset to the first Job-Class Entry section
IT3JJCCT: Number of Job-Class Entry sections for this Group
IT3JJCLN: Length of a single Job-Class entry

JES3 Job-Class Entry: This section holds information about one of the Job-Classes contained by this Group.

The fields in the IT3CD3JC section are:

Field Name: Description
IT3CJCNM: Job-Class name
IT3CSENB: Bitmap relative to system entries in the Group System Information section. If bit is ON, Job-Class is enabled on the corresponding system.
IT3CSDEF: Bitmap relative to system entries in the Group System Information section. If bit is ON, Job-Class is defined on the corresponding system.
IT3CSEN2: Bitmap relative to JPSYSIFE system entries, which is anchored by JPITMPTR. Job-Class is enabled on the corresponding system.
IT3CSDE2: Bitmap relative to JPSYSIFE system entries, which is anchored by JPITMPTR. Job-Class is defined on the corresponding system.

Initiator Header Section: Each individual Initiator Information section begins with a header section. This section holds an offset to the start of the detailed initiator information, as well as a pointer to the next initiator defined for the group.

The fields in the ITIHDIHD section are:

Field Name: Description
ITIHIEYE: Eyecatcher. Is set to‘DINITDTA’.
ITIHOHDR: Offset to the prefix section
ITIHNEXT: Address of the next individual initiator information section.
ITIHSYSI: Address of JPSYSIFE for this initiator.

Initiator Prefix Section: This section holds the combined length of all the sections needed to report information about an individual initiator.

The fields in the ITIPDINT section are:

Field Name: Description
ITIPILEN: Combined length of the individual initiator sections. This does not include the length of the header section.
ITIPITYP: Type of this section
ITIPIMOD: Modifier for this section

Initiator General Information Section: This section holds general information about an individual initiator.

The fields in the ITIGDIGI section are:

Field Name

Description

ITIGIILN

Length of this section

ITIGIITY

Type of this section

ITIGIIMD

Modifier for this section

ITIGASID

Address Space Identifier for the initiator job

ITIGSTAT

Initiator Status flag

Bit Value: Description
ITIGIDRI: Draining
ITIGDDRD: Drained
ITIGIHLI: Halting
ITIGIHLD: Halted
ITIGIINA: Inactive
ITIGIACT: Active
ITIGISTR: Starting

ITIGMVSN

MVS™ System name

ITIGSID

JES Member name

The following fields are associated with the currently active batch job in the initiator:

ITIGJNAM: Job name from the job card
ITIGJBID: Job ID of the batch job
ITIGOWNR: User ID from the job card
ITIGSTEP: Job step name
ITIGPRSN: Procedure step name
ITIGSECL: SECLABEL for the address space
ITIGJCLS: Job class
ITIGSCLS: If the currently active job is JES managed, this is the service class of that job. If the job is WLM managed, this is the service class the WLM Initiator is currently selecting on.

Note: Information on the job that is currently active on the initiator is only returned if the SSI caller is authorized to access data for the job, specifically, if the caller's security label dominates the security label of the job.

JES2 Initiator Information Section: This information is not available for WLM managed initiators.

The fields in the IT2IDI2I section are:

Field Name: Description
IT2ILEN: Length of this section
IT2ITYPE: Type of this section
IT2IMOD: Modifier for this section
IT2IITID: Initiator partition identifier
ITIITJI: Initiator job identifier

JES2 Initiator Job-Class Information Section: This information is not available for WLM managed initiators. Field IT2JJCOS is the offset to the first job-class entry section, and field IT2JJCCT indicates the number of job-class entries. The length of these entries is stored in IT2JJCLN, and these entries follow immediately after this section.

The fields in the IT2JDI2J section are:

Field Name: Description
IT2JLEN: Length of this section
IT2JTYPE: Type of this section
IT2JMOD: Modifier for this section
ITJJCOS: Offset to the first job-class entry
ITJJCCT: Number of job-class entries
ITJJCLN: Length of a single job-class entry

JES2 Job-Class Entry: Each JES2 Initiator can support multiple job classes.

The fields in the IT2CDIJC section are:

Field Name

Description

IT2CJCNM

Job class or job class group name

IT2CFLAG

Flag byte

Bit Name: Description
IT2CJCWY: ON if the job class is WLM eligible; OFF if the job class is not WLM eligible
IT2CJGRP: ON if IT2CJCNM is a job class group name; OFF if it is a job class name