INTJ0060 - Invoice Summary

Purpose

To create invoice summaries

Subsystem Callista Open Finance Interface (COFI)
Normally Run By A Callista fees administrator in consultation with the institution's Financial System Staff
Anticipated Frequency The job may run on a regular cycle (perhaps weekly or monthly) as determined by the external finance system.
Structure

A parameter form is not required for this job, however Message Box (6636) states: No parameters exist for this job. Do you wish to schedule the job to run as soon as possible?

 

INTJ0060 is a 'master job' comprising several processes.

INTJ0060 consists of two major components:

  • Create invoice summary
  • Update I_INVOICE records

This job runs independently, but accesses invoices created by INTJ0021.

The context for this job is described in the overview.

Run Details

INTJ0060 can only run in batch mode, through the Job Control & Scheduling Subsystem.

Job Conflict

This job has been set up with conflict records preventing it running concurrently with INTJ0020, INTJ0021, INTJ0022, INTJ0023, INTJ0024 and INTJ0065. Nor can several instances of INTJ0060 run simultaneously.

Transfer Statuses

The complete set of transfer status values indicating summary status of each record of I_INVOICE between Callista and the external finance system is:

  • READY, SUMMARISED, SENT, ERROR, NO_SUMM

For the individual processing of records in I_INVOICE, the following transfer status values replace those listed above:

  • READYTMP

Timing

An Invoice Summary is typically generated either daily, weekly or monthly depending on accounting practices of the external finance system

Error Handling

The JOB_STOP_FIRST_ERR_IND indicator in the I_INT_CONTROL table allows each institution to specify the type of error handling for this job and all other COFI jobs.  The two error handling options are:
  • Continue job processing (JOB_STOP_FIRST_ERR_IND = N) – ignore (& handle) errors as they are encountered and log error details.  The job continues and processes the next student’s record.
  • Stop job processing (JOB_STOP_FIRST_ERR_IND = Y) – fail the job when the first error is encountered (existing functionality).  N.B. Any failed validations that do not currently cause the job to fail prior to the introduction of the 'continue job processing' option, will not be affected by the selection of this option.

Checking on the Job Run

Always check the run log in form JBSF5301 to see that the job ran successfully. Custom built messages in the log indicate the outcomes for each component of the job.

The run log details also display the following summary information:

  • Number of records successfully processed
  • Number of records in error
  • Message text that points users to S_LOG and/or S_ERROR_LOG for details of errors / exceptions encountered during processing.

Important: Note that in order for this summary information to be included in the run log, the PASS_RJR_ID_IND value for this job, must be set to 'Y' in the S_JOB table.

 

 

Create Invoice Summary

This module creates invoice summary data for records in I_INVOICE.

Before the job executes, it checks to see if there are any existing records in I_INVOICE_SUMMARY with a summary_status of ERROR or READY. If there are, the job will not run and an error log will be produced.

When the module executes, it creates I_INVOICE summary data (I_INVOICE_SUMMARY) for all records in I_INVOICE which have READY recorded in the summary_status column. The records in I_invoice are noted as SUMMARISED when the new I_INVOICE_SUMMARY is generated. They are also assigned a batch_dt that corresponds with the generation of I_invoice_summary.

The external finance system updates the transfer status of the customer records in I_INVOICE_SUMMARY to SUCCESSFUL or ERROR once processing in the external system is complete. It also assigns them a ext_batch_number which corresponds to the processing job run by the external finance system.

Each summarised amount is determined by grouping the invoice data in I_INVOICE_TRANS_V. The GROUP BY (or summarised by) columns in the invoice summary processing are as follows:

GROUP BY

iitv.fee_type,
iitv.fee_cal_type,
iitv.fee_ci_sequence_number,
iitv.fee_cat,
iitv.course_cd,
iitv.currency_cd,
iitv.tax_account_cd,
iitv.account_cd,
iitv.tax_code,
ifcv.customer_cat;

Previously the output of the invoice summary process was two records – one for fees and one for tax. This is now rolled into the one record with new TAX_SUMMARY_AMT and FEE_AND_TAX_SUMM_AMT columns populated.

 

Rules/Notes:

The summary_status of records in I_INVOICE are either SUMMARISED, SENT or ERROR, after the external process and other COFI processes have processed the data.

Further the individual processing uses a value of READYTMP to indicate that the record is for the purpose of matching of individual processing records only and is not to be summarised.



 

Update I_Invoice records

This module checks on the state of records in the I_INVOICE_SUMMARY table and updates I_INVOICE records that have previously had SUMMARISED recorded in the summary_status column. Records in the I_INVOICE_SUMMARY table with a transfer_status of SUCCESSFUL result in a corresponding summary_status in I_Invoice of SENT. Records in the I_INVOICE_SUMMARY table with a transfer_status of ERROR result in a corresponding summary_status in I_Invoice of ERROR. In each case, the record in I_INVOICE is updated with the iis_sequence_number from the I_INVOICE_SUMMARY table record into which the invoice record was summarised..

 

Sample of the Summary Information provided in the Run Log for INTJ0060, if JOB_STOP_FIRST_ERR_IND = N in the I_INT_CONTROL table:

 

Started updating invoices with external reference details
that are related to successfully exported summary records 05/04/2008 16:15:48
Total records processed: 234 (Successful: 220 Unsuccessful: 14‘)
Completed updating invoices with external reference details 05/04/2008 16:15:48

Started updating invoices for summary batch 05/04/2008 16:15:48
Total records processed: 234 (Successful: 220 Unsuccessful: 14‘)
Completed updating invoices for summary batch 05/04/2008 16:15:48

Started summarising batch of invoices05/04/2008 16:15:48
Total records processed: 234 (Successful: 220 Unsuccessful: 14‘)
1000 Invoices summarised into 50 Invoice Summary records
Completed summarising batch of invoices 05/04/2008 16:15:48

Invoice records have been summarised.
Started creating job run message log 05/04/2008 16:15:48
Total number of system log entries created: 14
Please query the system log entries for details of all errors and exceptions. Additional detail on system errors can be viewed in the system error log.
        - Log Type: ‘INV_SUMM’
        - Log Creation Date: 05/04/2008 16:15:48
Completed creating job run message log 05/04/2008 16:15:48

 

Last modified on 27 June, 2013 1:32 PM

History Information

Release Version Project Change to Document
11.0.0.0.0.0. 1350 - Job Error Handling Part 2 Added details relating to error handling and log entries
10.1.0.0.0.0 1348 - Job Error Handling Part 1 Added details re Job Error handling and Run Log details.