Search Results get_tree_id

Overview

OKC_DBTREE_PVT is a private PL/SQL package in the APPS schema of Oracle E-Business Suite that supports the construction and traversal of hierarchical tree structures used by Oracle Contracts (OKC) functionality. The package is classified as PVT (private) within the ETRM metadata, indicating it is intended for internal use by other OKC modules rather than as a public API surface. Its role centers on managing a database-driven tree model, where node relationships, depth, labels, icons, and parent-child linkages are assembled in memory and returned to the calling layer for display or processing.

The package defines several PL/SQL record and collection types, including TreeDataRec, ResultRec, ErrorRec, IndexControlRec, and associated table types such as TreeDataTableType and ErrorStack. These structures store node metadata — initial state, depth level, label, icon name, node type, parent node ID, and child count — along with an indexed control structure that governs paging or batched retrieval of tree entries. Package-level globals such as PackageStateInd, ActiveTreeID, and the icon constant affldhdr maintain runtime state across calls.

Key Procedures and Functions

The documented procedures and functions forming this package's API include:

• PUSH_ERROR — Adds an error record onto the package-level error stack, capturing package name, program name, and related diagnostic context.
• POP_ERROR — Removes and returns the most recently pushed error record from the stack. The user search term "pop_error" corresponds directly to this routine, which is the standard mechanism for unwinding diagnostics after a failure.
• CLEAR_STACK — Empties the accumulated error stack, typically invoked before initiating a new tree operation.
• GET_DATA_PARAMETER — Retrieves a parameter value used to drive tree data assembly.
• GET_TREE_ID — Resolves and returns the identifier of the active tree being processed.
• CLEARNODECACHE — Flushes cached node data so subsequent traversals reflect current database state.
• PROCESSROOTNODE — Initializes processing of the root node of a tree, establishing the starting point for traversal.
• RETURNCHILDRENNODES — Returns the child nodes for a given parent, enabling hierarchical navigation.
• LOADNODECHILDREN — Loads child node records into the internal data table for a specified node.
• INITIALIZE_PACKAGE — Resets package state and global variables in preparation for a new tree session.

Tables Accessed

The package references several tables through APPS synonyms. OKC_K_GROUPS_B and OKC_K_GROUPS_TL hold contract group base and translation data, supplying node labels and descriptive text. OKC_K_GRPINGS stores group-to-contract assignments that underpin the hierarchy relationships represented in the tree. PLITBLM is an Oracle Applications internal table frequently used for temporary or indexed storage during tree assembly. Collectively, these tables provide the parent-child relationships and descriptive attributes surfaced as tree nodes.

Usage Notes

Because OKC_DBTREE_PVT is a private package, it is invoked indirectly — generally from Oracle Forms interface code or higher-level OKC public APIs that render or manipulate contract-related hierarchies. It is not intended as a documented integration point for customer extensions. Custom code should avoid direct dependency on its routines, as private signatures may change without notice. In EBS 12.1.1 and 12.2.2, the package operates entirely within the APPS schema, and error diagnostics are surfaced through its internal stack (PUSH_ERROR / POP_ERROR) rather than being raised directly to callers as standard named exceptions.