Search Results undo_header

Overview

OKS_COVERAGES_PUB is the public service-layer API for Oracle Service Contracts (OKS) coverage records in Oracle E-Business Suite. Coverage records represent the actual service entitlement lines generated against a service contract — the operational artifacts that determine whether a given item, serial number, or installed base instance is entitled to service, and for what period. The package exposes a controlled, message-enabled PL/SQL interface that forms, concurrent programs, and external integrations use to create, adjust, version, and reverse coverage data without touching the underlying Service Contracts base tables directly.

The package is declared AUTHID CURRENT_USER and is owned by APPS, making it a standard public API (classification PUB in ETRM). Its declaration block defines the conventional API constants — G_PKG_NAME, G_APP_NAME (mapped to OKC_API.G_APP_NAME), the unexpected-error token OKC_CONTRACTS_UNEXPECTED_ERROR, and the G_SQLERRM_TOKEN/G_SQLCODE_TOKEN pairs — plus the G_EXCEPTION_HALT_VALIDATION exception used to abort processing when validation fails. The source header identifies the file as OKSPMCVS.pls.

The package metadata documents thirteen procedures and functions, indicating a broad functional scope covering the full coverage lifecycle rather than a single operation. The "undo_header" search term that surfaced this object points directly to UNDO_HEADER, the rollback routine for a coverage header.

Key Procedures and Functions

The documented entry points, each following the standard EBS API signature convention of p_api_version, p_init_msg_list, and the x_return_status/x_msg_count/x_msg_data OUT parameters, are:

• CREATE_ACTUAL_COVERAGE — Creates an actual coverage record from an input record of type OKS_COVERAGES_PVT.ac_rec_type, with a p_restricted_update flag and an OUT parameter returning the new coverage identifier.
• UNDO_HEADER — Reverses or rolls back a coverage header identified by P_Header_id, removing its effect from the coverage structure.
• UNDO_LINE — Performs the equivalent rollback at line level, driven by P_Line_Id.
• UPDATE_COV_EFF — Updates the effective start and end dates of coverage associated with a given P_service_Line_Id.
• INSTANTIATE_COVERAGE — Generates coverage instances from a template or contract definition.
• DELETE_COVERAGE — Removes a coverage record.
• CHECK_COVERAGE_MATCH — Validates whether coverage matches the expected criteria before further processing.
• CREATE_ADJUSTED_COVERAGE — Creates a coverage record that reflects an adjustment to an existing coverage.
• OKS_BILLRATE_MAPPING — Handles mapping between coverage data and billing rate structures.
• VERSION_COVERAGE — Produces a new version of an existing coverage record.
• RESTORE_COVERAGE — Restores a coverage to a prior or saved state.
• DELETE_HISTORY — Purges historical coverage records.
• DELETE_SAVED_VERSION — Removes a stored coverage version.

Together these procedures support creation, adjustment, versioning, reversal, and cleanup, which is consistent with the versioning model that Service Contracts applies to contract and coverage data.

Tables Accessed

The ETRM metadata documents two referenced tables, both reached through APPS synonyms:

• OKC_K_ITEMS — the contract line item table. Coverage records are anchored to contract items, so this table supplies the parent context for header- and line-level operations such as creation and undo.
• OKC_K_LINES_B — the base contract lines table, providing the line-level context that UNDO_LINE, UPDATE_COV_EFF, and INSTANTIATE_COVERAGE require in order to locate and modify the correct coverage rows.

Coverage-specific detail is managed through the private package OKS_COVERAGES_PVT, which supplies the ac_rec_type subtype referenced in the public declarations; the public package therefore delegates most direct data manipulation to its private counterpart.

Usage Notes

OKS_COVERAGES_PUB is invoked primarily from the Service Contracts forms and from concurrent programs that generate, adjust, or expire coverage. The metadata records that the package is referenced by eleven other packages, which indicates it sits close to the center of the OKS API dependency graph and that internal OKS processing calls it rather than manipulating coverage tables directly. Custom code and external integrations should call these procedures instead of performing DML on OKC_K_ITEMS or OKC_K_LINES_B.

Because the procedures expose the standard message stack, callers must initialize it via p_init_msg_list and must inspect x_return_status and drain x_msg_count/x_msg_data after every call. UNDO_HEADER and UNDO_LINE are destructive reversals and should be called with the same care as the original creation call, typically within a transaction that the caller controls. The presence of both versioning and deletion routines means callers should prefer VERSION_COVERAGE and RESTORE_COVERAGE for reversible change and reserve the delete procedures for genuine purge scenarios.