Search Results utl_file_dir

Overview

ICX_POR_EXT_UTL is a shared PL/SQL utility package in the APPS schema that provides logging, debugging, transaction control, and file-handling services for Oracle E-Business Suite extension and portal-related code. It is declared with AUTHID CURRENT_USER, meaning its unqualified database references resolve against the privileges of the invoking session rather than the package owner. The package is classified as OTHER in the ETRM API registry and is referenced by sixteen other packages, which indicates it functions as a common infrastructure layer rather than a business-facing API.

The dominant purpose of ICX_POR_EXT_UTL is diagnostic output. It defines a graded logging scale ranging from a suppressing NOLOG_LEVEL through MUST, ERROR, ANLYS, INFO, DEBUG, and DETIL levels, together with a package variable that holds the current threshold. Extension routines call the debug entry points to emit messages that are routed either to the file system or to the concurrent manager log, controlled by the USE_FILE_SYSTEM and USE_CONCURRENT_LOG constants. This makes the package central to troubleshooting long-running interface or portal processes where standard concurrent request logging is insufficient.

Key Procedures and Functions

• SETDEBUGLEVEL — establishes the active logging threshold, suppressing messages below the requested level.
• DEBUG — two overloads that write a diagnostic message at a specified or default severity level.
• PUSHERROR — records an error message for later retrieval or display.
• PRINTSTACKTRACE — emits the current PL/SQL call stack to assist in fault isolation.
• SETFILEPATH / GETFILEPATH — set and retrieve the virtual directory used for log file output; the default is the UTL_FILE_DIR token.
• SETUSEFILE — selects file-system output versus concurrent-log output.
• OPENLOG / CLOSELOG — open a log file in a specified mode and close it when processing completes.
• EXTCOMMIT / EXTAFCOMMIT / EXTROLLBACK — perform commit, commit-after-failure, and rollback operations with the package's configurable commit size.
• GETTABLEELEMENT — returns an element from a DBMS_SQL NUMBER_TABLE.
• GETICXSCHEMA, GETTIMESTAMP, GETDATABASEVERSION — return the ICX schema name, the current timestamp, and the database version respectively.

Tables Accessed

The package operates against a small set of system and Oracle-supplied objects reached through APPS synonyms: DBMS_SQL, DBMS_UTILITY, DUAL, PLITBLM, UTL_FILE, and V$PARAMETER. DUAL and the PL/SQL-supplied packages supply scalar values and dynamic SQL support; DBMS_UTILITY provides stack and version information; DBMS_SQL supports the table-element retrieval routine; UTL_FILE performs the actual operating-system file read and write; and V$PARAMETER is queried to obtain initialization parameter values, notably UTL_FILE_DIR. No application data tables are read or written, confirming the package's purely infrastructural role.

Usage Notes

The package is normally invoked indirectly. Extension packages, portal routines, and custom concurrent programs call SETDEBUGLEVEL, DEBUG, and OPENLOG at the start of processing, use EXTCOMMIT or EXTROLLBACK at transaction boundaries, and call CLOSELOG in cleanup sections. Because the user searched for utl_file_dir, the relevant behaviour is the file-logging path: when UTL_FILE output is selected, the destination virtual path must correspond to a valid, writable directory listed in the UTL_FILE_DIR initialization parameter for the database instance. If the path is invalid or missing, the package returns its predefined file-open error message, which explicitly instructs the administrator to verify the APPLPTMP virtual path and confirm it appears at the beginning of the UTL_FILE_DIR parameter. Under Oracle EBS 12.1.1, UTL_FILE_DIR is configured in the database initialization file; under 12.2.2, the recommended approach is directory objects, though legacy UTL_FILE_DIR behaviour may still apply depending on instance configuration. Direct invocation from Forms is uncommon, but custom code may call GETFILEPATH, GETTIMESTAMP, or GETDATABASEVERSION for environment introspection.