Search Results create_valid_restriction

Overview

HR_SUMMARY_API is an Oracle Application Object Library/HRMS PL/SQL package owned by the APPS schema and classified as an API. Its purpose is to provide the programmatic interface for constructing and maintaining the HR summary definitions that underpin the Oracle Human Resources "summary" and "template" framework. These summaries allow implementers and developers to define reusable data-extraction templates driven by item types, key types, key values, item values, restriction types, restriction usage, and restriction values. In practice, the package exposes the set of low-level primitives that let callers register a summary item type, register the keys that identify instances of that item, bind values to those keys, apply generic validity restrictions, and finally assemble the definitions into a runnable template (a "process run"). The package is documented at object level as VALID in the ETRM extract for both the 12.1.1 and 12.2.2 application releases, and it is referenced by four other packages in the HRMS suite.

Key Procedures and Functions

The documented interface comprises twenty-four procedures and functions. The lookup routines are LCK, ROW_DATA, GET_ID, GET_ITU_ID, GET_VKT_ID, GET_RU_ID, and GET_RV_ID; these are the naming and locking accessors used to resolve an existing summary definition identifier (or an item-type-usage, valid-key-type, restriction-usage, or restriction-value identifier) before a create or update operation. The creation routines are CREATE_ITEM_TYPE, CREATE_KEY_TYPE, CREATE_KEY_VALUE, CREATE_ITEM_VALUE, CREATE_RESTRICTION_TYPE, CREATE_RESTRICTION_USAGE, CREATE_RESTRICTION_VALUE, CREATE_ITEM_TYPE_USAGE, CREATE_VALID_KEY_TYPE, CREATE_KEY_TYPE_USAGE, CREATE_TEMPLATE, and CREATE_PROCESS_RUN. Together these build the hierarchy from the elementary metadata (item type, key type) through the value layers (key value, item value) and the constraint layers (restriction type, restriction usage, restriction value), then bind them into usages (item type usage, key type usage, valid key type) and finally into an executable template and process run. Because the ETRM metadata records procedure and function names without parameter details, parameter lists should be confirmed against the package specification in the target release; the names, however, clearly indicate a create-and-resolve API pattern.

Tables Accessed

The only table documented as referenced through APPS synonyms is HR_SUMMARY. All persistent summary definitions created or modified through this API are ultimately written to that table, meaning HR_SUMMARY_API acts as the supported DML gateway for the HR_SUMMARY record set. Direct inserts into HR_SUMMARY are not the supported approach; the API enforces whatever validation and identifier derivation the summary framework requires. The package additionally depends on the SYS-owned STANDARD package, which is a normal PL/SQL dependency.

Usage Notes

HR_SUMMARY_API is an internal building-block API rather than an end-user-facing one. It is documented as referenced by HR_COPY_GSP, HR_FR_SEED_PKG, HR_SUMMARY_API itself (recursive/internal use), HR_SUMMARY_UTIL, and HR_SUM_STORE. This reference pattern shows that the package is normally invoked indirectly: seeding and copy routines use it to reproduce summary definitions across business groups or legislative environments, and utility/store packages use it to materialize and maintain summary data. Custom code should therefore call HR_SUMMARY_API only when implementing or extending the summary/template framework itself, and only after establishing the correct identifiers through the GET_ID/GET_* accessor functions and honouring the LCK locking routine to avoid concurrency issues. Because the metadata lists no forms or concurrent programs directly bound to the package, invocation is expected from other PL/SQL, from concurrent-program logic in the HRMS seed packages, or from custom extensions that must remain aligned with the template definitions consumed by the summary engine.