Search Results get_control_area_refid

Overview

APPS.CLN_CH_COLLABORATION_PKG is the core collaboration management package within the Oracle E-Business Suite Supply Chain Management collaboration module (CLN schema). In Oracle EBS 12.1.1 and 12.2.2, it provides the PL/SQL API layer that governs how trading partners exchange and synchronize supply chain collaboration documents through the ECX (e-Commerce Exchange) hub infrastructure. The package handles the complete lifecycle of a collaboration record: creating the collaboration header, attaching messages and XML transaction mappings, tracking status transitions, and resolving details such as data area and control area references that tie a collaboration to its underlying XML gateway transaction.

The package is classified as an OTHER API and is documented as VALID under the APPS schema in ETRM 12.2.2. It sits at the centre of a dense dependency web: it is referenced by twelve other packages — including CLN_ACK_PO_PKG, CLN_CH_EVENT_SUBSCRIPTION_PKG, CLN_NP_PROCESSOR_PKG, CLN_XMLG_EVENT_HANDLER_PKG, CLN_RESEND, and several M4U packages — and in turn depends only on SYS.STANDARD. This makes it a foundational utility for the broader CLN collaboration flow.

Key Procedures and Functions

The package exposes fourteen documented procedures and functions. Their functional groupings are as follows:

• Reference resolution: GET_CONTROL_AREA_REFID, GET_DATA_AREA_REFID, and GET_TRADING_PARTNER_DETAILS resolve identifiers and partner metadata needed to address a collaboration document.
• Lifecycle management: CREATE_COLLABORATION, ADD_COLLABORATION, UPDATE_COLLABORATION, and ADD_COLLABORATION_MESSAGES create and maintain collaboration headers and their associated messages.
• Lookup and query: FIND_COLLABORATION_STATUS, FIND_COLLABORATION_DETAIL_ID, and FIND_COLLABORATION_ID retrieve status, detail, and header identifiers for processing logic.
• Retrieval and defaults: RETRIEVE_COLLABORATION_DETAILS returns the full detail of a collaboration record, while DEFAULT_XMLGTXN_MAPPING and DEFAULT_COLLABORATION_STATUS supply default mapping and status values, and IS_UPDATE_REQUIRED determines whether a given collaboration needs refreshing.

Parameter lists are not documented in the ETRM metadata and should be confirmed from the package specification source in the database.

Tables Accessed

The package reads and writes several CLN and ECX tables through APPS synonyms. The primary CLN tables are CLN_COLLABORATION_HDR_ID_S, CLN_COLLABORATION_DTL_ID_S, and CLN_COLLABORATION_MSG_ID_S (sequence generators for headers, details, and messages), CLN_COLL_MESSAGES (message content), CLN_COLL_HIST_HDR and CLN_COLL_HIST_DTL (historical records), CLN_COLL_COMPLETED_STATUS (status tracking), and CLN_CH_XMLGTXN_MAPPING (the mapping between collaborations and XML Gateway transactions). On the ECX side, the package touches ECX_DOCLOGS, ECX_EXT_PROCESSES, ECX_HUBS, ECX_HUB_USERS, ECX_STANDARDS, ECX_TP_DETAILS, and ECX_TP_HEADERS, which define the trading partner, hub, and document exchange configuration.

Usage Notes

CLN_CH_COLLABORATION_PKG is invoked indirectly rather than through a user-facing form. It is typically called by collaboration event handlers (CLN_XMLG_EVENT_HANDLER_PKG), acknowledgement processing (CLN_ACK_PO_PKG), resend logic (CLN_RESEND), and processor packages (CLN_NP_PROCESSOR_PKG) during inbound and outbound collaboration flows. Because it is referenced by both Oracle-standard and M4U-era custom packages, it is a stable integration point for customized collaboration extensions. Any change to this package has wide impact due to its twelve dependent packages, and regression testing across the collaboration document lifecycle is strongly advised following patches or upgrades between 12.1.1 and 12.2.2.