Search Results pay_ip_startup_util
Overview
PAY_IP_STARTUP_UTIL is a utility package owned by the APPS schema in Oracle E-Business Suite, classified under the ETRM as a UTIL (utility) API. Its role is to support the installation, upgrade, and installation-tracking operations associated with the Oracle Payroll "IP" (install/upgrade process) startup routines. In practice, the package orchestrates a series of install-time and upgrade-time activities: it seeds ownership records, creates and maintains key flexfield structures, populates shadow staging tables prior to committing data to production tables, and configures run types, balance types, balance categories, element classifications, and enhanced retroactive setup definitions. Because these operations touch both Oracle Payroll core objects and Oracle Application Object Library (FND) configuration objects such as menus, functions, and flexfields, the package is best understood as a controlled bootstrap utility used when installing or upgrading the payroll product family rather than as a runtime business API.
Key Procedures and Functions
The package exposes eighteen documented procedures and functions. Their purposes, grouped by functional area, are as follows:
- Installation and ownership: INSERT_OWNERSHIP records application ownership entries; CHECK_TO_INSTALL determines whether installation steps are required; SETUP performs the primary orchestration of the install sequence.
- Data migration and staging: MOVE_TO_SHADOW_TABLES, UPDATE_SHADOW_TABLES, and MOVE_TO_MAIN_TABLES manage the staging workflow that copies and promotes data between shadow tables and the main application tables; INSERT_HISTORY_TABLE records historical snapshots.
- Flexfield and route configuration: CREATE_KEY_FLEXFIELD builds key flexfield definitions; CREATE_LEG_RULE creates legislation rules; CREATE_RUNTYPE establishes payroll run types; CREATE_GEN_UPG_DFN creates generic upgrade definitions; CREATE_ENH_RETRO_SETUP configures enhanced retroactive processing setup.
- Translation maintenance: UPDATE_ELE_CLASS_TL, UPDATE_BAL_TYPE_TL, UPDATE_RUN_TYPE_TL, and UPDATE_BAL_CATEGORIES_TL maintain translated (TL) descriptive text for element classifications, balance types, run types, and balance categories.
- Logging: WRITE_LOG records execution activity for diagnostics and audit purposes.
No parameter lists are published in the ETRM metadata; the preceding descriptions state purpose only.
Tables Accessed
The package reads and writes through APPS synonyms across several schemas. Oracle Application Object Library tables underpin configuration and menu setup: FND_APPLICATION, FND_FORM_FUNCTIONS, FND_MENUS, FND_MENU_ENTRIES, FND_ID_FLEX_SEGMENTS, FND_ID_FLEX_STRUCTURES, FND_PRODUCT_INSTALLATIONS, and FND_TERRITORIES_TL. Flexfield routing is handled through FF_ROUTES, FF_ROUTE_CONTEXT_USAGES, and FF_ROUTE_PARAMETERS. Ownership and legislation context is drawn from HR_APPLICATION_OWNERSHIPS, HR_S_APPLICATION_OWNERSHIPS, HR_LEGISLATION_INSTALLATIONS, and HR_STU_EXCEPTIONS. Together these accesses explain the package's install/upgrade focus: it must verify what is installed (FND_PRODUCT_INSTALLATIONS), establish ownership and legislation applicability, and configure flexfields, menus, and routes before payroll setup records can function.
Usage Notes
PAY_IP_STARTUP_UTIL is referenced by only one other package and is not intended for direct invocation from application forms or standard concurrent program submissions. It is typically exercised indirectly during product installation, patching, or upgrade cycles, or by other Payroll startup packages that call it as part of their own orchestration. Oracle EBS 12.1.1 and 12.2.2 environments treat it as an internal utility whose procedures should be invoked only through the sanctioned installation or upgrade driver, not from custom code. The INSERT_OWNERSHIP, CHECK_TO_INSTALL, MOVE_TO_SHADOW_TABLES, MOVE_TO_MAIN_TABLES, and SETUP procedures in particular carry sequencing dependencies and staging-table state assumptions; invoking them out of order risks inconsistent payroll configuration data.
-
PACKAGE: APPS.PAY_IP_STARTUP_UTIL
12.1.1
owner:APPS, object_type:PACKAGE, object_name:PAY_IP_STARTUP_UTIL, status:VALID,
-
PACKAGE: APPS.PAY_IP_STARTUP_UTIL
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_IP_STARTUP_UTIL, status:VALID,
-
PACKAGE BODY: APPS.PAY_IP_STARTUP_UTIL
12.1.1
owner:APPS, object_type:PACKAGE BODY, object_name:PAY_IP_STARTUP_UTIL, status:VALID,
-
PACKAGE: APPS.PAY_IP_STARTUP_UTIL
12.1.1
-
PACKAGE BODY: APPS.PAY_IP_STARTUP_UTIL
12.2.2
owner:APPS, object_type:PACKAGE BODY, object_name:PAY_IP_STARTUP_UTIL, status:VALID,
-
SYNONYM: APPS.HR_S_TAXABILITY_RULES_DATES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_TAXABILITY_RULES_DATES, status:VALID,
-
SYNONYM: APPS.HR_S_SUB_CLASSN_RULES_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_SUB_CLASSN_RULES_F, status:VALID,
-
SYNONYM: APPS.HR_S_ROUTE_PARAMETERS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_ROUTE_PARAMETERS, status:VALID,
-
SYNONYM: APPS.HR_S_USER_ENTITIES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_USER_ENTITIES, status:VALID,
-
SYNONYM: APPS.HR_S_CONTEXTS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_CONTEXTS, status:VALID,
-
SYNONYM: APPS.PAY_RETRO_COMPONENTS_S
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_RETRO_COMPONENTS_S, status:VALID,
-
SYNONYM: APPS.PAY_REPORT_FORMAT_MAPPINGS_S
12.2.2
owner:APPS, object_type:SYNONYM, object_name:PAY_REPORT_FORMAT_MAPPINGS_S, status:VALID,
-
SYNONYM: APPS.HR_S_REPORT_FORMAT_MAPPINGS_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_REPORT_FORMAT_MAPPINGS_F, status:VALID,
-
SYNONYM: APPS.HR_S_CONTEXTS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_CONTEXTS, status:VALID,
-
SYNONYM: APPS.HR_S_MAGNETIC_BLOCKS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_MAGNETIC_BLOCKS, status:VALID,
-
SYNONYM: APPS.HR_S_ELEMENT_SETS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_ELEMENT_SETS, status:VALID,
-
SYNONYM: APPS.HR_S_ORG_INFO_TYPES_BY_CLASS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_ORG_INFO_TYPES_BY_CLASS, status:VALID,
-
SYNONYM: APPS.HR_S_DATABASE_ITEMS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_DATABASE_ITEMS, status:VALID,
-
SYNONYM: APPS.HR_S_US_GARN_LIMIT_RULES_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_US_GARN_LIMIT_RULES_F, status:VALID,
-
SYNONYM: APPS.HR_S_US_STATE_TAX_INFO_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_US_STATE_TAX_INFO_F, status:VALID,
-
SYNONYM: APPS.HR_S_US_COUNTY_TAX_INFO_F
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_US_COUNTY_TAX_INFO_F, status:VALID,
-
SYNONYM: APPS.HR_S_ELEMENT_TYPE_RULES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_ELEMENT_TYPE_RULES, status:VALID,
-
SYNONYM: APPS.HR_S_BALANCE_CATEGORIES_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_BALANCE_CATEGORIES_F, status:VALID,
-
SYNONYM: APPS.HR_S_VALID_DEPENDENT_TYPES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_VALID_DEPENDENT_TYPES, status:VALID,
-
SYNONYM: APPS.HR_S_STATE_RULES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_STATE_RULES, status:VALID,
-
SYNONYM: APPS.HR_S_PAYMENT_TYPES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_PAYMENT_TYPES, status:VALID,
-
SYNONYM: APPS.HR_S_ELEMENT_CLASSIFICATIONS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_ELEMENT_CLASSIFICATIONS, status:VALID,
-
SYNONYM: APPS.HR_S_DEFINED_BALANCES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_DEFINED_BALANCES, status:VALID,
-
SYNONYM: APPS.HR_S_ROUTE_CONTEXT_USAGES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_ROUTE_CONTEXT_USAGES, status:VALID,
-
SYNONYM: APPS.HR_S_DATABASE_ITEMS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_DATABASE_ITEMS, status:VALID,
-
SYNONYM: APPS.HR_S_ELEMENT_CLASSIFICATIONS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_ELEMENT_CLASSIFICATIONS, status:VALID,
-
SYNONYM: APPS.HR_S_ORG_INFO_TYPES_BY_CLASS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_ORG_INFO_TYPES_BY_CLASS, status:VALID,
-
SYNONYM: APPS.HR_S_ORG_INFORMATION_TYPES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_ORG_INFORMATION_TYPES, status:VALID,
-
SYNONYM: APPS.HR_S_US_GARN_FEE_RULES_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_US_GARN_FEE_RULES_F, status:VALID,
-
SYNONYM: APPS.HR_S_ASSIGNMENT_INFO_TYPES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_ASSIGNMENT_INFO_TYPES, status:VALID,
-
SYNONYM: APPS.HR_S_LEGISLATION_RULES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_LEGISLATION_RULES, status:VALID,
-
SYNONYM: APPS.HR_S_BENEFIT_CLASSIFICATIONS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_BENEFIT_CLASSIFICATIONS, status:VALID,
-
SYNONYM: APPS.HR_S_INPUT_VALUES_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_INPUT_VALUES_F, status:VALID,
-
SYNONYM: APPS.HR_S_BALANCE_DIMENSIONS
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_BALANCE_DIMENSIONS, status:VALID,
-
SYNONYM: APPS.HR_S_USER_TABLES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_USER_TABLES, status:VALID,
-
SYNONYM: APPS.HR_S_BALANCE_CLASSIFICATIONS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_BALANCE_CLASSIFICATIONS, status:VALID,
-
SYNONYM: APPS.HR_S_HISTORY
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_HISTORY, status:VALID,
-
SYNONYM: APPS.HR_S_TAXABILITY_RULES
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_TAXABILITY_RULES, status:VALID,
-
PACKAGE: APPS.PER_AD_ZD_SEED_WRAPPER
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PER_AD_ZD_SEED_WRAPPER, status:VALID,
-
SYNONYM: APPS.HR_S_REPORT_FORMAT_ITEMS_F
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_REPORT_FORMAT_ITEMS_F, status:VALID,
-
SYNONYM: APPS.HR_S_TAXABILITY_RULES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_TAXABILITY_RULES, status:VALID,
-
SYNONYM: APPS.HR_S_LEGISLATION_RULES
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_LEGISLATION_RULES, status:VALID,
-
SYNONYM: APPS.HR_S_MAGNETIC_RECORDS
12.1.1
owner:APPS, object_type:SYNONYM, object_name:HR_S_MAGNETIC_RECORDS, status:VALID,
-
PACKAGE: APPS.PAY_CREATE_ELEMNT_TMPLT_RECORD
12.2.2
owner:APPS, object_type:PACKAGE, object_name:PAY_CREATE_ELEMNT_TMPLT_RECORD, status:VALID,
-
SYNONYM: APPS.HR_S_BALANCE_FEEDS_F
12.2.2
owner:APPS, object_type:SYNONYM, object_name:HR_S_BALANCE_FEEDS_F, status:VALID,