ClearTimecardCheckControlCache

Clear Timecard, Check Control, DBA Cache

Minor Business Rule

Object Name: B0500120

Parent DLL: CFND

Location: Client/Server

Language: C

Functional Description
B0500120 - Clear Timecard, Check Control or DBA Summary Cache

Purpose
The purpose of this function is to clear any one of the following caches when the unique cache name
is passed: Timecard Cache, Check Control Cache or DBA Summary Cache.

Setup Notes and Prerequisites
Any cache that needs to be cleared, must have already been created prior to running this function.

Special Logic
All 3 parameters MUST be passed regardless of which cache/s is to be cleard.  Valid values are:

szTimecardCacheName =   --> tells function to clear cache OR
                      "blanks"             --> tells function to ignore

szCheckControlCacheName =   --> clear cache  OR
                          "blanks"             --> ignore

szDBASummaryCacheName =     --> clear cache  OR
                        "blanks"               --> ignore

Technical Specification

Parameters: (D0500120)

Data Structure Description Data ItemI/ORequired
szTimecardCacheNamePIDIY
szCheckControlCacheNamePIDIY
szDBASummaryCacheNamePIDIY

This function uses the API "IsStringBlank" to determine if requested cache is to be cleared:
If (IsStringBlank(lpDS->szTimecardCacheName) == FALSE)
Initialize Data Structure
Initialize Cache Index
Set up Index to Timecard Cache
Get Cache Handle
Clear Timecard Cache
Terminate Cache handle
End If

If (IsStringBlank(lpDS->szCheckControlCacheName) == FALSE)
Initialize Data Structure
Initialize Cache Index
Set up Index to Timecard Cache
Get Cache Handle
Clear Timecard Cache
Terminate Cache handle
End If

If (IsStringBlank(lpDS->szDBASummaryCacheName) == FALSE)
Initialize Data Structure
Initialize Cache Index
Set up Index to Timecard Cache
Get Cache Handle
Clear Timecard Cache
Terminate Cache handle
End If

^

Data Structure

D0500120 - DS to Clear Timecard, Check Control, DBA Cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
szTimecardCacheName	PID	char	OPT	NONE
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.
szCheckControlCacheName	PID	char	OPT	NONE
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.
szDBASummaryCacheName	PID	char	OPT	NONE
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.

Related Functions

B0700003 Create PrePayroll Caches

Related Tables

None