Search Results undo_retirement

Overview

APPS.FA_GROUP_RETIREMENT_PVT is a private (PVT) PL/SQL package body within the Oracle E-Business Suite Fixed Assets (FA) module. It belongs to the family of FA private API packages that implement the low-level business logic used by the public Fixed Assets APIs and group asset transaction flows. The package's central purpose is to support group and mass retirement processing, including the reversal of retirements and the reinstatement of retired assets. In the context of Oracle EBS 12.1.1 and 12.2.2, this package is a helper (private) implementation layer, meaning it is not intended to be called directly by external consumers; instead it is invoked by the higher-level FA APIs or internal FA transaction programs that manage asset lifecycle changes for group assets.

The naming convention ("_PVT") and the object's placement under the APPS schema confirm it is an internal utility that encapsulates the retirement, undo-retirement, reinstatement, and undo-reinstatement operations for the Fixed Assets group retirement process. The package body documented here is version 120.5, last modified in 2009, which is consistent with the long-lived, stable nature of core FA accounting logic across the 12.1.x and 12.2.x releases.

Key Procedures and Functions

The package body exposes four documented program units, all returning BOOLEAN and each accepting the standard FA API parameter conventions (transaction record, asset records, period record, set of books context, MRC set-of-books type code, calling function identifier, and log level record). None of the parameter lists are reproduced here; only their documented purposes are described.

• DO_RETIREMENT — Executes the retirement of a group asset. It processes the transaction and asset records supplied by the caller to generate the retirement accounting and update asset financial information in the appropriate depreciation book(s).
• UNDO_RETIREMENT — Reverses a previously posted retirement. It operates against a transaction header identifier and set of books, effectively backing out the retirement transaction so the asset returns to its pre-retirement state.
• DO_REINSTATEMENT — Performs the reinstatement of a retired asset, restoring it to active status. This is the function most closely associated with the user's search term "do_reinstatement". It accepts transaction, asset header, asset financial, description, period, and inventory table records to rebuild the asset's active financial position.
• UNDO_REINSTATEMENT — Reverses a reinstatement operation, identified by transaction header and set of books, returning the asset to its prior retired state.

Tables Accessed

The ETRM metadata for this object lists no directly referenced tables via APPS synonyms. The package operates primarily on the strongly typed PL/SQL record structures defined in FA_API_TYPES (such as asset_hdr_rec_type, asset_fin_rec_type, and asset_retire_rec_type), which are passed in and out by the calling public APIs. Any underlying base-table access (for example FA_RETIREMENTS, FA_TRANSACTION_HEADERS, FA_BOOKS, and FA_ADDITIONS) is therefore performed indirectly through the API layer and the record structures rather than through explicit SQL statements in this private package body.

Usage Notes

Because FA_GROUP_RETIREMENT_PVT is a private API, it is not intended for direct invocation from forms, concurrent programs, or custom code. The metadata records that it is referenced by zero other packages, reinforcing its role as a leaf-level implementation unit. In practice, the retirement and reinstatement functions are invoked by the public Fixed Assets retirement APIs (for example the FA_RETIREMENT_PUB and related public packages) and by internal group asset processes. Customizations should always call the public API layer rather than this program unit, since the private package signature and behavior are subject to change without notice across patch levels of 12.1.1 and 12.2.2.