Search Results oks_auth_util_pvt




Overview
Explore in AI Chat

Overview

OKS_CONTRACT_LINE_PUB is the public PL/SQL API for the Oracle Service Contracts (OKS) module, providing the supported programmatic interface for creating, maintaining, validating, and deleting service contract lines in Oracle E-Business Suite 12.1.1 and 12.2.2. The package is owned by APPS and declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking schema rather than the definer. It is classified as a PUB interface, so it forms part of the frozen public API surface that Oracle supports for customer and partner extensions.

A central element of the package is the record type klnhv_rec_type, which mirrors the columns of the OKS_K_LINES_HV view and the underlying OKS_K_LINES_B/OKS_K_LINES_TL tables. Attributes include line identifiers and versioning columns (id, major_version, cle_id, dnz_chr_id), billing and pricing fields (discount_list, acct_rule_id, locked_price_list_id, price_uom), payment and credit-card data (payment_type, cc_no, cc_expiry_date, cc_auth_code, cc_bank_acct_id), usage estimation attributes, termination method, tax fields, and credit/override amounts. Each attribute defaults to the sentinel value OKC_API.G_MISS_NUM, G_MISS_CHAR, or G_MISS_DATE, which allows the API to distinguish an omitted value from an explicit NULL and to drive partial-update semantics.

Key Procedures and Functions

The ETRM 12.2.2 metadata documents 18 procedures and functions in the package, including the following public entry points:

  • CREATE_LINE — Inserts a new service contract line, accepting the line record and writing to the base, history, and translation tables.
  • LOCK_LINE — Locks a line for update by applying the appropriate concurrency control, which is the procedure most commonly associated with the "lock_line" search term.
  • UPDATE_LINE — Modifies an existing contract line, including the price list lock flag represented by locked_price_list_id.
  • DELETE_LINE — Removes a service contract line and its associated version history.
  • VALIDATE_LINE — Performs business-rule validation on line data prior to persistence, typically called before CREATE_LINE or UPDATE_LINE.
  • ADD_LANGUAGE — Loads translated line descriptions and other translatable attributes into the TL tables.
  • INSERT_ROW_UPG — Upgrade helper used during the 11i-to-12.x data migration to seed line rows.
  • CREATE_LINE_VERSION_UPG — Upgrade helper that generates version records for existing lines during migration.

Tables Accessed

The package reads and writes the following tables through APPS synonyms: OKS_K_LINES_B (base line table, storing non-translatable attributes), OKS_K_LINES_BH (history table, preserving prior versions for audit and rollback), OKS_K_LINES_TL (translatable line attributes), OKS_K_LINES_TLH (translatable history), FND_LANGUAGES (for language validation in ADD_LANGUAGE), and PLITBLM (the PL/SQL integer-table index-by table used for bulk operations and messaging). The B/BH and TL/TLH pairings reflect the standard Oracle multi-language and history-tracking pattern, so every line change typically results in a base insert plus a corresponding history insert.

Usage Notes

OKS_CONTRACT_LINE_PUB is typically invoked from the Service Contracts authoring forms (OKS contracts and lines), from concurrent programs that generate or renew contract lines, and from custom PL/SQL or OAF extensions. The package is referenced by 14 other packages, indicating it is a shared building block within the OKS stack. Callers should follow the standard pattern of populating the klnhv_rec_type record, calling VALIDATE_LINE, then CREATE_LINE or UPDATE_LINE, and using LOCK_LINE before any modification to avoid lost updates. Because the package is AUTHID CURRENT_USER, the invoking user must have direct privileges on the referenced OKS tables and APPS synonyms. Custom code should not call the _UPG procedures outside of an Oracle-driven upgrade, as they are migration-internal and not intended for production use.