JBSF5211 - Maintain Standing Request Frequency

Purpose

To create and maintain a Schedule for a Standing Request by specifying the Frequency with which the request should run in a nominated period

Subsystem

Job Control & Scheduling

Normally Run By Job Control Specialist
Anticipated Frequency As required
Structure

Blocks Standing Request Period
Standing Request Frequency
Standing Request Frequency (Calendar Type/Date Alias)
Buttons Run Window (JBSF4411)
Calendar Lookup
Date Alias (CALF7510)

  

Standing Request Period block

Note: There are two methods of specifying when a job should run. This form is used to set up a Schedule for Standing Requests. Use the form Maintain Request Schedule (JBSF5212) for all other requests.

As part of defining a Standing Request, it is necessary to set up a Schedule detailing the Frequency with which the request should run. The System organises for the job(s) comprising the request to run at the intervals specified in this form. Security restrictions may limit the use of Standing Requests to specific System users.

The form is accessed via the Standing Request Frequency button on the Central Request Form, Maintain Request Details (JBSF5210). This button is displayed whenever the Standing Request check box is set and saved. The check box is greyed out if a user is not permitted to create or alter a Standing Request, though the form can still be accessed for information.

A diagram illustrates the steps to set up a request as a Standing Request.

Much of this block is for information only. It displays request context details carried from the Central Request Form, including access to a pop-up window to see the intervals (set of times) assigned to the request's Run Window. The Date fields in the block are used to enter the period (which can be open-ended) during which the Standing Request is current.

For example, you have entered details of Request Number 67, created in the Maintain Request Details form, which are shown in this block. Request Number 67 contains a job to obtain and print statistics for study units, which are required on a regular basis during the teaching period.

The Standing Request period is set from 16th February 2004 to 31st October 2004

Standing Request Frequency block

Records in this block specify the Frequency with which a Standing Request will run during the Standing Request period. This can be entered as a day or days (for example, each Wednesday and Friday in February, April and June) or a day of the month (for example, the 18th of each month). Records here and in the next block (Frequency using a Date Alias) can be set up in combination.

To continue the above example, the statistics for study units produced by the job in request 67 are required every Friday morning during the teaching period, so a staff member sets up the request to run each Thursday evening. This is achieved by selecting THU in the Day/s or Day of Month field of this block, and the months FEB, MAR, APR, MAY, AUG, SEP, OCT in the Months field.

The Year is entered as 2004, and the time as 20:00.

From 16th February, which is the Start of the Standing Request period, the request will run each Thursday evening until 31 October

Standing Request Frequency (Calendar Type/Date Alias) block

Either as an alternative, or in combination with the Standing Request Frequency block, this block allows the entry of Date Aliases to determine the Frequency with which Standing Requests will run during the Standing Request period.

Standing request Schedules which rely on Date Aliases must be considered in conjunction with setting up Date Alias instances for the same Calendar Type. Since the System attempts to re-Schedule a Standing Request immediately after each Scheduled Date and Time of running, a further Date Alias instance must exist at that time, or the request will be deemed to have completed.

If, after a request has been submitted or re-Scheduled to run (request status WAIT), a Date Alias instance is amended or added so as to fall before the request is due to run, this instance will be ignored. This is because the next run date is determined at the time the request status is set to WAIT. For an overview of processes corresponding to request statuses, see the section Checking on the Progress of a Request in the Subsystem introduction.

Building on the example used in the previous blocks, assume that statistics for study units are also required on Government Census Dates. This requirement is built into the Standing Request by specifying CENSUS as the Date Alias in this block. The job will run on each Census Date within the Standing Request period, as well as at times Scheduled in the previous block.

 

The Standing Request Period block contains:

  • Request Number
  • Request Status
  • Run Window
  • Requested By
  • Start Date
  • Start Alias Instance
  • End Date
  • End Alias Instance

    Buttons

The Standing Request Frequency block contains:

  • Day/s or Day of Month
  • Month
  • Year
  • Time

The Standing Request Frequency (Calendar Type/Date Alias) block contains:

  • Calendar Type
  • Description
  • Date Alias
  • Time

Rules/Notes:

Caution is necessary in setting up this form with an open-ended Standing Request period, since specified days (and/or Date Aliases) may not necessarily coincide with allowed Run Windows in all cases, and jobs will not then run until their Run Window next becomes active.

To view the intervals for the request's Run Window, using the Maintain Standing Request Frequency form:

  • Using the button alongside the Run Window field, access the pop-up window, Inquire On Run Windows (JBSF4411)

Rules/Notes:

The Run Window cannot be modified in any way in this form.

To enter the period during which the given Standing Request is current, using the Maintain Standing Request Frequency form:

In Insert mode:

  • Supply a start date for the Standing Request period in either the Start Date field (Method 1) or the Start Alias Instance field (Method 2)
    • Method 1
      Enter a Date by keying directly in the field, or by using the Calendar Lookup button and selecting a date using the Electronic Calendar.
    • Method 2
      Select a Date using the Date Alias button to access the Inquire On Date Alias Instance form (CALF7510). Follow instructions given for that form. On return to this block, the System inserts the selected date in the Alias Instance field
  • Optionally, supply an End date for the Standing Request period in either the End Date field (Method 1, above) or the End Alias Instance field (Method 2, above)

Rules/Notes:

A date can be keyed using a variety of formats, including: 03/03/2004, 3-3-04, 3.3.04.

A Standing Request period can be open-ended.

 

To modify the period during which the given Standing Request is current, using the Maintain Standing Request Frequency form:

  • Modify the Start and End Dates of the period as required
  • Save

 

 

To remove the Dates signifying the Standing Request period, using the Maintain Standing Request Frequency form:

  • Ensure that all Frequency records are deleted
  • Delete values from the Start and End Date fields
  • Save

Rules/Notes:

This deletion should only be necessary if the request is to cease being a Standing Request - for example, where Standing Request details are to be removed in a new request achieved using the duplication method.

To create a record specifying the Frequency of a given Standing Request, using the Maintain Standing Request Frequency form:
  • Enter Insert mode
  • Select the day(s) or day of month on which the request is to run from the list of values (or key a valid value) in the Day/s or Day of Month field of a blank record
  • Select the month(s) when the request is to run from the list of values (or key a valid value or partial value) in the Month/s field
  • Select a year from the list of values (or key a valid value) in the Year field
  • Enter a time in 24-hour format in the Time field
  • Save

Rules/Notes:

If a value is entered in any field, then values must be entered in all fields of the record.

A time must be keyed in 24-hour format. Examples of accepted formats for 8 p.m. are 20:00, 20.0, 20-0.

20:3 is interpreted by the System as 20:03.

EVERY DAY, EVERY MONTH and EVERY YEAR are possible values.

When a Standing Request is open-ended, the System checks that the request is valid to run at least once.

Keying a partial value (and tab or enter) brings up a subset of the list of values in the Month field. For example, key 'JAN, S' to see all the month combinations starting 'JAN, SEP ..'.

Hint: One way to enter months is to select the full twelve months (scroll to end of list of values) and edit the field to delete unwanted months. Take care to retain consistent commas and spaces.

To modify a Frequency record using the Maintain Standing Request Frequency form:

  • Find the record to be modified, scrolling if necessary
  • Modify the record as required
  • Save

 

 

To delete a Frequency record using the Maintain Standing Request Frequency form:

  • Find the record to be deleted, scrolling if necessary
  • Locate the cursor in the record to be deleted
  • Delete record
  • Save

 

Using a Date Alias to specify the Frequency of a given Standing Request, using the Maintain Standing Request Frequency form:

In Insert mode:

  • Select the Calendar Type of the required Date Alias for the request Frequency record from the list of values (or key a valid value) in the Calendar Type field of a blank record
  • Select the required Date Alias indicating when the request should run from the list of values (or key a valid value) in the Date Alias field
  • Enter a time in 24-hour format
  • Save

Rules/Notes:

A time must be keyed in 24-hour format. Examples of accepted formats for 2 p.m. are 14:00, 14.0, 14-0.

14:3 is interpreted by the System as 14:03.

There must be at least one instance of the Date Alias which is valid for the period and Run Window of the request.

Hint: Use the Date Alias button in the top block to access the Inquire On Date Alias Instance form (CALF7510) and check on valid Date Alias/Calendar Type combinations. Use the Cancel button to return to this form without altering values in the top block.

To modify a Date Alias Frequency record using the Maintain Standing Request Frequency form: 
  • Find the record to be modified, scrolling if necessary
  • Modify the record as required
  • Save

 

To delete a Date Alias Frequency record using the Maintain Standing Request Frequency form:

  • Find the record to be deleted, scrolling if necessary
  • Locate the cursor in the record to be deleted
  • Delete record
  • Save

 

 

Last Modified on 14 January, 2004