F30026CSMSCostComponentsCache

F30026 S/WM Cost Components Cache

Minor Business Rule

Object Name: B1700080

Parent DLL: CCRIN

Location: Client/Server

Language: C

Functional Description

Purpose
The purpose of this business function is to populate a cache with records based on the percentage covered and the percentage not covered under a
CSMS Contract.  Then give the user the ability to read and destroy the cache.

Setup Notes and Prerequisites
• To fill the cache the user must first call the function with a mode of 1.  Then to read the cache, it should be called with a mode of 2 and to terminate
the cache, call it with a mode of 3.
• If calling in mode 1 a Job Number must be retrieved and passed in to create the cache with a unique
name.  The Job Number must be in string format. NOTE* If calling in mode 1 and the cache already
exists, the contents of the cache will be cleared.
• If calling in mode 2, the function needs to be in a loop to retrieve all the records from the cache
until ER_ERROR is returned.
• If calling in mode 3, pass the cache handle to clear existing cache records.
• This function will return ER_SUCCESS if there are no errors, or ER_ERROR if there were errors.  If
there are errors, detailed descriptions will be passed back in the ErrMsgId element of the data
structure.

Special Logic
Note:  This business function should be almost identical to B3003130 except that it does not retrieve any records from the F30026 table.  Instead it
takes the data being passed in through the data structure, breaks the cost down based on the percentage covered by a CSMS Contract, and then writes
records to the cache.  The reading and terminating of the cache remain similar to B3003130.  Any fields that are in the cache but not specified in this design
should be set to zero or blank.

Technical Specification
Mode:
1 = Clear/Create/Populate cache
2 = Read cache
3 = Terminate cache
4 = Unplanned Inventory Issues

Data Structure

D1700080 - F30026 S/WM Cost Components Cache

Parameter Name Data Item Data Type Req/Opt I/O/Both

cMode EV01 char REQ INPUT

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

mnItemNumber ITM MATH_NUMERIC REQ INPUT

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

szBranch MMCU char REQ INPUT

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.

szLocation LOCN char REQ INPUT

The storage location from which goods will be moved.

szLotNumber LOTN char REQ INPUT

A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.

szCostType COST char REQ INPUT

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.

mnCost STDC MATH_NUMERIC REQ BOTH

The cost of the item as calculated by the Simulate Cost Rollup program (P30820) and updated by the Frozen Cost Update program
(P30835). You can also manually maintain this cost.

szGLOffset GLC char OPT NONE

A code that determines the trade account that the system uses as the offset when you post invoices or vouchers. The system concatenates
the value that you enter to the AAI item RC (for Accounts Receivable) or PC (for Accounts Payable) to locate the trade account. For
example, if you enter TRAD, the system searches for the AAI item RCTRAD (for receivables) or PCTRAD (for payables). You can assign up to four
alphanumeric characters to represent the G/L offset or you can assign the three-character currency code (if you enter transactions in a
multicurrency environment). You must, however, set up the corresponding AAI item for the system to use; otherwise, the system ignores the G/L
offset and uses the account that is set up for PC or RC for the company specified. If you set up a default value in the G/L Offset field of the
customer or supplier record, the system uses the value during transaction entry unless you override it. Note: Do not use code 9999. It is reserved for
the post program and indicates that offsets should not be created.

mnServiceOrderNumber DOCO MATH_NUMERIC REQ INPUT

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.

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.

mnSequenceNumber OPSQ MATH_NUMERIC OPT NONE

A number used to indicate an order of succession. In routing instructions, a number that sequences the fabrication or assembly steps in the
manufacture of an item. You can track costs and charge time by operation. In bills of material, a number that designates the routing step in the
fabrication or assembly process that requires a specified component part. You define the operation sequence after you create the routing
instructions for the item. The Shop Floor Management system uses this number in the backflush/preflush by operation process. In engineering
change orders, a number that sequences the assembly steps for the engineering change. For repetitive manufacturing, a number that
identifies the sequence in which an item is scheduled to be produced. Skip To fields allow you to enter an operation sequence that you want to begin
the display of information. You can use decimals to add steps between existing steps. For example, use 12.5 to add a step between steps
12 and 13.

szTypeOperationCode OPSC char OPT NONE

A user defined code (30/OT) that indicates the type of operation. Valid values include: A Alternate routing   TT Travel time   IT Idle time   T Text

mnUniqueNextNumber UKID MATH_NUMERIC OPT NONE

This field is a unique number used to identify a record in a file.

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

cSuppressErrors ERR char OPT NONE

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the
external parameter data structure of the Data Dictionary Server.

idCacheHandle GENLNG ID OPT NONE

General purpose ID variable.

idCursorHandle GENLNG ID REQ BOTH

General purpose ID variable.

szJobNumber JOB char OPT NONE

Job Number

mnPercentOfFrozenTTL PCT MATH_NUMERIC OPT NONE

An abbreviation for percentage.

cCallFlag_EV01 EV01 char OPT INPUT

Special Input Parameters:

1 = Call Time Entry record is being processed
^

szCoveredGLCategory_GLCCV GLCCV char OPT INPUT

Special Input Parameters:
Covered G/L Category Code - Required if processing a Call Time Entry record.
^

szNonCoveredGLCategory_GLCNC GLCNC char OPT INPUT

Special Input Parameters:
Non-Covered G/L Category Code - Required if processing a Call Time Entry record.

^

mnPercentCovered_PCOVR PCOVR MATH_NUMERIC OPT INPUT

Special Input Parameters:
Percent Covered - Required if processing a Call Time Entry record.

^

Related Functions

None

Related Tables

F31171 Parts List - Extension

F31172 Routing Instructions - Extension

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cMode	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
mnItemNumber	ITM	MATH_NUMERIC	REQ	INPUT
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
szBranch	MMCU	char	REQ	INPUT
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.
szLocation	LOCN	char	REQ	INPUT
The storage location from which goods will be moved.
szLotNumber	LOTN	char	REQ	INPUT
A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics.
szCostType	COST	char	REQ	INPUT
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.
mnCost	STDC	MATH_NUMERIC	REQ	BOTH
The cost of the item as calculated by the Simulate Cost Rollup program (P30820) and updated by the Frozen Cost Update program (P30835). You can also manually maintain this cost.
szGLOffset	GLC	char	OPT	NONE
A code that determines the trade account that the system uses as the offset when you post invoices or vouchers. The system concatenates the value that you enter to the AAI item RC (for Accounts Receivable) or PC (for Accounts Payable) to locate the trade account. For example, if you enter TRAD, the system searches for the AAI item RCTRAD (for receivables) or PCTRAD (for payables). You can assign up to four alphanumeric characters to represent the G/L offset or you can assign the three-character currency code (if you enter transactions in a multicurrency environment). You must, however, set up the corresponding AAI item for the system to use; otherwise, the system ignores the G/L offset and uses the account that is set up for PC or RC for the company specified. If you set up a default value in the G/L Offset field of the customer or supplier record, the system uses the value during transaction entry unless you override it. Note: Do not use code 9999. It is reserved for the post program and indicates that offsets should not be created.
mnServiceOrderNumber	DOCO	MATH_NUMERIC	REQ	INPUT
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.
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.
mnSequenceNumber	OPSQ	MATH_NUMERIC	OPT	NONE
A number used to indicate an order of succession. In routing instructions, a number that sequences the fabrication or assembly steps in the manufacture of an item. You can track costs and charge time by operation. In bills of material, a number that designates the routing step in the fabrication or assembly process that requires a specified component part. You define the operation sequence after you create the routing instructions for the item. The Shop Floor Management system uses this number in the backflush/preflush by operation process. In engineering change orders, a number that sequences the assembly steps for the engineering change. For repetitive manufacturing, a number that identifies the sequence in which an item is scheduled to be produced. Skip To fields allow you to enter an operation sequence that you want to begin the display of information. You can use decimals to add steps between existing steps. For example, use 12.5 to add a step between steps 12 and 13.
szTypeOperationCode	OPSC	char	OPT	NONE
A user defined code (30/OT) that indicates the type of operation. Valid values include: A Alternate routing TT Travel time IT Idle time T Text
mnUniqueNextNumber	UKID	MATH_NUMERIC	OPT	NONE
This field is a unique number used to identify a record in a file.
szErrorMessage	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.
cSuppressErrors	ERR	char	OPT	NONE
The Data Field Error Code field is simply a generic data field to pass an error condition flag. This field is one of the fields that make up the external parameter data structure of the Data Dictionary Server.
idCacheHandle	GENLNG	ID	OPT	NONE
General purpose ID variable.
idCursorHandle	GENLNG	ID	REQ	BOTH
General purpose ID variable.
szJobNumber	JOB	char	OPT	NONE
Job Number
mnPercentOfFrozenTTL	PCT	MATH_NUMERIC	OPT	NONE
An abbreviation for percentage.
cCallFlag_EV01	EV01	char	OPT	INPUT
Special Input Parameters: 1 = Call Time Entry record is being processed ^
szCoveredGLCategory_GLCCV	GLCCV	char	OPT	INPUT
Special Input Parameters: Covered G/L Category Code - Required if processing a Call Time Entry record. ^
szNonCoveredGLCategory_GLCNC	GLCNC	char	OPT	INPUT
Special Input Parameters: Non-Covered G/L Category Code - Required if processing a Call Time Entry record. ^
mnPercentCovered_PCOVR	PCOVR	MATH_NUMERIC	OPT	INPUT
Special Input Parameters: Percent Covered - Required if processing a Call Time Entry record. ^

F31171 Parts List - Extension
F31172 Routing Instructions - Extension