Search Results ben_batch_rate_info_api




Overview
Explore in AI Chat

Overview

The APPS.BEN_BATCH_RATE_INFO_API package is a public PL/SQL API within the Oracle E-Business Suite Advanced Benefits (Benefits) module. It provides the programmatic interface for maintaining batch rate information records stored in the BEN_BATCH_RATE_INFO table. Batch rate information is used during benefits processing to hold rate, coverage, and cost values that are applied to a group of participants in a single batch operation rather than being entered individually. The package encapsulates the create, update, and delete operations required to keep these records synchronized with the benefits engine, insulating callers from the underlying table structure and from the validation and date-tracking logic that Benefits requires for its datetracked entities.

The package is classified in the ETRM repository with a status of VALID under the APPS schema and is treated as an API rather than a private helper package. It depends on the HR_API package, which supplies common Human Resources date-tracked API utilities, and on the SYS.STANDARD package. It is itself referenced by other Benefits packages, confirming its role as a shared, callable interface within the module.

Key Procedures and Functions

The ETRM metadata documents four callable units in this package:

  • CREATE_BATCH_RATE_INFO — Inserts a new batch rate information record. It is the entry point used when rate details must be established for a batch process that does not yet have them.
  • UPDATE_BATCH_RATE_INFO — Modifies an existing batch rate information record. It supports correction or adjustment of previously established rate data.
  • DELETE_BATCH_RATE_INFO — Removes a batch rate information record that is no longer required, typically when a batch scenario is abandoned or superseded.
  • LCK — A locking routine, conventionally used to obtain a row-level lock on the target record before an update or delete, ensuring concurrency safety when multiple sessions process the same batch.

Detailed parameter lists are not reproduced here; callers should reference the package specification in the target environment, as signatures can vary between patch levels.

Tables Accessed

The package operates against a single documented table, BEN_BATCH_RATE_INFO, accessed through an APPS synonym. This table stores the batch rate records that CREATE, UPDATE, and DELETE manipulate. The LCK routine reads the same table to identify and lock the row in question. No other application tables are documented as directly referenced by this package, although indirect access to Benefits and HR date-tracked infrastructure is implied through the HR_API dependency.

Usage Notes

This API is not intended for direct end-user invocation. It is called by other Benefits packages, specifically BEN_CLOSE_ENROLLMENT and BEN_CLS_UNRESOLVED_ACTN_ITEM, which invoke it as part of enrollment close and unresolved action item processing. Custom code and extensions that need to manage batch rate information should call this API rather than issuing DML against BEN_BATCH_RATE_INFO directly, so that the standard validation and locking behavior is preserved. Because the procedures rely on HR_API utilities, standard HR API conventions apply, including the use of validation modes and effective date parameters where the underlying entity is date-tracked.