1.Functional Description
1.1Purpose
This function will perform Get, Add, Update, Delete, Delete All, Get Next, Add/Update, and Terminate functions on the All Components (parts list) cache
used in Configurator Order Processing (P3294, X3294, P32943).
1.2Setup Notes and Prerequisites
The calling application is responsible for loading all appropriate key values to the data structure and identifying the number of keys to use in
retrieval/update processes.
'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 - will add if element does not exist, will change if it does exist.
'8' Terminate - terminate cache
'9' Close cursor
key values for a Get, Update, Delete, Get Next, and Add/Update.
A zero may be passed to retrieve or update the first record.
Index Number
2 Sales Order Line Number, Parent Item Number, Parent Branch, Sequence ID
3 Sales Order Line Number, Stocking Type, Sequence ID
4 Sales Order Line Number, User Added Code, Sequence ID
5 Sales Order Line Number, Parent Item Number, Parent Branch, Stocking Type, Sequence ID
1.3Special Logic
There is no special logic within this function.
2.Technical Specifications
2.1Parameters:
Data Item Data Structure DescriptionI/ORequiredNotes
LNIDSales Order Line NumberI/OYKey value.
ATSQConfigurator Sequence NumberI/OYKey value.
KITParent Item Number(short)I/O*
ITMComponent Item (short)I/O*
MCUBranch/PlantI/O*
ATOT Rule TypeI/O*
ATO#Rule NumberI/O*
ATOSRule Sequence NumberI/O*
QNTYQuantityI/O*
MULTMultiplier for QuantityI/O*
SEQConfigured Level Seq. No.I/O*
EV01User Added ItemI/O*
SO03Print PartI/O*
PRUPrice RollupI/O*
UMUnit of MeasureI/O*
CMCUComponent BranchI/O*
LNTYLine TypeI/O*
DSC1Assembly Rule DescriptionI/O*
ITCIssue Type CodeI/O*
OPSQOperation Sequence No.I/O*
DOCOWork Order NumberI/O*Used by R31410 only.
INT01Number of KeysIYNumber of Keys to be used in the cache retrieval/delete process. Note: This cache only has one key value,
ATSQ. If in fetch mode and the number of keys is 0 then the first element in the cache will be found without using a key.
EV01Cache Action CodeIY"1" = Get cache element "2" = Add element "3' = Update element "4" = Delete cache elements
(keyed) "5" = Delete All cache elements "6" = Get Next cache element "7' = Add/Update cache element "8" = End cache (terminate cache) "9" = Close
cursor
EV01Cache Code ErrorON"0" = Successful Process "1" = Reached End Of CACHE "2" = Invalid Input Parameter "3" =
Failed to Create CACHE "4" = Failed to Add CACHE "5" = Failed to Delete CACHE "6" = Fetch Failed (Mode 4)
EV01Suppress Error MessagesIN1=Suppress runtime error message handling. 0=Allow runtime error message
handling.
DTAIError Message ID ON
STKTStocking TypeIYStocking Type from F4102.
JOBSJob NumberIYUse with BSFN # for Cache name
GENLNGCursorI/ONStore Data pointer
EV01Return CursorINset to '1' to request a return of cursor
KTLNLine Number KIT MasterI/ON
ATLVConfigurator Level No.I/OY
RLINRelated Line NumberI/ON
RORNWork Order Related No.I/ON
STRTWork Order Start DateI/ON
LNIXSOE Line IndexI/ON
LNIXWO Line IndexI/ON
INT01Index NumberIN
UPRCPriceI/ON
UNCSCostI/ON
FUPForeign PriceI/ON
FUCForeign CostI/ON
GRWTWeightI/ON
2.2Related Tables
Table Table Description
None.
2.3Related Business Functions
Source NameFunction Name
None.
2.4Processing
Cache Layout:
AliasData ItemNotes
LNIDSales Order Line NumberIndex value.
ATSQConfigurator Sequence NumberIndex value.
KITParent Item Number(short)
ITMComponent Item (short)
MCUBranch/Plant
ATOT Rule Type
ATO#Rule Number
ATOSRule Sequence Number
QNTYQuantity
MULTMultiplier for Quantity
SEQConfigured Level Seq. No.
LVLConfigured Level
EV01Parent Item Indicator1 = This item is a parent item. 0 = This item is a child item. Used by R31410.
SO03Print Part
PRUPrice Rollup
UMUnit of Measure
CMCUComponent Branch
LNTYLine Type
DSC1Assembly Rule Description
ITCIssue Type Code
OPSQOperation Sequence No.
WOWork Order NumberUsed by R31410.
KTLNLine Number KIT Master
UPRCPrice
UNCSCost
FUPForeign Price
FUCForeign Cost
GRWTWeight
I. Perform setup functions
B.Retrieve cursor (either from data pointer or new CACHE cursor)
C.Return CACHE cursor upon requested
D. Set DS Cache Error Code = '0';
E. If not successful Set error "032E," "Error Processing Cache".
II. Processing Based on Mode.
2.Retrieve the first element on the cache matching the key values passed as input; the number of keys to be used is passed in the input
parameters, If "0" fetch first element in the list.
3.Load the values from the retrieved element into the data structure to be passed back to the calling program.
4.If get fails DS Cache Error Code = '6'.
B.If Process Mode is "2" - ADD (same logic as mode "7").
2.If record in CACHE is found, update record with new value.
2.If record in CACHE is found, update record with new value.
2.If delete fails DS Cache Error Code = '5'.
E.If Process Mode is "5" - DELETE ALL:
2.If delete fails DS Cache Error Code = '5'.
"Get" action, i.e. process mode "1", if number of keys is "0" then fetch next record with out 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 cursor and set DS Cache Error Code = '1'.
G.If Process Mode is "7" - ADD/UPDATE:
2.If record in CACHE is found, update record with new value.
D3200370 - Process All Components Cache
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
cCacheActionCode | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
nIndexNumber | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due. | ||||
nNumberOfKeys | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due. | ||||
cReturnCursor | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
idCursor | GENLNG | ID | OPT | NONE |
General purpose ID variable. | ||||
cCacheCodeError | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
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
| ||||
mnJobNumber | JOBS | MATH_NUMERIC | OPT | NONE |
The job number (work station ID) which executed the particular job. | ||||
mnConfigurationIDNumber | CFGID | MATH_NUMERIC | OPT | NONE |
An identifier that represents a unique configuration. It is generated by a next number value and is the key to the configuration tables. | ||||
mnComponentIDNumber | CFGCID | MATH_NUMERIC | OPT | NONE |
A number that represents a component in a configuration. This number, which is generated by next numbers, always restarts at 1 and
| ||||
mnParentIDNumber | CFGPID | MATH_NUMERIC | OPT | NONE |
A number that represents the parent component of a component in a configuration. | ||||
mnIdentifierShortItem | ITM | MATH_NUMERIC | OPT | NONE |
An inventory item number. The system provides three separate item numbers plus an extensive cross-reference capability to other item
| ||||
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
| ||||
szDescriptionLine1 | DSC1 | char | OPT | NONE |
Brief information about an item; a remark or an explanation. | ||||
mnQuantity | QNTY | MATH_NUMERIC | OPT | NONE |
The number of units that the system applies to the transaction. | ||||
szUnitOfMeasure | UM | char | OPT | NONE |
A user defined code (00/UM) that identifies the unit of measurement for an amount or quantity. For example, it can represent a barrel, box,
| ||||
cFixedOrVariableQuantity | FOVQ | char | OPT | NONE |
Reserved by J.D. Edwards
A code that specifies whether the quantity of a configured item varies according to the quantity of the parent item
| ||||
cPrintPart | SO03 | char | OPT | NONE |
A user defined code (32/PF) that indicates whether the system prints the configurator part on the
sales order and work order. The system
| ||||
szLineType | LNTY | char | OPT | NONE |
A code that controls how the system processes lines on a transaction. It controls the systems with which the transaction interfaces, such as
| ||||
cCommittedHS | COMM | char | OPT | NONE |
A value that indicates whether you specified from which Location and Lot a particular item was to come. If you specified a storage area, the
| ||||
szLocation | LOCN | char | OPT | NONE |
The storage location from which goods will be moved. | ||||
szLot | LOTN | char | OPT | NONE |
A number that identifies a lot or a serial number. A lot is a group of items with similar characteristics. | ||||
mnAmountExtendedCost | ECST | MATH_NUMERIC | OPT | NONE |
For accounts receivable and accounts payable, the invoice (gross) amount. For sales orders and purchase orders, the unit cost times the
| ||||
mnAmountExtendedPrice | AEXP | MATH_NUMERIC | OPT | NONE |
The number of units multiplied by the unit price. | ||||
mnAmountForeignExtCost | FEC | MATH_NUMERIC | OPT | NONE |
The product of the cost of an item, expressed in foreign currency according to the orders exchange rate, times the number of units. | ||||
mnAmountForeignExtPrice | FEA | MATH_NUMERIC | OPT | NONE |
The product of the foreign price times the number of units. | ||||
cUserAddedComponent | SOCF | char | OPT | NONE |
A code that indicates whether the item, price adjustment, or cost adjustment was added to the configuration by a cross-segment editing rule
| ||||
cWriteAttachedDetailLine | WADL | char | OPT | NONE |
A user defined code (32/WA) that indicates whether the component line generates a detail line that indicates whether the component is
| ||||
cIssueTypeCode | ITC | char | OPT | NONE |
A code that indicates how the system issues each component in the bill of material from stock. In Shop Floor Management, it indicates how
| ||||
mnSequenceNoOperations | 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
| ||||
cRuleType | ATOT | char | OPT | NONE |
A value that identifies whether the resulting value of the assembly inclusion rule is a part number, price, routing operation, or calculated
| ||||
mnRuleNumber | ATO# | MATH_NUMERIC | OPT | NONE |
The number associated with a set of cross-segment editing rules or assembly inclusion rules. | ||||
mnRuleSeqNumber | ATOS | MATH_NUMERIC | OPT | NONE |
The Sequence number is the rule number within an edit group of cross-segment editing rules or assembly inclusion rules. You can insert a
| ||||
cValidFlag | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
cStockingType | STKT | char | OPT | NONE |
A user defined code (41/I) that indicates how you stock an item, for example, as finished goods or as raw materials. The following stocking
| ||||
mnWeight | GRWT | MATH_NUMERIC | OPT | NONE |
Essentially a memo field at present, this value is intended to reflect the fact that many inventory items are always packaged in the same
| ||||
szWeightUnitOfMeasure | GWUM | char | OPT | NONE |
Gross weight unit of measure. | ||||
mnVolume | ITVL | MATH_NUMERIC | OPT | NONE |
The cubic units occupied by one inventory item. The definition of the unit itself (cubic feet, yards, meters, and so on) is defined in the volume
| ||||
szVolumeUnitOfMeasure | VLUM | char | OPT | NONE |
The unit of measure for the cubic space occupied by an inventory item. Typical volume unit of measures are:
ML Milliliter
OZ Fluid Ounce
| ||||
mnMBFLineIndex1 | LNIX | MATH_NUMERIC | OPT | NONE |
mnMBFLineIndex2 | LNIX | MATH_NUMERIC | OPT | NONE |
mnMBFLineIndex3 | LNIX | MATH_NUMERIC | OPT | NONE |
mnMBFLineIndex4 | LNIX | MATH_NUMERIC | OPT | NONE |
mnMBFLineIndex5 | LNIX | MATH_NUMERIC | OPT | NONE |
mnLineNumber | LNID | MATH_NUMERIC | OPT | NONE |
A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns
| ||||
mnRelatedLineNumber | RLIN | MATH_NUMERIC | OPT | NONE |
This field is not updated by the receipt applications; it is always populated with the value zero. | ||||
mnLineNumberKitMaster | KTLN | MATH_NUMERIC | OPT | NONE |
This line number indicates the relative sequence in which a component is added to a kit or single level bill of materials. For example, the
| ||||
szUniqueConfigurationID | CFGSID | char | OPT | NONE |
An identifier that represents a unique configuration. It is generated from an encryption algorithm. Regardless of the number of segments or
| ||||
szConfiguredItemAlias | CIA | char | OPT | NONE |
Reserved by J.D. Edwards
A code that references a configured item within a derived calculation. The code is associated with the particular
| ||||
cConfiguredItemDestination | CIDN | char | OPT | NONE |
A user defined code (32/DE) that specifies the type of transaction that the component of a configured item should generate. If the conditions
| ||||
cDisplayItemNumber | DSPI | char | OPT | NONE |
A code that indicates whether the system prints the configured item number before the segment value information in the text string format or
| ||||
cTextStringorCustomFormat | TXTS | char | OPT | NONE |
A code that indicates whether the configured text string format or a user defined format appears on the sales order (pick slip and invoice
| ||||
szCompanyKeyRelated | RKCO | char | OPT | NONE |
The key company that is associated with the document number of the related order. | ||||
szRelatedPoSoNumber | RORN | char | OPT | NONE |
A number that identifies a secondary purchase order, sales order, or work order that is associated with the original order. This number is for
| ||||
szRelatedOrderType | RCTO | char | OPT | NONE |
A user defined code (system 00, type DT) that indicates the document type of the secondary or related order. For example, a purchase
| ||||
mnUniqueKeyIDInternal | UKID | MATH_NUMERIC | OPT | NONE |
This field is a unique number used to identify a record in a file. | ||||
szInstananceID | CFGSID | char | OPT | NONE |
An identifier that represents a unique configuration. It is generated from an encryption algorithm. Regardless of the number of segments or
| ||||
mnUnused | MATH01 | MATH_NUMERIC | OPT | NONE |
- - - Good Performance Low Value. | ||||
cUnused | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
szUnused | CNID | char | OPT | NONE |
A code on the container or that you assign to the container in which the items on this purchase order or order line were shipped to you. You
| ||||
szItemNoUnknownFormat | UITM | char | OPT | NONE |
A number that the system assigns to an item. It can be in short, long, or third item number format. | ||||
cInventoryInterfaceFlag | IVI | char | OPT | NONE |
A code that identifies the type of interface to the Inventory Management system. Valid values are:
Y The dollar or unit value of any activity
| ||||
mnQtyOrderMultiples | ATMU | MATH_NUMERIC | OPT | NONE |
Reserved by J.D. Edwards The result of a derived calculation that will be used to extend the quantity of an item. | ||||
cReValidateRulesDown | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
cActiveComponent | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
cCacheSlidingPerformed | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
mnAmountTransferCost | ECST | MATH_NUMERIC | OPT | NONE |
For accounts receivable and accounts payable, the invoice (gross) amount. For sales orders and purchase orders, the unit cost times the
| ||||
mnAmountForeignTransferCost | FEC | MATH_NUMERIC | OPT | NONE |
The product of the cost of an item, expressed in foreign currency according to the orders exchange rate, times the number of units. | ||||
cGenerateWO | GWO | char | OPT | NONE |
A code indicating whether the system automatically generates an internal work order for this order detail line.
In World software, valid values
| ||||
cGeneratePO | IDC1 | char | OPT | NONE |
A code generally used with the 'D' and 'N' Inventory Interface which indicates whether a Purchase Order should be generated or not. A
| ||||
mnAmountPOCost | ECST | MATH_NUMERIC | OPT | NONE |
For accounts receivable and accounts payable, the invoice (gross) amount. For sales orders and purchase orders, the unit cost times the
| ||||
mnAmountForeignPOCost | FEC | MATH_NUMERIC | OPT | NONE |
The product of the cost of an item, expressed in foreign currency according to the orders exchange rate, times the number of units. | ||||
cInheritedTransactionType | CIDN | char | OPT | NONE |
A user defined code (32/DE) that specifies the type of transaction that the component of a configured item should generate. If the conditions
| ||||
mnMPMTaskID | 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,
| ||||
cPurgedItem | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
mnUnitListPrice | LPRC | MATH_NUMERIC | OPT | NONE |
The list price in the unit of measure of the base price retrieved from the Base Price File (F4106). This is the price the customer would pay if
| ||||
mnUnitPrice | UPRC | MATH_NUMERIC | OPT | NONE |
The list or base price to be charged for one unit of this item. In sales order entry, all prices must be set up in the Item Base Price File table
| ||||
mntForeignUnitPrice | FUP | MATH_NUMERIC | OPT | NONE |
The foreign price per unit. | ||||
mnUnitCost | UNCS | MATH_NUMERIC | OPT | NONE |
The amount per unit, derived by dividing the total cost by the unit quantity. | ||||
mnForeignUnitCost | FUC | MATH_NUMERIC | OPT | NONE |
Amount - Foreign Unit Cost | ||||
mnPOUnitCost | UNCS | MATH_NUMERIC | OPT | NONE |
The amount per unit, derived by dividing the total cost by the unit quantity. | ||||
mnForeignPOUnitCost | FUC | MATH_NUMERIC | OPT | NONE |
Amount - Foreign Unit Cost | ||||
mnExtTransferCost | ECST | MATH_NUMERIC | OPT | NONE |
For accounts receivable and accounts payable, the invoice (gross) amount. For sales orders and purchase orders, the unit cost times the
| ||||
mnForExtTranferCost | FEC | MATH_NUMERIC | OPT | NONE |
The product of the cost of an item, expressed in foreign currency according to the orders exchange rate, times the number of units. | ||||
mnTransferUnitCos | UNCS | MATH_NUMERIC | OPT | NONE |
The amount per unit, derived by dividing the total cost by the unit quantity. | ||||
mnTransferForUnitCost | FUC | MATH_NUMERIC | OPT | NONE |
Amount - Foreign Unit Cost | ||||
mnForeignListPrice | FPRC | MATH_NUMERIC | OPT | NONE |
The list price in the unit of measure of the base price retrieved from the Base Price File (F4106). This is the price the customer would pay if
| ||||
mnAdjustmentRevisionLevel | AREV | MATH_NUMERIC | OPT | NONE |
This field maintains the current revision level of Advanced Pricing adjustments awarded within a sales order. Adjustments associated with
| ||||
szSOEMBFInternalFlags | SOEF | char | OPT | NONE |
This field is broken down into 30 different flags which are passed in and out of the sales order entry MBF - F4211 Begin Doc, F4211 Pre
| ||||
szPOEMBFInternalFlags | POEF | char | OPT | NONE |
This field is broken down into 10 different flags which are passed in and out of the purchase order entry MBF - F4311 Begin Doc, F4311 Edit
| ||||
szAlphaFlags | ALPH | char | OPT | NONE |
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter
| ||||
cConfigPriceCostControl | OWTRFL | char | OPT | NONE |
Specifies an indicator setting. Valid values are: 0 False 1 True | ||||
cPriceOverrideCode | PROV | char | OPT | NONE |
A value established by the sales order entry program whenever a unit or extended price is entered into an order line item, overriding the
| ||||
cCostOverrideCode | CSTO | char | OPT | NONE |
A code that specifies whether the change order is a terms only change. For those organizations that elect to view subcontracts on a
|
None |
None |