Previous Page Contents Page Next Page

4.5 5250 Style File Records

The style file can contain the following records:

[define_style_header]

This record defines settings that are applied globally to all sessions.

[define_session_details]

This record defines settings for a particular session.

[define_printer]

This record specifies information for the printer that you will be using with your printer sessions.

[define_key_definitions]

This record defines the key definitions used by the emulation program.

[define_recplay_macro]

This record defines a macro.

[define_color_mapping]

This record defines a set of color mappings. It can be referred to by the [define_style_header] record, in which case the color mappings will apply globally to all sessions, or it can be referred to by specific [define_session_details] records, in which case the color mappings will just apply to those sessions.

The following sections describe these records.

4.5.1 [define_style_header]

The [define_style_header] record is an optional record that determines global settings (settings that are applied to all the sessions) for the 5250 emulation program. All of the fields in the [define_style_header] record are optional. These may be overridden by settings specified for individual sessions (in [define_session_details] records).

This record must always be included in the style file.

Parameter name                Type         Length   Default
[define_style_header]
 use_beep                     constant              YES
 popups_suppressed            constant              NO
 session_control_suppressed   constant              NO
 status_ltti_display          constant              YES
 status_cursor_pos_display                          YES
 status_session_id_display    constant              YES
 status_system_name_display   constant              YES
 large_icons                  constant              YES
 key_defs_5250_tag            character    32       "default key definitions"
 so_display_character         character    4        '
 si_display_character         character    4        `
 colormap_5250_tag            character    32       "default color map"
 host_codepage                character
 local_codepage               character    16       "ISO8859-1"
 initial_session_state        constant              DISABLED
 user_ID                      character    10
 password                     character    10
 startup_macro_tag            character    32
 support_132_columns          constant              NO
 printer_tag                  character    32       "default printer"

Supplied fields are:

use_beep

Specifies whether the 5250 emulation program uses the beep to indicate errors. The beep occurs (for example) when you type too many characters for the keyboard buffer to hold. This option does not affect the audible signals that are produced when you make an error in the menus and dialog boxes of the user interface-these cannot be disabled. Possible values are:

YES

The 5250 emulation program uses the beep to indicate errors.

NO

The 5250 emulation program does not use the beep to indicate errors.

popups_suppressed

Specifies whether the emulation program warning pop-ups are enabled or disabled. Possible values are:

YES

Warning pop-ups are disabled.

NO

Warning pop-ups are enabled.

session_control_suppressed

Specifies whether the session control window is enabled or disabled. Possible values are:

YES

The session control window is not displayed and can not be used to control sessions. Only those sessions that have an initial state of DISCONNECTED or CONNECTED and have a user ID and password configured (see the define_session_details record) are displayed. No other sessions can be used. If there are no suitable sessions then an error will be displayed and the emulator will fail to start.

Once a session window is terminated it cannot be re-enabled. The 5250 emulator will exit when the last session is terminated (unless there are printer sessions in use). If printer sessions are enabled then the emulator has to be terminated using the UNIX kill command.

NO

The session control window is displayed and can be used to control the sessions.

status_ltti_display

Specifies whether the LTTI status indicator is displayed. Possible values are:

YES

The LTTI status indicator is displayed.

NO

The LTTI status indicator is not displayed.

status_cursor_pos_display

Specifies whether the cursor position status indicator is displayed. Possible values are:

YES

The cursor position status indicator is displayed.

NO

The cursor position status indicator is not displayed.

status_session_id_display

Specifies whether the session ID status indicator is displayed. Possible values are:

YES

The session ID status indicator is displayed.

NO

The session ID status indicator is not displayed.

status_system_name_display

Specifies whether the system name status indicator is displayed. Possible values are:

YES

The system name status indicator is displayed.

NO

The system name status indicator is not displayed.

large_icons

Specifies whether large or small icons are used. Possible values are:

YES

Large icons are used.

NO

Small icons are used.

key_defs_5250_tag

Specifies the tag identifying the key definitions that will be used in 5250 emulation. This string is case sensitive. Any printable character is allowed.

so_display_character

Specifies the Shift Out character that will be displayed if a double-byte language is used. You can specify either the character itself or the hexadecimal value of that character.

si_display_character

Specifies the Shift In character that will be displayed if a double-byte language is used. You can specify either the character itself or the hexadecimal value of that character.

colormap_5250_tag

Specifies the tag identifying the color mappings that will be used in 5250 emulation. This string is case sensitive. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

host_codepage

Specifies the number of the host codepage that will be used as the default for all sessions.

local_codepage

Specifies the number of the local codepage that will be used as the default for all sessions.

initial_session_state

Specifies the state in which the session will be started up. Possible values are:

DISABLED

The session will be started up in Disabled state. This means that the session window will not be opened.

DISCONNECTED

The session will be started up in Disconnected state. This means that the session window will be opened but the session will not be connected to the AS/400.

CONNECTED

The session will be started up in Connected state. This means that the session window will be opened and the program will attempt to connect to the AS/400.

user_ID

Specifies the global user ID for the sessions.

password

Specifies the global password for the sessions.

startup_macro_tag

Specifies a macro that will be used when the display session connects to the AS/400. (This field only applies to display sessions because you cannot run macros in printer sessions.) This macro usually contains logon information. This string is case sensitive. Possible values are:

macro name

The name of the macro. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

NONE

Specifies that no macro is to be replayed when the session is connected to the AS/400.

support_132_columns

Specifies whether display sessions support a large screen size (132 columns wide instead of 80 columns). Possible values are:

YES

Specifies that 132 columns are supported. The session window will be 132 columns wide.

NO

Specifies that 80 columns are supported. The session window will be 80 columns wide.

printer_tag

Specifies the tag identifying the printer that will be used in 5250 emulation. This string is case sensitive. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

4.5.2 [define_session_details]

The [define_session_details] record determines settings for specific 5250 sessions. Each [define_session_details] record must have a session_name field specified, but the other fields are optional. These settings override any values specified in the global information. If you do not specify values here for the optional parameters, the 5250 emulation program uses values specified in the global information.

Parameter name                 Type           Length   Default
[define_session_details]
session_name                   character      8
host_codepage                  character      4
local_codepage                 character      16
initial_session_state          constant
startup_macro_tag              character      16
user_ID                        character      10
password                       character      10
support_132_columns            constant
colormap_5250_tag              character      32
key_defs_5250_tag              character      32
5250_device_name               character      10
printer_tag                    character      32

Supplied fields are:

session_name

A name identifying the session to which this information applies. This is an 8-byte string and must match the session name configured on the 5250 session information (see Configuring SNAP-IX. This field must always be set.

host_codepage

This specifies the number of the host codepage that will be used for this session. The value specified here overrides the value specified in the global information.

local_codepage

This specifies the number of the local codepage that will be used for this session. The value specified here overrides the value specified in the global information.

initial_session_state

Specifies the state in which the session will be started up. Possible values are:

DISABLED

The session will be started up in Disabled state.

DISCONNECTED

The session will be started up in Disconnected state. This means that the session window will be opened but the session will not be connected to the AS/400.

CONNECTED

The session will be started up in Connected state.

startup_macro_tag

Specifies a macro that will be used when the display session connects to the AS/400. (This field only applies to display sessions because you cannot run macros in printer sessions.) This usually contains logon information. This string is case sensitive. Possible values are:

macro name

The name of the macro. This is a 32-byte string. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

NONE

Specifies that no macro is to be replayed when the session is connected to the AS/400.

user_ID

Specifies the user ID for the session if it is different from the user ID specified in the global information.

password

Specifies the password for the session if it is different from the password specified in the global information.

support_132_columns

Specifies whether this display session supports a large screen size (132 columns wide instead of 80 columns). Possible values are:

YES

Specifies that 132 columns are supported. The session window will be 132 columns wide.

NO

Specifies that 80 columns are supported. The session window will be 80 columns wide.

colormap_5250_tag

Specifies the tag for the color mapping of this session (if this is different from the tag specified in the global information). This string is case sensitive. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

key_defs_5250_tag

Specifies the tag for the key definitions that will be used for this session (if this is different from the tag specified in the global information). This string is case sensitive. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

5250_device_name

Specifies the name that the AS/400 will use to identify the session. Only specify the name if your System Administrator tells you to (your System Administrator should also tell you what you should specify here). Possible values are:

device name

The name that the AS/400 will use to identify this session.

NONE

No name is specified. In this case the emulation program will create an implicit device name.

printer_tag

Specifies the tag identifying the printer that will be used in 5250 emulation (if this is different from the tag specified in the global information). This string is case sensitive. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

4.5.3 [define_printer]

The [define_printer] record determines settings for the printer you are using. The following fields must be set in each [define_printer] record: tag, printer_file_or_device, print_filter_application, paper_width, paper_height, virtual_width, virtual_height, virtual_rows, and virtual_columns. The other fields are optional.

Parameter name                Type            Length      Default
[define_printer]
tag                           character       32
output_device_type            constant                    PRINTER
print_file_write_mode         constant                    OVERWRITE
printer_file_or_device        character       256
print_filter_application      character       256
printer_model                 constant                    5224
paper_width                   number                      8.3
paper_height                  number                      11.7
virtual_width                 number                      13.2
virtual_height                number                      11
virtual_rows                  number                      55
virtual_columns               number                      132
orientation                   constant                    LANDSCAPE
host_print_transform          constant                    NO
printer_type                  character       15
paper_source1                 constant                    A4
paper_source2                 constant                    LETTER
envelope_source               constant                    NONE
wsc_lib                       character                   ""
wsc_file                      character       10          ""

Supplied fields are:

tag

Specifies the identifier for this particular [define_printer] record. This field must always be set, and must be unique. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

output_device_type

Specifies whether the contents of the session window will be sent to a printer or a file when you click on the Print Session Window button in a session window (or when this session receives a COPY TO PRINTER command from the AS/400). Possible values are:

PRINTER

Specifies that the contents of the session window will be sent to a printer.

FILE

Specifies that the contents of the session window will be sent to a file.

print_file_write_mode

Specifies whether the contents of the session window will be appended to an existing file, or whether the information will override information in the file. This field is only used if output_device_type is set to FILE and is ignored if the contents of the session window are to be sent to a printer. Possible values are:

APPEND

Specifies that session window information will be appended to existing information in the destination file.

OVERWRITE

Specifies that session window information will overwrite existing information in the destination file.

printer_file_or_device

Specifies the name of the file or printer to which this session window information will be written. If the output_device_type parameter is set to FILE, specify the name of the file here. If the output_device_type parameter is set to PRINTER, specify the name of the printer here. This field must always be set.

printer_filter_application

Specifies the name of the printer filter application that will be used to translate output from both local copy printing and printer sessions. This field must always be set. The emulation program supplies two applications that can be accessed. Possible values are:

SNAPRTA

This is an ASCII print application that can produce simple printer commands. (It may lose more complex print format information, such as character density.)

SNAPRTPS

This is a PostScript print application.

printer_model

Specifies which printer model of the 5250 IDS is being emulated. Possible values are:

5224

This is 5224 printer emulation.

3812

This is 3812 printer emulation.

The emulation program requires information about the paper onto which you will be printing. This information can be supplied in two ways.

The information in the fields below is used for local copy printing, and for printer session printing (if you are not using the host print transform facility). You must always set the information in these fields.

paper_width

Specifies the page width, in inches, of the paper you are using.

paper_height

Specifies the page height, in inches, of the paper you are using.

virtual_width

Specifies the page width, in inches, that has been configured on the AS/400 for the printer you are using. If your System Administrator is unable to tell you what this is, then specify the actual width of the paper that you are using.

virtual_height

Specifies the page height, in inches, that has been configured on the AS/400 for the printer you are using. If your System Administrator is unable to tell you what this is, then specify the actual width of the paper that you are using.

virtual_rows

Specifies the number of rows of data per page that has been configured on the AS/400 for the printer you are using. If your System Administrator is unable to tell you what this is, then specify the actual number of rows of data per page that you are using.

virtual_columns

Specifies the number of columns of data per page that has been configured on the AS/400 for the printer you are using. If your System Administrator is unable to tell you what this is, then specify the actual number of columns of data per page that you are using.

orientation

Specifies the page orientation of the paper. Possible values are:

LANDSCAPE

Specifies that you will be printing in a landscape orientation.

PORTRAIT

Specifies that you will be printing in a portrait orientation.

Provide the information in the fields that follow if you are using the AS/400 host print transform facility.

host_print_transform

Specifies whether you will use the host print transform facility provided by the AS/400. Ask your System Administrator whether this functionality is available to you. For more information about this feature, refer to your AS/400 documentation. Possible values are:

YES

Specifies that you will use the host print transform facility.

NO

Specifies that you will not use the host print transform facility.

printer_type

Specifies the type of printer that you are using. For more information about valid values that can be supplied here, refer to the AS/400 documentation.

paper_source1

Specifies the first paper source. For more information about this field, refer to the AS/400 documentation. Possible values are:

  • MFRTYPMDL

  • LETTER

  • LEGAL

  • EXECUTIVE

  • A4

  • A5

  • B5

  • CONT80

  • CONT132

  • NONE

These values represent the standard values used by the AS/400-refer to your AS/400 documentation for more information about each value.

paper_source2

Specifies the second paper source. For more information about this field, refer to the AS/400 documentation. Possible values are:

  • MFRTYPMDL

  • LETTER

  • LEGAL

  • EXECUTIVE

  • A4

  • A5

  • B5

  • NONE

These values represent the standard values used by the AS/400-refer to your AS/400 documentation for more information about each value.

envelope_source

Specifies the envelope source. For more information about this field, refer to the AS/400 documentation. Possible values are:

  • MFRTYPMDL

  • B5

  • MONARCH

  • NUMBER9

  • NUMBER10

  • C5

  • DL

  • NONE

These values represent the standard values used by the AS/400-refer to your AS/400 documentation for more information about each value.

wsc_lib

Specifies the name of the workstation customization library. For more information about this field, refer to the AS/400 documentation.

wsc_file

Specifies the name of the workstation customization file. For more information about this field, refer to the AS/400 documentation.

4.5.4 [define_key_definitions]

This record defines the key definitions used by the emulation program; it defines the local key or keys you have to press to send a particular keystroke to the AS/400. The [define_key_definitions] record must always contain a tag field (that is unique) and at least one definition (of a function or code) in it.

Parameter name           Type           Length   Default
[define_key_definitions]
tag                      character      32
function                 constant
                         ...
function                 constant
code                     character
                         ...
code                     character  

tag

Specifies the identifier for this particular [define_key_definitions] record. This field must always be set, and must be unique. Any printable characters are allowed.

The function parameter allows functions to be defined. A list of valid functions can be found in 5250 Keys.

The code parameter allows the character keys to be defined. Valid code values are:

The keystroke parameter is a string that describes a single keystroke or a combination of keystrokes. The characters that can be used here are listed in Valid Keystrokes.

If your key definitions contain characters like # or $, and you run the emulation program with a different LANG setting from the one that the style file was created with, then these character keys may not work correctly. Ensure that the style file you use was created with the same LANG setting that you use to run the program.

The ascii_val option is used when a character cannot be typed directly from the keyboard. The parameter ascii_val is a hex number in the range 0x00- 0xff.

The following list shows some example key definitions.

4.5.5 [define_recplay_macro]

The [define_recplay_macro record] record specifies the keystrokes that will be sent when that macro is played. A style file can contain any number of [define_recplay_macro] records. The tag field must always be set and must be a unique identifier for the macro (you must not use a tag that has already been used). Macros are not linked to any particular session; you can replay macros from any session (as long as you have permission to replay macros, which is specified by the System Administrator).

Parameter name            Type         Length   Default
[define_recplay_macro]
tag                       character    32
keystroke                 constant
macro_body(
function
..
..
function
)

tag

Specifies the identifier for this particular [define_recplay_macro] record. This field must always be set and must be unique. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

The function parameter allows functions to be defined. Valid function values are:

The keystroke parameter is a string that describes a keystroke or set of keystrokes. The list of keystrokes that can be used here can be found in Valid Keystrokes.

If your key definitions contain characters like # or $, and you run the emulation program with a different LANG setting from the one that the style file was created with, then these character keys may not work correctly. Ensure that the style file you use was created with the same LANG setting that you use to run the program.

The ascii_val option is used when a character cannot be typed directly from the keyboard. The parameter ascii_val is a hex number in the range 0x00- 0xff.

4.5.6 [define_color_mapping]

This record defines how each color or attribute used by the AS/400 will be displayed on your terminal. It can be referred to by the [define_style_header] record, in which case the color mappings will apply globally to all sessions, or it can be referred to by specific [define_session_details] records, in which case the color mappings will just apply to those sessions. Each [define_color_mapping] record must contain a tag field that is unique, and a full set of color definitions.

Parameter name          Type         Length    Value
[define_color_mapping]
tag                     character    32        tag
host_color              constant               local_color
...
...
host_color              constant               local_color
host_attribute          constant               local_attribute
...
...
host_attribute          constant               local_attribute

tag

Specifies the identifier for this particular [define_color_mapping] record. This field must always be set and must be unique. The allowed characters are:

  • Lowercase letters

  • Uppercase letters

  • Numerals 0-9

  • The space character

The valid values for host_color are:

The valid values for local_color are:

The valid values for host_attribute are:

The valid values for local_attribute are:

Previous Page Contents Page Top of Page Next page