ProcessCoByProductsCache

Process / Co-By Products Cache - Business Function

Minor Business Rule

Object Name: B3104040

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Process Co-By Products cache.  The Process Co-By Products cache is used
by the WIP Revaluation program to store Co and By Product records processed by the UBE.

Setup Notes and Prerequisites
The ProcessCoByProductsCache 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.  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.
5.   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.
6.  mnWorkOrderDocumentNumber - A member of the cache and part of the cache key.
7.  szCostType - A member of the cache and part of the cache key.
8.  szWorkCenter - A member of the cach and part of the cache key.
9.  szBranch - A member of the cache.
10.  mnShortItemNumber - A member of the cache.
11.  mnCompletedVarianceAmount - A member of the cache.
12.  mnScrappedVarianceAmount - A member of the cache.
13.  mnNetVarianceAmount - A member of the cache.
14.  mnActualAmount - A member of the cache.
15.  szOrderType - A member of the cach and part of the cache key.
16.  mnNumberKeys - Indicates the number of keys to be used when fetching from the cache.
17.  cReturnPointer - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has occured.
18.  szCompany - A member of the cache.
19.  szGlCategory - A member of the cache.
20.  mnWorkOrderQty - A member of the cache.

Technical Specifications
Cache Structure:
mnWorkOrderDocumentNumber
szOrderType
  szCostType
  szWorkCenter
  szBranch
  mnShortItemNumber
mnCompletedVarianceAmount
  mnScrappedVarianceAmount
  mnNetVarianceAmount
mnActualAmount
  szCompany
  szGlCategory
  mnWorkOrderQty
Cache Key:
mnWorkOrderDocumentNumber
  szOrderType
  szCostType
  szWorkCenter

Data Structure

D3104040 - Process / Co-By Products 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.

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.

idhCursor GENLNG ID OPT BOTH

General purpose ID variable.

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.

szCostType COST char OPT NONE

A code that designates each element of cost for an item. Examples of the cost object types are:   o  A1  Purchased raw material   o  B1
Direct labor routing rollup   o  B2  Setup labor routing rollup   o  C1  Variable burden routing rollup   o  C2  Fixed burden routing rollup   o  Dx  Outside
operation routing rollup   o  Xx  Extra add-ons, such as electricity and water The optional add-on computations usually operate with the type
Xx extra add-ons. This cost structure allows you to use an unlimited number of cost components to calculate alternative cost rollups. The
system then associates these cost components with one of six user defined summary cost buckets.

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.

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

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.

mnNetVarianceAmount MN29D9 MATH_NUMERIC OPT NONE

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

mnActualAmount CLAT MATH_NUMERIC OPT NONE

The actual amount to produce a given amount of product.

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.

szCompany CO char OPT NONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000
for transaction entries.

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.

mnWorkOrderQty UORG MATH_NUMERIC OPT NONE

The quantity of units affected by this transaction.

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.
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.
idhCursor	GENLNG	ID	OPT	BOTH
General purpose ID variable.
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.
szCostType	COST	char	OPT	NONE
A code that designates each element of cost for an item. Examples of the cost object types are: o A1 Purchased raw material o B1 Direct labor routing rollup o B2 Setup labor routing rollup o C1 Variable burden routing rollup o C2 Fixed burden routing rollup o Dx Outside operation routing rollup o Xx Extra add-ons, such as electricity and water The optional add-on computations usually operate with the type Xx extra add-ons. This cost structure allows you to use an unlimited number of cost components to calculate alternative cost rollups. The system then associates these cost components with one of six user defined summary cost buckets.
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.
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
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.
mnNetVarianceAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnActualAmount	CLAT	MATH_NUMERIC	OPT	NONE
The actual amount to produce a given amount of product.
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.
szCompany	CO	char	OPT	NONE
A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 for transaction entries.
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.
mnWorkOrderQty	UORG	MATH_NUMERIC	OPT	NONE
The quantity of units affected by this transaction.