TPS Commands

There are two levels of Terminal Printer Spooler (TPS) commands:

USER-level commands
CONTROL-level commands

If the NGEN28TP/USERS file of usernames is absent, then any user signed on to TPS is regarded as a CONTROL-level user, and the full range of TPS commands can be used.

If the NGEN28TP/USERS file is present, then only users designated as CONTROL-level users may use the full range of commands. Other users may only use the USER-level commands.

All USER-level TPS commands are also available to CONTROL users.

The CONTROL-level and USER-level commands are described below.

ADD

Use this command to add a TPS backup file to a terminal printer station.

Level	USER
Syntax	ADD backup [ON pack] station
Parameters	backup is the file name in the form TP nnnn pack is only required to ADD a file not on current BACKUP pack or DISK station is the station name of terminal printer to which the output is to be directed
Security	Privilege and User control are checked. If the file has a higher privilege level than the specified printer, or if the file username (or alternate username) is different to the TPS user's username, then the file will not be output.
Description	A new entry is created in the Index. If AUTO+ is set, the file will be printed as soon as the printer is available. ADD causes an automatic print, unless GLB.LINEUP is set to Y. You may add a file (using ADD) even if it is not currently in the Index, or if it has already been printed (provided it has not been removed).

AUTO+

Use this command to set the automatic printing option.

Level	USER
Syntax	AUTO+ station
Parameters	station is a valid station name defined in the COMS Configuration file.
Default	AUTO+
Description	Sets automatic printing option. If the printer is busy, Report output is sent to a backup file and is automatically released for printing when the printer is next available. Any unprinted files sent to backup because AUTO- had been set for this terminal printer station will commence printing automatically when AUTO+ is set and the printer is available. AUTO+ is overridden by GLB.BACKUP, GLB.LINEUP, GLB.USER values.

AUTO- Disable Automatic Printing Option

Use this command to disable the automatic printing option.

Level	USER
Syntax	AUTO- station
Parameters	station is a valid station name as defined in the COMS Configuration file
Description	Forces Report output to a backup file. (To print, use the POSITION or AUTO+ commands). TPS sets AUTO- when printer is busy or offline.

BACKUP Assign TPS Backup File Pack

Use this command to assign a pack for TPS backup files.

Level	CONTROL
Syntax	BACKUP [pack]
Parameters	pack is a valid pack name. If pack is unspecified, file names appear without the ON pack designation, and the Backup pack is the primary pack for the TPS usercode.
Description	Specifies the pack for backup file storage. May be changed at any time. Existing files will remain on their original pack, as specified in the NGEN28TP/ LINCINDEX file and FILES display details. Backup pack name is retained by TPS at End-of-Job.

BACKUP+ / BACKUP-

Use these commands to direct output to TPS backup file or a printer.

Level

CONTROL

Description

BACKUP+ forces all Report output to backup files. Output in backup files is not printed until the Report performs a RELEASE; logic command.

BACKUP- enables Report output to be sent direct to printers without creating a backup file, subject to certain conditions and settings.

Reference

See "Printing to TPS Backup Files" for more details.

BYE

Use this command to log off from TPS.

Level	USER
Syntax	BYE
Description	Logs user off TPS. Synonymous with OFF.

CLEAR

Use this command to abort the current task for a printer.

Level	USER
Syntax	CLEAR station
Parameters	station is a valid station name as defined in the COMS Configuration file
Security	Non-CONTROL users can only clear stations assigned to them. CONTROL users may clear any stations.
Description	Instructs TPS to quit the current task (if any) for the specified printer. Current Report output to that printer may be incomplete. For example, you may CLEAR a hung print task, where TPS has met a condition it cannot handle, and printer output cannot be completed. Any file printing from backup on a printer that is cleared will have its status altered to C. (You can view these files by using the FILES command.) The only TPS commands that can be used against such files are the ADD, DELETE, and PURGE commands. CLEAR resets formdepth. When printing recommences, the formdepth is reloaded if GLB.FORMDEPTH is non-zero. When a printer is cleared by a CONTROL user, the printer is reset to AUTO- status.

CONTROL

Use this command to display control option settings.

Level	CONTROL
Syntax	CONTROL[S]
Description	Displays the following current settings. See the relevant commands (in uppercase) for details.
Values	Current statuses (+ or -) shown for REMOVE, PRINTOK, SCROLL, HILIGHT, SETOFF, BACKUP, LOG, and COMS DCI trace. Current values shown for OBSERVER DELAY, OK DELAY, REPORTREADS, TANKSIZE, BACKUP pack, and next backup file name.

COUNT

Use this command to display TPS statistics.

Level	USER
Syntax	COUNT
Description	Displays number of Reports printed, and number of backup files opened since TPS was initiated.

CRASH

Use this command to terminate TPS unconditionally.

Level	CONTROL
Syntax	CRASH
Description	TPS goes to EOJ immediately and unconditionally. Output for Reports currently running (either direct to print, or to Backup) may be incomplete.

DELAY

Use this command to set the timeout and refresh periods.

Level	CONTROL
Syntax	DELAY OBSERVER nnnn DELAY OK nnnn
Parameters	nnnn is the delay value in the range 1000 through 9999, in hundredths of seconds. OBSERVER: Automatic status display period (default is 60 seconds) OK: Timeout delay before printer considered hung, if PRINTOK is reset (default is 90 seconds).
Description	OBSERVER delay sets period for automatic status displays. See the OBSERVER+ command. OK delay sets timeout for before TPS considers the printer as hung. See the PRINTOK+ and PRINTOK- commands.

DELETE

Use this command to logically delete a TPS backup file.

Level	USER
Syntax	DELETE backup [ON pack] [station]
Parameters	backup is the valid file name in the form: TP nnnn pack is only required to DELETE a file not on current BACKUP pack or DISK. station is the output station for file. Required when an ADD command has been used to add the backup file to more than one station (only the index entry for that station is removed, not the file).
Description	The file entry in the index is removed. The file itself is not removed if any other entries refer to that file; for example, because of an ADD to another printer, or with TPGROUPS. Refer also to the PURGE command.

DUMP

Use this command to print TPS diagnostics.

Level

CONTROL

Syntax

DUMP

Description

Dumps TPS diagnostic information to the TPS logging printer backup file. A dump can be invoked at any time. The printer file is released (and reopened if logging is active).

A dump listing should be submitted with any TPS fault report. In addition, a dump should be performed prior to any abnormal termination of TPS.

FILES

Use this command to display TPS backup file details.

Level	USER
Syntax	FILES [station]
Parameters	station if specified, only backup files for output to that station are displayed. If not specified, all backup files available to the user are displayed.
Description	Displays the name, status, and location of each backup file currently in the index for the station specified. If more than 20 entries, display shows 20 at a time for viewing. Transmit NEXT (as displayed on line 1) to receive the next page.

HELLO

Use this command to sign on to TPS.

Level	USER
Syntax	HELLO username checkword
Parameters	username is the valid username, up to 10 characters. checkword is a valid checkword associated with the username, up to 10 characters.
Description	Valid only when a NGEN28TP/USERS file is loaded. See Controlling Access to TPS. Synonymous with LOGON and USER.

HELP

Use this command to display help information for TPS commands.

Level	USER
Syntax	HELP [command]
Parameters	command if specified, displays help text for that command. If not specified, displays a list of all commands available to that user.
Description	Displays help information for TPS Commands. Any unrecognized input to TPS will invoke the display of available TPS commands. Synonymous with TEACH.

HILIGHT+ / HILIGHT-

Use this command to enable or disable highlighting for TPS displays.

Level

CONTROL

Description

HILIGHT+ sets display highlighting, enabling bright and reverse video display of various TPS statuses and messages.

HILIGHT- cancels display highlighting.

LANGUAGE

Use this command to display or change the TPS user language.

Level	USER
Syntax	LANGUAGE [language]
Parameters	language a language name declared in the NGEN28/MLSLIBRARY file.
Description	If language is omitted, the current TPS session language is displayed. If a valid language is specified, the current TPS session language is changed, and System messages will appear in the new language.

LOADCODES

Use this command to load the CODES file.

Level

CONTROL

Syntax

LOADCODES

Description

Loads printer control codes, including any Output Control codes, from the NGEN28SYS/CODES or CUSTOM16/CODES file.

TPS copies the file as its NGEN28TP/CODES work file.

LOADGROUPS

Use this command to load NGEN28TP/GROUPS file.

Level	CONTROL
Syntax	LOADGROUPS
Description	Loads Terminal Printer Groups from NGEN28TP/GROUPS file. TPS copies the file as its NGEN28TP/MYGROUP work file. See Multiple Printer Groups.

LOADUSERS

Use this command to load NGEN28TP/USERS file.

Level	CONTROL
Syntax	LOADUSERS
Description	Loads Username details from NGEN28TP/USERS file. See Controlling Access to TPS.

LOG+ / LOG-

Use these commands to activate or deactivate TPS logging.

Level	CONTROL
Syntax	LOG+ [DCI]
	LOG- [DCI]
Description	LOG+ activates TPS logging, causing TPS to write a printer backup file of various activities such as user input and Report header and trailer records, as they are processed. LOG+ DCI causes TPS to create a disk file containing a diagnostic trace of all inputs from, and some outputs to, COMS. This is only valid when TPS is run from a COMS direct window. The Trace file name is TRACE/TPSINT/ mix/ nnn LOG- DCI turns off input and output tracing. Closes the trace file. LOG- deactivates TPS logging and releases the print file. See DUMP, which also causes the log print file to be released.

Note: These settings are retained at end of job (EOJ).

LOGON

Use this command to sign on to TPS.

Level	USER
Syntax	LOGON username checkword
Parameters	username is the valid username, up to 10 characters. checkword is the valid checkword associated with the username. Up to 10 characters.
Description	Valid only when a NGEN28TP/USERS file is loaded. See Controlling Access to TPS. Synonymous with HELLO and USER.

OBSERVER+ / OBSERVER-

Use this command to enable or cancel Observer status.

Level

USER

Syntax

OBSERVER+ is the regular automatic displays of task statuses at your terminal

Description

Default period for automatic display is 60 seconds. To change display period, use DELAY command. Automatic display also when a task status changes. Limited to 20 Observer stations at one time.

See also the SCROLL+ command.

OFF

Use this command to log off the Spooler.

Level	USER
Syntax	OFF
Description	Logs user off TPS. Synonymous with BYE.

POSITION

There are two forms of the POSITION command. You use the first form to initiate output, and the second form to specify further actions.

The first (or initial) form is described in the following table.

Level	USER
Syntax	POSITION file [ON pack] station nnnn
Parameters	file is the backup file to be partially printed. pack is the optional pack name of backup file (as shown in the FILES display). station is the printer name on which file is to be printed (as declared in the COMS Configuration file). nnnn is the number of logical pages to be printed. Leading zeros are required.
Description	One logical page is printed from the backup file. You are informed when the logical page has been sent to the printer, and asked if you want to continue. Use the second form of the POSITION command to respond. The size of a logical page is determined by the value of GLB.FORMDEPTH from Report. If GLB.LINEUP is set to Y, the POSITION command sets AUTO- for the printer.

The second (or subsequent) form of the POSITION command is described in the following table.

Level	USER
Syntax	POSITION file [ON pack] response
Parameters	file is the backup file partially printed by first form of POSITION command. pack is the optional pack name of backup file (as shown in the FILES display). response is a response, as described in the following table.
Description	This form is only valid after using the first form, which initiates the output.

Responses for the second form of the POSITION command are described in the following table.

Response	Description
RETRY	Reprint the same page.
NEXT	Print the next page.
BACK	Print the previous page.
OK	Continue from page printed and print to end of file.
ABANDON	Abandon the print attempt.

PRINTOK+ / PRINTOK-

Use this command to set the TPS printer time-out status.

Level

CONTROL

Syntax

PRINTOK+

PRINTOK-

Description

PRINTOK+ (default) sets timeout (OK DELAY) for printers to infinity.

PRINTOK- sets timeout for printers to OK Delay. TPS will only wait this time for good-result response from MCS for printers.

If MCS does not respond within the OK DELAY period for any printer, the printer is marked as hung, and no more output is sent to printer until a RETRY command is issued.

Caution
Use of the PRINTOK- command may result in loss of output; if MCS does not respond within the period for any printer, then TPS sends further output.

PRINTERS

Use this command to display the status of printers that are in use.

Level	USER
Syntax	PRINTERS
Description	Displays the current status of each printer currently in use.

PURGE

Use this command to remove TPS backup files and index entries.

Level	USER
Syntax	PURGE [station] [username]
Parameters	station is the specific station or ALL. A specific station restricts scope to backup files and NGEN28TP/LINCINDEX entries for the station. ALL extends scope to all backup files for all printers. username restricts scope to backup files applicable to that username. Only valid for Control-level users when NGEN28TP/USERS file is loaded. If not a Control-level user, only files for that user are considered (do not specify username).
Description	This command removes backup files. It does not delete backup files currently in use. Actual backup files are removed only if there are no other index entries referring to that file; for example, because of an ADD, or where file is associated with a group of printers (TPGROUPS).

QUIT

Use this command to perform an orderly closedown of TPS.

Level	CONTROL
Syntax	QUIT TPS
Description	TPS goes to an orderly End-of-Job (EOJ) when printing of all current tasks is completed.

Caution
This command causes TPS to close down. Do not use QUIT to simply sign your terminal off TPS. To sign your terminal off TPS, use the BYE or OFF command.

REBUILD

Use this command to rebuild the NGEN28TP/LINCINDEX file.

Level

CONTROL

Syntax

REBUILD

Description

Causes TPS to rebuild the NGEN28TP/LINCINDEX file, which contains indexed print requests by printer. This can reduce access time.

After many print tasks, use this command to reduce disk space or balance index key structures.

REMOVE+ / REMOVE-

Use this command to remove or retain TPS backup files after printing.

Level	CONTROL
Syntax	REMOVE+
	REMOVE-
Description	REMOVE+ removes backup files once all print requests for a file have completed, unless Report logic sets GLB.BACKUP to Y (forcing backup file to be retained). REMOVE- (default) retains backup files, unless Report logic sets GLB.BACKUP to R (forcing backup file to be removed).

REPORTREADS

Use this command to set the ratio of Report reads to writes.

Level	CONTROL
Syntax	REPORTREADS nn
Parameters	nn is the ratio of inputs from Reports to outputs from TPS to printers, in the range 01 through 99. This is the approximate average number of Report frames per output block to printer (2050 bytes).
Default	10
Description	Relates to bandwidth differences. You may wish to drive Report input to TPS and TPS output to printers at differing relative rates.
Example	In an Integrity System where Reports lock database resources, you may want TPS to accept Report output as rapidly as possible. Do this by raising the value of REPORTREADS, so that TPS will accept a greater volume of output from Reports relative to the volume of output sent to printers. REPORTREADS may be adjusted back to normal when the Report is completed, or you could set it lower than normal to speed up the handling of output from TPS backup files.

RETRY

Use this command to repeat a previous print attempt.

Level	USER
Syntax	RETRY printer
Parameters	printer is the printer name to which output is directed.
Description	Instructs TPS to retry the hung printer specified, and then sends the same logical block of output again. The command is valid only if output is from a backup file and TPS is currently hung on output to that printer.

SCROLL+ / SCROLL-

Use this command to set or cancel user display scrolling.

Level

CONTROL

Syntax

SCROLL+

SCROLL-

Description

SCROLL+ sets scroll on for all terminals signed on to TPS. All TPS user displays scroll upwards.

SCROLL- (default) cancels user displays scrolling on all terminals signed on to TPS. All TPS user displays start at the Home position.

SETOFF

Use this command to establish an MCS auto sign off string.

Level	CONTROL
Syntax	SETOFF string
Parameters	string is the auto sign-off character or string for your MCS
Default	?CLOSE
Description	Sets the automatic string for the MCS to sign your terminal off TPS.

STATUS

Use this command to display the status of active tasks.

Level	USER
Syntax	STATUS
Description	Displays details for current username (if any), for example: Reports directed to backup files Reports output direct to printer Backup files being printed Backup files positioned (with the POSITION command) to printers Hung printers, for which the MCS has not responded OK within the OK DELAY time. See DELAY and PRINTOK Control-level commands.

TANKSIZE

Use this command to set the TPS tank size for Direct Output.

Level	CONTROL
Syntax	TANKSIZE nnnn
Parameters	nnnn is the size of a logical block in the Tank file, in records. Minimum of 100.
Default	1000
Description	Changes initial size of Tank file, which is used to spool output to printers (without waiting for a RELEASE command from the Report), when output is received from a Report faster than it can be delivered direct to a printer. Relates only to output sent direct to printers. Tank size is set up at TPS Beginning-of-Job (BOJ). Any change is not affected until the next BOJ of TPS. The Tank file is not used when output uses a backup file.

TEACH

Use this command to display help information for TPS commands.

Level	USER
Syntax	TEACH [command]
Parameters	command if specified, displays help text for that command. If not specified, displays a list of all commands available to that user.
Description	Displays help information for TPS Commands. Any unrecognized input to TPS displays available TPS commands. Synonymous with HELP.

USER

Use this command to sign on to TPS.

Level	USER
Syntax	USER username checkword
Parameters	username is the valid username, up to 10 characters. checkword is the valid checkword associated with the username, up to 10 characters.
Description	Valid only when a NGEN28TP/USERS file is loaded. See Controlling Access to TPS. Synonymous with HELLO and LOGON.