Search Results fa_null_fa_units

Overview

APPS.FA_CUSTOM_RET_VAL_PKG is a customizable validation package within the Oracle E-Business Suite Fixed Assets (OFA) module. Its filename, facrvcb.pls (version 120.3, dated 2005), indicates it is a customer-facing extension point ("RET" for retirement, "VAL" for validation, "CB" for the compiled body). The package exists so that implementers can inject site-specific validation logic into the mass retirement workflow without modifying Oracle's seeded code.

The package centres on a single public function, VALIDATE_CRITERIA, which accepts a mass retirement record and returns a Boolean indicating whether the supplied criteria pass validation. When validation fails, the function returns FALSE and populates an output error message so the calling form or concurrent program can surface a descriptive error to the user. It also accepts a logging level record, consistent with the FA_API_TYPES logging convention used across Fixed Assets APIs.

The default body delivered by Oracle is deliberately inert: every validation rule is commented out, and the function unconditionally returns TRUE. This design confirms the object is a template — the shipped logic performs no meaningful checks until a customer activates and customises the stub blocks.

Key Procedures and Functions

• VALIDATE_CRITERIA — The sole documented function. It takes a mass retirement record of type FA_CUSTOM_RET_VAL_PKG.mass_ret_rec_type, an OUT error message parameter, and an optional log level record. It returns a Boolean validity flag. Within the body, four user-defined exceptions — Category_required, Location_required, Units_required, and Group_asset_required — are declared to support conditional validation. In the baseline version the corresponding IF blocks are commented out, so the function always returns TRUE. The exception handlers demonstrate the intended error-raising pattern: they call FND_MESSAGE.SET_NAME to attach an application message (for example 'FA_NULL_CATEGORY', 'FA_NULL_LOCATION', or 'FA_NULL_FA_UNITS'), optionally bind a token such as 'LOCATION' or 'ASSET_UNITS', then assign FND_MESSAGE.GET to the output parameter and return FALSE.

No other procedures or functions are exposed by this package; the local record variable l_mass_ret_rec exists only to hold a working copy of the incoming record and is not publicly callable.

Tables Accessed

The package references the FA_MASS_RETIREMENTS table through the APPS synonym. The table is not directly queried in the supplied excerpt; instead it is referenced indirectly via the record structure, whose fields mirror FA_MASS_RETIREMENTS columns (for example mass_retirement_id, category_id, location_id, units, group_asset_id, and project_id). The commented validation examples check these columns for null values, and the message token binding explicitly names columns such as FA_MASS_RETIREMENTS.LOCATION_ID and FA_MASS_RETIREMENTS.ASSET_UNITS. This confirms the package is designed to validate the retirement header criteria captured in that table.

Usage Notes

VALIDATE_CRITERIA is invoked from the Create Mass Retirements form and from the Process Pending Retirements Criteria step — precisely the two call sites named in the code comments. During either flow, the form or concurrent program assembles an FA_MASS_RETIREMENTS record, passes it to the function, and branches on the returned Boolean.

Because the ETRM classifies this object as OTHER and it is referenced by one other package, it should be treated as a supported extension point rather than a general-purpose API. Implementers customise it by uncommenting and adapting the sample exception blocks, optionally adding tokens to FND_MESSAGE calls so that standard OFA messages display properly. Any change must preserve the function signature and return contract, since the calling form and the referencing package depend on the Boolean result and the populated error message. Customisations must be reapplied after applied patches, as the package body resides in the APPS schema and is a template delivered by Oracle.