COZTOOLS - Retrieve JOBD Attr. (RTVJOBDA)

The COZTOOLS - Retrieve JOBD Attributes (RTVJOBDA) command may be used to retrieve information associated with an existing JOBD (job description) object. Several attributes as well as the Library List associated with the JOBD may be retrieved.

Restrictions:

This command must be run within a CL program only.

Parameters

Keyword	Description	Choices	Notes
JOBD	Job Description	Qualified object name	Required, Positional 1
	Qualifier 1: Job Description	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
RTNJOBDLIB	Job Description Library (10)	Character value	Optional, Positional 2
JOBQ	Job Queue Name (10)	Character value	Optional
JOBQLIB	Job Queue Library (10)	Character value	Optional
OUTQ	Output Queue Name (10)	Character value	Optional
OUTQLIB	Output Queue Library (10)	Character value	Optional
USER	User Profile (10)	Character value	Optional
PRTDEV	Printer Device (10)	Character value	Optional
LOGCLPGM	Log CL Program commands (10)	Character value	Optional
LOGOUTPUT	Job log output (10)	Character value	Optional
INQMSGRPY	Inquiry Message Reply (10)	Character value	Optional
TEXT	Text description (50)	Character value	Optional
LIBL	Initial Library list (2750)	Character value	Optional

Top

Job Description (JOBD)

Specifies Job Description whose attributes are retrieved.

This is a required parameter.

Qualifier 1: Job Description

name: Specify the name of the Job Description to be retrieved.

Qualifier 2: Library

*LIBL: Specify *LIBL to have the system search the current library list for the Job Description. When this option is used, you could use the RTNJOBDLIB parameter to retrieve the name of the library in which the Job Description object resides.
*CURLIB: The Job Description is located in the current library for the job running this command.
name: Specify the name of the library containing the Job Description.

Job Description Library (10) (RTNJOBDLIB)

A CL variable that recieves the library name for the Job Description object whose attributes are being retrieved. Use this parameter when specifying *LIBL or *CURLIB on the command to determine the library where the *JOBD object is located.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)

Job Queue Name (10) (JOBQ)

Specify a CL variable to receive the name of the JOBQ associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)

Job Queue Library (10) (JOBQLIB)

Specify a CL variable to receive the library name of the JOBQ associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)

Output Queue Name (10) (OUTQ)

Specify a CL variable to receive the name of the OUTQ associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)

Output Queue Library (10) (OUTQLIB)

Specify a CL variable to receive the library name of the OUTQ associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)

User Profile (10) (USER)

Specify a CL variable to receive the User Profile associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)
Valid return values are any user profile ID or *RQS

Printer Device (10) (PRTDEV)

Specify a CL variable to receive the Print Device associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)
Valid return values are any printer device name or *USRPRF or *SYSVAL or *WRKSTN

Log CL Program commands (10) (LOGCLPGM)

Specify a CL variable to receive the LOGCLPGM attribute associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)
Valid return values are *YES or *NO

Job log output (10) (LOGOUTPUT)

Specify a CL variable to receive the Job Log Output attribute associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)
Valid return values are: *SYSVAL *JOBLOGSVR *JOBEND *PND

Inquiry Message Reply (10) (INQMSGRPY)

Specify a CL variable to receive the Inquiry Message Default Reply associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(10)
Valid return values are: *RQD *DFT *SYSRPYL

Text description (50) (TEXT)

Specify a CL variable to receive the Text Description associated with the Job Description object.

character-value: Specify a valid CL variable: TYPE(*CHAR) LEN(50)

Initial Library list (2750) (LIBL)

Specify a CL variable to receive the Library List associated with the Job Description object.

character-value: Specify a valid CL variable of TYPE(*CHAR) LEN(n) where n >= 10 and n <= 2750
Each library is returned as an 11-position entry. Therefore multiply the number of expected returned library names by 11 to calculate the length of your CL return variable. For example, to retrieve up to 6 library of the Job Description's library list, use TYPE(*CHAR) LEN(66) If you only want the first library, you may specify a minimum length of 10 positions for this parameter. For the legacy 25-library maximum, specify LEN(275) to insure enough room to receive all 25 library names. If using the current 250 library list name limitation, specify a length of LEN(2750) for your CL variable.

Examples for RTVJOBDA

Example 1: Simple Command Example

RTVJOBDA  KWD1(PARMVAL1)

This command <...>

Example 2: More Complex Command Example

RTVJOBDA   KWD1(PARMVAL1)  KWD2(PARMVAL2)
           KWD3(PARMVAL3)

This command <...>

Error messages for RTVJOBDA

*ESCAPE Messages

CPF9801: Object &2 in library &3 not found.
CPF9802: Not authorized to object &2 in &3.
CPF9803: Cannot allocate object &2 in library &3.
CPF9807: One or more libraries in library list deleted.
CPF9808: Cannot allocate one or more libraries on library list.
CPF9810: Library &1 not found.
CPF9811: Program &1 in library &2 not found.
CPF9812: File &1 in library &2 not found.
CPF9820: Not authorized to use library &1.
CPF9830: Cannot assign library &1.
CPF9899: Error occurred during processing of command.