Library Routines

jobinfo( {jsid} , {nnn } )

{jobname}, {varname }

{jobnumber}, {mnemonic}

{filename}

Num.	Mnemonic	Return Type	Description
0	EXISTS	Boolean	Returns TRUE if the job exists on the system, returns false otherwise.
1	CIPID	Integer	PID for job master process
100	JSID	Integer	Job Number
101	JOBNUM	String	Job Number
102	LOGIN	String	Returns the logon name in the form: [jobname,]user.group
103	USERID	Integer	User ID number for job.
104	USER	String	User Name
105	GROUPID	Integer	Group ID number for job
106	GROUP	String	Returns the Job/Session's current logon group.
110	JOBNAME	String	Returns Job Name
115	SHELL	String	Job’s shell on startup.
116	DIR	String	Starting directory
117	JOBFILE	String	Name of the file used as source for this job
118	DINTRO	String	Returns the introduction date for the Job in the form: "DD-MTH-YYYY HH:MI"
119	INTRO	String	Returns the introduction date for the Job in the form: "YEARMMDDHHMI"
120	IINTRO	Integer	Returns the introduction date for the Job as offset from 1/1/1970
121	STREAMEDBY	String	User who launched this job
122	STDIN	String	Returns filename of $STDIN for the Job
123	STDLIST	String	Returns filename of $STDLIST for Job
124	STDERR	String	Returns filename of stderr for Job
125	JOBSTEP	String	Returns the current job step for the job
126	JOBS	Integer	Returns the number of active jobs.
127	INPRI	Integer	Job input priority
129	DLAUNCHED	String	Returns the launch date for the Job in the form: "DD-MTH-YYYY HH:MI"
130	LAUNCHED	String	Returns the launch date for the Job in the form: "YEARMMDDHHMI"
131	ILAUNCHED	Integer	Returns the introduction date for the Job as offset from 1/1/1970
134	DEFERRED	Boolean	Returns TRUE if job is deferred, false otherwise
136	HOLD	Integer	Returns TRUE if the original job is on hold, false otherwise
138	WALLTIME	Integer	The Wall time limit (in minutes) for the Job
139	CPULIMIT	Integer	The CPU limit established for the Job
140	STATE	String	The general state category for the job (EXEC, SUSP, SCHED or EOJ)
141	SUBSTATE	String	The current Job state (EXEC, SUSP, WAIT, INTRO, HOLD, OK, CANCEL, ABORT, RESOURCE, RUNBOOK, LOCKED, ERR, WARN, FAIL, VERIFY, EVAL or SCHED)
145	DELETESTDLIST	Boolean	Returns TRUE if STDLIST=DELETE, false otherwise
148	ERRCMD	String	Command to execute if job ends in ERR Status.
149	FAILCMD	String	Command to execute if job ends in FAIL Status.
150	FINISHCMD	String	Command to execute if job validates successfully.
151	INITCMD	String	Command to execute when job is introduced, but before it begins executing.
152	VALIDATECMD	String	Command to execute if job ends in OK Status.
153	WARNCMD	String	Command to execute if job ends in WARN status.
154	AUTOFLUSH	Boolean	Returns TRUE if job is set to automatically flush from queue upon abend, FALSE otherwise.
155	MAXWAIT	Integer	Maximum number of minutes job can remain in WAIT state before being flushed.
156	NICE	Integer	Nice value for job.
157	PREPROCESSOR	String	Command used to pre-process job template file in order to generate final job file.
158	SETJCS	String	List of JCS variables set prior to launching job.
159	CRITICAL	String	Returns “CRITICAL” for critical job, “SEMI” for semi-critical job, “NORMAL” for normal importance, “NONCRITICAL” for non-critical job, and the rule to be executed for a variable criticality job.
200	JOBQ	Integer	Jobqueue to which job belongs.
201	JOBLIMIT	Integer	System job limit
202	JOBQLIMIT	Integer	Job limit for this job’s jobqueue.
203	JOBFENCE	Integer	Current system jobfence
204	JOBQFENCE	Integer	Jobfence for this job’s jobqueue.
399	RESOURCES	String	List of resources for this job.
500	JOBFAMILY	String	Returns the name of the job number family to which this job belongs.
899	DEPENDENCIES	String	Returns list of pending dependencies for job.
901	NUMABORT	Integer	Number of jobs fitting pattern specified that are in ABORT state
902	NUMACTIVE	Integer	Number of jobs fitting pattern specified that are logged on
903	NUMCANCEL	Integer	Number of jobs fitting pattern specified that are in CANCEL state
904	NUMERROR	Integer	Number of jobs fitting pattern specified that are in ERROR state
905	NUMEXEC	Integer	Number of jobs fitting pattern specified that are in EXEC state
906	NUMFAIL	Integer	Number of jobs fitting pattern specified that are in FAIL state
907	NUMFINISH	Integer	Number of jobs fitting pattern specified that are in FINISH state
908	NUMHOLD	Integer	Number of jobs fitting pattern specified that are in HOLD state
909	NUMINTRO	Integer	Number of jobs fitting pattern specified that are in INTRO state
910	NUMRESOURCE	Integer	Number of jobs fitting pattern specified that are in RESOURCE wait state
911	NUMSCHED	Integer	Number of jobs fitting pattern specified that are in SCHED state
912	NUMSUSP	Integer	Number of jobs fitting pattern specified that are in SUSP state
913	NUMVERIFY	Integer	Number of jobs being verified for successful completion.
914	NUMWAIT	Integer	Number of jobs fitting pattern that are in WAIT state
915	NUMWARN	Integer	Number of jobs fitting pattern specified that are in WARN state
999	TOTAL	Integer	Number of jobs fitting pattern

jobnum(spec) – returns job numbers of all jobs fitting spec.

jobqinfo(queuename,parmnum) – returns info about a jobqueue.

Num.	Mnemonic	Return Type	Description
0	EXISTS	Boolean	Returns TRUE if the job queue exists on the system, returns false otherwise.
200	JOBQ	Integer	Jobqueue name.
201	JOBLIMIT	Integer	System job limit
202	JOBQLIMIT	Integer	Job limit for this jobqueue.
203	JOBFENCE	Integer	Current jobfence
204	JOBQFENCE	Integer	Jobfence for this jobqueue.
205	JOBS	Integer	Returns the number of active jobs.
206	QSTATE	String	The current Jobqueue state (OPEN, CLOSED, SUSPEND, LOAD or ERROR).
207	RULE	String	Rule for job introduction order
212	MAXLOAD	Double	Maximum system load before queue shuts down.
213	PARENT	String	Parent queue for this jobqueue.
214	MINSLICE	Integer	Minimum CPU slice (0.1%) process must get
215	MAXSLICE	Integer	Maximum CPU slice (0.1%) process may get
216	NICE	Integer	Nice value for each job in the queue
217	INCR	Integer	Priority change for jobs outside slice limits
901	NUMABORT	Integer	Number of jobs in the jobqueue that are in ABORT state
902	NUMACTIVE	Integer	Number of jobs in the jobqueue that are logged on
903	NUMCANCEL	Integer	Number of jobs in the jobqueue that are in CANCEL state
904	NUMERROR	Integer	Number of jobs in the jobqueue that are in ERROR state
905	NUMEXEC	Integer	Number of jobs in the jobqueue that are in EXEC state
906	NUMFAIL	Integer	Number of jobs in the jobqueue that are in FAIL state
907	NUMFINISH	Integer	Number of jobs in the jobqueue that are in FINISH state
908	NUMHOLD	Integer	Number of jobs in the jobqueue that are in HOLD state
909	NUMINTRO	Integer	Number of jobs in the jobqueue that are in INTRO state
910	NUMRESOURCE	Integer	Number of jobs in the jobqueue that are in RESOURCE wait state
911	NUMSCHED	Integer	Number of jobs in the jobqueue that are in SCHED state
912	NUMSUSP	Integer	Number of jobs in the jobqueue that are in SUSP state
913	NUMVERIFY	Integer	Number of jobs in the jobqueue being verified for successful completion.
914	NUMWAIT	Integer	Number of jobs in the jobqueue that are in WAIT state
915	NUMWARN	Integer	Number of jobs in the jobqueue that are in WARN state
999	TOTAL	Integer	Total Jobs assigned to the jobqueue

replyinfo ( {JOBNUM, jobnum}, {nnn } )

{PID, nnn }, {jcwname }

{LOGON, [sname,]user.grp}, {mnemonic }

{PROCESS, filename},

{STREAM, streamfile},

{REPLYID, replynum},

{HOST, hostname},

{VIRTUAL, vmname},

The information returned by replyinfo (by request number/mnemonic) is as follows:

Num.	Mnemonic	Return Type	Description
0	EXISTS	Boolean	Reply exists for user.
1	PID	String	PID of process requesting REPLY.
100	JSID	Integer	Job Number for job requesting REPLY.
101	JOBNUM	String	Job number of job requesting REPLY.
102	LOGIN	String	Job card of job requesting REPLY in form [sess,]user.grp
103	USERID	Integer	User ID number requesting reply.
104	USER	String	User name requesting reply.
105	GROUPID	Integer	Group ID number requesting reply.
106	GROUP	String	Group name requesting reply.
110	JOBNAME	String	Job card session name requesting reply.
400	REPLYID	Integer	ID of pending reply.
404	TEXT	String	Text of pending REPLY.
405	TIME	String	24 hour time REPLY was posted.
406	TIMEOUT	Integer	Time in minutes after REPLY was posted that it will timeout.
407	ITIME	Integer	Time REPLY was posted in seconds offset from 1/1/1970.
408	DURATION	Integer	Duration in minutes reply has been pending.
410	PROCESS	String	Name of process requesting REPLY.
411	MINLEN	Integer	Minimum length in characters for response.
412	MAXLEN	Integer	Maximum length in characters for response.
413	EDIT	String	Regex that will be used to check validity of response.
414	DEFAULT	String	Response that will be issued if REPLY times out.
415	HOST	String	Host name where reply will show.
416	ECHO	Boolean	Determines whether ASK command will echo to stderr.
700	VIRTUAL	String	Virtual host whose targets will show the reply.
999	TOTAL	Integer	Total number of outstanding REPLY's fitting requested pattern

resinfo(resource,parmnum) – returns info about a resource.

Num.	Mnemonic	Return Type	Description
0	EXISTS	Boolean	Resource exists
17	RULE	String	Allocation rule for Resource
300	RESOURCE	String	Resource name
301	LEVEL	String	LOCAL, GLOBAL or SHARED
302	SUBCLASS	Array	Name of job number family, jobqueue, user, etc. owning resource.
303	DESC	String	Description of the Resource
304	LIMIT	Integer	Total number of the Resource
305	MIN	Integer	Minimum priority of a process requesting a Resource
306	MAX	Integer	Maximum priority of a process requesting a Resource
307	AVAIL	Integer	Number currently free for allocation
309	SORT	String	Sort order of processes requesting Resource
310	USED	Integer	Number currently in use
311	USERS	Array	List of PID, JSID and COUNT using a resource
312	WAITING	Array	List of PID, JSID and COUNT waiting for a resource

resuser(resource,pid,parmnum) – returns info about a user of a resource.

Num.	Mnemonic	Return Type	Description
0	EXISTS	Boolean	Resource exists
1	PID	Integer	PID for job master process
2	JSID	Integer	Job Number
3	JOBNUM	String	Job Number
4	LOGIN	String	Returns the logon name in the form: [jobname,]user.group
5	USERID	Integer	User ID number for job.
6	USER	String	User Name
7	GROUPID	Integer	Group ID number for job
8	GROUP	String	Returns the Job/Session's current logon group.
9	JOBNAME	String	Returns Job Name
17	RULE	String	Allocation rule for Resource
300	RESOURCE	String	Resource name
301	LEVEL	String	LOCAL, GLOBAL or SHARED
302	SHARES	Array	Hosts sharing the resource
303	DESC	String	Description of the Resource
304	LIMIT	Integer	Total number of the Resource
305	MIN	Integer	Minimum priority of a process requesting a Resource
306	MAX	Integer	Maximum priority of a process requesting a Resource
307	AVAIL	Integer	Number currently free for allocation
309	SORT	String	Sort order of processes requesting Resource
310	USED	Integer	Number currently in use
311	USERS	Array	List of PID, JSID and COUNT using a resource
312	WAITING	Array	List of PID, JSID and COUNT waiting for a resource

getvar(parmname,scope) – returns value of a JCS variable.

setvar(parmname,scope,value[,indirect]) – sets a value for a JCS variable.

finfo(filename,parmnum) – returns info about a file.

duration(units,from[,to[,calendarname]]) – returns the number of temporal units between two dates.

iduration(units,from[,to[,calendarname]]) – returns the integral number of temporal units between two dates.