ErrorCache1

Error Cache 1 - Business Function

Minor Business Rule

Object Name: B3104050

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this function is to perform all caching functionality for the Error Cache 1.  The Error Cache 1 is used by the WIP Revaluation program
to cache error records to be printed on the UBE output.

Setup Notes and Prerequisites
The ErrorCache1 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.  szCompany - A member of the cache and part of the cache key.
7.  szBranch - 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.  mnAAI - A member of the cache and part of the cache key.
10.  mnNumberKeys - Indicates the number of keys to be used when fetching from the cache.
11.  cReturnPointer - A value of '1' indicates that a pointer to the cache should be returned when a successful cache read has occured.
12.  szCostType - A member of the cache and part of the cache key.
13.  szDocumentType - A member of the cache.

Technical Specifications
Cache Structure:
szCompany
  szBranch
  szGLCategoryCode
  mnAAI
szCostType
szDocumentType
Cache Key:
szCompany
  szBranch
  szGLCategoryCode
  mnAAI
  szCostType

Data Structure

D3104050 - Error Cache 1 - 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.

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.

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.

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.

mnAAI ANUM MATH_NUMERIC OPT NONE

A number used to specify sequence and retrieve accounting information.

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.

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.

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

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.
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.
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.
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.
mnAAI	ANUM	MATH_NUMERIC	OPT	NONE
A number used to specify sequence and retrieve accounting information.
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.
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.
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