CacheProcessMRPItemQuantities

Cache, Process MRP Item Quantities

Major Business Rule

Object Name: B3401290

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, and Terminate 

functions on the MRP Item Quantity Cache used in the MRP/MPS planning programs (P3482 and P3483).


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.


1.2 Setup Notes and Prerequisites
• 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 - close input cache cursor and free the pointer
• 'D' Debug Mode - Dumps the contents of the entire cache into a text file

• 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, update, or delete the first record.

1.3Special Logic

This function creates a unique cache for each MRP/MPS planning process.  The function appends the 

input Job Number string to the two character ID 'IQ' to build the cache name used for the calling 

application.


2.Technical Specifications


Cache Layout:Cache includes all of the following fields; key fields are noted.


Data Item Data Structure DescriptionKey Field

MCU    Branch                        Y

TP      Quantity Type                 Y

DRQJ     Date                             Y

NQ01      Quantity



I.Perform setup functions 

A.Initialize cache to get handle.
B.If not successful, set error "032E", set Cache Error Code = '3', and return failure.

C.Set Cache Error Code = '0'

D.Set return code to success.


II.Processing Based on Mode.


A.If Cache Action Code is '1' - GET:
1.Open cursor, Reset cursor.
2.Retrieve the first element on the cache matching the key values passed as input.  If the 

input Number of Keys is zero, fetch the first element in the cache.

3.Load the values from the retrieved element into the data structure to be passed back to 

the calling program.

4.If Sequential Fetch is '1' then Return the Cursor Pointer.

5.If get fails set Cache Error Code = '6'.


B.If Cache Action Code is '2' - ADD:
1.Insert a new cache element with values from data structure.
2.If add fails set error "032E", set Cache Error Code = '4', and return failure.


C.If Cache Action Code is '3' - UPDATE:
1.Update existing cache element with values from data structure.
2.If update fails set error "032E", set Cache Error Code = '4', and return failure.


D.If Cache Action Code is '4' - DELETE:
1.If the Number of Keys is not 0, delete all elements in the cache matching the key values 
passed as input.

2.If the number of keys is 0, delete the first cache element.

3.If delete fails, set Cache Error Code = '5'.


E.If Cache Action Code is '5' - DELETE ALL:

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


F.If Cache Action Code is '6' - GET NEXT:
1.Retrieve the next element in the cache matching the key values passed as input (the 
cursor should have been set through a previous "Get" action, i.e. Cache Action Code '1'.  If the 

Number of Keys is zero then fetch the next record without 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 the cursor, free pointer and set Cache Error Code = 

'1'.


G.If Cache Action Code is '7' - ADD/UPDATE:

1.Delete Record , if one exists,  that matches the full key from Input.
2.Insert a new cache element with values from data structure.

3.If add fails set error "032E", set Cache Error Code = '4', and return failure.


H.If Cache Action Code is '8' - END
1.Perform cleanup functions (Terminate cache).

I.If Cache Action Code is '9' - CLOSE
1.Retrieve cursor from Cache Cursor Pointer.
2.Close Cursor

3.Free Pointer

4.Set Cache Cursor Pointer = 0


J.If Cache Action Code is 'D' - DUMP
1.Dump contents of the cache into a text file.

Data Structure

D3401290 - Cache, Process MRP Item Quantities


Data Item Data Structure DescriptionI/ORequiredNotes

JOB            Job Number                        IY      Job Number as string for 
cache name

MCU            Branch                        I/OY      Key value

TP            Quantity Type                  I/OY      key value

DRQJ            Date                              I/O      key value

NQ01            Quantity                        I/OY

EV01            Cache Action Code                  IY      '1' = Get cache element 

                                                                        '2' = Add element  

                                                                        '3' = Update element 

                                                                        '4' = Delete cache elements 

                                                                        '5' = Delete All cache 

elements 

                                                                        '6' = Get Next cache element 

                                                                        '7'  = Add/Update cache 

element 

                                                                        '8' = End cache (terminate 

cache) 

                                                                        '9' = Close Cursor and Free 

Ptr 

                                                                        'D' = Dump cache into text 

file

EV01            Cache Error Code                  ON      '0' = Success Process 

                                                                        '1' = Reached End of 

Cache(mode 6)                                                                         

                                                                        '2' = Invalid Input Parameter 


                                                                        '3' = Failed to Create Cache 

                                                                        '4' = Failed to Add/Update 

Cache 

                                                                        '5' = Failed to Delete Cache 

                                                                        '6' = Fetch Failed(mode 1 or 

9)

INT01            Number of Keys                      IY      Number of Keys to be used in 

the 

                                                                        cache process.

GENLNG         Cache Cursor Ptr                  I/ONUsed when Sequential Fetch is 

'1'


EV02            Sequential Fetch                  I/ON      If Action is GET, and this 

parm is 

                                                                        '1' it will return the cursor 

pointer 

                                                                        in Cache Cursor Ptr

SUPPS            Suppress Error Message              IN      '0'= allow runtime error 

message 

                                                                             handling. 

                                                                        '1'= Suppress runtime error 

message 

                                                                             handling.

DTAI            Error Message Id                  ON      " " = Success 

                                                                        "032E" = Error Processing 

Cache




^

Parameter NameData ItemData TypeReq/OptI/O/Both
szJobNumberJOBcharNONENONE

Job Number

szBranchMCUcharNONENONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szQuantityTypeTPcharNONENONE

An identification code of a Report Writer Type.

jdDateDRQJJDEDATENONENONE

The date that an item is scheduled to arrive or that an action is scheduled for completion.

mnQuantityNQ01MATH_NUMERICNONENONE

The net transaction quantity from all transactions for an Item for Period 01.

cCacheActionCodeEV01charNONENONE

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

cCacheErrorCodeEV02charNONENONE

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

nNumberOfKeysINT01integerNONENONE

Number of Days in Future to Query for Responses Due. 

cSuppressErrorMessageSUPPScharNONENONE

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.

szErrorMessageIDDTAIcharNONENONE

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.

idCacheCursorPtrGENLNGIDNONENONE

General purpose ID variable.

cSequentialFetchEV03charNONENONE

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. 

Related Functions

None

Related Tables

None