Functional Description
Purpose
This function will perform Get, Add, Update, Delete, Delete All, Get Next, Add/Update, and Terminate
functions on the Asset Master MBF Cache.
Setup Notes and Prerequisites
Special Logic
Cache Action Code
'1' Get - retrieve the cache element. If not found, fetch from F1201 and add it to cache.
'2' Add - add a cache element.
'3' Update - update a cache element.
'4' Delete - delete a cache element.
'5' Delete All - delete all cache elements
'6' Get Next - retrieve the next cache element
'7' Add/Update - NOT IMPLEMETED.
'8' Terminate - terminate cache
'9' Close Cursor and Free Data Ptr
Number of Keys
As a parameter
If the number of keys is passed as a parameter, the business function uses this value to setup key
values for a Get, Update, Delete, Get Next, and Add/Update.
A zero may be passed to retrieve, update, or delete the first record.
If the cache does not have a key, a zero should always be passed
Technical Specification
The index for this cache is made up of the Asset Item Number and Modified or Original fields. This
index is UNIQUE.
Cache Name
If the Input Cache Name is " " or NULL, this function will build, create a new cache based on this
name and return the cache name.
The cache name that is returned is built using the following:
"hhmmss" + 4 digit random number. Eg: "102536nnnn"
The actual cache that is created will be named using the concatenation of "ASSETMBF_" + Cache Name.
Perform setup functions
B.If the Input Cache Name is Blank
C.Generate Cache Name and return to Input Cache Name
D.Create a new cache using "ASSETMBF _" + Input Cache Name
E.End If
F.If not successful, set error "032E", set Cache Error Code = '3', and return failure.
G.Validate input parameters Number Of Keys, Action Code, and Comparison Flag.
H.If not valid, set error "032E", set Cache Error Code = '2', and return failure.
I.Set Cache Error Code = '0'
J.Set return code to success.
II.Processing Based on Mode.
A.If Cache Action Code is '1' - GET:
it.
2.Retrieve the first element on the cache matching the key values passed as input. If the input
Number of Keys is zero, fetch the first element in the cache.
3.Load the values from the retrieved element into the data structure to be passed back to the
calling program.
4.If SequentialFetch = '1', return cursor pointer to calling application. Otherwise, close the
cursor.
5.If Get Fails
6.Fetch Record from F1201.
7.If Found
8.Load the values from the retrieved element into the data structure to be
passed back to the calling program.
9.Insert a new cache element with values from data structure as Original rec.
10.Else
11.Set Cache Error Code = '6'.
12.End If
13.End If
2.If add fails set error "032E", set Cache Error Code = '4', and return failure.
2.If update fails set error "032E", set Cache Error Code = '4', and return failure.
as input.
2.If the number of keys is 0, delete the first cache element.
3.If delete fails, set Cache Error Code = '5'.
2.If delete fails, set Cache Error Code = '5'.
the cache matching the key values passed as input (the cursor should have been set through a
previous "Get" action, i.e. action code '1'. If the Number of Keys is zero then fetch the
next record without using any key).
2.Load the values from the retrieved element into the data structure to be passed back to
the calling program.
3.If there are no more elements, close the cursor and set Cache Error Code = '1'.
2.Perform cleanup functions (Terminate cache).
2.Close cursor.
3.Free Data Ptr and Set Cache Cursor Ptr to 0.
D1200260 - Cache Process Asset Master MBF
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
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
| ||||
mnAssetItemNumber | NUMB | MATH_NUMERIC | OPT | NONE |
An 8-digit number that uniquely identifies an asset. | ||||
szUnitNumber | APID | char | OPT | NONE |
A 12-character alphanumeric code used as an alternate identification number for an asset. This number is not required, nor does the
| ||||
mnParentNumber | AAID | MATH_NUMERIC | OPT | NONE |
A parent number groups related components together. You can associate each item of property and piece of equipment with a parent item.
| ||||
szSerialTagNumber | ASID | char | OPT | NONE |
A 25-character alphanumeric number that you can use as an alternate asset identification number. You might use this number to track
| ||||
mnSequenceNumber1 | SEQ | MATH_NUMERIC | OPT | NONE |
A number that specifies the sequence of information. | ||||
szMajorClass | ACL1 | char | OPT | NONE |
A user defined code (12/C1) that determines the accounting class category code. You use this accounting category code to classify assets
| ||||
szSubClass | ACL2 | char | OPT | NONE |
A user defined code (12/C2) that is used to classify assets into groups or families. You use the equipment category code as a subclass to
| ||||
szClassCode3 | ACL3 | char | OPT | NONE |
A user defined code (12/C3) that classifies assets into groups or families. You use the manufacturer category code to further define
| ||||
szClassCode4 | ACL4 | char | OPT | NONE |
A user defined code (12/C4) that classifies assets into groups or families. You use the model year category code to further define the
| ||||
szClassCode5 | ACL5 | char | OPT | NONE |
A user defined code (12/C5) that classifies assets into groups or families. You use the usage category codes to further define the subclass
| ||||
szCostCenter | 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
| ||||
szDescription001 | DL01 | char | OPT | NONE |
A user defined name or remark. | ||||
szDescription002 | DL02 | char | OPT | NONE |
Additional text that further describes or clarifies a field in the system. | ||||
szDescription003 | DL03 | char | OPT | NONE |
Additional text that further describes or clarifies an element. | ||||
szDescCompressed | DSCC | char | OPT | NONE |
The compressed description contains the alpha name without spaces, slashes,dashes, commas, and other special characters. The
| ||||
jdDateAcquired | DAJ | JDEDATE | OPT | NONE |
Use this field to specify the date the asset was acquired. This date is typically the start depreciation date, but you can specify a different
| ||||
jdDateDisposal | DSP | JDEDATE | OPT | NONE |
The date the asset was disposed. | ||||
szEquipmentStatus | EQST | char | OPT | NONE |
A user defined code (12/ES) that identifies the equipment or disposal status of an asset, such as available, down, or disposed. | ||||
cNewOrUsedOnAcquisition | NORU | char | OPT | NONE |
A user defined code (H12/NO) that specifies whether an asset is new or used for tax purposes. Valid values are:
N
The asset is new.
U
The
| ||||
mnAmtEstSalvageValue | AESV | MATH_NUMERIC | OPT | NONE |
The estimated salvage value at the end of the useful life of an asset. | ||||
mnAmtReplacementCost | ARPC | MATH_NUMERIC | OPT | NONE |
The current or estimated replacement cost of the asset. Typically, replacement cost is established by objective means, such as an
| ||||
mnAmtLastYearsReplacement | ALRC | MATH_NUMERIC | OPT | NONE |
The estimate cost to replace the asset if purchased in the prior year. You must use the query facility for reports. | ||||
szAssetCostAcct_BU | AMCU | char | OPT | NONE |
The business unit to which the system charges original acquisition cost and any supplemental capital additions. The system uses a default
| ||||
szAssetCostAcct_OBJ | AOBJ | char | OPT | NONE |
The object account to which the original acquisition cost and any supplemental capital additions have been charged.
If the asset is a
| ||||
szAssetCostAcct_SUB | ASUB | char | OPT | NONE |
The subsidiary account to which the original acquisition cost and any supplemental capital additions have been charged. | ||||
szAccumDepreAcct_BU | DMCU | char | OPT | NONE |
The business unit to which the system charges accumulated depreciation amounts. | ||||
szAccumDepreAcct_OBJ | DOBJ | char | OPT | NONE |
The object account number to which the accumulated depreciation amount is to be charged. | ||||
szAccumDepreAcct_SUB | DSUB | char | OPT | NONE |
The subsidiary account to which the accumulated depreciation amount is to be charged. | ||||
szDeprExpenseAcct_BU | XMCU | char | OPT | NONE |
The business unit to which the system charges depreciation expense. | ||||
szDeprExpenseAcct_OBJ | XOBJ | char | OPT | NONE |
The object account to which the depreciation expense is to be charged. | ||||
szDeprExpenseAcct_SUB | XSUB | char | OPT | NONE |
The subsidiary number to which the depreciation expense is to be charged. | ||||
szAssetRevenue_BU | RMCU | char | OPT | NONE |
The business unit that the system credits for revenue amounts that originate in Equipment/Plant Management billing programs. | ||||
szAssetRevenue_OBJ | ROBJ | char | OPT | NONE |
The object account the system credits for revenue amounts that originate in Equipment/Plant Management billing programs. | ||||
szAssetRevenue_SUB | RSUB | char | OPT | NONE |
The subsidiary account that the system credits for revenue amounts that originate in Equipment/Plant Management billing programs. | ||||
mnAssetItemCurrentQty | ARCQ | MATH_NUMERIC | OPT | NONE |
This is the current number of units for an asset. The current item quantity is used in conjunction with the original quantity. The Current Item
| ||||
mnAssetItemOriginalQty | AROQ | MATH_NUMERIC | OPT | NONE |
The original number of units for an asset. If assets are purchased and accounted for in quantities (more than one), you can specify the
| ||||
mnTaxEntity | TXJS | MATH_NUMERIC | OPT | NONE |
The address number of the tax authority to which property taxes are paid. | ||||
mnAmtInvTaxCrYtd | AITY | MATH_NUMERIC | OPT | NONE |
The amount of investment tax credit (ITC) to be considered in depreciation calculations. | ||||
mnAmtInvTaxCrPye | AITP | MATH_NUMERIC | OPT | NONE |
The investment tax credit amount taken in the prior year. | ||||
cFinancingMethod | FINC | char | OPT | NONE |
A user defined code (12/FM) that indicates how a fixed asset was acquired, for example financed or purchased outright. | ||||
cItcOwnedFlag | ITCO | char | OPT | NONE |
Investment Tax Credit. Data item not used. | ||||
cPurchaseOption | PURO | char | OPT | NONE |
A code that indicates whether there is an option to purchase a leased or rented asset. This code is informational only. Valid values are:
Y
| ||||
mnAmtPurchaseOptionPrice | APUR | MATH_NUMERIC | OPT | NONE |
A number that indicates the purchase price, if you have the option to purchase a leased or rented asset. This field is informational only. | ||||
mnPurOptionCreditPct | PURP | MATH_NUMERIC | OPT | NONE |
The fixed percentage of the monthly payment that applies to the purchase of the asset. Enter a percent as a decimal. For example, enter
| ||||
mnAmtPurchaseOptionMax | APOM | MATH_NUMERIC | OPT | NONE |
A number that indicates the maximum monetary amount that applies toward the purchase, if applicable. For example, if a portion of the
| ||||
mnAddressNumberLessor | LANO | MATH_NUMERIC | OPT | NONE |
The address book number for the lessor, renter, or lending institution. | ||||
jdDateContract | JCD | JDEDATE | OPT | NONE |
The date the contract for the asset was put into effect. | ||||
jdDateExpiredJulian | DEXJ | JDEDATE | OPT | NONE |
The date that the contract for the asset expired. | ||||
mnAmountMonthlyPayment | AMF | MATH_NUMERIC | OPT | NONE |
A number that indicates the amount of the monthly payment for the asset you are financing, renting, or leasing. This field is informational
| ||||
szNameRemark | RMK | char | OPT | NONE |
A generic field that you use for a remark, description, name, or address. | ||||
szNameRemarksLine2 | RMK2 | char | OPT | NONE |
A generic field that you use for a remark, description, name, or address. | ||||
szInsurancePolicyNumber | INSP | char | OPT | NONE |
A reference number for information only. | ||||
szInsuranceCompany | INSC | char | OPT | NONE |
The name of the company issuing a specific insurance policy for a piece of equipment or property. | ||||
mnPolicyRenewalMonth | INSM | MATH_NUMERIC | OPT | NONE |
The month in which the insurance policy is to be renewed. | ||||
mnAmountInsurancePremium | INSA | MATH_NUMERIC | OPT | NONE |
The cost of the insurance premium. | ||||
mnAmountInsuranceValue | AIV | MATH_NUMERIC | OPT | NONE |
The declared value for insurance reporting purposes. You must use the query facility to prepare reports as prescribed by your insurance
| ||||
mnInsuranceValueIndex | INSI | MATH_NUMERIC | OPT | NONE |
Data item not used. | ||||
szUserId | USER | char | OPT | NONE |
The code that identifies a user profile. | ||||
jdDtLastChanged | LCT | JDEDATE | OPT | NONE |
The day a master or transaction record was last changed. | ||||
szLocation | LOC | char | OPT | NONE |
The current physical location of an asset. The location must have a valid business unit or job number in the Business Unit Master table
| ||||
szState | ADDS | char | OPT | NONE |
A user defined code (00/S) that specifies the state or province. This code is usually a postal service abbreviation. | ||||
szProgramId | PID | char | OPT | NONE |
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
| ||||
jdDateBeginningEffective | EFTB | JDEDATE | OPT | NONE |
The date that an address, item, transaction, or table record becomes active. The meaning of this field differs, depending on the program.
| ||||
jdDateExpectedReturn | DER | JDEDATE | OPT | NONE |
The date the equipment is expected to be returned from a particular location. | ||||
cActionMessageControl | MSGA | char | OPT | NONE |
A code to indicate which messages should be displayed.
A Y code will display all messages, including those that have been cleared or
| ||||
szNameExplanation | EX | char | OPT | NONE |
A description, remark, name, or address. | ||||
szNameRemarkExplanation | 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
| ||||
mnAddressNumber | AN8 | MATH_NUMERIC | OPT | NONE |
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or
| ||||
szClassCode6 | ACL6 | char | OPT | NONE |
A user defined code (12/C6) that classifies assets into groups or families. You use this code to further define the subclass codes. | ||||
szClassCode7 | ACL7 | char | OPT | NONE |
A user defined code (12/C7) that classifies assets into groups or families. You use this category code to further define the subclass codes. | ||||
szClassCode8 | ACL8 | char | OPT | NONE |
A user defined code (system 12, type C8) that is used to classify assets into groups or families. You use this category code to further define
| ||||
szClassCode9 | ACL9 | char | OPT | NONE |
A user defined code (system 12, type C9) that is used to classify assets into groups or families. You use this category code to further define
| ||||
szClassCode0 | ACL0 | char | OPT | NONE |
A user defined code (12/CO) that groups similar items for billing. If you are an Equipment Management client and you use Equipment
| ||||
mnStdFuelConsumption | SFC | MATH_NUMERIC | OPT | NONE |
The standard fuel consumption per unit (hour or mile) as described in the manufacturer's specifications. This can be compared with the
| ||||
szDisposalAccumDepre_BU | DADC | char | OPT | NONE |
The business unit to which accumulated depreciation was backed out of at time of disposal. | ||||
szDisposalAccumDepre_OBJ | DADO | char | OPT | NONE |
The object account to which accumulated depreciation was backed out of at time of disposal. | ||||
szDisposalAccumDepre_SUB | DADS | char | OPT | NONE |
The subsidiary to which accumulated depreciation was backed out of at time of disposal. | ||||
szUnitNo | UNIT | char | OPT | NONE |
The number that identifies the actual space within a building that is or can be leased, such as an apartment, office, retail space, parking
| ||||
mnParentItemNoShort | KIT | MATH_NUMERIC | OPT | NONE |
The system provides for three separate item numbers.
1. Item Number (short) - An eight-digit, computer assigned, completely
| ||||
szParentItemNoLong | KITL | char | OPT | NONE |
The system provides for three separate item numbers.
1. Item Number (short) - An eight-digit, computer assigned, completely
| ||||
szAfeNumber | AFE | char | OPT | NONE |
Authorization for Expenditure unit number. This number is used for informational purposes only. | ||||
szJobCategory | JBCD | char | OPT | NONE |
A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and
| ||||
szJobStep | JBST | char | OPT | NONE |
A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job
| ||||
szUnionCode | UN | char | OPT | NONE |
A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate. | ||||
cSubledgerInactiveCode | SBLI | char | OPT | NONE |
An option that indicates whether a specific subledger is inactive. Examples of inactive subledgers are jobs that are closed, employees
| ||||
jdDateUpdated | UPMJ | JDEDATE | OPT | NONE |
The date that specifies the last update to the file record. | ||||
szWorkStationId | JOBN | char | OPT | NONE |
The code that identifies the work station ID that executed a particular job. | ||||
mnTimeLastUpdated | UPMT | MATH_NUMERIC | OPT | NONE |
The time that specifies when the program executed the last update to this record. | ||||
szCategoryCodeFA0 | FA0 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCatagoryCodeFA11 | FA1 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA12 | FA2 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA13 | FA3 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA14 | FA4 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA15 | FA5 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA16 | FA6 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA17 | FA7 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA18 | FA8 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA19 | FA9 | char | OPT | NONE |
A three digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the
| ||||
szCategoryCodeFA21 | FA21 | char | OPT | NONE |
A 10-digit category code that can be specified for any purpose. This code can then be used to selectively extract specific assets from the
| ||||
szCategoryCodeFA22 | FA22 | char | OPT | NONE |
A 10 digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the Asset
| ||||
szCategoryCodeFA23 | FA23 | char | OPT | NONE |
A 10 digit category code that can be used for any purpose. You can then use this code to selectively extract specific assets from the Asset
| ||||
cAllowWorkOrderYN | WOYN | char | OPT | NONE |
A code that indicates whether a piece of equipment or asset may be entered on a work order. Valid values are:
1
| ||||
mnCriticality | CRTL | MATH_NUMERIC | OPT | NONE |
A code that indicates the criticality of the piece of equipment or PM schedule. This code is used in calculating the criticality of the work
| ||||
cWarrantyFlag | WRFL | char | OPT | NONE |
A code that indicates whether a piece of equipment is under warranty. Valid values are: Blank Not under warranty 1 Under warranty | ||||
jdDateWarrantyExpired | WARJ | JDEDATE | OPT | NONE |
The date through which the product warranty is in effect. | ||||
cModifiedOrOriginal | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
szCacheActionCode | CACTN | char | OPT | NONE |
A code that indicates the activity you want to perform. Valid codes:
o Get - Retrieve the cache element
o Add - Add a cache element
o
| ||||
mnNumberKeys | NKEYS | MATH_NUMERIC | OPT | NONE |
The number of keys in an index that will be used to retrieve, delete, or update a record. | ||||
szCacheName | JBNM | char | OPT | NONE |
This is the name of a job in the system. | ||||
idCacheCursorPtr | GENLNG | ID | OPT | NONE |
General purpose ID variable. | ||||
cSequentialFetch | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
cErrorCode | ERRC | char | OPT | NONE |
This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document
| ||||
cSuppressErrorMessage | SUPPS | char | OPT | NONE |
A flag indicating whether or not runtime error messaging will occur when an error message is issued from a business function.
0 = allow
| ||||
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
|
None |
F1201 Asset Master File |