Search Results lookup_jurisdiction_code

Overview

PAY_MAG_UTILS is a PL/SQL utility package owned by the APPS schema in Oracle E-Business Suite, classified in the ETRM repository as an OTHER API (not an officially supported public interface). Its documented purpose is to supply procedures and functions used by magnetic reports, principally the US 1099-R and related year-end statutory reporting programs that write output to magnetic media. The package originated in release 40.0 (October 1996) and was progressively extended through version 115.5, with the header comment recording increments for lookup insertion, debugging output, earned-date derivation, organization info validation, user-defined function (UDF) management, parameter retrieval, and DBDRV driver commands. In Oracle EBS 12.1.1 and 12.2.2 the package remains part of the Payroll legislated-reporting infrastructure, providing shared lookup, validation, action-creation, and formatting logic that individual magnetic report concurrent programs call rather than reimplement.

Key Procedures and Functions

• LOOKUP_FORMULA — resolves a formula by session date, business group, legislation and formula name, returning a numeric identifier; used when a magnetic report must locate the correct payroll calculation for a jurisdiction.
• LOOKUP_FORMAT — returns the report format applicable to a period end, report type and state, driving state-specific layout selection.
• BAL_DB_ITEM — retrieves the value of a database item by name, supporting balance extraction within report logic.
• LOOKUP_JURISDICTION_CODE — resolves the jurisdiction code for a reporting context.
• CHECK_REPORT_UNIQUE — validates that a report record has not already been produced, preventing duplicate filings.
• CREATE_PAYROLL_ACTION / CREATE_ASSIGNMENT_ACTION / ERROR_PAYROLL_ACTION / UPDATE_ACTION_STATUS — create, mark as error, and update the status of payroll and assignment actions associated with magnetic reporting runs.
• GET_DATES — derives the reporting date ranges required by the magnetic process.
• MAIN — the package driver entry point coordinating the reporting sequence.
• INSERT_LOOKUP — inserts lookup values, originally added to support 1099-R debugging.
• WRITE — a simple debugging output routine.
• ORG_INFO_EXISTS — tests whether a given organization information type exists.
• DATE_EARNED — computes the date earned for reporting purposes.
• UDF_EXISTS — the function referenced by the search term; it tests for the existence of a user-defined function definition, allowing report logic to branch conditionally when a UDF is or is not defined for the business group.
• DELETE_UDF — removes a user-defined function definition, pairing with UDF_EXISTS for cleanup and regeneration cycles.
• GET_PARAMETER — returns a concurrent program or report parameter value by name.

Tables Accessed

The package reads and writes through APPS synonyms. Formula and function metadata come from FF_FORMULAS_F, FF_FUNCTIONS, FF_FUNCTION_PARAMETERS, FF_FUNCTION_CONTEXT_USAGES, FF_DATABASE_ITEMS, FF_ARCHIVE_ITEMS and FF_USER_ENTITIES — the last supporting the UDF existence and deletion logic. Organization validation uses HR_ORG_INFORMATION_TYPES. Magnetic output structures are held in PAY_MAGNETIC_BLOCKS and PAY_MAGNETIC_RECORDS. Payroll action state is read and written in PAY_PAYROLL_ACTIONS and PAY_PAYROLL_ACTIONS_S, with assignment-level actions in PAY_ASSIGNMENT_ACTIONS. Formatting and state rules reside in PAY_REPORT_FORMAT_MAPPINGS_F and PAY_STATE_RULES.

Usage Notes

PAY_MAG_UTILS is invoked indirectly by magnetic media report concurrent programs and by the forms that submit them; it is not intended for direct customer invocation. It is referenced by nine other packages, confirming its role as a shared dependency. Because the ETRM classification is OTHER, the package carries no supported-API guarantee, and customizations that call UDF_EXISTS, DELETE_UDF or the action-creation routines directly risk breakage on patching. Oracle EBS 12.1.1 and 12.2.2 deployments should treat the package as internal reporting infrastructure and limit interaction to the standard magnetic report submission flows.