VerifyAndGetECOPartsList

Verify And Get ECO Parts List

Major Business Rule

Object Name: B3000740

Parent DLL: CMFGBASE

Location: Client/Server

Language: C

1.Functional Description

This business function verifies that the ECO Parts List (F3013) record exists and returns
                  a pointer to the Parts List Record.  You can retrieve a record from F3013 using 

Five different            

                  indexes.

   Index:  Pass in the number that identifies the index used to fetch the record.
      Keys:   Pass the number of key elements used to fetch the record.    

   Return Pointer:  1=Return Pointer, 0=Do not return pointer.  
   Call Type: 1=Verify that record exists, 2=Verify that record does not exist.  

   Suppress Error Message: 1=Suppress runtime error message handling, 0=Allow runtime error  

                               message handling.


If a pointer to the record is returned, this pointer must be cleared in the application using the 

BSFN FreePtrtoDataStructure.


1.1Purpose
This business function verifies that the ECO Parts List (F3013) record exists and returns a pointer 
to the ECO Parts List Record.


1.2Setup Notes and Prerequisites

• Set on "Suppress Error Messages" to suppress the runtime error message handling. Otherwise, if an 
error occurs the error message will be displayed on the message line and the appropriate field (if any) 

will be highlighted.

• Set on "Return Pointer" to return a pointer the F3013 record.  If a pointer to the record is 
returned, this pointer must be cleared in the application using the BSFN FreePtrtoDataStructure.

• The user passes to the business function the number of the index they want to use and the number of 
key fields within that index that will be used.


List of Indexes:


  1 = ECPR, KIT, MMCU, TBM, BQTY, SRV  (6 Keys)

  2 = ECPR, ITM, MMCU, TBM, BQTY, TRV (6 Keys)

  3 = ITM, DOCO (2 Keys)

  4 = DOCO, PSQ, RSQ (3 Keys)

  5 = DOCO, DCTO (2 Keys)


• Set the "Call Type" flag to a "1" to have the business function verify that the record exists. Set 
it to "2" to have the business function verify that the record does not exist (ie. it returns an error 

if a record is found).


1.3Special Logic

None.

2.Technical Specifications


2.4Processing 

1.0.  Initialize the DS F3013Pointer to NULL.

2.0.  Fetch the ECO Parts List Detail Record using Index 1.


3.0.  If Fetch failed, return messages.

3.1.  If DS Call Type is equal to '1', return error messages.
3.1.1.  Assign DS Error Message ID = '0002' (Record Invalid).
3.1.2.  If DS Suppress Error Message is not equal to '1', SetGBRError where error message is 

'0002' ( Record Invalid) and first field in index is highlighted.


4.0.  If Fetch is successful, return pointer and messages.

4.1.  If DS Call Type is equal to '2', return error messages.
4.1.1.  Assign DS Error Message ID = '2463' (Record Already Exists).
4.1.2.  If DS Suppress Error Message is not equal to '1', SetGBRError where error message is 

'2463' (Record Already Exists) and first field in index is highlighted.


4.2If DS Call Type is not equal to '2', return the ECO Parts List Detail information.


4.3.  If  DS Call Type is not equal to '2' and DS Return Pointer is equal to '1', return pointer 

to the ECO Parts List Detail Record.

4.3.1.  Allocate memory for the ECO Parts List Detail Record.
4.3.2.  If Memory Allocation is successful, Assign DS F3013 Pointer = Address of ECO Parts List 
Detail Record.

4.3.3.  If Memory Allocation is not successful, return error messages.
4.3.3.1.  Assign DS Error Message ID = '4365' (No Memory).
4.3.3.2.  If DS Suppress Error Message is not equal to '1', SetGBRError where error message is 
             '4365' and first field in index is highlighted.


Retrievals:
 1.  ECO Parts List Detail Table (F3013) using index 1.

Returns:

1.  If Call Type is equal to '1' and the fetch fails, return Error Message ID '0002' (Record 
Invalid).

2.  If Call Type is equal to '2' and the fetch is successful, return Error Message ID '2463' (Record 

Already Exists).

3.  If Call Type is equal to '1' and Return Pointer is equal to '1', the fetch is successful, and the 

memory allocation is successful, return the pointer to the data structure.

4.  If Call Type is equal to '2' and the fetch is successfull, return ECO Parts List Detail 

Information. 



Checklist:


Business Function SVR(The Business Function SVR document can be found on 
in the shared folder NTSERV2.xls)

______Business Function Name

______Source file Name

______Description of what the function does

______Which programs use the function

______Authors name


    Object Librarian Check:

______Verify Related Functions List against header file
______Verify Related Tables List against header file

______Verify Business Function Data Structure in the header file against Business Function   

   Parameter List

______"Check In" All the Business Function Parameter Lists


   All Business Functions must be run through Bounds Checker before checking them  in.

______Bounds Checker


Note:
Make sure to highlight the line and click on either 'Parameters' or 'Notes' button to get 
Function ID




^

Data Structure

D3000740 - Verify And Get ECO Parts List

Parameter NameData ItemData TypeReq/OptI/O/Both
mnOrderNumberDOCOMATH_NUMERICNONENONE

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.

mnPrimarySequencePSQMATH_NUMERICNONENONE

szBusinessUnitMCUcharNONENONE

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.

mnRelatedSequenceRSQMATH_NUMERICNONENONE

cParentChildInclusionECPRcharNONENONE

A code that indicates whether the item is a parent or component. Using this value, the system selects items for you on the Related Items 
window when you perform a where-used inquiry for components or a single-level or multilevel inquiry for parent items. The Engineering Change 
Population program uses this value to determine the requested change. Valid values are:    P The item is a parent.    C The item is a 
component.

mnShortItemNumberITMMATH_NUMERICNONENONE

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

szBranchMMCUcharNONENONE

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.

szTypeOfBillTBMcharNONENONE

A user defined code (40/TB) that designates the type of bill of material. You can define different types of bills of material for different uses. 
For example:    M     Standard manufacturing bill    RWK   Rework bill    SPR   Spare parts bill  The system enters bill type M in the work order 
header when you create a work order, unless you specify another bill type. The system reads the bill type code on the work order header to 
know which bill of material to use to create the work order parts list. MRP uses the bill type code to identify the bill of material to use when it 
attaches MRP messages. Batch bills of material must be type M for shop floor management, product costing, and MRP processing.

mnParentItemNumberKITMATH_NUMERICNONENONE

The system provides for three separate item numbers.    1.   Item Number (short) - An eight-digit, computer assigned, completely 
non-significant item number.    2.   2nd Item Number - The 25-digit, free form, user defined alphanumeric item number.    3.   3rd Item Number - Another 
25-digit, free form, user defined alphanumeric item number.

mnBatchQuantityBQTYMATH_NUMERICNONENONE

The quantity of finished units that you expect this bill of material or routing to produce. You can specify varying quantities of components 
based on the amount of finished goods produced. For example, 1 ounce of solvent is required per unit up to 100 units of finished product. 
However, if 200 units of finished product is produced, 2 ounces of solvent are required per finished unit. In this example, you would set up batch 
quantities for 100 and 200 units of finished product, specifying the proper amount of solvent per unit.

szToRevisionLevelTRVcharNONENONE

The revision level for the part that is reported next. This might not be the next sequential revision.

szSwapToRevisionLevelSRVcharNONENONE

The revision level of the "Swap-to item" whenever an engineering change order is swapping out one item for another. The swap-to revision 
becomes the next revision level for the item only when the ECO is created in "Swap To" mode.

szOrderTypeDCTOcharNONENONE

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has 
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post 
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and 
should not be changed: P Accounts Payable documents   R Accounts Receivable documents   T Payroll documents   I Inventory documents  
O Purchase Order Processing documents   J General Accounting/Joint Interest Billing documents   S Sales Order Processing documents

szErrorMessageIDDTAIcharNONENONE

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.

szIndexDTAIcharNONENONE

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.

szKeysDTAIcharNONENONE

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.

idF3013PointerGENLNGIDNONENONE

General purpose ID variable.

cReturnPointerEV01charNONENONE

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

cCallTypeEV01charNONENONE

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

cSuppressErrorMessagesEV01charNONENONE

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

jdEffectiveFromDateEFFFJDEDATENONENONE

A date that indicates one of the following:     o When a component part goes into effect on a bill of material     o When a routing step goes into 
effect as a sequence on the routing for an item     o When a rate schedule is in effect The default is the current system date. You can enter 
future effective dates so that the system plans for upcoming changes. Items that are no longer effective in the future can still be recorded and 
recognized in Product Costing, Shop Floor Management, and Capacity Requirements Planning. The Material Requirements Planning system 
determines valid components by effectivity dates, not by the bill of material revision level. Some forms display data based on the effectivity 
dates you enter.

jdEffectiveThruDateEFFTJDEDATENONENONE

A date that indicates one of the following:     o When a component part is no longer in effect on a bill of material     o When a routing step is no 
longer in effect as a sequence on the routing for an item     o When a rate schedule is no longer active The default is December 31 of the 
default year defined in the Data Dictionary for Century Change Year. You can enter future effective dates so that the system plans for upcoming 
changes. Items that are no longer effective in the future can still be recorded and recognized in Product Costing, Shop Floor Management, 
and Capacity Requirements Planning. The Material Requirements Planning system determines valid components by effectivity dates, not by 
the bill of material revision level. Some forms display data based on the effectivity dates you enter.

szProgramIdPIDcharNONENONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

Related Functions

B4000460 Free Ptr To Data Structure

Related Tables

F3013 ECO Parts List Detail