Results for “format_mask”

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

Overview

IGS_PE_PERSON_ID_TYP is a reference (lookup) table within the Oracle E-Business Suite Student System module (IGS). It defines the categories, or types, of person identifiers that may be attributed to an individual in the institutional person registry. Examples cited in the ETRM documentation include an OLAA id, a VTAC id, or an "old id" — identifiers issued by external admissions bodies or legacy identifiers retained for historical reconciliation. Every alternate person identifier recorded against a person must be classified by one of the rows defined in this table, which makes it a foundational control object for identity management across the Student System.

From a Data Vault modeling perspective, the mined foreign-key structure classifies this object as hub-leaning. It functions principally as a durable, business-key driven reference set that many downstream tables resolve against, rather than as a transactional or dependent-child structure. No foreign keys are recorded outbound from this table, confirming its role as a terminal lookup rather than a link between business entities.

Key Information Stored

The table carries 14 documented columns in the 12.1.1 ETRM schema. The most significant are:

• PERSON_ID_TYPE — the primary key and the business-key candidate. Also enforced by unique index IGS_PE_PERSON_ID_TYP_U1 and by primary key constraint IGS_PE_PERSON_ID_TYP_PK. This is the code referenced by all dependent foreign-key columns.
• DESCRIPTION — human-readable label for the identifier type.
• S_PERSON_ID_TYPE — the short or secondary display form of the type.
• INSTITUTION_CD — institution qualifier, allowing different identifier taxonomies per institution.
• PREFERRED_IND — flags whether an identifier of this type is treated as preferred.
• UNIQUE_IND — controls whether only one identifier of this type may be held per person.
• FORMAT_MASK — input/validation mask applied to the identifier value.
• REGION_IND — regional applicability indicator.
• CLOSED_IND — marks a type as retired so it is no longer offered for new assignments while remaining valid for history.
• Audit columns — CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, and LAST_UPDATE_LOGIN support standard EBS auditing.

No separate surrogate sequence key is documented; the identifier type code itself serves as the primary key, and the unique index on PERSON_ID_TYPE is the sole business-key candidate.

Common Use Cases and Queries

Typical reporting and validation scenarios include listing all active identifier types for a given institution, resolving codes to descriptions on person-level reports, and validating that a person's identifiers respect uniqueness and preference rules.

• Lookup of active types: SELECT person_id_type, description FROM igs_pe_person_id_typ WHERE closed_ind = 'N' ORDER BY description;
• Joining identifiers to their type definitions: SELECT a.person_id, a.person_id_type, t.description, a.person_id_value FROM igs_pe_alt_pers_id a, igs_pe_person_id_typ t WHERE a.person_id_type = t.person_id_type;
• Enforcing uniqueness analysis: identify persons holding more than one identifier of a UNIQUE_IND type.
• Admissions and statutory extracts, such as 1098-T setup, where the configured PERSON_ID_TYPE drives which identifier is printed.
• Institution-specific configuration review, filtering by INSTITUTION_CD and REGION_IND.

Related Objects

The table is referenced by six documented foreign keys. The most significant are:

• IGS_PE_ALT_PERS_ID via PERSON_ID_TYPE — the principal child holding the actual alternate identifier values attributed to a person. This is the most operationally important dependency.
• IGS_AD_IMP_NEAR_MTCH_ALL via PERSON_ID_TYPE — used in admissions near-match processing and duplicate detection.
• IGS_SS_ADMAPPL_SETUP via PERSON_ID_TYPE — admissions application configuration.
• IGS_DA_SETUP via DEFAULT_STUDENT_ID_TYPE — defines the default student identifier type for the institution.
• IGS_FI_1098T_SETUP via PERSON_ID_TYPE — drives the identifier used on 1098-T tax reporting.
• IGS_UC_DEFAULTS via NI_NUMBER_ALT_PERS_TYPE — UCAS-related defaults for national insurance and alternate person identifiers.

Because these dependents rely on the PERSON_ID_TYPE code, any change to a type code or its CLOSED_IND status should be assessed against all referencing setups and person identifier records before being applied.