ManufacturingJournalEntryCache

Manufacturing Journal Entry Cache

Minor Business Rule

Object Name: B3104280

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Manufacturing Journal Entry Cache.  The Manufacturing Journal Entry
Cache is used by the Manufacturing Journal Entries UBE (R31802A) to cache all journal entry records in order to print these records on the report
output.

Setup Notes and Prerequisites
The ManufacturingJournalEntryCache 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
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 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.
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.   szBatchType - A member of the cache and part of the cache key.
7.   mnBatch Number - A member of the cache and part of the cache key.
8.   jdBatch Date - A member of the cache.
9.   mnDocumentNumber - A member of the cache and part of the cache key.
10.  szOrderType - A member of the cach and part of the cache key.
11.  jdGLDate - A member of the cache.
12.  szCompany - A member of the cache and part of the cache key.
13.  szExplanation - A member of the cache.
14.  mnItemNumber - A member of the cache and part of the cache key.
15.  szGLAccount - A member of the cache and part of the cache key.
16.  cSubledgerType - A member of the cache and part of the cache key.
17.  mnDebitAmount - A member of the cache.
18.  mnCreditAmount - A member of the cache.
19.  szLedgerType - A member of the cache.
20.  cDocumentTypeIndicator A member of the cache and part of the cache key.
21.  szAccountDescription - A member of the cache.
22.  szDocumentType - A member of the cache.
23.  cReadByAccountNumber - A member of the cache.
24.  cSumWithinWO - Flag that indicates that journal entries should be summarized within work orders.
25.  cSumAcrossWO - Flag that indicates that journal entries should be summarized accross all work orders.
26.  szItemDescription - A member of the cache.
27.  mnWorkOrderNumber - A member of the cache and part of the cache key.
28.  szSubledger - A member of the cache and part of the cache key.

Technical Specifications
Cache Structure:
szCompany
szBatchType
mnBatchNumber
mnWorkOrderNumber
szOrderType
mnDocumentNumber
cDocumentTypeIndicator
mnItemNumber
cDebitCredit
cSubledgerType
   szSubledger
szGLAccount
mnLineNumber
szCacheJobNumber
jdBatchDate
jdGLDate
szExplanation
mnDebitAmount
mnCreditAmount
szLedgerType
szAccountDescription
szDocumentType
szItemDescription
Cache Key:
                szCompany
szBatchType
mnBatchNumber
mnWorkOrderNumber
szOrderType
mnDocumentNumber
cDocumentTypeIndicator
mnItemNumber
cDebitCredit
cSubledgerType
   szSubledger
szGLAccount
mnLineNumber

Data Structure

D3104280 - Manufacturing Journal Entry Cache

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.

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.

idhCursor GENLNG ID OPT NONE

General purpose ID variable.

szBatchType ICUT char OPT NONE

A code that specifies the system and type of transactions entered in a batch. The system assigns the value when you enter a transaction.
Valid values are set up in user defined code table 98/IT. You cannot assign new values. All batch types are hard coded.

mnBatchNumber ICU MATH_NUMERIC OPT NONE

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either
assign a batch number or let the system assign it using the Next Numbers program.

jdBatchDate DBT JDEDATE OPT NONE

The date of the batch.  If you leave this field blank, the system uses the current date.

mnDocumentNumber DOC MATH_NUMERIC OPT NONE

A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document
number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents
in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable     o
Original document - voucher     o Matching document - payment Accounts Receivable     o Original document - invoice     o Matching document -
receipt Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents:
deductions, unapplied receipts, chargebacks, and drafts.

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

jdGLDate DGJ JDEDATE OPT NONE

A date that identifies the financial period to which the transaction will be posted. You define financial periods for a date pattern code that you
assign to the company record. The system compares the date that you enter on the transaction to the fiscal date pattern assigned to the
company to retrieve the appropriate fiscal period number, as well as to perform date validations.

szCompany KCO char OPT NONE

A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher,
or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the
document company to retrieve the correct next number for that company. If two or more original documents have the same document number and
document type, you can use the document company to locate the desired document.

szExplanation EXR char OPT NONE

A name or remark that describes the purpose for using an account or conveys any other information that the user wants about the
transaction.

mnItemNumber 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

szGLAccount ANI char OPT NONE

A value that identifies an account in the general ledger. Use one of the following formats to enter account numbers:   o  Standard account
number (business unit.object.subsidiary or flex format).   o  Third G/L number (maximum of 25 digits).   o  Account ID number. The number is eight
digits long.     o  Speed code, which is a two-character code that you concatenate to the AAI item SP. You can then enter the code instead of
an account number. The first character of the account number indicates its format. You define the account format in the General Accounting
constants.

cSubledgerType SBLT char OPT NONE

A user defined code (00/ST) that is used with the Subledger field to identify the subledger type and how the system performs subledger
editing. On the User Defined Codes form, the second line of the description controls how the system performs editing. This is either hard-coded
or user defined. Valid values include: A Alphanumeric field, do not edit   N Numeric field, right justify and zero fill   C Alphanumeric field, right
justify and blank fill

mnDebitAmount MN29D9 MATH_NUMERIC OPT NONE

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

mnCreditAmount MN29D9 MATH_NUMERIC OPT NONE

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

szLedgerType LT char OPT NONE

A user defined code (09/LT) that specifies the type of ledger, such as AA (Actual Amounts), BA (Budget Amount), or AU (Actual Units). You
can set up multiple, concurrent accounting ledgers within the general ledger to establish an audit trail for all transactions.

cDocumentTypeIndicator EV01 char OPT NONE

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

szAccountDescription DL01 char OPT NONE

A user defined name or remark.

szDocumentType DCT char OPT NONE

A user defined code (00/DT) that identifies the origin and purpose of the transaction.  PeopleSoft reserves several prefixes for document
types, such as, vouchers, invoices, receipts, and timesheets. The reserved document type prefixes for codes are: P Accounts payable
documents R Accounts receivable documents T Time and Pay documents I Inventory documents O Purchase order documents S Sales order
documents

cReadByAccountNumber EV01 char OPT NONE

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

cSumWithinWO EV01 char OPT NONE

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

cSumAcrossWO EV01 char OPT NONE

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

szItemDescription DSC1 char OPT NONE

Brief information about an item; a remark or an explanation.

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.

szSubledger SBL char OPT NONE

A code that identifies a detailed, auxiliary account within a general ledger account. A subledger can be an equipment item number or an
address book number. If you enter a subledger, you must also specify the subledger type.

szUnitOfMeasure 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).

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.
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.
idhCursor	GENLNG	ID	OPT	NONE
General purpose ID variable.
szBatchType	ICUT	char	OPT	NONE
A code that specifies the system and type of transactions entered in a batch. The system assigns the value when you enter a transaction. Valid values are set up in user defined code table 98/IT. You cannot assign new values. All batch types are hard coded.
mnBatchNumber	ICU	MATH_NUMERIC	OPT	NONE
A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either assign a batch number or let the system assign it using the Next Numbers program.
jdBatchDate	DBT	JDEDATE	OPT	NONE
The date of the batch. If you leave this field blank, the system uses the current date.
mnDocumentNumber	DOC	MATH_NUMERIC	OPT	NONE
A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable o Original document - voucher o Matching document - payment Accounts Receivable o Original document - invoice o Matching document - receipt Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents: deductions, unapplied receipts, chargebacks, and drafts.
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
jdGLDate	DGJ	JDEDATE	OPT	NONE
A date that identifies the financial period to which the transaction will be posted. You define financial periods for a date pattern code that you assign to the company record. The system compares the date that you enter on the transaction to the fiscal date pattern assigned to the company to retrieve the appropriate fiscal period number, as well as to perform date validations.
szCompany	KCO	char	OPT	NONE
A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the document company to retrieve the correct next number for that company. If two or more original documents have the same document number and document type, you can use the document company to locate the desired document.
szExplanation	EXR	char	OPT	NONE
A name or remark that describes the purpose for using an account or conveys any other information that the user wants about the transaction.
mnItemNumber	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
szGLAccount	ANI	char	OPT	NONE
A value that identifies an account in the general ledger. Use one of the following formats to enter account numbers: o Standard account number (business unit.object.subsidiary or flex format). o Third G/L number (maximum of 25 digits). o Account ID number. The number is eight digits long. o Speed code, which is a two-character code that you concatenate to the AAI item SP. You can then enter the code instead of an account number. The first character of the account number indicates its format. You define the account format in the General Accounting constants.
cSubledgerType	SBLT	char	OPT	NONE
A user defined code (00/ST) that is used with the Subledger field to identify the subledger type and how the system performs subledger editing. On the User Defined Codes form, the second line of the description controls how the system performs editing. This is either hard-coded or user defined. Valid values include: A Alphanumeric field, do not edit N Numeric field, right justify and zero fill C Alphanumeric field, right justify and blank fill
mnDebitAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
mnCreditAmount	MN29D9	MATH_NUMERIC	OPT	NONE
This is a generic field used as a work field in Everest.
szLedgerType	LT	char	OPT	NONE
A user defined code (09/LT) that specifies the type of ledger, such as AA (Actual Amounts), BA (Budget Amount), or AU (Actual Units). You can set up multiple, concurrent accounting ledgers within the general ledger to establish an audit trail for all transactions.
cDocumentTypeIndicator	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szAccountDescription	DL01	char	OPT	NONE
A user defined name or remark.
szDocumentType	DCT	char	OPT	NONE
A user defined code (00/DT) that identifies the origin and purpose of the transaction. PeopleSoft reserves several prefixes for document types, such as, vouchers, invoices, receipts, and timesheets. The reserved document type prefixes for codes are: P Accounts payable documents R Accounts receivable documents T Time and Pay documents I Inventory documents O Purchase order documents S Sales order documents
cReadByAccountNumber	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
cSumWithinWO	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
cSumAcrossWO	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szItemDescription	DSC1	char	OPT	NONE
Brief information about an item; a remark or an explanation.
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.
szSubledger	SBL	char	OPT	NONE
A code that identifies a detailed, auxiliary account within a general ledger account. A subledger can be an equipment item number or an address book number. If you enter a subledger, you must also specify the subledger type.
szUnitOfMeasure	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).