Order Capture User Hooks (Doc ID 373923.1)

Last updated on JUNE 21, 2023

Applies to:

Purpose

Order Capture User Hooks

I. Introduction
II. Vertical and Custom Hooks
III. Implementing Hooks
IV. Returning Errors
V. Enabling and Disabling Hooks
VI. Notes and Recommendations

Scope

I. Purpose

User Hooks are a feature that allows customizing the application in a way that is less invasive and that can be easily disabled for diagnosing problems with the customization. Hooks are code that is conditionally executed by some application packages. The condition is that the hook has to be enabled.

Hook calls are interleaved in some of Order Capture (ASO) APIs, mostly on public APIs. There are two types of Hooks:

Pre-processing Hooks: Are hooks that execute (if enabled)Before the API does any actual processing. These are good for modifying/adding information so the API can proceed with that change in place. These hooks are of type B (from Before)

Post-processing Hooks: re hooks that execute (if enabled) After the API did all processing. Post hooks are usually good for cleanup of a pre-hook or for further processing after the vanilla API has finished work. These hooks are of type A (from After).

In an API that support hooks the following structure is observed:

[Top]

Details