ShopFloorCostsCache

Shop Floor Costs Cache

Minor Business Rule

Object Name: B3104410

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Shop Floor Costs Cache.  The Shop Floor Costs Cache is used by the WIP
Revaluation program to cache all routing cost records that will be used to revalue work order production costs.

Setup Notes and Prerequisites
The ShopFloorCostsCache must be called with cMode = 0 in order to create an instance of the cache before any other caching functionality can be
performed.  In addition, the cache must be called with cMode = 4 after all desired caching functionality has been performed in order to terminate the cache.

Business Function Paramenters:
1.  mnWorkOrderNumber - A member of the cache and part of the cache key.
2.  szWorkCenter - A member of the cache and part of the cache key.
3.  cMode - Indicates the desired processing.
     Valid modes include:
0 = Create an instance of the cache
1 = Add a record to cache
2 = Read a record from cache
3 = Delete a record from cache
4 = Terminate the cache
4.  szCacheJobNumber - A unique job number that can be combined with business function object name to create a unique cache name.
5.  cErrorCode - Indicates that an error occured during cache processing
6.  szErrorMessage - The error message ID returned from the business function when an error occurs during processing.  This ID is
    returned regardless of the value in the cSuppressErrorMessage parameter.
7.  mnNumberOfKeys - Indicates the number of keys to be used for a fetch from the cache.
8.  mnB1CurrentAmount  - A member of the cache.
9.  mnB1PlannedAmount  - A member of the cache.
10.  mnB2ActualAmount  - A member of the cache.
11.  mnB2CurrentAmount  - A member of the cache.
12.  mnB2PlannedAmount  - A member of the cache.
13.  mnB3ActualAmount  - A member of the cache.
14.  mnB3CurrentAmount  - A member of the cache.
15.  mnB3PlannedAmount  - A member of the cache.
16.  mnB4ActualAmount  - A member of the cache.
17.  mnB4CurrentAmount  - A member of the cache.
18.  mnB4CurrentAmount  - A member of the cache.
19.  mnC1PlannedAmount  - A member of the cache.
20.  mnC1ActualAmount  - A member of the cache.
21.  mnC1CurrentAmount  - A member of the cache.
22.  mnC2PlannedAmount  - A member of the cache.
23.  mnC2ActualAmount  - A member of the cache.
24.  mnC2CurrentAmount  - A member of the cache.
25.  mnC3PlannedAmount  - A member of the cache.
26.  mnC3ActualAmount  - A member of the cache.
27.  mnC3CurrentAmount  - A member of the cache.
28.  mnC4CurrentAmount  - A member of the cache.
29.  mnC4PlannedAmount  - A member of the cache.
30.  mnC4ActualAmount  - A member of the cache.
31.   idhCursor - A cursor pointing to a particular record in the cache.  The cursor is passed back from the function when the cReturnPointer
          parameter is set to '1' and should be passed into the function for a sequential read of the cache.
32.  cReturnCursor - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has occured.

Technical Specifications
Cache Structure:
szCacheJobNumber
  mnOrderNumber
  szWorkCenter
  mnB1CurrentAmount
  mnB1PlannedAmount
mnB1ActualAmount
mnB2CurrentAmount
mnB2PlannedAmount
  mnB2ActualAmount
  mnB3CurrentAmount
  mnB3PlannedAmount
  mnB3ActualAmount
  mnB4CurrentAmount
  mnB4PlannedAmount
  mnB4ActualAmount
  mnC1CurrentAmount
  mnC1PlannedAmount
  mnC1ActualAmount
  mnC2CurrentAmount
  mnC2PlannedAmount
  mnC2ActualAmount
  mnC3CurrentAmount
  mnC3PlannedAmount
  mnC3ActualAmount
  mnC4CurrentAmount
  mnC4PlannedAmount
  mnC4ActualAmount

Cache Key:
mnOrderNumber
  szWorkCenter

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnOrderNumber	DOCO	MATH_NUMERIC	OPT	NONE
A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, and so on.
szWorkCenter	MCU	char	OPT	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.
cMode	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szCacheJobNumber	JOBN	char	OPT	NONE
The code that identifies the work station ID that executed a particular job.
cErrorCode	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szErrorMessage	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.
cNumberOfKeys	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
mnB1CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB1PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB1ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB2CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB2PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB2ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB3CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB3PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB3ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB4CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB4PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnB4ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC1CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC1PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC1ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC2CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC2PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC2ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC3CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC3PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC3ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC4CurrentAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC4PlannedAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnC4ActualAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
idhCursor	GENLNG	ID	OPT	NONE
General purpose ID variable.

ShopFloorCostsCache