Search Results delete_user_column

Overview

APPS.PAY_USER_COLUMN_API is a PL/SQL package body in the Oracle E-Business Suite (EBS) Payroll (PAY) module, classified as an API. It provides the programmatic interface for defining and maintaining user-defined columns within the Payroll application. User columns allow implementers and administrators to extend the standard data model with custom descriptive fields that can be associated with payroll-related entities, enabling organizations to capture information that is not provided by seeded columns. The package encapsulates the business rules and validation logic required to create, modify, and remove these definitions, ensuring that the underlying metadata remains consistent and that all dependent objects are updated appropriately. The ETRM metadata confirms the package is VALID in the APPS schema in both release 12.1.1 and 12.2.2.

Key Procedures and Functions

The documented API surface consists of three procedures:

• CREATE_USER_COLUMN — Defines a new user column. It validates the submitted definition against existing column metadata and persists the new record through the underlying DML layer.
• UPDATE_USER_COLUMN — Modifies the attributes of an existing user column definition while preserving referential integrity with dependent objects.
• DELETE_USER_COLUMN — Removes a user column definition and manages the associated dependent records as part of the deletion process.

No parameter lists are published in the available metadata, so the exact signatures must be confirmed by inspecting the package specification on the target instance.

Tables Accessed

The ETRM excerpt does not enumerate the base tables accessed through APPS synonyms, so the specific table names cannot be asserted from the documentation alone. Based on the dependency listing, the package performs its DML exclusively through internal helper packages rather than issuing direct SQL. The dependencies PAY_PUC_INS, PAY_PUC_UPD, and PAY_PUC_DEL handle insert, update, and delete operations on the primary user column table, while PAY_PCT_INS, PAY_PCT_UPD, and PAY_PCT_DEL perform the equivalent operations for the related user column context/definition table. This layered design keeps the public API independent of the physical table structures and centralizes validation and auditing behavior in the helper packages.

Usage Notes

PAY_USER_COLUMN_API is typically invoked when user columns are added or maintained through the Payroll setup user interface, where the form calls the API instead of performing direct DML. It is also the recommended entry point for custom code and data-migration scripts that must create or alter user column definitions, because it guarantees application of the supported business rules. The package is referenced by three other database objects, confirming it forms part of a wider dependency chain within the Payroll schema. Callers should note that the package is not itself referenced as a dependency by the objects it invokes; the direction of dependency runs from the helper packages back to this API. As with all EBS public APIs, the package should be called with proper initialization and exception handling, and the standard commit strategy for the calling program should be respected. Any direct manipulation of the underlying tables is discouraged, as it bypasses the validation performed here.