Batch Job Documentation System

Usage/Job Entry


New Job Initialization

When documenting a new job, an SPX utility exists to extract some basic initial documentation. Option D.8 requests a Panvalet library in which the new job resides and requests the Panvalet member name. A batch job called JOBDOC is then submitted which extracts the job description, CPU time and output distribution parameters. These are loaded into the AIMS Batch Job Documentation System under Test AIMS where the documentation can be completed.

Items are extracted as follows:

  1. CPU time is extracted from the JOB statement. The first statement of your JCL MUST be the JOB statement or this will fail.
  2. The "//xxxx OUTPUT" format must be used to identify forms rather than the "/*OUTPUT xxxx" format.
  3. The first set of comments in the program need to be the description of the job. The JCL comment line should look something like this:

    //***** AB1234: xxxx

    where xxxx is the description of the job. Instead of AB1234, the Z-version name (if appropriate) can be used. The key is that the first 6 characters match the name of the job as documented and that it end with a colon (:). The description is also used for the Job Setups purpose (line 1). To add a second purpose line, add a second comment line without the jobname. The extract program will do automatic word-wrap on a 2-line purpose.

Using the D.8 option for new job documentation initialization is strongly encouraged to help eliminate entry errors.

Documentation Updating

To update documentation for a job, go to the appropriate application screen, make the necessary changes and press PF1 or PF13 to update. Each application screen has at least one item which may be repeated. For example, the Job Setup screen has Job Dependency criteria. Each has 4 lines of entry. If the job requires more than 4 lines to describe dependencies, additional pages are available by pressing the page down key (PF8 or PF20). All information may be entered before updating by pressing the PF1 or PF13 key.

When using multiple pages for entry, blank lines will be suppressed. If, for example, job AB1234 had one dependency condition listed on page 1 of the Job Setup screen and one listed on page 2, both would appear on page 1 after updating (but not before being updated).

Before proceeding to the next documentation screen (through use of PF9, PF21 or other means), be sure to update on the current screen if any changes were made.

Other Information

When documentation is updated, the name of the person updating the documentation and the date of the update are saved with the documentation.

When the job purpose is changed on the Job Setup screen, the first line of the job purpose is used as the description of the job as shown on the Job Selection screen.

IT Applications Support


Last Modified: