PrefCommitByLocationCache

Preference Commitments By Location Cache

Minor Business Rule

Object Name: B4201200

Parent DLL: CDIST

Location: Client/Server

Language: C

Functional Description

Purpose

This function will perform Get, Add, Update, Delete, Delete All, Get Next, Add/Update, and Terminate
functions on the Pref Commit Location Qty cache used in Sale Order Preference Commitments.

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.

Setup Notes and Prerequisites

None.

Special Logic

None.

Technical Specification

Related Tables

None.

Related Business Functions

None.

Processing

Cache Layout:

AliasData ItemNotes
LNIDParent Sales Order Line NumberIndex value
ITMParent Item Number(short)Index value
MCUBranch/PlantIndex value
PELSegment NumberIndex value
ATSQConfigurator Sequence Number
ATIVSegment Value
CNUMNumeric Segment Indicator
RRNError counter/flag
RNDCRound Derived Calculation
SEQConfigured Item Level Seq. No.
LVLConfigured Item Level

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

D4201200 - Cache Preference Commitments By Location







Special Input Expected





Parameters:





Data Item Data Structure DescriptionI/ORequired   Notes





JOBS      Job Number                   I   Y     Used in Cache Name


MCU      Branch                  I/O   N     Key value


LOCN      Location                  I/O   N


QTY      Avail Quantity            I/O   N


INT01      Number of Keys             I   Y     Number of Keys to be


                                                           used in the cache


                                                           retrieval/delete


                                                           process


EV01      Suppress Error Messages       I   N     1 = Suppress runtime


                                                           error message handling


                                                           0 = Allow runtime error


                                                           message handling


EV01      Process Mode             I   Y     "1" = Get cache element


                                                           "2" = Add element


                                                           "3" = Update element


                                                           "4" = Delete cache


                                                                 elements (keyed)


                                                           "5" = Delete All cache


                                                                 elements


                                                           "6" = Get Next cache


                                                                 element


                                                           "7"  = Add/Update cache


                                                                  element


                                                           "8" = End cache


                                                                 (terminate cache)


EV01      Return Cursor            I/O   Y     1 = Return Cursor


                                                           0 = Do not Return


                                                               Cursor


GENLNGCursor                  I/O   N     Returns cursor


 








Special Output Returned








Parameters:





Data Item Data Structure DescriptionI/ORequired   Notes





MCU      Branch                  I/O   N     Key value


LOCN      Location                  I/O   N


QTY      Avail Quantity            I/O   N





DTAI      Error Message ID             O   N


EV01      Cache Code Error             O   N     "0" = Successful Process


                                                           "1" = Reached End Of


                                                                 CACHE


                                                           "2" = Invalid Input


                                                                 Parameter


                                                           "3" = Failed to Create


                                                                 CACHE


                                                           "4" = Failed to


                                                                 Add/Update CACHE


                                                           "5" = Failed to Delete


                                                                 CACHE


                                                           "6" = Fetch Failed 


EV01      Return Cursor            I/O   Y     1 = Return Cursor


                                                           0 = Do not Return


                                                               Cursor


GENLNGCursor                  I/O   N     Returns cursor

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cSuppressErrorMessage	SUPPS	char	NONE	NONE
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.
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.
cCacheCodeError	EV01	char	NONE	NONE
"0" = Successful Process "1" = Reached End Of CACHE "2" = Invalid Input Parameter "3" = Failed to Create CACHE "4" = Failed to Add/Update CACHE "5" = Failed to Delete CACHE "6" = Fetch Failed ^
cCacheActionCode	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
cReturnCursor	EV01	char	NONE	NONE
1 = Return Cursor 0 = Do not Return Cursor ^
idCursor	GENLNG	ID	NONE	NONE
General purpose ID variable.
nNumberOfKeys	INT01	integer	NONE	NONE
Number of Keys to be used in the cache retrieval/delete process. ^
mnJobNumber	JOBS	MATH_NUMERIC	NONE	NONE
The job number (work station ID) which executed the particular job.
szBranch	MCU	char	NONE	NONE
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.
szLocation	LOCN	char	NONE	NONE
The storage location from which goods will be moved.
mnQuantity	QTY	MATH_NUMERIC	NONE	NONE
The number of units associated with an asset.
szLot	LOTN	char	OPT	NONE
A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.

Related Functions

None

Related Tables

None