Search Results pqh_roles_api




Overview
Explore in AI Chat

Overview

PQH_ROLES_API is a public PL/SQL package owned by the APPS schema that encapsulates the business logic for maintaining role definitions within the Oracle E-Business Suite HRMS role model. It is classified as an API in the ETRM repository and is part of the PQH (Public Sector/HR role management) family of objects that underpin the role-based delegation and hierarchy features used by Oracle Approvals Management, iProcurement, and other role-driven modules. The package provides a programmatic, validated interface for creating, modifying, and removing records in the PQH_ROLES table so that external callers do not write directly to the underlying table and thereby bypass the constrained validation performed by the API layer.

The package depends on APPS.HR_API, the core Human Resources API library, and on standard SYS packages (STANDARD). It is documented as VALID in both the 12.1.1 and 12.2.2 releases, and it is referenced only by itself in the dependency listing, indicating it is a top-level entry point rather than a helper called by other packaged code.

Key Procedures and Functions

Three documented procedures constitute the public interface of PQH_ROLES_API:

  • CREATE_ROLE — Inserts a new role row into PQH_ROLES, applying the validation and defaulting rules that govern role definition. It is the entry point used when a new role must be registered before it can be assigned or referenced by other HR objects.
  • UPDATE_ROLE — Modifies an existing role record, permitting changes to the attributes that the API exposes for maintenance. It enforces the same business rules applied at creation and preserves referential integrity with dependent role assignments.
  • DELETE_ROLE — Removes a role from PQH_ROLES through the sanctioned deletion path, ensuring that dependent data is not orphaned and that the deletion conforms to the API's internal checks.

Parameter lists are not reproduced here; consult the ETRM package specification for exact signatures. Only these three procedures are documented for this API.

Tables Accessed

The single documented table is PQH_ROLES, accessed through an APPS synonym. This table is the master repository of role definitions used by the role-management feature set. All three procedures operate against it: CREATE_ROLE performs the insert, UPDATE_ROLE performs the update, and DELETE_ROLE performs the delete. No other tables are listed in the ETRM metadata, so the API's transactional scope is confined to this entity.

Usage Notes

Because PQH_ROLES_API exposes a controlled interface and depends on HR_API, it is the correct integration point for any process that must maintain role records. It is typically invoked from:

  • Oracle Forms-based HR setup or role-maintenance screens that call the API instead of issuing DML directly.
  • Concurrent programs or batch loaders that provision roles in bulk.
  • Custom PL/SQL code in extensions and integrations that must create, update, or delete roles while honoring the standard validation logic.

Callers should invoke the package through the APPS schema, commit only after the API returns successfully, and avoid direct DML against PQH_ROLES. Since the package is VALID in both 12.1.1 and 12.2.2 and is not wrapped by any other documented package, it can be treated as a stable extension point across those releases.