VisualAge Generator to Enterprise Generation Language Migration Guide


Maps

The maps section is organized into the following tables.


Figure 76. Maps -- general information

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
There are two types of maps:
  • Display maps
  • Printer maps
There are two types of forms:
  • Text forms
  • Print forms
No special considerations.
Map names consist of a map group name and a map name.

The form name does not include the formGroup name.

A form can be defined (nested) within a form group.

Alternatively, a form can be outside the formGroup part. In this case, the formGroup part must include a use statement to specify the form name and an import statement import the package in which the form located. This technique enables you to have one definition of a common form (for example, a pop-up list form) and make it available in many different form groups.

The migration tool migrates all maps to forms. The tool does not attempt to identify common, identical map definitions across multiple map groups.

If you migrate in single file mode, the migration tool includes a use statement for each form within a form group. You should move the forms so that they are nested within their formGroup part.

If you migrate using Stage 1 - 3 migration, the migration tool automatically nests all forms within the formGroup part.

When a program specifies a map group, the program can use any map within the map group just by referencing the map name. When a program includes a use statement to indicate which formGroup it is using, the program can reference any map within the formGroup just by referencing the form name. No special considerations.

Figure 77. Display maps -- general syntax, map type, and properties

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Display maps can contain the following:
  • Map group name and map name
  • Map properties
    • General properties
      • Help map name
      • Help key
      • Bypass keys
      • Variable field folding
    • Layout properties
      • Map size
      • Starting position
      • Floating map
    • Devices
      • Type (Display or Print)
      • Supported devices
  • Constant fields
  • Variable fields
  • Field edit order for variable fields
Text form parts can contain the following:
  • Form name
  • Form type
  • Form properties
  • Constant fields
  • Variable fields
  • Validation order for variable fields

An example of the format of a text form created by the migration tool is as follows:

Form mapName type textForm
 { screenSizes=(sizeList),
   formSize=(24,80), position=(1,1),
   helpForm=helpFormName,
   helpKey=pf1,
   validationBypassKeys=(pf3),
   msgField=VAGen_EZEMSG }
  [ variableFields ]
  [ constantFields ]
end // end mapName

The migration tool uses the VAGen device type to determine whether the map is a Display map (text form) or a Printer map (print form).

See Figure 75 for information about determing whether the device is a display or printer.

Help map name helpForm No special considerations.
Help key helpKey No special considerations.
Bypass keys

You can specify a maximum of 5 Bypass keys for a map.

validationBypassKeys

You can specify a maximum of 5 validationBypassKeys for a form.

No special considerations.
Variable field folding Not supported for a form. Each char or mbchar variable field on the form must specify whether the data the user enters is to be automatically converted to upper case. The migration tool does the following:
  • If Variable field folding is specified for the entire map, the migration tool includes upperCase=yes for every character and mixed field.
  • If Variable field folding is not specified for the entire map, the migration tool uses the Fold information specified for each character or mixed field to determine whether to set the upperCase property for that field.
Map size -- Lines and Columns size = ( Lines, Columns) No special considerations.
Starting position - Line and Column NEXT,SAME is required if the map ia a floating map. position = ( Line, Column )

If the position information is omitted, the form is a floating form

If Floating map is selected, the migration tool omits the position information.
Floating map Not applicable. If the position information is omitted, the form is a floating form. If Floating map is selected, the migration tool omits the position information.
Device Type - Display or DBCS Display type textForm The migration tool uses the Device Type information to determine whether to migrate the map to a text or print form.
Supported devices
Note:
Supported devices shows the device type, number of lines, and number of columns
screenSizes = ((Lines, Columns),
               (Lines, Columns))
Note:
Include a (Lines, Columns) pair for each screen size that you want to have supported for the form.

The migration tool uses the device type information to determine the corresponding screenSizes property. If several VAGen devices have the same screen Size, the migration tool only includes the screen size once.

Special considerations apply because not all of the devices supported by VAGen are supported for COBOL generation in EGL. See Map groups, maps, and device sizes for details.

Not applicable. In VisualAge Generator, the message field is always named EZEMSG. msgField

This is the name of the field that is to contain any EGL error messages.

The migration tool sets the msgField property if EZEMSG is anywhere on the map.
Not applicable. alias

The migration tool includes the alias property if the map has to be renamed due to a conflict with an EGL reserved word or because the map name starts with the # symbol. The migration tool also includes the alias property for a map in a program's help map group if the map has to be renamed due to a conflict with the name of a map in the program's main map group.

Special considerations apply. See Map names and help map names for details.


Figure 78. Printer maps -- general syntax, map type, and properties

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Printer maps can contain the following:
  • Map group name and map name
  • Map properties
    • General properties
      • Help map name
      • Help key
      • Bypass keys
      • Variable field folding
      • SO/SI take position
    • Layout properties
      • Map size
      • Starting position
      • Floating map
    • Devices
      • Type (Display or print)
      • Supported devices
  • Constant fields
  • Variable fields
  • Field edit order for variable fields
Print forms can contain the following:
  • Form name
  • Form properties
  • Constant fields
  • Variable fields

An example of the format of a text form created by the migration tool is as follows:

Form mapName type printForm
 {size=(255,158), position=(1,1),
  addSpaceForSOSI=yes }
  [ variableFields ]
  [ constantFields ]
end  // end mapName 

The migration tool uses the VAGen device type to determine whether the map is a Display map (text form) or a Printer map (print form).

The migration tool always omits the following properties for print forms:

  • General properties
    • Help map name
    • Help key
    • Bypass keys
    • Variable field folding
  • Devices
    • Supported devices
  • Field edit order for variable fields

See Figure 74 for information about determining whether the device is a display or printer.

Help map name Not applicable for a print form. The migration tool omits this property for a print form.
Help key Not applicable for a print form. The migration tool omits this property for a print form.
Bypass keys Not applicable for a print form. The migration tool omits this property for a print form.
Variable field folding Not applicable for a print form. The migration tool omits this property for a print form.
SO/SI take position addSpaceForSOSI No special considerations.
Map size -- Lines and Columns size = ( Lines, Columns ) No special considerations.
Starting position - Line and Column NEXT,SAME is required if the map is a floating map. position = ( Line, Column )

If the position information is omitted, the form is a floating form.

If Floating map is selected, the migration tool omits the position information.
Floating map Not applicable.

If the position information is omitted, the form is a floating form.

If Floating map is selected, the migration tool omits the position information.
Device Type - Printer or DBCS Printer type printForm The migration tool uses the Device Type information to determine whether to migrate the map to a text or print form.
Supported devices Not applicable for a print form. The migration tool omits this property for a print form.
Not applicable. In VisualAge Generator, the message field is always named EZEMSG. msgField

This is the name of the field that is to contain any EGL error messages.

The migration tool sets the msgField property if EZEMSG is anywhere on the map.
Not applicable. alias

The migration tool includes the alias property if the map has to be renamed due to a conflict with an EGL reserved word or because the map name starts with the # symbol. The migration tool also includes the alias property for a map in a program's help map group if the map has to be renamed due to a conflict with the name of a map in the program's main map group.

Special considerations apply. See Map names and help map names


Figure 79. Map constant and variable fields -- general information

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
All positions on a map must be accounted for as one of the following:
  • a variable field
  • a constant field
  • an attribute byte at the beginning of a constant or variable field
All positions on a form do not have to be accounted for. Blank constants that have the default properties (noHighLight, normalIntensity, protect=skip, defaultColor, no outlining, and no cursor) do not need to be specified. The migration tool omits blank constants that have the default properties.
Constant fields on display maps can have attributes specified that do not really apply to constants. For example:
  • Unprotected
  • Input required
  • Require fill on input
  • Numeric attribute
  • Modified data tag
Constant fields on text forms cannot specify properties that do not make sense for a constant. The migration tool omits properties for constants on text form if the properties are not supported.
Constant field on printer maps can have attributes that do not really apply to printers. For example:
  • Color
  • Intensity
  • Highlighting other than underscore
  • Protection
  • Initial cursor field
  • Light pen detect
Constant fields on print forms cannot specify properties that do not make sense for a constant. The migration tool omits properties for constants on print forms if the properties are not supported.
Variable fields on printer maps can specify attributes that do not really apply to printers. For example:
  • Color
  • Intensity
  • Highlighting other than underscore
  • Protection
  • Initial cursor field
  • Input required
  • Require fill on input
  • Numeric attribute
  • Modified data tag
  • Light pen detect
Variable fields on print forms cannot specify properties that to not make sense for a print form. The migration tool omits properties for variable fields on print forms if the properties are not supported.
Variable fields on printer maps can specify edits that do not really apply to printers. For example:
  • Minimum input
  • Fold
  • Hex edit
  • Input required
  • Minimum value
  • Maximum value
  • Edit messages
Variable field on print forms cannot specify properties that to not make sense for a print form. The migration tool omits properties for variable fields on print forms if the properties are not supported.

Figure 80. Map constant and variable fields -- general syntax, data type, length, decimals, and description

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
A variable on a map has the following information:
  • Name
  • Information based on what you dropped on the map:
    • Data type
    • Position
  • Basic information:
    • Descripton
    • Initial value
    • Length in bytes
    • Array index
    • Numeric edit
  • Attributes
  • Edits, including number of decimals
  • Error messages
Note:
position is the position of the attribute byte. The length in bytes is the length of the field in bytes, excluding the attribute byte. The length in bytes is also used for the length of the data value.
The information for a variable field on a map includes the following:
  • Name
  • Type and length in characters for character fields
  • Type, precision, and scale for numeric fields
  • Position
  • Field length in bytes
  • Presentation properties
  • Formatting properties
  • Validation properties
  • Value

In general, the following is true:

  • VAGen attributes correspond to EGL presentation properties.
  • VAGen edits and messages correspond to EGL formatting properties or validation properties.
  • However, some of the VAGen attributes and edits are merged into a single EGL property or moved to a different category.

Here is an example of an EGL variable field:

itemName
  dataType(lengthInformation)
  // description
  { position=(row,column),
    fieldLen=length
    validationOrder=n
    [presentationProperties]
    [formattingProperties]
    [value="initialValue"] }
   [arrayInformation]
 
Note:
position is the position of the attribute byte. fieldLen is the length of the field in bytes, excluding the attribute byte. The primitive type information given in dataType(lengthInformation) is the length of the data value.
The migration tool sets the EGL fieldLen property to the VAGen Length in bytes. The tool sets the lengthInformation for the dataType as follows:
  • For char, dbchar, and mbchar fields, migration tool sets the lengthInformation to the number of characters, not the number of bytes.
  • For VAGen char fields that specify the Numeric edit, the migration tool does the following:
    • Converts the field to the EGL num type.
    • Sets the precision to the VAGen length in bytes and then reduces the precision by one if decimals are specified for the field in VisualAge Generator.
    • Sets the scale to the number of decimals specified in VisualAge Generator.

Special considerations apply. See Numeric variable fields for details.

A constant on a map has the following information:
  • Information based on what you dropped on the map:
    • Data type
    • Position
  • Basic information:
    • Initial value
    • Length in bytes
  • Attributes
Note:
position is the position of the attribute byte. The length in bytes is the length of the field in bytes, excluding the attribute byte.
The information for a constant field on a map includes the following:
  • Position
  • Field length
  • Presentation properties
  • Value

In general, the following is true:

  • VAGen attributes correspond to EGL presentation properties.
  • Attributes that apply only to input editing are not supported for EGL constant fields.

The data type for a constant is determined based on the value property.

Here is an example of an EGL constant field:

{ position=(row,column),
  fieldLen=length,
  [presentationProperties]
  [value="initialValue"] }
Note:
position is the position of the attribute byte. fieldLen is the length of the field in bytes, excluding the attribute byte.
The migration tool sets the EGL fieldLen property to the VisualAge Generator Length.
Data type:
  • Character constant
  • Character variable
  • DBCS constant
  • DBCS variable
  • Mixed constant
  • Mixed variable
  • Character variable with the Numeric edit selected
Note:
The type is determined based on the type of field you drop on the map and whether you select the Numeric edit box.
EGL data type:
  • Not applicable
  • char
  • Not applicable
  • dbchar
  • Not applicable
  • mbchar
  • num
No special considerations.
Description Not applicable. The migration tool converts the description to a comment that follows the data type and length information.
Initial value value
Note:
  • In VisualAge Generator Compatibility mode, the value property is only used when displaying a field on the screen that has not had a value assigned to it. The value property is not used to set the initial value of the field in storage.
  • When VisualAge Generator Compatibility mode is not specified, the value property provides the initial value of field in the program when the program starts.
No special considerations.
Length An EGL variable has the following:
  • A length, which is the number of characters or digits in the field.
  • A fieldLen, which is the space the field occupies on the map, excluding the attribute byte.
The migration tool uses the VAGen length to set both the EGL length and the EGL fieldLen properties. Special considerations apply for numeric fields. See Numeric variable fields for details.
Array index
Note:
  • The array size is determined based on the highest array index for the variable field.
  • You can override some attributes such as cursor position, color, highlighting, intensity, protection, and cursor position for elements of the array.
  • You can also override the initial value for elements of the array.
itemName
  datatype(lengthInfo)
  [ arraySize ]
  { properties for index 1 }
  itemName[n]
  { properties for index n }
Note:
  • The array size is specified immediately after the datatype and length information.
  • You can override cursor location, and presentation properties such as color, highlighting, intensity, and protect.
  • You can also override the value property.
  • You can specify the position of each element by doing the following:
    • Specifying the explicit position of each element with position(row,column).
    • Specifying the following additional properties for index 1: columns, linesBetweenRows, spacesBetweenColumns, and indexOrientation.
The migration tool always explicitly sets the position for each element of the array.
Field Edit Order
Note:
  • Field Edit Order is specified from the Define pulldown.
  • The default Field Edit Order is based on the position of the variable fields on the map, left to right, then top to bottom.
  • Some versions of Cross System Product and VisualAge Generator did not record the field edit order in the External Source Format.
validationOrder
Note:
The default validationOrder is based on the position of the variable fields on the map, left to right, then top to bottom.
The migration tool omits the validationOrder if it is not included in the External Source Format for the map.

Figure 81. Map constant and variable fields -- attributes

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Intensity:
  • Normal
  • Dark
  • Bright
intensity:
  • normalIntensity
  • invisible
  • bold
(presentation property)
No special considerations.
Highlight:
  • No highlight
  • Blink
  • Reverse video
  • Underscore
highlight:
  • noHighlight
  • blink
  • reverse
  • underline
(presentation property)
No special considerations.
Protection:
  • Unprotected
  • Protected
  • Autoskip
protect:
  • no
  • yes
  • skip
(presentation property)
No special considerations.
Color:
  • Mono
  • Blue
  • Red
  • Pink
  • Green
  • Turquoise
  • Yellow
  • White
color:
  • defaultColor
  • blue
  • red
  • magenta
  • green
  • cyan
  • yellow
  • white
(presentation property)
No special considerations.
Initial cursor field
cursor = yes | no
(form field property)
No special considerations.
Input required inputRequired (validation property) The migration tool merges the VAGen Input required attribute and the Input required edit as follows:
  • If either the Input required attribute or the Input required edit is selected, the migration tool includes inputRequired.
  • If neither is selected, the migration tool omits inputRequired.
Require fill on input fill (validation property) No special considerations.
Numeric attribute
Note:
This property is supported for CHA fields, including CHA fields that have Numeric edit selected.
isDecimalDigit (validation property)
Note:
This property is only supported for char fields.
If the Numeric attribute is selected, the migration tool does the following:
  • Includes isDecimalDigit for char fields.
  • Omits isDecimalDigit for numeric fields. EGL provides a software edit for numeric fields to maintain compatibility with VAGen.

See Map fields and the numeric hardware attribute for additional details.

Modified data tag modified (presentation property) No special considerations.
Light pen detect detectable (presentation property) No special considerations.
Outlining:
  • left
  • right
  • over
  • under
  • box
outline:
  • left
  • right
  • over
  • under
  • box
(presentation property)
No special considerations.

Figure 82. Map variable fields -- general edits

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Edit routine validator OR validatorTable

(validation property)

The migration tool does the following:
  • Sets the validator property if the map edit routine is EZEC10 or EZEC11.
  • Sets the validator property if the edit routine is a function.
  • Sets the validatorTable property if the edit routine is a table.
Note:
Special considerations apply if the edit routine is not available during migration. See Variable map fields and edit routines for additional details and potential problems.
Justify - Left | Right | None
Note:
For map items, the default is right for numeric fields and left for all other fields.
align = left | right | none

(formatting property)

Note:
For form fields, the default is right for numeric fields and left for all other fields.
No special considerations.
Date edit mask

Values are as follows:

  • SYSGREGRN
  • SYSJULIAN
  • dateEditPattern
dateFormat = value

Values are as follows:

  • systemGregorian
  • systemJulian
  • "dateEditPattern"

(formatting property)

No special considerations.
Minimum input minimumInput (validation property) No special considerations.
Fill character
Note:
The default fill character for items used on a map is null for character, DBCS, or MIXED fields; blank for numeric fields; and 0 for hex fields.
fillCharacter (formatting property)
Note:
The default fill character for items used on a map is null for character, DBCS, or MIXED fields; blank for numeric fields; and 0 for hex fields.
No special considerations.
Fold upperCase (formatting property) The migration tool does the following:
  • If Variable field folding is specified for the entire map, the migration tool includes upperCase=yes for every character and mixed field.
  • If Variable field folding is not specified for the entire map, the migration tool uses the Fold information specified for each character or mixed field to determine whether to set the upperCase property for that field.
Hex edit isHexEdit (validation property) No special considerations.
Input required inputRequired (validation property) The migration tool merges the VAGen Input required attribute and the Input required edit as follows:
  • If either the Input required attribute or the Input required edit is selected, the migration tool includes inputRequired.
  • If neither is selected, the migration tool omits inputRequired.
Check SO/SI space needsSOSI (validation property) No special considerations.

Figure 83. Map variable fields -- numeric edits

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Minimum value and Maximum value
Note:
If either Minimum value or Maximum value is specified, both must be specified.
range = ( minimumValue, maximumValue ) (validation property) The migration tool combines the Minimum value and Maximum value into the EGL range property.
Sign:
  • None
  • Leading
  • Trailing
Note:
The default is None.
sign:
  • none
  • leading
  • trailing

(validation property)

Note:
The default is none.
No special considerations.
Currency currency = yes | no (formatting property)
Note:
  • If currency = yes, the actual currency symbol used at runtime is set the same way it is in VAGen.
  • Alternatively, you can specify currency="symbol" for a form variable field.
The migration tool only sets currency to yes or no. The tool never sets currency="symbol" for form variable fields.
Separator numericSeparator (formatting property) No special considerations.
Zero edit zeroFormat (formatting property) No special considerations.

Figure 84. Map variable fields -- error messages

VisualAge Generator 4.5
EGL produced by the migration tool Migration tool considerations
Edit routine validatorMsgKey OR validatorTableMsgKey (validation properties) The migration tool migrates the edit routine message as follows:
  • Sets validatorMsgKey if the edit routine is EZEC10 or EZEC11.
  • Sets validatorTableMsgKey if the edit routine is a table.
  • Does not migrate the edit routine message if the edit routine is a function because the message is not used in this situation in VisualAge Generator.

See Variable map fields and edit routines for additional details and potential problems.

Minimum input minimumInputMsgKey (validation property) No special considerations.
Input required inputRequiredMsgKey (validation property) No special considerations.
Data type typeChkMsgKey (validation property) No special considerations.
Numeric range rangeMsgKey (validation property) No special considerations.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]