WIPRevaluationCache

WIP Revaluation Cache Business Function

Minor Business Rule

Object Name: B3104100

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functionality Overview

Purpose
This function was created for the WIP Revaluation enhancement.  It is called by both the Load WIP Revaluation Cache business
function (B3104150) and the WIP Revaluation UBE (R30837).  It's purpose is to appropriately manipulate the WIP Revaluation
Cache, based on the cMode parameter.

Setup Notes and Prerequisites
Before any cache manipulation can take place this function must be called with cMode = 0 in order to initiate the cache.  When
cache processing is finished, the function should be called with cMode = 5 in order to terminate the cache.

Parameter Details:
1.  cMode
0 = Create a unique cache instance
1 = Add a unique record to cache
2 = Read a record from the cache - for sequential read set cReturnPointer = '1'
3 = Update a record in the cache
4 = Delete a record from the cache based on keys
5 = Terminate 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.  mnLowLevelCode - A member of the cache and part of the cache key.
6.  szBranch - A member of the cache and part of the cache key.
7.  mnShortItemNumber - A member of the cache and part of the cache key.
8.  mnWorkOrderNumber - A member of the cache and part of the cache key.
9.  szCompletionLocation - A member of the cache and part of the cache key.
10.  szCompletionLot - A member of the cache and part of the cache key.
11.  szIssueLocation - A member of the cache and part of the cache key.
12.  szIssueLot - A member of the cache and part of the cache key.
13.  szOrderType - A member of the cache and part of the cache key.
14.  sz2ndItemNumber - A member of the cache.
15.  sz3rdItemNumber - A member of the cache.
16.  cParentChild - A member of the cache.
17.  szGLCategory - A member of the cache.
18.  szCostMethod - A member of the cache.
19.  szStatusCodeWo - A member of the cache.
20.  cVarianceFlag - A member of the cache.
21.  cExploded - A member of the cache.
22.  cInitialBuildup - A member of the cache.
23.  szErrorMessageID - 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.
24.  szProductionUOM - A member of the cache.
25.  cStockingType - A member of the cache.
26.  mnWorkOrderUnits - A member of the cache.
27.  cCostLevel - A member of the cache.
28.  mnCompletedUnits - A member of the cache.
29.  mnScrappedUnits - A member of the cache.
30.  mnNumberKeys - Indicates the number of keys to be used when fetching from the cache.
31.  cReturnPointer - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has
occured.
32.  cLevel - A member of the cache.
33.  szWorkOrderCostingMethod - A member of the cache

Data Structure

D3104100 - WIP Revaluation Input Data Cache Business Function

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

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.

cSuppressErrorMessage EV01 char OPT NONE

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

idhCursor GENLNG ID OPT NONE

General purpose ID variable.

mnLowLevelCode LLX MATH_NUMERIC OPT NONE

This identifies the lowest level in any bill of material at which a particular component may appear..

szBranch MMCU char OPT NONE

A code that represents a high-level business unit. Use this code to refer to a branch or plant that might have departments or jobs, which
represent lower-level business units, subordinate to it. For example:     o Branch/Plant (MMCU)     o Dept A (MCU)     o Dept B (MCU)     o Job 123
(MCU) Business unit security is based on the higher-level business unit.

mnShortItemNumber ITM MATH_NUMERIC OPT NONE

An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and
so forth. The item numbers are as follows:   o Item Number (short) - An eight-digit, computer-assigned item number     o 2nd Item Number - The
25-digit, free-form, user defined alphanumeric item number     o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item
number

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

szCompletionLocation LOCN char OPT NONE

The storage location from which goods will be moved.

szCompletionLot LOTN char OPT NONE

A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.

szIssueLocation LOCN char OPT NONE

The storage location from which goods will be moved.

szIssueLot LOTN char OPT NONE

A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.

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

sz2ndItemNumber LITM char OPT NONE

A number that identifies the item. The system provides three separate item numbers plus an extensive cross-reference capability to
alternative item numbers. The three types of item numbers are: Item Number (short) An 8-digit, computer-assigned item number. 2nd Item Number A
25-digit, user defined, alphanumeric item number. 3rd Item Number Another 25-digit, user defined, alphanumeric item number. In addition to
these three basic item numbers, the system provides an extensive cross-reference search capability. You can define numerous
cross-references to alternative part numbers. For example, you can define substitute item numbers, replacements, bar codes, customer numbers, or
supplier numbers.

sz3rdItemNumber AITM char OPT NONE

The system provides three separate item numbers plus an extensive cross-reference capability to alternate item numbers. These item
numbers are as follows: 1.  Item Number (short) - An 8-digit, computer-assigned 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. In addition to
these three basic item numbers, an extensive cross-reference search capability has been provided (see XRT). Numerous cross references to
alternate part numbers can be user defined, such as substitute item numbers, replacements, bar codes, customer numbers, or supplier
numbers.

cParentChild PART char OPT NONE

An option that specifies whether the system displays parent records or child records. If you turn on this option, the system displays parent
records for the address book number entered. Also a field that indicates whether a record is a parent or child. For the field, valid values
are: P Parent   C Child

szGLCategory GLPT char OPT NONE

A user defined code (41/9) that identifies the G/L offset that system uses when it searches for the account to which it posts the transaction. If
you do not want to specify a class code, you can enter **** (four asterisks) in this field. You can use automatic accounting instructions (AAIs) to
predefine classes of automatic offset accounts for the Inventory Management, Procurement, and Sales Order Management systems. You
might assign G/L class codes as follows:    IN20   Direct Ship Orders    IN60   Transfer Orders    IN80   Stock Sales The system can generate
accounting entries based upon a single transaction. For example, a single sale of a stock item can trigger the generation of accounting entries
similar to the following:         Sales-Stock (Debit) xxxxx.xx    A/R Stock Sales (Credit) xxxxx.xx    Posting Category: IN80             Stock Inventory
(Debit) xxxxx.xx    Stock COGS (Credit) xxxxx.xx The system uses the class code and the document type to find the AAI.

szCostMethod LEDG char OPT NONE

A user defined code (40/CM) that specifies the basis for calculating item costs. Cost methods 01 through 19 are reserved for J.D. Edwards
use.

szStatusCodeWo SRST char OPT NONE

A user defined code (00/SS) that describes the status of a work order, rate schedule, or engineering change order. Any status change from
90 through 99  triggers the system to automatically update the completion date.

cVarianceFlag PPFG char OPT NONE

A 1 in this field indicates that this work order has had work order activity run against it in update mode. A 2 in this field indicates that this work
order has had the appropriate variances calculated and reported to the general ledger.

cExploded EV01 char OPT NONE

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

cInitialBuildup EV01 char OPT NONE

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

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

szProductionUOM UOM char OPT NONE

A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).

cStockingType STKT char OPT NONE

A user defined code (41/I) that indicates how you stock an item, for example, as finished goods or as raw materials. The following stocking
types are hard-coded and you should not change them:    0   Phantom item    B Bulk floor stock    C Configured item    E Emergency/corrective
maintenance    F Feature    K Kit parent item    N Nonstock The first character of Description 2 in the user defined code table indicates if the item
is purchased (P) or manufactured (M).

mnWorkOrderUnits UORG MATH_NUMERIC OPT NONE

The quantity of units affected by this transaction.

cCostLevel CLEV char OPT NONE

A code that indicates whether the system maintains one overall inventory cost for the item, a different cost for each branch/plant, or a
different cost for each location and lot within a branch/plant. The system maintains inventory costs in the Inventory Cost table (F4105). Valid codes
are:    1   Item level    2   Item/Branch level    3   Item/Branch/Location level

mnCompletedUnits SOQS MATH_NUMERIC OPT NONE

The number of units committed for shipment in Sales Order Entry, using either the entered or the primary unit of measure defined for this
item. In the Manufacturing system and Work Order Time Entry, this field can indicate completed or scrapped quantities. The quantity type is
determined by the type code entered.

mnScrappedUnits SOCN MATH_NUMERIC OPT NONE

The number of units canceled in Sales Order or Work Order Processing, using either the entered or the primary unit of measure defined for
this item. In manufacturing, this can also be the number of units scrapped to date.

mnNumberKeys NKEYS MATH_NUMERIC OPT NONE

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.

cLevel EV01 char OPT NONE

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

szWorkOrderCostingMethod LEDG char OPT NONE

A user defined code (40/CM) that specifies the basis for calculating item costs. Cost methods 01 through 19 are reserved for J.D. Edwards
use.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
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.
cSuppressErrorMessage	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
idhCursor	GENLNG	ID	OPT	NONE
General purpose ID variable.
mnLowLevelCode	LLX	MATH_NUMERIC	OPT	NONE
This identifies the lowest level in any bill of material at which a particular component may appear..
szBranch	MMCU	char	OPT	NONE
A code that represents a high-level business unit. Use this code to refer to a branch or plant that might have departments or jobs, which represent lower-level business units, subordinate to it. For example: o Branch/Plant (MMCU) o Dept A (MCU) o Dept B (MCU) o Job 123 (MCU) Business unit security is based on the higher-level business unit.
mnShortItemNumber	ITM	MATH_NUMERIC	OPT	NONE
An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item numbers (see data item XRT) to accommodate substitute item numbers, replacements, bar codes, customer numbers, supplier numbers, and so forth. The item numbers are as follows: o Item Number (short) - An eight-digit, computer-assigned item number o 2nd Item Number - The 25-digit, free-form, user defined alphanumeric item number o 3rd Item Number - Another 25-digit, free-form, user defined alphanumeric item number
mnWorkOrderNumber	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.
szCompletionLocation	LOCN	char	OPT	NONE
The storage location from which goods will be moved.
szCompletionLot	LOTN	char	OPT	NONE
A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.
szIssueLocation	LOCN	char	OPT	NONE
The storage location from which goods will be moved.
szIssueLot	LOTN	char	OPT	NONE
A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.
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
sz2ndItemNumber	LITM	char	OPT	NONE
A number that identifies the item. The system provides three separate item numbers plus an extensive cross-reference capability to alternative item numbers. The three types of item numbers are: Item Number (short) An 8-digit, computer-assigned item number. 2nd Item Number A 25-digit, user defined, alphanumeric item number. 3rd Item Number Another 25-digit, user defined, alphanumeric item number. In addition to these three basic item numbers, the system provides an extensive cross-reference search capability. You can define numerous cross-references to alternative part numbers. For example, you can define substitute item numbers, replacements, bar codes, customer numbers, or supplier numbers.
sz3rdItemNumber	AITM	char	OPT	NONE
The system provides three separate item numbers plus an extensive cross-reference capability to alternate item numbers. These item numbers are as follows: 1. Item Number (short) - An 8-digit, computer-assigned 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. In addition to these three basic item numbers, an extensive cross-reference search capability has been provided (see XRT). Numerous cross references to alternate part numbers can be user defined, such as substitute item numbers, replacements, bar codes, customer numbers, or supplier numbers.
cParentChild	PART	char	OPT	NONE
An option that specifies whether the system displays parent records or child records. If you turn on this option, the system displays parent records for the address book number entered. Also a field that indicates whether a record is a parent or child. For the field, valid values are: P Parent C Child
szGLCategory	GLPT	char	OPT	NONE
A user defined code (41/9) that identifies the G/L offset that system uses when it searches for the account to which it posts the transaction. If you do not want to specify a class code, you can enter **** (four asterisks) in this field. You can use automatic accounting instructions (AAIs) to predefine classes of automatic offset accounts for the Inventory Management, Procurement, and Sales Order Management systems. You might assign G/L class codes as follows: IN20 Direct Ship Orders IN60 Transfer Orders IN80 Stock Sales The system can generate accounting entries based upon a single transaction. For example, a single sale of a stock item can trigger the generation of accounting entries similar to the following: Sales-Stock (Debit) xxxxx.xx A/R Stock Sales (Credit) xxxxx.xx Posting Category: IN80 Stock Inventory (Debit) xxxxx.xx Stock COGS (Credit) xxxxx.xx The system uses the class code and the document type to find the AAI.
szCostMethod	LEDG	char	OPT	NONE
A user defined code (40/CM) that specifies the basis for calculating item costs. Cost methods 01 through 19 are reserved for J.D. Edwards use.
szStatusCodeWo	SRST	char	OPT	NONE
A user defined code (00/SS) that describes the status of a work order, rate schedule, or engineering change order. Any status change from 90 through 99 triggers the system to automatically update the completion date.
cVarianceFlag	PPFG	char	OPT	NONE
A 1 in this field indicates that this work order has had work order activity run against it in update mode. A 2 in this field indicates that this work order has had the appropriate variances calculated and reported to the general ledger.
cExploded	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
cInitialBuildup	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szErrorMessageID	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.
szProductionUOM	UOM	char	OPT	NONE
A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).
cStockingType	STKT	char	OPT	NONE
A user defined code (41/I) that indicates how you stock an item, for example, as finished goods or as raw materials. The following stocking types are hard-coded and you should not change them: 0 Phantom item B Bulk floor stock C Configured item E Emergency/corrective maintenance F Feature K Kit parent item N Nonstock The first character of Description 2 in the user defined code table indicates if the item is purchased (P) or manufactured (M).
mnWorkOrderUnits	UORG	MATH_NUMERIC	OPT	NONE
The quantity of units affected by this transaction.
cCostLevel	CLEV	char	OPT	NONE
A code that indicates whether the system maintains one overall inventory cost for the item, a different cost for each branch/plant, or a different cost for each location and lot within a branch/plant. The system maintains inventory costs in the Inventory Cost table (F4105). Valid codes are: 1 Item level 2 Item/Branch level 3 Item/Branch/Location level
mnCompletedUnits	SOQS	MATH_NUMERIC	OPT	NONE
The number of units committed for shipment in Sales Order Entry, using either the entered or the primary unit of measure defined for this item. In the Manufacturing system and Work Order Time Entry, this field can indicate completed or scrapped quantities. The quantity type is determined by the type code entered.
mnScrappedUnits	SOCN	MATH_NUMERIC	OPT	NONE
The number of units canceled in Sales Order or Work Order Processing, using either the entered or the primary unit of measure defined for this item. In manufacturing, this can also be the number of units scrapped to date.
mnNumberKeys	NKEYS	MATH_NUMERIC	OPT	NONE
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.
cLevel	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szWorkOrderCostingMethod	LEDG	char	OPT	NONE
A user defined code (40/CM) that specifies the basis for calculating item costs. Cost methods 01 through 19 are reserved for J.D. Edwards use.