Search Results get_message_details

Overview

The PAY_US_WORKFLOW_API_PKG package is a PL/SQL API owned by the APPS schema that provides the programmatic interface used by the Oracle Payroll Process Workflow (part of the Oracle Human Resources and Payroll suite). Its declared purpose in the package header is to support the Payroll Process Workflow — the Oracle Workflow-driven framework that manages the lifecycle of a payroll run, from process submission and input checking through processing, error handling, and notification delivery. The package was originally created in June 2003 by jgoswami (version 115.0) and was subsequently enhanced. The current shipped header revision is 120.1, dated 15-JUL-2011.

The package declares AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking user rather than the definer. This is significant for deployments that call the package from custom code: the calling schema must itself have the required object privileges on the underlying payroll and workflow tables (typically granted through APPS synonyms). The package is classified as API type OTHER and is not referenced by any other documented package, so it functions as a top-level entry point rather than a shared internal library.

Key Procedures and Functions

ETRM documents fourteen procedures and functions. The package defines two PL/SQL record and collection types — attribute_data_rec (carrying workflow item type, item key, attribute name, and attribute value) and cp_rqid_data_rec (carrying workflow item type, item key, concurrent program short name, and request ID), with a corresponding attribute_data_tab table type. These types underpin the attribute and request-ID handling routines.

• GET_MESSAGE_DETAILS — Returns the detail content of a workflow notification message for a payroll workflow item, allowing callers to retrieve the descriptive text associated with a message or notification.
• GET_ASSIGNMENT_INFO — Retrieves assignment-level information for the payroll workflow context.
• GETRETROINFORMATION / GETRETROENHANCEDINFO — Return retroactive payroll information; the enhanced variant (added in version 115.4, bug 12704242, July 2011) supports the extended retro processing model.
• POST_NOTIFICATION_SET_ATTR — Sets workflow item attributes in conjunction with posting a notification.
• GET_PARAMETER — Reads a named parameter value used during workflow execution.
• SET_ATTR_VALUE / GET_ATTR_VALUE — Generic setters and getters for workflow item attribute values.
• GET_VALUE / SET_VALUE — Generic accessors for package-internal or context values.
• GET_BATCH_DETAILS — Returns batch-level details for a payroll process.
• EXECUTECONCPROGRAM — Submits a concurrent program from within the workflow (added in version 115.1, bug 3006871).
• CHECKPROCESSINPUTS — Validates the inputs supplied to a payroll process (added in version 115.1).
• ISRESPONSEREQUIRED — Indicates whether a response is required from the notification recipient (added in version 115.3, bug 3316422).

Tables Accessed

• WF_ITEMS — Holds workflow item type and item key values, the anchoring identifiers used by nearly every routine in the package.
• HR_ASSIGNMENT_SETS — Supplies assignment set information used by GET_ASSIGNMENT_INFO.
• PAY_ALL_PAYROLLS_F — Provides payroll definitions relevant to the payroll process workflow.
• PAY_ASSIGNMENT_ACTIONS — Stores action-level results for assignments processed by a payroll run.
• PAY_PAYROLL_ACTIONS — Stores payroll action records (run, reversal, and related actions) that drive workflow state.
• PAY_RETRO_ASSIGNMENTS — Identifies assignments with retroactive changes, supporting the retro-information routines.

Usage Notes

The package is invoked by the Payroll Process Workflow itself as the Oracle Workflow engine executes the payroll process definition; it is not normally called directly by end users. Because it is declared AUTHID CURRENT_USER, custom code that calls these routines must own the necessary privileges on the referenced tables or be granted access through the standard APPS synonym layer. The presence of EXECUTECONCPROGRAM and CHECKPROCESSINPUTS indicates the package is also used to launch and pre-validate concurrent programs that are chained from a workflow process. Since the package is not referenced by any other documented package, diagnostics for the workflow, including retrieval of get_message_details output, should be performed against the workflow notification tables and the PAY_PAYROLL_ACTIONS records the package maintains.