Search Results orgp_upd_ou_sts

Overview

IGS_OR_GEN_001 is a public PL/SQL package owned by the APPS schema in Oracle E-Business Suite Release 12.1.1 and 12.2.2. It is classified as an "OTHER" API within the ETRM repository rather than a formal public API, meaning it is intended primarily for internal use by Oracle's own application modules but is callable from custom extensions at the customer's own risk. The package delivers a general-purpose utility library for the Oracle Student System (formerly Oracle iLearning/Student System, module prefix IGS) organization component, whose responsibility is the maintenance of the institution and organization unit hierarchy used throughout enrollment, admissions, and academic records processing.

The package is unusually broad in scope: it combines date-effective history maintenance for organization units, status derivation and update routines, and location-type lookups into a single container. Its header identifies the original author (pkpatel, December 2001) and records that the update_org procedure was added under Bug 2266315 in May 2002 specifically to synchronize organization unit records with the party model introduced by Oracle's Trading Community Architecture (TCA) via HZ_PARTIES. The package relies on AUTHID CURRENT_USER, so all SQL executed within it resolves objects and privileges against the calling schema rather than the definer's schema.

Key Procedures and Functions

• UPDATE_ORG — The procedure most commonly sought by name in searches such as "update_org". It performs the update of an organization's record, taking an organization unit code drawn from the party number domain and an organization status, and applying the change through the package's internal logic. It is the entry point used when correcting or advancing an organization unit's status.
• ORGP_UPD_OU_STS — Updates the status of a specified organization unit across an effective date range, returning a message name as an OUT parameter to indicate success or the nature of any failure.
• ORGP_UPD_INS_OU_STS — Updates status for organization units belonging to a given institution, likewise emitting a message name to the caller.
• ORGP_DEL_INSTN_HIST and ORGP_DEL_OU_HIST — Delete historical rows for an institution or for a specific organization unit and start date respectively, used when purging superseded history records.
• ORGP_INS_OU_HIST — Inserts a historical snapshot row for an organization unit, capturing description, status, type, member type, and institution along with effective and history start/end dates and the history "who" column for audit purposes.
• ORGP_GET_LOCAL_INST — Returns the local institution code for the current session or environment.
• ORGP_GET_S_LOC_TYPE and ORGP_GET_S_LOC_TYPE2 — Return a location type designation, the first keyed on a location code and the second keyed directly on a location type value.
• ORGP_GET_WITHIN_OU — Answers whether one organization unit falls within another, supporting optional direct-match evaluation; it is declared with PRAGMA RESTRICT_REFERENCES (WNDS, WNPS) so it can be safely invoked from SQL and from other restricted contexts.

Tables Accessed

The package references several tables through APPS synonyms. HZ_PARTIES supplies the party number that keys update_org, reflecting the TCA integration of organization units. IGS_PE_HZ_PARTIES links person and organization records to their TCA party rows, and is used to reconcile organization identity with party identity. IGS_OR_STATUS holds the valid organization status values applied and validated by the status update routines. IGS_OR_UNIT_REL stores the hierarchical relationships between organization units and is the primary source for ORGP_GET_WITHIN_OU. IGS_AD_LOCATION_ALL provides location and location type data for the two ORGP_GET_S_LOC_TYPE functions. In addition, the package declares a global variable, g_org_unit_cd, typed against hz_parties.party_number.

Usage Notes

IGS_OR_GEN_001 is not an end-user-facing API; it is invoked indirectly. The ETRM metadata records that it is referenced by eleven other packages, which is the typical invocation path: forms and concurrent programs in the Student System organization components call higher-level APIs, which in turn call these utility procedures. Custom code should call the package only after determining that no supported public API exists for the required operation, and should supply a valid organization unit code and status consistent with IGS_OR_STATUS. Because ORGP_GET_WITHIN_OU carries RESTRICT_REFERENCES, it is safe to embed in SQL statements. Callers of the status update procedures should always inspect the returned message name; a non-null value indicates a functional condition rather than a raised exception. All date-effective operations require the caller to supply accurate effective and history dates, as the package does not derive them automatically. Given the AUTHID CURRENT_USER declaration, custom callers must hold direct privileges on the underlying tables rather than relying on the APPS schema's grants.