ItemAlternativeDesc
Item Alternative Description
Major Business Rule
Object Name: B4100560
Parent DLL: COPBASE
Location: Client/Server
Language: C
Functional Description
Purpose
This function retrieves records from the Item Alternative Description table (F4101D) or
updates/writes records to the Item Alternative Description table.
Setup Notes and Prerequisites
The Language Preference (LNGP), Compressed Text (ALN), Item Number (ITM) and Program Id (PID) are
required input parameters.
If the MODE (EV01) = '1', the record is retrieved.
If the MODE (EV01) = '2', the record is updated/added. The 2nd and 3rd (LITM, AITM) fields are
required.
Technical Specification
This function retrieves the Item Alternative Description record for the Item and Language Preference
passed in if the Mode = '1'. If a record is found, the descriptions are returned.
If Mode = '2', If the record does not exist, a record is written to the F4101D if the Description
fields (DSC1 and DSC2) and Compressed Text (ALN) fields are not blank.
If Mode = '2', If the record does exist and DSC1, DSC2 and ALN are all blank, delete the F4101D
record, otherwise, update the record.
Data Structure
D4100560 - Item Alternative Description
| Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
|---|
| szLanguagePreference | LNGP | char | NONE | NONE |
A user defined code (01/LP) that specifies the language to use on forms and printed reports. Before you specify a language, a code for that
language must exist at either the system level or in your user preferences. |
| 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 |
| szDescription1 | DSC1 | char | NONE | NONE |
Brief information about an item; a remark or an explanation.
|
| szDescription2 | DSC1 | char | NONE | NONE |
Brief information about an item; a remark or an explanation.
|
| szSearchText | SRTX | char | NONE | NONE |
A field that lets you specify how the system searches for an item. Your entry should be specific and descriptive of the item. Type the words
in the order a user is likely to enter them.
In single-byte environments, where computer storage space can hold only Latin-based language
character sets, the system inserts the first 30 characters from the item's description if you do not enter search text.
In double-byte environments,
where computer storage space can hold more complex language character sets (in languages such as Japanese, Chinese, and Korean),
you must complete this field. It is a single-byte field that you complete with single-byte characters to phonetically represent the item
description (which can be single-byte, double-byte, or both). |
| szCompressedText | ALN | char | NONE | NONE |
The compressed version of the thirty character alpha search field, with all blanks removed. |
| cMode | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event.
|
| 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.
|
| cSuppressErrorMessage | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event.
|
| szProgramId | PID | char | NONE | NONE |
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.
|
| szSecondItemNumber | LITM | char | NONE | NONE |
A number that identifies the item. The system provides three separate item numbers plus an extensive cross-reference capability to
alternative item numbers. The three types of item numbers are:
Item Number (short)
An 8-digit, computer-assigned item number.
2nd Item Number
A
25-digit, user defined, alphanumeric item number.
3rd Item Number
Another 25-digit, user defined, alphanumeric item number.
In addition to
these three basic item numbers, the system provides an extensive cross-reference search capability. You can define numerous
cross-references to alternative part numbers. For example, you can define substitute item numbers, replacements, bar codes, customer numbers, or
supplier numbers.
|
| szThirdItemNumber | AITM | char | NONE | NONE |
The system provides three separate item numbers plus an extensive cross-reference capability to alternate item numbers. These item
numbers are as follows:
1. Item Number (short) - An 8-digit, computer-assigned 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.
In addition to
these three basic item numbers, an extensive cross-reference search capability has been provided (see XRT). Numerous cross references to
alternate part numbers can be user defined, such as substitute item numbers, replacements, bar codes, customer numbers, or supplier
numbers. |