You are on page 1of 88

I N T E L L I G E N T • S Y S T E M S • M A N A G E M E N T

Columbus Output Management


How to use the uq menu interface

UQUF-4800-00 Columbus OM 4.8


Publication number Trademark acknowledgements
UQUF-4800-00 (September 2007) Product and company names mentioned herein may be the
trademarks or registered trademarks of their respective
owners.
Documentation set
The documentation relating to this product includes:
License information

How to install Columbus OM
Copyright © 2007 Macro 4. All rights reserved.

How to configure Columbus OM
This publication, as well as the software described in it, is

How to use Columbus OM furnished under license and may be used or copied only in

How to use the command line interface accordance with the terms of such license. The information
in this publication is furnished for informational use only, is

How to use the uq menu interface subject to change without notice, and should not be

How to integrate with SAP R/3 construed as a commitment by Macro 4. Macro 4 assumes
no responsibility or liability for any errors or inaccuracies

Technical Reference
which may appear in this publication.
Except as permitted by such license, no part of this
Making comments publication may be reproduced, stored in a retrieval
We welcome suggestions from all users regarding our system, or transmitted, in any form or by any means,
software products and their accompanying documentation. electronic, mechanical, recording or otherwise, without
Please contact your local Macro 4 representative, email us prior written permission from Macro 4.
at tech.authors@macro4.com, or write to:
Technical Documentation
Macro 4
The Orangery, Turners Hill Road,
Crawley, West Sussex RH10 4SS
United Kingdom
www.macro4.com
3

Contents

How to use the uq menu interface UQUF-4800-00

About this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 1 Using the uq menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7


Working with menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Working with the browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 2 Terminal definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 17


Selecting a terminal definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Creating a definition for uq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Creating a definition for the browser . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configuring the Columbus OM/browser relationship . . . . . . . . . . . . . . . 31

Chapter 3 Standard Columbus OM menu structure . . . . . . . . . . . . 33


Customizing the menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Dispatch instance menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Fax instance menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Print instance menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapter 4 Built-in functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61


A functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
B functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
C functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
D functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
E functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
F G and H functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
I J and K functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
L functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
M functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
N functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
O P and Q functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
R functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


4 Contents

S functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
T U and V functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
W functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Chapter 5 System files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


menu.fkey: Function key assignments . . . . . . . . . . . . . . . . . . . . . . . . . 76
menu.menu: Vertical menu definitions . . . . . . . . . . . . . . . . . . . . . . . . 77
menu.ring: Horizontal menu definitions . . . . . . . . . . . . . . . . . . . . . . . 78
terminal_type: Source terminal definitions . . . . . . . . . . . . . . . . . . . . . . 78
terminal_type.def: Browser terminal definitions . . . . . . . . . . . . . . . . . . . 78
terminal_type.ttp: Compiled terminal definitions. . . . . . . . . . . . . . . . . . . 79
fkey.tab: Function key classification . . . . . . . . . . . . . . . . . . . . . . . . . 79
report.def: Browser print specification . . . . . . . . . . . . . . . . . . . . . . . . 80
uqadm.menu, uqimp.menu, uqops.menu, uquser.menu . . . . . . . . . . . . . . 81
wliqsum.tab: Queue display format . . . . . . . . . . . . . . . . . . . . . . . . . . 82
wopqsum.tab: Printer status display format . . . . . . . . . . . . . . . . . . . . . 82

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


5

About this manual

How to use the uq menu interface UQUF-4800-00

The uq menu interface is available for Columbus OM running on UNIX platforms.


The interface, invoked by the uq command, enables you to administer and operate
Columbus OM by using hierarchical menus presented on an 80 by 24 character-
mode terminal. It is described in these sections:
■ ‘Using the uq menus’ on page 7, describing the appearance and operation of
the menu interface and of the associated text file browser, is of relevance to
anybody using the menu interface.
■ ‘Terminal definitions’ on page 17 explains how the interface uses standardized
setup files in order to operate across a range of terminal types. You should
study this material during the Columbus OM installation procedure.

‘Standard Columbus OM menu structure’ on page 33 specifies the menu
hierarchies distributed with Columbus OM. The information here and in the
following sections is of importance only if you intend to customize the menus.

‘Built-in functions’ on page 61 lists the available set of functions which the
menu system invokes in order to control and monitor Columbus OM activities.

‘System files’ on page 75 defines various files used by the menu interface and
the text file browser.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


6 About this manual ■
Conventions

Conventions
The following typographic conventions are used:
boldface Indicates a command or keyword that you should type, exactly
as shown.
italics Indicates a variable for which you should substitute an
appropriate value.
monotype Indicates literal input and output.
Ctrl+D Indicates two or more keys pressed simultaneously.
[ ] Brackets surround an optional value.
| Vertical bars separate alternative values from which you must
make a selection.
... Ellipsis indicates that the preceding element may be repeated.
The names of some files and directories depends on your installation. For example,
the directory $UNIQDIR/media/paper contains files defining the types of paper
used at that installation. In the text, such files are referenced as
$UNIQDIR/media/paper/paper_type.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


7

CHAPTER 1

Chapter 1 Using the uq menus

The uq menu interface is a UNIX-based alternative to the command line method of


using and controlling a Columbus OM system. Instead of needing to remember the
various Columbus OM commands and their options, you can navigate through a
hierarchy of logical choices until you reach the operation which you want to
perform. Wherever possible, you can select an item either by typing its name, or by
highlighting it from a list of possible values.
The associated document browser enables you to view the contents of an ASCII
text document. As well as moving sequentially forwards and backwards through
the document, you can jump to specific pages, locate occurrences of text strings,
and print some or all of the document.
The browser is primarily used by the uq menu system, but is also available from the
command line. Both components are provided only on UNIX systems.
■ ‘Working with menus’ on page 8 provides general instructions on the use of the
menu system to control Columbus OM.

‘Working with the browser’ on page 13 covers use of the text browser.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


8 CHAPTER 1 ■
Using the uq menus ■
Working with menus

Working with menus


The interface assumes that you have a character mode terminal, typically
displaying 24 rows of 80 columns, and capable of a small number of visual effects
such as high/low intensity and normal/inverse video; if available, line-drawing
characters are also displayed. To control these effects, it uses the $TERM (or
$UNIQTERM) environment variable to determine the characteristics of your
terminal device: the procedure for configuring this variable correctly during
Columbus OM installation is described in ‘Creating a definition for uq’ on page 20.
Also, your $UF_HOME environment variable must be set to $UNIQDIR/uniform.

Starting the menu interface


Type uq on the UNIX command line to start the menu interface and display the
top-level menu. The menus are different for each print, fax and dispatch instances,
and also vary according to your access privileges, but all follow the same pattern.
You will come across three general display styles:

for selecting primary options, see ‘Using vertical menus’ on page 9

for data-related activities such as viewing the entries on a queue, see ‘Using
horizontal menus’ on page 12

for viewing the contents of a file, see ‘Working with the browser’ on page 13.
To exit from the menu interface, select the Quit option on the top-level (vertical)
menu. You can also exit by pressing function key F10. The interface uses the
function keys F1 to F10 to select various options; in particular F9 to confirm an
operation and F10 to terminate an operation.
Note On some terminals you may need to use an alternative set of ten function
keys: Help, F7, F8, F9, F10, F11, F12, F13, Do, PF4.
Terminal emulators do not always provide full function key support, but you can
achieve the same results by pressing the Escape key followed by a digit: Esc then 1
is equivalent to F1 (or Help), Esc then 2 is equivalent to F2 (or F7)..., through to
Esc then 0 which is equivalent to F10 (or PF4).

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 1 ■
Using the uq menus ■
Working with menus
9

Using vertical menus


This is an example of a vertical menu: the top-level options available to somebody
with Implementors privileges to a Columbus OM print instance:
title block option panel

key legends instance block


information block

The display includes these areas:


■ a title block, naming the product and the access level

the option panel, listing the choices available at this level
■ an information block with version and licensing data

an instance block, naming the Columbus OM instance and this menu screen
■ a set of key legends relating to function and other keys.

Choosing from the menu


To select an option, do one of the following:

Press the CursorDown and CursorUp keys to highlight the option, and then
press Return to select it.

Type the first letter of the option. If there is only one option with that letter, it is
automatically selected. If there are multiple options, keep typing the letter to
cycle through them, pressing Return to select.
Note You can configure this second behaviour by setting the Menu_Mode
parameter in $UNIQDIR/config/defaults.tab, described in the Technical
Reference manual.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


10 CHAPTER 1 ■
Using the uq menus ■
Working with menus

Performing the chosen option


After you select an option, one of two things happens:

If no further information is needed, the option is performed. For example,
Printer Status List immediately displays the status of all configured print
servers, while Quit takes you back to the previous menu, or out from the menu
interface.

Where additional choices or values are required, the interface presents a further
menu, or overlays another panel on the current menu. For example, Queue
Maintenance overlays a set of options relating to queues, on which Extend
Completed Queue superimposes a prompt panel for you to enter an
appropriate number for the extended queue size.

Selecting additional values from a list


In many cases, the interface can assist you by offering a list of possible values. For
example, Configuration overlays a set of options relating to server configuration,
on which Modify a Printer superimposes a prompt panel for you to enter the
printer name. At this point, you can either:
■ type the name, and then press Return to display its configuration; or

just press Return. The interface displays a list of possible printers, from which
you can select the appropriate value in the usual way.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 1 ■
Using the uq menus ■
Working with menus
11

On a data entry panel where multiple values are defined, a similar mechanism is
available. For example, after you select Modify a Printer and specify the printer
name, the displayed panel includes a field for you to specify the name of a printer
type. With the cursor in this field, you can either:
■ type the name; or

use the List command assigned to function key F8. The interface then pops up
an option panel of possible printer types, from which you can select the
appropriate value as before; or

if the field is empty, just press Return to pop up the option panel.

For some field types, for example Yes/No values, the List command cycles
through the possible values. For fields where it is not possible to display a list of
possible values (for example, user-definable remarks), the List command has no
effect.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


12 CHAPTER 1 ■
Using the uq menus ■
Working with menus

Using horizontal menus


This is an example of a horizontal (or ring) menu: a display of the queues in for the
Columbus OM print instance:

option bar monitor block

key legends display area instance block

The display includes these areas:



the option bar, listing the choices available at this level, and explaining the
currently-selected option

a monitor block, showing whether the data display is being automatically
refreshed as values change
■ a display area which can contain a variety of data presentations

an instance block, naming the Columbus OM instance and this menu screen
■ a set of key legends relating to function and other keys.
In most respects, horizontal menus offer the same functionality as vertical menus.

Choosing from the menu


To select an option from the menu, do one of the following:

Press the CursorRight and CursorLeft keys to highlight the option, and then
press Return to select it;
■ Type the first letter of the option. If there is only one option with that initial
letter, it is automatically selected. If there are multiple options, keep typing the
letter to cycle through them, and then press Return to select.
You can often use the CursorDown and CursorUp keys to select one of the items in
the display area, on which the selected option is to operate.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 1 ■
Using the uq menus ■
Working with the browser
13

Working with the browser


Like the uq menu interface, the browser assumes that you have a character mode
terminal, typically displaying 24 rows of 80 columns, and capable of a small
number of visual effects such as high/low intensity and normal/inverse video. To
control these effects, it uses the $TERM (or $UNIQTERM) environment variable to
determine the characteristics of your terminal device. The procedure for
configuring this variable correctly during Columbus OM installation is described in
‘Creating a definition for the browser’ on page 26.
Note The browser and the uq menu interface use separate terminal definitions.

Starting the browser


Type browse file on the UNIX command line to view the first lines of the file.

key legends display area status bar

The display includes these areas:



a display area which presents the file contents

a status bar which shows the current location within the file
■ a set of key legends relating to function and other keys. Display of this
optional area is controlled by the browser terminal definition file: see ‘Help
Text block’ on page 29.

Using the keyboard


The standard key assignments for the supported functions are given here:

‘Controlling the display’ on page 14

‘Moving around the document’ on page 14

‘Locating text strings’ on page 15

‘Marking blocks to be printed’ on page 15

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


14 CHAPTER 1 ■
Using the uq menus ■
Working with the browser


‘Printing parts of the document’ on page 16
The browser uses function keys F1 to F10 to select various options.
Note On some terminals you may need to use an alternative set of ten function
keys: Help, F7, F8, F9, F10, F11, F12, F13, Do, PF4.
Terminal emulators do not always provide full function key support: you can
achieve the same results by pressing the Escape key followed by a digit. For
example, Esc then 1 is equivalent to F1 (or Help); Esc then 2 is equivalent to F2 (or
F7); through to Esc then 0 which is equivalent to F10 (or PF4).

Controlling the display


These keys control the browser display.

To do this Press these keys

display help text h or H

toggle the display of the Status bar w or W

cycle through the defined display sizes z or Z

refresh the display Ctrl+L

exit from the browser q or Q or Esc then 0

Moving around the document


These keys support navigation around the document.

To do this Press these keys

move the cursor down one row n or N or CursorDown

move the cursor up one row CursorUp

move the cursor right one column CursorRight

move the cursor left one column CursorLeft

scroll down by half the screen height d

scroll up by half the screen height u

scroll right by half the screen width >

scroll left by half the screen width <

go to the next page D

go to the previous page U

go to the first page t or T or F3

go to the last page b or F4

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 1 ■
Using the uq menus ■
Working with the browser
15

To do this Press these keys

go to a specified page g or G
the page_number then Return
go to the last line of the file B

Locating text strings


These keys display occurrences of a specified text string.

To do this Press these keys

locate the next occurrence of a text string l or L


the string then Return
the attributes then Return
repeat the last locate function r or R or Return

The attributes control the way in which the search is conducted; any
combination of:

C to ignore upper/lowercase differences when matching the string


I to require that the string is an independent word, delimited by non
alphanumeric characters
W to recognize wildcards in the string, with an asterisk * meaning any
number of characters, and a question mark ? meaning any single character.

Marking blocks to be printed


These keys mark one or more blocks of contiguous lines, which can then be
printed.

To do this Press these keys

define a block which starts at the bottom line of s


the display
define a block which starts at the top line of the S
display
define a block which ends at the bottom line of e
the display
define a block which ends at the top line of the E
display
display the next marked block, with its start at the m
bottom line of the display
display the previous marked block, with its start M
at the bottom line of the display
clear the marked block which starts at the bottom c
line of the display

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


16 CHAPTER 1 ■
Using the uq menus ■
Working with the browser

To do this Press these keys

clear the marked block which starts at the top C


line of the display
clear all marked blocks aa or AA

Printing parts of the document


These keys invoke the print capability.

To do this Press these keys

print the entire document p or P


1 then Return
the printer then Return
(see the Note below)
Return

print a range of pages p or P


2 then Return
the first_page then Return
the last_page then Return
the printer then Return
(see the Note below)
Return

print the marked block(s) p or P


3 then Return
the printer then Return
(see the Note below)
Return

Note Printing can be configured to use either the standard UNIX lp command
or, if available, the capabilities of the Columbus OM print instance: see
‘Configuring the Columbus OM/browser relationship’ on page 31. Where
a Columbus OM print instance is used, you are also asked whether the
print queue entry should have Held status, and given the opportunity to
associate a remark with the print job.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


17

CHAPTER 2

Chapter 2 Terminal definitions

This chapter describes how, as part of the Columbus OM installation process, you
must establish terminal definition files to support the uq menu interface. Standard
files suitable for use with many popular terminal types are supplied with
Columbus OM, so this task is unlikely to be complicated.
The uq and browse commands present formatted displays using absolute cursor
positioning, inverse video, line-drawing characters and other similar effects. These
displays are constructed using control codes which must be specified for a
particular terminal type (and emulators of that type) in a terminal definition file. To
use the uq and browse commands, you must ensure that appropriate definition files
exist for the terminal type(s) which you plan to use.
■ ‘Selecting a terminal definition’ on page 18 explains how to check if your
terminal type is supported as standard, and what to do if it isn’t.
■ ‘Creating a definition for uq’ on page 20 specifies the definition files used by
the uq command.

‘Creating a definition for the browser’ on page 26 specifies the definition files
used by the browse command.

‘Configuring the Columbus OM/browser relationship’ on page 31 covers
additional points to be considered when integrating the browser into a
Columbus OM instance.
Note Terminal definitions are stored in files beneath the $UNIQDIR directory
defining a single Columbus OM instance. If your installation includes
multiple Columbus OM instances, you must create appropriate terminal
definitions within each instance.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


18 CHAPTER 2 ■
Terminal definitions ■
Selecting a terminal definition

Selecting a terminal definition


Columbus OM uses two sets of terminal definition files:

files in $UNIQDIR/uniform/ttp control the menus displayed by the uq
command; in addition, $UNIQDIR/menus/fkey.tab defines how the Key
legends area of menus are displayed.
■ files in $UNIQDIR/browser control text file displays produced by the browse
command, and by certain options within the uq menu interface.
For a list of terminal definitions supplied with the Columbus OM product, see
‘Standard supported terminals’ on page 19. To ensure that Columbus OM uses the
appropriate definition for your terminal, determine the current value of your
$TERM environment variable, then proceed according to these options:

1 $TERM value matches one of the standard Columbus OM terminal definitions:


you need do nothing further. Columbus OM will use the $TERM value to select
the appropriate definition.
2 $TERM value is not an exact match, but is related to one of the standard
Columbus OM terminal definitions (for example, your $TERM contains vt420,
which is upwards compatible with the supplied vt220 definition): you have
three choices.
■ Clone a supplied definition: see ‘Copying an existing terminal definition’
on page 19. This is the preferred method, since the new definition is then
available to all users with no impact on their environment variables.

Define a $UNIQTERM environment variable to contain one of the standard
Columbus OM terminal definitions; Columbus OM will use a $UNIQTERM
value in preference to a $TERM value. For example, your $TERM contains
vt420, so you could set $UNIQTERM to vt220.

Change your $TERM setting to match one of the standard Columbus OM
terminal definitions. For example, your $TERM contains vt420, so you
could change it to vt220. This is the simplest answer, but should be
approached with caution as it may affect the behaviour of other software
running on your terminal.
3 $TERM value bears no relation to any of the standard Columbus OM terminal
definitions (for example, your $TERM contains hp700, which is incompatible
with the supplied definitions): you have two choices.

Switch the terminal hardware to a different emulation mode and change
your $TERM setting to match one of the standard Columbus OM terminal
definitions. This is the preferred method, since almost all modern terminals
include emulators of models such as the vt100 or vt220 which are
including among the Columbus OM definitions.

Build a new definition: see ‘Creating a definition for uq’ on page 20 and
‘Creating a definition for the browser’ on page 26. This is more
complicated, and may not be possible for all terminals.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Selecting a terminal definition
19

Standard supported terminals


Columbus OM is supplied with this set of standard terminal definitions:

Definition Applies to

aixterm AIX X-terminal


dtterm DEC VT220
ibm3101 IBM 3101
ibm3151 IBM 3151
ibm3161 IBM 3161
m303 ICL M303
pt200 Prime PT200
sun Sun workstation console
sun-cmd Sun workstation console
ti931 Texas Instruments TI931
vt100 DEC VT100
vt220 DEC VT220
vt220d DEC VT220 with no graphic characters
wyse60 Wyse 60
xterm X-terminal
xterm2 X-terminal with no graphic characters

Copying an existing terminal definition


If your $TERM value is not an exact match, but is compatible with one of the
standard Columbus OM terminal definitions, you can clone the existing definition
by making identical copies of its files:
1 In $UNIQDIR/browser, copy std_terminal_type.def to
new_terminal_type.def (preferably updating the comment at the top of the
file).
2 In $UNIQDIR/uniform/ttp/source, copy std_terminal_type to
new_terminal_type (preferably updating the comment at the top of the file).

3 Compile the copied file using the command ufct new_terminal_type


4 In $UNIQDIR/menus, edit fkey.tab by copying the line for std_terminal_type
to an equivalent line for new_terminal_type.
Columbus OM will use your $TERM value to select the new_terminal_type
definition.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


20 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq

Creating a definition for uq


uq terminal definitions are created in source form, then compiled before use. For a
given terminal_type, the source file is
$UNIQDIR/uniform/ttp/source/terminal_type and the compiled file is
$UNIQDIR/uniform/ttp/terminal_type.ttp.

To build a definition for a new terminal type, follow these steps:


1 Create a source definition file: see ‘Defining the terminal characteristics’ below.
2 Compile the source: see ‘Compiling the definition’ on page 25.
3 Classify the terminal type’s function keys: see ‘Specifying function key
handling’ on page 25.

Defining the terminal characteristics


A uq terminal definition file is divided into a number of logical blocks. Each block
starts with the keyword BEGIN, contains a related set of specification statements,
and is terminated by the keyword END. A specification statement occupies a single
line. Blank lines are ignored, as is any text on a line after the comment characters
/*. The blocks are:
■ ‘ATTRIBUTES block’ on page 21

‘CONFIG block’ on page 22
■ ‘CURSOR block’ on page 22

‘GRAPHICS block’ on page 23
■ ‘KEYBOARD block’ on page 24

‘SCREEN block’ on page 25
In the specification statements which follow, the phrase code... denotes a space-
separated list of control codes to be transmitted to, or received from, the terminal.
Each item in the list is either:

one or more literal characters enclosed in single quotes '...' (within which
two consecutive quotes '' can be used to represent one single quote);
■ the standard ASCII control character name, from this list:

Name Octal Name Octal Name Octal

nul 000 vt 013 syn 026


soh 001 ff 014 etb 027
stx 002 cr 015 can 030
etx 003 so 016 em 031
eot 004 si 017 sub 032
enq 005 dle 020 esc 033
ack 006 dc1 021 fs 034
bell 007 dc2 022 gs 035

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq
21

Name Octal Name Octal Name Octal

bs 010 dc3 023 rs 036


ht 011 dc4 024 uf 037
lf 012 nak 025 del 177

ATTRIBUTES The ATTRIBUTES block specifies the visual attributes of characters.


block
Syntax
BEGIN ATTRIBUTES
ADDITIVE character
PREFIX code...
PREFIX_RESETS_ALL
RESET_ALL code...
RESET_BLINKING code...
RESET_RVIDEO code...
RESET_HIDDEN code...
RESET_LOW_INTENSITY code...
RESET_UNDERLINED code...
SEPERATOR code...
SET_BLINKING code...
SET_HIDDEN code...
SET_LOW_INTENSITY code...
SET_RVIDEO code...
SET_UNDERLINED code...
SUFFIX code...
END

Parameters
PREFIX code...
SEPERATOR code...
SUFFIX code...

For terminals which can set and reset several attributes in a single command,
PREFIX is sent first, then the first attribute, then the SEPERATOR (sic), then the
second attribute, then the SEPERATOR ..., then the final attribute, then SUFFIX.
For terminals which must treat each attribute individually, these statements
must be omitted.
PREFIX_RESETS_ALL

For terminals which can set and reset several attributes in a single command,
PREFIX_RESETS_ALL specifies that PREFIX first resets all attributes and then
sets those which follow, instead of individually setting and resetting them. For
terminals which must treat each attribute individually, this statement should be
omitted.
RESET_ALL code...

The sequence to reset all attributes.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


22 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq

SET_attribute code...
RESET_attribute code...

The sequences to set and reset individual attributes.


ADDITIVE character

An optional base value added to the code values for SET_attribute.

CONFIG block The CONFIG block specifies communications properties.

Syntax

BEGIN CONFIG
DYNT_ID T1|T2
END

Parameters
DYNT_ID T1|T2

T1 and T2 identify block mode device drivers used with some terminal types.
The appropriate setting can best be established through trial and error.

CURSOR block The CURSOR block specifies cursor positioning.

Syntax
BEGIN CURSOR
COLUMN [FIRST] ADD|SUBTRACT number
INVISIBLE code...
PREFIX code...
ROW [FIRST] ADD|SUBTRACT number
SEPERATOR code...
SUFFIX code...
USE_RANK_VALUE
VISIBLE code...
END

Parameters
PREFIX code...
SEPERATOR code...
SUFFIX code...

When positioning the cursor to an absolute location, PREFIX is sent first, then
the row (or column) position, then the SEPERATOR (sic), then the column (or
row) position, then SUFFIX.
ROW [FIRST] ADD|SUBTRACT number
COLUMN [FIRST] ADD|SUBTRACT number

The FIRST qualifier should be used once, with either ROW or COLUMN, to
determine which is sent first when positioning the cursor to an absolute
location. The number is added to or subtracted from the absolute row or
column to determine the appropriate value to be sent to the terminal.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq
23

USE_RANK_VALUE

USE_RANK_VALUE specifies that each row or column value is sent as a seven-bit


binary number (thus a value of 65 is sent as the character “A”). If omitted, each
value is converted to a decimal string (thus a value of 65 is sent as the
characters “65”).
VISIBLE code...
INVISIBLE code...

The sequences to make the cursor visible (while the user is entering data) and
invisible (at other times).

GRAPHICS block The GRAPHICS block specifies the display of simple lines and boxes.

Syntax
BEGIN GRAPHICS
G1_ON code...
G2_ON code...
G_OFF code...

HLINE|TLINE|BLINE code...
RHLINE|RTLINE|RBLINE code...

VLINE|LLINE|RLINE code...
RVLINE|RLLINE|RRLINE code...

TLCORNER|BLCORNER|TRCORNER|BRCORNER code...
RTLCORNER|RTRCORNER|RBLCORNER|RBRCORNER code...

HEADL|HEAD|HEADR code...
RHEADL|RHEAD|RHEADR code...
END

Parameters
G1_ON code...
G2_ON code...
G_OFF code...

The sequences to select graphics character set 1 (normal video), graphics


character set 2 (reverse video), and to return to the standard text character set.
TLINE|HLINE|BLINE code...
RTLINE|RHLINE|RBLINE code...

The sequences to output a one-character horizontal line in normal video and in


reverse video. The position of the line within the character pixel matrix is
respectively across the top, through the middle, and across the bottom.
LLINE|VLINE|RLINE code...
RLLINE|RVLINE|RRLINE code...

The sequences to output a one-character vertical line in normal video and in


reverse video. The position of the line within the character pixel matrix is
respectively at the left, through the middle, and at the right.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


24 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq

TLCORNER|TRCORNER|BLCORNER|BRCORNER code...
RTLCORNER|RTRCORNER|RBLCORNER|RBRCORNER code...

The sequences to output a one-character corner in normal video and in reverse


video.
HEADL|HEAD|HEADR code...
RHEADL|RHEAD|RHEADR code...

The sequences to output a one-character menu header character (top-left, top,


top-right) in normal video and in reverse video.

KEYBOARD block The KEYBOARD block maps character sequences received from the terminal to the
appropriate function name.

Syntax
BEGIN KEYBOARD
BACKTAB code...
CLEAR code...
CURSOR_DOWN code...
CURSOR_LEFT code...
CURSOR_RIGHT code...
CURSOR_UP code...
DELETE code...
ENTER code...
F1 code...
...
F10 code...
HELP code...
HOME code...
INSERT code...
PAGE_DOWN code...
PAGE_UP code...
PRINT code...
RETURN code...
TAB code...
END

Any given function name may be defined several times, each with a different
character sequence. However, any given character sequence must appear only
once in this block. When an incoming character sequence is recognized, the uq
interface instructs the terminal to perform the associated functionality.
The block includes the function names F1 through F10. These entries represent the
standard functionality associated with ten function keys, rather than the actual key
legends (which may in some instances be Help, F7, ... PF4); you can also press the
Escape key and then a digit 1 through 0 to achieve the same effect. If you cannot
otherwise identify it, you may be able to determine the character sequence return
from a given key by using this technique on the terminal concerned:

$ echo "press_key_here" | od -c
0000000 code... \n
0000004

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Creating a definition for uq
25

where press_key_here represents a single press of the key concerned. The


returned code... prior to the \n is the key’s character sequence, with control
codes given as three-digit octal numbers (see ‘Defining the terminal characteristics’
on page 20). Note, however, that this method requires the Bourne shell, and may
not work reliably under a terminal emulator.
See also ‘Specifying function key handling’ below.

SCREEN block The SCREEN block specifies the display characteristics as a whole.

Syntax
BEGIN SCREEN
CLEAR code...
PAUSE_AFTER_CLEAR number
END

Parameters
CLEAR code...

The sequence to clear the screen to spaces, with the cursor at the first column of
the first row.
PAUSE_AFTER_CLEAR number

The delay in milliseconds after CLEAR and before sending further characters.

Compiling the definition


To compile a uq terminal definition file:
1 Change to the $UF_HOME/ttp/source directory.
2 Use the ufct command to compile the appropriate terminal_type source file.

$ ufct terminal_type

3 If successful, the resulting terminal_type.ttp is written to $UF_HOME/ttp.

Specifying function key handling


$UNIQDIR/menus/fkey.tab defines the way in which function keys are labelled on
a given terminal. The file contains one line for each terminal type, with two space-
separated fields:
terminal_type

The name of the terminal type, as set in $TERM or $UNIQTERM.


0|1|2

The classification of the terminal type, used to select the appropriate set of key
legends to display along the bottom of the uq menus; one of:

0 The terminal has no function keys; the equivalent functionality can be


obtained only by pressing ESC followed by a digit 1 through 0.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


26 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for the browser

1 The terminal has standard ANSI function keys labelled “F1” through
“F10”.
2 The terminal has enhanced ANSI function keys labelled “Help”, “F7”
through “F13”, “Do” and “PF4”.

Add an appropriate line for the new terminal type.

Creating a definition for the browser


A browser terminal definition file $UNIQDIR/browser/terminal_type.def is
divided into a number of logical blocks. Unlike the uq definitions, a block is
delineated only by the specification statements that it contains, not by surrounding
BEGIN and END keywords. A specification statement occupies a single line. Blank
lines are ignored, as is any text on a line which starts with the comment character #.
The blocks are:
■ ‘Display block’ below

‘Keyboard block’ on page 28
■ ‘Help Text block’ on page 29
In addition, a capability to switch between different display sizes on the same
terminal requires changes in two of those blocks. See ‘Screen Size Switching’ on
page 30.
In the specification statements which follow, the phrase code... denotes a
sequence of control codes to be transmitted to, or received from, the terminal. Each
item in the sequence is either:
■ a literal character (with two consecutive backslashes \\ used to represent one
single backslash);

a standard ASCII control character from this list, given as a backslash followed
by a three-digit octal number:

Name Octal Name Octal Name Octal

nul 000 vt 013 syn 026


soh 001 ff 014 etb 027
stx 002 cr 015 can 030
etx 003 so 016 em 031
eot 004 si 017 sub 032
enq 005 dle 020 esc 033
ack 006 dc1 021 fs 034
bell 007 dc2 022 gs 035
bs 010 dc3 023 rs 036
ht 011 dc4 024 uf 037
lf 012 nak 025 del 177

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Creating a definition for the browser
27

Display block The Display block specifies the visual attributes of characters, cursor positioning,
and the display characteristics as a whole.

Syntax
# Display block
BLINK code...
BOTTOM code...
CLEAR code...
COLS number
CURSOROFF code...
CURSORON code...
DELETE code...
ERASE code...
HOME code...
INITS code...
INSERT code...
LINTENSE code...
NL_STR code...
NORMAL code...
RESETS code...
ROWS number
RVIDEO code...
STATUS ON|OFF

Parameters
ROWS number
COLS number

The number of rows and columns on the screen.


STATUS ON|OFF

ON to initially display the status bar at the bottom of the screen; OFF to suppress
it.
INITS code...
RESETS code...
CLEAR code...

The sequences to initialize the terminal on entry to browse mode, to reset it on


exit, and to clear the screen.
BLINK code...
LINTENSE code...
NORMAL code...
RVIDEO code...

The sequences to set and reset display attributes.


HOME code...
BOTTOM code...
NL_STR code...

The sequences to move the cursor to the top left corner and bottom left corner
of the screen, and to the start of the next line.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


28 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for the browser

CURSORON code...
CURSOROFF code...

The sequences to make the cursor visible and invisible.


INSERT code...
DELETE code...
ERASE code...

The sequences to insert a blank line above the cursor (scrolling the remainder
down), to delete the current line (scrolling up), and to erase all text to the right
of the cursor on the current line.

Keyboard block The Keyboard block maps character sequences received from the terminal to the
appropriate function name. Each line contains three space-separated fields:
function code... legend

Parameters
function

The name of a browser function, listed below. Any given function name may
be defined several times, each with a different character sequence. However,
any given character sequence must appear only once in this block. When an
incoming character sequence is recognized, the browser instructs the terminal
to perform the associated functionality.
code...

A character sequence which might be received.


legend

The legend on the associated key, used when displaying help text to inform the
user which key performs which function.
The browser functions are:

BEGIN Display the first page of the file.


END Display the last page of the file.
EOF Display the last line of the file on the bottom line of the display.
EXIT Exit from the browser.
GOTOPAGE Display a specified page of the file starting at the top line of the
display.
HELP Display help text.
LINEDOWN Move cursor down one row.
LINELEFT Move cursor left one column.
LINERIGHT Move cursor right one column.
LINEUP Move cursor up one row.
LOCATE Search for a string.
MARKCLEARALL Clear all marked blocks.
MARKCLEARBOT Clear the marked block which starts at the bottom line of the
display.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Creating a definition for the browser
29

MARKCLEARTOP Clear the marked block which starts at the top line of the
display.
MARKENDBOT Define a block which ends at the bottom line of the display.
MARKENDTOP Define a block which ends at the top line of the display.
MARKGOTONEXT Display the next marked block with its start at the bottom line
of the display.
MARKGOTOPREV Display the previous marked block with its start at the bottom
line of the display.
MARKSTARTBOT Define a block which starts at the bottom line of the display.
MARKSTARTTOP Define a block which starts at the top line of the display.
NULLACT Define a key to have no effect.
PAGEDOWN Display the next page of the file starting at the top line of the
display.
PAGEUP Display the previous page of the file starting at the top line of
the display.
PRINT Print all or part of the file.
REDRAW Refresh the display.
REPEAT Repeat the last LOCATE function.
SCROLLDOWN Scroll down by half the screen height.
SCROLLEFT Scroll left by half the screen width.
SCROLLRIGHT Scroll right by half the screen width.
SCROLLUP Scroll up by half the screen height.
SIZE_SW Cycle through the defined display size configurations
(optional: see ‘Screen Size Switching’ on page 30).
STATUS_SW Toggle the display of the status bar.

Help Text block The Help Text block supports two capabilities: user-defined material, and function
key assignments.

Syntax
# Help Text block
HELPPATH file
HELP_TEXT "14_char_string"

Parameters
HELPPATH file

file is the full path to a file of user-defined supplementary material, which will
be displayed after the standard browser help listing the functions available and
the keystrokes which invoke those functions.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


30 CHAPTER 2 ■
Terminal definitions ■
Creating a definition for the browser

HELP_TEXT "14_char_string"

If used, this statement should appear exactly ten times, giving the text to appear
in the ten highlighted boxes in the Key legends area; the legends can reflect
the use of ten function keys, or any other key information you wish to display.
Each quoted 14_char_string is displayed as two strings of seven characters,
one above the other; by convention, the upper string is the left-aligned key
identification, and the lower string is the right-aligned functional description.
If you choose to display the function key assignments using HELP_TEXT, you should
also make allowances for the two lines that this occupies by modifying two
statements in the Keyboard block: decrease by two the value specified for ROWS,
and adjust the definition of BOTTOM correspondingly.
The default terminal definition files in $UNIQDIR/browser/terminal_type.def do
not include HELP_TEXT definitions, though such definitions are available in files
$UNIQDIR/browser/terminal_type.fkey. To switch to the definitions which
include the Key legends display:

$ cd $UNIQDIR/browser
$ mv terminal_type.def terminal_type.no_fkey
$ mv terminal_type.fkey terminal_type.def

CAUTION Do not confuse these .fkey files in $UNIQDIR/browser with the quite
different .fkey files in $UNIQDIR/menus.

Screen Size Screen Size Switching supports the capability of switching between different
Switching display sizes on the same terminal. If you wish to implement this capability, you
must change two blocks in the file.
Firstly, modify the Display block by grouping the ROWS, COLS and BOTTOM
specifications for a given display configuration, followed by a SET_SIZE statement
to activate that configuration. You can repeat this group of four statements for each
display configuration.
# Screen size definitions
ROWS number
COLS number
BOTTOM code...
SET_SIZE code...

Parameters
ROWS number
COLS number
BOTTOM code...

The definitions which are associated with a given display configuration.


SET_SIZE code...

The sequence to switch the terminal into that configuration.


Secondly, modify the Keyboard block by associating one or more character
sequences with the SIZE_SW function. Repeated operation of the key associated
with this function then causes the browser to cycle through the defined display
configurations.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 2 ■
Terminal definitions ■
Configuring the Columbus OM/browser relationship
31

Configuring the Columbus OM/browser relationship


When you install Columbus OM on a UNIX platform, you need to consider the
relationship with the text file browser. There are three aspects:
■ invoking the browser from the uq menu interface

invoking a Columbus OM print instance from the browser
■ configuring browser printing.

Invoking the browser from the uq menu interface


The system file $UNIQDIR/config/default.tab contains a VDUMode parameter
which determines how text files are displayed from within the uq menu interface.
To use the browser for this purpose, set the parameter thus:
VDUMode 'browse %FILE -PAGE %PLEN'

Invoking a Columbus OM print instance from the browser


The browser calls the shell script $UNIQDIR/browser/brprint when requested to
print parts of a document. By default, this script calls the Columbus OM print
instance to handle the print request; therefore, if your installation includes a print
instance then you need take no further action. If your installation does not include a
Columbus OM print instance, you should switch to the alternative print process
which uses the standard UNIX lp command:

$ cd $UNIQDIR/browser
$ mv brprint brprint.uniq
$ mv brprint.lp brprint

If necessary, you can amend either of these scripts.

Configuring browser printing


The browser reads a file $UNIQDIR/browser/report.def to obtain certain
configuration information. See ‘report.def: Browser print specification’ on page 80
for details.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


32 CHAPTER 2 ■
Terminal definitions ■
Configuring the Columbus OM/browser relationship

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


33

CHAPTER 3

Chapter 3 Standard Columbus OM


menu structure

This chapter presents the standard uq menu structure for Columbus OM, primarily
for the benefit of implementors wanting to apply customizations to suit the
requirements of their installation.
Note In the standard menu definition files, some options have been commented
out by a hash # at the start of the line; these extra options are shown as such
in the sections which follow.
Where applicable, the minimum administrative access privilege that a user must
have before being offered an option by the menu interface is provided. Thus,
“Minimum privileges: administrators” means that a user listed in
$UNIQDIR/security/administrators (which also includes everybody listed in
implementors) will see the option, which will not be offered to users listed only in
operators, or in none of these three files. Options without an annotation of this
form are offered to all users of a given menu.

‘Customizing the menus’ on page 34

‘Dispatch instance menus’ on page 35

‘Fax instance menus’ on page 41

‘Print instance menus’ on page 48

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


34 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Customizing the menus

Customizing the menus


The menu interface is controlled by a series of definition files, in
$UNIQDIR/menus, whose structure is defined in ‘menu.menu: Vertical menu
definitions’ on page 77 and ‘menu.ring: Horizontal menu definitions’ on page 78.
In almost every instance, the effect of selecting a menu option is either to display a
sub-menu, or to invoke one of the Columbus OM functions: see ‘Built-in functions’
on page 61.
You can modify any of the Columbus OM menu definition files in order to:
■ add options to a menu

remove (usually by commenting out) options from a menu
■ change the access privileges associated with an option.
You can also modify some of the information displays. See:
■ ‘wliqsum.tab: Queue display format’ on page 82

‘wopqsum.tab: Printer status display format’ on page 82.
The interface displays the name of the current menu in the Instance block towards
the bottom right-hand corner of the screen.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus
35

Dispatch instance menus


The uq command uses your access privileges in conjunction with files
uqimp.menu, uqadm.menu, uqops.menu and uquser.menu in
$UNIQDIR/menus to display an appropriate menu:

‘uq401: Main Menu (dispatch implementors, administrators, operators)’ below
■ ‘uq402: Main Menu (dispatch users)’ on page 36

‘uq010: Security’ on page 36
■ ‘uq411: Dispatch Server Management’ on page 38

‘uq413: Configuration’ on page 38
■ ‘wliq: List Queue’ on page 39

‘wliq3: Search Options’ on page 39

uq401: Main Menu (dispatch implementors, administrators,


operators)
Server Status List Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62). Minimum privileges:
operators.
List the Dispatch Display ring menu ‘wliq: List Queue’ on page 39 by
Queue invoking built-in function ‘wlistq: List the queue’ (see
page 71). Minimum privileges: operators.
List Current Browse the contents of file
Bundles $UNIQDIR/media/dispatch/bundle.tab. Minimum
privileges: operators.
Dispatch a File Invoke built-in function ‘addq: Add entry to print or
dispatch queue’ (see page 62). Minimum privileges:
operators.
System Security Display menu ‘uq010: Security’ on page 36 by invoking
built-in function ‘security_sel: Display System Security
menu’ (see page 69). Minimum privileges: operators.
Server Management Display menu ‘uq411: Dispatch Server Management’
on page 38. Minimum privileges: operators.
Configuration Display menu ‘uq413: Configuration’ on page 38.
Minimum privileges: implementors.
Queue Maintenance Display menu ‘uq014: Queue Maintenance’ on
page 55. Minimum privileges: operators.
View Logs Display menu ‘uq027: View Logs’ on page 55.
Minimum privileges: operators
Quit Exit from the uq menu interface.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


36 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus

uq402: Main Menu (dispatch users)


# Print a File Invoke built-in function ‘addq: Add entry to print or
dispatch queue’ (see page 62).
List the Dispatch Display ring menu ‘wliq: List Queue’ on page 39 by
Queue invoking built-in function ‘wlistq: List the queue’ (see
page 71).
Server Status List Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62).
Quit Exit from the uq menu interface.

uq010: Security
Add name to list of Invoke built-in function ‘addname: Add name to list of
authorized users authorized users’ (see page 62).
Remove name from Invoke built-in function ‘remname: Remove name from
list of authorized list of authorized users’ (see page 68).
users
Allow access to all Invoke built-in function ‘addall: Allow all users access
other users to a function’ (see page 62).
Remove access from Invoke built-in function ‘remall: Remove access to
all individual function from all users’ (see page 68).
users
Quit Return to the previous menu.

The operations on this menu add and remove entries from the files which control
which users are authorised to perform which Columbus OM functions. The list of
controllable functions, taken from $UNIQDIR/security/security.tab, is:

Operator Privileges Update access control file operators. Minimum


privileges: operators.
Administrator Update access control file administrators. Minimum
Privileges privileges: administrators.
Implementor Update access control file implementors. Minimum
Privileges privileges: implementors.
Add entries for Update access control file aeq_o. Minimum privileges:
other user operators.
Modify entries for Update access control file aeq_mod. Minimum
any user privileges: operators.
Resubmit entries as Update access control file rsq_o. Minimum privileges:
your own operators.
Redirect a pending Update access control file mod_at.
queue entry
Redirect a Update access control file mod_at_c.
completed queue
entry
List all in pending Update access control file liq_ap. Minimum privileges:
queue operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus
37

List all in either Update access control file liq_ao. Minimum privileges:
queue operators.
List specific Update access control file liq_o. Minimum privileges:
owner's entries operators.
View other owner's Update access control file liq_view. Minimum
entries privileges: administrators.
View entries of Update access control file liq_view_g. Minimum
others in group privileges: operators.
View your own Update access control file liq_view_o. Minimum
entries privileges: operators.
Display queue entry Update access control file liq_det. Minimum privileges:
details administrators.
Receive 'queue Update access control file wliq_warn. Minimum
tidy' message privileges: operators.
Remove any owner's Update access control file req_ao. Minimum privileges:
entries administrators.
Remove specific Update access control file req_o. Minimum privileges:
owner's entries operators.
Use of queue Update access control file aeq_p0. Minimum
priority 0 privileges: operators.
Use of queue Update access control file aeq_p1. Minimum
priority 1 privileges: operators.
Use of queue Update access control file aeq_p2. Minimum
priority 2 privileges: operators.
Use of queue Update access control file aeq_p3. Minimum
priority 3 privileges: operators.
Use of queue Update access control file aeq_p4. Minimum
priority 4 privileges: operators.
Use of queue Update access control file aeq_p5. Minimum
priority 5 privileges: operators.
Use of queue Update access control file aeq_p6. Minimum
priority 6 privileges: operators.
Use of queue Update access control file aeq_p7. Minimum
priority 7 privileges: operators.
Use of queue Update access control file aeq_p8. Minimum
priority 8 privileges: administrators.
Use of queue Update access control file aeq_p9. Minimum
priority 9 privileges: implementors.
Display system Update access control file syq_dd. Minimum
defaults privileges: operators.
Modify system Update access control file sysdef_mod. Minimum
defaults privileges: implementors.
Extend Completed Update access control file syq_ec. Minimum privileges:
queue administrators.
Extend Pending Update access control file syq_ep. Minimum
queue privileges: administrators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


38 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus

Journal of Update access control file syq_jc. Minimum privileges:


Completed queue operators.
Journal of Pending Update access control file syq_jp. Minimum privileges:
queue operators.
Fix Completed queue Update access control file syq_fc. Minimum privileges:
operators.
Fix Pending queue Update access control file syq_fp. Minimum privileges:
operators.
Purge Completed Update access control file syq_pc. Minimum
queue privileges: administrators.
Purge Pending queue Update access control file syq_pp. Minimum
privileges: administrators.
Start a dispatch Update access control file syq_i. Minimum privileges:
server operators.
Stop a dispatch Update access control file syq_tn. Minimum privileges:
server operators.
View Queue Update access control file syq_qs. Minimum
statistics privileges: operators.
View Server status Update access control file syq_s. Minimum privileges:
operators.

uq411: Dispatch Server Management


Start Server Invoke built-in function ‘start_server: Start server’ (see
page 69). Minimum privileges: operators.
Stop Server Invoke built-in function ‘stop_server: Stop server’ (see
page 70). Minimum privileges: operators.
Server Status Invoke built-in function ‘server_stats: Display status of
server’ (see page 69). Minimum privileges: operators.
Start all Servers Invoke built-in function ‘start_all_servers: Start all
servers’ (see page 69). Minimum privileges: operators.
Stop all Servers Invoke built-in function ‘stop_all_servers: Stop all
servers’ (see page 70). Minimum privileges: operators.
All Server Status Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62). Minimum privileges:
operators.
Quit Return to the previous menu.

uq413: Configuration
Add Dispatch Server Invoke built-in function ‘add_server: Configure new
general server’ (see page 62). Minimum privileges:
implementors.
Modify Dispatch Invoke built-in function ‘mod_server: Configure
Server general server’ (see page 67). Minimum privileges:
implementors.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus
39

Remove a Dispatch Invoke built-in function ‘del_server: Delete server’ (see


Server page 64). Minimum privileges: implementors.
Rules Table Browse the contents of file
$UNIQDIR/media/dispatch/rules.tab. Minimum
privileges: implementors.
System Defaults Invoke built-in function ‘mod_default: Configure
system defaults’ (see page 66). Minimum privileges:
implementors.
Quit Return to the previous menu.

wliq: List Queue


Servers Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62).
# Add Invoke built-in function ‘wliq_addq: Add entry to print
queue’ (see page 70).
# Modify Invoke built-in function ‘wliq_modq: Modify current
print queue entry’ (see page 71).
Remove Invoke built-in function ‘wliq_remq: Remove current
entry from queue’ (see page 71).
Hold Invoke built-in function ‘wliq_hold: Put current entry
on hold’ (see page 70).
Release Invoke built-in function ‘wliq_relq: Release current
HELD entry’ (see page 71).
# Resubmit Invoke built-in function ‘wliq_resq: Resubmit current
entry’ (see page 71).
Location Invoke built-in function ‘wliq_setq: Change to another
Columbus OM instance’ (see page 71). Minimum
privileges: administrators.
View Invoke built-in function ‘wliq_view: View document
file for current entry’ (see page 71).
Search Display menu ‘wliq3: Search Options’ below by
invoking built-in function ‘wliq_options: Display
Search Options menu’ (see page 71).
Attributes Invoke built-in function ‘si_detail: Display server
information for current entry’ (see page 69).

wliq3: Search Options


Restrict OWNER Invoke built-in function ‘chg_owner: Select specific
owner’ (see page 64). Minimum privileges: liq_o.
Show all OWNERS Invoke built-in function ‘any_owner: Select any owner’
(see page 63). Minimum privileges: liq_ao.
Show all OWNERS in Invoke built-in function ‘any_pending: Select any
pending queue owner in Pending, current owner in Completed’ (see
page 63). Minimum privileges: liq_ap.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


40 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Dispatch instance menus

Restrict FILENAME Invoke built-in function ‘chg_filename: Select specific


filename’ (see page 64).
Show all FILENAMES Invoke built-in function ‘any_filename: Select any
filename’ (see page 63).
Restrict ADDRESS Invoke built-in function ‘chg_address: Select specific
(printer/class) address’ (see page 64).
Show all ADDRESSES Invoke built-in function ‘any_address: Select any
(printers/ classes) address’ (see page 62).
Add a STATUS Invoke built-in function ‘new_status: Impose restriction
restriction on status code’ (see page 67).
Remove a STATUS Invoke built-in function ‘rem_status: Lift restriction on
restriction status code’ (see page 68).
Allow all STATUSES Invoke built-in function ‘any_status: Select any status
code’ (see page 63).
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus
41

Fax instance menus


The uq command uses your access privileges in conjunction with files
uqimp.menu, uqadm.menu, uqops.menu and uquser.menu in
$UNIQDIR/menus to display an appropriate menu:

‘uq201: Main Menu (fax implementors, administrators, operators)’ below
■ ‘uq202: Fax Submission (fax users)’ on page 42

‘uq010: Security’ on page 42
■ ‘uq211: Fax Server Management’ on page 44

‘uq212: Monitor Fax Servers’ on page 45
■ ‘uq213: Configuration’ on page 45

‘wliq: List Queue’ on page 46
■ ‘wliq3: Search Options’ on page 46

uq201: Main Menu (fax implementors, administrators,


operators)
Fax Server Status Invoke built-in function ‘list_fax_servers: List status of
all fax servers’ (see page 66). Minimum privileges:
operators.
# All Server Status Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62). Minimum privileges:
operators.
List the Fax Queue Display ring menu ‘wliq: List Queue’ on page 46 by
invoking built-in function ‘wlistq: List the queue’ (see
page 71). Minimum privileges: operators.
Monitor Fax Servers Display ring menu ‘uq212: Monitor Fax Servers’ on
page 45 by invoking built-in function ‘uqt: Monitor all
fax servers’ (see page 70). Minimum privileges:
operators.
Send a Fax Invoke built-in function ‘addfq: Add entry to fax queue’
(see page 62). Minimum privileges: operators.
System Security Display menu ‘uq010: Security’ on page 42 by invoking
built-in function ‘security_sel: Display System Security
menu’ (see page 69). Minimum privileges: operators.
Fax Server Display menu ‘uq211: Fax Server Management’ on
Management page 44. Minimum privileges: operators.
Configuration Display menu ‘uq213: Configuration’ on page 45.
Minimum privileges: implementors.
Change Queue Invoke built-in function ‘set_queue: Change to another
Columbus OM instance’ (see page 69). Minimum
privileges: administrators.
Queue Maintenance Display menu ‘uq014: Queue Maintenance’ on
page 55. Minimum privileges: operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


42 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus

View Logs Display menu ‘uq027: View Logs’ on page 55.


Minimum privileges: operators.
Quit Exit from the uq menu interface.

uq202: Fax Submission (fax users)


Send a Fax Invoke built-in function ‘addfq: Add entry to fax queue’
(see page 62).
List the Fax Queue Display ring menu ‘wliq: List Queue’ on page 46 by
invoking built-in function ‘wlistq: List the queue’ (see
page 71).
Fax Server Status Invoke built-in function ‘list_fax_servers: List status of
all fax servers’ (see page 66).
# All Server Status Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62).
Quit Exit from the uq menu interface.

uq010: Security
Add name to list of Invoke built-in function ‘addname: Add name to list of
authorized users authorized users’ (see page 62).
Remove name from Invoke built-in function ‘remname: Remove name from
list of authorized list of authorized users’ (see page 68).
users
Allow access to all Invoke built-in function ‘addall: Allow all users access
other users to a function’ (see page 62).
Remove access from Invoke built-in function ‘remall: Remove access to
all individual function from all users’ (see page 68).
users
Quit Return to the previous menu.

The operations on this menu add and remove entries from the files which control
which users are authorised to perform which Columbus OM functions. The list of
controllable functions, taken from $UNIQDIR/security/security.tab, is:

Operator Privileges Update access control file operators. Minimum


privileges: operators.
Administrator Update access control file administrators. Minimum
Privileges privileges: administrators.
Implementor Update access control file implementors. Minimum
Privileges privileges: implementors.
Add entries for Update access control file aeq_o. Minimum privileges:
other user operators.
Modify entries for Update access control file aeq_mod. Minimum
any user privileges: operators.
Resubmit entries as Update access control file rsq_o. Minimum privileges:
your own operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus
43

Redirect a pending Update access control file mod_at.


queue entry
Redirect a Update access control file mod_at_c.
completed queue
entry
List all in pending Update access control file liq_ap. Minimum privileges:
queue operators.
List all in either Update access control file liq_ao. Minimum privileges:
queue operators.
List specific Update access control file liq_o. Minimum privileges:
owner's entries operators.
View other owner's Update access control file liq_view. Minimum
entries privileges: administrators.
View entries of Update access control file liq_view_g. Minimum
others in group privileges: operators.
View your own Update access control file liq_view_o. Minimum
entries privileges: operators.
Display queue entry Update access control file liq_det. Minimum privileges:
details administrators.
Receive 'queue Update access control file wliq_warn. Minimum
tidy' message privileges: operators.
Remove any owner's Update access control file req_ao. Minimum privileges:
entries administrators.
Remove specific Update access control file req_o. Minimum privileges:
owner's entries operators.
Use of queue Update access control file aeq_p0. Minimum
priority 0 privileges: operators.
Use of queue Update access control file aeq_p1. Minimum
priority 1 privileges: operators.
Use of queue Update access control file aeq_p2. Minimum
priority 2 privileges: operators.
Use of queue Update access control file aeq_p3. Minimum
priority 3 privileges: operators.
Use of queue Update access control file aeq_p4. Minimum
priority 4 privileges: operators.
Use of queue Update access control file aeq_p5. Minimum
priority 5 privileges: operators.
Use of queue Update access control file aeq_p6. Minimum
priority 6 privileges: operators.
Use of queue Update access control file aeq_p7. Minimum
priority 7 privileges: operators.
Use of queue Update access control file aeq_p8. Minimum
priority 8 privileges: administrators.
Use of queue Update access control file aeq_p9. Minimum
priority 9 privileges: implementors.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


44 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus

Display system Update access control file syq_dd. Minimum


defaults privileges: operators.
Modify system Update access control file sysdef_mod. Minimum
defaults privileges: implementors.
Extend Completed Update access control file syq_ec. Minimum privileges:
queue administrators.
Extend Pending Update access control file syq_ep. Minimum
queue privileges: administrators.
Journal of Update access control file syq_jc. Minimum privileges:
Completed queue operators.
Journal of Pending Update access control file syq_jp. Minimum privileges:
queue operators.
Fix Completed queue Update access control file syq_fc. Minimum privileges:
operators.
Fix Pending queue Update access control file syq_fp. Minimum privileges:
operators.
Purge Completed Update access control file syq_pc. Minimum
queue privileges: administrators.
Purge Pending queue Update access control file syq_pp. Minimum
privileges: administrators.
Start a fax server Update access control file syq_i. Minimum privileges:
operators.
Stop a fax server Update access control file syq_tn. Minimum privileges:
operators.
View Queue Update access control file syq_qs. Minimum
statistics privileges: operators.
View Server status Update access control file syq_s. Minimum privileges:
operators.
Remote Update access control file uqnet_uq. Minimum
Administration privileges: administrators.

uq211: Fax Server Management


Start Fax Server Invoke built-in function ‘start_server: Start server’ (see
page 69). Minimum privileges: operators.
Stop Fax Server Invoke built-in function ‘stop_server: Stop server’ (see
page 70). Minimum privileges: operators.
Fax Server Status Invoke built-in function ‘server_stats: Display status of
server’ (see page 69). Minimum privileges: operators.
Start all Fax Invoke built-in function ‘start_all_servers: Start all
Servers servers’ (see page 69). Minimum privileges:
administrators.
Stop all Fax Invoke built-in function ‘stop_all_servers: Stop all
Servers servers’ (see page 70). Minimum privileges:
administrators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus
45

All Server Status Invoke built-in function ‘all_server_stats: Show status of


all servers’ (see page 62). Minimum privileges:
administrators.
Quit Return to the previous menu.

uq212: Monitor Fax Servers


Management Display menu ‘uq211: Fax Server Management’ on
page 44.
ListQ Display ring menu ‘wliq: List Queue’ on page 46 by
invoking built-in function ‘wlistq: List the queue’ (see
page 71).
Detail Invoke built-in function ‘server_setup: Display server
configuration (any server)’ (see page 69).

uq213: Configuration
Add a Fax server Invoke built-in function ‘add_fax_server: Configure
new fax server’ (see page 62). Minimum privileges:
implementors.
Duplicate a Fax Invoke built-in function ‘dup_server: Duplicate server’
server (see page 65). Minimum privileges: implementors.
Modify a Fax server Invoke built-in function ‘mod_fax_server: Configure
fax server’ (see page 66). Minimum privileges:
implementors.
Remove a Fax server Invoke built-in function ‘del_server: Delete server’ (see
page 64). Minimum privileges: implementors.
Add Other Server Invoke built-in function ‘add_server: Configure new
general server’ (see page 62). Minimum privileges:
implementors.
Modify Other Server Invoke built-in function ‘mod_server: Configure
general server’ (see page 67). Minimum privileges:
implementors.
Fax Shortcodes Invoke built-in function ‘fax_shortcodes: Configure fax
shortcodes’ (see page 65). Minimum privileges:
implementors.
Serial Line Invoke built-in function ‘mod_ldef: Configure serial
Definition lines’ (see page 66). Minimum privileges:
implementors.
System Defaults Invoke built-in function ‘mod_default: Configure
system defaults’ (see page 66). Minimum privileges:
implementors.
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


46 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus

wliq: List Queue


Servers Invoke built-in function ‘list_fax_servers: List status of
all fax servers’ (see page 66).
# Add Invoke built-in function ‘wliq_addfq: Add entry to fax
queue’ (see page 70).
Modify Invoke built-in function ‘wliq_modfq: Modify current
fax queue entry’ (see page 71).
Remove Invoke built-in function ‘wliq_remq: Remove current
entry from queue’ (see page 71).
Hold Invoke built-in function ‘wliq_hold: Put current entry
on hold’ (see page 70).
Release Invoke built-in function ‘wliq_relq: Release current
HELD entry’ (see page 71).
Resubmit Invoke built-in function ‘wliq_resq: Resubmit current
entry’ (see page 71).
# Location Invoke built-in function ‘wliq_setq: Change to another
Columbus OM instance’ (see page 71). Minimum
privileges: administrators.
View Invoke built-in function ‘wliq_view: View document
file for current entry’ (see page 71).
Options Display menu ‘wliq3: Search Options’ below by
invoking built-in function ‘wliq_options: Display
Search Options menu’ (see page 71).

wliq3: Search Options


Restrict OWNER Invoke built-in function ‘chg_owner: Select specific
owner’ (see page 64). Minimum privileges: liq_o.
Show all OWNERS Invoke built-in function ‘any_owner: Select any owner’
(see page 63). Minimum privileges: liq_ao.
Show all OWNERS in Invoke built-in function ‘any_pending: Select any
pending queue owner in Pending, current owner in Completed’ (see
page 63). Minimum privileges: liq_ap.
Restrict FILENAME Invoke built-in function ‘chg_filename: Select specific
filename’ (see page 64).
Show all FILENAMES Invoke built-in function ‘any_filename: Select any
filename’ (see page 63).
Restrict ADDRESS Invoke built-in function ‘chg_address: Select specific
address’ (see page 64).
Show all ADDRESSES Invoke built-in function ‘any_address: Select any
address’ (see page 62).
Add a MEDIUM Invoke built-in function ‘new_medium: Impose
restriction restriction on medium’ (see page 67).
Remove a MEDIUM Invoke built-in function ‘rem_medium: Lift restriction
restriction on medium’ (see page 68).

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Fax instance menus
47

Show all MEDIA Invoke built-in function ‘any_medium: Select any


medium’ (see page 63).
Add a STATUS Invoke built-in function ‘new_status: Impose restriction
restriction on status code’ (see page 67).
Remove a STATUS Invoke built-in function ‘rem_status: Lift restriction on
restriction status code’ (see page 68).
Allow all STATUSES Invoke built-in function ‘any_status: Select any status
code’ (see page 63).
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


48 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

Print instance menus


The uq command uses your access privileges in conjunction with files
uqimp.menu, uqadm.menu, uqops.menu and uquser.menu in
$UNIQDIR/menus to display an appropriate menu:

‘uq001: Main Menu (print implementors, administrators, operators)’ below
■ ‘uq002: Document Printing (print users)’ on page 49

‘uq008: Configure System Tables’ on page 49
■ ‘uq010: Security’ on page 50

‘uq011: Scheduler Management’ on page 53
■ ‘uq012: Monitor Printers’ on page 54

‘uq013: Configuration’ on page 54
■ ‘uq014: Queue Maintenance’ on page 55

‘uq027: View Logs’ on page 55
■ ‘wliq: List Queue’ on page 56

‘wliq3: Search Options’ on page 57
■ ‘wopq: Printer Operations’ on page 57

‘wopq1: Class Maintenance’ on page 58
■ ‘wopq2: Paper Maintenance’ on page 59

uq001: Main Menu (print implementors, administrators,


operators)
Printer Status List Invoke built-in function ‘list_printers: List status of all
print servers’ (see page 66). Minimum privileges:
operators.
List the Print Display ring menu ‘wliq: List Queue’ on page 56 by
Queue invoking built-in function ‘wlistq: List the queue’ (see
page 71). Minimum privileges: operators.
Print a File Invoke built-in function ‘addq: Add entry to print or
dispatch queue’ (see page 62). Minimum privileges:
operators.
Monitor Printers Display ring menu ‘uq012: Monitor Printers’ on
page 54 by invoking built-in function ‘uqo: Monitor all
print servers’ (see page 70). Minimum privileges:
operators.
Printer Operations Display ring menu ‘wopq: Printer Operations’ on
page 57 by invoking built-in function ‘wopq: Display
Printer Operations menu’ (see page 72). Minimum
privileges: operators.
System Security Display menu ‘uq010: Security’ on page 50 by invoking
built-in function ‘security_sel: Display System Security
menu’ (see page 69). Minimum privileges: operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
49

Scheduler Display menu ‘uq011: Scheduler Management’ on


Management page 53. Minimum privileges: operators.
Configuration Display menu ‘uq013: Configuration’ on page 54.
Minimum privileges: implementors.
Change Location Invoke built-in function ‘set_queue: Change to another
Columbus OM instance’ (see page 69). Minimum
privileges: administrators.
Queue Maintenance Display menu ‘uq014: Queue Maintenance’ on
page 55. Minimum privileges: operators.
View Logs Display menu ‘uq027: View Logs’ on page 55.
Minimum privileges: operators.
Quit Exit from the uq menu interface.

uq002: Document Printing (print users)


Print a File Invoke built-in function ‘addq: Add entry to print or
dispatch queue’ (see page 62).
List the Print Display ring menu ‘wliq: List Queue’ on page 56 by
Queue invoking built-in function ‘wlistq: List the queue’ (see
page 71).
Printer Status List Invoke built-in function ‘list_printers: List status of all
print servers’ (see page 66).
Quit Exit from the uq menu interface.

uq008: Configure System Tables


System Defaults Invoke built-in function ‘mod_default: Configure
system defaults’ (see page 66). Minimum privileges:
implementors.
Group Maintenance Invoke built-in function ‘printer_groups: Configure
printer groups’ (see page 68). Minimum privileges:
implementors.
Netmaster Hosts Invoke built-in function ‘netmaster_hosts: Configure
Table hosts for netmaster’ (see page 67). Minimum privileges:
implementors.
Remote Printers Invoke built-in function ‘remote_table: Configure
Table remote printers’ (see page 68). Minimum privileges:
implementors.
Trusted Hosts Table Invoke built-in function ‘mod_cshosts: Configure
csuniq trusted hosts’ (see page 66). Minimum
privileges: implementors.
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


50 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

uq010: Security
Add name to list of Invoke built-in function ‘addname: Add name to list of
authorized users authorized users’ (see page 62).
Remove name from Invoke built-in function ‘remname: Remove name from
list of authorized list of authorized users’ (see page 68).
users
Allow access to all Invoke built-in function ‘addall: Allow all users access
other users to a function’ (see page 62).
Remove access from Invoke built-in function ‘remall: Remove access to
all individual function from all users’ (see page 68).
users
Quit Return to the previous menu.

The operations on this menu add and remove entries from the files which control
which users are authorised to perform which Columbus OM functions. The list of
controllable functions, taken from $UNIQDIR/security/security.tab, is:

Operator Privileges Update access control file operators. Minimum


privileges: operators.
Administrator Update access control file administrators. Minimum
Privileges privileges: administrators.
Implementor Update access control file implementors. Minimum
Privileges privileges: implementors.
Add entries for Update access control file aeq_o. Minimum privileges:
other user operators.
Modify entries for Update access control file aeq_mod. Minimum
any user privileges: operators.
Resubmit entries as Update access control file rsq_o. Minimum privileges:
your own operators.
Redirect a pending Update access control file mod_at.
queue entry
Redirect a Update access control file mod_at_c.
completed queue
entry
Full modification Update access control file modq_full. Minimum
privileges: operators.
List all in pending Update access control file liq_ap. Minimum privileges:
queue operators.
List all in either Update access control file liq_ao. Minimum privileges:
queue operators.
List queue for one Update access control file liq_1p. Minimum privileges:
printer only operators.
List specific Update access control file liq_o. Minimum privileges:
owner's entries operators.
View other owner's Update access control file liq_view. Minimum
entries privileges: administrators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
51

View entries of Update access control file liq_view_g. Minimum


others in group privileges: operators.
View your own Update access control file liq_view_o. Minimum
entries privileges: operators.
Display queue entry Update access control file liq_det. Minimum privileges:
details administrators.
Receive 'queue Update access control file wliq_warn. Minimum
tidy' message privileges: operators.
Remove any owner's Update access control file req_ao. Minimum privileges:
entries administrators.
Remove specific Update access control file req_o. Minimum privileges:
owner's entries operators.
Use of queue Update access control file aeq_p0. Minimum
priority 0 privileges: operators.
Use of queue Update access control file aeq_p1. Minimum
priority 1 privileges: operators.
Use of queue Update access control file aeq_p2. Minimum
priority 2 privileges: operators.
Use of queue Update access control file aeq_p3. Minimum
priority 3 privileges: operators.
Use of queue Update access control file aeq_p4. Minimum
priority 4 privileges: operators.
Use of queue Update access control file aeq_p5. Minimum
priority 5 privileges: operators.
Use of queue Update access control file aeq_p6. Minimum
priority 6 privileges: operators.
Use of queue Update access control file aeq_p7. Minimum
priority 7 privileges: operators.
Use of queue Update access control file aeq_p8. Minimum
priority 8 privileges: administrators.
Use of queue Update access control file aeq_p9. Minimum
priority 9 privileges: implementors.
Create a new Update access control file server_add. Minimum
printer privileges: implementors.
Modify an existing Update access control file server_mod. Minimum
printer privileges: implementors.
Delete an existing Update access control file server_rem. Minimum
printer privileges: implementors.
Abort any printout Update access control file opq_a. Minimum privileges:
operators.
Abort own printouts Update access control file opq_a_own. Minimum
only privileges: operators.
Cancel any printout Update access control file opq_c. Minimum privileges:
operators.
Cancel own Update access control file opq_c_own. Minimum
printouts only privileges: operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


52 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

Pause any printout Update access control file opq_p. Minimum privileges:
operators.
Pause own printouts Update access control file opq_p_own. Minimum
only privileges: operators.
Resume any printout Update access control file opq_r. Minimum privileges:
operators.
Resume own Update access control file opq_r_own. Minimum
printouts only privileges: operators.
Split any printout Update access control file opq_s. Minimum privileges:
operators.
Split own printouts Update access control file opq_s_own. Minimum
only privileges: operators.
Transfer any Update access control file opq_t. Minimum privileges:
printout operators.
Transfer own Update access control file opq_t_own. Minimum
printouts only privileges: operators.
Lineup a printer Update access control file opq_l. Minimum privileges:
operators.
Add a printer to a Update access control file opq_i. Minimum privileges:
class operators.
Delete a printer Update access control file opq_x. Minimum privileges:
from a class operators.
Disable a printer Update access control file opq_d. Minimum privileges:
operators.
Enable a printer Update access control file opq_e. Minimum privileges:
operators.
Duplicate a printer Update access control file opq_o. Minimum privileges:
implementors.
Add paper to a Update access control file opq_m. Minimum privileges:
printer operators.
Remove paper from a Update access control file opq_u. Minimum privileges:
printer operators.
Change printer Update access control file opq_v. Minimum privileges:
device administrators.
Kill a printer Update access control file opq_k. Minimum privileges:
server administrators.
Display system Update access control file syq_dd. Minimum
defaults privileges: operators.
Modify system Update access control file sysdef_mod. Minimum
defaults privileges: implementors.
Extend Completed Update access control file syq_ec. Minimum privileges:
queue administrators.
Extend Pending Update access control file syq_ep. Minimum
queue privileges: administrators.
Journal of Update access control file syq_jc. Minimum privileges:
Completed queue operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
53

Journal of Pending Update access control file syq_jp. Minimum privileges:


queue operators.
Fix Completed queue Update access control file syq_fc. Minimum privileges:
operators.
Fix Pending queue Update access control file syq_fp. Minimum privileges:
operators.
Start a print Update access control file syq_i. Minimum privileges:
server operators.
Stop a print server Update access control file syq_tn. Minimum privileges:
operators.
Purge Completed Update access control file syq_pc. Minimum
queue privileges: administrators.
Purge Pending queue Update access control file syq_pp. Minimum
privileges: administrators.
View Queue Update access control file syq_qs. Minimum
statistics privileges: operators.
View Server status Update access control file syq_s. Minimum privileges:
operators.
View Printer Update access control file printer_ops. Minimum
Operations privileges: administrators.
Force shutdown of Update access control file uqkill. Minimum privileges:
Columbus OM server administrators.

uq011: Scheduler Management


Start Scheduler Invoke built-in function ‘start_master: Start scheduler
on current queue’ (see page 69). Minimum privileges:
operators.
Stop Scheduler Invoke built-in function ‘stop_master: Stop scheduler
on current queue’ (see page 70). Minimum privileges:
operators.
Scheduler Status Invoke built-in function ‘master_status: Show status of
scheduler on current queue’ (see page 66). Minimum
privileges: operators.
# Start all Invoke built-in function ‘start_all_masters: Start
Schedulers scheduler on all queues’ (see page 69). Minimum
privileges: administrators.
# Stop all Invoke built-in function ‘stop_all_masters: Stop
Schedulers scheduler on all queues’ (see page 69). Minimum
privileges: administrators.
# All Scheduler Invoke built-in function ‘all_master_status: Show status
Status of scheduler on all queues’ (see page 62). Minimum
privileges: administrators.
Start Server Invoke built-in function ‘start_server: Start server’ (see
page 69). Minimum privileges: operators.
Stop Server Invoke built-in function ‘stop_server: Stop server’ (see
page 70). Minimum privileges: operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


54 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

Server Status Invoke built-in function ‘server_stats: Display status of


server’ (see page 69). Minimum privileges: operators.
Start all Servers Invoke built-in function ‘start_all_servers: Start all
servers’ (see page 69). Minimum privileges: operators.
Stop all Servers Invoke built-in function ‘stop_all_servers: Stop all
servers’ (see page 70). Minimum privileges: operators.
All Server Status Invoke built-in function ‘all_server_stats: Show status of
all servers’ (see page 62). Minimum privileges:
operators.
Quit Return to the previous menu.

uq012: Monitor Printers


Scheduler Display menu ‘uq011: Scheduler Management’ on
page 53.
ListQ Display ring menu ‘wliq: List Queue’ on page 56 by
invoking built-in function ‘wlistq: List the queue’ (see
page 71).
Operations Display ring menu ‘wopq: Printer Operations’ on
page 57 by invoking built-in function ‘wopq: Display
Printer Operations menu’ (see page 72).
Detail Invoke built-in function ‘server_setup: Display server
configuration (any server)’ (see page 69).
# Detail Invoke built-in function ‘printer_setup: Display print
server configuration’ (see page 68).

uq013: Configuration
Add a Printer Invoke built-in function ‘add_print_server: Configure
new print server’ (see page 62). Minimum privileges:
implementors.
Duplicate a Printer Invoke built-in function ‘dup_server: Duplicate server’
(see page 65). Minimum privileges: implementors.
Modify a Printer Invoke built-in function ‘mod_print_server: Configure
print server’ (see page 67). Minimum privileges:
implementors.
Remove a Printer Invoke built-in function ‘del_server: Delete server’ (see
page 64). Minimum privileges: implementors.
Enable a Printer Invoke built-in function ‘enable_printer: Enable print
server’ (see page 65). Minimum privileges:
implementors.
Modify Print Invoke built-in function ‘mod_scheduler: Configure
Scheduler scheduler’ (see page 67). Minimum privileges:
implementors.
Add Other Server Invoke built-in function ‘add_server: Configure new
general server’ (see page 62). Minimum privileges:
implementors.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
55

Modify Other Server Invoke built-in function ‘mod_server: Configure


general server’ (see page 67). Minimum privileges:
implementors.
Paper Type Invoke built-in function ‘paper_types: Configure paper
Definition type’ (see page 67). Minimum privileges:
implementors.
Printer Type Invoke built-in function ‘define_printer: Configure
Definition printer type’ (see page 64). Minimum privileges:
implementors.
Serial Line Invoke built-in function ‘mod_ldef: Configure serial
Definition lines’ (see page 66). Minimum privileges:
implementors.
Configure System Display menu ‘uq008: Configure System Tables’ on
Tables page 49. Minimum privileges: implementors.
# Create an Archive Invoke command uq_mkarchive. Minimum privileges:
Queue implementors.
Quit Return to the previous menu.

uq014: Queue Maintenance


Extend Pending Invoke built-in function ‘ext_pending: Extend Pending
Queue queue’ (see page 65). Minimum privileges:
administrators.
Extend Completed Invoke built-in function ‘ext_complete: Extend
Queue Completed queue’ (see page 65). Minimum privileges:
administrators.
Purge Pending Queue Invoke built-in function ‘purge_pending: Purge
Pending queue’ (see page 68). Minimum privileges:
administrators.
Purge Completed Invoke built-in function ‘purge_complete: Purge
Queue Completed queue’ (see page 68). Minimum privileges:
administrators.
Fix Pending Queue Invoke built-in function ‘fix_pending: Fix Pending
queue’ (see page 65). Minimum privileges: operators.
Fix Completed Queue Invoke built-in function ‘fix_complete: Fix Completed
queue’ (see page 65). Minimum privileges: operators.
Queue Statistics Invoke built-in function ‘queue_stats: Display queue
statistics’ (see page 68). Minimum privileges:
operators.
Quit Return to the previous menu.

uq027: View Logs


# Day Log Invoke built-in function ‘view_day_log: View day log
by page’ (see page 70).
# Error Log Invoke built-in function ‘view_err_log: View error log
by page’ (see page 70).

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


56 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

# Output Invoke built-in function ‘view_output: View output log


by page’ (see page 70).
Day Log Invoke built-in function ‘browse_day_log: Browse day
log’ (see page 63).
Error Log Invoke built-in function ‘browse_err_log: Browse error
log’ (see page 63).
Output Invoke built-in function ‘browse_output: Browse output
log’ (see page 63).
Quit Return to the previous menu.

wliq: List Queue


Printers Invoke built-in function ‘list_printers: List status of all
print servers’ (see page 66).
# Add Invoke built-in function ‘wliq_addq: Add entry to print
queue’ (see page 70).
Modify Invoke built-in function ‘wliq_modq: Modify current
print queue entry’ (see page 71).
Remove Invoke built-in function ‘wliq_remq: Remove current
entry from queue’ (see page 71).
Hold Invoke built-in function ‘wliq_hold: Put current entry
on hold’ (see page 70).
Release Invoke built-in function ‘wliq_relq: Release current
HELD entry’ (see page 71).
Resubmit Invoke built-in function ‘wliq_resq: Resubmit current
entry’ (see page 71).
Redirect Invoke built-in function ‘wliq_redir: Redirect current
entry to another queue’ (see page 71). Minimum
privileges: administrators.
Location Invoke built-in function ‘wliq_setq: Change to another
Columbus OM instance’ (see page 71). Minimum
privileges: administrators.
View Invoke built-in function ‘wliq_view: View document
file for current entry’ (see page 71).
Errors Invoke built-in function ‘wliq_error: View stderr stream
for current entry’ (see page 70).
Search Display menu ‘wliq3: Search Options’ on page 57 by
invoking built-in function ‘wliq_options: Display
Search Options menu’ (see page 71).
Attributes Invoke built-in function ‘si_detail: Display server
information for current entry’ (see page 69).
Why? Query the status of the current queue entry.
# Edit Modify the Columbus OM file containing the current
queue entry.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
57

wliq3: Search Options


Restrict OWNER Invoke built-in function ‘chg_owner: Select specific
owner’ (see page 64). Minimum privileges: liq_o.
Show all OWNERS Invoke built-in function ‘any_owner: Select any owner’
(see page 63). Minimum privileges: liq_ao.
Show all OWNERS in Invoke built-in function ‘any_pending: Select any
pending queue owner in Pending, current owner in Completed’ (see
page 63). Minimum privileges: liq_ap.
Restrict FILENAME Invoke built-in function ‘chg_filename: Select specific
filename’ (see page 64).
Show all FILENAMES Invoke built-in function ‘any_filename: Select any
filename’ (see page 63).
Restrict SETUP Invoke built-in function ‘chg_form: Select specific
(paper type) paper type’ (see page 64).
Show all SETUPS Invoke built-in function ‘any_info: Select any server
(paper types) information’ (see page 63).
Restrict ADDRESS Invoke built-in function ‘chg_address: Select specific
(printer/class) address’ (see page 64).
Show all ADDRESSES Invoke built-in function ‘any_address: Select any
(printers/classes) address’ (see page 62).
Add a STATUS Invoke built-in function ‘new_status: Impose restriction
restriction on status code’ (see page 67).
Remove a STATUS Invoke built-in function ‘rem_status: Lift restriction on
restriction status code’ (see page 68).
Allow all STATUSES Invoke built-in function ‘any_status: Select any status
code’ (see page 63).
Quit Return to the previous menu.

wopq: Printer Operations


Enable Invoke built-in function ‘wopq_enable: Enable print
server’ (see page 72). Minimum privileges: operators.
EnaAll Invoke built-in function ‘wopq_enable_all: Enable all
print servers’ (see page 73). Minimum privileges:
administrators.
Disable Invoke built-in function ‘wopq_disable: Disable print
server’ (see page 72). Minimum privileges: operators.
DisAll Invoke built-in function ‘wopq_disable_all: Disable all
print servers’ (see page 72). Minimum privileges:
administrators.
Abort Invoke built-in function ‘wopq_abort: Abort printout’
(see page 72). Minimum privileges: operators.
Cancel Invoke built-in function ‘wopq_cancel: Cancel printout’
(see page 72). Minimum privileges: operators.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


58 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

Realign Invoke built-in function ‘wopq_lineup: Line up paper’


(see page 73). Minimum privileges: operators.
Pause Invoke built-in function ‘wopq_pause: Pause print
server’ (see page 73). Minimum privileges: operators.
Resume Invoke built-in function ‘wopq_continue: Continue
paused print server’ (see page 72). Minimum privileges:
operators.
Backup Invoke built-in function ‘wopq_backup: Back up
printout’ (see page 72). Minimum privileges: operators.
Advance Invoke built-in function ‘wopq_advance: Advance
printout’ (see page 72). Minimum privileges: operators.
Gotopage Invoke built-in function ‘wopq_goto_page: Reposition
printout’ (see page 73). Minimum privileges: operators.
Split Invoke built-in function ‘wopq_split: Split printout onto
another print server’ (see page 73). Minimum
privileges: operators.
Transfer Invoke built-in function ‘wopq_transfer: Transfer
printout to another print server’ (see page 73).
Minimum privileges: operators.
Class Display menu ‘wopq1: Class Maintenance’ below.
Minimum privileges: operators.
Paper Display menu ‘wopq2: Paper Maintenance’ on page 59.
Scheduler Display menu ‘uq011: Scheduler Management’ on
page 53. Minimum privileges: operators.
Location Invoke built-in function ‘wopq_setq: Change to another
Columbus OM instance’ (see page 73). Minimum
privileges: administrators.
Monitor Display ring menu ‘uq012: Monitor Printers’ on
page 54 by invoking built-in function ‘uqo: Monitor all
print servers’ (see page 70). Minimum privileges:
operators.
ListQ Display ring menu ‘wliq: List Queue’ on page 56 by
invoking built-in function ‘wlistq: List the queue’ (see
page 71).

wopq1: Class Maintenance


Add a Printer to a Invoke built-in function ‘wopq_create_alias: Add print
Class server to class’ (see page 72).
Remove a Printer Invoke built-in function ‘wopq_remove_alias: Remove
from a Class print server from class’ (see page 73).
List the Printers Invoke built-in function ‘list_aliases: List print servers in
in a Class class’ (see page 66).
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus
59

wopq2: Paper Maintenance


Add Paper Type Invoke built-in function ‘wopq_add_paper: Mount
paper’ (see page 72).
Remove Paper Type Invoke built-in function ‘wopq_rem_paper: Unmount
paper’ (see page 73).
Change Paper Type Invoke built-in function ‘wopq_change_paper: Change
and line up paper’ (see page 72).
Quit Return to the previous menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


60 CHAPTER 3 ■
Standard Columbus OM menu structure ■
Print instance menus

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


61

CHAPTER 4

Chapter 4 Built-in functions

The uq menu interface invokes the built-in functions to perform almost all
Columbus OM control and administration tasks.

‘A functions’ on page 62

‘B functions’ on page 63

‘C functions’ on page 63

‘D functions’ on page 64

‘E functions’ on page 65

‘F G and H functions’ on page 65

‘I J and K functions’ on page 65

‘L functions’ on page 66

‘M functions’ on page 66

‘N functions’ on page 67

‘O P and Q functions’ on page 67

‘R functions’ on page 68

‘S functions’ on page 69

‘T U and V functions’ on page 70

‘W functions’ on page 70

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


62 CHAPTER 4 ■
Built-in functions ■
A functions

A functions
abort_print: Abort printout

Invoke the opq -a command.


add_fax_server: Configure new fax server

Update files in $UNIQDIR/servers/.


add_net_server: Configure new net server

Update files in $UNIQDIR/servers/.


add_paper: Mount paper

Invoke the opq -m command.


add_print_server: Configure new print server

Update files in $UNIQDIR/servers/.


add_server: Configure new general server

Update files in $UNIQDIR/servers/.


add_vts_server: Configure new VTS server

Update files in $UNIQDIR/servers/.


addall: Allow all users access to a function

Update files in $UNIQDIR/security/. May be placed only on the System


Security menu uq010.menu.
addfq: Add entry to fax queue

Invoke the afq command.


addname: Add name to list of authorized users

Update files in $UNIQDIR/security/. May be placed only on the System


Security menu uq010.menu.
addq: Add entry to print or dispatch queue

Invoke the aeq command.


advance: Advance printout

Invoke the opq -r command.


all_master_status: Show status of scheduler on all queues

Invoke the syq -s server command.


all_server_stats: Show status of all servers

Invoke the syq -as command.


any_address: Select any address

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
B functions
63

any_filename: Select any filename

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
any_info: Select any server information

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
any_medium: Select any medium

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
any_owner: Select any owner

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
any_pending: Select any owner in Pending, current owner in Completed

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
any_status: Select any status code

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.

B functions
back_up: Back up printout

Invoke the opq -r command.


browse_day_log: Browse day log

Display the contents of $UNIQDIR/servers/server/dayDD.log.


browse_err_log: Browse error log

Display the contents of $UNIQDIR/servers/server/error.log, driver.err and


output.txt.

browse_output: Browse output log

Display the contents of $UNIQDIR/servers/server/activity.log,


background.job, driver.log and output.txt.

build_rolo: Build ROLO configuration

Update files in $UNIQDIR/rolo/.

C functions
cancel_print: Cancel printout

Invoke the opq -c command.


change_paper: Change and lineup paper

Invoke the appropriate commands.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


64 CHAPTER 4 ■
Built-in functions ■
D functions

chg_address: Select specific address

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
chg_filename: Select specific filename

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
chg_font: Change font

Invoke the apq -f command.


chg_form: Select specific paper type

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
chg_hopper: Change hopper

Invoke the apq -hp command.


chg_info: Select specific server information

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
chg_orient: Change orientation

Invoke the apq -or command.


chg_owner: Select specific owner

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
chg_paper: Change paper without line up

Invoke the opq -m command.


chg_pitch: Change pitch

Invoke the apq -pt command.


continue_print: Continue paused printout

Invoke the opq -r command.


create_alias: Add print server to class

Invoke the opq -i command.

D functions
define_printer: Configure printer type

Update files in $UNIQDIR/media/print/.


del_server: Delete server

Update files in $UNIQDIR/servers/.


disable_all: Disable all print servers

Invoke the opq -d command for all printers.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
E functions
65

disable_printer: Disable print server

Invoke the opq -d command.


dup_rolo: Duplicate ROLO configuration

Update files in $UNIQDIR/rolo/.


dup_server: Duplicate server

Invoke the opq -o command.

E functions
edit_rolo: Modify ROLO configuration

Update files in $UNIQDIR/rolo/.


enable_all: Enable all print servers

Invoke the opq -e command for all printers.


enable_printer: Enable print server

Invoke the opq -e command.


ext_complete: Extend Completed queue

Invoke the syq -ec command.


ext_pending: Extend Pending queue

Invoke the syq -ep command.

F G and H functions
fax_shortcodes: Configure fax shortcodes

Update files in $UNIQDIR/media/fax/shortcds/.


fix_complete: Fix Completed queue

Invoke the syq -fc command.


fix_pending: Fix Pending queue

Invoke the syq -fp command.


freq_macros: Define macros for user-defined frequencies

Update $UNIQDIR/config/fmacro.tab.
goto_page: Go to specific page

Invoke the opq -r command.


hold: Put queue entry on hold

Invoke the aeq -h command.

I J and K functions
install_rolo: Install ROLO configuration

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


66 CHAPTER 4 ■
Built-in functions ■
L functions

Update files in $UNIQDIR/rolo/.


kill_server: Kill server

Invoke the opq -k command.

L functions
lineup: Line up active printout

Invoke the opq -l command.


list_aliases: List print servers in class

Display information from $UNIQDIR/servers/alias.tab.


list_fax_servers: List status of all fax servers

Invoke the syq -as command.


list_printers: List status of all print servers

Invoke the syq -as command.


list_rolo: List ROLO configurations

Display information from $UNIQDIR/rolo/.


listq: List the queue

Invoke the liq command (with -ao -ap if those options are available to the
user).
listq_ao: List the queue

Invoke the liq command (with -ao if that option is available to the user).
listq_ap: List the queue

Invoke the liq command (with -ap if that option is available to the user).

M functions
master_status: Show status of scheduler on current queue

Invoke the syq -s server command.


mod_cshosts: Configure csuniq trusted hosts

Update $UNIQDIR/config/chosts.tab.
mod_default: Configure system defaults

Update $UNIQDIR/config/default.tab.
mod_fax_server: Configure fax server

Update files in $UNIQDIR/servers/.


mod_ldef: Configure serial lines

Update files in $UNIQDIR/servers/.


mod_net_server: Configure net server

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
N functions
67

Update files in $UNIQDIR/servers/.


mod_print_server: Configure print server

Update files in $UNIQDIR/servers/.


mod_scheduler: Configure scheduler

Update files in $UNIQDIR/servers/.


mod_server: Configure general server

Update files in $UNIQDIR/servers/.


mod_uqvars: Modify Columbus OM system variables

Update $UNIQDIR/config/uqvar.tab.
mod_vts_server: Configure VTS server

Update files in $UNIQDIR/servers/.


modfq: Modify fax queue entry

Invoke the afq command.


modq: Modify print or dispatch queue entry

Invoke the aeq command.

N functions
net_listq: List remote queue

Obsolete.
net_run_uq: Display Columbus OM menu on remote queue

Obsolete.
net_uqo: Monitor remote queue

Obsolete.
net_wlistq: List remote queue

Obsolete.
netmaster_hosts: Configure hosts for netmaster

Update $UNIQDIR/config/nmhosts.tab.
new_medium: Impose restriction on medium

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
new_status: Impose restriction on status code

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.

O P and Q functions
paper_types: Configure paper type

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


68 CHAPTER 4 ■
Built-in functions ■
R functions

Update files in $UNIQDIR/media/paper/.


pause_print: Pause printout

Invoke the opq -p command.


printer_groups: Configure printer groups

Update files in $UNIQDIR/media/groups/.


printer_setup: Display print server configuration

Invoke the opq -q command.


purge_complete: Purge Completed queue

Invoke the syq -pc command.


purge_pending: Purge Pending queue

Invoke the syq -pp command.


queue_stats: Display queue statistics

Invoke the syq -qs command.

R functions
redirect: Redirect entry to another queue

Invoke the aeq command.


release: Release HELD queue entry

Invoke the aeq -r command.


rem_medium: Lift restriction on medium

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
rem_paper: Unmount paper

Invoke the opq -u command.


rem_rolo: Remove ROLO configuration

Update files in $UNIQDIR/rolo/.


rem_status: Lift restriction on status code

Set wliq command options to control which queue entries are listed. May be
placed only on the Search Options menu wliq3.menu.
remall: Remove access to function from all users

Update files in $UNIQDIR/security/. May be placed only on the System


Security menu uq010.menu.
remname: Remove name from list of authorized users

Update files in $UNIQDIR/security/. May be placed only on the System


Security menu uq010.menu.
remote_table: Configure remote printers

Update $UNIQDIR/config/remote.tab.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
S functions
69

remove_alias: Remove print server from class

Invoke the opq -x command.


remq: Remove entry

Invoke the req command.


remq_ao: Remove entry

Invoke the req command (with -ao if that option is available to the user).
remq_force: Remove entry

Invoke the req -f command (with -ao if that option is available to the user).
resubmit: Resubmit entry

Invoke the rsq command.

S functions
security_sel: Display System Security menu

Display the appropriate System Security menu uq010.menu.


server_setup: Display server configuration (any server)

Invoke the opq -q command.


server_stats: Display status of server

Invoke the syq -s command.


set_queue: Change to another Columbus OM instance

Set the -qn command option.


show_queue: Display name of current queue

Display the name of the Columbus OM instance defined by $UNIQDIR.


si_detail: Display server information for current entry

Invoke the wliq command to display queue entry information. May be placed
only on the List Queue menu wliq.ring.
split_print: Split printout onto another print server

Invoke the opq -s command.


start_all_masters: Start scheduler on all queues

Invoke the syq -i server command.


start_all_servers: Start all servers

Invoke the syq -ai command.


start_master: Start scheduler on current queue

Invoke the syq -i server command.


start_server: Start server

Invoke the syq -i command.


stop_all_masters: Stop scheduler on all queues

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


70 CHAPTER 4 ■
Built-in functions ■
T U and V functions

Invoke the syq -t server command.


stop_all_servers: Stop all servers

Invoke the syq -at command.


stop_master: Stop scheduler on current queue

Invoke the syq -t server command.


stop_server: Stop server

Invoke the syq -t command.

T U and V functions
transfer_print: Transfer printout to another print server

Invoke the opq -t command.


uqo: Monitor all print servers

Invoke the liq command.


uqt: Monitor all fax servers

Invoke the liq command.


view_day_log: View day log by page

Display the contents of $UNIQDIR/servers/server/dayDD.log.


view_err_log: View error log by page

Display the contents of $UNIQDIR/servers/server/error.log, driver.err and


output.txt.

view_output: View output log by page

Display the contents of $UNIQDIR/servers/server/activity.log,


background.job, driver.log and output.txt.

W functions
wliq_addfq: Add entry to fax queue

Invoke the afq command. May be placed only on the List Queue menu
wliq.ring.

wliq_addq: Add entry to print queue

Invoke the apq command. May be placed only on the List Queue menu
wliq.ring.

wliq_error: View stderr stream for current entry

Display the contents of $UNIQDIR/queue/document/xentry_id.err. May be


placed only on the List Queue menu wliq.ring.
wliq_hold: Put current entry on hold

Invoke the aeq -h command. May be placed only on the List Queue menu
wliq.ring.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
W functions
71

wliq_modfq: Modify current fax queue entry

Invoke the afq command. May be placed only on the List Queue menu
wliq.ring.

wliq_modq: Modify current print queue entry

Invoke the apq command. May be placed only on the List Queue menu
wliq.ring.

wliq_notify: Notify stream to continue

Invoke the opq -n command. May be placed only on the List Queue menu
wliq.ring.

wliq_options: Display Search Options menu

Display the Search Options menu wliq3.menu.


wliq_output: View stdout stream for current entry

Display the contents of $UNIQDIR/queue/document/xentry_id.out. May be


placed only on the List Queue menu wliq.ring.
wliq_redir: Redirect current entry to another queue

Invoke the aeq command. May be placed only on the List Queue menu
wliq.ring.

wliq_relq: Release current HELD entry

Invoke the aeq -r command. May be placed only on the List Queue menu
wliq.ring.

wliq_remq: Remove current entry from queue

Invoke the req command. May be placed only on the List Queue menu
wliq.ring.

wliq_resq: Resubmit current entry

Invoke the rsq command. May be placed only on the List Queue menu
wliq.ring.

wliq_setq: Change to another Columbus OM instance

Set the -qn command option. May be placed only on the List Queue menu
wliq.ring.

wliq_view: View document file for current entry

Invoke the browse command. May be placed only on the List Queue menu
wliq.ring.

wlistq: List the queue

Invoke the wliq command (with -ao -ap if those options are available to the
user).
wlistq_ao: List the queue

Invoke the wliq command (with -ao if that option is available to the user).
wlistq_ap: List the queue

Invoke the wliq command (with -ap if that option is available to the user).

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


72 CHAPTER 4 ■
Built-in functions ■
W functions

wlistq_cl: List remote queue in client mode

Invoke the wliq command to list the remote queue in client (local) mode (with
-ao -ap if those options are available to the user).

wlistq_loc: List the client queue

Invoke the wliq command to list the client (local) queue (with -ao -ap if
those options are available to the user).
wopq: Display Printer Operations menu

Display the Printer Operations menu wopq.menu.


wopq_abort: Abort printout

Invoke the opq -a command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_add_paper: Mount paper

Invoke the opq -m command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_advance: Advance printout

Invoke the opq -r command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_backup: Back up printout

Invoke the opq -r command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_cancel: Cancel printout

Invoke the opq -c command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_change_paper: Change and line up paper

Invoke the appropriate commands. May be placed only on the Printer


Operations menu wopq.menu.
wopq_continue: Continue paused print server

Invoke the opq -r command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_create_alias: Add print server to class

Invoke the opq -i command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_disable: Disable print server

Invoke the opq -d command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_disable_all: Disable all print servers

Invoke the opq -d command for all printers. May be placed only on the
Printer Operations menu wopq.menu.
wopq_enable: Enable print server

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 4 ■
Built-in functions ■
W functions
73

Invoke the opq -e command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_enable_all: Enable all print servers

Invoke the opq -e command for all printers. May be placed only on the
Printer Operations menu wopq.menu.
wopq_goto_page: Reposition printout

Invoke the opq -r command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_lineup: Line up paper

Invoke the opq -l command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_pause: Pause print server

Invoke the opq -p command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_rem_paper: Unmount paper

Invoke the opq -u command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_remove_alias: Remove print server from class

Invoke the opq -x command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_setq: Change to another Columbus OM instance

Set the -qn command option. May be placed only on the Printer Operations
menu wopq.menu.
wopq_split: Split printout onto another print server

Invoke the opq -s command. May be placed only on the Printer Operations
menu wopq.menu.
wopq_transfer: Transfer printout to another print server

Invoke the opq -t command. May be placed only on the Printer Operations
menu wopq.menu.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


74 CHAPTER 4 ■
Built-in functions ■
W functions

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


75

CHAPTER 5

Chapter 5 System files

This chapter provides definitions of the following files which are used only by the
uq menu interface (for details of general Columbus OM files, see the Technical
Reference manual):

‘menu.fkey: Function key assignments’ on page 76
■ ‘menu.menu: Vertical menu definitions’ on page 77

‘menu.ring: Horizontal menu definitions’ on page 78
■ ‘terminal_type: Source terminal definitions’ on page 78

‘terminal_type.def: Browser terminal definitions’ on page 78
■ ‘terminal_type.ttp: Compiled terminal definitions’ on page 79

‘fkey.tab: Function key classification’ on page 79
■ ‘report.def: Browser print specification’ on page 80

‘uqadm.menu, uqimp.menu, uqops.menu, uquser.menu’ on page 81
■ ‘wliqsum.tab: Queue display format’ on page 82

‘wopqsum.tab: Printer status display format’ on page 82

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


76 CHAPTER 5 ■
System files ■
menu.fkey: Function key assignments

menu.fkey: Function key assignments


$UNIQDIR/menus/menu.fkey defines the function keys associated with a menu.

Structure
Blank lines: significant. Comments: hash (#) at start. Continuation: none.

Content
The file contains three blocks of ten lines. The first block is used with terminals
classified as type 0 (no function keys) in $UNIQDIR/menus/fkey.tab, the second
block applies to type 1 terminals (standard ANSI function keys), and the third
block is for type 2 terminals (enhanced ANSI function keys).
A block contains exactly ten lines, giving the designations for keys F1 through F10,
where each line is either blank, or contains exactly fourteen characters. Each
14_char_string is displayed as two strings of seven characters, one above the
other; by convention, the upper string is the left-aligned key identification, and the
lower string is the right-aligned functional description.

Example
# Esc N (default)
esc 1: Help
esc 2: AutoHlp

esc 4: EditOpt
Tab: Next
Backtab Prev
esc 7: List Q
esc 8: List
esc 9: Commit
esc 0: Quit
#
# F1-F10 (ANSII)
F1: Help
F2:Auto Help

F4:EditOptions
Tab: Next
Backtab Prev
F7: List Q
F8: List
F9: Commit
F10: Quit
#
# Do/PF4 (Enhanced ANSII)
Help: Help
F7:Auto Help

F9:EditOptions
Tab: Next
Backtab Prev
F12: List Q
F13: List
Do: Commit
PF4: Quit

See also
■ ‘fkey.tab: Function key classification’ on page 79

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 5 ■
System files ■
menu.menu: Vertical menu definitions
77

menu.menu: Vertical menu definitions


$UNIQDIR/menus/menu.menu contains the definition of a vertical menu.

The same structure is also used for another class of files:



$UNIQDIR/menus/menu.ring contains the definition of a horizontal (ring)
menu, on which the menu title is always a null string.

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: tilde (~) at end.

Content
The file starts with a line specifying the menu title, enclosed in quotes "..." if it
contains spaces or is null. Two optional numbers give the horizontal and vertical
offsets of the first character of the first menu option, with a minimum value of 2 and
a maximum determined by the size of the menu; if the values are zero or null, the
menu is centred. This is followed by one line for each option on the menu, with
four space-separated fields.
string

The option text to be displayed on the menu, enclosed in quotes "..." if it


contains spaces.
action

The Columbus OM action invoked when this option is selected.


MEN|BIF|SHELL|COM|WINrrcc

The action type; one of:

MEN display a sub-menu.


BIF (the default) invoke a Columbus OM function. See ‘Built-in
functions’ on page 61.
SHELL execute a UNIX command, then redisplay the menu.
COM execute a UNIX command, then display the message “Hit any
Key to Return to Menu”.
WINrrcc execute a UNIX command in a window of rr rows and cc
columns (both must be two-digit numbers), then display the
message “Hit any Key to Acknowledge”.
access_file

The file in $UNIQDIR/security which determines which users may access this
option; the option is not displayed for users who are not (directly or indirectly)
listed in the access_file. If omitted, or if the file is empty, all users have
access.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


78 CHAPTER 5 ■
System files ■
menu.ring: Horizontal menu definitions

Example
"Main Menu"

"Printer Status List" list_printers BIF operators


"List the Print Queue" wlistq BIF operators
"Print a File" addq BIF operators
"Monitor Printers" uqo BIF operators
"Printer Operations" wopq BIF operators
"System Security" security_sel BIF operators
"Scheduler Management" uq011 MEN operators
"Configuration" uq013 MEN implementors
"Change Location" set_queue BIF administrators
"Queue Maintenance" uq014 MEN operators
"View Logs" uq027 MEN operators
"Quit" quit

menu.ring: Horizontal menu definitions


$UNIQDIR/menus/menu.ring contains the definition of a horizontal (ring) menu.

For details of the structure of this file, see ‘menu.menu: Vertical menu definitions’
on page 77.
Note Because of the limited space available for a horizontal menu, the strings
giving the option text to be displayed on the menu should be restricted to
single-word mnemonics not longer than ten characters.

terminal_type: Source terminal definitions


$UNIQDIR/uniform/ttp/source/terminal_type contains the definition (in source
format) of the characteristics of terminal_type terminals, for use by the uq
command which starts the menu interface.

Structure
Blank lines: ignored. Comments: characters /* at start. Continuation: none.

Content
A uq terminal definition file is divided into a number of logical blocks. Each block
starts with the keyword BEGIN, contains a related set of specification statements,
and is terminated by the keyword END. A specification statement occupies a single
line.

Example
See ‘Creating a definition for uq’ on page 20.

See also
■ ‘terminal_type.ttp: Compiled terminal definitions’ on page 79

terminal_type.def: Browser terminal definitions


$UNIQDIR/browser/terminal_type.def contains the definition of the
characteristics of terminal_type terminals, for use by the browse command.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 5 ■
System files ■
terminal_type.ttp: Compiled terminal definitions
79

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: none.

Content
A browser terminal definition file is divided into a number of logical blocks. A
specification statement occupies a single line.

Example
See ‘Creating a definition for the browser’ on page 26.

terminal_type.ttp: Compiled terminal definitions


$UNIQDIR/uniform/ttp/terminal_type.ttp contains the compiled definition of the
characteristics of terminal_type terminals, for use by the uq command which starts
the menu interface. This is a binary file, created from the corresponding source file
$UNIQDIR/uniform/ttp/source/terminal_type with the ufct command.

See also

‘terminal_type: Source terminal definitions’ on page 78

fkey.tab: Function key classification


$UNIQDIR/menus/fkey.tab classifies supported terminal types according to their
function key labelling.

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: tilde (~) at end.

Content
The file contains one line for each terminal type, with two space-separated fields:
terminal_type

The name of the terminal type, as set in $TERM or $UNIQTERM.


0|1|2

The classification of the terminal type; one of:

0 The terminal has no function keys; the equivalent functionality can be


obtained only by pressing ESC followed by a digit 1 through 0.
1 The terminal has standard ANSI function keys labelled “F1” through
“F10”.
2 The terminal has enhanced ANSI function keys labelled “Help”, “F7”
through “F13”, “Do” and “PF4”.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


80 CHAPTER 5 ■
System files ■
report.def: Browser print specification

Example
# Terminal Mapping
# -------- -------
a230 1
aixterm 1
dtterm 1
hp220 1
hpterm 1
ibm3151 1
m303 1
pt200 1
sun-cmd 1
vt100 1
vt220 1
vt420 1
xterm 1
xterm2 1
#
hp700 2
wyse60 2

See also

‘menu.fkey: Function key assignments’ on page 76

report.def: Browser print specification


$UNIQDIR/browser/report.def contains print specification data, for use by the
browse command.

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: none.

Content
The file contains five lines:
INITP ??

Defines the character sequence which when detected at the start of a file
switches into FORTRAN print mode.
RESETP

Defines the character sequence which when detected switches out of


FORTRAN print mode.
FORMFEED 1

Defines the character which when detected in column one causes a formfeed in
FORTRAN print mode.
PAGESIZE 60

The default number of lines per page; may be over-ridden by the -page option.
MAXPAGE 9999

The maximum number of pages that can be browsed. This value can be
increased if required.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 5 ■
System files ■
uqadm.menu, uqimp.menu, uqops.menu, uquser.menu
81

Example
INITP ??
RESETP
FORMFEED 1
PAGESIZE 60
MAXPAGE 9999

uqadm.menu, uqimp.menu, uqops.menu,


uquser.menu
$UNIQDIR/menus/uqXXX.menu defines the top-level menus displayed by the uq
command. There are four such menus:

uqadm.menu for users with administrators privileges
■ uqimp.menu for users with implementors privileges

uqops.menu for users with operators privileges
■ uquser.menu for users without any of those privileges.

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: none.

Content
The file contains a single line, with two space-separated fields.
menu

The name of the top-level menu for this class of user, corresponding to a
definition contained in file $UNIQDIR/menus/menu.menu.
string

The title text to be displayed at the head of the menu, enclosed in quotes "..."
if it contains spaces.

Usage
uq checks your user_id against the contents of the implementors, administrators
and operators files in $UNIQDIR/security to establish your personal level of
authorisation. The outcome of that evaluation determines:

which of the files uqimp.menu, uqadm.menu, uqops.menu and uquser.menu
defines your initial uq menu

which options to include when displaying any of the menus.

Example
uq001 "Columbus OM Implementors Menu"

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


82 CHAPTER 5 ■
System files ■
wliqsum.tab: Queue display format

wliqsum.tab: Queue display format


$UNIQDIR/config/wliqsum.tab defines the default display format used for queue
displays in the uq menu interface, which presents each queue entry on a separate
line, divided into columns displaying the entry’s attributes in the format and
sequence which you specify here. The display is generated by the wliq command,
a variant of the liq command.

Example
# Column Column Column Format or Trailing
# Name Title Width Justification Spaces
# ----------- ----------- ------ ------------- --------
UID Entry 5 R 1
OWNER Owner 5 L 1
NAME Document 14 L 1
PAGES Pages 5 R 1
DESTINATION Printer 10 L 1
PAPER Paper 8 L 1
DATE 'Date ' 0 'DD MON' 1
DATE 'Time ' 0 'HH:MI' 1
STATUS Status 9 L 1

wopqsum.tab: Printer status display format


$UNIQDIR/config/wopqsum.tab defines the default display format used for print
server displays in the uq menu interface, which presents each server on a separate
line, divided into columns displaying the server’s status in the format and sequence
which you specify here. The display is generated by the wopq command, a variant
of the opq command.

Structure
Blank lines: ignored. Comments: hash (#) at start. Continuation: tilde (~) at end.

Content
The file contains one line for each attribute to be displayed; the sequence of the
lines in this file determines the order of the columns across the display. Any
column which would cause the display to exceed 80 characters is silently ignored.
Each line has six space-separated fields.
attribute

The name of the attribute to be displayed in this column, listed in ‘Displayable


attributes’ on page 83.
title

The text to be displayed at the head of the column, enclosed in quotes "..." if
it contains spaces. A title which is shorter than width is aligned according to
format; one which is longer than width is truncated.

width

The number of character positions occupied by this column.


format

L to left-align the attribute value within the specified width, R to right-align it.
An attribute value which is longer than width is truncated.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


CHAPTER 5 ■
System files ■
wopqsum.tab: Printer status display format
83

YES|NO

YES to update the display in Monitoring mode if a value in this column


changes; NO otherwise.
padding

The number of blank character positions between this column and the next.
The default is 1; a value of zero is permitted.

Displayable attributes
The following attributes of a print server may be selected for display. Note that you
should specify SERVER as the first column; otherwise, the system automatically
inserts such a specification of its own.
ACTIVE

Either ACTIVE or inactive.


CONFIG.name

The value of the server’s configuration parameter name.


ENABLED

Either ENABLED or disabled.


FILENAME

The source document currently being processed.


LAST_ACTIVE

The time (hh:mm) at which the server was last active.


PAGE

The number of the page currently being printed.


SERVER

The name of the server.


STATUS

The server’s current status.


UID

The unique identification number entry_id of the queue entry currently being
processed.

Example
# Column Column Column Left/ Monitor Trailing
# Name Title Width Right Column? Spaces
# ----------- --------- ------ ----- ------- --------
SERVER Printer 12 L No 1
STATUS Status 8 L Yes 1
ENABLED Enabled? 8 L Yes 1
PAGE Page 5 R Yes 1
CONFIG.PAPER Paper 10 L No 1
CONFIG.PRINTER_ID Id 26 L No 1

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


84 CHAPTER 5 ■
System files ■
wopqsum.tab: Printer status display format

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


85

Index

B terminal_type.ttp 20, 25, 79


uqadm.menu 35, 41, 48, 81
browse command 13, 18, 78, 80
uqimp.menu 35, 41, 48, 81
brprint file 31
uqops.menu 35, 41, 48, 81
uquser.menu 35, 41, 48, 81
C wliqsum.tab 82
commands wopqsum.tab 82
browse 13, 18, 78, 80 fkey.tab file 18, 25, 76, 79
liq 82
opq 82 L
ufct 25, 79
liq command 82
uq 8, 18, 35, 41, 48, 78, 79, 81
wliq 82
wopq 82 M
.menu file 34
D menu.fkey file 76
menu.menu file 77
default.tab file 9, 31
menu.ring file 34, 78

E O
environment variables
opq command 82
TERM 8, 13, 18, 25
UF_HOME 8
UNIQTERM 8, 13, 18, 25 R
report.def file 31, 80
F
files T
brprint 31 TERM environment variable 8, 13, 18, 25
default.tab 9, 31 terminal_type file 20, 25, 78
fkey.tab 18, 25, 76, 79 terminal_type.def file 26, 30, 78
menu.fkey 76 terminal_type.ttp file 20, 25, 79
menu.menu 34, 77
menu.ring 34, 78
report.def 31, 80
U
terminal_type 20, 25, 78 UF_HOME environment variable 8
terminal_type.def 26, 30, 78 ufct command 25, 79

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


86 Index

UNIQTERM environment variable 8, 13,


18, 25
uq command 8, 18, 35, 41, 48, 78, 79, 81
uq menus
built-in functions 61
customizing 34
dispatch instance 35
fax instance 41
horizontal 12
print instance 48
using 8
vertical 9
uqadm.menu file 35, 41, 48, 81
uqimp.menu file 35, 41, 48, 81
uqops.menu file 35, 41, 48, 81
uquser.menu file 35, 41, 48, 81

W
wliq command 82
wliqsum.tab file 82
wopq command 82
wopqsum.tab file 82

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE


COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE UQ MENU INTERFACE
I N T E L L I G E N T • S Y S T E M S • M A N A G E M E N T

www.macro4.com

You might also like