Search Results wf_agents_pkg




Overview
Explore in AI Chat

Overview

WF_AGENTS_PKG is a workflow configuration repository package that manages the definition, maintenance, and lifecycle of agents within the Oracle E-Business Suite Workflow engine. Agents represent the addressing abstraction through which the Business Event System routes and delivers event messages: each agent associates a protocol, an address, a queue handler, and a queue name with a registered subscriber or system. In EBS 12.1.1 and 12.2.2, the agent catalog is the foundation for outbound and inbound event delivery between application modules, between EBS and external systems via AQ or similar queue transports, and between the Workflow Notification Mailer and recipients.

The package encapsulates the CRUD operations against the WF_AGENTS table so that application code, concurrent processes, and setup utilities do not manipulate agent rows directly. It is classified as an API package under the APPS schema and is referenced by three other packages, indicating it is a shared dependency in the workflow event infrastructure rather than a leaf utility.

Key Procedures and Functions

  • INSERT_ROW — Creates a new agent definition, inserting attributes such as GUID, name, system GUID, protocol, address, queue handler, queue name, direction, status, display name, description, type, and java queue handler. On success it raises the workflow business event oracle.apps.wf.event.agent.create; if the row cannot be reselected by GUID, it raises NO_DATA_FOUND.
  • UPDATE_ROW — Modifies an existing agent definition, updating the same set of descriptive and routing attributes addressed by the insert path. This is the mechanism used to change queue names, protocols, or status without recreating the agent.
  • DELETE_ROW — Removes an agent definition from the WF_AGENTS repository.
  • LOAD_ROW — Loads or seeds agent data, typically used by setup and upgrade routines to populate or refresh agent definitions.
  • GENERATE — Produces the runtime representation or generated artifacts required for the agent, such as the queued delivery configuration used by the event system.
  • RECEIVE — Handles inbound receipt of a message through the agent, resolving the agent's queue handler and queue name into an invocation of the associated workflow or event processing logic.

Tables Accessed

The package operates primarily on WF_AGENTS, the master repository of agent definitions. Every CRUD operation in the package targets this table: INSERT_ROW populates it, UPDATE_ROW and DELETE_ROW maintain it, and LOAD_ROW seeds it. The GUID column acts as the logical key, and the row is re-selected after insert to return the ROWID to the caller.

The package also references XMLDOM, an XML DOM helper used when agent payloads or generated configuration must be parsed or assembled as XML. This reflects the event system's dependence on XML message envelopes. Column-level metadata, including queue_name and queue_handler, is what enables the Workflow Agent Listener and outbound queue processing to resolve a logical agent to a physical queue at runtime.

Usage Notes

WF_AGENTS_PKG is typically invoked indirectly rather than from end-user forms. The Workflow Administrator responsibility and the Business Event System setup screens call these procedures through the underlying agent maintenance forms and concurrent request wrappers. Upgrades and patches that introduce new agents or adjust existing queue assignments invoke LOAD_ROW and GENERATE as part of seed data processing.

Custom integrations that dynamically create agents — for example, provisioning a new subscriber with its own queue — call INSERT_ROW and UPDATE_ROW rather than issuing DML against WF_AGENTS directly, ensuring the agent.create event is raised and downstream caches remain consistent. The exception handler wraps failures with wf_core.context for diagnostic purposes, so callers should surface the resulting error stack. Note that INSERT_ROW raises the create event only after the row is confirmed present by GUID and raises NO_DATA_FOUND otherwise; code surrounding custom inserts must therefore tolerate that exception on retry.