Results for “okc_k_art_variables_u1”

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

Overview

The OKC_K_ART_VARIABLES table resides in the OKC schema and belongs to the Contracts Core module (OKC) of Oracle E-Business Suite. It is described in the ETRM repository as the document clause variable table, and its purpose is to store clause variables that are used within a document through contract terms. In practical terms, this object holds the runtime and configuration values that drive variable substitution inside contract clause text, allowing clauses authored in a template to be populated dynamically when a contract or document is assembled.

From a Data Vault modeling perspective, the ETRM metadata classifies this table heuristically as standalone, based on the structure of its foreign key relationships. This is a modeling suggestion rather than a physical directive: the table is not currently linked to other OKC entities through declared foreign keys and behaves in isolation at the schema level, which means it can be treated as a self-contained reference or configuration entity rather than as a dependent satellite of a larger hub.

Key Information Stored

The table contains 18 documented columns. The most significant are:

• CAT_ID — the contract article/category identifier, which also participates in the unique business key and carries a foreign key reference to BEN_TCS_CAT. This ties each clause variable to a specific contract term or clause category.
• VARIABLE_CODE — the code that identifies the variable within the clause. Together with CAT_ID it forms the unique index OKC_K_ART_VARIABLES_U1, making the pair the primary business-key candidate.
• VARIABLE_TYPE — indicates the nature of the variable (for example, a value set, a static value, or another typing scheme) and drives how the variable is resolved at runtime.
• EXTERNAL_YN — flags whether the variable is sourced externally.
• ATTRIBUTE_VALUE_SET_ID and VARIABLE_VALUE_ID — reference the value set and the resolved variable value respectively.
• VARIABLE_VALUE — the literal or resolved value assigned to the variable.
• OVERRIDE_GLOBAL_YN, GLOBAL_VARIABLE_VALUE, and GLOBAL_VARIABLE_VALUE_ID — support the override of global variable values at the document or clause level.
• MR_VARIABLE_HTML and MR_VARIABLE_XML — multi-row variables rendered in HTML and XML form, which is essential for clause content that expands into repeating or structured output.
• OBJECT_VERSION_NUMBER — the standard EBS optimistic locking column, alongside the audit columns CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, and LAST_UPDATE_LOGIN.

Note that the unique index on (CAT_ID, VARIABLE_CODE) is the documented business-key candidate; the table does not expose a separately documented surrogate primary key column beyond this composite.

Common Use Cases and Queries

Typical use cases include auditing which variables drive a given contract clause, tracing the values substituted into generated documents, and reporting on external versus internal variable usage. A representative query listing variables for a given category might read:

• SELECT CAT_ID, VARIABLE_CODE, VARIABLE_TYPE, VARIABLE_VALUE FROM OKC.OKC_K_ART_VARIABLES WHERE CAT_ID = :p_cat_id;
• SELECT * FROM OKC.OKC_K_ART_VARIABLES WHERE EXTERNAL_YN = 'Y' AND VARIABLE_VALUE IS NULL; — to find unresolved external variables.
• SELECT CAT_ID, VARIABLE_CODE, OVERRIDE_GLOBAL_YN, GLOBAL_VARIABLE_VALUE FROM OKC.OKC_K_ART_VARIABLES WHERE OVERRIDE_GLOBAL_YN = 'Y'; — to report overridden globals.

Related Objects

• BEN_TCS_CAT — referenced through the FK OKC_K_ART_VARIABLES.CAT_ID → BEN_TCS_CAT; the primary parent object.
• OKC_K_ARTICLES / OKC_K_ARTICLE_VERSIONS — the clause/article definitions that consume these variables.
• OKC_K_TERMS and OKC_K_LINES — contract term and line records that bind clauses to documents.
• OKC_K_HEADERS — contract headers that carry the assembled clauses.
• OKC_K_VARIABLES / value-set tables — supporting the ATTRIBUTE_VALUE_SET_ID and VARIABLE_VALUE_ID references.