Search Results hxc_tk_group_query_api




Overview
Explore in AI Chat

Overview

The APPS.HXC_TK_GROUP_QUERY_API package is a public application programming interface (API) within the Oracle E-Business Suite Time and Labor (HXC) module. Its role is to manage the definition and lifecycle of Timekeeper Group Query records — the reusable query definitions that determine which workers belong to a given Timekeeper Group. In Oracle Time and Labor, timekeepers are responsible for entering and approving time for defined populations of employees. The selection criteria that bound those populations are stored as query definitions and associated with timekeeper groups. This package provides the programmatic entry point by which such group-to-query associations are created, modified, and removed, ensuring that the underlying data is validated and maintained consistently rather than being manipulated directly at the table level.

The package is classified as an API in the ETRM metadata, is owned by the APPS schema, and holds a VALID status in release 12.2.2. It corresponds to the applications-side package specification and body, with dependencies on the SYS.STANDARD package.

Key Procedures and Functions

The package exposes seven documented procedures and functions that together implement a complete maintenance cycle:

  • CREATE_TK_GROUP_QUERY — Inserts a new query definition and associates it with a specified timekeeper group, establishing the membership rules used for that group.
  • UPDATE_TK_GROUP_QUERY — Modifies an existing timekeeper group query record, allowing the associated criteria or group linkage to be revised.
  • DELETE_TK_GROUP_QUERY — Removes an existing timekeeper group query association from the system.
  • CHK_NAME — Validation routine that verifies the name of the query or group against naming rules and uniqueness constraints.
  • CHK_TK_GROUP_ID — Validation routine that confirms the supplied timekeeper group identifier exists and is valid before creating or updating an association.
  • CHK_DELETE — Validation routine that determines whether a given query record may be safely deleted, guarding against removal of records that are still in use.
  • MAINTAIN_TK_GROUP_QUERY — A coordinating routine that drives the maintain operation, typically dispatching to the appropriate create, update, or delete logic based on the requested action.

The CHK_* routines are internal validation helpers invoked by the higher-level maintenance procedures; they are documented as part of the public specification but are not intended to be called directly by external code.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • HXC_TK_GROUPS — The parent table holding timekeeper group definitions. It is referenced to validate the group identifier supplied during create and update, and to enforce group-level integrity.
  • HXC_TK_GROUP_QUERIES — The child table that stores the individual query definitions associated with each timekeeper group. This is the primary table maintained by the API's create, update, and delete operations.
  • DUAL — Used for simple single-row validation queries and scalar checks within the CHK_* routines.

Usage Notes

This API is typically invoked indirectly through the Oracle Time and Labor setup forms and concurrent processes rather than by end users or developers writing direct calls. It is referenced by the companion package HXC_TK_GRP_QUERY_CRITERIA_API, which manages the underlying query criteria records, and by the HXC_TK_GROUP_QUERY_API package body itself. Because it is a documented public API, customizations and extensions that need to programmatically define or alter timekeeper group queries should call these procedures instead of issuing direct DML against HXC_TK_GROUP_QUERIES, so that the built-in name, identifier, and deletion validations are consistently applied. As with all APPS-owned APIs, callers should observe standard practices regarding error handling, concurrency, and commit control, and should not call the CHK_* routines directly.