Search Results oks_template_set_pub




Overview
Explore in AI Chat

Overview

The APPS.OKS_TEMPLATE_SET_PUB package body is a public (PUB-classified) PL/SQL API within Oracle E-Business Suite's Service Contracts (OKS) module. It serves as the external-facing interface for managing template sets used throughout the Service Contracts and Telecommunications/Service Renewal subsystems. Template sets group reusable document and report templates (and the associated knowledge or header structures) that drive contract generation, renewals, and reporting. Because it is classified as a PUB API, this package is intended to be called by external consumers — Oracle Forms, concurrent programs, other modules, and custom code — rather than being invoked only internally. Internally it delegates to the private implementation package OKS_TEMPLATE_SET_PVT, following the standard EBS PUBLIC/PRIVATE API pairing convention. The package body is documented as VALID and, per the ETRM metadata, is not referenced by any other database object, confirming its role as a top-level entry point.

Key Procedures and Functions

The documented API exposes nineteen procedures and functions. The core CRUD operations form the foundation of the interface:

  • INSERT_ROW — creates a new template set record.
  • UPDATE_ROW — modifies an existing template set record.
  • DELETE_ROW — removes a template set record.
  • LOCK_ROW — obtains a concurrency lock on a template set row prior to modification.
  • VALIDATE_ROW — performs business-rule validation on template set data, typically invoked before insert or update to ensure data integrity.
  • API_COPY — duplicates an existing template set, supporting reuse of template configuration.
  • CHANGE_VERSION — manages versioning of a template set, invoking version-control logic through OKS_TEMPLATE_SET_PVT.
  • QC — likely a query/qualifier or quality-check convenience routine supporting the API surface.
  • GET_TEMPLATE_SET_DTLS — retrieves the details of a template set for a given identifier, returning attributes for display or downstream processing.

The remaining documented entries complete the standard EBS API pattern. Parameter lists are intentionally not enumerated here; each routine accepts the standard EBS API parameters (p_init_msg_list, p_commit, x_return_status, x_msg_count, x_msg_data) along with object-specific identifiers and attributes.

Tables Accessed

Through APPS synonyms, the package references three principal base tables:

  • OKS_K_HEADERS_B — the knowledge/contract header base table, holding header-level records associated with template sets.
  • OKS_REPORT_TEMPLATES — stores the report template definitions managed within each template set; the package also reads the accompanying view OKS_REPORT_TEMPLATES_V.
  • WF_ITEMS — the Oracle Workflow items table, used when template-set changes or approvals generate workflow events.

The package additionally consumes supporting views such as XDO_TEMPLATES_VL (XML Publisher templates) and utility packages including FND_API, FND_MSG_PUB, FND_LOG, MO_GLOBAL, OKC_API, OKC_UTIL, OKS_RENEW_UTIL_PVT, and OKS_WF_K_PROCESS_PVT for messaging, logging, multi-org security, and workflow integration.

Usage Notes

This package is typically invoked from Service Contracts setup and administration forms when users define, copy, version, or maintain template sets; from concurrent programs that generate contracts, renewals, or reports; and from custom PL/SQL integrations requiring programmatic template-set management. Because it is a PUB API, callers should use it rather than touching OKS_TEMPLATE_SET_PVT directly, preserving upgrade safety and enforcing the standard EBS error-handling contract (checking x_return_status and retrieving messages via FND_MSG_PUB). Callers must initialize the message stack, observe multi-org context via MO_GLOBAL, and honor the LOCK_ROW/VALIDATE_ROW sequence before UPDATE or DELETE. The API is compatible with both EBS 12.1.1 and 12.2.2. The package is referenced by two other packages, indicating it participates in a broader contract template workflow.