Search Results create_role




Overview

APPS.PQH_ROLES_API is a PL/SQL server-side API within the Oracle E-Business Suite Public Sector / Human Resources (PQH) schema. It encapsulates the business logic required to maintain role definitions stored in the PQH_ROLES entity, which forms part of the HR roles framework used by Public Sector applications. The package exposes a controlled, validated interface so that role records can be created, modified, and removed without direct DML against the underlying table. In Oracle EBS 12.1.1 and 12.2.2, such API packages are the sanctioned integration point for developers and form-based flows that must respect role datemasking, object versioning, and business-group security rules. The package body header identifies the member procedures and confirms its location in the APPS schema. The purpose is to centralize referential and validation logic — including the handling of developer descriptive flexfield (DFF) column values attached to a role — so that every change to PQH_ROLES passes through consistent checks and version tracking.

Key Procedures and Functions

The package exposes three documented procedures that together provide the full lifecycle of a role record:

  • CREATE_ROLE — Inserts a new role into PQH_ROLES. It accepts the role identity fields (role name and role type code), an enable flag, the owning business group, an effective date, and a set of developer descriptive flexfield attributes (information category plus INFORMATION1 through INFORMATION30). It returns the generated role identifier and an object version number, and supports validation-only execution through the p_validate flag, allowing callers to test the operation and roll back without committing.
  • UPDATE_ROLE — Modifies the attributes of an existing role, using the object version number to enforce optimistic locking. This is the procedure most frequently targeted by users searching for "update_role," since it is the supported mechanism for changing a role definition rather than issuing a direct update against PQH_ROLES.
  • DELETE_ROLE — Removes a role record. Positioned alongside create and update, it completes the maintenance cycle and ensures that role deletion is subject to the same validation and referential safeguards as the other operations.

No parameter lists are itemized here beyond the documented CREATE_ROLE signature; the other procedures follow the same conventions of validation mode, surrogate key, and version number.

Tables Accessed

The only table referenced by this package, through its APPS synonym, is PQH_ROLES. CREATE_ROLE performs the insert, UPDATE_ROLE performs the update against the identified row, and DELETE_ROLE removes it. Because PQH_ROLES carries the role header attributes and the developer DFF segment columns, all read and write activity for role metadata is concentrated in this single table. The package does not reference additional entities directly; any cross-entity validation is handled by the validation logic bundled in the API rather than by joining to other tables inside the package body.

Usage Notes

PQH_ROLES_API is typically invoked in three contexts. First, from Oracle Forms user interfaces that allow administrators to define and maintain roles, where the form executes the API rather than performing "update role" DML directly. Second, from concurrent programs or batch processes that seed or synchronize role definitions. Third, from custom PL/SQL code that needs to create, update, or delete roles as part of an integration or extension. In each case, callers should pass a meaningful effective date, supply the correct business group, and honor the object version number returned by the API to avoid lost updates. Running with validation enabled is advisable during development. Note the ETRM metadata records zero inbound callers, meaning nothing else in the shipped product depends on this package, so it is safe to consider it a leaf-level API whose contract is maintained for external and form-driven use.