Search Results add_section




Overview

OKC_TERMS_SECTIONS_GRP is a group-type PL/SQL package body in the Oracle E-Business Suite ETRM (Enterprise Contracts) module, owned by the APPS schema. It exposes the section-level manipulation logic used by Oracle Contracts to create, maintain, and validate the sections that make up a contract terms document. A contract terms record is organized hierarchically into articles (stored in OKC_K_ARTICLES_B) and the individual sections that belong to those articles (stored in OKC_SECTIONS_B). This package provides the API surface through which forms, concurrent programs, and custom extensions add, change, lock, and remove those section rows while preserving the integrity of the surrounding terms structure.

The package follows the standard ETRM group (GRP) design pattern. It defines the customary FND_API constant set (G_FALSE, G_TRUE, G_RET_STS_SUCCESS, G_RET_STS_ERROR, G_RET_STS_UNEXP_ERROR), the application identifier constants G_APP_NAME and G_FND_APP sourced from OKC_API, and the package name constant G_PKG_NAME. Amendment tracking is represented by the G_AMEND_CODE_ADDED, G_AMEND_CODE_UPDATED, and G_AMEND_CODE_DELETED constants, and debug output is controlled through FND_LOG levels (G_DBG_LEVEL, G_PROC_LEVEL, G_EXCP_LEVEL). This structure is consistent with the 120.1 source revision of the file OKCGSCNB.pls.

Key Procedures and Functions

The documented public interface contains six procedures. The parameter lists are deliberately omitted here; the descriptions below reflect the documented purpose of each entry point.

  • ADD_SECTION — Attaches a new section to an existing article within a contract terms document. This is the entry point most commonly sought by callers extending the terms structure and is the procedure associated with the search term "add_section". It records the insertion against the amendment history and returns the standard API status.
  • CREATE_SECTION — Creates a section record, establishing the base row and its descriptive attributes so that it can subsequently be referenced by the article hierarchy.
  • UPDATE_SECTION — Modifies the attributes of an existing section, marking the change as an amendment so that revision history remains traceable.
  • DELETE_SECTION — Removes a section from the terms structure, applying the deletion amendment code and respecting referential dependencies.
  • LOCK_ROW — Acquires a row-level lock on the section record to serialize concurrent modification before an update or delete is applied.
  • VALIDATE_ROW — Performs the standard row-level validation expected by the ETRM API framework, confirming that required attributes and mandatory relationships are satisfied before a write is committed.

Tables Accessed

The package operates against the following tables, referenced through APPS synonyms:

  • OKC_SECTIONS_B — The base table holding contract terms section rows. CREATE_SECTION, ADD_SECTION, UPDATE_SECTION, and DELETE_SECTION write to this table; VALIDATE_ROW and LOCK_ROW read and lock it.
  • OKC_K_ARTICLES_B — The base table holding articles. It supplies the parent context into which a section is placed and is read to confirm the article that a new or amended section belongs to.
  • PLITBLM — The PL/SQL index-by table type used internally for bulk processing, collection handling, and multi-row operations within the group API.

Usage Notes

OKC_TERMS_SECTIONS_GRP is invoked from the Oracle Contracts terms authoring forms, from concurrent programs that build or refresh contract terms documents, and from custom code that extends the ETRM section model. It is referenced by six other packages, which indicates it acts as a shared service layer rather than an end-user entry point. Callers should supply the standard FND_API parameters (API version, initialization flag, and the x_return_status / x_msg_count / x_msg_data out parameters) and should handle the unexpected-error status by logging the contents of the error message and error code tokens defined at package level. Because the procedures participate in the amendment framework, callers that need an audit trail of section additions, changes, and deletions should invoke ADD_SECTION, UPDATE_SECTION, and DELETE_SECTION rather than performing direct DML against OKC_SECTIONS_B. In EBS 12.1.1 and 12.2.2 the package is delivered under the APPS schema as an ETRM-supported API; direct modification of the package body is not supported.