Results for “get_system_variables”

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

Overview

OKC_CLM_PKG is a PL/SQL package in the Oracle E-Business Suite Contracts (OKC) module, declared with AUTHID CURRENT_USER and owned by the APPS schema. Its name and procedure set indicate that it belongs to the Contract Lifecycle Management (CLM) and clause library subsystem, and it likely appears in some searches under the approximate phrase "acom clime." The package provides the programmatic interface through which contract terms, clause sections, articles, and template constructs are assembled, validated, and resolved. In the context of Oracle EBS 12.1.1 and 12.2.2, it operates beneath the Contracts authoring forms, servicing the logic that maps user-defined variables (UDVs) and system variables into clause text and that maintains the reusable clause and template structures from which individual contract documents are generated. Its metadata classifies the API as OTHER, meaning it is a supporting internal package rather than a published, externally supported interface.

Key Procedures and Functions

The package exposes thirteen documented procedures and functions that fall into four functional groups.

• Variable resolution: GET_USER_DEFINED_VARIABLES, GET_UDV_WITH_PROCEDURES, and GET_CLM_UDV return collections of variable codes and their resolved values for a given document type, document identifier, operating unit, and intent. GET_SYSTEM_VARIABLES performs the equivalent retrieval for system-seeded variables.
• Variable persistence and defaults: SET_CLM_UDV writes the resolved variable values back for a contract or template document, while GET_DEFAULT_SCN_CODE derives the default section code used when new clause sections are created.
• Duplicate elimination: CLM_REMOVE_DUP_SCN_ART, CLM_REMOVE_DUP_ARTICLES, and CLM_REMOVE_DUP_SECTIONS remove redundant section, article, and section-to-article associations that can accumulate through template copying or authoring revisions.
• Usage and template maintenance: INSERT_USAGES_ROW, DELETE_USAGES_ROW, and COPY_USAGES_ROW manage rows in the template usage structures, while CHECK_DUP_TEMPLATES validates whether a template definition would duplicate an existing one.

All documented entry points follow the standard EBS API convention, accepting p_api_version and p_init_msg_list and returning x_return_status, x_msg_data, and x_msg_count. Several operate against the x_udf_var_value_tbl collection type defined in OKC_XPRT_XRULE_VALUES_PVT, the shared export rule values structure.

Tables Accessed

The package reads and writes contract clause and template data through APPS synonyms. OKC_SECTIONS_B, OKC_ARTICLES_ALL, OKC_ARTICLE_VERSIONS, and OKC_ART_VAR_SECTIONS provide the section, article, version, and variable-to-section structures manipulated by the duplicate-removal and default-code routines. OKC_K_ARTICLES_B and OKC_K_ART_VARIABLES hold contract-specific article and variable instances. Variable metadata is drawn from OKC_BUS_VARIABLES_B and OKC_BUS_VARIABLES_TL, while document typing comes from OKC_BUS_DOC_TYPES_B. The usage and template logic operates on OKC_TEMPLATE_USAGES, OKC_MLP_TEMPLATE_USAGES, OKC_XPRT_TEMPLATE_RULES, OKC_XPRT_RULE_HDRS_ALL, and OKC_XPRT_RULE_CONDITIONS. OKC_TERMS_CLM_UDV_T stores the CLM-specific user-defined variable values written by SET_CLM_UDV.

Usage Notes

OKC_CLM_PKG is an internal dependency rather than a standalone callable API. The metadata records that it is referenced by nine other packages, indicating that it is invoked from higher-level Contracts packages that drive clause assembly, variable substitution, and template instantiation. In practice it is exercised when users author or copy contract templates and clauses in the Contracts Workbench and related forms, when template rules and variables are evaluated during document generation, and when usage and version rows are maintained. Customizations should treat these procedures as unsupported internals and prefer the documented Contracts public APIs; direct calls require the standard API initialization sequence and appropriate return-status handling.