Search Results has_primary_contract_doc

Overview

OKC_CONTRACT_DOCS_GRP is the document-management API group for the Oracle E-Business Suite Contracts (OKC) module, part of Oracle Enterprise Trading and Risk Management / Contract Lifecycle Management. It governs the relationship between a "business document" — such as a contract, quote, or terms document — and the physical or generated attachment that represents it. The package provides the standardized insert, update, and delete entry points for the OKC_CONTRACT_DOCS entity and manages the corresponding rows in the FND_ATTACHED_DOCUMENTS and FND_DOCUMENTS attachment infrastructure, including versioning and category linkage. The API follows the standard Oracle EBS API contract, accepting p_api_version, p_init_msg_list, p_validation_level, and p_commit, and returning x_return_status, x_msg_count, and x_msg_data. The package AUTHID CURRENT_USER, declared as an API group (GRP) classification, and is identified in the header as $Header: OKCGCONTRACTDOCS.pls 120.0, with constants G_COPY_PROGRAM_ID, G_ATTACH_ENTITY_NAME ('OKC_CONTRACT_DOCS'), and G_CURRENT_VERSION. In the context of a "Deal Counsel Form" search, this package is the underlying API invoked when users attach or version legal documents on a contract or deal record.

Key Procedures and Functions

The package exposes twelve documented procedures and functions:

• INSERT_CONTRACT_DOC — Creates the association between a business document (business_document_type, business_document_id, business_document_version) and an attached document, and optionally creates the FND attachment record.
• UPDATE_CONTRACT_DOC — Modifies an existing contract document association, including visibility, effective dates, and flags.
• DELETE_CONTRACT_DOC — Removes a contract document association.
• VERSION_ATTACHMENTS — Creates a new version of an existing document attachment.
• DELETE_DOC_ATTACHMENTS — Deletes the FND attachment records associated with a document.
• DELETE_VER_ATTACHMENTS — Deletes attachments for a specific document version.
• COPY_ATTACHMENTS — Copies attachments from one document or version to another; uses G_COPY_PROGRAM_ID.
• QA_DOC — Interacts with the OKC_DOC_QA_LISTS quality/document checklist structures.
• IS_PRIMARY_TERMS_DOC_MERGEABLE — Determines whether a primary terms document can be merged.
• GET_PRIMARY_TERMS_DOC_FILE_ID — Returns the file identifier of the primary terms document.
• HAS_PRIMARY_CONTRACT_DOC — Indicates whether a primary contract document exists.
• CLEAR_PRIMARY_DOC_FLAG — Clears the primary document indicator on a contract document.

Tables Accessed

The package reads and writes OKC_CONTRACT_DOCS, the transactional table linking contracts to attachments, and OKC_BUS_DOC_TYPES_B for business document type validation. Attachment data flows through FND_ATTACHED_DOCUMENTS and FND_ATTACHED_DOCUMENTS_S, with document definitions and translations in FND_DOCUMENTS and FND_DOCUMENTS_TL, and category validation via FND_DOCUMENT_CATEGORIES. Error and message handling uses FND_NEW_MESSAGES. The OKC_DOC_QA_LISTS table supports quality/document checklist processing. DUAL and PLITBLM support internal PL/SQL logic. All are accessed through APPS synonyms.

Usage Notes

This package is typically invoked from the Contracts forms (OKC) when users attach, version, or remove documents, from concurrent programs that generate or copy contract documents, and from custom extensions that programmatically manage contract attachments. Because the package is classified as GRP and referenced by seven other packages, it should not be modified or bypassed; direct DML against the underlying tables is discouraged in favor of these APIs.