Search Results tax_prefix




Overview
Explore in AI Chat

Overview

PYSOYTLS is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified in the ETRM repository as an OTHER API (an internal utility package rather than a public, supported business API). The package name expands to "Start Of Year Tools," reflecting its origin in the Oracle Payroll (PY) module, where the start-of-year processing cycle requires manipulation and validation of tax code definitions. It was originally authored by Barry Goodsell in August 1995 and first shipped under version 40.0, with a subsequent 40.1 edit for release. The package is declared AUTHID CURRENT_USER, meaning its SQL executes under the privileges of the invoking session rather than the package owner — a common pattern for utility packages that need to respect the caller's security context.

The package's functional purpose is the parsing and decomposition of payroll tax codes. Tax codes in Oracle Payroll carry structured meaning: a prefix that identifies the tax authority or jurisdiction, a numeric value component, and a suffix that distinguishes variants. PYSOYTLS exposes string and numeric helpers that isolate each of these components so that downstream start-of-year logic can compare, rank, or re-sequence tax codes across a legislative year boundary.

Key Procedures and Functions

ETRM documents four callable functions in this package. All four are declared with PRAGMA RESTRICT_REFERENCES set to WNDS (Write No Database State) and WNPS (Write No Package State), confirming they are pure read-only functions with no side effects on database or package state — a property that makes them safe for use inside SQL statements and view definitions.

  • TRIM — Accepts a string and returns a string. It normalizes the input by removing extraneous leading and/or trailing characters, providing the cleaned token used by the other parsing functions.
  • TAX_PREFIX — Accepts a tax code string and returns the prefix portion, isolating the jurisdictional or authority identifier that precedes the numeric component of the tax code.
  • TAX_VALUE — Accepts a tax code string and returns a number, extracting the numeric portion embedded within the tax code. This is the function surfaced by the user's search for "tax_value" and is the core conversion routine that lets start-of-year logic treat a tax code's ordinal value as a sortable, comparable quantity.
  • TAX_SUFFIX — Accepts a tax code string and returns the suffix portion, isolating the trailing qualifier that distinguishes tax codes sharing the same prefix and value.

Tables Accessed

The documented metadata lists no tables referenced via APPS synonyms. This is consistent with the WNDS/restrict_references declarations above: the package performs purely in-memory string parsing and numeric conversion and does not read or write payroll tax tables, fiscal year tables, or any other database object. Callers bear responsibility for supplying valid tax code strings, typically sourced from payroll tax code definitions held elsewhere.

Usage Notes

The package is invoked from other PL/SQL units rather than from an Oracle Forms UI or a standalone concurrent program. The ETRM metadata records that it is referenced by exactly one other package, indicating it is a subordinate helper rather than a widely consumed API. In practice, custom start-of-year extensions, payroll tax code migration scripts, and reporting logic that must sort or group tax codes by jurisdiction can call TAX_PREFIX, TAX_VALUE, and TAX_SUFFIX together to reconstruct the structure of a tax code. Because the functions are restricted to WNDS and WNPS, they may be embedded directly in SQL SELECT lists and WHERE clauses. Implementers should treat PYSOYTLS as an internal, unsupported object: it carries no documented public API classification, its header has not been revised since 1999, and its behavior across the 12.1.1 to 12.2.2 upgrade should be verified in each target environment before reliance in production customizations.