Purpose

This job rolls over cohort process windows from one calendar to another.

SubSystem

General System Functions and Facilities

This job should be run as required after calendars have been rolled over.

Cohort Process Windows define time periods in which processes can be accessed for particular cohorts. They are normally defined by a start date alias and an end date alias within calendars appropriate to the process. Cohorts are defined in GENF1000 and the dates defining their process windows are recorded in GENF1100.

This job creates new instances of Cohort Process Windows using existing instances as a pattern to repeat in another calendar.
The user selects the Calendar Instance and optionally the Process Type and Cohort as the rollover source, and a Calendar Instance as the rollover destination.
The job locates all existing Cohort Process Windows from the source and creates equivalent records in the destination Calendar Instance for the same Process(es) as exist in the source Calendar Instance.
The user may run the job only for the chosen Calendar Instance, or they can also include any subordinate Calendar Instances. For example, if a user only chooses ACAD-YR 2010 as the rollover source and ACAD-YR 2011 as the rollover destination and they select the 'Include Subordinate Calendar Instances' check box, then the job finds all Cohort Process Windows defined against all processes and all Calendar Instances subordinate to ACAD-YR 2010. If there is one Cohort Process Window defined against the ADD-UNIT process for SEM-1 2010, then the job will create a Cohort Process Window against the ADD-UNIT process for SEM-1 2011.

The Job Run Log
Where a record cannot be created, the function logs validation errors or warnings in the job run log.
Errors, warnings and information generated while rolling over the Cohort Process Window are stored in the existing S_LOG and S_LOG_ENTRY tables, with an S_LOG_TYPE of CPW-ROLL denoting a Cohort Process Window Rollover entry.
When the Cohort Process Window Rollover job is run, an XML file is created from the S_LOG records (in the format specified by the XSLT style sheet) and the file is sent to the output as defined in the job output configuration in JBSF4110.

Warnings will be logged if:

• A date alias instance is being rolled over and is not defined for the destination calendar then a warning is logged.
• A date alias that is closed is being rolled over then a warning is logged.
• A start date alias value is in the past or null and end date alias is in the future or null then a warning is logged.
• An end date alias value is in the past then then a warning is logged.
• A Cohort Process Window already exists in the rollover destination Calendar Instance and Process combination in a cohort code other than the one being rolled over, then the rollover will create the new cohort, but warning is recorded in the log.

Cohort Process Windows will not be rolled over if:

• A Cohort has a System Status of INACTIVE or PLANNED in GENF1000.
• A matching ACTIVE or PLANNED cohort already exists as a Cohort Process Window in the rollover destination Calendar Instance/Process combination, then it will not be overwritten and an error is logged.

Previous Jobs
This job can also recreate the output from previous job runs. From the Previous Log Creation Date LOV the user can select a previous log file. When the user clicks on the 'Create File' button, an XML file will be sent to the output defined in JBSF4110.
The log is also accessible via GENJ1100.

The Reproduce Log File block contains:

• Previous Log creation Date
• Log Level

Parameters Tab

• Create File

Rules/Notes:

When a Previous Log creation Date is specified, the job creates an XML file. No other parameters except Log Level will be considered and no Cohort Process Windows are rolled over.

The selection from the Log Level poplist determines what entries will appear in the log file that is produced.

A Previous Log Creation Date must be specified prior to the Create File button being clicked.

The Rollover Source block contains:

• Source Calendar
• Include Subordinate Calendars check box
• Process Type
• Cohort
  

Rules/Notes:

The Source Calendar field label is initially coloured red. This colour disappears when a value is selected for this field or for the Previous Log Creation Date field.

If the Source Calendar has a subordinate Calendar Instance that does not exist in the Destination calendar structure, and the subordinate Rollover Source Calendar Instance contains Cohort Process Windows, then no records for that Calendar Instance are created and an error is logged.

If the job is run with the 'Include Subordinate Calendar Instances' check box selected, and the Destination Superior Calendar Instance has a subordinate Calendar Instance that is not defined as a subordinate to the Source Calendar Instance, then a warning is logged.

If a Destination Calendar Instance has more than one subordinate Calendar Instance of the same Calendar Type and Alternate Code (e.g. Academic Period has two SEM-1 records an Alternate Code of S1, but with different start dates) the rollover process will not create Cohort Process Windows for these calendars. An error will be logged.

The Rollover Destination and Output block contains:

• Destination Calendar
• Predictive Mode check box
• Exception Log Comments

Rules/Notes:

The Destination Calendar field label is initially coloured red. This colour disappears when a value is selected for this field or for the Previous Log Creation Date field.

If the Predictive Mode check box is checked then the rollover process will run, and will log any errors, warnings or information to the error log, however it will not create any Cohort Process Window records.

Any text recorded in the Exception Log Comments is included in the SYSTEM_LOG.KEY field and is displayed in description field adjacent to the Previous Log Creation Date.