WorkOrderVarianceCache

Work Order Variance Cache - Business Function

Minor Business Rule

Object Name: B3104030

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Work Order Variance Cache.  The Work Order Variance Cache is used by
the WIP Revaluation program to store the WIP variance amounts for each work order processed by the UBE.

Setup Notes and Prerequisites
The WorkOrderVarianceCache function 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.  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
2.  szCacheJobNumber - A unique job number that can be combined with business function object name to create a unique cache name.
3.  cSuppressErrorMessage - A value of '1' indicates that errors encountered during processing should not be set in the message center.
4.   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.
5.  szErrorMessage - The error messge ID returned from the business function when an error occurs.  This message is returned regardless of the
value of the cSuppressErrorMessage parameter.
6.  mnWorkOrderDocumentNumber - A member of the cache and part of the cache key.
7.  mnCurrentVarianceAmount - A member of the cache.
8.  mnPlannedVarianceAmount - A member of the cache.
9.  mnActualVarianceAmount - A member of the cache.
10.  mnCompletedVarianceAmount - A member of the cache.
11.  mnScrappedVarianceAmount - A member of the cache.
12.  szOrderType - A member of the cach and part of the cache key.
13.  mnNumberKeys - Indicates the number of keys to be used when fetching from the cache.
14.  cReturnPointer - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has occured.
15.  szWorkCenter - A member of the cach and part of the cache key.

Technical Specifications
Cache Structure:
mnWorkOrderDocumentNumber
szOrderType
szWorkCenter
  mnCurrentVarianceAmount
  mnPlannedVarianceAmount
  mnActualVarianceAmount
  mnCompletedVarianceAmount
mnScrappedVarianceAmount
Cache Key:
mnWorkOrderDocumentNumber
  szOrderType
szWorkCenter

Data Structure

D3104030 - Work Order Variance Cache - Data Structure

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

cMode EV01 char OPT INPUT

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

szCacheJobNumber JOBN char OPT INPUT

The code that identifies the work station ID that executed a particular job.

cSuppressErrorMessage EV01 char OPT INPUT

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

idhCursor GENLNG ID OPT BOTH

General purpose ID variable.

szErrorMessage DTAI char OPT OUTPUT

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.

mnWorkOrderDocumentNumber 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.

mnCurrentVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

This is a generic field used as a work field in Everest.

mnPlannedVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

This is a generic field used as a work field in Everest.

mnActualVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

This is a generic field used as a work field in Everest.

mnCompletedVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

This is a generic field used as a work field in Everest.

mnScrappedVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

This is a generic field used as a work field in Everest.

szOrderType DCTO char OPT NONE

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and
should not be changed: P Accounts Payable documents R Accounts Receivable documents T Payroll documents I Inventory documents
O Purchase Order Processing documents J General Accounting/Joint Interest Billing documents S Sales Order Processing documents

mnNumberKeys NKEYS MATH_NUMERIC OPT INPUT

The number of keys in an index that will be used to retrieve, delete, or update a record.

cReturnPointer EV01 char OPT INPUT

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

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.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cMode	EV01	char	OPT	INPUT
An option that specifies the type of processing for an event.
szCacheJobNumber	JOBN	char	OPT	INPUT
The code that identifies the work station ID that executed a particular job.
cSuppressErrorMessage	EV01	char	OPT	INPUT
An option that specifies the type of processing for an event.
idhCursor	GENLNG	ID	OPT	BOTH
General purpose ID variable.
szErrorMessage	DTAI	char	OPT	OUTPUT
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.
mnWorkOrderDocumentNumber	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.
mnCurrentVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnPlannedVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnActualVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnCompletedVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnScrappedVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
szOrderType	DCTO	char	OPT	NONE
A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and should not be changed: P Accounts Payable documents R Accounts Receivable documents T Payroll documents I Inventory documents O Purchase Order Processing documents J General Accounting/Joint Interest Billing documents S Sales Order Processing documents
mnNumberKeys	NKEYS	MATH_NUMERIC	OPT	INPUT
The number of keys in an index that will be used to retrieve, delete, or update a record.
cReturnPointer	EV01	char	OPT	INPUT
An option that specifies the type of processing for an event.
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.