DBALockoutFunction

DBA Lockout Function

Minor Business Rule

Object Name: B0700016

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700016 - DS for DBA Lockout Function

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

jdPayrollBeginningDateEFTBJDEDATEOPTNONE

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.  
For example, the effective date could represent the following:    o When a change of address becomes effective.   o When a lease becomes 
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective. 

jdPayrollEndingDateEFTEJDEDATEOPTNONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

szPayrollIDPAYDcharOPTNONE

A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll 
cycle. This code is also used to identify the interim ID that you select when you enter interim payments.

szDBACachePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szCheckControlCachePID1charOPTNONE

Program ID - 01

jdDateUpdatedUPMJJDEDATEOPTNONE

The date that specifies the last update to the file record.

mnTimeLastUpdatedUPMTMATH_NUMERICOPTNONE

The time that specifies when the program executed the last update to this record.

szProgramIDPID3charOPTNONE

Program ID - 03

szWorkStationIDJOBNcharOPTNONE

The code that identifies the work station ID that executed a particular job.

szUserIDUSERcharOPTNONE

The code that identifies a user profile.

szDBADetailCachePID1charOPTNONE

Program ID - 01

szCountryCTRcharOPTNONE

A user defined code (00/CN) that identifies a country. The country code has no effect on currency conversion. The Address Book system 
uses the country code for data selection and address formatting.

szOverrideGLBankAccount_GLBAGLBAcharOPTNONE

The number of the bank account (general ledger account) to be updated automatically when receipts or disbursements are entered. The 
bank account number is assumed to be the same for every document in a batch. Therefore, it is not cleared from entry to entry. However, if 
you leave the bank account number blank, the system retrieves a default bank account number from the Automatic Accounting Instructions file 
(F0012), item number RB for Accounts Receivable and PB for Accounts Payable.

jdPaycheckDate_CKDTCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

szTimecardCachePID1charOPTNONE

Program ID - 01

szAAIJournalsCache_PIDPIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szHomeBusinessUnitHMCUcharOPTNONE

The number of the business unit in which the employee generally resides.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

Related Functions

B0700003 Create PrePayroll Caches
B0700370 Add Records to the DBA Detail Cache
B0700920 Retrieve AAI for Journals
B0701180 Retrieve Corporate Tax ID
N0500012 Get AAI For Timecard Journals

Related Tables

F069116 Payroll Transaction Constants
F0709 Deduction/Benefit/Accrual Ledger File