Search Results pay_run_types_tl




Overview
Explore in AI Chat

Overview

APPS.PAY_IP_STARTUP_UTIL is a utility package body in the Oracle Payroll (PAY) module of Oracle E-Business Suite. It supports the installation and startup processing that occurs when a new Oracle Payroll legislative environment, application ownership, or product installation is configured. The package performs the low-level setup operations required to make a payroll installation functional: it establishes application ownership records, creates key flexfield structures, builds element and balance classifications, defines run type records (including the TL-enabled run type definitions surfaced through PAY_RUN_TYPES_TL), constructs eligibility rules and formula routes, and moves data between shadow and main tables during installation and upgrade.

The package body carries a header revision of 120.3, indicating an Oracle 12.0-level code line that remains in service under EBS 12.1.1 and 12.2.2. Because it is classified as a UTIL package, it is not intended as an end-user API; it is invoked by installation, upgrade, and setup orchestration code within the Payroll product.

Key Procedures and Functions

  • INSERT_OWNERSHIP — Creates application ownership records, populating the HR application ownerships tables that govern which application owns a given payroll installation.
  • CHECK_TO_INSTALL — Determines whether a particular installation or setup step is required, acting as a gate before other setup procedures execute.
  • MOVE_TO_SHADOW_TABLES and UPDATE_SHADOW_TABLES — Stage payroll setup data into shadow (staging) tables so it can be validated and transformed before being pushed to production tables.
  • MOVE_TO_MAIN_TABLES — Transfers validated data from the shadow tables into the main application tables, completing the installation or upgrade load.
  • INSERT_HISTORY_TABLE — Records historical setup information, preserving a trail of installation or upgrade changes.
  • CREATE_KEY_FLEXFIELD — Creates key flexfield structures, including segments and structures registered through the FND flexfield tables.
  • CREATE_LEG_RULE — Defines legislation-specific eligibility rules used in payroll processing.
  • CREATE_RUNTYPE and UPDATE_RUN_TYPE_TL — Create run type definitions and maintain their translated (TL) attributes, which is the path by which records in PAY_RUN_TYPES_TL are established or refreshed for a legislative environment. This pair of procedures is directly relevant to queries involving the run type translated table.
  • UPDATE_ELE_CLASS_TL, UPDATE_BAL_TYPE_TL, and UPDATE_BAL_CATEGORIES_TL — Maintain translated attributes on element classifications, balance types, and balance categories respectively.
  • CREATE_ENH_RETRO_SETUP and CREATE_GEN_UPG_DFN — Establish enhanced retroactive processing setup and generate upgrade definitions used during product upgrade.
  • SETUP — The top-level orchestration procedure that drives the individual setup steps in the appropriate sequence.
  • WRITE_LOG — A diagnostic utility that writes formatted messages to the concurrent request log or output file, applying up to two substitution tokens to an FND message. Logging is conditional on the LOGGING action parameter; when logging is disabled, log-file messages are suppressed, but OUTPUT file messages are still written. Blank lines are emitted when the message text is null.

Tables Accessed

The package reads and writes application ownership and legislation installation data through HR_APPLICATION_OWNERSHIPS, HR_S_APPLICATION_OWNERSHIPS, HR_LEGISLATION_INSTALLATIONS, and HR_STU_EXCEPTIONS. Flexfield and menu structures are managed through FND_ID_FLEX_SEGMENTS, FND_ID_FLEX_STRUCTURES, FND_APPLICATION, FND_MENUS, FND_MENU_ENTRIES, FND_FORM_FUNCTIONS, and FND_TERRITORIES_TL. Installation state is verified against FND_PRODUCT_INSTALLATIONS. Formula and route definitions are created and maintained through FF_ROUTES, FF_ROUTE_CONTEXT_USAGES, and FF_ROUTE_PARAMETERS. The package also reads PAY_ACTION_PARAMETERS to resolve the LOGGING flag and delegates group context to PAY_CORE_UTILS.

Usage Notes

PAY_IP_STARTUP_UTIL is invoked during payroll installation, legislative startup, and upgrade processing rather than from standard user-facing forms. It is referenced by one other package in the ETRM inventory, consistent with its role as an internal setup dependency. Because it writes directly to core setup tables and flexfield definitions, custom code should not call its procedures against a production environment; any reuse should be limited to controlled setup or migration scripts and should be preceded by a full data backup. Diagnostic behavior can be influenced by the LOGGING action parameter, and messages are routed through FND_FILE and FND_MESSAGE for standard concurrent-manager log and output handling. All identifiers rely on APPS synonyms, so invocations must be qualified appropriately in a multi-org, multi-legislative deployment.