Previous Page Contents Page Next Page

5.4 RJE Style File Records

The style file can contain the following records:

define_workstation_options

Specifies how the workstation interacts with the host (see define_workstation_options Record).

define_minor_options

Specifies how the workstation interacts with the Solaris computer to process input and output data (see define_minor_options Record).

define_forms_control

Defines a Forms Control Buffer, which specifies a page layout used by an RJE printer device (see define_forms_control Record).

define_ws_device

Defines an RJE output device (printer or punch) (see define_ws_device Record).

The following sections describe these records.

5.4.1 define_workstation_options Record

The define_workstation_options record controls the workstation's interaction with the host job entry subsystem.

This record must always be included in the style file. Provide the record name enclosed in square brackets followed by each parameter name and its assigned value, if any. Each parameter name and value pair must be on a separate line.

[define_workstation_options]
description=
logon_text=
send_logon=NO
inbound_compression=NO

Summary of define_workstation_options Parameters, provides a summary of the define_workstation_options record parameters.

Summary of define_workstation_options Parameters

Parameter NameTypeLength Default
description character 31 (null string)
logon_text character 256 (null string)
send_logon constant NO
inbound_compression constant NO

The following are descriptions of the define_workstation_options record parameters:

description

An optional text string describing the workstation. This string is for information only; it is stored in the style file and displayed in the RJE style file customization program, but SNAP-IX does not make any use of it.

logon_text

The logon string required by the host job entry subsystem.

This string must be specified if the send_logon parameter is set to YES; check with your host job entry subsystem personnel to determine the correct string to use. If send_logon is set to NO, this parameter must not be specified.

send_logon

Specifies whether the RJE workstation sends its logon string to the host to initiate RJE startup or waits for the host to initiate the startup. Allowed values:

YES

The workstation sends a logon message to the host as soon as the SSCP session is established. The logon_text parameter must be specified.

NO

The workstation waits for a BIND message from the host, and does not send the logon string. The logon_text parameter must not be specified.

Check with your host job entry subsystem personnel to determine the correct option to use.

inbound_compression

Specifies whether job files submitted to this workstation are to be compressed for transfer to the host. Compression can improve the overall processing time for a job if you are sending large files containing sequences of repeated characters; that is, more than four of the same character (including the space or null characters) in succession.

Check with your host job entry subsystem personnel to find out whether compression is supported. If the host configuration specifies that compression is supported, you can choose whether to use it; do not specify compression if the host configuration does not support it. Note that SNAP-IX always accepts compressed files sent from the host.

5.4.2 define_minor_options Record

The define_minor_options record controls how the workstation interacts with the SNAP-IX computer to process input and output data. Provide the record name enclosed in square brackets followed by each parameter name and its assigned value, if any. Each pair of parameter name and value must be on a separate line. Summary of define_minor_options Parameters, provides a summary of the define_minor_options parameters.

Summary of define_minor_options Parameters

Parameter NameTypeLength Default
description character 31 (null string)
job_logs constant NO
list_sent_jobs constant NO
temp_directory character 256

/var/opt/sna/rje/WKST/.pgmout

punch_padding constant PAD_NONE
ff_passthrough constant NO
printer_nl decimal 132
console_log_size decimal 10000
ebcdic_newline constant NO
logon_retry constant NO
mail_on_events constant YES
keep_failed_files constant NO
run_in_foreground constant NO
punch_nl_IRS constant YES
ignore_rec_length constant NO
display_sscp_messages constant NO

The following are descriptions of the define_minor_options record parameters:

description

An optional text string describing the minor options. This string is for information only; it is stored in the style file, but SNAP-IX does not make any use of it.

job_logs

Specifies whether the workstation should log messages about the progress of jobs it is processing. Note that these messages are not written to the standard SNAP-IX audit or error log file, but to a separate file for each workstation. This file is named job.log, and is stored in the main workstation directory /var/opt/sna/rje/WKST. For more details of the format of this file, see RJE Job Log File.

Allowed values:

YES

Log messages about job progress.

NO

Do not log messages.

If you specify YES, SNAP-IX writes to this file each time a job is spooled, canceled, or sent to the host, and each time output is received from the host. You should check this file at intervals and either delete the file or delete older entries from it, to ensure that the file does not grow too large and take up too much disk space. If you want to delete individual entries from the file rather than deleting the whole file, you must do it when the SNA software is not running.

list_sent_jobs

Specifies whether the workstation should retain information about jobs after it has sent them to the host, so that you can use the snajoblst command to list them. Allowed values:

YES

Retain information about sent jobs.

NO

Do not retain information about sent jobs.

If you set this option to YES, note that SNAP-IX retains information about the sent jobs until you purge them using the snajobpur command. You should use this command regularly to ensure that the volume of information stored does not grow too large (which affects disk space and the performance of the RJE programs). See RJE Commands, for more information about RJE commands.

Note also that SNAP-IX does not purge any existing stored information when you change this option from YES to NO; you should use the snajobpur command to do this explicitly.

temp_directory

Specifies the directory where the workstation stores temporary files that it uses during job processing. This parameter must include the full path of a directory on the computer where the workstation runs; the primary user and group of the workstation must have read and write access to this directory.

punch_padding

Specifies whether to pad punch records out to the full record length during output, and (if so) the pad characters to be used.

PAD_NONE

Specifies that no records are to be padded.

PAD_TEXT

Specifies that text records are to be padded with spaces (either ASCII or EBCDIC, depending on the setting of translate_data in the define_ws_device record).

PAD_TRANSP

Specifies that transparent data records are to be padded with NULL characters.

PAD_TRANSP_SPACE

Specifies that transparent data records are to be padded with spaces (either ASCII or EBCDIC, depending on the setting of translate_data in the define_ws_device record).

To specify that both text records and transparent data records are to be padded, use the two constants separated by a + character (PAD_TEXT + PAD_TRANSP or PAD_TEXT + PAD_TRANSP_SPACE).

ff_passthrough

Specifies whether the workstation should pass through Form Feed (FF) characters received from the host in printer output, or convert them to line-feed characters. This option is ignored for punch output. Allowed values:

YES

Pass through FF characters without conversion.

NO

Convert FF characters to the appropriate number of line-feed characters to reach the end of the page (as defined by the Forms Control Buffer used by the printer device).

Select the option that generates the output format expected by the printer devices or output programs you are using.

printer_nl

Specifies the maximum line length in characters for printer output; the workstation will insert a new-line character each time the output line reaches this length. The valid range is 132- 255. This option is ignored for punch output.

console_log_size

Specifies the maximum size in bytes of each of the two files used to hold console log data for this workstation, in the range 10,000-1,000,000,000. The first file can grow to the size specified here; information is then written to the second file. When the second file reaches the same size, the first file is cleared, and the information is redirected to the first file. Using two files means that console logging can be active for an extended period of time, with a maximum disk space usage of twice the value specified here.

Leave the following parameters set to their default settings, as specified in Summary of define_minor_options Parameters, unless your SNAP-IX supplier explicitly tells you to change them. They are used only in special cases; for most SNAP-IX installations, the default values are correct and should not be changed.

ebcdic_newline

If the workstation's output devices expect data in EBCDIC format and so require data to be passed through without EBCDIC-ASCII translation, set this option to YES to indicate that any new-line characters inserted by the workstation should be EBCDIC and not ASCII new-line characters. Otherwise, set it to NO to insert ASCII new-line characters.

logon_retry

If the workstation loses contact with the host program (for example because the communications link to the host fails, or because the host system has been restarted), it normally stops and must be manually restarted when the host program is available. To force the workstation to retry sending the logon string periodically until it succeeds, set logon_retry to YES; to disable retrying the logon, set it to NO. This parameter applies only if the workstation is defined to send its logon string at startup (the send_logon parameter in the define_workstation_options record); it is ignored otherwise.

If this option is set to YES, note that messages are logged to the audit log file each time the workstation attempts to contact the host; if the display_sscp_messages parameter is set to YES, messages are also written to the RJE console log file. If the workstation has to retry frequently (for example, because of an unreliable communications link), this may result in a large amount of data being written to these files; you should ensure that the maximum file sizes specified for these files allow for this, to avoid losing data when the files wrap.

mail_on_events

Specifies whether the workstation should send mail messages to the primary user of the workstation about the progress of jobs it is processing. Allowed values:

YES

Send mail messages about job progress.

NO

Do not send messages.

keep_failed_files

If a communications link failure occurs while the host is sending output to the workstation, the host will retry sending the output when the communications link is restored. SNAP-IX assumes that the host will resend complete data, and so the workstation normally deletes the temporary file containing incomplete output when it detects the failure.

In general, the host's configuration should specify a large checkpoint size, to ensure that it will always resend the complete output data and not try to restart part way through. For example, to ensure this in a typical JES2 workstation configuration, set CKPTLINE and CKPTPAGE to 10000 and CKPTMODE to PAGE.

If the host's checkpoint size is set so that it restarts part way through the output data, set keep_failed_files to YES so that SNAP-IX does not delete incomplete files. In this case, although the output data file contains only the last section of the data (from the point at which the host restarted), the user can recover the earlier data from the temporary files stored for the workstation.

run_in_foreground

The RJE workstation normally runs in the background as a daemon process. To force it to run in the foreground, set run_in_foreground to YES.

punch_nl_IRS

When sending punch output, the host specifies the line length to be used for the output from each job; SNAP-IX normally inserts a new-line character each time an output line reaches this length. To override the specified line length so that a new-line character is inserted only when an Inter-Record Separator (IRS) character is received in the host data, set punch_nl_IRS to YES .

ignore_rec_length

When sending job data to the host, SNAP-IX normally inserts an IRS character each time the line length reaches the specified record length. To override the specified record length so that an IRS is inserted only when the job data contains a new-line character, set ignore_rec_length to YES.

display_sscp_messages

When the RJE workstation attempts to establish a session with the host for one of its LUs, the host can send data on the SSCP session for that LU. This data may simply be a start-of-day message when the session is established successfully, or may contain diagnostics information indicating why the session could not be established. If the workstation receives SSCP data, SNAP-IX writes the first 80 bytes of this data to the log file; however, because only 80 bytes can be included in the log message, some of the data may be lost.

To specify that SSCP data should be written to the RJE console as well as to the log file, set display_sscp_messages to YES. In this case, the complete data sent by the host is written to the console log file and can be viewed using the console program. To specify that SSCP data should not be written to the console, set this option to NO.

This option is intended for use when you are having problems establishing sessions to the host; displaying the complete SSCP data on the console enables you to check for error messages indicating why the session could not be established. In normal use, you should set this option to NO to avoid filling up the console log file with large amounts of data (particularly if the host sends a full-screen banner message at start of day).

5.4.3 define_forms_control Record

The define_forms_control record defines a Forms Control Buffer that determines the page layout used by an RJE printer device. Each Forms Control Buffer can be used by one or more printer devices. Provide the record name, enclosed in square brackets, followed by each parameter name and its assigned value, if any. Each pair of parameter name and value must be on a separate line. Summary of define_forms_control Parameters, provides a summary of the define_forms_control record parameters.

Summary of define_forms_control Parameters

Parameter NameTypeLength Default
description character 31 (null string)
form_name character 8
form_length decimal 66
first_line decimal 1
last_line decimal 66
channel_2 decimal 0
channel_3 decimal 0
channel_4 decimal 0
channel_5 decimal 0
channel_6 decimal 0
channel_7 decimal 0
channel_8 decimal 0
channel_9 decimal 0
channel_10 decimal 0
channel_11 decimal 0
channel_12 decimal 0

The following are descriptions of the define_forms_control record parameters:

description

An optional text string describing the Forms Control Buffer. This string is for information only; it is stored in the style file and displayed in the RJE style file customization program, but SNAP-IX does not make any use of it.

form_name

A name identifying this Forms Control Buffer. This name should not match any other form_name in the style file; if you include two Forms Control Buffers with the same name, only the second definition is used.

form_length

The page length used to format the output data, specified by the number of lines the printer can print on each page. Specify a value in the range 1-255.

first_line

The line number (within the specified page length) on which the first line of data should be printed. This determines the top margin on the printed page; for example, 1 specifies no top margin (print on the first printable line of the page), and 5 specifies a top margin 4 lines deep.

Specify a value from 1 to the number of lines specified by the form_length parameter.

last_line

The line number (within the specified page length) on which the last line of data should be printed. This determines the bottom margin on the printed page; for example, on a 66-line page, 66 specifies no bottom margin (print down to the last printable line of the page), and 62 specifies a top margin 4 lines deep.

Specify a value between the values of the first_line and form_length parameters.

channel_2 through channel_12

Vertical channel positions 2 through 12 specify 'vertical tabs'-specific positions on the page at which data can be printed. When the data from the host contains the control code 'go to vertical channel n,' the line number specified here for that vertical channel determines the position on the page at which subsequent data will be printed.

For each of the channels 2 to 12, specify a line number, between the values of the first_line and form_length parameters. Alternatively, if you specify 0 (zero) for a particular vertical channel position, the output device simply interprets the 'go to vertical channel n' instruction as a line feed.

5.4.4 define_ws_device Record

The define_ws_device record defines a printer or punch device used for processing RJE output. Up to nine printer and nine punch devices can be defined for each workstation. Each device, identified by its device type (printer or punch) and device number (1-9), must match a device defined at the host for this workstation.

Some host systems make a distinction between punch devices and exchange devices, and require the use of exchange devices for transferring data records of more than 80 bytes. SNAP-IX does not make this distinction, because it does not impose a restriction on the record length for punches. If the host requires output to be sent to an exchange device, you can include this in the RJE style file using a punch device; any output for exchange device n is routed to the punch device n. For example, if the host specifies that an output device is exchange device number 3, you need to define a punch with device number 3 for the workstation, and output for this exchange device is sent to punch number 3. In this case, the host configuration must not also include a punch device number 3; problems can occur if the host attempts to route outputs from two different jobs to a punch and an exchange device that both have the same number.

Provide the record name enclosed in square brackets, followed by each parameter name and its assigned value, if any. Each parameter name and value pair must be on a separate line. Summary of define_ws_device Parameters, provides a summary of the define_ws_device record parameters.

Summary of define_ws_device Parameters

Parameter Name TypeLength Default
description character 31 (null string)
device_number decimal
device_type constant PUN
form_name character 8 (null string)
translate_data constant YES
translate_transp_data constant YES
concatenate constant YES
output_type constant DIR
pdir_passthrough constant NO
add_punch_nl constant YES
output_path character 256

/var/opt/sna/rje/WKST /output

output_file character (see notes)

The following are descriptions of the define_ws_device record parameters:

description

An optional text string describing the device. This string is for information only; it is stored in the style file and displayed in the RJE style file customization program, but SNAP-IX does not make any use of it.

device_number

The number that the host uses to identify this device, in the range 1-9. This must not match the device number of any other device of the same type (printer or punch, as specified by the device_type parameter) defined for the workstation.

The host configuration identifies each printer or punch only by its number; the range of numbers for each device type is always consecutive and starts at 1. For example, if two printers and three punches are defined at the host, they will be assigned printer numbers 1 and 2 and punch numbers 1, 2, and 3. You must number each device in each device type consecutively starting at 1 to ensure that the SNAP-IX configuration matches the host configuration; if there are gaps in the sequence of device numbers, the RJE programs will fail with an error message indicating that the style file is invalid.

device_type

Specifies the type of output device; use this parameter to define the appropriate devices of each type to match the host configuration. Allowed values:

PRT

Printer device

PUN

Punch device (this value is also used for exchange devices)

form_name

For a printer device, this parameter specifies the name of the Forms Control Buffer that defines the output format; it must match the name specified in a define_forms_control record in the same workstation style file. For a punch device, this parameter is ignored.

translate_data

Specifies whether data received from the host is translated from EBCDIC to ASCII before being routed to the appropriate file or program. Allowed values:

YES

Received data is translated from EBCDIC to ASCII.

NO

Received data is not translated.

translate_transp_data

Specifies whether transparent data received from the host is translated from EBCDIC to ASCII before being routed to the appropriate file or program. The host output may contain control codes indicating that a section of data is to be treated as transparent data; this means that the printer should pass it through as received without checking it for control codes. Allowed values:

YES

Received transparent data is translated from EBCDIC to ASCII.

NO

Received transparent data is not translated.

If the translate_data parameter is set to NO, the translate_transp_data parameter must also be set to NO.

concatenate

Specifies whether data routed to a file is concatenated to the end of any existing data in the file. This option applies only if the output_type parameter is set to FILE; it is ignored otherwise. Allowed values:

YES

Data routed to a file is concatenated to the end of the file.

NO

Data routed to a file replaces the current contents of the file.

output_type

Specifies how output received from the host for this printer is handled. Allowed values:

DIR

Output from each job is sent to a separate file in a particular directory; the directory must be specified using the output_path parameter. The file is given the name RJE_abcdef, where abcdef is an alphabetic string unique to each job; the strings are assigned in sequence so that alphabetical order corresponds to the order in which the outputs were received from the host. The output_file parameter must not be specified.

FILE

Output from all jobs is sent to a single file, which must be specified using the output_file and output_path parameters.

PROGRAM

Output from all jobs is used as the standard input to a program, which must be specified using the output_file and output_path parameters. If output from more than one job is directed to the same program at the same time, multiple instances of the program are started.

pdir_passthrough

Specifies whether the information in any PDIRs (Peripheral Data Information Records) accompanying host output is routed with the host output. Allowed values:

YES

PDIR information is routed with the host output.

The usage of this parameter depends on the value of the output_type parameter, as follows:

  • If output_type is DIR or FILE, the information in any accompanying PDIRs is sent to a second file with the same name as the output file but with the extension .i. For file output, this file is appended or overwritten in the same way as the output file.

  • If output_type is PROGRAM , the information in the first PDIR sent to the device is passed to the program as parameters. See RJE Components and Operation, for information about how the program should use PDIR information.

NO

PDIR information is discarded.

add_punch_nl

Specifies whether to insert a new-line character after each record of the host output. This option applies only to punch devices; do not specify it for printer devices. Allowed values:

YES

Insert a new-line character after each record, regardless of whether the host data stream includes new-line characters.

NO

Do not insert new-line characters. Select this option if the host includes the required new-line characters in the data stream.

output_path

Specifies the directory to which output is routed. This must be the full path of a directory on the computer where the workstation runs.

The usage of this parameter depends on the value of the output_type parameter, as follows:

  • If output_type is DIR, the parameter specifies the directory in which output files are created. The primary user and group of the workstation must have read/write access to this directory.

  • If output_type isFILE, the parameter specifies the directory path of the file to which host output sent to this device is written. The primary user and group of the workstation must have read/write access to this directory.

  • If output_type is PROGRAM , the parameter specifies the directory path of the program to which host output sent to this printer is routed.

output_file

Specifies the file to which output is routed; the maximum length of this parameter is determined by the maximum filename length on the Solaris system. This file must exist in the directory specified by output_path on the computer where the workstation runs.

The usage of this parameter depends on the value of the output_type parameter, as follows:

  • If output_type is DIR, this parameter must not be specified.

  • If output_type is FILE, the parameter specifies the file to which host output sent to this device is written. The primary user and group of the workstation must have read/write access to this file. The concatenate parameter specifies whether output from subsequent jobs overwrites the file or is appended to it.

  • If output_type is PROGRAM , the parameter specifies the program to which host output sent to this printer is routed. The primary user and group of the workstation must have execute access for this program. The host output will be used as standard input to the program.

Previous Page Contents Page Top of Page Next page