GLSummaryDataCache

G/L Summary Data Cache - Business Function

Minor Business Rule

Object Name: B3104010

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the G/L Summary Data Cache.  The G/L Summary Data Cache is used by the
WIP Revaluation program to cache all journal entry detail records in order to print these records on the report output.

Setup Notes and Prerequisites
The GLSummaryDataCache 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 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.   mnWorkOrderDocumentNumber - A member of the cache and part of the cache key.
7.  szKeyCompany - A member of the cache and part of the cache key.
8.  szCompany - A member of the cache and part of the cache key.
9.  szAccountNumber - A member of the cache and part of the cache key.
10.  cDebitCreditIndicator - A member of the cach and part of the cache key.
11.  szAccountId - A member of the cache.
12.  szBusinessUnit - A member of the cache.
13.  szObjectAccount - A member of the cache.
14.  szSubsidiary - A member of the cache.
15.  mnAmount - A member of the cache.
16.  szDescription - A member of the cache.
17.  szCurrencyCode - A member of the cache.
18.  szOrderType - A member of the cache.
19.  mnNumberKeys - Indicates the number of keys to be used for a fetch from the cache.
20.  cReturnPointer - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has occured.
21.  mnDocumentNumber - A member of the cache.
22.  jdGLDate - A member of the cache.
23.  szExplanation - A member of the cache.

Technical Specifications
Cache Structure:
mnWorkOrderDocumentNumber
szOrderType
szKeyCompany
szCompany
szAccountNumber
cDebitCreditIndicator
szAccountId
szBusinessUnit
szObjectAccount
szSubsidiary
mnAmount
szDescription
szCurrencyCode
mnDocumentNumber
jdGLDate
szExplanation
Cache Key:
mnWorkOrderDocumentNumber
szOrderType
szKeyCompany
szCompany
szAccountNumber
cDebitCreditIndicator

Data Structure

D3104010 - G/L Summary 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.

mnWorkOrderDocumentNumber DOCO MATH_NUMERIC OPT NONE

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.

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.

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

cDebitCreditIndicator EV01 char OPT NONE

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

szAccountId AID char OPT NONE

A number that the system assigns to each general ledger account in the Account Master table (F0901) to uniquely identify it.

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.

szObjectAccount OBJ char OPT NONE

The portion of a general ledger account that refers to the division of the Cost Code (for example, labor, materials, and equipment) into
subcategories. For example, you can divide the Cost Code for labor into regular time, premium time, and burden. Note: If you use a flexible chart of
accounts and the object account is set to 6 digits, J.D. Edwards recommends that you use all 6 digits. For example, entering 000456 is not
the same as entering 456 because if you enter 456 the system enters three blank spaces to fill a 6-digit object.

szSubsidiary SUB char OPT NONE

A subset of an object account. Subsidiary accounts include detailed records of the accounting activity for an object account.

mnAmount AA MATH_NUMERIC OPT NONE

A number that identifies the amount that the system will add to the account balance of the associated account number.  Enter credits with a
minus sign (-) either before or after the amount.

szDescription DL01 char OPT NONE

A user defined name or remark.

szCurrencyCode CRCD char OPT NONE

A code that identifies the currency of a transaction.

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.

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

jdGLDate GLDT JDEDATE OPT NONE

The date on which the competency goal was set for the employee.

szExplanation EXA char OPT NONE

A description, remark, explanation, name, or address.

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

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.
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.
szAccountNumber	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.
cDebitCreditIndicator	EV01	char	OPT	NONE
An option that specifies the type of processing for an event.
szAccountId	AID	char	OPT	NONE
A number that the system assigns to each general ledger account in the Account Master table (F0901) to uniquely identify it.
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.
szObjectAccount	OBJ	char	OPT	NONE
The portion of a general ledger account that refers to the division of the Cost Code (for example, labor, materials, and equipment) into subcategories. For example, you can divide the Cost Code for labor into regular time, premium time, and burden. Note: If you use a flexible chart of accounts and the object account is set to 6 digits, J.D. Edwards recommends that you use all 6 digits. For example, entering 000456 is not the same as entering 456 because if you enter 456 the system enters three blank spaces to fill a 6-digit object.
szSubsidiary	SUB	char	OPT	NONE
A subset of an object account. Subsidiary accounts include detailed records of the accounting activity for an object account.
mnAmount	AA	MATH_NUMERIC	OPT	NONE
A number that identifies the amount that the system will add to the account balance of the associated account number. Enter credits with a minus sign (-) either before or after the amount.
szDescription	DL01	char	OPT	NONE
A user defined name or remark.
szCurrencyCode	CRCD	char	OPT	NONE
A code that identifies the currency of a transaction.
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.
mnDocumentNumber	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.
jdGLDate	GLDT	JDEDATE	OPT	NONE
The date on which the competency goal was set for the employee.
szExplanation	EXA	char	OPT	NONE
A description, remark, explanation, name, or address.