Search Results okl_header_interface




Overview
Explore in AI Chat

Overview

The OKL_HEADER_INTERFACE table is the open interface header table for Oracle Leasing and Finance Management (OKL), the ETRM module within Oracle E-Business Suite 12.1.1 and 12.2.2. It serves as the staging and inbound landing structure through which external contract header data is loaded into the OKL application before validation and transfer into the production contract tables. Records written here by external systems, conversion routines, or third-party integrations are processed by the OKL contract import program, which reads the header row, resolves the attached line detail, performs validation, and creates or updates the corresponding contract in the operational schema.

The table resides in the OKL schema and is a wide, denormalized structure of 422 documented columns in the 12.2.2 physical schema. Its breadth reflects the fact that it must accommodate every configurable attribute of an OKL contract header, including pricing, rate, end-of-term and early-termination quote parameters, insurance, lien and title registration, tax, factoring, and portfolio assignment attributes. The Data Vault classification mined from the foreign key structure is standalone, meaning the table references other entities but is not itself referenced by dependent tables; as a modeling suggestion, it behaves as a staging or source satellite rather than a hub or link, since it is transient in nature and is purged or superseded once import completes.

Key Information Stored

The table is keyed operationally by BATCH_NUMBER, which groups a set of interface records submitted together, and by a contract identity tuple. IMPORT_REQUEST_ID and IMPORT_REQUEST_STAGE track the import submission and its processing stage, while STATUS carries the processing state of the interface row. DELETE_BEFORE_IMPORT_YN controls whether an existing contract is replaced during import. ST_UPDATE_LINES_FROM_CONTRACT governs whether line-level attributes are refreshed from the contract.

Business-key candidates include CONTRACT_NUMBER, CONTRACT_NUMBER_OLD, CUSTOMER_NUMBER, and CUSTOMER_ACCOUNT_NUMBER, which identify the target contract and the counterparty. CUSTOMER_ID, CUSTOMER_ACCOUNT_ID, PRODUCT_ID, LEGAL_ENTITY_ID, INVOICE_FORMAT_ID, AUTHORING_ORG_ID, and SALESPERSON_ID are the confirmed foreign key columns documented for this table. Core commercial attributes include START_DATE, TERM, CURRENCY_CODE, CONTRACT_CATEGORY, DEAL_TYPE_CODE, ACCEPTED_DATE, DATE_SIGNED, and DATE_APPROVED. Financial and pricing controls include END_OF_TERM_OPTION, MID_TERM_OPTION, SECURITY_DEPOSIT_HOLD_FLAG, VARIABLE_RATE, INTEREST_METHOD, INTEREST_START_DATE, BASE_RATE, and DAYS_IN_YEAR. Descriptive and tracking columns such as CONTRACT_DESCRIPTION, APPLICATION_CODE, DATE_CREATED_IN_OKL, and SCHEDULED_WORKER_ID complete the operational picture.

Common Use Cases and Queries

Typical use cases include monitoring pending loads, troubleshooting rejected rows, and reconciling interface volumes against successfully created contracts. A frequent pattern is to isolate failed or unprocessed rows by status and batch:

  • SELECT BATCH_NUMBER, CONTRACT_NUMBER, STATUS, IMPORT_REQUEST_ID, DATE_CREATED FROM OKL.OKL_HEADER_INTERFACE WHERE STATUS = 'ERROR' ORDER BY BATCH_NUMBER;
  • SELECT BATCH_NUMBER, COUNT(*) FROM OKL.OKL_HEADER_INTERFACE GROUP BY BATCH_NUMBER ORDER BY BATCH_NUMBER;
  • SELECT H.CONTRACT_NUMBER, H.CUSTOMER_NUMBER, H.PRODUCT_ID FROM OKL.OKL_HEADER_INTERFACE H WHERE H.IMPORT_REQUEST_STAGE = 'VALIDATED' AND H.LEGAL_ENTITY_ID = :p_legal_entity;

Reporting consumers typically join the interface row to FV_LEGAL_ENTITIES, FND_DM_PRODUCTS, and PA_INVOICE_FORMATS to resolve descriptive names for audit and conversion reconciliation reports, and compare interface counts with staged customer and customer account records before committing an import run.

Related Objects

The documented foreign keys tie this interface to the following reference and master objects:

  • FND_DM_PRODUCTS, joined on OKL_HEADER_INTERFACE.PRODUCT_ID = FND_DM_PRODUCTS.PRODUCT_ID, resolves the leasing product definition.
  • PA_INVOICE_FORMATS, joined on OKL_HEADER_INTERFACE.INVOICE_FORMAT_ID = PA_INVOICE_FORMATS.INVOICE_FORMAT_ID, supplies the billing invoice format.
  • FV_LEGAL_ENTITIES, joined on OKL_HEADER_INTERFACE.LEGAL_ENTITY_ID = FV_LEGAL_ENTITIES.LEGAL_ENTITY_ID, identifies the owning legal entity.
  • The corresponding OKL line interface table, which parallels the header and carries the contract line detail consumed by the same import process.
  • The OKL production contract header tables, into which validated interface rows are transferred.
  • OKL contract import concurrent programs and their submission parameters, which drive processing of this table.

Because the object is classified as standalone, no dependent tables reference it directly; the dependency flows one way, from the interface into the operational OKL contract structures.