Search Results default_collaboration_status

Overview

CLN_CH_COLLABORATION_PKG is the central PL/SQL package in Oracle E-Business Suite's Collaborative Planning/Supply Chain Collaboration module within the CLN (Collaboration) schema. Its primary business function is to manage the lifecycle of collaboration records between trading partners. Specifically, it handles creation, retrieval, updating, and status tracking of collaboration headers, details, and messages. The package operates in both inbound and outbound contexts — it is invoked whenever a new collaboration must be initiated, or when details of an existing collaboration need to be retrieved or updated. It bridges Oracle's XML Gateway infrastructure (ECX tables) with collaboration-specific data stores (CLN tables), and it depends heavily on XML parsing routines (xmldom, xmlparser) to extract data such as document creation dates and control/data area reference identifiers from XML payloads exchanged between partners.

Key Procedures and Functions

The package exposes 14 documented procedures and functions. GET_CONTROL_AREA_REFID and GET_DATA_AREA_REFID extract reference identifiers from the control and data areas of incoming or outgoing XML messages. CREATE_COLLABORATION and ADD_COLLABORATION instantiate new collaboration records, while UPDATE_COLLABORATION modifies existing ones. IS_UPDATE_REQUIRED evaluates whether an incoming message warrants an update to an existing collaboration. FIND_COLLABORATION_STATUS, FIND_COLLABORATION_DETAIL_ID, and FIND_COLLABORATION_ID are lookup routines that resolve collaboration identifiers and their current status values. RETRIEVE_COLLABORATION_DETAILS returns the full detail record of a collaboration. ADD_COLLABORATION_MESSAGES appends message entries to an existing collaboration. GET_TRADING_PARTNER_DETAILS resolves partner information from the ECX trading partner tables. DEFAULT_XMLGTXN_MAPPING — the object the user searched for — resolves or supplies default XML Gateway transaction mappings associated with a collaboration, drawing on the CLN_CH_XMLGTXN_MAPPING table. DEFAULT_COLLABORATION_STATUS assigns the default status value to a newly created collaboration record. The package also contains private helper functions such as GET_CHILD_ELEMENT_VALUE and GET_DOCUMENT_CREATION_DATE, which use DOM parsing to extract values from XML documents.

Tables Accessed

The package reads and writes several CLN and ECX tables via APPS synonyms. CLN_COLLABORATION_HDR and CLN_COLLABORATION_DTL store collaboration headers and details, with their identifier sequences CLN_COLLABORATION_HDR_ID_S and CLN_COLLABORATION_DTL_ID_S. CLN_COLLABORATION_MSG and CLN_COLLABORATION_MSG_ID_S hold collaboration messages. CLN_CH_XMLGTXN_MAPPING provides XML Gateway transaction mapping definitions used by DEFAULT_XMLGTXN_MAPPING. CLN_COLL_COMPLETED_STATUS and CLN_COLL_HIST_HDR/CLN_COLL_HIST_DTL track completed-status and historical collaboration data. On the ECX side, the package accesses ECX_DOCLOGS and ECX_EXT_PROCESSES for document logging and external process linkage, ECX_HUBS and ECX_HUB_USERS for trading hub configuration, ECX_STANDARDS for messaging standards, and ECX_TP_HEADERS/ECX_TP_DETAILS for trading partner master data. Together these tables allow the package to correlate Oracle collaboration records with the XML Gateway messaging infrastructure that transports them.

Usage Notes

CLN_CH_COLLABORATION_PKG is typically invoked from Oracle EBS Collaboration module forms (such as collaboration inquiry and maintenance screens), from concurrent programs that process inbound and outbound collaboration messages, and from custom extensions integrating third-party supply chain systems with Oracle XML Gateway. Because it is referenced by twelve other packages, it functions as a shared service layer: other CLN and ECX packages call its lookup and mutation routines rather than manipulating the underlying tables directly. The package relies on the profile option CLN_DEBUG_LEVEL for diagnostic output, routing debug messages through ECX_CLN_DEBUG_PUB. In 12.1.1 and 12.2.2 environments, its XML handling component depends on the Oracle XML Parser for PL/SQL (xmlparser/xmldom). When customizing or debugging collaboration flows, DBAs and developers commonly trace calls starting from CREATE_COLLABORATION, ADD_COLLABORATION, and DEFAULT_XMLGTXN_MAPPING, since these represent the entry points for establishing and mapping a new trading-partner collaboration.