Search Results cz_utils




Overview
Explore in AI Chat

Overview

APPS.CZ_UTILS is a shared PL/SQL utility package body within the Oracle E-Business Suite, belonging to the ETRM (Electronic Technical Reference Manual) product family. The package is classified as an OTHER API under the APPS schema and is marked VALID in both Oracle EBS 12.1.1 and 12.2.2. Its business role is to centralise a broad set of low-level technical services — logging, date conversion, user and environment resolution, string and numeric validation, database link retrieval, and error-stack propagation — that are required across the ETRM application. Because it composes generic helpers rather than business transactions, CZ_UTILS functions as foundational infrastructure: it is referenced by 167 other packages, indicating that the majority of ETRM modules depend on it either directly or transitively. The package reports no inbound references from database objects, confirming it is a leaf consumer of standard Oracle facilities (FND_FILE, FND_GLOBAL, FND_LOG, FND_MESSAGE, FND_MSG_PUB, FND_INSTALLATION, FND_USER, DUAL, ALL_USERS) while exposing services upward to the wider ETRM code base.

Key Procedures and Functions

The package body documents 29 procedures and functions. The principal groups are as follows.

  • Logging and reporting: LOG_REPORT, REPORT, and REPORT_HTML_TAGS provide the standard mechanism by which ETRM programs emit concurrent-program output and structured reports, including HTML-formatted content.
  • Date and epoch handling: TODATE converts character representations to date values; EPOCH_BEGIN and EPOCH_END derive the start and end boundaries of an epoch interval, supporting time-bounded processing.
  • Configuration flags: GET_PK_USEEXPANSION_FLAG and GET_NOUPDATE_FLAG retrieve profile-style switch values from the ETRM configuration tables, controlling primary-key expansion behaviour and update suppression respectively.
  • Validation and conversion: ISNUM validates whether a supplied value is numeric; CONV_NUM performs numeric conversion; GET_TEXT resolves a text value for a given context or identifier; CHECK_INSTALLED_LANG confirms whether a language is installed in the EBS instance.
  • Session and user context: GET_USER_NAME returns the current or specified application user; SPX_UID and SPX_LOGIN_TYPE expose the underlying session user identifier and login type used by ETRM security processing.
  • Infrastructure and diagnostics: RETRIEVE_DB_LINK obtains the database link definition used by distributed ETRM operations; ADD_ERROR_MESSAGE_TO_STACK and ADD_EXC_MSG_TO_FNDSTACK append messages and exception text onto the FND message stack for downstream error display.

Tables Accessed

The package body operates against a small set of ETRM configuration and control tables accessed through APPS synonyms, together with standard Oracle dictionary and application views.

  • CZ_DB_SETTINGS — stores configurable ETRM settings; read by the flag and configuration retrieval functions.
  • CZ_DB_LOGS — the ETRM logging table, written by the logging routines to record processing activity and report output.
  • CZ_SERVERS — defines registered ETRM servers, supporting server- and link-related operations.
  • CZ_XFR_FIELDS and CZ_XFR_TABLES — describe transfer field and table definitions consumed by the utility routines when constructing or interpreting data movement.
  • FND_USER and ALL_USERS — used for user name and schema resolution.
  • DUAL — used for single-row evaluations.

Usage Notes

CZ_UTILS is an internal support package rather than a user-facing API. It is invoked implicitly by the 167 ETRM packages that depend upon it, most commonly from concurrent programs that call REPORT and LOG_REPORT to produce output files, and from validation routines that call ISNUM, TODATE, and CONV_NUM before committing data. Form-based and custom code paths invoke GET_USER_NAME, SPX_UID, and GET_NOUPDATE_FLAG to establish session and configuration context, while error handling blocks call ADD_ERROR_MESSAGE_TO_STACK and ADD_EXC_MSG_TO_FNDSTACK to surface messages through the standard FND message framework. Because the package relies on FND_GLOBAL, FND_LOG, and FND_MSG_PUB, its behaviour is fully consistent with native EBS diagnostics, and because it is a leaf object with no inbound dependencies, it can be modified or patched without affecting non-ETRM modules. Oracle does not publish CZ_UTILS as a supported public API, so customisations should treat it as an internal implementation detail and avoid direct invocation where a documented alternative exists.