Note: For a key that is documented as returning
a BINARY(8) UNSIGNED value, the QGYOLJOB API
may return a 'C' rather than the expected 'B'.
This is done for compatibility with older implementations.
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Receiver variable definition information | Output | Char(*) |
| 5 | Length of receiver variable definition information | Input | Binary(4) |
| 6 | List Information | Output | Char(80) |
| 7 | Number of records to return | Input | Binary(4) |
| 8 | Sort information | Input | Char(*) |
| 9 | Job selection information | Input | Char(*) |
| 10 | Size of job selection information | Input | Binary(4) |
| 11 | Number of fields to return | Input | Binary(4) |
| 12 | Key of fields to be returned | Input | Array(*) of Binary(4) |
| 13 | Error Code | I/O | Char(*) |
| 14 | Job selection format name | Input | Char(8) |
| 15 | Reset status statistics | Input | Char(1) |
| 16 | General return data | Output | Char(*) |
| 17 | Length of general return data | Input | Binary(4) |
The Open List of Jobs (QGYOLJOB) API generates a list of jobs on the system. The list is based on specified selection criteria. The filtered list may then be sorted depending on the value of the sort parameter. Upon successful completion of this API, a handle is returned in the list information parameter. You may use this handle on subsequent calls to the following APIs:
None.
The variable that is used to return the job information.
The length of the receiver variable. This must be large enough to hold at least one record of information.
The format of the job list to be returned. If format OLJB0200 is specified, the fields that are selected by the caller are returned for each job in the list. This format is slower than the OLJB0100 format. The performance varies depending on the number of fields selected.
The possible format names follow:
| OLJB0100 | Basic job list. |
| OLJB0200 | Basic job list with keyed return fields. |
| OLJB0300 | Active job list with keyed return fields. |
See Format of Receiver Variable for more information.
The variable that is used to return the description of how the keyed portion of the list is returned in the receiver variable. This variable is not filled in if the OLJB0100 format is used. See Format of Receiver Variable Definition Information for a description of the layout of this parameter.
The length of the receiver variable definition information. This must be large enough to hold the information for all key fields that are specified in the key of fields to be returned parameter.
Information about the list that is created by this program. For a description of the layout of this parameter, see Open list information format.
The number of records in the list to put into the receiver variable after filtering and sorting have been done.
Information on what fields within the record of information to sort. See Format of Sort Information for a description of the layout of this parameter.
Information that is used for selecting which jobs to include in the list. See Format of Job Selection Information for a description on the layout of this parameter.
The size, in bytes, of the job selection information parameter. The minimum value required for this parameter is 60 (or 108 with selection format OLJS0200).
The number of fields to return. If this parameter is 0, the key of fields to be returned parameter is not used, the receiver variable definition information parameter is not modified, and the length of receiver variable definition information must be 0. This field must be set to 0 when the format is set to OLJB0100.
The list of the fields to be returned. For a list of valid key fields allowed on the OLJB0200 format, see List of Keys Supported for Format OLJB0200. For a list of valid key fields allowed on the OLJB0300 format, see List of Keys Supported for Format OLJB0300.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The format of the job selection information input. If this parameter is not specified, the OLJS0100 format is used. The possible format names follow:
| OLJS0100 | Basic selection information. |
| OLJS0200 | Additional selection information. |
See the Format of Job Selection Information for more information.
Optional Parameter Group 2 applies only when the format is OLJB0300.
The elapsed time and all the key fields that are based on the elapsed time are reset to zero. If a format other than OLJB0300 is specified, this field needs to be zero. The default value for this field is zero. The following special values may be specified:
| 0 | The elapsed time and the key fields based on the elapsed time are not reset. |
| 1 | The elapsed time and the key fields based on the elapsed time are reset back to zero. |
General output information that applies to the OLJB0300 format. See General Return Data for a description of the data returned. This field is used only if the Length of general return data is greater than 8.
The length of the general output information. The general output information field must be a minimum of 8 bytes or 0 when the format is not OLJB0300. The default value for this field is 0.
The following tables describe the order and format of the data that is returned in the receiver variable.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name used |
| 10 | A | CHAR(10) | User name used |
| 20 | 14 | CHAR(6) | Job number used |
| 26 | 1A | CHAR(16) | Internal job identifier |
| 42 | 2A | CHAR(10) | Status |
| 52 | 34 | CHAR(1) | Job type |
| 53 | 35 | CHAR(1) | Job subtype |
| 54 | 36 | CHAR(2) | Reserved |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(56) | Everything in OLJB0100 format |
| 56 | 38 | CHAR(1) | Job information status |
| 57 | 39 | CHAR(3) | Reserved |
| This information repeats for each key selected. | CHAR(*) or BINARY(4) | Data | |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name used |
| 10 | A | CHAR(10) | User name used |
| 20 | 14 | CHAR(6) | Job number used |
| 26 | 1A | CHAR(4) | Active job status |
| 30 | 1E | CHAR(1) | Job type |
| 31 | 1F | CHAR(1) | Job subtype |
| 32 | 20 | BINARY(4) | Total length of data returned |
| 36 | 24 | CHAR(4) | Reserved |
| This information repeats for each key selected. | CHAR(*) or BINARY(4) | Data | |
Active job status. The active status of the initial thread of the job. For the list of possible values, see the active job status field in the Work Management API Attribute Descriptions (WMAttrDesc).
Data. The data returned for the key field.
Internal job identifier. A value that is sent to other APIs to speed the process of locating the job on the system. Only APIs that are described in this topic use this identifier. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.
Job information status. Whether the information was available for the job. The possible values follow:
| blank | The information was available. |
| L | The information was not available because the job was not accessible. |
Job name used. The name of the job as identified to the system. For an interactive job, the system assigns the job the name of the workstation where the job started. For a batch job, you specify the name in the command when you submit the job.
Job number used. The system-assigned job number.
Job subtype. Additional information about the job type (if any exists). Refer to Comparing Job Type and Subtype with the Work with Active Job Command in the Retrieve Job Information (QUSRJOBI) API for information about how the job type field and the job subtype field equate to the type field in the Work with Active Job (WRKACTJOB) command. The possible values follow:
| blank | The job has no special subtype. |
| D | The job is a batch immediate job. |
| E | The job started with a procedure start request. |
| F | The job is a System i® Advanced 36® machine server job. |
| J | The job is a prestart job. |
| P | The job is a print driver job. |
| T | The job is a System/36™ multiple requester terminal (MRT) job. |
| U | The job is an alternate spool user. |
Job type. The type of job. Refer to Comparing Job Type and Subtype with the Work with Active Job Command in the Retrieve Job Information (QUSRJOBI) API for information about how the job type field and the job subtype field equate to the type field in the Work with Active Job (WRKACTJOB) command. The possible values for this field follow:
| A | The job is an autostart job. |
| B | The job is a batch job. |
| I | The job is an interactive job. |
| M | The job is a subsystem monitor job. |
| R | The job is a spooled reader job. |
| S | The job is a system job. |
| W | The job is a spooled writer job. |
| X | The job is the start-control program-function (SCPF) system job. |
| blank | The job has no type. A possible reason is the job was not found. |
Reserved. An ignored field.
Status. The status of the job. The valid values follow:
| *ACTIVE | The job has started, and it can use system
resources (processing unit, main storage, and so on). This value does not
guarantee that the job is currently running, however. For example, an active
job may be in one of the following states where it is not in a position to use
system resources:
|
| *JOBQ | The job is currently on a job queue. The job may have been previously active and was placed back on the job queue because of the Transfer Job (TFRJOB) or Transfer Batch Job (TFRBCHJOB) command, or the job was never active because it was just submitted. |
| *OUTQ | The job has completed running and has spooled output that has not yet printed. |
| blank | The job has no status. A possible reason is the job was not found. |
Total length of data returned. The length of the data portion of the returned data. This includes the sum of all the keyed data for the job.
User name used. The user profile under which the job is run. The user name is the same as the user profile name and can come from several different sources depending on the type of job.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of fields returned |
| These fields repeat, in the order listed, for each key selected. | BINARY(4) | Length of field information returned | |
| BINARY(4) | Key field | ||
| CHAR(1) | Type of data | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Length of data | ||
| BINARY(4) | Displacement to data | ||
Displacement to data. The displacement from the beginning of the job record to the value for this key.
Key field. The field returned. See List of Keys Supported for Format OLJB0200 for the list of valid keys supported for the OLJB0200 format. See List of Keys Supported for Format OLJB0300 for the list of valid keys supported for the OLJB0300 format.
Length of data. The length of the data returned for the field.
Length of field information returned. The total length of definition information returned for this field. This value is used to increment to the next field in the list.
Number of fields returned. The number of fields in each record that is returned to the application.
Reserved. An ignored field.
Type of data. The type of data that is returned.
Note: For a key that is documented as returning
a BINARY(8) UNSIGNED value, the QGYOLJOB API
may return a 'C' rather than the expected 'B'.
This is done for compatibility with older implementations.
| C | The data is returned in character format. |
| B | The data is returned in binary format. |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of keys to sort on |
| Offsets vary. These fields repeat for each sort key field. | BINARY(4) | Sort key field starting position | |
| BINARY(4) | Sort key field length | ||
| BINARY(2) | Sort key field data type | ||
| CHAR(1) | Sort order | ||
| CHAR(1) | Reserved | ||
Number of keys to sort on. The number of fields within the record structure to sort on. If 0 is specified, the list is not sorted.
The following special value is supported for format OLJB0200 only. Also, the job selection information must be set to return only the jobs that are waiting to run from a single job queue.
| -1 | The list of jobs that are waiting to run on the specified job queue are returned in the order they will be selected off the job queue to become active. When this special value is used, the job queue priority (1005), data and time job was put on this job queue (0404), and the date and time job is scheduled to run (0403) keys must be included in the list of key fields to return. |
The following special value is supported for format OLJB0300 only.
| -2 | The list of active jobs is returned grouped by subsystem, with each subsystem monitor job followed by the jobs that are running in that subsystem. The jobs are sorted alphabetically by subsystem name, and then by job name within the subsystem. This sort order is similar to the way the jobs are displayed on the Work with Active Jobs (WRKACTJOB SEQ(*SBS)) display. When this special value is used, the subsystem description name (1906) key must be included in the list of key fields to return. |
Reserved. Reserved field. This field must be set to hexadecimal or binary zero.
Sort key field data type. The data type of the field to sort on. Refer to the key data type field in the Sort (QLGSORT) API for information on the list of data types available.
Sort key field length. The length of the field to sort on.
Sort key field starting position. Within the record of information, the starting position of the field to sort on. A value of 1 represents the first position within the record.
Sort order. Whether the list should be sorted in ascending or descending order according to the key.
| 1 | Sort in ascending order. |
| 2 | Sort in descending order. |
The organization of the job selection information parameter is shown below. A description of the fields in the parameter follows the table.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name |
| 10 | 0A | CHAR(10) | User name |
| 20 | 14 | CHAR(6) | Job number |
| 26 | 1A | CHAR(1) | Job type |
| 27 | 1B | CHAR(1) | Reserved (ignored) |
| 28 | 1C | BINARY(4) | Offset to primary job status array |
| 32 | 20 | BINARY(4) | Number of primary job status entries |
| 36 | 24 | BINARY(4) | Offset to active job status array |
| 40 | 28 | BINARY(4) | Number of active job status entries |
| 44 | 2C | BINARY(4) | Offset to jobs on job queue status array |
| 48 | 30 | BINARY(4) | Number of jobs on job queue status entries |
| 52 | 34 | BINARY(4) | Offset to job queue names array |
| 56 | 38 | BINARY(4) | Number of job queue names entries |
| The offsets to these fields are specified in the previous offset variables. | ARRAY(*) of CHAR(10) | Primary job status | |
| ARRAY(*) of CHAR(4) | Active job status | ||
| ARRAY(*) of CHAR(10) | Jobs on job queue status | ||
| ARRAY(*) of CHAR(20) | Job queue names | ||
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(60) | Everything in fixed portion of OLJS0100 format |
| 60 | 3C | BINARY(4) | Offset to current user profile array |
| 64 | 40 | BINARY(4) | Number of current user profile entries |
| 68 | 44 | BINARY(4) | Offset to server type array |
| 72 | 48 | BINARY(4) | Number of server type entries |
| 76 | 4C | BINARY(4) | Offset to the active subsystem array |
| 80 | 50 | BINARY(4) | Number of active subsystem entries |
| 84 | 54 | BINARY(4) | Offset to the memory pool array |
| 88 | 58 | BINARY(4) | Number of memory pool entries |
| 92 | 5C | BINARY(4) | Offset to the job type - enhanced array |
| 96 | 60 | BINARY(4) | Number of job type - enhanced entries |
| 100 | 64 | BINARY(4) | Offset to the qualified job name array |
| 104 | 68 | BINARY(4) | Number of qualified job name entries |
| The offsets to these fields are specified in the previous offset variables. | ARRAY(*) | Arrays from OLJS0100 format | |
| ARRAY(*) of CHAR(10) | Current user profile | ||
| ARRAY(*) of CHAR(30) | Server type | ||
| ARRAY(*) of CHAR(10) | Active subsystem | ||
| ARRAY(*) of BINARY(4) | Memory pool | ||
| ARRAY(*) of BINARY(4) | Job type - enhanced | ||
| ARRAY(*) of CHAR(26) | Qualified job name | ||
Active job status. The active status of the initial threads of the jobs to be included in the list. For the list of possible values, see the active job status field in the Work Management API Attribute Descriptions (WMAttrDesc). (For compatibility with previous releases, the CLDW status can be specified in the active job status array. The CLDW status is not returned, however, for any jobs.)
Active subsystem. The active subsystem under which the job is currently running.
Current user profile. The user profile under which the initial thread of the job is currently running. This name may differ from the user portion of the job name. The current user profile is blank for jobs that are not active.
Job name. A specific job name, a generic name, or one of the following special values:
| * | Only the job in which this program is running. The user name and job name fields must be blank. |
| *CURRENT | All jobs with the current job's name. |
| *ALL | All jobs. The user name and job type fields must be specified. |
| blank | This field must be blank when using the Qualified job name array. |
Job number. A specific job number or one of the following special values:
| *ALL | Jobs with the specified job name and user name, regardless of the job number. The job name and user name fields must be specified. |
| blank | This field must be blank when using the Qualified job name array. |
Job queue names. The job queue names. Jobs on these job queues are included in the list. The first 10 characters contain the job queue name, and the last 10 characters contain the library name.
Jobs on job queue status. The status of the jobs on the job queue to be included in the list. The possible values follow:
| SCD | This job will run as scheduled. |
| HLD | This job is being held on the job queue. |
| RLS | This job is ready to be selected. |
Job type. The type of job to be listed. The possible values follow:
| * | This value lists all job types. |
| A | The job is an autostart job. |
| B | The job is a batch job. |
| I | The job is an interactive job. |
| M | The job is a subsystem monitor job. |
| R | The job is a spooled reader job. |
| S | The job is a system job. |
| W | The job is a spooled writer job. |
| X | The job is the SCPF system job. |
Job type - enhanced. The type of job to be listed. This field combines the Job type and Job Subtype fields. The possible values are:
| 110 | Autostart job. |
| 200 | All the batch job types. |
| 210 | Batch job. |
| 220 | Batch immediate job. |
| 230 | Batch - System/36 multiple requester terminal (MRT) job. |
| 240 | Batch - Alternate spool user |
| 310 | Communications job - procedure start request job. |
| 900 | All interactive type jobs. |
| 910 | Interactive job. |
| 920 | Interactive job - Part of group. |
| 930 | Interactive job - Part of system request pair. |
| 940 | Interactive job - Part of system request pair and part of a group. |
| 1600 | All prestart jobs. |
| 1610 | Prestart job. |
| 1620 | Prestart batch job. |
| 1630 | Prestart communications job. |
| 1810 | Reader job. |
| 1910 | Subsystem job. |
| 1920 | System job. |
| 2310 | Writer job. |
Memory pool. The identifier of the system memory pool in which the job started running. The identifier is a number in the range of 1 - 64.
Number of active job status entries. The number of entries that are specified for the active job status array. If this value is 0, no filtering is done on active job status. The offset to active job status array and the active job status array fields are not used. If the value is not 0, the primary job status array must include an array entry of *ACTIVE or the number of primary job status array entries should be specified as 0 to indicate that no filtering is done on the primary job status.
Number of active subsystem entries. The number of entries that are specified for the active subsystem array. If this value is 0, no filtering is done on active subsystems, and the offset to the active subsystem array and the active subsystem array fields are not used. This value must be 0 when format OLJB0100 or OLJB0200 is specified.
Number of current user profile entries. The number of entries that are specified for the current user profile array. If this value is 0, no filtering is done on the current user profile, and the offset to current user profile array and the current user profile array fields are not used.
Number of job queue names entries. The number of entries that is specified for the job queue names array. If this value is 0, no filtering is done on the job queue names. The offset to job queue names array and the job queue names array fields are not used. If this value is not 0, the primary job status array must include an array entry of *JOBQ or the number of primary job status array entries should be specified as 0 to indicate that no filtering is done on the primary job status. This value must be 0 when format OLJB0300 is specified.
Number of jobs on job queue status entries. The number of entries that are specified for the jobs on job queue status array. If this value is 0, no filtering is done on the jobs on job queue status array. The offset to jobs on job queue status array and the jobs on job queue status array fields are not used. If this value is not 0, the primary job status array must include an array entry of *JOBQ or the number of primary job status array entries should be specified as 0 to indicate that no filtering is done on the primary job status. This value must be 0 when format OLJB0300 is specified.
Number of job type - enhanced entries. The number of entries that are specified for the job type - enhanced array. If this value is 0, no filtering is done on the job type - enhanced array. The offset to job type - enhanced array and the job type - enhanced array fields are not used.
Number of memory pool entries. The number of entries that are specified for the memory pool name array. If this value is 0, no filtering is done on memory pool, and the offset to the memory pool name array and the memory pool name array fields are not used. This value must be 0 when format OLJB0100 or OLJB0200 is specified.
Number of primary job status entries. The number of entries that are specified for the primary job status array. If 0 is specified, no filtering is done on the primary job status, and the offset to primary job status array and the primary job status array fields are not used. This value must be 0 when format OLJB0300 is specified.
Number of qualified job name entries. The number of entries that are specified for the qualified job name array. If 0 is specified, no filtering is done on the qualified job name, and the offset to qualified job name array and the qualified job name array fields are not used. This value must be 0 when format OLJB0300 is specified. This value must be 0 when anything other than blanks are specified in the job name, user name, or job number fields. The same number of jobs will be returned in the list of returned jobs. For jobs that are not found, the Status, Job type, and Job subtype fields will be set to blanks and the Job information status field will be set to 'L'.
Number of server type entries. The number of entries that is specified for the server type array. If this value is 0, no filtering is done on the server type. Also, the offset to server type array and the server type array fields are not used.
Offset to active job status array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the active job status array.
Offset to active subsystem array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the active subsystem array.
Offset to current user profile array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the current user profile array.
Offset to job queue names array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the job queue names array.
Offset to jobs on job queue status array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the jobs on job queue status array.
Offset to job type - enhanced array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the job type - enhanced array.
Offset to memory pool array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the memory pool name array.
Offset to primary job status array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the primary job status array.
Offset to qualified job name array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the qualified job name array.
Offset to server type array. The offset in characters (bytes) from the beginning of the job selection information structure to the beginning of the server type array.
Primary job status. The primary status of the jobs to be included in the list. The possible special values follow:
| *ACTIVE | Active jobs. This includes group jobs, system request jobs, and disconnected jobs. |
| *JOBQ | Jobs that are currently on job queues. |
| *OUTQ | Jobs that have completed running but still have output on an output queue. |
Qualified job name. The qualfied job name. The first 10 characters are the job name. The second 10 characters are the user name of the job. The last 6 characters are the job number.
Reserved (ignored). An ignored field.
Reserved (must be 0). Reserved field. This field must be set to zero.
Server type. The type of server represented by the job. Servers provided by IBM start with QIBM. A server type, a generic value, or one of the following special values can be specified:
| *ALL | All jobs with a server type. |
| *BLANK | All jobs without a server type. |
User name. A specific user profile name, a generic name, or one of the following special values:
| *CURRENT | Jobs that use the current job's user profile. |
| *ALL | Jobs that use the specified job name, regardless of the user name. The job name and job number fields must be specified. |
| blank | This field must be blank when using the Qualified job name array. |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(8), UNSIGNED | Elapsed time |
| 16 | 10 | CHAR(*) | Reserved |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Elapsed time. The time, in milliseconds, that has elapsed between the measurement start time and the current system time. This value is 0 the first time this API is called by this job. The measurement start is set the first time this API is called and when the Reset status statistics is set to reset the elapsed time.
Reserved. An ignored field.
The following table contains a list of the valid keys for format OLJB0200. The descriptions of all the valid key attributes are described in Work Management API Attribute Descriptions (WMAttrDesc).
| Key | Type | Description |
|---|---|---|
| 101 | CHAR(4) | Active job status |
| 102 | CHAR(1) | Allow multiple threads |
| 103 | CHAR(4) | Active job status for jobs ending |
| 201 | CHAR(10) | Break message handling |
| 301 | CHAR(1) | Cancel key |
| 302 | BINARY(4) | Coded character set ID |
| 303 | CHAR(2) | Country or region ID |
| 304 | BINARY(4) | Processing unit time used, if less than 2,147,483,647 milliseconds |
| 305 | CHAR(10) | Current user profile |
| 306 | CHAR(1) | Completion status |
| 307 | BINARY(4) | Current system pool identifier |
| 311 | CHAR(10) | Character identifier control |
| 312 | BINARY(8), UNSIGNED | Processing unit time used - total for the job |
| 313 | BINARY(8), UNSIGNED | Processing unit time used for database - total for the job (Deprecated) |
| 401 | CHAR(13) | Date and time job became active |
| 402 | CHAR(13) | Date and time job entered system |
| 403 | CHAR(8) | Date and time job is scheduled to run |
| 404 | CHAR(8) | Date and time job was put on this job queue |
| 405 | CHAR(4) | Date format |
| 406 | CHAR(1) | Date separator |
| 407 | CHAR(1) | DBCS-capable |
| 408 | CHAR(10) | DDM conversation handling |
| 409 | BINARY(4) | Default wait |
| 410 | CHAR(13) | Device recovery action |
| 411 | CHAR(10) | Device name |
| 412 | BINARY(4) | Default coded character set identifier |
| 413 | CHAR(1) | Decimal format |
| 418 | CHAR(13) | Date and time job ended |
| 423 | BINARY(4) | Day of week |
| 501 | BINARY(4) | End severity |
| 502 | CHAR(1) | End status |
| 503 | CHAR(1) | Exit key |
| 601 | CHAR(10) | Function name |
| 602 | CHAR(1) | Function type |
| 701 | CHAR(1) | Signed-on job |
| 702 | CHAR(10) | Group profile name |
| 703 | CHAR(150) | Group profile name - supplemental |
| 901 | CHAR(10) | Inquiry message reply |
| 1001 | CHAR(15) | Job accounting code |
| 1002 | CHAR(7) | Job date |
| 1003 | CHAR(20) | Job description name - qualified |
| 1004 | CHAR(20) | Job queue name - qualified |
| 1005 | CHAR(2) | Job queue priority |
| 1006 | CHAR(8) | Job switches |
| 1007 | CHAR(10) | Job message queue full action |
| 1008 | BINARY(4) | Job message queue maximum size |
| 1012 | CHAR(10) | Job user identity |
| 1013 | CHAR(1) | Job user identity setting |
| 1014 | BINARY(4) | Job end reason |
| 1015 | CHAR(1) | Job log pending |
| 1016 | BINARY(4) | Job type - enhanced |
| 1017 | CHAR(8) | Job local time |
| 1018 | CHAR(10) | Job log output |
| 1019 | CHAR(10) | Job description library ASP device name |
| 1020 | CHAR(10) | Job queue library ASP device name |
| 1201 | CHAR(3) | Language ID |
| 1202 | CHAR(1) | Logging level |
| 1203 | CHAR(10) | Logging of CL programs |
| 1204 | BINARY(4) | Logging severity |
| 1205 | CHAR(10) | Logging text |
| 1301 | CHAR(8) | Mode name |
| 1302 | BINARY(4) | Maximum processing unit time |
| 1303 | BINARY(4) | Maximum temporary storage in kilobytes |
| 1304 | BINARY(4) | Maximum threads |
| 1305 | BINARY(4) | Maximum temporary storage in megabytes |
| 1306 | CHAR(10) | Memory pool name |
| 1307 | CHAR(1) | Message reply |
| 1308 | CHAR(4) | Message key, when active job waiting for a message |
| 1309 | CHAR(20) | Message queue name - qualified, when active job waiting for a message |
| 1310 | CHAR(10) | Message queue library ASP device name, when active job waiting for a message |
| 1401 | BINARY(4) | Number of auxiliary I/O requests, if less than 2,147,483,647 |
| 1402 | BINARY(4) | Number of interactive transactions |
| 1403 | BINARY(4) | Number of database lock waits |
| 1404 | BINARY(4) | Number of internal machine lock waits |
| 1405 | BINARY(4) | Number of nondatabase lock waits |
| 1406 | BINARY(8), UNSIGNED | Number of auxiliary I/O requests |
| 1501 | CHAR(20) | Output queue name - qualified |
| 1502 | CHAR(2) | Output queue priority |
| 1601 | CHAR(10) | Print key format |
| 1602 | CHAR(30) | Print text |
| 1603 | CHAR(10) | Printer device name |
| 1604 | CHAR(10) | Purge |
| 1605 | BINARY(4) | Product return code |
| 1606 | BINARY(4) | Program return code |
| 1607 | CHAR(8) | Pending signal set |
| 1608 | BINARY(4) | Process ID number |
| 1801 | BINARY(4) | Response time total |
| 1802 | BINARY(4) | Run priority (job) |
| 1803 | CHAR(80) | Routing data |
| 1901 | CHAR(20) | Sort sequence table - qualified |
| 1902 | CHAR(10) | Status message handling |
| 1903 | CHAR(10) | Status of job on the job queue |
| 1904 | CHAR(26) | Submitter's job name - qualified |
| 1905 | CHAR(20) | Submitter's message queue name - qualified |
| 1906 | CHAR(20) | Subsystem description name - qualified |
| 1907 | BINARY(4) | System pool identifier |
| 1908 | CHAR(10) | Special environment |
| 1909 | CHAR(8) | Signal blocking mask |
| 1910 | BINARY(4) | Signal status |
| 1911 | CHAR(30) | Server type |
| 1982 | CHAR(10) | Spooled file action |
| 2001 | CHAR(1) | Time separator |
| 2002 | BINARY(4) | Time slice |
| 2003 | CHAR(10) | Time-slice end pool |
| 2004 | BINARY(4) | Temporary storage used in kilobytes |
| 2005 | BINARY(4) | Time spent on database lock waits |
| 2006 | BINARY(4) | Time spent on internal machine lock waits |
| 2007 | BINARY(4) | Time spent on nondatabase lock waits |
| 2008 | BINARY(4) | Thread count |
| 2009 | BINARY(4) | Temporary storage used in megabytes |
| 2020 | CHAR(10) | Time zone current abbreviated name |
| 2021 | CHAR(50) | Time zone current full name |
| 2022 | CHAR(7) | Time zone current message identifier |
| 2023 | BINARY(4) | Time zone current offset |
| 2024 | CHAR(10) | Time zone description name |
| 2025 | CHAR(20) | Time zone message file name - qualified |
| 2026 | CHAR(1) | Time zone Daylight Saving Time indicator |
| 2027 | BINARY(4) | Time zone year offset |
| 2101 | CHAR(24) | Unit of work ID |
| 2102 | BINARY(4) | User return code |
The following table contains a list of the valid keys for format OLJB0300. The descriptions of all the valid key attributes are described in Work Management API Attribute Descriptions (WMAttrDesc).
| Key | Type | Description |
|---|---|---|
| 103 | CHAR(4) | Active job status for jobs ending |
| 305 | CHAR(10) | Current user profile |
| 312 | BINARY(8), UNSIGNED | Processing unit time used - total for the job |
| 313 | BINARY(8), UNSIGNED | Processing unit time used for database - total for the job (Deprecated) |
| 314 | BINARY(4) | Processing unit used - percent during the elapsed time (job) |
| 315 | BINARY(8), UNSIGNED | Processing unit used - time during the elapsed time (job) |
| 316 | BINARY(4) | Processing unit used for database - percent during the elapsed time (job) (Deprecated) |
| 317 | BINARY(8), UNSIGNED | Processing unit used for database - time during the elapsed time (job) (Deprecated) |
| 402 | CHAR(13) | Date and time job entered system |
| 414 | BINARY(8), UNSIGNED | Disk I/O count during the elapsed time (job) |
| 415 | BINARY(8), UNSIGNED | Disk I/O count - total for the job |
| 416 | BINARY(8), UNSIGNED | Disk I/O count during the elapsed time - asynchronous I/O (job) |
| 417 | BINARY(8), UNSIGNED | Disk I/O count during the elapsed time - synchronous I/O (job) |
| 502 | CHAR(1) | End status |
| 601 | CHAR(10) | Function name |
| 602 | CHAR(1) | Function type |
| 902 | CHAR(16) | Internal job identifier |
| 904 | BINARY(4) | Interactive response time - total during the elapsed time |
| 905 | BINARY(4) | Interactive transactions - count during the elapsed time |
| 1012 | CHAR(10) | Job user identity |
| 1014 | BINARY(4) | Job end reason |
| 1015 | CHAR(1) | Job log pending |
| 1016 | BINARY(4) | Job type - enhanced |
| 1306 | CHAR(10) | Memory pool name |
| 1307 | CHAR(1) | Message reply |
| 1308 | CHAR(4) | Message key, when active job waiting for a message |
| 1309 | CHAR(20) | Message queue name - qualified, when active job waiting for a message |
| 1310 | CHAR(10) | Message queue library ASP device name, when active job waiting for a message |
| 1609 | BINARY(8), UNSIGNED | Page fault count during the elapsed time (job) |
| 1802 | BINARY(4) | Run priority (job) |
| 1906 | CHAR(20) | Subsystem description name - qualified |
| 1911 | CHAR(30) | Server type |
| 1982 | CHAR(10) | Spooled file action |
| 2008 | BINARY(4) | Thread count |
The conditions under which this API is threadsafe are the same as those described in the Usage Notes for the Retrieve Job Information (QUSRJOBI) API.
When collecting performance statistics,
it is important to provide an adequate time interval.
The reported values reflect both
the performance of the job that the API is looking at
and the performance of the job that the API is running in.
For example, you may see percentages greater than 100%
because of the way the API interacts with the job that it is sampling.
| Message ID | Error Message Text |
|---|---|
| CPF1865 E | Value &1 for job type not valid. |
| CPF1866 E | Value &1 for number of fields to return not valid. |
| CPF1867 E | Value &1 in list not valid. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C39 E | Value for reserved field not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CB1 E | Value &1 for job status is not valid. |
| CPF3CB2 E | Value specified for job parameter is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| GUI0002 E | &2 is not valid for length of receiver variable. |
| GUI0024 E | &1 is not valid for number of keys to sort on. |
| GUI0025 E | &1 is not valid for sort key field starting position. |
| GUI0026 E | &1 is not valid for sort key field length. |
| GUI0027 E | &1 is not valid for number of records to return. |
| GUI0049 E | Key 1903 for status of jobs on job queues is not specified. |
| GUI0052 E | &1 is not valid for active status. |
| GUI0119 E | Reserved field in sort information not valid. |
| GUI0120 E | Order field in sort information not valid. |
| GUI0121 E | Printer name cannot be specified when format LSPL0100 is requested. |
| GUI0122 E | Number of primary job status entries not valid. |
| GUI0123 E | Active status key must be specified. |
| GUI0124 E | Primary status array must include *ACTIVE. |
| GUI0125 E | Status of job on job queue key must be specified. |
| GUI0126 E | Primary status array must include *JOBQ. |
| GUI0127 E | Number of job queue names not valid. |
| GUI0128 E | Job queue name key must be specified. |
| GUI0129 E | Number of active job status entries not valid. |
| GUI0130 E | Number of jobs on job queue status entries not valid. |
| GUI0131 E | &2 is not valid for length of job selection criteria. |
| GUI0132 E | &2 is not valid for length of receiver variable definition information. |
| GUI0133 E | Format OLJB0200 must be specified. |
| GUI0134 E | &2 not valid for length of job selection information. |
| GUI0137 E | Current user key must be specified. |
| GUI0138 E | Server type key must be specified. |
| GUI0139 E | Number of current users not valid. |
| GUI0140 E | Number of server types not valid. |
| GUI0142 E | Format OLJB0300 valid for active jobs only. |
| GUI0143 E | Number of memory pool names not valid. |
| GUI0144 E | Number of active subsystem names not valid. |
| GUI0145 E | All optional parameters must be specified. |
| GUI0146 E | Filter information not correct for format OLJB0200. |
| GUI0147 E | Required keys not specified. |
| GUI0148 E | Number of job type enhanced values not valid. |
| GUI0149 E | &1 is not valid for number of keys to sort on. |
| GUI0150 E | Subsystem key must be specified. |
| GUI0151 E | Job type enhanced key must be specified. |