Search Results create_tk_group_query

Overview

HXC_TK_GROUP_QUERY_API is a public Oracle E-Business Suite PL/SQL API belonging to the APPS schema that manages the query definitions attached to timekeeper groups within Oracle Time and Labor (OTL). A timekeeper group is a set of employees for whom one or more timekeepers are responsible; a timekeeper group query further qualifies that population by associating an include or exclude selection rule with the group. This package provides the programmatic maintenance layer for the HXC_TK_GROUP_QUERIES entity, allowing query rows to be created, modified, and removed while enforcing the business rules that govern the relationship between a query and its parent timekeeper group. The package header carries a "noship" version stamp (hxctkgqapi.pkb 120.2), confirming it is an internal, non-shipped API that is nonetheless classified as public and callable from supported extension code. It exposes seven documented entry points and is referenced by one other package, indicating that it operates as a reusable building block rather than a terminal application component.

Key Procedures and Functions

• CREATE_TK_GROUP_QUERY — Creates a timekeeper group query for a given name and parent group. It accepts a validation flag; when validation is requested the database remains unchanged, otherwise a new query row is inserted and the generated primary key and object version number are returned.
• UPDATE_TK_GROUP_QUERY — Modifies an existing timekeeper group query, applying the same validation and object version number conventions used at creation.
• DELETE_TK_GROUP_QUERY — Removes an existing timekeeper group query from the repository.
• CHK_NAME — Validation routine that verifies the supplied query name is acceptable and does not conflict with existing data before the caller commits to an insert.
• CHK_TK_GROUP_ID — Validation routine that confirms the referenced timekeeper group identifier is valid and available for association.
• CHK_DELETE — Validation routine that determines whether the identified query may legitimately be deleted, guarding against removal of rows that are still required.
• MAINTAIN_TK_GROUP_QUERY — Internal consolidation routine that drives the shared insert, update, and delete logic on behalf of the public procedures, ensuring that validation, auditing, and object version handling are applied consistently.

Tables Accessed

• HXC_TK_GROUP_QUERIES — The primary table for this API. All creation, update, and deletion activity is directed at this table, which stores the query name, the include/exclude indicator, and the system/user flag for each defined query.
• HXC_TK_GROUPS — The parent timekeeper group table. It is read to validate the foreign key supplied through p_tk_group_id before any query row is written.
• DUAL — Used for lightweight SQL expressions, such as validation lookups and sequence or flag evaluation, that do not require a base table.

Usage Notes

This API is normally invoked indirectly. Oracle Time and Labor setup forms that allow a user to define or maintain timekeeper group queries call the procedures at save time, and the package's validation subprograms are exercised before the form issues its commit. The same procedures may be called from PL/SQL-based concurrent programs, from workflow or business event handlers, and from custom extensions that need to provision or migrate timekeeper group query definitions in bulk.

Callers should observe three conventions. First, every mutating call should be issued with p_validate set to TRUE first so that business rule violations are surfaced without altering the database; only after validation succeeds should the call be repeated with p_validate set to FALSE. Second, the object version number parameter must be carried through from read to write, because it implements optimistic locking and prevents lost updates when two sessions edit the same query. Third, since this is a validation-aware API rather than a commit-aware one, the calling code remains responsible for transaction control and for formatting any user-facing message from the raised application error. Because the package is public but unsupported for modification, extensions should call it as delivered and should not depend on internal implementation details beyond the documented signatures.