GetUDCDescription

Get UDC Description

Minor Business Rule

Object Name: N0800031

Parent DLL: CHRM

Location: Client/Server

Language: NER

Functional Description

Purpose


This NER returns the the UDC Description from the F0005 file.  The UDC description is retrieved by 

using the a combination of the Data Dictionary value and the User Defined Code or a combination of the 

System Code, the User Defined Codes and the User Defined Code. These values are passed in by the user. 


Setup Notes and Prerequisites


Special Logic




Technical Specification


The first five fields of this NER are intended as input fields. 

-The szDataDictionaryItem field is the Data Dictionary item that has an associated UDC in its data 

edit rules.

-The szSystemCode field is the System Code variable (data type SY) found in the F0004 and F0005 

files.

-The szUserDefinedCodes field is the User Defined Codes variable (data type RT) found in the F0004 

and F0005 files.

-The cUserDefinedCode and szUserDefinedCode fields are the User Defined Code (data type KY) found in 

the F0005 file. The former is used for character variables; the later is used for string variables.


The remaining field are intended primarily as output fields.

-The szDescription01 field is used to retrieve the first description (data type DL01) from the F0005 

file.

-The szDescription02 field is used to retrieve the second description (data type DL02) from the F0005 

file.

-The cErrorCode returns one of the following values:


0 = No Errors

2 = No value could be found as both the cUserDefinedCode and the szUserDefinedCode have non-blank 

values

3 = The edit rule for the entered Data Dictionarry item is not a UDC

4 = The szSystemCode and/or szUserDefinedCode fields have values as well as the szDataDictionaryItem 

field. 

5 = User Defined Code not found in F0004

6 = No value could be found as the szDataDictionaryItem field is blank and the szSystemCode and/or 

the szUserDefinedCodes values are blank

7 = User Defined Code not found in F0005

8 = No value could be found as both the cUserDefinedCode and szUserDefinedCode fields are blank


-The szSpecialHandlingCode field is used to retrieve the special handling code (data type SPHD) from 

the F0005 file.


-------------------------------------------------------

Not all of the five input fields will be used simultaneously. The user will enter one of two 

combinations:

-A szDataDictionaryItem value 

and either a cUserDefinedCode 

  or a szUserDefinedCode value.

-A szSystemCode value , 

 a szUserDefinedCodes value, 

and either a cUserDefinedCode 

  or a szUserDefinedCode value.


The first combination is prefered as changes to the Data Dictionary item or UDC tables is 

automatically handled without having to manually enter new System Code and User Defined Codes values.



Data Structure

DN0800031 - Get UDC Description


^

Parameter NameData ItemData TypeReq/OptI/O/Both
szDataDictionaryItemDTAIcharNONENONE

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.

szSystemCodeSYcharNONENONE

A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts 
Payable 09 General Accounting 11 Multicurrency

szUserDefinedCodesRTcharNONENONE

A code that identifies the table that contains user defined codes. The table is also referred to as a UDC type.

cUserDefinedCodeEV01charNONENONE

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

szUserDefinedCodeKYcharNONENONE

A list of valid codes for a specific user defined code list.

szDescription01DL01charNONENONE

A user defined name or remark.

szDescription02DL02charNONENONE

Additional text that further describes or clarifies a field in the system.

cErrorCodeERRCcharNONENONE

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

szSpecialHandlingCodeSPHDcharNONENONE

A code that indicates special processing requirements for certain user defined code values. The value that you enter in this field is unique 
for each user defined code type. The system uses the special handling code in many ways. For example, special handling codes defined for 
Language Preference specify whether the language is double-byte or does not have uppercase characters. Programming is required to 
activate this field.

Related Functions

None

Related Tables

None