Search Results get_mask

Overview

APPS.HR_NMF_SYNC is a server-side PL/SQL package body that supports Oracle E-Business Suite Human Resources name-format synchronization processing. Its central responsibility is to reconcile the name format definitions stored in the HR_NAME_FORMATS table with the payroll action framework so that person names are regenerated and stored consistently using the masks defined for each legislation and format. The package name and internal constants — g_FULL_NAME, g_ORDER_NAME, and g_LIST_NAME — confirm that it operates against the three seeded name format definitions (FULL_NAME, ORDER_NAME, and LIST_NAME) used by Oracle HRMS for displaying and formatting person names.

The header revision string (hrnmfsyn.pkb 120.7) indicates the package was last modified in the 12.0.x development line and is delivered unchanged into 12.1.1 and 12.2.2. It is classified as an OTHER API, meaning it is an internal utility package rather than a supported public API, and it is referenced by no other packages in the documented metadata.

Key Procedures and Functions

The ETRM metadata documents six program units:

• INITIALIZATION — Performs setup work before the main synchronization run, establishing the working context and any cached or session-level state required by subsequent procedures.
• RANGE_CURSOR — Defines the driving cursor used to select the population of records that must be synchronized, allowing the run to be processed in controlled ranges rather than as a single unbounded set.
• ACTION_CREATION — Creates the assignment action records that cause name regeneration to occur, writing through PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S and linking to the payroll action framework in PAY_PAYROLL_ACTIONS.
• ARCHIVE_DATA — Preserves the pre-existing name-format or action data before changes are applied, providing a recovery and audit trail.
• SUBMIT_SYNC_NAMES — The principal entry point; it orchestrates the synchronization of person names against the current mask definitions and submits the resulting processing.
• VALIDATERUN — Validates the parameters and preconditions for the run, returning an outcome that determines whether processing may proceed.

Internally, the body also contains a private cache_mask_info procedure. It executes the csr_get_masks cursor, which is the code path exercised when a user searches for "get_mask". That cursor selects legislation_code, format_name, user_format_choice, and format_mask from HR_NAME_FORMATS, filtering on the supplied legislation code or a null (global) legislation, on format name, and on user format choice, and caches the returned mask information in a PL/SQL table so masks are not repeatedly queried. A Write_Log helper writes messages to the concurrent manager log via FND_FILE.PUT_LINE.

Tables Accessed

Documented access is through APPS synonyms:

• HR_NAME_FORMATS — the source of name format and mask definitions; read by the get_mask cursor and used for caching mask information.
• PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S — the base and translated assignment action tables populated by ACTION_CREATION to trigger name re-derivation for affected assignments.
• PAY_PAYROLL_ACTIONS — the parent payroll action record against which assignment actions are grouped.
• PER_ALL_PEOPLE_F — the person datastore whose names are evaluated and regenerated under the active format masks.
• ALL_TRIGGERS, USER_TRIGGERS, and DUAL — used for metadata and existence checks and for single-row evaluations.
• PLITBLM — the underlying storage for PL/SQL index-by tables, consistent with the mask caching performed by cache_mask_info.

Usage Notes

HR_NMF_SYNC is typically invoked from a concurrent program, most plausibly the "Synchronize Name Formats" process, since its logging is written through FND_FILE to the concurrent manager log. It is not a supported public API and is referenced by no other documented package, so it should not be called directly from customer code. Oracle Forms-based name format maintenance in HRMS uses the same mask definitions, and this package applies those definitions retroactively to existing person records. Runtime errors surface through the Write_Log exception handler, which writes SQLERRM to the log and re-raises.