Purpose

To enable the creation and maintenance of system Jobs and their outputs, and to record any restrictions apply to them.

Subsystem

Job Control & Scheduling

System Job Block

Data in this form will normally be set up and maintained by IT staff with responsibility for the Callista Student Management System (SMS).

This is the principal form used to identify and define executable jobs to be run within the Callista system. The jobs recorded here will be available to be run when requested by end-users with appropriate security privileges. Jobs can be of the following types: shell scripts, Pro*C and C executables, database procedures and reports.

The Job Details recorded in this block include:

• Identifying information (Description, Titles used in menus).
• Job control information (Job Priority, whether the job can be restarted).
• Operating information (Job Type, Execution File Name, Parameter Form Name).
• Security information (constraints on data access).

An executable job (recorded here in the Job Execution Name field) can be known within the Callista system under several different job names, each of which may be associated with one or more output records.

In this block it is also possible to indicate that Restrictions apply on the data accessed for report jobs. The nature of the data Restrictions depends on the database access specified in the security Subsystem for the person requesting the job.

Overlay blocks called from this block are used to record Restrictions about time and method of running. A form can also be called to record any prerequisite and/or dependent jobs associated with this job. Details of output file(s) from the job are recorded in the Job Output block.

If the Allow Connect Type check box is selected, then the Job Parameter and Connect Output Types buttons will be displayed. Some existing form details are greyed out within the Job Output block. They are:

• System Output Type
• Messaging Output
• Override Options
• Allow Print
• Allow Fax
• Allow Email
• Delete Output
• Job Output Options Button

Job Output Tab

Refer to the section Output from Jobs in Understanding Job Control & Scheduling, for an overview.

A job can have one or more output files. Records must be created here for each file to be directed to an output destination (Printer, Fax or Email). At run time, a unique number is appended to each output file created.

The Maintain Job Output Options (JBSF4120) form, accessed via the Job Output Options button in this block, enables the setting up of output options (destinations) to be used when the job is requested by an end-user.

The Override Options check box and associated check boxes, Allow Print, Allow Fax (not operational), Allow Email, control whether or not people requesting jobs are permitted to change or add output destinations. These possibilities exist:

• Output option specified / No Override: Cannot alter the destination at request time.
• Output option specified / Override: It is possible to alter the destination at request time.
• Output option not specified / Override: A destination must be added at request time.

The System Output Type field enables the selection of output in one of these forms:

• POSTCRIPT - creates a file in Postscript format for sending to a Postscript printer or viewing via a third party Postscript viewer.
• TEXT - creates a text file, particularly suitable for insertion into third party applications.
• PDF - creates a file in pdf format for viewing with Adobe Acrobat Reader.
• CSV - delimited file suitable for spreadsheet applications
• XML - creates a file that can be viewed by web browsers

If Staff Connect functionality is available to an institution, then the Connect Output Types button will appear next to the Job Output Options button. The Connect Output Types button navigates to JBSF4130 where other output forms for the web are available.

See Staff Connect Information for the different screens available within Staff Connect and what they do.

Report Template Tab

If a Report Engine is selected and the Template Enabled check box is enabled in Maintain Report Engine Details (JBSF4150), then the Report Template tab appears next to the 'Job Output' tab.

The template information, along with the Report Engine details in JBSF4150, will be used to execute a report using a third party Report Engine.

The 'Template Name' field is a unique name on an appropriate server, so that the Report Engine can identify and access them.

The 'Template Display Name' field displays a user defined name when executing a report and selecting a template.

The 'Standard Template' check box is selected to indicate the standard default template to use when executing a report.

Overlays

Job Run Window Restriction (select Restrictions button first)

A job can be restricted to running only in certain Run Windows. For a job run in immediate mode, this restricts the times it can start. If run in batch mode, the job can only be included in a request with the same Run Window(s).

This overlay block, which is displayed when the Restrictions and Run Window Restrictions buttons are selected, is used to select the Run Windows against which the job may run.

For full information on Run Windows, see the documentation for the Maintain Run Windows (JBSF4410) form.

Job Run Mode Restriction

Report jobs can be run in either IMMEDIATE or BATCH mode. In IMMEDIATE mode, they run as a background process on the client machine. Jobs other than report jobs must be run in batch mode, within a request.

This overlay block, which is displayed when the Restrictions and Run Mode Restrictions buttons are selected, is used to stipulate that a report is to be run only in one or other mode. If a mode restriction is not applied here, it may be run in either mode. (However, if a job is restricted to a particular Run Window, and that Run Window in turn is restricted to a particular run mode, then the job is effectively restricted to a specific run mode.) If specified as IMMEDIATE mode only, it can never form part of a job request.

Job Conflict

It may be inadvisable to run a particular job concurrently with another, particularly where the two jobs access the same set of data. Conflict may occur where two jobs are simultaneously updating a set of data, or where one job is extracting data while another job is updating the same data. A further consideration, where a job processes large data volumes, is that concurrent processing may unnecessarily slow down both jobs.

When a Job Conflict Record is entered against a job, this job cannot run if the conflict job is running, and vice-versa. Callista will only allow the second job to run when the first job is finished.

One or more jobs can be recorded as Conflict Jobs.

Those jobs for which this is critical will already have Conflict Records set up, and are identified in the job's documentation. System administrators may use this function to control the relative timing of other jobs and reports.

For example, in Finance Interface processing, composite jobs have been set up with Conflict Records, as shown here. In this example, none of the four jobs can run while any other is running. The setup also prevents different instances of the same job from running concurrently.

Warning

When attempting to run any job/report in immediate mode, and the result is shown in a web browser with 'pop-up' enabled, the job/report will not show. Disable 'pop-up' and try again. This applies to all pop-up programs (Google, IE XP SP2, etc).

This form is accessed from the main menu.

The System Job block contains:

• Job Name
  A name by which the executable job is known within the Callista system. This name is used when granting a job to security roles and individual users.
• Last Run Date
  The date and time when the job was last run within a request is displayed by the system.
• Closed check box
• Description
• System Job Type
  This is used by the system to build operating system commands when the job is scheduled to run.
• Report Engine
  Used to nominate the type of Report engine used to execute the report for this job.
• Ovrd Report Directory Name
  Used to define the Directory Name which overrides the default Directory Name Column in the System Report Engine for this report.
• Ovrd Report Constant String
  Used to define the Report Constant String to which Report Output for this job is directed.
• System Job Priority
  Has nine system-defined values. Each job must be assigned a priority, used by the system in ordering jobs at run time. Users granted override privilege for a particular job (in security forms SECF0062 or SECF0063) can override this priority when requesting the job.
• Menu Title
  This is used to identify the job in the menus, the alpha list and the history list (accessed from menus).
• Short Title
  Used in the Zoom facility and in some security forms.
• Job Execution Name
  The name of the executable job. For case-sensitive operating systems such as Unix, the case here must match the filename. There can be a one-to-many relationship between an executable job and the System Jobs named in the Job Name field.
• Parameter Form
  This form has a 1:1 relationship with the Execution job. If there is no entry here, the Job Parameters button in the central request form, JBSF5210, is disabled. For further information, refer to the technical information in the Callista Product Centre (wiki.callista.com.au/display/CPC).
• Restartable check box
  If selected, the job will be restarted at the next available opportunity after an operating system failure, database restart or other system failure.
• Pass Request Job Run ID Parameter check box
  If selected, the unique code which identifies a particular job run request instance of the job is passed to the job as a Parameter. The code is used to uniquely identify the output from a job. In particular, it identifies extract tables to jobs which further process the extracted data.
• Parameter Form Type
  Select either REPORT where the Parameter form is an Oracle Reports form or FORM where the Parameter form is an Oracle Forms form.
• Update Job check box
  Used only for information. The setting/unsetting of this check box does not affect processing in any way.
• Run As Requester check box
  If selected, report jobs will only include data that the person creating the request is permitted by their security privileges to view. Update and other jobs are not affected by this check box.
• Allow Connect Output Type check box
  This check box is only selected for institutions where Staff Connect Report functionality is available.
• Comments

  Buttons

• Job Parameters (JBSF4180)
  This button only displays when Allow Connect Output Type check box on System Job block is checked.
• Job Dependencies (JBSF4140)
• Restrictions (overlays)

Buttons

• Run Window Restrictions (overlay)
  • Run Windows
  • Description
  • Back button
• Run Mode Restrictions (overlay)
  • System Run Mode
  • Description
  • Back button

• Conflicts (overlay)
  • Conflict Job Name
  • Description
  • Back button
• Job Text (JBSF4170)

The Job Output tab contains:

• Output Number
  The System Job Priority number from upper block.
• Description
  A description is copied from the Short Title in upper block.
• System Output Type
  Select what type of output from LOV. For example, the user may want to create a report as a PDF.
• Output File Name
  A name the user wants to use to identify the output information.
• Messaging Output check box
  Must be selected to use electronic messaging.
• Override Options check box
• Allow Print check box
• Allow Fax check box
• Allow Email check box
• Delete Output check box

• Template Name
• Template Display Name
• Standard Template check box

Buttons

Connect Output Types (JBSF4130)
This button only displays when Allow Connect Output Type check box on System Job block is checked.

Job Output Options (JBSF4120)

Rules/Notes:

Changes made to a job's details may affect the ability to submit existing requests containing the job, or prevent a job waiting to run from doing so.

It is envisaged that in future, the connect Output Types may be merged with the existing System Output Types, making all Output Types available to all reports.

If Staff Connect functionality is available, and the Allow Connect Output Type check box is selected, some existing form details will not be enabled. For example, the Print, Fax and Email check boxes in the lower block.

Report Engine

When a System Job Type of 'Report' is selected, the user is able to select an appropriate Report Engine from the list of options. These must be previously defined in Maintain Report Engine Details (JBSF4150).

If the user does not select a Report Engine and:

• No details of a Report Engine are recorded, then Oracle Reports becomes the default.
• Another Report Engine is recorded as a default, then this becomes the default.
• There is more than one Report Engine recorded, then the user must select one of the Report Engines to use.

Report Template Tab

If a Report Engine is selected and the Mandatory Template check box is enabled in Maintain Report Engine Details (JBSF4150), one of the templates must be identified as the default 'Standard Template'. This will mean that when a user is executing the report, this becomes the default template.

The template name must be unique so that the Report Engine can identify and access it when executing the report.

• Enter the name of the new job in the Job Name field.
• Enter an explanatory description in the Description field.
• Select the type of job from the list of values (or key a valid value) in the System Job Type field.
• Select a priority from the list of values (or key in a number from 1 to 9) in the System Job Priority field.
• Enter a suitable title for menu use in the Menu Title field.
• Enter a title in the Short Title field.
• Enter the physical file name of the executable job in the Job Execution Name field.
• Enter the name of the Parameter form, if any, associated with the execution job.
• Select the Restartable checkbox if this job can be rerun.
• For information purposes, select the Update Job checkbox if applicable to this job.
• For report jobs, select the Run As Requester checkbox if restricted data access is required.
• If institution has Staff Connect functionality, and this function is required, select Allow Connect Output Type.
• If required, enter additional information about the job in the Comments field.
• If required, access the Job Run Window Restriction block and/or the Job Run Mode Restriction block and/or the Job Conflict block via the buttons.
• Save.

• Find the record to be modified.
• Modify the record as required.
• Save.

• Find the record to be deleted.
• Locate the cursor in the record to be deleted.
• Delete record.
• Save.

Rules/Notes:

A system Job cannot be deleted if Job Output records, Job Conflict Records, job Run Window restriction records or job run mode restriction records exist for it. Neither can it be deleted if it is part of a job request.

Jobs can be made unavailable for further use by setting the Closed check box. Jobs in existing requests will still run.

• Enter a description for the output in the Description field.
• If required, select TEXT or PDF from the pop-down list for System Output Type.
• Enter the output file name associated with this system Job in the Output File Name field.
• Optionally select the Messaging Output check box to use Electronic Messaging.
• Select the Override check boxes, as required.
• Optionally, select the Delete Output check box.
• Optionally, if Staff Connect Output Types button.
• Save.

Rules/Notes:

An output number is supplied automatically by the system on saving.

The Reports facility will pick up the job's output file name from this block. For other jobs, such as shell scripts or Pro*C, the name recorded here should be the name used in the executable job. For case-sensitive operating systems such as Unix, the case must match the case of the filename. For all output, the JBS Subsystem uses the output file name recorded here to direct the output file to a destination.

Output type defaults to Postscript, unless institution has Staff Connect functionality, then select the output type using the Connect Output Type button.

If the Override Options check box is set, then at least one of Allow Print, Allow Fax, Allow Email must also be set.

If the Messaging Output check box is selected, a Job Output file must be specified.

• Find the record to be modified.
• Modify the record as required.
• Save.

• Find the record to be deleted.
• Locate the cursor in the record to be deleted.
• Delete record.
• Save.

Rules/Notes:

Job Output cannot be deleted once this output exists in a request, or if it has output options.

• Access the overlay block using the Restrictions/Run Window Restrictions buttons
• Ensure mode is Insert.
• 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.
• Save.
• To reinstate previous screen layout, select Back.

Rules/Notes:

A restriction can be saved here, or on return to the previous layout.

• Find the record to be deleted.
• Locate the cursor in the record to be deleted.
• Delete record.
• Save.
• To reinstate previous screen layout, select Back.

Rules/Notes:

Save here or after reinstating the previous screen layout.

• Access the overlay block using the Restrictions/Run Mode Restrictions buttons.
• Ensure Insert mode.
• Select the run mode required from the list of values (or key a valid value) in the System Run Mode field of a blank record.
• Save.
• To reinstate previous screen layout, select Back.

Rules/Notes:

Only report jobs may be run in IMMEDIATE mode.

• Find the record to be deleted.
• Locate the cursor in the record to be deleted.
• Delete record.
• Save.

Rules/Notes:

This will have the effect of reinstating both modes as options for a report job.

• Access the overlay block using Conflicts button.
• Select the conflict job from the list of values (or key a valid value) in the Conflict Job Name field of a blank record.
• Save.
• To reinstate previous screen layout, select Back.

Rules/Notes:

Conflict relationships work both ways. i.e. an attempt to run either job will not succeed if the other job is running.

More than one job can be recorded as a conflict job.

Conflict Records can prevent separate instances of the same job from running concurrently.

To delete a Conflict Record using the Maintain Job Details form:

• Find the record to be deleted.
• Locate the cursor in the record to be deleted.
• Delete record.
• Save.

Rules/Notes:

This will have the effect of allowing both jobs to run concurrently.

2011 - Calipso

Updated reference and link to the tech docs in the CPC wiki space.