Search Results build_xml

Overview

OTFR2483 is an Oracle E-Business Oracle Training and Events (OTRM/OTA) module package owned by APPS and classified as an OTHER API in ETRM 12.2.2. Its header ($Header: otfr2483.pkh 120.1 2005/11/03) shows the package dates from the 11.5.x era and has been carried forward unchanged into 12.1.1 and 12.2.2. The package belongs to the OTFR (Oracle Time and Labor / Oracle Training and Revenue reporting) family of generated legislative reporting packages, and its core responsibility is the production of the statutory 2483 annual training/accrual report. It extrudes training and accrual plan data for a given company, business group and calendar year, and emits that data as an XML document for downstream rendering.

The central artefact is the build_XML procedure, which is the entry point most commonly sought by integrators and reported by users searching for "build_xml". It is complemented by a tax/accrual calculation helper (GET_DIF_BALANCE) and a concurrent-program wrapper (RUN_2483) that drives the whole process under the standard Oracle request framework.

Key Procedures and Functions

• GET_DIF_BALANCE — A function returning a NUMBER. It computes the differential accrual balance for a specific assignment, accrual plan, payroll and business group as at a supplied end date. It is used by the reporting logic to establish the opening/closing balances required by the 2483 form.
• build_XML — A procedure with an OUT NOCOPY CLOB parameter (p_xml) that returns the assembled XML document. Inputs identify the company, tax year, optional date-to cutoff, detail section and an optional report template name. This is the procedure that constructs the complete XML payload consumed by the report template.
• run_2483 — The concurrent-program entry point, using the standard (errbuf OUT NOCOPY VARCHAR2, retcode OUT NOCOPY NUMBER) signature. Parameters control the business group, template, company, calendar, time period, currency, process name and a debug flag. It orchestrates retrieval and hands control to the XML builder.

Tables Accessed

The package reads from a broad set of Core HR, Payroll and OTA tables, referenced through APPS synonyms:

• PER_ALL_PEOPLE_F and PER_TIME_PERIODS — employee assignment data and payroll period definitions.
• HR_ALL_ORGANIZATION_UNITS, HR_ALL_ORGANIZATION_UNITS_TL, HR_ORGANIZATION_INFORMATION, HR_LOCATIONS_ALL — organization, translation, classification and location details that identify the reporting company.
• OTA_TRAINING_PLANS, OTA_EVENTS_TL, OTA_TP_MEASUREMENT_TYPES — training plans, event descriptions and measurement types that form the substantive content of the report.
• PAY_ELEMENT_CLASSIFICATIONS — payroll element classification used to distinguish accrual balances.
• FND_LOOKUP_VALUES — lookup translations for codes appearing in the output.
• DBMS_LOB — the built-in package used to assemble and write the large CLOB XML result.

Usage Notes

OTFR2483 is not referenced by any other package in the ETRM metadata, which confirms it is a leaf-level reporting utility rather than a shared API. In practice it is invoked in three ways: (1) as a concurrent program through the RUN_2483 wrapper, scheduled by the HR/Payroll administrator for annual statutory filing; (2) directly by report templates (for example Oracle XML Publisher / BI Publisher templates named via P_TEMPLATE_NAME) that call build_XML to obtain the raw XML for formatting; and (3) from custom PL/SQL where a caller needs the assembled CLOB but does not require the concurrent manager. Because build_XML exposes the CLOB through an OUT NOCOPY parameter, callers must supply an initialised LOB locator and are responsible for freeing it. All procedures run AUTHID CURRENT_USER, so privileges are resolved against the invoking schema — under a typical APPS sign-on this is not restrictive, but in custom integration schemas the necessary EXECUTE grants and synonym access must be in place. The presence of a debug flag on run_2483 indicates that diagnostic tracing of the extraction is supported and should be enabled during troubleshooting rather than in production runs.