Search Results ff_routes_s




Overview
Explore in AI Chat

Overview

APPS.PAY_MX_ARCHIVE_DBI_PKG is an Oracle E-Business Suite package body owned by the APPS schema and classified as an "OTHER" API in the Oracle Payroll product family for the Mexican (MX) localization. Its name and dependency profile identify it as a localization utility responsible for archiving Mexican payroll data elements — specifically the Database Items (DBI) and the Flexfield Routes that underpin them. In Oracle Payroll, database items define the individual balance, element, and formula inputs that payroll processes read and write, while routes map those database items to the payroll run contexts in which they are valid. The package extracts the current definitional metadata for these objects from the Fast Formula (FF) dictionary tables and preserves it in an archive structure so that the configuration in force at a given point in time can be retained for audit, statutory reporting, and historical reconciliation.

Key Procedures and Functions

The documented package exposes two public procedures:

  • CREATE_ARCHIVE_ROUTES — Captures and archives the route definitions associated with the Mexican payroll database items. It operates against the FF_ROUTES and FF_ROUTES_S tables together with the supporting route metadata tables, preserving the context, parameter, and parameter-value relationships that define how each route is resolved at runtime.
  • CREATE_ARCHIVE_DBI — Captures and archives the database item definitions themselves. It works with the FF_USER_ENTITIES and FF_USER_ENTITIES_S tables along with FF_DATABASE_ITEMS, recording the database item metadata required to reconstruct or audit the DBI configuration.

The two procedures are complementary: CREATE_ARCHIVE_DBI preserves the database items, and CREATE_ARCHIVE_ROUTES preserves the routing that binds those database items to contexts and parameters. No parameter lists are documented in the available metadata.

Tables Accessed

All tables are accessed through APPS synonyms and fall into two logical groups:

  • Route definition tables: FF_ROUTES and FF_ROUTES_S (the route header and its translation/seed table), FF_ROUTE_CONTEXT_USAGES (context assignments for each route), and FF_ROUTE_PARAMETERS, FF_ROUTE_PARAMETERS_S, and FF_ROUTE_PARAMETER_VALUES (route parameters and their permitted values).
  • Database item tables: FF_USER_ENTITIES and FF_USER_ENTITIES_S (the user-entity definitions that back database items), FF_DATABASE_ITEMS (the database item definitions), and FF_CONTEXTS (the context definitions referenced by routes and entities).
  • Utility: DUAL and SYS.STANDARD are referenced for standard PL/SQL and single-row query operations.

These tables are read to produce a point-in-time snapshot of the Mexican payroll database item and route configuration.

Usage Notes

Because the package is classified as an "OTHER" API, it is not intended for direct interactive use but is invoked programmatically. Typical invocation paths include payroll localization concurrent programs, archive and purge routines for Mexican statutory reporting, and upgrade or migration scripts that must retain the pre-change Fast Formula configuration before applying patches. Customers and partners extending the Mexican localization may call the procedures from custom concurrent programs or PL/SQL wrappers when a historical snapshot of database item and route metadata is required. The metadata notes that the package itself is not referenced by any other database object, indicating it functions as a top-level utility whose procedures are called externally rather than through an internal dependency chain; documentation for the related package that references it should be consulted for the surrounding archive workflow.