Results for “okc_tree_index”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

OKC_TREE_INDEX is an Oracle E-Business Suite package body owned by the APPS schema. Within the ETRM 12.1.1 and 12.2.2 environments it is classified under the generic API category "OTHER," indicating that it is an internal utility package rather than a published business API. Its documented dependency list is deliberately small: the package references only the APPS schema itself, the FND_PROFILE package, and the SYS STANDARD package. No application tables or views are listed among its dependencies, and the status of the object is VALID in the documented releases.

The package appears to support the tree-navigation and hierarchical display machinery used by Oracle Contracts (OKC) functionality. The naming convention of its documented subprograms — label retrieval, padding of identifiers and labels, configurable separators and pad characters, and a root identifier — points to a role as a display and indexing helper for tree structures rather than as a transaction-processing routine. Notably, the ETRM metadata states that the package is not referenced by any database object, which confirms that it is invoked from client-side or mid-tier code rather than from other stored PL/SQL units.

Key Procedures and Functions

The documented package exposes nine subprograms. Their names indicate the following purposes:

• GET_ID — returns an identifier value, presumably the tree or node identifier formatted for display.
• GET_ID_LPADED — returns an identifier padded on the left, producing fixed-width identifiers suitable for alignment in list or tree presentations.
• GET_LABEL — returns the display label associated with a tree entry.
• GET_LABEL_RPADED — returns a label padded on the right, the counterpart to the left-padded identifier routine.
• SET_SEPARATOR — establishes the separator character or string used when concatenating identifier and label components.
• SET_PAD_CHAR — establishes the pad character applied by the left- and right-padding routines.
• SET_ROOT_ID — records the identifier of the root node for the tree being processed.
• GET_ROOT_ID — retrieves the previously established root identifier.
• NESTED_ROWNUM — computes or returns a row number within a nested hierarchy, supporting ordered traversal of tree levels.

The presence of both setter and getter pairs for separator, pad character, and root identifier indicates a session-oriented state model: callers configure the package once, then repeatedly request formatted identifiers and labels. The metadata does not document parameter lists, and none should be assumed.

Tables Accessed

The documented dependency information records no application tables or APPS synonyms referenced by OKC_TREE_INDEX. The only declared dependencies are the APPS schema itself, FND_PROFILE, and SYS.STANDARD. The involvement of FND_PROFILE suggests that behavioural defaults — such as padding width, separator character, or label formatting — may be resolved from profile option values at runtime rather than from database tables. In the absence of documented table access, the package should be regarded as a formatting and index-computation utility operating on values supplied by its caller.

Usage Notes

By design the package is self-contained and is not referenced by any database object in the documented releases. It is therefore not invoked from triggers, views, or other stored packages, but from client-side code — most plausibly Oracle Forms used in the Contracts module — or from custom PL/SQL that needs consistent tree-label formatting. The documented metadata records that OKC_TREE_INDEX is referenced by three other packages, indicating reuse by sibling OKC utilities that depend on its formatting conventions. Because the object is internal and undocumented as a public API, customisations should favor invoking the documented subprograms only where a business requirement genuinely demands identical label or identifier formatting, and should avoid modifying the package body, since any such change would diverge from the Oracle-supplied VALID state and complicate future patching in both 12.1.1 and 12.2.2.