Search Results jtf_msg_obj_s

Overview

APPS.JTF_USR_HKS is the user-hook services package body within the Oracle E-Business Suite CRM Technology Foundation (JTF) schema. Its principal business function is to provide a controlled extension mechanism through which customers and integrators can inject custom pre-processing and post-processing logic into standard CRM APIs without modifying shipped code. The package resolves whether a user hook is enabled for a given package, API, processing type, and hook type by consulting the JTF_USER_HOOKS registry, and it supplies the supporting infrastructure for launching workflows and generating asynchronous messages. In addition to hook gating, JTF_USR_HKS implements the plumbing used by the JTF messaging architecture to stage, publish, and deliver messages and to launch workflow processes that do not themselves generate user-facing messages. The package is therefore a shared utility layer: 96 other packages reference it, indicating that hook evaluation and message handling are invoked from a large number of CRM flows, including service requests, subscriptions, and interaction tracking. The header identifies the source as JTFUHKSB.pls, version 120.4, last shipped in October 2005, so the implementation is stable and unchanged across the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

The package exposes 16 documented procedures and functions. OK_TO_EXECUTE is the hook gate: it reads the EXECUTE_FLAG from JTF_USER_HOOKS for the supplied package, API, processing type, and user hook type, and returns FALSE when no row exists or when the flag is not 'Y'. When the flag is 'Y', it further inspects the concurrent program context, returning TRUE for a null program context and suppressing execution for designated concurrent program and hook type combinations. WRKFLOWLAUNCH starts a non-message-generating workflow, accepting an item type, item process name, item key, and bind data identifier, and returning an out return code. GENMSGWRKFLOWLAUNCH performs the equivalent launch for message-generating workflows. GENERATE_MESSAGE, PUBLISH_MESSAGE, and STAGE_MESSAGE cover message construction, publication to the queue, and staging for later delivery, while HANDLE_MSG_EXCEP provides exception handling for failed message operations. Bind data support is provided by GET_BIND_DATA_ID, LOAD_BIND_DATA, and PURGE_BIND_DATA, which manage the lifecycle of workflow bind variables. GET_USER_HOOK_ID and GET_BUS_OBJ_ID resolve surrogate identifiers for hooks and business objects, and GENERATE_HDRXML produces header XML for messages.

Tables Accessed

The package reads and writes JTF_USER_HOOKS and its sequence-backed table JTF_USER_HOOKS_S to store hook definitions and identifiers. JTF_BIND_DATA holds the bind name, bind value, and data type records consumed during workflow launches. JTF_MESSAGE_OBJECTS and JTF_MSG_OBJ_S define message object metadata, while JTF_MSG_ID_S supplies message identifiers. JTF_HEADER_DTD and JTF_SYNC_REPLY_MSG support header XML generation and synchronous reply handling respectively. Utility access is made to DUAL, DBMS_ALERT, DBMS_AQ, DBMS_LOB, and DBMS_XMLQUERY for alerting, advanced queuing, large object manipulation, and XML query generation.

Usage Notes

JTF_USR_HKS is normally invoked indirectly. Standard CRM APIs call OK_TO_EXECUTE before running customer hook code, and the workflow and messaging entry points are called by the JTF messaging framework and by concurrent programs that dispatch outbound messages. Because the package is referenced by 96 other packages, changes to its behavior have broad reach and should be treated as high impact. Customizations should register hooks in JTF_USER_HOOKS rather than altering this package body, and bind data created for workflow launches should be purged after use to avoid table growth.