CacheProcessString

Cache, Process String

Minor Business Rule

Object Name: B3201050

Parent DLL: CMFG

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose
This function will perform Get, Add, Update, Delete, Delete All, Get Next, Add/Update, Terminate, and
Close Cursor functions on the String cache used in Configurator Order Processing.

1.2Setup Notes and Prerequisites
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

• 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.3Special Logic
There is no special logic within this function.

2.Technical Specifications
2.4Processing
I. Perform setup functions

A. Initialize cache to get handle.
B. Set DS Cache Error Code = '0';
C. If not successful Set error "032E," "Error Processing Cache".

II. Processing Based on Mode.

A.If Process Mode is "1" - GET:

1.Open cursor, reset cursor.
2.Retrieve the first element on the cache matching the key values passed as input; the number of
keys to be used is passed in the input parameters, If "0" fetch first element in the list.
3.Load the values from the retrieved element into the data structure to be passed back to the
calling program.
4.If get fails DS Cache Error Code = '6'.

B.If Process Mode is "2" - ADD (same logic as mode "7").

1.Delete Record, if one exists, that matches full key from Input.
2.Insert a new cache element with values from data structure.
3.If add fails set error "032E" and set DS Cache Error Code = '4'.

C.If Process Mode is "3" - UPDATE (same logic as mode "7").

1.Delete Record, if one exists, that matches full key from Input.
2.Insert a new cache element with values from data structure.
3.If add fails set error "032E" and set DS Cache Error Code = '4'.

D.If Process Mode is "4" - DELETE:

1.Delete all elements on the cache matching the key values passed as input.
2.If delete fails DS Cache Error Code = '5'.

E.If Process Mode is "5" - DELETE ALL:

1.Delete all elements in the cache.
2.If delete fails DS Cache Error Code = '5'.

F.If Process Mode is "6" - GET NEXT:

1.Retrieve the next element on the cache matching the key values passed as input (the
cursor should have been set through a previous "Get" action, i.e. process mode "1", if number of
keys is "0" then fetch next record with out using any key).
2.Load the values from the retrieved element into the data structure to be passed back to
the calling program.
3.If there are no more elements close cursor and set DS Cache Error Code = '1'.

G.If Process Mode is "7" - ADD/UPDATE:

1.Delete Record, if one exists, that matches full key from Input.
2.Insert a new cache element with values from data structure.
3.If add fails set error "032E" and set DS Cache Error Code = '4'.

H.If Process Mode is "8" - END

1.Perform cleanup functions (Terminate cache).

I.If Process Mode is "9" - CLOSE CURSOR

1.Perform cursor close on cursor passed in.

Data Structure

D3201050 - Cache, Process String

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
nNumberOfKeys	INT01	integer	NONE	NONE
Number of Days in Future to Query for Responses Due.
cCacheActionCode	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
cCacheCodeError	EV02	char	NONE	NONE
An option that specifies the type of processing for an event.
cSuppressErrorMessages	EV03	char	NONE	NONE
A radio button that specifies the level at which trace/track result is to be displayed. Select the Detail to display all transactions except IB, IX, and IZ types. Or, select Derivative Lots Only to display only those transactions that may have created new derivative lot.
szErrorMessageID	DTAI	char	NONE	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.
mnJobNumber	JOBS	MATH_NUMERIC	NONE	NONE
The job number (work station ID) which executed the particular job.
mnLineNumber	LNID	MATH_NUMERIC	NONE	NONE
A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns this number,but in some cases you can override it.
mnParentItemNumber	KIT	MATH_NUMERIC	NONE	NONE
The system provides for three separate item numbers. 1. Item Number (short) - An eight-digit, computer assigned, completely non-significant item number. 2. 2nd Item Number - The 25-digit, free form, user defined alphanumeric item number. 3. 3rd Item Number - Another 25-digit, free form, user defined alphanumeric item number.
mnSequenceNumber	SEQN	MATH_NUMERIC	NONE	NONE
A number used to organize the table into a logical group for online viewing and reporting.
szMultiLevelConfiguredStringse	MC01	char	NONE	NONE
Reserved by J.D. Edwards A string that the system generates by concatinating the value of each segment value.
szMultiLevelConfiguredStringSe	MC02	char	NONE	NONE
Reserved by J.D. Edwards A string that the system generates by concatinating the value of each segment.
idCursor	GENLNG	ID	NONE	NONE
General purpose ID variable.
cReturnCursor	EV04	char	NONE	NONE
PeopleSoft event point processing flag 04.
szConfiguratorSequenceID	ATSQ	char	OPT	NONE
Reserved by J.D. Edwards A string that is generated to uniquely identify and sequence items in a configuration.
cStringType	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
nIndexNumber	INT01	integer	OPT	NONE
Number of Days in Future to Query for Responses Due.

Related Functions

None

Related Tables

None