Results for “jtf_user_hooks”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

JTF_USER_HOOKS is a CRM Foundation (JTF) table that records the execution status of user hooks registered within Oracle E-Business Suite. A "user hook" is a customer-defined extension point that allows custom PL/SQL logic to be injected into standard product flows — for example, at the completion of a service request, a campaign activity, or a lead conversion. This table acts as the control registry that determines which hook packages exist, which product and API they are bound to, how they are invoked, and whether they are currently enabled for execution.

The object is owned by the JTF schema and is marked VALID in both 12.1.1 and 12.2.2. The documented physical schema in ETRM 12.2.2 lists 17 columns. From a heuristic Data Vault modeling perspective, the mined relationship data classifies this object as standalone, suggesting it be modeled as a hub-like reference entity rather than a dependent satellite or link; no foreign-key dependencies were detected in the metadata. The table therefore functions as a self-contained configuration and status register rather than a transactional fact table.

Key Information Stored

Two unique indexes govern the table. The surrogate-oriented primary key is JTF_USER_HOOKS_PK, defined over the composite business columns API_NAME, USER_HOOK_TYPE, PKG_NAME, PROCESSING_TYPE, and PRODUCT_CODE. A second unique index, JTF_USER_HOOKS_U3, repeats the identical column set, reinforcing that combination as the true business key. Because the composite itself carries a generated identifier column, USER_HOOK_ID serves as the row-level surrogate.

• USER_HOOK_ID — surrogate identifier for the hook registration row.
• API_NAME — the application programming interface or entry point to which the hook is attached.
• USER_HOOK_TYPE — classifies the hook (for example, before-insert, after-update, or similar lifecycle category).
• PKG_NAME — the PL/SQL package implementing the custom hook logic.
• PROCESSING_TYPE — defines how the hook is processed (synchronous, asynchronous, or batch).
• PRODUCT_CODE — identifies the owning CRM product module; this is the column most frequently searched by users.
• EXECUTE_FLAG — controls whether the hook is currently active or suppressed.
• CREATED_BY / CREATION_DATE — standard WHO audit columns capturing registration origin.
• LAST_UPDATED_BY / LAST_UPDATE_DATE / LAST_UPDATE_LOGIN — track the most recent modification of the hook status.
• ATTRIBUTE1 through ATTRIBUTE5 — descriptive flexfield (DFF) segments for customer-defined metadata.

The five-column business key guarantees that a given package can only be registered once per combination of API, hook type, processing type, and product.

Common Use Cases and Queries

Administrators and technical consultants query this table primarily to audit customizations after cloning, patching, or upgrades, and to confirm which hooks are enabled and where. A frequent search filters by PRODUCT_CODE:

• Locate all enabled hooks for a product: SELECT pkg_name, api_name, user_hook_type, execute_flag FROM jtf.jtf_user_hooks WHERE product_code = :p_code;
• Audit disabled hooks prior to a release: SELECT user_hook_id, api_name, pkg_name FROM jtf.jtf_user_hooks WHERE execute_flag = 'N';
• Trace the package behind a specific hook: join on PKG_NAME and API_NAME to identify the implementation.
• Report hook inventory by processing type for performance planning.

Because execution status drives whether custom code fires at runtime, this table is a critical reference during troubleshooting of unexpected behavior introduced by extensions.

Related Objects

The metadata identifies no foreign-key relationships, consistent with the standalone classification. Practical dependencies are driven by the business-key columns rather than enforced constraints:

• JTF_USER_HOOKS_PK and JTF_USER_HOOKS_U3 — the unique indexes defining row identity.
• Custom PL/SQL packages referenced by PKG_NAME — the actual hook implementations registered here.
• JTF APIs / entry points referenced by API_NAME — the invocation points that call registered hooks.
• Product definitions referenced by PRODUCT_CODE — the CRM module owning each hook.
• JTF_OBJECTS / JTF_AMV_* — commonly consulted alongside this table for CRM Foundation configuration context.

Any reporting on custom extensions should treat JTF_USER_HOOKS as the authoritative registry linking products, APIs, and hook packages.