Search Results get_source_context

Overview

APPS.PAY_HK_RULES is a payroll rules package body in the Oracle E-Business Suite Payroll module, localized for the Hong Kong (HK) legislative and payroll context. It is classified in the ETRM metadata as an "OTHER" API type under the APPS schema, indicating that it is not part of the public, supported APIs exposed by Oracle Payroll but rather serves an internal, country-specific processing role. The package is a small, single-purpose body whose header indicates an original creation on 08-Nov-2000 and a subsequent revision on 02-Dec-2002 (version 115.1) that added the nocopy option to the in out parameter of its sole procedure and introduced dbdrv/checkfile commands. The core business function of this package is to resolve the correct "source" element entry context for a given assignment action and element entry, providing the linkage required by Hong Kong payroll processing logic to identify the originating element information for a payroll action.

Key Procedures and Functions

The package exposes a single documented procedure:

• GET_SOURCE_CONTEXT — Resolves and returns the source context identifier for a payroll process. Based on the package source, the procedure accepts an assignment action identifier, an element entry identifier, and an in out nocopy parameter that receives the resolved source value. Internally it opens a cursor that joins the element entries, assignment actions, and payroll actions to derive the source. The nocopy hint added in version 115.1 avoids copying the parameter value during the call, a minor performance optimization. No other procedures or functions are documented.

Tables Accessed

The cursor within GET_SOURCE_CONTEXT reads from the following three tables (referenced through APPS synonyms):

• PAY_ELEMENT_ENTRIES_F — The core element entry table; the procedure selects ENTRY_INFORMATION1 from the matching entry, applying FND_NUMBER.CANONICAL_TO_NUMBER to convert the stored value to a canonical numeric form.
• PAY_ASSIGNMENT_ACTIONS — Provides the assignment action context, linking the assignment action to its parent payroll action via PAYROLL_ACTION_ID and matching the assignment to the element entry.
• PAY_PAYROLL_ACTIONS — Supplies the payroll action and, critically, the EFFECTIVE_DATE used to constrain the element entry within its effective start and end dates.

The join logic ensures the returned source value corresponds to the element entry effective on the payroll action's effective date for the specified assignment and assignment action. The package performs read-only access; no inserts, updates, or deletes are documented.

Usage Notes

Because PAY_HK_RULES is classified as an "OTHER" API and is referenced by zero other packages in the ETRM metadata, it is best understood as an internal utility invoked from within Oracle Payroll's Hong Kong country-specific processing path rather than as a standalone entry point for custom development. It would typically be called from Hong Kong payroll element/rule processing logic, fast formulas, or local payroll concurrent processes that require the source context of an element entry during a payroll run. Custom code should treat it as an unsupported internal object: Oracle does not document its parameters for public consumption, and signatures may change between releases such as 12.1.1 and 12.2.2. Where a supported integration is required, developers should prefer the documented public Payroll APIs. Its presence across both 12.1.1 and 12.2.2 confirms it remains part of the Hong Kong payroll baseline.