Search Results uwq_begin_session

Overview

IEU_SH_PUB is the public API package for the Interaction/E-Service session-to-activity tracking framework in Oracle E-Business Suite. Its name derives from the former Interaction E-Utilities (IEU) product family, and the "SH" suffix denotes the session-handling layer. The package exposes the documented PL/SQL entry points that customer code, Oracle forms, and internal concurrent programs use to register work sessions and the discrete activities performed within them. In EBS 12.1.1 and 12.2.2 it functions strictly as a thin public wrapper over the private implementation package IEU_SH_PVT: each public procedure validates the standard API arguments and then delegates all business logic, table maintenance, and error capture to the private layer. This separation preserves a stable, upgrade-safe signature for external callers while allowing Oracle to change the underlying logic in the private package. The header comments ($Header: IEUPSHB.pls 120.0 2005/06/02) confirm the package has been shipped since the 11i era and remained unchanged into the 12.x code lines.

Key Procedures and Functions

The ETRM metadata documents five public procedures, all following the Oracle Application Object Library API conventions (P_API_VERSION, P_INIT_MSG_LIST, P_COMMIT, X_MSG_COUNT, X_MSG_DATA, X_RETURN_STATUS).

• UWQ_BEGIN_SESSION — Opens a session, identifying the resource, user, login, extension, and application under which subsequent activity will be recorded. It returns an X_SESSION_ID that callers must supply to all later activity calls.
• UWQ_END_SESSION — Closes the session identified by P_SESSION_ID. The optional P_END_REASON_CODE records why the session terminated (for example, normal logout versus timeout), which is important for reporting and duration analysis. This is the procedure most commonly associated with the "uwq_end_session" search term.
• UWQ_BEGIN_ACTIVITY — Starts a discrete activity inside an open session. Callers pass the session identifier, an activity type code, media type and media identifiers, user and login context, a reason code, request method, requested media type, and a work item type code, allowing fine-grained attribution of each interaction.
• UWQ_UPDATE_ACTIVITY — Modifies an already-open activity, allowing attributes captured at start time to be refreshed as the interaction evolves.
• UWQ_END_ACTIVITY — Terminates an individual activity within the session, closing its time span and finalizing its recorded attributes.

Tables Accessed

The ETRM excerpt lists no direct table references for IEU_SH_PUB. This is consistent with the wrapper design: the public package performs no DML itself. All inserts, updates, and queries against the underlying session and activity tables are executed by IEU_SH_PVT against the IEU schema objects (accessed through APPS synonyms) that store session headers, activity records, media references, and reason codes. Because the public layer issues no SQL, DBAs tuning this framework should direct tracing and index review at the private package.

Usage Notes

IEU_SH_PUB is invoked as a standard EBS PL/SQL API from three sources: Oracle Forms-based interaction consoles, concurrent programs that reconcile or report on session data, and custom code extending the interaction tracking model. Callers are expected to pass a valid P_API_VERSION, check X_RETURN_STATUS, and inspect X_MSG_DATA on failure. Coupled with the P_COMMIT flag, callers control transaction boundaries, so the begin/end pairs should normally be committed once a logical unit of work completes. The ETRM metadata records that this package is referenced by one other package, indicating limited but defined reuse within the EBS codebase.