Results for “psp_salary_cap_overrides_api”

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

Overview

PSP_SALARY_CAP_OVERRIDES_API is an internal PL/SQL API belonging to the Oracle E-Business Suite Applications schema (APPS). It provides programmatic control over salary cap override records, which are used in grant and effort reporting processes to allow an institution to substitute a project- or funding-source-specific annual salary cap in place of the standard cap for a defined date range. The package exposes a small, focused set of DML-style procedures that create, modify, and remove override rows. As indicated by the source header, the package is marked "Internal Development Use Only," meaning it forms part of Oracle's internal implementation surface rather than a formally published public interface. Its behavior is transactional: each procedure either completes the intended operation or raises an error and leaves the underlying override data unchanged.

Key Procedures and Functions

• CREATE_SALARY_CAP_OVERRIDE — Creates a salary cap override record. The procedure requires that a salary cap already exist for the specified date range as a prerequisite. It accepts the funding source code, project identifier, start and end dates, currency code, and annual salary cap value, and returns an object version number, the newly generated salary cap override identifier, and a return status flag. When the validate parameter is supplied, the procedure performs validation of the effort report line without committing the change. On success, the override is created; on failure, no row is written and an error is raised.
• UPDATE_SALARY_CAP_OVERRIDE — Modifies an existing salary cap override record, typically used when the annual cap amount, currency, or effective date range of an override must be adjusted. It relies on the object version number to enforce optimistic locking, ensuring that stale updates against concurrently modified rows are rejected.
• DELETE_SALARY_CAP_OVERRIDE — Removes an existing salary cap override, retiring the exception so that the standard salary cap logic applies for the affected project and funding source over the previously overridden date range.

Tables Accessed

The ETRM metadata for this package does not enumerate the specific base tables it references. Based on the package's documented purpose and naming conventions within the salary cap feature area, the procedures operate against the salary cap override entity and its supporting salary cap definition. The override rows are keyed by funding source code, project identifier, and effective start and end dates, and they store a currency code and an annual salary cap amount. The object version number returned and consumed by these procedures is maintained on the override row itself to support concurrent update control. Callers should treat the underlying table names as internal implementation details of the salary cap override feature.

Usage Notes

Because the package is classified for internal development use, it is generally not intended for direct invocation by customer extensions. It is most likely called from the salary cap maintenance user interface within the grants and effort reporting modules, from concurrent programs that process salary cap overrides in bulk, or from other internal APIs — the metadata shows the package is referenced by one other package. Custom code that must manage overrides should prefer the supported user interface or a supported public API where one exists. If direct invocation is unavoidable, callers must observe the validation, prerequisite, and optimistic locking conventions of the procedures: supply a valid salary cap definition covering the requested date range, pass accurate object version numbers on update and delete, and respect the returned status flags rather than assuming success. The package is present across Oracle EBS 12.1.1 and 12.2.2 with the same three-procedure surface.