Maintain Request Details - JBSF5210

Purpose

To allow the creation, maintenance, submission and querying of job requests, and

as an access point to all other forms and processes concerned with job requests

Subsystem

Job Control and Scheduling

Structure

Two Blocks

Request

Request Job

 

Navigation Buttons invoke:

  • the parameter interface
  • other forms

Function Buttons invoke:

  • processes

Not all buttons are available at the same time - the configurable buttons are marked with an asterisk *

Navigation Buttons:

Runtime Parameter Form
Maintain Request Job Output Destinations form
Maintain Request Schedule Details form *
Maintain Standing Request Frequency form *
Maintain Request Job Run form

Function Buttons:

Cancel Request
Submit Request *
Re-plan Request *

Zooms:

Maintain Job Dependencies form
Maintain Person Preferences form

Image

 

 

Request

Explanation

NOTE: If a job is to be run immediately or is scheduled to run as soon as possible, rather than in batch mode, this form is not used. Refer to Running a Report Immediately in the subsystem introduction.

Job requests are the means by which users initiate batch jobs, previously defined within the Callista system, to run reports, update the database and perform system maintenance tasks. A set of interconnected forms is used to perform the tasks necessary to create, modify and query job requests, and to track the progress of jobs once a request has been submitted. This form, Maintain Request Details, is the central form of the set, and contains navigation buttons to the associated forms, and function buttons to initiate processes.

This Request block, and the block below which is used to specify the job(s) composing the request, contain the core information about the request. A configurable button in this block allows navigation either to the Maintain Request Schedule Details form (JBSF5212), or the Maintain Standing Request Frequency form (JBSF5211) to set up a schedule for running the request. When this form is accessed directly from a job/report parameter form, data is defaulted into the form. The Run Window can be changed and jobs can be added or deleted.

It is possible to create new requests by using an existing request as a template.

This section links to the documentation for interconnected forms at appropriate points. A complete overview of the subsystem is given in Understanding Job Control and Scheduling, including an outline of all the forms needed to create and submit a request, in the section Steps in a Job Request.

A reminder: It is necessary to save after selecting the function buttons Cancel Request, Submit Request and Re-plan Request in this block.

Example

An example of the complete request process is given in the subsystem introduction.

 

To create a new job request using the Maintain Request Details form:

In Insert mode:

  1. Either
    key a valid     run window value in the Run Window field
    or
    using the icon alongside the field ,
    access the pop-up window, Inquire On Run Windows (    JBSF4411), and select the required run window using that form. (Tip: Key the first letter of the run window code and Tab, the rest of the code will be entered automatically.)
  2. Optionally, remove the checkmark from the Abort On Error indicator.
  3. Optionally, set the Sequence indicator.
  4. If this is to be a standing request, set the Standing Request indicator (subject to you having security privilege to create standing requests).
  5. Navigate to the Request Job block, and set up the job(s) according to the instructions given for that block.
  6. Set up the request schedule. Depending on whether the Standing Request indicator is set, the navigation button on the right will be
    either
    the Request Schedule button accessing the Maintain Request Schedule Details form (    JBSF5212)
    or
    the Standing Request Frequency button accessing the Maintain Standing Request Frequency form (    JBSF5211).
    Access the appropriate form and follow the instructions given in that form's documentation.
  7. Use the Submit Request button to submit the request for scheduling.
  8. Save.

Rules:

  • Note that steps 3 to 7 can be performed in a different order, as required. This may necessitate saving data before performing the next step.
  • The ID of the person making the request is inserted automatically by the system.
  • Values in the Request Status field are maintained by the system. For a new request, the status defaults to PLANNED.
  • The system inserts a unique request number when the request is saved.
  • The Abort On Error indicator is relevant where several jobs are specified for a request. It is set as the default, and indicates that subsequent jobs are not to be run (but are to be 'aborted'), if a previous job fails to complete successfully.
  • The Sequence indicator, if set, indicates that jobs in a request are to be run in sequence rather than in priority order. The required sequence is organised in the Request Job block. This facility is useful when it is not permitted to override the priorities set.
  • Jobs within a request will never be run concurrently, even if there are several batch queues open.
  • The Standing Request indicator, if set, marks the request as one to be scheduled and run automatically by the system at pre-determined intervals. The right hand button in the block is then configured to access the correct schedule form. The indicator label is greyed out if you are not permitted to run standing requests.
  • Security restrictions may prevent some users from creating standing requests. To check, use the Zoom to the Maintain Person Preferences form (SECF0066), where a checkmark in the Allow Standing Request checkbox indicates permission.
  • To successfully submit a request, there must be at least one future date/time in the schedule at the time the request is submitted.

To inquire on existing job requests using the Maintain Request Details form:

In Query mode:

  1. Enter query details in the appropriate fields.
  2. Execute the query.
  3. Navigation buttons allow existing schedule, output and parameter data for this request to be seen.

(Inquire on the progress of individual jobs via the Run Job button in the Request Job block.)

Rules:

  • A request can have the following status values:
    PLANNED, WAIT, SCHEDULED, COMPLETE, CANCELLED.
  • A submitted request's status is updated automatically by the system as the request is processed, but it is necessary to re-query to see the current status in the Request Status field.
    HINT: Using the three keystrokes F7, F7, F8 is a quick way to re-query the last record accessed.

To duplicate an existing request, as the basis for a new request, using the Maintain Request Details form:

  1. Find the request which is to serve as a template for a new request, following the instructions in 'To inquire on existing job requests...' above.
  2. With the cursor located in the Request block, create a new record.
  3. Duplicate the record previously selected.
  4. Optionally, change the run window.
    Either
    delete existing text in the Run Window field, and key a valid value
    or
    using the icon alongside the field ,
    access the pop-up window, Inquire On Run Windows (    JBSF4411), and select the required run window using that form.
  5. Save.
  6. Modify all other data, as required.
  7. Save.

Rules:

  • HINT: The function key F6 is a quick way to create a new record, and F4 duplicates the record selected previously.

To modify job request details in this block, before submission, using the Maintain Request Details form:

  1. Find the record to be modified.
  2. Modify as required.
  3. (Modify details in the Request Job block and linked forms, and in schedule forms, as required).
  4. Save.

Rules:

  • The modification of individual jobs in a request is undertaken in and from the Request Job block.
  • Request schedules are modified either in the Maintain Request Schedule Details form (JBSF5212) or the Maintain Standing Request Frequency form (JBSF5211).

To modify a job request, after submission, using the Maintain Request Details form:

  1. Find the record to be modified.
  2. Check that the Request Status is WAIT.
  3. Select the Re-plan Request button, and Save. Request status reverts to PLANNED.
  4. Modify as required (see above).

Rules:

  • Requests that have been submitted, and have a status of WAIT, can be re-set to PLANNED status, and modified. Once a request becomes SCHEDULED, this is no longer possible.

To cancel a job request using the Maintain Request Details form:

  1. Select the Cancel Request button to set a request's status to CANCELLED and prevent further use.
  2. Save.

Rules:

  • A saved request cannot be deleted.
  • Note that if a request is cancelled while one of its component jobs is running, that job will continue to run, but any subsequent jobs in the request will be cancelled.

  

Request Job

Explanation

The job or jobs to include in a request are specified in this block. There are various attributes of jobs that determine whether they can form part of a particular request, and how they must be requested. These factors apply:

  • Users can only include jobs to which they have been granted access.
  • Jobs may be restricted to particular run windows. They can then only be included in a request with a matching run window.
  • Jobs can have prerequisite and/or dependent jobs stipulated. If the relationship is mandatory, the user must ensure that all related jobs are included in the job request. Use the Zoom facility to the Maintain Job Dependencies form (JBSF4140) to see job relationships - if a (saved) job record is selected in the Request Job block, zooming to JBSF4140 will display prerequisite and dependent jobs for the selected job.
Including jobs in a request

Priority. Some users are permitted, for designated jobs, to override the priority assigned to those jobs. Once job records are saved, it is possible to alter the sequence in which jobs are to run, as an alternative to their running in priority order.

Parameters and Output. Jobs usually require parameter values to be entered by the user. They may also need output destination details specified at this stage, if destination defaults have not been assigned. For each job, therefore, it may be necessary to access

  • the parameter interface (JBSPARAMS) to enter parameters, using the Job Parameters navigation button
  • the Maintain Request Job Output Destinations form (JBSF5230) to enter destination details, using the Job Output navigation button.

Entry order. When recording several jobs for a request, the user has a choice about the order in which tasks are done. It is possible

  • to enter jobs and save them one at a time, adding parameter and output records after each job is saved, or
  • to enter all jobs required for the request, save them together, and then select each job in turn to add parameter and output records.

The instructions given in the next table are for the first method. Priorities can be changed (if permitted) at any time, and the sequence can be amended at any point after all jobs are saved.

Job tracking. Once a request has been submitted, the Job Run navigation button gives access to the Maintain Request Job Run form (JBSF5300). Use this form to track the progress of individual jobs.

Example

An example of the complete request process is given in the subsystem introduction.

  

To specify a job as part of a request, using the Maintain Request Details form:

In Insert mode:

  1. In a blank record, select the required job from the list of values (or key a valid value) in the Job Name field.
  2. Optionally, and if permitted, change the job's priority by selecting from the list of values, or by keying a number from 1 to 9 in the Priority Override field.
  3. Save.
  4. If required, access the parameter interface via the Job Parameters button, and enter parameters for the job.
  5. If required, access the Maintain Request Job Output Destinations form (JBSF5230) via the Job Output button to specify destinations for output from the job.

Rules:

  • If the form has been accessed from a report name or other job name on a menu, the job selected there is displayed when this block is entered. This record must still be saved. (Continue from step 2).
  • If the form is entered from a job/report parameter form, the job/report details are displayed when the form opens.
  • A request can include more than one job.
  • The same job may be included more than once in a request.
  • The list of values shows open jobs only.
  • A job may have more than one output, and for each output, one or more destination sets. Refer to Output from Jobs in the introduction, for an outline of possible output combinations.
  • Some jobs already have a particular run window or windows specified. You will not be able to add these jobs to a request with a different run window.

To alter the run sequence of jobs in a request, using the Maintain Request Details form:

  1. Ensure that the Sequence indicator is selected (in the Request block), and all job records are saved.
  2. Place the cursor in the job record to be moved.
  3. Use the upper icon to move the record up, a place at a time, or the lower icon to move it down.
  4. Save.

Rules:

  • Sequence numbers are initially supplied by the system as job records are entered.

To modify job details for a request using the Maintain Request Details form:

  1. Place the cursor in the job record to be modified.
  2. Modify the job priority, if required, and save.
  3. Modify parameters by accessing the parameter interface via the Job Parameters button.
  4. Modify output details by accessing the Maintain Request Job Output Destinations form (JBSF5230) via the Job Output button.

Rules:

  • Jobs details can only be amended while the request has a status of PLANNED.
  • A job record (as designated in the Job Name field) cannot be changed, once saved, it can only be deleted. Its priority can be amended if permitted by the user's security access.
  • Parameter and output details can be amended.

To delete a job from a request using the Maintain Request Details form:

  1. Find the record to be deleted.
  2. Locate the cursor in the record to be deleted.
  3. Delete record.
  4. Save.

Rules:

  • Jobs can only be deleted while the request has a status of PLANNED, and as long as it has not already been submitted once (i.e. is not a 're-plan').

Last Modified on 11 March 2002