Search Results pay_gb_eyctl




Overview
Explore in AI Chat

Overview

PAY_GB_EYCTL is an Oracle E-Business Suite package body owned by the APPS schema, classified under the generic API category "OTHER" in the ETRM repository. Its name follows the Oracle Payroll (PAY) naming convention for the United Kingdom localization, where the "GB" segment denotes the country-specific module and the "EYCTL" suffix implies "End of Year Control." The package therefore serves as the control layer for the United Kingdom end-of-year (EOY) payroll processing cycle, supporting statutory year-end submissions and reconciliation activities required by HM Revenue & Customs.

In Oracle EBS 12.1.1 and 12.2.2, the package is documented as VALID with a single exposed procedure, EOY_CONTROL. Its dependency graph confirms its role as an orchestration utility rather than a base business entity: it consumes the concurrent manager interfaces (FND_CONCURRENT and FND_REQUEST), profile options (FND_PROFILE), and HR utilities (HR_UTILITY), and it interfaces with the year-end extract infrastructure through PAY_YEAR_END_EXTRACT.

Key Procedures and Functions

  • EOY_CONTROL — The single documented procedure in the package body. As the name indicates, it provides the controlling entry point for United Kingdom end-of-year processing. Although the ETRM metadata does not publish its parameter list, the procedure is understood to coordinate or drive EOY activity, likely by submitting or managing the concurrent requests associated with the year-end extract and submission process. It is the only callable interface documented for PAY_GB_EYCTL, and all functional access to the package's logic is expected to flow through it.

No additional procedures or functions are recorded in the documented metadata, and the listed references to PAY_GB_EYCTL itself (a self-reference in the dependency chain) indicate internal, package-private logic that is not exposed externally.

Tables Accessed

The ETRM documentation for PAY_GB_EYCTL does not list direct table references through APPS synonyms; the dependency section instead records references to other PL/SQL units. The notable dependency is PAY_YEAR_END_EXTRACT, the year-end extract package, which is the component responsible for assembling the statutory EOY data set. PAY_GB_EYCTL relies on this package for extract generation rather than querying payroll tables directly, consistent with an orchestration role. Supporting dependencies include:

  • FND_REQUEST — used to submit concurrent programs, such as the year-end extract or EOY report request, programmatically.
  • FND_CONCURRENT — used to monitor or manage the status of those concurrent requests.
  • FND_PROFILE — used to read environment and localization profile option values that govern EOY behavior.
  • HR_UTILITY — used for standard HR/Payroll utility operations such as date handling or business-group context.

Because no direct table access is documented, DBAs and developers should treat the package as an indirect data consumer that acts through PAY_YEAR_END_EXTRACT and the concurrent manager APIs.

Usage Notes

PAY_GB_EYCTL is not referenced by any other database object, which confirms that it is an application-facing utility rather than a shared internal library. It is therefore invoked either from the United Kingdom Payroll responsibility through a form or concurrent program, or from custom code that requires programmatic control of EOY processing. Typical invocation patterns include calling EOY_CONTROL from a concurrent program wrapper or a custom PL/SQL script to trigger the year-end extract and submission chain during the annual payroll close. Because the package depends on FND_REQUEST and FND_PROFILE, it must be executed in a valid Applications session with an initialized environment; standalone SQL*Plus execution without the APPS context is not supported. In 12.2.2, where the online patching editioning model applies, the package is expected to be resolved through the editioning view in the APPS schema. Administrators should verify the package status as VALID after patching, since any invalidation of PAY_YEAR_END_EXTRACT or the FND dependencies will cascade to PAY_GB_EYCTL and block the EOY cycle.