VerifyAndGetItemXRef

Verify And Get Item XRef

Minor Business Rule

Object Name: B4100600

Parent DLL: COPBASE

Location: Client/Server

Language: C

Functional Description

Purpose
To retrieve the Item Cross Reference (F4104) record based on the Index and Key parameters passed in.

Setup Notes and Prerequisites
• 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.

'b7'b7'b7'b7List of Indexes:
1. ITM, XRT, AN8, CITM, EXDJ
2. ITM, XRT, AN8, EXDJ
3. ITM, AN8
4. CITM, XRT, AN8

• The returned error message will display automatically on the message line and the appropriate field
(if any) will be highlighted. This can be suppressed by turning on the "Suppress Error Message" flag.
• Turn on the "Return Pointer" flag to have the business function return a pointer to the record.
• 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).
'b7'b7'b7'b7

Data Structure

D4100600 - Verify And Get Item XRef

Data Item Data Structure Description  I/ORequired

EV01        Return Pointer Flag         I  Yes
EV01        Call Type                     I    Yes
EV01        Suppress Error Messages Flag   I   No
DTAI        Index                     I   Yes
DTAI        Keys                           I  Yes
DTAI        Error Message ID         O    No
GENLNG  File Pointer               O   No
ITM        Short Item Number        I/O  Yes
XRT        Cross Reference Type Code   I   Yes
AN8        Address Number               I  Yes
CITM        Customer/SupplierItem Number  I/O  Yes
EXDJ        Date - Expired               I  Yes
DSC1        Description Line 1         O
DSC2        Description Line 2             O

^

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

cReturnPointerFlag EV01 char NONE NONE

Enter a '1' to Return Pointer.
Enter a '0' to Not Return Pointer.ab

^

cCallType EV01 char NONE NONE

Enter a '1' to verify that record exists.
Enter a '2' to verify that record does not exist.ab

^

cSuppressErrorMessages EV01 char NONE NONE

Enter a '1' to suppress runtime error message handling.
Enter a '0' to allow runtime error message handling.ab

^

szIndex DTAI char NONE NONE

Pass in the number that identifies the index used to fetch the record.ab

^

szKeys DTAI char NONE NONE

Pass the number of key fields used to fetch the record.ab

^

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

idF4104Pointer GENLNG ID NONE NONE

General purpose ID variable.

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

szCrossRefTypeCode XRT char NONE NONE

A user defined code (41/DT) that identifies the type of cross-reference set up for this customer. Examples of cross-reference types include:
o Substitutes     o Replacements     o Bar codes     o Customer item numbers     o Supplier item numbers

mnAddressNumber AN8 MATH_NUMERIC NONE NONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or
location.

szCustomerItemNumber CITM char NONE NONE

The cross-reference item number that the system assigns to an item number. A cross-reference number allows you to use a supplier's item
number if it is different from your own item number when you are processing an order or printing.

jdDateExpired EXDJ JDEDATE NONE NONE

The date on which a transaction, text message, agreement, obligation, or preference has expired or been completed.

szDescription1 DSC1 char NONE NONE

Brief information about an item; a remark or an explanation.

szDescription2 DSC2 char NONE NONE

A second, 30-character description, remark, or explanation.

jdAsOfDate EFFF JDEDATE OPT NONE

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.

Related Functions

B4000460 Free Ptr To Data Structure

Related Tables

F4104 Item Cross Reference File

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cReturnPointerFlag	EV01	char	NONE	NONE
Enter a '1' to Return Pointer. Enter a '0' to Not Return Pointer.ab ^
cCallType	EV01	char	NONE	NONE
Enter a '1' to verify that record exists. Enter a '2' to verify that record does not exist.ab ^
cSuppressErrorMessages	EV01	char	NONE	NONE
Enter a '1' to suppress runtime error message handling. Enter a '0' to allow runtime error message handling.ab ^
szIndex	DTAI	char	NONE	NONE
Pass in the number that identifies the index used to fetch the record.ab ^
szKeys	DTAI	char	NONE	NONE
Pass the number of key fields used to fetch the record.ab ^
szErrorMessageID	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.
idF4104Pointer	GENLNG	ID	NONE	NONE
General purpose ID variable.
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
szCrossRefTypeCode	XRT	char	NONE	NONE
A user defined code (41/DT) that identifies the type of cross-reference set up for this customer. Examples of cross-reference types include: o Substitutes o Replacements o Bar codes o Customer item numbers o Supplier item numbers
mnAddressNumber	AN8	MATH_NUMERIC	NONE	NONE
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
szCustomerItemNumber	CITM	char	NONE	NONE
The cross-reference item number that the system assigns to an item number. A cross-reference number allows you to use a supplier's item number if it is different from your own item number when you are processing an order or printing.
jdDateExpired	EXDJ	JDEDATE	NONE	NONE
The date on which a transaction, text message, agreement, obligation, or preference has expired or been completed.
szDescription1	DSC1	char	NONE	NONE
Brief information about an item; a remark or an explanation.
szDescription2	DSC2	char	NONE	NONE
A second, 30-character description, remark, or explanation.
jdAsOfDate	EFFF	JDEDATE	OPT	NONE
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.