Search Results derive_format_mask

Overview

APPS.PAY_JP_ENTRIES_PKG is a Japanese localization package within Oracle Payroll (PAY) that supports the entry and validation of element entry values for payroll elements processed under Japanese legislative and business rules. The package operates with AUTHID CURRENT_USER and is classified in the ETRM repository as an OTHER API, indicating it is primarily an internal support package rather than a public, fully supported interface. Its responsibilities center on deriving and formatting element entry input values, validating entries and their values against defined payroll input value rules, managing the descriptive flexfield attributes attached to element entries, and performing the insert, update, delete, and locking operations that persist element entry rows. Because Japanese payroll requires specific formatting, defaulting, and validation behavior for numeric and character input values, this package encapsulates logic that the generic Payroll element entry forms and processes rely upon when the Japanese localization is active. Its header file (pyjpetr.pkh, version 120.0.12010000.1) dates from the 12.1 development line and remains in place through EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The package exposes twelve documented procedures and functions. DERIVE_DEFAULT_VALUES, the object most commonly sought in relation to this package, is responsible for determining and supplying default screen entry values for element entry input values. DERIVE_ATTRIBUTES handles the derivation of descriptive flexfield attribute values for element entries. DERIVE_FORMAT_MASK derives the display format mask applied to an input value, which in the Japanese context governs how numeric amounts and codes are presented and interpreted.

Validation logic is provided by CHK_ENTRY, which validates an element entry as a whole, and CHK_ENTRY_VALUE, which validates an individual element entry input value. Mode resolution helpers include FIND_DT_UPD_MODES and FIND_DT_DEL_MODES, which determine the applicable update and delete modes for entry data. Persistence operations are handled by INS, UPD, and DEL for inserting, updating, and deleting element entry records, supported by the locking routines LCK and INS_LCK, which acquire and manage row locks to preserve concurrency integrity. Together these procedures form the complete entry-lifecycle surface: defaulting, validation, mode selection, locking, and data manipulation.

Tables Accessed

The package reads and writes the core Payroll element entry tables. PAY_ELEMENT_ENTRIES_F stores the element entry header rows, including descriptive flexfield attribute columns used by DERIVE_ATTRIBUTES. PAY_ELEMENT_ENTRY_VALUES_F stores the individual input values belonging to each entry and is central to CHK_ENTRY_VALUE and DERIVE_DEFAULT_VALUES. PAY_ELEMENT_TYPES_F supplies element definition details such as element name, input currency code, and the multiple-entries-allowed flag, which are cached in the package's element record structures. PAY_INPUT_VALUES_F and its translation table PAY_INPUT_VALUES_F_TL provide input value definitions, including display sequence, unit of measure, mandatory flag, maximum length, and format mask. PAY_LINK_INPUT_VALUES_F and PAY_ELEMENT_LINKS_F define which input values are available for a given element link. FF_FDI_USAGES_F supports descriptive flexfield usage resolution, and PLITBLM is referenced in conjunction with flexfield processing. Read access dominates for the definition and flexfield tables, while the entry tables receive the package's insert, update, and delete operations.

Usage Notes

PAY_JP_ENTRIES_PKG is invoked primarily from the Oracle Forms-based element entry maintenance screens when the Japanese localization is in use, where it supplies default values, computes format masks, validates entries and their values, and persists changes. It may also be called from payroll processes and concurrent programs that create or validate element entries, and from custom forms or PL/SQL that require the same Japanese-specific defaulting and validation behavior. Because the package is documented as OTHER rather than a public API and two other packages reference it, custom code should account for its internal nature and the possibility of signature changes across patches. The package's type declarations, particularly the fixed size limit of fifteen used for the input value collection and the cache structures for element codes and input values, reflect design assumptions that callers should not override.