Results for “hr_emp_error_utility”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

HR_EMP_ERROR_UTILITY is an APPS-owned PL/SQL package classified under the OTHER API category in Oracle E-Business Suite. It provides the shared error-handling and workflow-recovery infrastructure used by Oracle HRMS employee and user-registration transactions. Rather than performing business validation itself, the package centralises the mechanics of surfacing errors to the end user, recording diagnostic text against transaction steps, and cleaning up stranded Oracle Workflow processes when an HR transaction fails.

This utility sits at the intersection of the HR transaction framework and the Workflow engine. Employee hire, rehire, assignment change, and new-user registration flows are orchestrated as workflow items whose progress is tracked in HR_API_TRANSACTION_STEPS. When a step raises a fatal condition, the calling process needs a consistent way to mark the step as failed, attach a readable message, abort the workflow, and reset any partially completed state. HR_EMP_ERROR_UTILITY supplies exactly those operations, which is why it is referenced by HR_NEW_USER_REG_SS and HR_TRANSACTION_SS — the two primary server-side entry points for these flows.

Key Procedures and Functions

The ETRM metadata documents twelve procedures and functions. The principal ones are:

• RAISE_SYSTEM_ERROR — Raises an unexpected or internal (system) error, typically when the failure is not attributable to user input. It allows the calling transaction to fail in a controlled manner while preserving diagnostic context.
• INITIALISE_SYSTEM_ERROR — Sets up the error state prior to raising, ensuring any previously accumulated messages are cleared and the error structures are ready for use.
• ABORT_PROCESS_IN_ERROR — Terminates the workflow process that owns the failing transaction, moving it to an error status so it is not left running or retried indefinitely.
• RESET_WORKFLOW — Restores workflow state, allowing a process that was previously marked in error to be re-driven or cleaned up.
• CLR_TRANSACT_STEP_MESSAGES — Clears messages recorded against transaction steps, used at the start of a retry or reprocessing cycle.
• CLR_ACTIVITY_MESSAGES — Clears messages attached to workflow process activities, the activity-level counterpart to the step-level cleanup.
• SET_TRANSACT_STEP_ERROR_TEXT and EXISTS_ERROR_TEXT — Write and test for error text on a transaction step, supporting both message population and conditional handling.
• SET_TRANSACT_STEP_WARNING_TEXT and EXISTS_WARNING_TEXT — The equivalent pair for non-fatal warnings, allowing a step to record advisory text without aborting the process.

Tables Accessed

• HR_API_TRANSACTION_STEPS — The core table for HR transaction step tracking. The package reads and writes step status and message columns here, forming the basis of all SET/CLR/EXISTS operations.
• WF_ITEMS — Holds the workflow item representing the running HR process; used when aborting or resetting a process in error.
• WF_PROCESS_ACTIVITIES — Identifies the specific activity within the workflow, required for activity-level message cleanup.
• WF_ITEM_ATTRIBUTE_VALUES — Stores workflow item attributes, referenced when inspecting or resetting process state.

Usage Notes

HR_EMP_ERROR_UTILITY is an internal framework package rather than a public API. It is not invoked directly from Oracle Forms; instead it is called by the HR server-side packages (HR_NEW_USER_REG_SS, HR_TRANSACTION_SS) and by HR_EMP_ERROR_UTILITY's own dependent code when a transaction fails. Custom code that programmatically drives HR transactions — for example, a concurrent program performing bulk hires — may call these procedures to emulate standard error handling, but doing so requires an active workflow item and transaction step context. Because the package manipulates Workflow tables directly, incorrect use can leave processes in an inconsistent state, so it is normally reserved for framework code and Oracle-supported extensions.