Search Results generate_hdrxml




Overview
Explore in AI Chat

Overview

JTF_USR_HKS is a public PL/SQL package in the APPS schema that implements the Oracle E-Business Suite user hook and message generation framework for the CRM/Telephony (JTF) product family. The package serves two related business functions. First, it provides a generic user hook execution mechanism, allowing Oracle and customer code to determine whether a given user hook may execute for a specified package, API, process type, and hook type. Second, and more prominently, it provides the runtime engine for constructing, staging, publishing, and synchronizing business object messages exchanged between EBS and external or downstream applications, including workflow-driven message launches.

The package is defined with AUTHID CURRENT_USER and carries a header dated 2005, indicating that the interface has been stable across EBS 11i, 12.1.1, and 12.2.2. It is classified under the ETRM "OTHER" API classification, meaning it is not a standard business object API but an infrastructure utility used broadly across the JTF and adjacent modules. The documented metadata lists sixteen procedures and functions and records that the package is referenced by ninety-six other packages, confirming its role as a shared messaging dependency.

Key Procedures and Functions

  • OK_TO_EXECUTE — Function that evaluates whether a specified user hook is permitted to execute for a given package, API, process type, and hook type, returning a Boolean result.
  • WRKFLOWLAUNCH — Procedure that launches an Oracle Workflow process for a workflow item, binding data identifier, and return code.
  • GENMSGWRKFLOWLAUNCH — Procedure that launches the message-generation workflow (item type JTFMSGWF), accepting product code, business object code and name, action code, correlation identifier, bind data identifier, and OAI parameter and array inputs.
  • GENERATE_MESSAGE — Overloaded procedure used for publishing messages and for sending replies. It accepts product code, business object code and name, action code, correlation identifier, bind data identifier, and optional OAI parameters, returning a return code. The overload supports the reply path in addition to the initial publication path.
  • GET_BIND_DATA_ID — Function that obtains a bind data identifier for message processing.
  • LOAD_BIND_DATA — Procedure that loads bind data into the messaging repository.
  • PURGE_BIND_DATA — Procedure that removes bind data that is no longer required.
  • GET_USER_HOOK_ID — Function that retrieves the identifier of a user hook definition.
  • GET_BUS_OBJ_ID — Function that retrieves the identifier of a business object definition.
  • GENERATE_HDRXML — Procedure that generates the header XML for a message.
  • PUBLISH_MESSAGE — Procedure that enqueues or publishes a constructed message.
  • STAGE_MESSAGE — Procedure that stages a message prior to publication.
  • HANDLE_MSG_EXCEP — Procedure that handles messaging exceptions, including the synchronous reply path.

The package also declares the OAI_data_array_type, a VARRAY of ten VARCHAR2(50) elements used to carry OAI parameters.

Tables Accessed

  • JTF_BIND_DATA — Stores bind data referenced by the bind data identifier; read and written by the load, get, and purge procedures.
  • JTF_USER_HOOKS, JTF_USER_HOOKS_S — Define user hook configurations and their sequence; consulted by OK_TO_EXECUTE and GET_USER_HOOK_ID.
  • JTF_MESSAGE_OBJECTS — Defines message object metadata used to resolve business object identifiers and message structure.
  • JTF_HEADER_DTD — Supplies the header document type definition used by GENERATE_HDRXML.
  • JTF_MSG_ID_S, JTF_MSG_OBJ_S — Sequences supplying message and message object identifiers.
  • JTF_SYNC_REPLY_MSG — Holds synchronous reply messages for the reply path of GENERATE_MESSAGE.
  • DBMS_ALERT, DBMS_AQ, DBMS_LOB, DBMS_XMLQUERY — Supplied PL/SQL packages used for alerting, advanced queuing, large object manipulation, and XML query generation.

Usage Notes

JTF_USR_HKS is normally invoked indirectly. Message-generating APIs and user hook processing routines across the JTF, CRM, and Service modules call GENERATE_MESSAGE, GENMSGWRKFLOWLAUNCH, and the bind data procedures rather than duplicating messaging logic. The documented metadata records ninety-six referencing packages, which is consistent with its role as a central utility. Custom code should invoke the public procedures only, supplying the mandatory product code, business object code, action code, and bind data identifier, and should always inspect the returned x_return_code. Direct manipulation of the underlying JTF tables is not recommended, because message sequencing, staging, and synchronous reply handling are managed internally by the package. The presence of overloaded GENERATE_MESSAGE signatures requires callers to match the publishing or reply form precisely.