Results for “cp_enabled_flag_p”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PAY_PAYRPDTR_XMLP_PKG is the generated PL/SQL package behind the Oracle Payroll XML Publisher concurrent program identified by the source file PAYRPDTRS.pls (version 120.0). The suffix "XMLP_PKG" indicates that the package encapsulates the data model and report-level logic for an XML Publisher (BI Publisher) report template; Oracle's concurrent program architecture invokes such a package to execute the query, derive calculated columns, and return the XML data set to the publishing engine. In the Oracle E-Business Suite 12.1.1 and 12.2.2 environments, this package is owned by the APPS schema and is classified as an OTHER API, meaning it is not a public, supported integration interface but rather an internal artifact generated to support a specific seeded report.

The business purpose of the report it backs is to produce a listing of payroll-related definitions — specifically, records filtered by a status value and an enabled flag, with a count of short names — rendered through an XML template. The package exposes report-level entry points and formula functions that the XML Publisher engine calls during the report lifecycle, allowing the output to carry derived values such as a computed status, a flag indicator, and a record count.

Key Procedures and Functions

Eight procedures and functions make up the documented pl/sql interface. They fall into three functional groups:

• BEFOREREPORT — a lifecycle function returning a boolean, executed before the report data is fetched. It performs any required setup such as context initialization or parameter validation.
• AFTERREPORT — a lifecycle function returning a boolean, executed after report generation to perform teardown or final processing.
• CF_COUNT_SHORT_NAMEFORMULA — a calculated (CF) formula function that receives a count of short names and returns a number. It derives the count value used in the report output.
• CF_STATUSFORMULA — a calculated formula function returning a character value. This is the function most commonly located when searching for "cf_statusformula"; it computes the report's status column, drawing on the package-level variable P_STATUS or CP_STATUS.
• CF_ENABLED_FLAGFORMULA — a calculated formula function returning a character value, deriving the enabled flag shown in the report from P_ENABLED_FLAG or CP_ENABLED_FLAG.
• CP_COUNT_SHORT_NAME_P — an accessor function returning the value of the package variable CP_COUNT_SHORT_NAME.
• CP_STATUS_P — an accessor function returning the varchar2 value of CP_STATUS.
• CP_ENABLED_FLAG_P — an accessor function returning the varchar2 value of CP_ENABLED_FLAG.

Package-level variables P_STATUS, P_ENABLED_FLAG, P_CONC_REQUEST_ID, CP_COUNT_SHORT_NAME, CP_STATUS, and CP_ENABLED_FLAG hold state shared between the lifecycle and formula functions. The "CF_" prefix denotes calculated formula columns bound into the XML template, while "CP_" denotes concurrent program parameters or derived columns exposed to the report.

Tables Accessed

The only documented table reference is FND_SESSIONS, accessed through an APPS synonym. FND_SESSIONS is the standard Oracle Application Object Library table that tracks active user sessions and concurrent request context. The package reads it to obtain the concurrent request identifier (reflected in the P_CONC_REQUEST_ID variable) and session-level information needed to resolve the report's parameters and run context. No payroll base tables are documented as directly referenced in this metadata; the payroll data itself is supplied through the report's query definition rather than enumerated here.

Usage Notes

PAY_PAYRPDTR_XMLP_PKG is invoked automatically by the Oracle concurrent manager when the associated XML Publisher payroll report program is submitted; it is not designed to be called directly from a form, another package, or custom code. ETRM records show zero packages referencing it, confirming its role as a leaf-level report implementation artifact.

Because the package is classified as OTHER and its header indicates a non-shipped ("noship") source at version 120.0, it should be treated as read-only and internal. Customizations should be applied by copying the concurrent program and its XML template rather than by modifying APPS-owned package source. Any diagnostic investigation of "cf_statusformula" should recognise it as a generated template formula function rather than an exposed business API, and changes to its behaviour must be made through the report template or a cloned definition.