Search Results igs_ps_nsus_rtn




Overview
Explore in AI Chat

Overview

IGS_PS_NSUS_RTN is a table within the IGS (Student System) product schema of Oracle E-Business Suite, present and valid in both release 12.1.1 and 12.2.2. Its documented purpose is to store the information that defines Retention master setup — the configuration records that control how non-standard usage or retention charges are calculated for a given unit offering option and fee type. In functional terms, it acts as a setup or rules table rather than a transactional accumulation table: each row represents a configured retention rule keyed by the combination of an offering option and a fee type, together with the definition code, formula method, rounding method, and weekend-duration handling that govern how the retained amount is derived.

From a Data Vault modeling perspective, the heuristic classification mined from the foreign-key structure is satellite-leaning. This is a reasonable modeling suggestion, since the table carries descriptive and rule-oriented attributes (definition, formula, rounding, weekend flags) that qualify and contextualise the parent offering-option and fee-type relationships rather than acting as an independent hub of business entities. It should not be treated as an authoritative Data Vault designation, only as an indicative pattern.

Key Information Stored

The table's documented physical schema in ETRM 12.1.1 comprises twelve columns. The most operationally significant are:

  • NON_STD_USEC_RTN_ID — the surrogate primary key, defined by index IGS_PS_NSUS_RTN_PK. It uniquely identifies each retention master record and is the column referenced by child tables.
  • UOO_ID — foreign key to IGS_PS_UNIT_OFR_OPT_ALL, identifying the unit offering option to which the retention rule applies. It forms part of the business-key candidate index IGS_PS_NSUS_RTN_U1.
  • FEE_TYPE — foreign key to IGS_FI_FEE_TYPE_ALL, identifying the fee type governed by the rule. It is the second column of the unique index IGS_PS_NSUS_RTN_U1.
  • DEFINITION_CODE — the code describing the retention definition used for the rule.
  • FORMULA_METHOD — the method by which the retention or non-standard usage amount is calculated.
  • ROUND_METHOD — the rounding convention applied to the calculated result.
  • INCL_WKEND_DURATION_FLAG — a flag indicating whether weekend duration is included when determining the retained period.

The unique index IGS_PS_NSUS_RTN_U1 (UOO_ID, FEE_TYPE) is the meaningful business-key candidate, enforcing that only one retention master definition exists per offering option and fee type combination. The remaining columns — CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, and LAST_UPDATE_LOGIN — are standard Oracle EBS who-columns used for auditing and concurrency control rather than business meaning.

Common Use Cases and Queries

Typical use cases include reviewing retention setup for a specific offering option, validating that no duplicate rule exists for a given option and fee type, and reporting the calculation methods applied across a programme. A common query retrieves the rule for an option and fee type:

  • SELECT r.non_std_usec_rtn_id, r.definition_code, r.formula_method, r.round_method FROM igs_ps_nsus_rtn r WHERE r.uoо_id = :p_uoо_id AND r.fee_type = :p_fee_type; — returning the single configured rule via the unique business key.
  • Joining to the parent option table to describe rules by option name, and to the fee type table to resolve fee type descriptions.
  • Audit reporting on who created or last updated retention rules within a date range, using the who-columns.

Related Objects

The following objects are most significant to IGS_PS_NSUS_RTN based on the documented FK relationships:

  • IGS_PS_UNIT_OFR_OPT_ALL — parent of UOO_ID; supplies the offering option context for each rule.
  • IGS_FI_FEE_TYPE_ALL — parent of FEE_TYPE; supplies the fee type definition referenced by the rule.
  • IGS_PS_NSUS_RTN_DTL — child table referencing IGS_PS_NSUS_RTN via NON_STD_USEC_RTN_ID; holds the detail lines belonging to each retention master record.