Search Results okc_template_keyword_pvt




Overview

OKC_TEMPLATE_KEYWORD_PVT is a private (PVT) PL/SQL package in the APPS schema that supports the Oracle Contracts (OKC) module's template keyword infrastructure. Contracts in Oracle E-Business Suite frequently rely on reusable templates whose content is assembled from keyword substitution — placeholders that are resolved at runtime against contract, party, or system data. This package provides the administrative maintenance routines used to keep the metadata that drives that keyword resolution synchronized and performing efficiently.

Because the package is classified as PVT, it is not part of Oracle's published, supported API surface. It exists to serve internal contract-template processing rather than to be called directly by customer extensions. The package is declared AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking schema rather than the definer, which is consistent with an internal utility that operates against session-level context and dictionary metadata.

The $Header comment records a last revision of 120.1 dated 2005/09/14, indicating the package is long-standing and largely stable across the 12.1.1 and 12.2.2 releases. The identifier is shared between the two releases; the file revision line does not distinguish them, so behavior is expected to be materially the same in both.

Key Procedures and Functions

The package exposes four public program units, all procedures:

  • SYNC — Synchronizes the keyword definition metadata used by contract templates. It reconciles stored keyword information so that template processing operates against current definitions.
  • OPTIMIZE — Performs optimization of the underlying keyword metadata, restructuring or consolidating it to improve resolution performance at runtime.
  • SYNC_CTX — The concurrent-program wrapper for SYNC. It accepts the standard Oracle concurrent manager argument signature: errbuf OUT NOCOPY VARCHAR2 and retcode OUT NOCOPY VARCHAR2. This signature confirms SYNC_CTX is intended to be registered as a concurrent program, with the two outgoing parameters reporting success or failure back to the concurrent manager.
  • OPTIMIZE_CTX — The concurrent-program wrapper for OPTIMIZE, exposing the same errbuf/retcode interface for scheduled or on-demand execution.

The _CTX suffix in Oracle EBS conventionally denotes the concurrent-program entry point corresponding to a core routine; the documentation confirms this by pairing each wrapper with its underlying procedure. No parameter lists beyond the concurrent wrappers are documented, and none should be assumed for SYNC or OPTIMIZE.

Tables Accessed

The only documented table referenced through APPS synonyms is AD_CTX_DDL, an Applications DBA dictionary table that holds DDL definitions associated with Oracle context (the CTX application context). Access to AD_CTX_DDL is consistent with the package's role in maintaining context-linked keyword metadata, and it aligns with the naming of the SYNC_CTX and OPTIMIZE_CTX wrappers. No other base tables are documented, so any additional dependencies inferred from general product knowledge should be treated as unverified.

Usage Notes

The package is not intended for direct invocation from client code. Its principal intended entry points are SYNC_CTX and OPTIMIZE_CTX, which are designed to be registered as concurrent programs and run through the standard concurrent manager so that the errbuf and retcode parameters are populated and status is tracked in the request log. Typical invocation is during implementation, after applying patches that affect contract templates, or as periodically scheduled maintenance to keep keyword metadata synchronized and optimized.

Custom code should not call SYNC or OPTIMIZE directly; because the package is PVT and has no documented parameterized interface, its internals are subject to change in Oracle patches. The metadata records zero dependent packages, indicating the routines are not widely called from within the application's PL/SQL layer, which further supports the conclusion that they are administrative in nature. The user search term sync_ctx corresponds directly to the documented concurrent wrapper SYNC_CTX, the entry point most likely to appear in a scheduled concurrent program definition.