DriverBalanceCache

Driver Balance Cache

Minor Business Rule

Object Name: B1600050

Parent DLL: CFIN

Location: Client/Server

Language: C

1.Functional Description
This function is used to maintain Driver Balances Cache

1.1Purpose
Use this function to maintain the F1632 drive balances cache. The driver calculation programs will
use this cache to accumulate driver volume information until it is updated in F1632.

1.2Setup Notes and Prerequisites

None.

1.3Special Logic

None.

2.Technical Specifications
2.4Processing
You can call this business function with four different actions (EV01):

1 = Initialize
2 = Add / Update
      3 = Get cache entry
      4 = Get Cache using Cache Key
8 = Terminate CACHE

1. If the Action Code EV01 = '1' (Initialize)

a)If the cache does not exist, initialize it.
b)If the cache exits clear it (Delete all).

  c) If error, return " Cache Processing Error" (032E) error message.

2. If the Action Code EV01 = '2' (Add/Update).

a)It will add a record to the cache with all the database fields from the passed parameters if
element does not exist (using several key fields).
b)Otherwise, fetch a record from the cache (using several key fields) and update the record in the
cache with all the database fields from the passed parameters. (but Amount Net Posting will
Accumulate instead replace.)
c)If error, return "Cache Processing Error" (032E) error message.

3. If the Action Code ='3' (Get cache entry).

a)Get next entry in cache.
b)If end of cache, return "1"  end of cache.

c)    If error, return "Cache Processing Error" (032E) error message.

4. If the Action Code ='4' (Get cache entry by using cache key ).
    a)    Get entry in cache by using the cache keys.
    b)    If error, return "Cache Processing Error" (032E) error message.

5. If the Action Code ='8' (Terminate)
    a)     Terminate CACHE from memory .
    b)     If error, return "Cache Processing Error"(032E) error message.

Otherwise, return "Action Invalid" (0001) error message.

Data Structure

D1600050 - Driver Balance Cache

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

cSuppressErrorMessage SUPPS char NONE NONE

A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.        0 = allow
runtime error message handling.        1 = suppress runtime error message handling.

szErrorMessage DTAI char NONE 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.

cMode EV01 char NONE NONE

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

mnJobnumber JOBS MATH_NUMERIC NONE NONE

The job number (work station ID) which executed the particular job.

szDriverCode DRCD char NONE NONE

A code that identifies drivers within the Advanced Cost Accounting system.

szBusinessUnit MCU char NONE 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.

szUnitOfMeasure UOM char NONE 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).

szCurrencyCode CRCD char NONE NONE

A code that identifies the currency of a transaction.

szSubledger SBL char NONE 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.

cSubledgerType SBLT char NONE 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

szCostObject1 ABR1 char NONE NONE

A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify
the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in
the cost object code field to the Account Balances file (F0902).

cCostObjectType1 ABT1 char NONE NONE

A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can
be added or modified using the Cost Object Types program (P1620).

szCostObject2 ABR2 char NONE NONE

A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify
the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in
the cost object code field to the Account Balances file (F0902).

cCostObjectType2 ABT2 char NONE NONE

A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can
be added or modified using the Cost Object Types program (P1620).

szCostObject3 ABR3 char NONE NONE

A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify
the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in
the cost object code field to the Account Balances file (F0902).

cCostObjectType3 ABT3 char NONE NONE

A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can
be added or modified using the Cost Object Types program (P1620).

szCostObject4 ABR4 char NONE NONE

A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify
the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in
the cost object code field to the Account Balances file (F0902).

cCostObjectType4 ABT4 char NONE NONE

A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can
be added or modified using the Cost Object Types program (P1620).

mnShortItemNumber ITM MATH_NUMERIC NONE 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

szCompany CO char NONE 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.

mnAmountNetPosting001 AN01 MATH_NUMERIC NONE NONE

A number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants table (F0010). The net amount posted is the total of all debits and credits, beginning with the first day of the period through the last
day of the period.

mnAmountNetPosting002 AN02 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting003 AN03 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting004 AN04 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting005 AN05 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting006 AN06 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting007 AN07 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting008 AN08 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting009 AN09 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting010 AN10 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting011 AN11 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting012 AN12 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting013 AN13 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

mnAmountNetPosting014 AN14 MATH_NUMERIC NONE NONE

Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company
Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day
of the period.

idGenericLong GENLNG ID NONE NONE

General purpose ID variable.

cEndOfCache EV01 char NONE NONE

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

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.

szActivityCode ACTB char OPT NONE

The aggregation of actions performed within an organization that are useful for purposes of activity-based costing.

mnCenturyFiscalYear CFY MATH_NUMERIC OPT NONE

A field used to store the century concatenated with the fiscal year.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cSuppressErrorMessage	SUPPS	char	NONE	NONE
A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function. 0 = allow runtime error message handling. 1 = suppress runtime error message handling.
szErrorMessage	DTAI	char	NONE	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.
cMode	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
mnJobnumber	JOBS	MATH_NUMERIC	NONE	NONE
The job number (work station ID) which executed the particular job.
szDriverCode	DRCD	char	NONE	NONE
A code that identifies drivers within the Advanced Cost Accounting system.
szBusinessUnit	MCU	char	NONE	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.
szUnitOfMeasure	UOM	char	NONE	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).
szCurrencyCode	CRCD	char	NONE	NONE
A code that identifies the currency of a transaction.
szSubledger	SBL	char	NONE	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.
cSubledgerType	SBLT	char	NONE	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
szCostObject1	ABR1	char	NONE	NONE
A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in the cost object code field to the Account Balances file (F0902).
cCostObjectType1	ABT1	char	NONE	NONE
A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can be added or modified using the Cost Object Types program (P1620).
szCostObject2	ABR2	char	NONE	NONE
A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in the cost object code field to the Account Balances file (F0902).
cCostObjectType2	ABT2	char	NONE	NONE
A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can be added or modified using the Cost Object Types program (P1620).
szCostObject3	ABR3	char	NONE	NONE
A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in the cost object code field to the Account Balances file (F0902).
cCostObjectType3	ABT3	char	NONE	NONE
A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can be added or modified using the Cost Object Types program (P1620).
szCostObject4	ABR4	char	NONE	NONE
A cost object code, such as an equipment item number or an address book number. If you enter a cost object code, you must also specify the cost object type. This field functions the same and is validated the same as the subledger field, but the system does not post the data in the cost object code field to the Account Balances file (F0902).
cCostObjectType4	ABT4	char	NONE	NONE
A code that specifies the type of cost object and the type of editing. Valid types are stored in the Cost Object Types table (F1620) and can be added or modified using the Cost Object Types program (P1620).
mnShortItemNumber	ITM	MATH_NUMERIC	NONE	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
szCompany	CO	char	NONE	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.
mnAmountNetPosting001	AN01	MATH_NUMERIC	NONE	NONE
A number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants table (F0010). The net amount posted is the total of all debits and credits, beginning with the first day of the period through the last day of the period.
mnAmountNetPosting002	AN02	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting003	AN03	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting004	AN04	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting005	AN05	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting006	AN06	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting007	AN07	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting008	AN08	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting009	AN09	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting010	AN10	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting011	AN11	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting012	AN12	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting013	AN13	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
mnAmountNetPosting014	AN14	MATH_NUMERIC	NONE	NONE
Number that represents the net amount posted during the accounting period. The system uses the accounting periods from the Company Constants file (F0010). The net amount posted is the total of all debits and credits beginning with the first day of the period through the last day of the period.
idGenericLong	GENLNG	ID	NONE	NONE
General purpose ID variable.
cEndOfCache	EV01	char	NONE	NONE
An option that specifies the type of processing for an event.
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.
szActivityCode	ACTB	char	OPT	NONE
The aggregation of actions performed within an organization that are useful for purposes of activity-based costing.
mnCenturyFiscalYear	CFY	MATH_NUMERIC	OPT	NONE
A field used to store the century concatenated with the fiscal year.