Results for “initialise_system_error”

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

Overview

HR_EMP_ERROR_UTILITY is a private PL/SQL utility package in the Oracle E-Business Suite APPS schema that centralizes error, warning, and status handling for employee-related Oracle Workflow transactions. Its source header (hreruweb.pkb 120.2) and internal naming confirm it supports the HR employee information workflow, providing a consistent mechanism to record errors against workflow activities, manage transaction step messages in HR_API_TRANSACTION_STEPS, and reset or abort workflow processes when processing cannot continue. The package is classified as OTHER in the ETRM and is intended for internal consumption by HR workflow and API infrastructure rather than direct end-user invocation.

Key Procedures and Functions

Twelve documented program units are exposed, centered on two themes: error message management and workflow/process control.

• SET_TRANSACT_STEP_ERROR_TEXT — Records error text against a specific HR API transaction step, the procedure referenced by the search term "set_transact_step_error_text." It is the primary means of attaching diagnostic or validation error content to a transaction step row.
• SET_TRANSACT_STEP_WARNING_TEXT — Analogous to the error variant, records non-fatal warning text against a transaction step.
• CLR_TRANSACT_STEP_MESSAGES — Clears error and warning messages previously stored on transaction step records.
• EXISTS_ERROR_TEXT — Tests whether error text has been recorded for a given context.
• EXISTS_WARNING_TEXT — Tests whether warning text has been recorded for a given context.
• INITIALISE_SYSTEM_ERROR — Establishes the internal state required before a system-level error is raised.
• RAISE_SYSTEM_ERROR — Raises a system error from within the workflow-driven process.
• ABORT_PROCESS_IN_ERROR — Terminates the current workflow process, marking it as errored.
• RESET_WORKFLOW — Resets workflow state so a process can be retried or re-executed.
• CLR_ACTIVITY_MESSAGES — Clears messages associated with a workflow activity.
• The remaining documented unit, together with the activity status logic evident in the source (SET_ACTIVITY_STATUS, invoked with item type, item key, activity ID, and status), completes the set of private helpers used to keep activity and step status synchronized.

Parameter lists are intentionally omitted here; the package exposes these units for use by the HR workflow framework, not for arbitrary caller-supplied arguments.

Tables Accessed

The package operates against four documented tables via APPS synonyms:

• HR_API_TRANSACTION_STEPS — The central store for HR API transaction step state, including the error and warning text maintained by SET_TRANSACT_STEP_ERROR_TEXT, SET_TRANSACT_STEP_WARNING_TEXT, and CLR_TRANSACT_STEP_MESSAGES.
• WF_ITEMS — Holds the workflow item instances whose status must be updated or reset.
• WF_PROCESS_ACTIVITIES — Records activity-level state for the workflow processes that the package aborts, resets, or updates.
• WF_ITEM_ATTRIBUTE_VALUES — Stores item attribute values used to identify and diagnose the failing transaction context.

These accesses confirm that the package bridges the HR API transaction layer and the Oracle Workflow engine, allowing errors detected in employee data processing to be written to HR staging tables while the corresponding workflow status is corrected.

Usage Notes

HR_EMP_ERROR_UTILITY is not exposed through a form or concurrent program; it is a supporting library invoked by other PL/SQL packages—two documented dependents reference it—and by the HR employee workflow itself. It is typically called when an HR transaction fails validation or processing, at which point the calling API records the failure via SET_TRANSACT_STEP_ERROR_TEXT, optionally flags warnings, and either aborts the process in error or resets the workflow for retry. Customizations that integrate with HR employee workflows may call these procedures to propagate error text and manage workflow state consistently, provided they run as APPS and respect the private access status. Because the error and warning procedures are the documented interface for the searched term, developers should standardize on them rather than writing directly to HR_API_TRANSACTION_STEPS or the Workflow tables, ensuring message consistency and correct interaction with the workflow engine in both 12.1.1 and 12.2.2.