Search Results create_standard_note




Overview
Explore in AI Chat

Overview

The APPS.OKE_STANDARD_NOTES_PUB package is a public PL/SQL API within the Oracle E-Business Suite Procurement and Contracts family, specifically belonging to the Oracle Knowledge Engine (OKE) module used by Oracle Contracts. Its purpose is to provide a programmatic interface for managing the reusable "standard notes" that can be attached to contract documents, contract templates, and related contract artifacts. Standard notes allow organizations to maintain a library of pre-approved textual clauses and boilerplate language that can be inserted consistently across contracts, ensuring legal and commercial consistency while reducing manual authoring effort.

The package is classified as a PUBLIC (PUB) API, meaning it is intended to be invoked by other application code, Oracle Forms, and customer extensions rather than being an internal-only private package. In the ETRM 12.2.2 metadata the package is marked VALID in the APPS schema, and it exposes a documented set of procedures covering the full lifecycle of a standard note: creation, update, deletion, validation, copying, and locking.

Key Procedures and Functions

The documented API surface exposes the following procedures and functions. Parameter lists are not reproduced here; the descriptions reflect the documented functional intent of each routine.

  • CREATE_STANDARD_NOTE — Creates a new standard note record, populating the base table and corresponding translation rows.
  • UPDATE_STANDARD_NOTES — Modifies the attributes of an existing standard note, such as its descriptive and textual content.
  • DELETE_STANDARD_NOTE — Removes a standard note from the repository, typically enforcing validation rules before deletion.
  • VALIDATE_STANDARD_NOTE — Applies business validation logic to a standard note, ensuring required fields, uniqueness, and referential integrity constraints are satisfied before a save or commit.
  • COPY_STANDARD_NOTE — Duplicates an existing standard note, enabling users to derive new notes from established templates.
  • LOCK_STANDARD_NOTE — Acquires a lock on a standard note record to support concurrent editing and prevent conflicting updates.

Only six of the thirteen documented routines are itemized in the available metadata; the remainder follow the same lifecycle-oriented design pattern typical of OKE public APIs.

Tables Accessed

The package reads and writes the following tables, accessed through APPS synonyms:

  • OKE_K_STANDARD_NOTES_B — The base table storing the master (language-independent) attributes of each standard note.
  • OKE_K_STANDARD_NOTES_TL — The translation table holding language-specific translatable columns for each standard note, supporting the multi-language (TL) data model.
  • PLITBLM — The PL/SQL integer table used for bulk operations and collection handling within the API internals.

Usage Notes

OKE_STANDARD_NOTES_PUB is referenced by other OKE packages, notably OKE_CONTRACT_PUB and OKE_KCOPY_PKG, which invoke it when standard notes are attached to contracts or copied as part of contract duplication. It in turn depends on OKE_API and OKE_NOTE_PVT. Typical invocations occur from Oracle Contracts forms, concurrent programs that seed or migrate standard notes, and custom PL/SQL extensions that must programmatically manage the note library. When integrating, developers should call the validation routine before create or update, and acquire a lock before modifying shared records to avoid concurrency conflicts.