ReportDataCache

Report Data Cache - Business Function

Minor Business Rule

Object Name: B3104020

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Report Data Cache.  The Report Data Cache is used by the WIP Revaluation
program to store all WIP revaluation records in order to print these records on the report output.

Setup Notes and Prerequisites
The ReportDataCache 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.  szKeyCompany - A member of the cache and part of the cache key.
7.  szBusinessUnit - A member of the cache and part of the cache key.
8.  szGLCategoryCode - A member of the cache and part of the cache key.
9.  mnWorkOrderDocumentNumber - A member of the cach and part of the cache key.
10.  mnTotalNewWIPCost - A member of the cache.
11.  mnTotalOldWIPCost - A member of the cache.
12.  mnVariance - A member of the cache.
13.  mnOriginalQuantity - A member of the cache.
14.  szOrderType - A member of the cach and part of the cache key.
15.  mnNumberKeys - Indicates the number of keys to be used for a fetch from the cache.
16.  cReturnPointer - 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:
szKeyCompany
  szBusinessUnit
  szGLCategoryCode
  mnWorkOrderDocumentNumber
  szOrderType
  sz2ndItemNumber
  mnTotalNewWIPCost
  mnTotalOldWIPCost
  mnVariance
  mnOriginalQuantity
Cache Key:
szKeyCompany
  szBusinessUnit
  szGLCategoryCode
  mnWorkOrderDocumentNumber
  szOrderType

Data Structure

D3104020 - Report Data 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.

szKeyCompany KCOO char OPT NONE

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to
assign a next number. In this case, you probably would not use the order company to locate the document.

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

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

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.

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.

mnTotalNewWIPCost MN29D9 MATH_NUMERIC OPT NONE

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

mnTotalOldWIPCost MN29D9 MATH_NUMERIC OPT NONE

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

mnVariance MN29D9 MATH_NUMERIC OPT NONE

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

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

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.
szKeyCompany	KCOO	char	OPT	NONE
A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to assign a next number. In this case, you probably would not use the order company to locate the document.
szBusinessUnit	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.
szGLCategoryCode	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.
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.
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.
mnTotalNewWIPCost	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnTotalOldWIPCost	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnVariance	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnOriginalQuantity	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.