Results for “okc_terms_udv_with_procedure_t”

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

Overview

OKC_TERMS_UDV_WITH_PROCEDURE_T is a Contracts Core (OKC) table that supports the storage and evaluation of user-defined variables (UDVs) associated with contract terms, clauses, and articles. In Oracle E-Business Suite 12.1.1 and 12.2.2, the OKC module underpins the Contract Terms and Conditions repository, where clause text is authored, versioned, and assembled into contract documents. The "_WITH_PROCEDURE" naming convention indicates that this table holds variable definitions that are resolved at runtime, typically by invoking a stored procedure or server-side logic rather than a static lookup. This distinguishes it from purely declarative UDV storage: the procedure-backed variables enable dynamic substitution of values into contract terms, driving personalization of clauses during document generation.

From a Data Vault modeling perspective, the ETRM metadata classifies this object heuristically as standalone. This suggests the table is best modeled as a satellite or standalone dimension-like structure, since the only documented foreign key relationship points to BEN_TCS_CAT (the benefits/compensation category table) via CAT_ID, rather than to a central hub such as a contract header or terms hub. Mined FK structure references OKC_TERMS_UDV_WITH_PROCEDURE_T.CAT_ID → BEN_TCS_CAT, confirming the categorical anchoring of the variable definitions.

Key Information Stored

The documented physical schema exposes six columns. The most functionally significant are:

• VARIABLE_CODE — the business identifier for the user-defined variable; the primary lookup key used by contract generation logic to resolve a token appearing in clause or article text.
• VARIABLE_VALUE — the resolved or stored value assigned to the variable, or the payload returned by the associated procedure.
• DOC_TYPE — the document type classification that scopes the variable to a category of contract documents.
• DOC_ID — the document instance identifier linking the variable record to a specific generated or authored document.
• ARTICLE_VERSION_ID — the versioned article identifier, tying the variable to a specific revision of contract article text so that historical versions resolve correctly.
• CAT_ID — the category identifier, and the sole documented foreign key column, referencing BEN_TCS_CAT.

No explicit surrogate primary key is documented among these six columns; the ETRM schema reports Owner OKC with six columns and no PK column listed. Where a unique index exists, the combination of VARIABLE_CODE with DOC_TYPE, DOC_ID, and ARTICLE_VERSION_ID would serve as the natural business-key candidate, since a variable is meaningful only within the context of a specific article version and document.

Common Use Cases and Queries

Typical scenarios include resolving UDV values during contract document assembly, auditing which variables were used in a clause version, and reporting on variable usage across document types. A representative query joins the variable table to its documented parent category:

• Resolving variable definitions by category: SELECT t.variable_code, t.variable_value FROM okc_terms_udv_with_procedure_t t, ben_tcs_cat c WHERE t.cat_id = c.cat_id AND c.category_name = :p_category;
• Listing variables for a specific article version: filter on ARTICLE_VERSION_ID and DOC_ID to reconstruct the variable set active when that article revision was published.
• Reporting on document-type usage: group by DOC_TYPE to measure which contract templates rely most heavily on procedure-backed variables.

Because the table is confined to Contracts Core, queries should generally be executed against the OKC schema context with appropriate APPS grants, and results joined to contract header and article tables to present human-readable contract context.

Related Objects

• BEN_TCS_CAT — referenced via CAT_ID; the categorical parent that classifies variable definitions.
• OKC_TERMS_UDV_T — the likely companion table holding non-procedure (static) UDV definitions; compare to distinguish declarative from procedure-backed variables.
• OKC_ARTICLE_VERSIONS (and related article/version tables) — joined via ARTICLE_VERSION_ID to obtain the clause text in which variables are embedded.
• OKC_DOCUMENTS / OKC_DOC_TYPES — joined via DOC_ID and DOC_TYPE to resolve the contract document and template context.
• OKC_TERMS_UDV_VALUES — where present, stores per-document resolved variable values, complementing the definitions held here.
• OKC_CONTRACTS (OKC_K_HEADERS) — the parent contract structure ultimately served by these variable definitions during document generation.

Together these objects form the Contracts Core terms-resolution layer, with OKC_TERMS_UDV_WITH_PROCEDURE_T acting as the procedure-backed variable definition store.