CacheCacheJobNumbers

Cache, Cache Job Numbers

Minor Business Rule

Object Name: B3003230

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function will perform Get, Add, Update, Delete, Delete All, Get Next, Add/Update, and Terminate
functions on the Job Numbers cache.

The calling application is responsible for loading all appropriate key values to the data structure
and identifying the number of keys to use in retrieval/update processes.

• Cache Action Code
• •
'1' Get - retrieve the cache element.
• '2' Add - add a cache element.
• '3' Update - update a cache element.
• '4' Delete - delete a cache element.
• '5' Delete All - delete all cache elements
• '6' Get Next - retrieve the next cache element
• '7' Add/Update - will add if element does not exist, will change if it does exist.
• '8' Terminate - terminate cache
• '9' Close Cursor- closes cache cursor
•

• Number of Keys
• •
If the number of keys is passed as a parameter, the business function uses this value to setup
key values for a Get, Update, Delete, Get Next, and Add/Update.
• A zero may be passed to retrieve or update the first record.
•

1.3 Special Logic
Only modify the Save Key fields on the first Add.

1.4 Notation
Any where that there is DS this refers to the business function Data Structure, any where there
is Cache DS this refers to the cache data structure.

Data Structure

D3003230 - Cache, Cache Job Numbers

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnCachedJobNumber JOBS MATH_NUMERIC REQ NONE

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

nNumberofKeys INT01 integer REQ NONE

Number of Days in Future to Query for Responses Due.

cProcessMode EV01 char REQ NONE

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

cCacheCodeError EV01 char OPT NONE

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

cSuppressErrorMessages EV01 char OPT NONE

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

mnJobNumber JOBS MATH_NUMERIC REQ NONE

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

szErrorMessageID DTAI char OPT NONE

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.

cReturnCursorFlag EV01 char OPT NONE

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

idCursor GENLNG ID OPT NONE

General purpose ID variable.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnCachedJobNumber	JOBS	MATH_NUMERIC	REQ	NONE
The job number (work station ID) which executed the particular job.
nNumberofKeys	INT01	integer	REQ	NONE
Number of Days in Future to Query for Responses Due.
cProcessMode	EV01	char	REQ	NONE
An option that specifies the type of processing for an event.
cCacheCodeError	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
cSuppressErrorMessages	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
mnJobNumber	JOBS	MATH_NUMERIC	REQ	NONE
The job number (work station ID) which executed the particular job.
szErrorMessageID	DTAI	char	OPT	NONE
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.
cReturnCursorFlag	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
idCursor	GENLNG	ID	OPT	NONE
General purpose ID variable.