BARR/SPOOL manual

5. Print Spool Description

This chapter describes the installation parameters you specify to set up the print spool.

5.1 Print Spool Description Screen

From the Installation Description menu, select Print Spool Description to display this screen:

Specify the following options:

Spool printers:

Specify the number of printers serviced by the print spool. From 0-8 printers may be specified. These printers display at the top of the Print Spool screen during operation.

The default number of Spool printers is 0, meaning the spool feature is not used. You must define at least 1 Spool printer in order to use the print spool.

Spool printers act as filters. They route files from the spool directory to PC printers based on preset selection criteria. On the Assign Devices menu, Spool printers are named SPOOL1 through SPOOL8. Assignment of Spool printers to destination devices is discussed in a later step.

Performance Tuning: If you are not using the print spool function, leave the number of Spool printers at 0. This frees memory buffers which can be used by other program features.

SPOOL directory:

A DOS directory is used as the print queue for spooling. This directory is automatically created the first time you run the software. The spool directory name displays as SPOOL in the list of Destination choices under Assign Devices, regardless of what name you assign the directory.

Retain directory:

This is an optional directory used to automatically store files after they print from the spool. In some applications it is useful to save, or retain, a file after printing so that you can print another copy at a later time.

The Retain directory must be on the same disk drive as the SPOOL directory. If the directory does not already exist, it is automatically created the first time you run the software. If a Retain directory is not specified but a file is set for a Disposition of Retain, the file will be saved to the root directory on the print spool drive, usually C:\ .

In the software, the Disposition attribute is used to select which files to save. The default is for all files to be retained, meaning the file Disposition is set to Retain or is blank. The Disposition field can be changed either on the Print Spool screen during program operation or on the File Attribute Table in the Installation Description. On the Print Spool screen, you can change the Disposition for individual files interactively. The File Attribute Table allows you to preset the Disposition for individual files, groups of files, or all files.

When a file is retained, the file date and time are changed to the current PC date and time. (This allows use of the feature that automatically deletes old retain files after a specified period.)

A separate Restore screen is provided for managing the files stored in the Retain directory. The Restore screen is described in Chapter 14.

Form|FCB name is used to control spool.

This option lets you choose whether the Form name or FCB name is used to control the printing of spool files. The control name displays on the Print Spool screen to the right of the file name, after the file State and Disposition. This location is also referred to as the control column. The heading for the control column on the Print Spool screen will match your selection.

Form – Default. On the Print Spool screen, the control column heading is set to Form and the form name for each file displays in this column. When the form name on the Spool printer matches the form name of a file and other print spool criteria match, the job prints.

FCB – On the Print Spool screen, the control column heading is set to FCB and the FCB name for each file displays in this column. When the FCB name on the Spool printer matches the FCB name of a file and other print spool criteria match, the job prints.

The following screen shows what the Print Spool screen looks like if you choose Form to control spool printing:

If you choose FCB to control spool printing, FCB displays instead of Form.

Display FCB|Form name on spool control screen?

This option allows you to display both the Form name and FCB name on the Print Spool screen. The PC operator may find it useful to see both names. However, only the name specified by the previous option, FCB/Form name is used to control spool, controls printing.

The display name appears on the Print Spool screen in the first column, immediately before the file name. This location is also referred to as the display column. The heading for the display column will match your selection.

No – Default. Only the name specified with the option FCB|Form name is used to control spool displays on the Print Spool screen.

Yes – Both the Form name and FCB name display on the Print Spool screen. If you select Form name is used to control spool, then FCB is used for the display column. If you select FCB name is used to control spool, then Form is used for the display column.

For example, if you select Form name is used to control spool and set Display FCB name on spool control screen? to Yes, the Print Spool screen looks like this:

The FCB name appears in the display column. When the job begins to print, the Spool printer name displays in place of the file State.

If you select FCB name is used to control spool and set Display Form name on spool control screen? to Yes, the columns on the Print Spool screen will be reversed.

Printing can start before end of file is received?

Specify whether the entire file must be received before it can start printing, or if a file can begin printing while it is in the process of being received.

Yes – Default. Printing starts without waiting for the end of the file to be received. This feature is especially useful for very large files which take a long time to receive, because the files will print much sooner.

No – Printing starts after the end of file is received. This method is recommended if the speed of the communications line is not fast enough to drive your printer at full speed. BARR/SPOOL can drive the printer at rated speed and prevents the printer from pausing to wait for more data from the communications line.

Sort spool files by

Four sort criteria may be specified for setting the order in which files display during print spooling. Files print in the same order that they are displayed. Up to four sort variables may be specified. Print spool files are sorted by the first variable, then subsorted by the remaining three variables.

Tips for entering sort criteria

The default Prty >, Date <, and Time causes files to be sorted by the highest priority, oldest date, and oldest time. In the sort criteria, > indicates ascending order and < indicates descending order.

Variable Name

Means
Sort by

Sort Order

Prty>

Priority

highest to lowest

Prty<

Priority

lowest to highest

Class

File class

lowest to highest

File

File name

alphanumerically

Size>

File size

largest to smallest

Size<

File size

smallest to largest

Form

Form name

alphanumerically

Date<

Date

oldest to newest

Time<

Time

oldest to newest

Date>

Date

newest to oldest

Time>

Time

newest to oldest

(blank)

Variable not used

__

Sort retain files by

Four sort criteria may be specified for setting the order in which retained files display on the Restore screen. The default is to sort by Date > and Time >, the newest date and time. Sort criteria choices are the same as for the Sort spool files by option.

Use File Attribute Table?

A table of file attributes may be used to automatically assign criteria to files or to override existing criteria.

No – Default. The File Attribute Table is not used.

Yes – Use the File Attribute Table to override spooling attributes as files are placed in the print spool directory. The table displays after the Printer Initialization screen.

Allow operator to modify file attributes?

Choose whether the PC operator may alter the attributes of print spool files from the Print Spool screen.

Yes – Default. The operator is allowed to modify file attributes on the Print Spool screen to control which jobs print. Attributes which can be modified using the File command include Form, State, Class, Priority, and Copies.

No – Operators are not allowed to alter the file attributes that control which jobs print. The File command does not display on the Print Spool screen. This option ensures that the same criteria are always used to control print jobs.

Check SPOOL directory for new files every ___ seconds.

Specify how often the software should check for new files in the print spool directory and update the list of files on the Print Spool screen. This parameter applies only to files copied into the print spool directory from DOS or the LAN. Files received from a host computer display immediately. The default check interval is 300 seconds. Use of a very small interval, such as 5 seconds, is not recommended because it will reduce program performance.

Include printer form header only once during reprint?

This option is useful during Reprint of spool files and controls whether form information is sent to the printer only once.

Yes – Default. During Reprint of a file, the form header information is included only in the first portion of output sent to the printer. For example, if the operator selects Print Test Page then starts the job, the form information is sent only with the test page. It is not sent again when the file begins to print. Sending the form information twice causes problems for some printers.

No – During Reprint of a file, the form header is included in each portion of the output sent to the printer.

Log operations to LOG device?

Specify whether messages are written to the console log file to help you track print spool activity. To use this feature, you must set up the log device by specifying LOG(FILE) in Assign Devices.

No – Default. Messages about print spool activity do not display.

Yes –  Messages are written to the console log file when print spool files are printed, reprinted, deleted, or restored. Print messages display in this format:

START SPOOL1: STOCKUPD.RPT to LPT1
END SPOOL1: STOCKUPD.RPT to LPT1

If a file is printed using the Reprint option, messages display in this format:

START SPOOL1: PAYROLL.RPT to LPT1
REPRINT SPOOL1: PAYROLL.RPT to LPT1
END SPOOL1: PAYROLL.RPT to LPT1

When files are deleted or restored, messages display in this format:

DELETED: DAILY.RPT
RESTORED: LABELS.JOB

When a file is manually deleted and a retain directory is specified, a message indicates that the file has been retained:

RETAINED: DAILY.RPT

Delete old Retain directory files?

If you are using the Retain directory feature, choose whether old retain files are automatically deleted. This feature may be used to free disk space when many files are being retained.

No – Retain files must be deleted manually. When retaining a large number of files, it is advisable to periodically delete the files from disk so the hard drive does not become full.

Yes – Retain files are deleted automatically after the specified retain period has expired.

Retain files for ___ days.

Specify the number of days for which files are retained before being automatically deleted. The default retain period is 7 days. When files are moved to the Retain directory, the date and time are changed to the current PC date and time to enable tracking of the retain period. The software deletes the expired retain files each time the program is started and at midnight when the PC system date changes.

This option is valid only if Delete old Retain directory files? is set to Yes.

5.2 Printer Initialization

After the print spool parameters are specified on the Print Spool Description screen, press ENTER to display the Printer Initialization criteria. The three fields State, Form, and Class control how the Spool printers select files to route at program startup. The values for these fields must match the attributes for a file in order for the file to print.

These fields may be changed during print spool operation. However, each time the program is run the criteria will be reset to the initial values specified under Printer Initialization.

The value for Spool printers must be set to at least 1 for this screen to display.

Assign the following startup values:

Printer

The name of the Spool printer displays in this column. The number of printers which display depends on the number of Spool printers specified on the Print Spool Description screen.

State

This parameter indicates the initial state of the printer at program startup. A different state may be specified for each printer.

Ready – Default. Files begin printing immediately, if the attributes of the files match the criteria of the Spool printer.

Reprint – Files are placed in the Reprint state if the attributes of the files match the criteria of the Spool printer. Operator action is required to position the file at the location where reprinting will start.

Disabled – The Spool printer is disabled. Files will not print until the operator changes the printer state on the Print Spool screen.

Form

If you want to route files based on a specific form name, enter a form name. The form name may contain up to 8 characters. DOS wildcards * and ? may be used in the form name to select groups of forms. If this field is left blank, the form name will not be used in the print selection criteria.

Class

Enter one-character class names. Either a number or a letter may be used for the file class. Files copied into the Spool directory from DOS are automatically assigned a class of Z.

Up to five classes can be entered for each printer. If this field is left blank, class will not be used in the print selection criteria.

5.3 File Attribute Table

The File Attribute Table is used for automatic assignment of file attributes and is especially useful for unattended print spool operation. As files are received to the SPOOL directory, their spooling attributes can automatically be assigned or overridden by the definitions in the File Attribute Table. In most cases, no changes are made to the attributes within the files. The override values simply display on the Print Spool screen and are used when the files print. (Values from the File Attribute Table are written to the file only if you change the file State from the Print Spool screen.)

The File Attribute Table is enabled by setting Use File Attribute Table? to Yes on the Print Spool Description screen. It displays after the Printer Initialization screen.

How the Table Works

Each line in the table is a separate entry, and each entry has two parts: file match criteria and file override values. Filename and Form are the match criteria. State, Class, Prty, Copies, and Disposition are the override values.

Files received to the print spool are checked against the match criteria of each entry in the table. The override values in the table are used only if the Filename or Form of the file matches an entry in the table. Override values for the file display on the Print Spool screen.

If both Filename and Form are specified in a single table entry, then both the Filename and Form from the file must match the table in order for the override values to be used. If a table entry contains only the Filename (the Form is blank), only the Filename must match. If only the Form is specified in the table (the Filename is blank), then only the Form must match.

If more than one table entry matches the file, the program applies each matching entry in a cumulative manner, beginning with the first entry of the table. For example, if there are two matching table entries, the attribute changes from the first matching entry are applied, then the attribute changes from the second matching entry are applied. If the first and second matching entries both change the same attribute, the second matching entry replaces the value from the first matching entry.

The DEFAULT line at the bottom of the table is used to provide default attributes for any files whose Filename or Form do not appear in the table. The DEFAULT line is useful for providing values for most files, and individual table entries can be used to specify exceptions for a few files.

When specifying the attribute override values, only attributes with specified values are used. Blank attributes in the table indicate that the value from the file, if any, is used.

Table Entries

Up to 20 table entries may be made. If more table entries are needed, a version of the software which supports 100 entries is available. The fields for each table entry — file match criteria and file override values — are described below.

Match Criteria – The first two fields in the table are file match criteria. You may specify one field or both fields.

Filename

The file name in the table must be an exact match of the full name of the file, including the file extension. This means that a table Filename without an extension (i.e., DATA) can only match a file that has no extension, and a table Filename with an extension (i.e., DATA.001) can only match a file that has an extension. DOS wildcards may also be used in the table Filename. For example, names like DATA*.* or TAX??JUN may be specified.

Form

The form name in the table must be an exact match of the form name for the file. DOS wildcards also may be used in the form name, for example STD* or CHECKS??.

Override Values – The next five fields are file override values. Override values are assigned if a matching entry is found in the table. The values you  specify will display on the Print Spool screen. Specify only those values you want to override.

State

Specify the initial State assigned to the file when it is placed in the print spool. Choices include Ready and Hold. Other states may be set from the Print Spool screen.

Ready – Default. Files begin printing immediately if their attributes match the criteria of the Spool printer. Blank also indicates Ready.

Hold – Files cannot print until the operator sets the file State to Ready. This choice is useful for files which may require the operator to load special forms paper in the printer.

Class

Specify the file Class. The Class may be used as part of the criteria which determines on which Spool printer the file prints. Either a number or a letter may be used for the file Class. Files copied into the print spool directory from DOS are automatically assigned a class of Z.

Prty

Specify the file Priority number. The Priority may be used as criteria for the Spool printer to determine on which printer the file prints. The highest Priority is 9; the lowest Priority is 1.

Copies

Specify the number of Copies to print. If Copies is not specified in the file and the number in the File Attribute Table is left blank, the default value is 1 copy.

Disposition

The Disposition attribute allows you to selectively Retain or Delete individual files. When specified on the DEFAULT entry line, the Disposition applies to all files not listed in the table.

Retain – Default. Files are written to the Retain directory after they print. Retain is indicated by Retain or blank in the File Attribute Table, or blank in front of the form name on the Print Spool screen.

Delete – If you define a Retain directory on the Print Spool Description screen, all files will be retained by default. Individual files may be assigned a Disposition of Delete in the File Attribute Table or on the Print Spool screen. If a Retain directory is not specified, files are deleted by default.

Sample Attribute Table

A sample table entry is shown below.

According to this table:

When you finish making table entries, press ENTER to return to the Installation Description menu.