Search Results get_customized_restriction

Overview

APPS.HR_GEN_PKG is the server-side agent for the Oracle HRMS forms libraries. Its purpose, as stated in the package header, is to handle all server-side traffic to and from the Human Resources forms libraries, centralizing server logic so that the client-side library code remains free of embedded SQL and can be maintained as a global library. This design supports the requirement that a form and its attached libraries reference the same server-side package, avoiding an environment where both a form and its libraries define competing copies of the same server-side logic. The package has been in the HRMS code line since 1995 and was maintained through the 11i and R12 releases, including 12.1.1 and 12.2.2. Its scope includes forms initialization, session attribute management, date and session-date handling, legislation and business group restriction lookups, comment maintenance, tracing utilities, and pipe-based messaging used by Advanced Benefits (ADE) processing.

Key Procedures and Functions

• PUTSESSIONATTRIBUTEVALUE — Stores a value in the session so that subsequent server-side calls within the same form session can retrieve it.
• GET_CUSTOMIZED_RESTRICTION — Returns customized restriction information, notably applicable to legislation and business group filtering, removing the need for client-side restriction SQL.
• INSERT_COMMENT — Inserts a comment row into the HR comments schema.
• COMMENT_TEXT — Retrieves or manages comment text, historically widened to accommodate long comment values.
• GET_DATES — Returns date values used for date-track processing; later versions added an overload of this routine.
• CHANGE_SES_DATE — Alters the effective session date used by the current form session.
• DELETE_SES_ROWS — Removes session-related rows that are no longer required.
• TRACE_ON — Enables diagnostic tracing for the session.
• TRACE_OFF — Disables diagnostic tracing, the counterpart to TRACE_ON.
• TRACE — Writes trace output when tracing is active.
• SET_TRACE_OPTIONS — Configures the destination or behavior of the tracing mechanism.
• SET_LOCATION — Records or resets an application or session location.
• PIPE_ADE_DETAIL — Sends ADE detail over the database pipe mechanism.
• RESET_PIPE_BUFFER — Clears the pipe buffer before or after messaging.
• PURGE_PIPE — Removes residual messages from the pipe.
• SEND_PIPE_MESSAGE — Transmits an inter-process message using DBMS_PIPE.

Tables Accessed

• HR_COMMENTS, HR_COMMENTS_S — Base table and its synonym, used by INSERT_COMMENT and COMMENT_TEXT to store and retrieve comments attached to HR entities.
• PAY_CUSTOMIZED_RESTRICTIONS — Referenced by GET_CUSTOMIZED_RESTRICTION to enforce legislation and business group restrictions.
• DBMS_PIPE — The database pipe package, used by the ADE-related pipe procedures for inter-session messaging.

Usage Notes

HR_GEN_PKG is not an end-user API. It is invoked from Oracle HRMS forms and their attached libraries, typically during form initialization (init_forms), session attribute setup, comment entry, date tracking, and optional tracing. The pipe routines support Advanced Benefits communication between database sessions. Because the package is not referenced by other documented packages, customizations should not assume it is a stable public interface; changes to its signatures or behavior between 12.1.1 and 12.2.2 may break dependent forms. When investigating issues, the TRACE_ON, TRACE_OFF, and SET_TRACE_OPTIONS routines can be used to generate server-side diagnostic output for the calling session.