Search Results igs_he_sub_rtn_cal_pk

Overview

The IGS_HE_SUB_RTN_CAL table is a component of the Oracle E-Business Suite's now-obsolete Student System (IGS). Its primary function is to manage the association between specific submission returns and the academic calendars relevant to those returns. In the context of Higher Education (HE) data submissions, this table acts as a configuration or mapping entity. It explicitly defines which academic calendar instances (CAL_TYPE and CI_SEQUENCE_NUMBER) should be included in the data processing and extraction for a given user-defined submission return (SUBMISSION_NAME, USER_RETURN_SUBCLASS, RETURN_NAME). This ensures that reporting and regulatory returns are scoped to the correct time periods and academic cycles.

Key Information Stored

The table's structure is defined by its composite primary key, which uniquely identifies a calendar association for a submission return. The key columns are:

• SUBMISSION_NAME, USER_RETURN_SUBCLASS, RETURN_NAME: Together, these columns form a foreign key reference to the IGS_HE_SUBMSN_RETURN table. They identify the specific submission and return instance to which a calendar is linked.
• CAL_TYPE, CI_SEQUENCE_NUMBER: Together, these columns form a foreign key reference to the IGS_CA_INST_ALL table (Calendar Instance). They identify the specific academic calendar type and sequence (e.g., "SEMESTER", "2008") that is considered in scope for the associated return.

Each record represents the intentional inclusion of one calendar instance for one submission return.

Common Use Cases and Queries

A primary use case is the setup and validation of a data submission process. An administrator would populate this table to define the temporal boundaries for a HESA or similar statutory return. Common queries would involve listing all calendars linked to a return for review, or joining to calendar and student data to extract submission-specific information. For example, to identify all calendars configured for a specific return:

SELECT cal_type, ci_sequence_number
FROM igs_he_sub_rtn_cal
WHERE submission_name = 'HESA_2024'
  AND return_name = 'STUDENT';

Another critical use is in the background logic of submission extraction programs, which would query this table to determine which academic periods to include when collating student, course, or financial data for the return file.

Related Objects

The table maintains defined foreign key relationships with two core tables in the EBS data model:

• IGS_HE_SUBMSN_RETURN: This is the parent table for submission return definitions. The relationship is enforced through the columns SUBMISSION_NAME, USER_RETURN_SUBCLASS, and RETURN_NAME. This ensures that a calendar association cannot exist without a valid parent return record.
• IGS_CA_INST_ALL: This table stores calendar instance details. The relationship is enforced through the columns CAL_TYPE and CI_SEQUENCE_NUMBER. This ensures that any calendar referenced in a submission return is a valid and existing academic calendar within the system.

The table itself is referenced by its primary key constraint, IGS_HE_SUB_RTN_CAL_PK. It is important to note the ETRM metadata explicitly states this table was "Not implemented in this database," indicating it may exist in the data dictionary but was not actively used in all deployments of the obsolete IGS product.