Search Results get_article_variable_values

Overview

ASO_CONTRACT_TERMS_PUB is the public PL/SQL package body that exposes the contract terms API used by Oracle EBS Order Capture and Quoting (ASO) to manage the variable substitution layer of contract terms attached to a quote, order, or article. In Oracle EBS 12.1.1 and 12.2.2, contract terms are the configurable textual clauses (warranties, payment terms, liability limitations) that print on quote and order documents. These clauses contain "article variables" and "line variables" — named tokens embedded in the clause text whose runtime values are resolved from the transaction, customer, system profile, or line-level data at the moment the term is applied or previewed. ASO_CONTRACT_TERMS_PUB serves as the thin public boundary over the internal implementation, insulating callers from private package signatures and centralising logging, message-stack handling, and savepoint management. The source header (asopktcb.pls, version 120.1) records the package as created in October 2002 and last shipped in June 2005, and the header carries no functional change history, indicating a stable API surface across the 11i and 12.x lines.

Key Procedures and Functions

The documented API classification PUB exposes three procedures.

• GET_ARTICLE_VARIABLE_VALUES — Resolves the runtime values for the article-level variables referenced within the contract terms associated with a given document. The identifier of the document (quote, order, or article) is passed in, and the caller supplies a system-variable value table that is populated in place. This is the procedure returned by a search on "get_article_variable_values".
• GET_LINE_VARIABLE_VALUES — Performs the parallel resolution for line-level variables, so that each quote or order line can carry its own substituted term text rather than a document-wide value.
• OK_TO_COMMIT — Provides the standard transactional advisory used by EBS APIs, allowing a caller orchestrating several API calls to determine whether the current work may be committed or must instead be rolled back.

All three follow the EBS API conventions: an API version argument, an initialise-message-list flag defaulting to FND_API.G_FALSE, and the standard x_return_status, x_msg_count, and x_msg_data output triplet. Internally, the public body validates the API version, establishes a savepoint, conditionally calls FND_MSG_PUB.initialize, sets the cached G_Debug_Flag from the ASO_ENABLE_DEBUG profile option, and emits trace messages through ASO_DEBUG_PUB when debugging is enabled. GET_ARTICLE_VARIABLE_VALUES then delegates to the corresponding procedure in the internal package ASO_CONTRACT_TERMS_INT.

Tables Accessed

No base tables are accessed directly by the public body. All persistence and lookup work is delegated to ASO_CONTRACT_TERMS_INT, indirectly referencing the contract terms repository, the OKC terms utility structures (note the OKC_TERMS_UTIL_GRP.sys_var_value_tbl_type parameter type), and the ASO quote and line entities via APPS synonyms. The public layer therefore acts purely as a façade.

Usage Notes

Because it is a PUB-classified API, ASO_CONTRACT_TERMS_PUB is the supported entry point for custom code and is referenced by one other package within the EBS codebase. Typical invocation points are the Order Capture and Quoting forms when a user applies or previews contract terms, and any custom concurrent program or extension that needs to expand variable placeholders before printing terms. Callers should pass FND_API.G_TRUE for the initialise-message-list flag, inspect x_return_status against FND_API.G_RET_STS_SUCCESS, drain messages with FND_MSG_PUB.count_and_get when the status is not success, and honour OK_TO_COMMIT before issuing a COMMIT.