Search Results get_pay_message

Overview

APPS.HR_CN_API is a public PL/SQL package in the Oracle E-Business Suite Human Resources (HR) module, classified as an API in the ETRM repository and owned by the APPS schema. Its header identifies it with AUTHID CURRENT_USER and a package header revision dating to the 12.0 code line ($Header: hrcnapi.pkh 120.1.12000000.1), which carries forward unchanged into Oracle EBS 12.1.1 and 12.2.2. The package provides a library of validation and utility routines used by Oracle HR localization and person/assignment processing logic, particularly where Chinese (CN) legislative and payroll-related attributes must be validated before records are committed. In the 12.2.2 documented metadata the package exposes 23 procedures and functions and is referenced by 18 other packages, indicating it serves as a shared validation utility layer rather than a standalone user-facing process.

Key Procedures and Functions

The documented interface includes location, lookup, validation, and message-retrieval routines:

• SET_LOCATION (two overloads) — Establishes a trace/location context for diagnostic purposes, either conditioned on a trace flag or applied irrespective of trace, allowing callers to annotate processing steps with a message and step number.
• CHECK_LOOKUP — Validates a lookup code against a specified lookup type, returning a Boolean result; the header notes it is used in employee-checking logic.
• IS_POSITIVE_INTEGER, IS_NUMBER, IS_VALID_PERCENTAGE, IS_VALID_POSTAL_CODE — Primitive format validators for numeric, percentage, and postal-code values.
• CHK_PERSON_TYPE, CHECK_PERSON, CHECK_ASSIGNMENT, CHECK_ADDRESS — Validation routines for person type, person, assignment, and address records.
• CHECK_ORGANIZATION, CHECK_ORG_CLASS, CHECK_ORG_TYPE — Validation of organization records and their classifications and types.
• CHECK_CIN, CHECK_TAX_DEPENDENCE, CHECK_BUS_GRP, CHECK_PAYMENT_METHOD — Chinese localization validations covering national identification, tax dependence, business group, and payment method attributes.
• GET_PAY_MESSAGE — Retrieves a payroll-related message string for the caller; this is the routine associated with the search term, and is typically used to obtain locale-specific or validation feedback text when payment or payroll validation fails.
• GET_USER_TABLE_VALUE, GET_DFF_TL_VALUE — Return stored user-table (flexfield) values and translated descriptive flexfield values respectively.

Tables Accessed

The package reads and writes primarily HR and flexfield metadata through APPS synonyms:

• FND_DESCR_FLEX_COLUMN_USAGES, FND_DESCR_FLEX_COL_USAGE_TL — Descriptive flexfield column usage definitions and their translations, supporting GET_DFF_TL_VALUE and related lookups.
• HR_ORGANIZATION_INFORMATION — Organization-level attribute storage, consulted by the organization and business-group checks.
• PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_CLASSIFICATIONS_TL — Payroll element classification data and translations, relevant to payment and payroll validation.
• PAY_PERSONAL_PAYMENT_METHODS_F — Personal payment method records, used by CHECK_PAYMENT_METHOD and GET_PAY_MESSAGE.
• PAY_USER_COLUMN_INSTANCES_F — User-defined column instance rows backing GET_USER_TABLE_VALUE.
• PER_ADDRESSES, PER_PERSON_TYPES — Person addresses and person type definitions for address and person-type validation.
• PLITBLM — The PL/SQL index-by table of VARCHAR2 used for passing collections into and out of SQL.

Usage Notes

HR_CN_API is a server-side package and is not exposed as a form or concurrent program in its own right. It is invoked from PL/SQL in Oracle HR localization code, from other APIs, and from custom extensions requiring the same validation semantics. Its 18 referencing packages confirm that it is consumed throughout HR and payroll processing rather than called directly by end users. Because it operates under AUTHID CURRENT_USER, callers must ensure the invoking schema has the necessary privileges on the underlying APPS synonyms, and custom code should call the documented routines rather than depend on internal behavior. The presence of SET_LOCATION and trace-conditional overloads means diagnostic output can be directed by the caller, which is useful when troubleshooting payroll or person validation failures in 12.1.1 and 12.2.2 environments.