Results for “report_null_flag”

7 results




AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IGS_HE_USR_RT_CL_FLD is a table in the IGS (Student System) product schema of Oracle E-Business Suite, valid in both 12.1.1 and 12.2.2. It holds the field-level definition of a User Defined Return Class — the specific fields that a user elects to include when configuring a return class that deviates from the delivered System Return Class. Because the selected fields are normally a subset of those defined for the System Return Class, this table functions as a user-specific projection or filtering layer over the seeded return-class field definitions.

From a Data Vault modeling perspective, the heuristic classification of this object is satellite-leaning. That is, it behaves less like an independent hub of business entities and more like a descriptive satellite attached to the user return class parent. Each row carries descriptive and behavioral attributes (include flags, constant values, default values, null-reporting flags) that qualify the parent entity rather than establishing a new identity. This classification is a modeling suggestion derived from FK structure, not a delivered architectural statement, and implementers should treat it as guidance when mapping IGS data into a warehouse or integration layer.

Key Information Stored

The table contains twelve documented columns. The most significant are:

  • USR_RT_CL_FLD_ID — surrogate identifier for the row, enforced by unique index IGS_HE_USR_RT_CL_FLD_U2.
  • USER_RETURN_SUBCLASS — the user-defined return class to which this field definition belongs; part of the composite primary key.
  • FIELD_NUMBER — identifies the field within the return class; the second component of the composite primary key.
  • CONSTANT_VAL — a fixed value substituted for the field, used when the field is not sourced from transactional data.
  • DEFAULT_VAL — the default value applied to the field when no other value is supplied.
  • INCLUDE_FLAG — controls whether the field participates in the user-defined return class; this is the primary mechanism by which the subset is defined.
  • REPORT_NULL_FLAG — governs whether null occurrences are reported for the field in return output.
  • CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN — standard EBS audit columns capturing who created and last modified the row and when.

The primary key IGS_HE_USR_RT_CL_FLD_PK is (USER_RETURN_SUBCLASS, FIELD_NUMBER), which is also enforced by the unique index IGS_HE_USR_RT_CL_FLD_U1. The second unique index, IGS_HE_USR_RT_CL_FLD_U2, keys on USR_RT_CL_FLD_ID alone, making both the composite business key and the surrogate identifier candidates for uniqueness. Implementers should recognize that the business key is the (USER_RETURN_SUBCLASS, FIELD_NUMBER) pair rather than the surrogate.

Common Use Cases and Queries

Typical usage centers on reporting and validating the composition of user-defined return classes. A common query lists the fields included in a given class:

  • SELECT FIELD_NUMBER, INCLUDE_FLAG, DEFAULT_VAL, CONSTANT_VAL FROM IGS_HE_USR_RT_CL_FLD WHERE USER_RETURN_SUBCLASS = :subclass ORDER BY FIELD_NUMBER;
  • Filtering to included fields only: add WHERE INCLUDE_FLAG = 'Y'.
  • Identifying classes that override values: WHERE CONSTANT_VAL IS NOT NULL OR DEFAULT_VAL IS NOT NULL.
  • Auditing recent changes: WHERE LAST_UPDATE_DATE >= :since AND LAST_UPDATED_BY = :user_id.

These patterns support configuration review, migration verification between environments, and reconciliation of user-defined classes against the System Return Class field inventory. Reports that compare delivered versus user-defined field sets rely on outer joins between this table and the system field definitions.

Related Objects

The documented foreign key relationship is:

  • IGS_HE_USR_RTN_CLAS — referenced by IGS_HE_USR_RT_CL_FLD.USER_RETURN_SUBCLASS. This parent table defines the user return class header, and the join column USER_RETURN_SUBCLASS is the principal association for querying fields within a class.

Beyond this documented FK, the table is closely associated in practice with the System Return Class field definitions that supply the superset from which user fields are drawn, with the return class header and line structures that consume the included fields, and with the standard EBS audit/Who columns sourced from FND standard date and user tracking. Integration or extract logic should always resolve the parent class via IGS_HE_USR_RTN_CLAS before interpreting field-level flags, since INCLUDE_FLAG and DEFAULT_VAL are only meaningful within the context of a specific user return class.