Search Results freeze_worksheet

Overview

ZPB_DC_UTIL is a utility PL/SQL package body owned by the APPS schema in Oracle E-Business Suite. It belongs to the ZPB (Demand Planning / Demand Collaboration) module and is classified by ETRM as a UTIL API. Its business purpose is to manage the worksheet lifecycle for demand collaboration objects by controlling the freeze state of individual worksheets stored in the ZPB_DC_OBJECTS table. Freezing a worksheet locks it against further modification, preserving the current data set for downstream planning, comparison, or approval activities. Unfreezing restores the worksheet to its prior editable state, and the refresh procedure reloads or recalculates worksheet content.

The package body header identifies the source file as ZPBDCUTB.pls, version 120.1, last shipped on 2007/12/04. This places the implementation within the 12.1.1 family of EBS releases, and the same object is documented for 12.2.2. The package exposes a deliberately narrow, three-procedure interface, consistent with a lightweight utility whose responsibility is limited to state transitions on the worksheet record rather than full demand planning logic.

Key Procedures and Functions

• FREEZE_WORKSHEET — Freezes the worksheet identified by its object_id in ZPB_DC_OBJECTS. The documented source shows that the procedure first reads the current status of the target worksheet, then updates the record to set status to LOCKED, stores the prior status value in the prior_lock_status column, sets freeze_flag to 'Y', and maintains the standard WHO audit columns (last_updated_by, last_update_date, last_update_login) from fnd_global. The procedure returns a standard FND_API return status and message, issuing success when a row is updated and an error when the object_id is not found. A NO_DATA_FOUND handler and a WHEN OTHERS handler map exceptions to the appropriate FND_API status codes. The procedure commits its work, and the FND context must be initialized before invocation.
• UNFREEZE_WORKSHEET — Reverses the freeze operation for a worksheet, returning the record to its prior lock status as captured by FREEZE_WORKSHEET. It is the counterpart API used when a locked worksheet must be reopened for editing or regeneration.
• REFRESH_WORKSHEET — Reloads or recalculates the contents of a worksheet, allowing planning data to be brought current without altering the lock semantics established by the freeze and unfreeze procedures.

No functions are documented for this package; all three members are procedures. Parameter lists are intentionally not restated here, and consumers should reference the package specification for exact signatures.

Tables Accessed

• ZPB_DC_OBJECTS — The single documented table referenced by the package, accessed through an APPS synonym. It stores demand collaboration worksheet objects keyed by object_id and is read to obtain the current status and updated to set status, prior_lock_status, and freeze_flag. The table also carries the standard WHO audit columns populated by the package. ZPB_DC_OBJECTS is the same object referenced in the user search term "zpb_dc_objects."

Usage Notes

ZPB_DC_UTIL is a server-side utility invoked from the demand collaboration forms, from concurrent programs that batch-process worksheets, or from custom PL/SQL code that needs to lock or release a worksheet. Because the procedures rely on fnd_global for audit who-columns, callers must initialize the FND context (for example, through FND_GLOBAL.APPS_INITIALIZE or by running within an established EBS session) before calling any procedure. FREEZE_WORKSHEET performs an explicit COMMIT, so it should not be embedded inside a larger transaction where commit control is expected by the caller.

ETRM records show the package is referenced by zero other packages, confirming that it sits at the leaf of the dependency tree and exposes its procedures directly to forms and custom callers rather than serving as an internal building block for other APIs. Because it writes the prior lock status, callers that unfreeze worksheets should be aware that the original state is restored from the value persisted at freeze time.