Results for “hr_phone_api”
50+ results
AI-generated from documented ETRM metadata — verify critical details on the linked pages.
Overview
APPS.HR_PHONE_API is a public Oracle E-Business Suite API package that provides the supported programmatic interface for creating, maintaining, and removing telephone records held against a person in Oracle Human Resources. The package header declares it as AUTHID CURRENT_USER, meaning it executes with the privileges of the calling schema, and the source identifiers it as a Human Resources (PER) product object. Its declared display name is "Phone".
The business purpose of the package is to centralise the validation and storage of phone data so that external callers do not write directly to the underlying phone tables. In release 12.1.1 and 12.2.2 the HR phone model is shared with the Trading Community Architecture (TCA) party model inherited through the HR/TCA merge, so the API must support both person-anchored and party-anchored phone records. The licensing comment in the package states that the API is licensed for use with Human Resources and HR Foundation, which bounds where it may legitimately be called.
Because the user search referred to phone data used by "web and document application" scenarios, it is worth noting that this API is the correct integration point for such requirements: any custom web or document-facing component that needs to persist a person's telephone details should call HR_PHONE_API rather than performing direct DML on PER_PHONES.
Key Procedures and Functions
The ETRM metadata records four documented entry points in this package:
- CREATE_PHONE — Creates a new phone record. The documented prerequisites require that a person already exists before a phone can be created for them. Each phone is linked to a parent table; the documentation states that the only currently supported parent table is PER_PEOPLE_F, and that by virtue of the HR/TCA merge, party_id is also supported, in which case parent_id and parent_table are not required. Documented parameters include the effective dates (date from and date to), the phone type (validated against the PHONE_TYPE lookup type), the phone number itself, the parent identifier (which must relate to a valid person_id on PER_PEOPLE_F), the parent table name, and an attribute category that determines the descriptive flexfield structure. On success the phone record is created; on failure the record is not created and an error is raised.
- UPDATE_PHONE — Modifies an existing phone record, applying the same validation rules and effective-dating conventions used at creation.
- DELETE_PHONE — Removes an existing phone record from the person's telephone details.
- CREATE_OR_UPDATE_PHONE — A combined routine that resolves whether the supplied phone data represents a new or existing record and applies the appropriate create or update behaviour in a single call, which is convenient for interfaces that cannot determine record existence in advance.
Tables Accessed
The documented tables referenced through APPS synonyms are:
- PER_PHONES — The primary store of telephone records. CREATE_PHONE and CREATE_OR_UPDATE_PHONE insert into this table, UPDATE_PHONE and CREATE_OR_UPDATE_PHONE modify existing rows, and DELETE_PHONE removes them.
- PER_ALL_PEOPLE_F — The person table used to validate that the parent_id supplied by the caller corresponds to a valid person. This enforces the documented prerequisite that a person must exist before a phone can be created for them, and underpins the restriction that PER_PEOPLE_F is the supported parent table.
Usage Notes
HR_PHONE_API is typically invoked from Oracle Forms-based person maintenance screens, from concurrent programs that batch-load or migrate telephone data, and from custom PL/SQL integration code. The ETRM metadata records that the package is referenced by thirteen other packages, indicating that it is a foundational dependency within the HR API layer rather than an end-user entry point. Callers must supply a valid PHONE_TYPE lookup value and should respect the effective-dating parameters, since phone records are date-tracked. Where the HR/TCA party model is in use, callers may supply party_id instead of the parent_id and parent_table pair. All error conditions are surfaced through the standard HR API error mechanism, so custom code should check the API return status and message rather than assuming success on completion.
-
PACKAGE: APPS.PER_PEOPLE_PKG 12.2.2