Search Results wf_setup




Overview
Explore in AI Chat

Overview

APPS.WF_SETUP is an Oracle E-Business Suite administrative package belonging to the Oracle Workflow (WF) schema family. Its principal role is to configure and maintain the infrastructure that supports the Workflow event system: local agents, database queue propagation, listeners, and scheduled DBMS_JOB entries. Rather than executing business transactions, WF_SETUP acts as a setup and maintenance layer that administrators and internal Workflow components use to establish connectivity between a local system and remote systems in a distributed Workflow environment.

The package is classified under ETRM as OTHER, reflecting its hybrid nature — it exposes both callable procedures and internal helper routines that support Oracle Workflow's System Configuration, Agent, and Queue Propagation administration pages. In EBS 12.1.1 and 12.2.2 it remains an unmodified Oracle-supplied package with AUTHID CURRENT_USER, meaning privilege checks are applied against the invoking schema.

Key Procedures and Functions

The documented API surface comprises eleven procedures and one function. Since the user searched for "create_queue," that routine warrants particular attention.

  • Create_Queue — Accepts an agent GUID and provisions the corresponding database queue required for Workflow event messaging and propagation.
  • GetLocalSystemGUID — Function returning the RAW GUID that uniquely identifies the local Workflow system.
  • Check_All — Validates the overall Workflow setup, typically invoked from the administration UI to confirm configuration consistency.
  • List_Listener / Edit_Listener — Enumerate and modify DBMS_JOB entries that run WF_EVENT.LISTEN for a local agent. Edit_Listener optionally accepts a job number to modify an existing job and a URL for redirection.
  • SubmitListener — Persists listener scheduling changes into the DBMS_JOB queue, applying run date, day, hour, minute, and second parameters supplied from the UI.
  • Edit_Propagation / SubmitPropagation — Manage DBMS_AQADM schedule propagation for outbound queues, including duration, interval, latency, and action arguments.
  • DeleteJob / DeletePropagation — Remove a listener job or a propagation schedule when an agent or queue is retired.
  • JobNextRunDate — Private function that computes the next execution timestamp for a DBMS_JOB based on day, hour, minute, and second offsets.

Tables Accessed

WF_SETUP reads and writes several Workflow metadata tables through APPS synonyms. WF_AGENTS and WF_SYSTEMS provide the agent and system identifiers that drive GUID resolution. WF_ALL_JOBS and WF_RESOURCES expose pending job and resource records used when managing listeners. ALL_DB_LINKS and USER_DB_LINKS are consulted to confirm database link availability for propagation. ALL_QUEUES, DBA_QUEUE_SCHEDULES, and GV$AQ reflect queue and propagation state. The package also calls DBMS_AQADM and DBMS_JOB directly to schedule propagation and listener execution, and uses HTF, HTP, OWA_COOKIE, and OWA_UTIL to render administrative web pages.

Usage Notes

WF_SETUP is primarily invoked from Oracle Workflow's administrator web interface rather than from custom code. The Create_Queue, Edit_Listener, and Edit_Propagation routines are triggered when an administrator saves configuration changes on the Agent, System, or Queue Propagation pages. SubmitListener and SubmitPropagation are called on the resulting form submissions. Check_All is used for diagnostic validation. Custom integrations rarely call these routines directly; where they do, the routines are typically used to programmatically register a new agent, queue, or propagation schedule during a multi-node Workflow topology deployment. Because the package is owned by APPS and marked AUTHID CURRENT_USER, any calling code must execute with sufficient privileges on DBMS_JOB, DBMS_AQADM, and the Workflow synonym set. The package is referenced by at least one other Workflow package, confirming its role as a shared setup utility.