Search Results oki_dbi_scm_rsg_api_pvt




Overview
Explore in AI Chat

Overview

OKI_DBI_SCM_RSG_API_PVT is a private PL/SQL package in the APPS schema that supports the Oracle Enterprise Command Center (ECC) and Diagnostics/BI indexing infrastructure used by Oracle Supply Chain Management in Oracle E-Business Suite 12.1.1 and 12.2.2. Its name derives from the Oracle Knowledge Index (OKI) and Diagnostics for Business Intelligence (DBI) components that manage searchable and summarized indexes over EBS transactional tables. The package provides the low-level API used to create, drop, and manage indexes that back the Oracle Information Discovery and Resource Search Group (RSG) functionality, and it exposes a customization hook (Oki_Custom_Api) that lets customers influence the parameters passed into the indexing process via BIS_BIA_RSG_PARAMETER_TBL — the very object referenced in the user's search. Because the package is classified as PVT (private), it is not intended to be called directly by end users; instead it is invoked by the internal indexing job framework that drives the Oracle EBS search and knowledge-management features.

Key Procedures and Functions

  • Oki_Custom_Api — Documented as accepting a single parameter of type BIS_BIA_RSG_PARAMETER_TBL (an IN OUT NOCOPY parameter). This is the customer-extension entry point: it is designed to be customized so that site-specific logic can adjust the parameter table passed in by the indexing framework.
  • Manage_Oki_Index — Takes a mode, an object name, and a return code (IN OUT NOCOPY). It serves as the orchestrating routine that decides whether to create or drop the OKI index for the named object based on the supplied mode, returning a status code to the caller.
  • Drop_Index — Accepts a table name, an owner, and a return code (IN OUT NOCOPY); it removes the existing index associated with the specified table and owner and reports success or failure through the return code.
  • Create_index — Accepts a table name, an owner, and a return code (IN OUT NOCOPY); it builds the OKI/DBI index for the specified table, again reporting the result via the return code.
  • sleep — Accepts the same BIS_BIA_RSG_PARAMETER_TBL parameter type as Oki_Custom_Api; it provides a controlled wait/pacing mechanism used during index maintenance to avoid contention or to allow dependent resources to settle.

Tables Accessed

The package references the following objects through APPS synonyms: OKI_DBI_INDEXES, which tracks the indexes the package owns and maintains; ALL_INDEXES, the Oracle data dictionary view used to determine whether a given index already exists; DBMS_LOCK, the built-in package supplying the locking primitives that serialize concurrent index operations; DBMS_METADATA, used to extract the DDL needed to create or drop index objects; and V$INSTANCE, consulted to identify the current instance in a RAC environment. The BIS_BIA_RSG_PARAMETER_TBL PL/SQL table type carries the parameter payload consumed by Oki_Custom_Api and sleep. One other package in the EBS codebase references OKI_DBI_SCM_RSG_API_PVT, confirming it is a supporting utility rather than a top-level entry point.

Usage Notes

Because OKI_DBI_SCM_RSG_API_PVT is a private package, it is invoked indirectly by the Oracle indexing and diagnostics framework rather than from Oracle Forms or directly through a concurrent program. In practice it executes as part of scheduled index maintenance jobs that run during periods of low activity, or on demand when the search/knowledge index for a Supply Chain table must be rebuilt. The documented Oki_Custom_Api procedure is the supported customization point: implementers extend the parameter table BIS_BIA_RSG_PARAMETER_TBL to tune indexing behavior without modifying Oracle code. Custom code should not call Manage_Oki_Index, Create_index, or Drop_Index directly, since doing so can bypass the framework's locking and logging. When diagnosing index creation failures, check the return code populated by the procedure and verify the associated metadata and dictionary entries in OKI_DBI_INDEXES and ALL_INDEXES.