W4Cache

W-4 Cache

Minor Business Rule

Object Name: B0800440

Parent DLL: CHRM

Location: Client/Server

Language: C

Functional Description

Purpose

The purpose of this business function is to keep the information pertaining to the W-4 tax form in a 

cache to maintain the data and to increase processing in the employee self-service process.


Setup Notes and Prerequisites


Special Logic


Technical Specifications


#defineCACHE_GET1

#defineCACHE_ADD2

#defineCACHE_UPDATE3

#defineCACHE_DELETE4

#defineCACHE_DELETE_ALL5

#defineCACHE_GET_NEXT6

#defineCACHE_ADD_UPDATE7

#defineCACHE_END8

#defineCACHE_CLOSE_CURSOR9

#defineCACHE_LOAD_DATA10


Index 1

NumSegments = 3

mnJobnumberA

mnAddressNumber

mnYearCalMN4


Data Structure

mnJobnumberAJOBSJob Number

szCacheActionCodeCACTNCache Action Code

idCacheCursorGENLNG Generid Long ID - OneWorld

mnIndexIdNKEYSNumber of Keys

szCacheNamePIDProgram ID

mnNumberOfKeysNKEYSNumber of Keys

cSuppressErrorMessageSUPPSSuppress Error Message

szErrorMessageDTAIData Item

mnAddressNumber AN8Address Number

mnYearCalMN4 CALYEARYear - Calendar

cW4MaritalStatus W4MARSTMarital Status, IRS W-4 Form

cW4NameChangeFlag W4NMCHFLFlag, Name Change

mnW4NumberOfAllowancesTotalW4NOALLNumber of Allowances in IRS Form W-4

mnW4AdditionalWithholdingW4AWAdditional Withholding

cW4ExemptStatusFlag W4EXMFLGFlag, Exempt Status on IRS Form W-4

cNoLiabilityLastYear EV01OneWorld Event Point 01

cNoLiabilityThisYear EV01OneWorld Event Point 01

cClaimedAsDependent EV01OneWorld Event Point 01

cSingleMarried2ndJob EV01OneWorld Event Point 01

cSpouseIsDependentEV01OneWorld Event Point 01

nmNumberOfDependentsINT01Integer 01 - OneWorld

cHeadOfHouse  EV01OneWorld Event Point 01

cChildCareCredit  EV01OneWorld Event Point 01

nNumberOfEligDependents INT01Integer 01 - OneWorld

mnCombinedIncome  MATH01Math Numeric 01

cItemizing  EV01OneWorld Event Point 01

cCombinedOver  EV01OneWorld Event Point 01

mnAmountItemizedDeduct MATH01Math Numeric 01

cStandardDeduction EV01OneWorld Event Point 01

mnAdjustments  MATH01Math Numeric 01

mnCredits  MATH01Math Numeric 01

mnNonWageEstimate  MATH01Math Numeric 01

mnLowestWages  MATH01Math Numeric 01

HmighestWages  MATH01Math Numeric 01

nNumberOfWeeks INT01Integer 01 - OneWorld


Data Structure

D0800440 - W-4 Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnJobnumberAJOBSMATH_NUMERICREQINPUT

The job number (work station ID) which executed the particular job.

szCacheActionCodeCACTNcharREQINPUT

A code that indicates the activity you want to perform. Valid codes:     o Get - Retrieve the cache element     o Add - Add a cache element     o 
Update - Update a cache element     o Delete - Delete a cache element     o Delete All - Delete all cache elements     o Get Next - Retrieve the 
next cache element     o Add/Update - Add a cache element if it does not exist; Update a cache element if it does exist     o Terminate - 
Terminate Cache

idCacheCursorGENLNGIDREQBOTH

General purpose ID variable.

mnIndexIdNKEYSMATH_NUMERICOPTINPUT

The number of keys in an index that will be used to retrieve, delete, or update a record.

mnNumberOfKeysNKEYSMATH_NUMERICOPTINPUT

The number of keys in an index that will be used to retrieve, delete, or update a record.

cSuppressErrorMessageSUPPScharOPTINPUT

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow 
runtime error message handling.        1 = suppress runtime error message handling.

mnAddressNumberAN8MATH_NUMERICOPTBOTH

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

mnYearCalMN4CALYEARMATH_NUMERICOPTBOTH

The four-digit calendar year.

cW4MaritalStatusW4MARSTcharOPTBOTH

A code that represents the marital status of an employee. This code is required by IRS Form W-4.

cW4NameChangeFlagW4NMCHFLcharOPTBOTH

A flag, when set, indicates that the last name differes from that on the social security card. Value when set = 1.

mnW4NumberOfAllowancesTotalW4NOALLMATH_NUMERICOPTBOTH

Total number of allowances claimed on IRS Form W-4

mnW4AdditionalWithholdingW4AWMATH_NUMERICOPTBOTH

An additional amount to be withheld from each paycheck. This value may be calculated using the worksheets in IRS Form W-4.

cW4ExemptStatusFlagW4EXMFLGcharOPTBOTH

A flag to indicate that an employee is claiming exemption from withholding of taxes on IRS Form W-4. To claim exemption, an employee 
has to meet all conditions listed on Form W-4.

cNoLiabilityLastYearEV01charOPTBOTH

An option that specifies the type of processing for an event.

cNoLiabilityThisYearEV01charOPTBOTH

An option that specifies the type of processing for an event.

cClaimedAsDependentEV01charOPTBOTH

An option that specifies the type of processing for an event.

cSingleMarried2ndJobEV01charOPTBOTH

An option that specifies the type of processing for an event.

cSpouseIsDependentEV01charOPTBOTH

An option that specifies the type of processing for an event.

nmNumberOfDependentsINT01integerOPTBOTH

Number of Days in Future to Query for Responses Due. 

cHeadOfHouseEV01charOPTBOTH

An option that specifies the type of processing for an event.

cChildCareCreditEV01charOPTBOTH

An option that specifies the type of processing for an event.

nNumberOfEligDependentsINT01integerOPTBOTH

Number of Days in Future to Query for Responses Due. 

mnCombinedIncomeMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

cItemizingEV01charOPTBOTH

An option that specifies the type of processing for an event.

cCombinedOverEV01charOPTBOTH

An option that specifies the type of processing for an event.

mnAmountItemizedDeductMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

cStandardDeductionEV01charOPTBOTH

An option that specifies the type of processing for an event.

mnAdjustmentsMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

mnCreditsMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

mnNonWageEstimateMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

szErrorMessageDTAIcharOPTOUTPUT

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szCacheNamePIDcharREQINPUT

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.

mnLowestWagesMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

HmighestWagesMATH01MATH_NUMERICOPTBOTH

- - - Good Performance Low Value. 

nNumberOfWeeksINT01integerOPTBOTH

Number of Days in Future to Query for Responses Due. 

cActionFlagACFLcharOPTBOTH

A field that defines the type of change that will be made to a record. This flag is used by the system in subsequent record processing.

mnAdministratorNumberTAN8MATH_NUMERICOPTBOTH

Administrator Number

szMessageToAdministratorCMDScharOPTBOTH

Enter a CL command string to be executed in the jobstream. You may enter a specific command and prompt with a leading ? or press the 
F4 key. You may also enter only a ? or press F4 to get a prompt for all CL commands. Any change to this entry will call the CL command 
prompter to ensure that the command is syntax-checked. Also remember that only commands that are supported in batch mode will work. This 
entry is invalid if you specify a Form ID and Version number (FASTR, Dream Writer, or World Writer).

Related Functions

None

Related Tables

None