Results for “okl_gts_pvt”

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

Overview

OKL_GTS_PVT is a private PL/SQL package in the APPS schema within Oracle E-Business Suite, belonging to the Oracle Lease and Finance Management (OKL) module family. The "PVT" suffix indicates that this is an internal, private API layer that supports a corresponding public package, OKL_GTS_PUB. In ETRM terminology, the package name fragment "GTS" refers to Stream Generation Template Sets, and the package functions as the low-level implementation layer that maintains the OKL_ST_GEN_TMPT_SETS entity.

Stream generation templates define the rules and parameters by which the Lease Management engine creates billing streams during contract origination, renewal, or restructuring. The package encapsulates the DML and validation logic required to define, copy, update, and delete those template sets, and it exposes that logic to public APIs and concurrent processes rather than to end users directly. Because it is an API-classified private package, external code should not call it directly; consumers are expected to use the public wrapper OKL_GTS_PUB or the higher-level stream generation APIs.

Key Procedures and Functions

The documented API surface includes nine procedures and functions, with six named in the metadata:

• QC — A quality-control routine used internally to validate that the state of a template set row and its attributes satisfy the package's invariants before persistence.
• CHANGE_VERSION — Handles versioning of template set records, allowing an existing definition to be revised without destroying the prior version. This supports auditability and reproducible stream generation on contracts that reference an earlier template version.
• API_COPY — Implements the copy logic for a template set, creating a new record derived from an existing one. This underpins "clone" or "copy template" actions in the Stream Generation Template Sets UI.
• INSERT_ROW — Performs the DML insert into OKL_ST_GEN_TMPT_SETS, applying validation and defaulting prior to the write.
• UPDATE_ROW — Performs the DML update of an existing template set row, guarding against invalid state transitions.
• DELETE_ROW — Performs the DML delete of a template set row, enforcing referential or logical delete rules as required.

Tables Accessed

The package's SQL references are documented against two tables accessed through APPS synonyms:

• OKL_ST_GEN_TMPT_SETS — The primary schema object. It stores the definition of stream generation template sets. INSERT_ROW, UPDATE_ROW, DELETE_ROW, and API_COPY operate directly on this table, while QC and CHANGE_VERSION read and re-write version-related columns.
• PLITBLM — The standard Oracle Application Object Library table used for storing and retrieving translated database messages. The package uses it to obtain user-facing error text for messages raised during validation, keeping error strings NLS-compliant.

In addition, OKL_GTS_PVT depends on FND_API for standard API return codes and message handling, OKL_API for shared Lease Management helper logic, and SYS.STANDARD. It is referenced by the public and workflow packages OKL_GTS_PUB, OKL_GTS_PVT_W, and by the stream migration and template generation layer comprising OKL_STREAM_MIGRATION_PVT, OKL_STRM_GEN_TEMPLATE_PUB, and OKL_STRM_GEN_TEMPLATE_PVT.

Usage Notes

OKL_GTS_PVT is not exposed on any form or concurrent program directly. It is invoked in three primary ways. First, through the public API OKL_GTS_PUB, which wraps these routines for supported integration and extension. Second, through workflow-enabled variants such as OKL_GTS_PVT_W, invoked when approvals or workflow activities must mutate a template set. Third, through the stream generation and migration packages, which use API_COPY and CHANGE_VERSION when templates are migrated between environments or applied to contracts. Custom development should call OKL_GTS_PUB rather than this private package, consistent with EBS API standards and to preserve upgrade safety.