Search Results get_data_parameter

Overview

OKC_DBTREE_PVT is a private PL/SQL package body in the Oracle E-Business Suite Contracts (OKC) module. It implements the internal engine that builds, caches, and traverses hierarchical tree structures used by the Contract Terms and Conditions authoring framework, commonly referred to as the DBT (Database Tree) facility. The package operates on an in-memory control table—referred to internally as IControlTable—that tracks each node of a tree by tree identifier and node number, storing start and stop indices that describe the position of a node's children within the loaded data set. The documented private procedure SaveNodeIndex illustrates this design: it locates an existing node in the control table and updates its start_ind, end_ind, and num_entries attributes, or appends a new entry when no match is found. The user search term id_out corresponds to the package's convention of returning identifier information to calling code through output parameters; tree and node identifiers are passed out of internal routines so that parent processes (particularly form-based authoring screens) can persist or navigate the hierarchy. The header comment (OKCTREEB.pls 120.1) indicates the file has been stable since the 11i/12.0 era and remains shipped in 12.1.1 and 12.2.2. The package is classified as PVT, meaning it is not a public API and should be invoked only by other OKC packages or via supported form logic rather than directly by customer code.

Key Procedures and Functions

• INITIALIZE_PACKAGE — Establishes package-level state, resetting global variables and the node cache before a tree operation begins.
• GET_TREE_ID — Resolves and returns the identifier of the tree being processed, supplying the value that downstream routines use to key control table entries and to populate output parameters of the id_out form.
• GET_DATA_PARAMETER — Retrieves configuration or runtime parameter values that govern how tree data is fetched and interpreted.
• LOADNODECHILDREN — Populates the in-memory control table with the child nodes of a given parent, computing start and end indices analogous to SaveNodeIndex.
• RETURNCHILDRENNODES — Returns the set of child nodes for a supplied parent node to the calling program.
• PROCESSROOTNODE — Drives processing of the tree's root node, typically initiating a recursive walk of the hierarchy.
• CLEARNODECACHE — Purges cached node entries, freeing memory and preventing stale hierarchy data between invocations.
• PUSH_ERROR / POP_ERROR / CLEAR_STACK — Implement a private error stack. PUSH_ERROR records an error condition, POP_ERROR retrieves the most recent error, and CLEAR_STACK resets the stack after handling completes.

Tables Accessed

The package references the following objects through APPS synonyms:

• OKC_K_GROUPS_B — Base table holding contract group (tree node) definitions; supplies the identity and structure of nodes.
• OKC_K_GROUPS_TL — Translation table providing language-specific node descriptions.
• OKC_K_GRPINGS — Maps groups to their parents and order, providing the parent-child relationships that the tree traversal depends on.
• PLITBLM — A standard EBS PL/SQL index-by table type used for bulk operations and parameter passing.

Usage Notes

As a PVT package, OKC_DBTREE_PVT is invoked indirectly. It is called from Contracts authoring forms—particularly the Terms and Conditions and contract groups setup screens—which display hierarchical group structures. It is not exposed as a concurrent program entry point and is not referenced by other public packages (referenced by 0 packages per the ETRM metadata). Because behavior may change across patch levels, custom code should not call these routines directly; the supported route is to use the OKC public APIs and form-driven maintenance of contract groups.