Search Results check_if_qualified_for_ca




Overview
Explore in AI Chat

Overview

APPS.PYCADAR_PKG is a Canadian Payroll deposit advice package within the Oracle E-Business Suite Payroll (PAY) module. Its primary business function is to support the generation, qualification, and archiving of deposit advice documents for Canadian payroll processing, including the XML-based Canadian Deposit Advice enhancement introduced in version 115.8. The package acts as the procedural engine behind the Canadian Deposit Advice concurrent process, which produces payment notifications advising employees of amounts deposited to their bank accounts.

The package is classified as OTHER in the ETRM API registry, meaning it is an internal implementation package rather than a formally published open interface. It is referenced by fifteen other packages, indicating its role as a shared utility layer within Canadian payroll processing logic. The package is defined with AUTHID CURRENT_USER, so it executes with the privileges of the calling user and relies on APPS synonyms for all table access.

Key Procedures and Functions

  • RANGE_CURSOR — Builds the driving SQL cursor (returned via an OUT NOCOPY parameter) used to select assignment records for processing in a given payroll action. It underpins the chunked, restartable processing model used by the action creation routines.
  • ACTION_CREATION — The core routine that creates deposit advice actions for a range of assignments (start person, end person, chunk) within a payroll action. It drives the generation of the advice records.
  • ARCHIVE_ACTION_CREATION — A variant of action creation invoked by the payroll archive process, producing deposit advice output from archived payroll results.
  • QUALIFYING_PROC — Added in the 2012 Canadian Deposit Advice XML enhancement. It identifies which assignments qualify for deposit advice generation, serving as the qualification filter for the XML process.
  • CHECK_IF_QUALIFIED_FOR_CA — Companion function to QUALIFYING_PROC that evaluates whether a given assignment meets the Canadian qualification criteria for advice creation.
  • CHECK_IF_ASSIGNMENT_PAID — Function introduced to improve performance (Bug#3438254) that determines whether an assignment was actually paid within a deposit date range for a given prepayment action and consolidation set, preventing unnecessary advice generation.
  • SORT_ACTION — Orders the processing results according to a supplied procedure name and SQL string, controlling output sequence.
  • GET_PARAMETER — Retrieves runtime parameter values used to steer the package's processing behavior.
  • GET_LABELS — Returns label text (with multiple input parameters) used for report headings and translated output on the deposit advice.

Tables Accessed

The package reads and writes a broad set of payroll and HR tables through APPS synonyms. Payroll action data is sourced from PAY_PAYROLL_ACTIONS, PAY_ACTION_INFORMATION, and PAY_ACTION_INTERLOCKS, which control action grouping and locking. Assignment-level state is drawn from PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S, while PER_ALL_ASSIGNMENTS_F and PER_PERIODS_OF_SERVICE provide the employee assignment and service context. Payment and method details come from PAY_PRE_PAYMENTS and PAY_ORG_PAYMENT_METHODS_F. Consolidation and grouping rules reference HR_ASSIGNMENT_SETS, HR_ASSIGNMENT_SET_AMENDMENTS, PAY_ALL_PAYROLLS_F, PAY_REPORT_CATEGORIES, and PAY_REPORT_GROUPS. Reference lookups are resolved through FND_LOOKUP_VALUES.

Usage Notes

PYCADAR_PKG is typically invoked by the Canadian Deposit Advice concurrent program and by the payroll archive process rather than called directly from forms. Its chunked RANGE_CURSOR / ACTION_CREATION design supports parallel, restartable processing of large payroll populations. Customizations should avoid modifying the package directly; instead, extensions should call the documented public routines or replicate qualification logic via CHECK_IF_ASSIGNMENT_PAID and CHECK_IF_QUALIFIED_FOR_CA. Because the specification uses AUTHID CURRENT_USER, callers must ensure the APPS synonyms are visible in their schema context.