Search Results get_custom_status

Overview

OKS_CODE_HOOK is a client extension hook package owned by APPS within the Oracle Service Contracts (OKS) module of Oracle E-Business Suite. It is defined with AUTHID CURRENT_USER, meaning that its procedures execute with the privileges of the invoking user rather than the definer. The package provides a controlled extension framework through which customers can override or supplement standard Service Contracts processing logic without modifying Oracle-seeded code. Each hook procedure follows a consistent convention: an OUT parameter (typically named x_hook) signals whether the hook was used, returning 1 when custom logic executed, 0 when the standard behavior should apply, and -1 when an error occurred. This design allows Oracle's core Service Contracts programs to call the hook unconditionally and branch based on the returned value. The package is referenced by eight other packages in the EBS instance, confirming its role as a cross-cutting extension point relied upon by billing, tax, and contract merge processing flows. The source header indicates the package has been maintained across multiple releases, with a last recorded revision in 2013 corresponding to the 12.1.1 and 12.2.2 code lines.

Key Procedures and Functions

• TAX_TRX_DATE — Sets the transaction date used for tax calculation on a contract. It receives contract header and line identifiers plus header and line start dates, and returns the hook status along with the computed transaction date.
• BILLING_INTERFACE_ST_DATE — A client extension introduced for bug 7668259 that allows an alternative approach when running the Service Contracts main billing program. It returns the hook status, a billing interface start date, and a hint whose only permitted value is "FULL", indicating parallel thread processing behavior.
• CALC_HEADER_AMT — Added for bug 5073827, this extension permits an alternate calculation of the contract header amount and header tax. It accepts the contract header identifier and returns the hook status, header tax amount, and total header amount.
• CUSTOM_FUNCTION — Added for bug 7687114, providing a general-purpose extension function for customer-defined logic.
• DATE_ASMBLR_FN and CUSTOM_DA_PRC — Functions and procedures supporting custom date assembly processing within the Service Contracts framework.
• GET_CUSTOM_STATUS — Retrieves a custom status value for contract processing.
• UPDATE_MERGE_ACCOUNT — The procedure corresponding to the user's search term. It supports account-level merge processing, allowing contract and related account data to be redirected or updated when parties or accounts are merged.
• UPDATE_PARTY_MERGE — Companions the account merge logic, handling party merge events so that contract records continue to reference valid party identifiers after a merge.
• GET_CONTRACT_SOURCE_DETAILS — Returns source detail information for a contract.
• GET_SUBS_QTY and GET_SUBS_UOM — Return subscription quantity and unit of measure values respectively for use in contract and billing calculations.

Tables Accessed

The package interacts with Service Contracts and Order Management base tables through APPS synonyms. OKC_K_HEADERS_B and OKC_K_LINES_B supply contract header and line data, while OKC_CLASS_OPERATIONS and OKC_OPERATION_INSTANCES provide the class and operation definitions that drive hook invocation points; OKC_OPERATION_LINES links operations to specific lines. OE_ORDER_HEADERS_ALL and OE_ORDER_LINES_ALL are referenced for order data that feeds billing interface and merge processes. These tables collectively support tax date determination, header amount calculation, and the account and party merge hooks.

Usage Notes

OKS_CODE_HOOK is not invoked directly by end users. Core Service Contracts concurrent programs and forms call its procedures at specific extension points, most notably the main billing program, tax calculation, header amount rollup, and the party and account merge processes. Customers implement their logic by copying the package and populating the hook body; the x_hook return value governs whether the standard path executes. Because UPDATE_MERGE_ACCOUNT and UPDATE_PARTY_MERGE participate in merge processing, customizations here must be regression-tested whenever the Trading Community Architecture merge routines are patched. Custom code should preserve the documented return conventions and avoid committing transactions, since the calling programs manage transaction boundaries.