Search Results pa_workflow_utils




Overview
Explore in AI Chat

Overview

PA_WORKFLOW_UTILS is a server-side PL/SQL package body owned by the APPS schema that provides utility services for the Oracle Workflow integration implemented within Oracle Project Costing and Oracle Projects. Its central role is to encapsulate the mechanics of creating, starting, monitoring, and cancelling Oracle Workflow processes that are associated with project records such as project status changes, project approvals, and notification-driven business events. Rather than requiring each Project module to construct low-level calls to WF_ENGINE and WF_CORE directly, PA_WORKFLOW_UTILS exposes a stable, Projects-specific abstraction over the generic Workflow APIs and stores associated metadata in Projects-owned tables.

The package is documented as VALID in ETRM metadata and is classified under API classification OTHER, indicating it is primarily an internal utility rather than a public, externally published API. It is referenced by 23 other database objects, confirming that it functions as a shared infrastructure component consumed across the Projects suite.

Key Procedures and Functions

ETRM documents nine procedures and functions within the package body:

  • INSERT_WF_PROCESSES — Inserts a row into PA_WF_PROCESSES, registering a workflow process definition or instance against a Projects entity so it can be tracked and retrieved later.
  • SET_GLOBAL_ATTR — Sets a Workflow global attribute, allowing contextual values required by the workflow definition to be established before a process is started.
  • SET_NOTIFICATION_MESSAGES — Populates or resolves notification message text, typically by invoking FND_MESSAGE and FND_MSG_PUB to load Application Object Library messages for use in workflow notifications.
  • GET_APPLICATION_ID — Returns the Oracle Application Object Library application identifier associated with the Projects context, supplying the application ID required by Workflow engine calls.
  • GET_WORKFLOW_INFO — Retrieves stored workflow information, providing callers with the item key, process name, or status details recorded for a Projects entity.
  • CANCEL_WORKFLOW — Terminates an active workflow process, typically by invoking WF_ENGINE to abort or complete the item when a business transaction is reversed or abandoned.
  • CREATE_WORKFLOW_PROCESS — Creates a Workflow process instance and records the generated item key, commonly persisting it through PA_WORKFLOW_ITEMKEY_S.
  • START_WORKFLOW_PROCESS — Launches the created process through WF_ENGINE so that notifications and subsequent activities are dispatched.
  • MODIFY_WF_CLOB_CONTENT — Manipulates CLOB content associated with workflow data, using DBMS_LOB for large-object handling.

Tables Accessed

The package operates against the following documented tables, accessed through APPS synonyms:

  • PA_WF_PROCESSES — The primary staging and tracking table for workflow process records associated with Projects entities.
  • PA_WORKFLOW_ITEMKEY_S — The sequence used to generate unique Workflow item keys for newly created processes.
  • PA_PAGE_CONTENTS — Supplies page content or message text used when constructing notification bodies.
  • PA_PROJECT_STATUSES — Provides project status definitions referenced when determining which workflow to trigger.
  • FND_RESPONSIBILITY — Resolves responsibility information, for example to identify notification recipients.
  • DBMS_LOB and DUAL — Used for large-object manipulation and simple scalar queries respectively.

Usage Notes

PA_WORKFLOW_UTILS is normally invoked indirectly rather than called by end users. Typical invocation paths include Projects forms and concurrent programs that initiate approval or notification workflows, and other Projects PL/SQL packages — the 23 documented referencing objects — that delegate workflow handling to this utility. Custom extensions should call the package through the APPS schema, supplying the correct application ID and item key context, and should rely on the internal error handling provided by FND_API, FND_MSG_PUB, PA_DEBUG, and PA_INTERFACE_UTILS_PUB. Because the package depends on WF_ENGINE, WF_CORE, and FND_PROFILE, Workflow must be installed and configured, and the relevant Projects profile options must be set for processes to start and route correctly. Direct DML against PA_WF_PROCESSES is discouraged; the documented procedures should be used to maintain consistency with the Workflow engine.