GetDataDictionaryDescriptions

F9202/F9203 Get Data Dictionary Descriptions

Minor Business Rule

Object Name: N7992002

Parent DLL: CTRANS

Location: Client/Server

Language: NER

Functional Description

Purpose
Retrieve the English Alpha Description and the Row/Column Descriptions from the F9203 and F9202
respectively.

Setup Notes and Prerequisites
Pass in
• A flag of '1' to indicate if F9202 or F9203 exists.
• The keys to the files, DTAI, SYR, SCRN.
'b7
This is typically retrieved when using N7992001 - Get Data Dictionary Status information

Special Logic

Technical Specification

Data Structure

D7992002 - F9202/F9203GetDataDictionaryDescriptions

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

cActionCode ACTN char REQ INPUT

A code that specifies the action that is performed. Valid values are: A Add C Change

cUpdateMasterFile EV01 char REQ INPUT

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

cProcessEdit EV02 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
runtime error message handling.        1 = suppress runtime error message handling.

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
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

szVersion VERS char OPT NONE

A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined
processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a
menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.

szDataItem DTAI char REQ INPUT

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.

szLanguagePreference LNGP char REQ INPUT

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.

szProductCodeReporting SYR char REQ INPUT

A user defined code (98/SY) that specifies the system number for reporting and jargon purposes.

szScreenName SCRN char REQ INPUT

In OneWorld, a form or application object name as found in the Object Management Workbench. In WorldSoftware, a screen or display file
name as found in the Software Versions Repository.

cF92021Exists EV05 char REQ INPUT

A flag that indicates whether automatic spell check is turned on.

cF92031Exists EV06 char REQ INPUT

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

szDescriptionAlpha DSCA char OPT OUTPUT

A description for the data items. Enter text in upper and lower case. The system uses this name to search for similar data items. To enter an
alpha description, follow these conventions: Dates Begin all date fields with the word, Date. Amounts Begin all amount fields with the word,
Amount. Units Begin all unit, quantity, and volume fields with the word, Units. Name Begin all 30-byte description fields with the word,
Name. Prompt Begin any Y/N prompting field with the word, Prompt. Address Number Begin all address numbers (employee, customer, owner) with the
word, Address Number.

szDescriptionRow DSCR char OPT OUTPUT

For OneWorld, the row description that identifies fields on forms and reports. For World, the title that identifies text and reports. Use it in a
manner similar to the column description in the query facility. It should be less than 35 characters. Use abbreviations whenever possible.
Common abbreviations are: U/M Units of measure   YTD Year-to-date MTD Month-to-date PYE Prior year end   QTY Quantity G/L General ledger
A/P Accounts payable   DEPR Depreciation

szColTitle1 CH1 char OPT OUTPUT

The first line of description used in column headings on a report or form. This description should be no larger than the data item size, if
possible. If the column heading is only one line, it should be placed in this column. Use the second line of the Column Title when one is not
sufficient.

szColTitle2 CH2 char OPT OUTPUT

The second line of description used in column headings on a report or form. This description should be no larger than the data item size, if
possible. If the column heading is only one line, it should be placed in the first column.

szDescCompressed DSCC char OPT NONE

The compressed description contains the alpha name without spaces, slashes,dashes, commas, and other special characters.  The
compressed description is the field used in the Data Dictionary Name Search.

Related Functions

None

Related Tables

None

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
cActionCode	ACTN	char	REQ	INPUT
A code that specifies the action that is performed. Valid values are: A Add C Change
cUpdateMasterFile	EV01	char	REQ	INPUT
An option that specifies the type of processing for an event.
cProcessEdit	EV02	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 runtime error message handling. 1 = suppress runtime error message handling.
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 special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.
szVersion	VERS	char	OPT	NONE
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szDataItem	DTAI	char	REQ	INPUT
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.
szLanguagePreference	LNGP	char	REQ	INPUT
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.
szProductCodeReporting	SYR	char	REQ	INPUT
A user defined code (98/SY) that specifies the system number for reporting and jargon purposes.
szScreenName	SCRN	char	REQ	INPUT
In OneWorld, a form or application object name as found in the Object Management Workbench. In WorldSoftware, a screen or display file name as found in the Software Versions Repository.
cF92021Exists	EV05	char	REQ	INPUT
A flag that indicates whether automatic spell check is turned on.
cF92031Exists	EV06	char	REQ	INPUT
An option that specifies the type of processing for an event.
szDescriptionAlpha	DSCA	char	OPT	OUTPUT
A description for the data items. Enter text in upper and lower case. The system uses this name to search for similar data items. To enter an alpha description, follow these conventions: Dates Begin all date fields with the word, Date. Amounts Begin all amount fields with the word, Amount. Units Begin all unit, quantity, and volume fields with the word, Units. Name Begin all 30-byte description fields with the word, Name. Prompt Begin any Y/N prompting field with the word, Prompt. Address Number Begin all address numbers (employee, customer, owner) with the word, Address Number.
szDescriptionRow	DSCR	char	OPT	OUTPUT
For OneWorld, the row description that identifies fields on forms and reports. For World, the title that identifies text and reports. Use it in a manner similar to the column description in the query facility. It should be less than 35 characters. Use abbreviations whenever possible. Common abbreviations are: U/M Units of measure YTD Year-to-date MTD Month-to-date PYE Prior year end QTY Quantity G/L General ledger A/P Accounts payable DEPR Depreciation
szColTitle1	CH1	char	OPT	OUTPUT
The first line of description used in column headings on a report or form. This description should be no larger than the data item size, if possible. If the column heading is only one line, it should be placed in this column. Use the second line of the Column Title when one is not sufficient.
szColTitle2	CH2	char	OPT	OUTPUT
The second line of description used in column headings on a report or form. This description should be no larger than the data item size, if possible. If the column heading is only one line, it should be placed in the first column.
szDescCompressed	DSCC	char	OPT	NONE
The compressed description contains the alpha name without spaces, slashes,dashes, commas, and other special characters. The compressed description is the field used in the Data Dictionary Name Search.