Columbus Om Installation Configuration
Columbus Om Installation Configuration
Columbus Om Installation Configuration
5.000
Publication number
Trademark acknowledgements
Documentation set
This is the only manual for this product.
Copyright notice
Columbus OM (the Programs and associated materials) is a
proprietary product of Macro 4 Limited a division of
UNICOM Global. The Programs have been provided
pursuant to License Agreement containing restrictions on
their use. The programs and associated materials contain
valuable trade secrets and proprietary information of
Macro 4 Limited and are protected by United States Federal
and non-United States copyright laws. The Programs and
associated materials may not be reproduced, copied,
changed, stored, disclosed to third parties, and distributed in
any form or media (including but not limited to copies on
magnetic media) without the express prior written permission
of Macro 4 Limited, The Orangery, Turners Hill Road,
Worth, Crawley, West Sussex, RH10 4SS, U.K.
Columbus OM
Copyright 1995-2012 All Rights Reserved. Macro 4
Limited a division of UNICOM Global.
No part of this Program may be reproduced in any form or
by electronic means, including the use of information storage
and retrieval systems, without the express prior written
consent and authorization of Macro 4 Limited.
No part of this manual may be reproduced or transmitted
in any form or by any means, electronic or mechanical,
without prior written permission from Macro 4 Limited.
Disclaimer
We cannot guarantee freedom from, or assume any
responsibility or liability for technical inaccuracies or
typographical errors. The information herein is furnished
for informational use only and should not be construed as a
commitment by Macro 4 Limited a division of UNICOM
Global.
Contents
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Overview of a Columbus OM output management environment . . . . . . . . . . . . 16
Configuration functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
CONTENTS
CONTENTS
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
CONTENTS
CONTENTS
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
CONTENTS
10
Conventions
Conventions
The following typographic conventions are used:
boldface
italics
monotype
Ctrl+D
...
Support for quota-based scanning and printing. For more information, see
Working with quota-based scanning: Scan2Print on page 514.
Columbus OM 4.930
The filein server can process files either in the order in which they were put
in the scanned folder, or in alphabetic order. See the Directory_Read_Order
parameter on page 235.
Print indexing can be turned off by setting the PCL_Converter system
parameter to NONE. See page 239.
req command: Entries for deletion can be selected by their status. See
page 260.
Event monitoring: New events record when queues are automatically purged,
extended and archived (see page 433); and when printers are started, stopped
and initiated (see page 434). New parameters for evserver control when
events are written to a logfile: see Flush_Filter and Flush_Logfile on
page 438.
uqsfcache: Remote_User parameter specifies a userid on a remote computer
that Columbus OM is to send feedback to. See page 443.
page 576.
Columbus OM 4.920
11
12
Columbus OM 4.915
Combined installation program for Columbus OM for IOP, the Columbus IOP
web interface, and Columbus Accounting. For more information, see Installing
a Columbus Intelligent Office Printing (IOP) deployment on page 37.
Columbus OM 4.910
Intelligent Office Printing features select most suitable devices for printing
documents, based on document properties and user authorisation, with options
to divert to other devices or enforce special requirements. For more
information, see Intelligent Office Printing (IOP) on page 495.
Columbus OM 4.900
The file-locking system to prevent two users accessing a file at the same time
has been supplemented by a faster and more reliable method that provides
more effective support for multi-processor computers.
On Windows, mutexes are used. On UNIX, semaphores are used. The method
used is specified by the ULM_Method parameter in the default.tab file.
xprinter supports the Internet Printing Protocol (IPP). For more information,
(spage 400).
A printers connection parameters can be more finely specified: the values for
the Connect_Delay, Disconnect_Delay and Connect_Interval parameters
can be specified in milliseconds (instead of seconds) by adding M after the
value.
The uqsfcache server can make a copy of its cache file before processing it,
ensuring that statuses are not lost if the server stops abnormally. For more
information, see the servers Backup_Cache parameter (page 442).
You can control whether the dispatch server counts the pages and lines in a
bundle of documents. For more information, see the servers
Count_Bundle_Pages parameter (page 320).
Errors that occur in the status feedback reporting system can be recorded in a
logfile. For more information, see the Log_SFB_Errors system default
parameter (page 437).
IOP Universal Driver: There is more control over which options in a printers
Properties dialog box are available, and the text in the dialog box can be
edited. Oncall printers can be configured at installation time or by using the
Properties dialog box. For more information, see Configuring the IOP
Universal Driver on page 59.
13
14
15
CHAPTER 1
Chapter 1
Introduction
This chapter provides an overview of the configuration features that enable you to
set up Columbus OM so that it can be used for printing documents and sending
faxes. These features include:
administering the document queues that enable users to process, track and
archive documents
configuring a fax environment for sending and receiving faxes by using the
Columbus OM fax facility
monitoring the use of Columbus OM with audit trails, log files and archives
16
CHAPTER 1
Introduction
Columbus OM
Explorer
document
status
Columbus OM
instance
document
status
printer or
fax modem
There may be several Columbus OM instances on the same host: either different
Columbus OM products or copies of the same product, configured differently.
Each instance usually controls several printers or fax modems.
Columbus OM
Explorer
Columbus OM
print instance A
printers
Columbus OM
print instance B
printers
Columbus OM
fax instance C
fax modems
In a Columbus OM print system, there may be several hosts with print instances.
Users may be able to access each instance directly or they may access one instance
which in turn accesses another instance.
CHAPTER 1
Introduction
Columbus OM
Explorer
Columbus OM
instance A
Columbus OM
instance B
printer or
fax modem
For greater control over the use of a Columbus OM print system, you can use the
Columbus OM dispatch features. You can specify rules to select documents
according to their attributes (for example, the owner or the destination) or their
contents, and then process them differently. For example, documents sent to a
printer that has been taken offline for maintenance can be automatically redirected
to another printer.
Columbus OM
Explorer
Columbus OM
Dispatch
Columbus OM
Print
printer or
fax modem
The dispatch functionality can be provided either by the dispatch server that is
contained within the Columbus OM print instance or by a separately installed
Columbus OM dispatch instance.
For more information, see Controlling Columbus OM with the dispatch server on
page 279.
17
18
CHAPTER 1
Introduction
Configuration functions
Configuration functions
This section briefly describes the areas that have to be configured to create a
Columbus OM system.
Network communications
The network communications enable the components of a Columbus OM system
to communicate with each other. They enable Columbus OM Explorer on a PC to
communicate with a Columbus OM instance on a host computer, and a
Columbus OM instance to communicate with other Columbus OM instances.
For the network communications to work, you have to choose a port number that
Columbus OM uses, and you must use the same port number on every computer
within the Columbus OM system.
Queue maintenance
All the documents that you send to a Columbus OM instance are stored in a queue:
The pending queue contains documents that are waiting to be processed. When
you add an entry, it first goes in the pending queue.
The completed queue contains documents that have been processed (either
successfully or unsuccessfully). Columbus OM automatically moves the
documents from the pending queue to the completed queue when it has
processed them.
The archive queue contains documents that have been moved from the
completed queue and that you want to store for future reference.
Columbus OM
Explorer
Columbus OM
pending queue
Columbus OM
completed queue
Columbus OM
archive queue
Every instance has its own pending queue and a completed queue. The archive is
optional: after documents have been in the completed queue, you can either store
them in the archive or discard them. If you want to use the archive queue, you have
to create it yourself.
The initial size of the pending and completed queue are set when you install the
Columbus OM instance. To make sure that there is enough space to hold all the
documents that users want to add, you can either increase the size of the queues or
delete old entries. Both of these can be done either manually, or automatically
when needed.
CHAPTER 1
Introduction
Configuration functions
At regular intervals, you must also check the integrity of the queue, and fix it if
necessary. This can also be done either manually or automatically.
printers on
network
Columbus OM
Explorer
Columbus OM
print instance
Columbus OM
PC Printer
Channel
printers
attached to PC
printers
attached to host
accessed by
modem
To set up local printing, you have to provide information about how the printers
are connected.
Local printing is controlled by one of Columbus OMs servers called
printmaster. The printmaster server is configured for you when you install
Columbus OM. However, you might need to change its configuration to meet the
requirements of your site.
Distributed printing
Distributed printing enables users to print document on printers that are controlled
by Columbus OM instances other than the one to which they are connected. These
printers are known as remote printers.
Columbus OM
Explorer
HOST A
Columbus OM
HOST B
Columbus OM
printer
19
20
CHAPTER 1
Introduction
Configuration functions
In this example, the printer is controlled by the Columbus OM print instance that
is on Host B. The printer is in Host Bs local printing environment. On Host A, the
same printer is set up as a remote printer. This enables users who can connect only
to Host A to use the printer.
To set up a distributed print environment, you need to create a list of the remote
printers that you want users to have access to. Distributed printing is controlled by
the netmaster server. Like printmaster, netmaster is configured for you when
you install Columbus OM.
Converting lp requests into Columbus OM requests
Columbus OM can intercept print requests that users make using the standard
UNIX lp command, and add those requests to its own queue.
Transferring documents from other hosts to Columbus OM
Users who do not have direct access to a Columbus OM instance can still add
entries to its queue, if they can transfer files to the host that the instance is on.
Setting up printers
For each printer that you want to use with Columbus OM, you have to set up a
printer server to control it. Setting up a printer server includes specifying the
connection to the printer (for example, whether it is connected to the host, by the
network or by a modem) and its type (for example, PCL or PostScript).
Document processing
Additional features enable documents to be processed before they are printed. For
example, banner pages can be added to ensure consistent output, and documents
can be converted into different formats (for example, from PCL to PostScript),
enabling you to make better use of the printers available.
CHAPTER 1
Introduction
Configuration functions
System security
Essential to every Columbus OM system is maintaining security: ensuring that
users can modify, view and delete only the documents that are appropriate to their
responsibilities, and also ensuring that only authorized users have access to the
Columbus OM configuration functions.
Advanced users and administrators might prefer the command line interface to
Columbus OM, available for both Windows and UNIX.
Just before users are given access to these interfaces, the administrator might want
to customize how they work. For example, there are several default values that can
be set in advance to make it faster and easier for users to add entries.
21
22
CHAPTER 1
Introduction
Configuration functions
23
CHAPTER 2
Chapter 2
Installing Columbus OM
See
installing Columbus OM
Configuring Columbus OM on
page 42
starting Columbus OM
upgrading Columbus OM
uninstalling Columbus OM
Uninstalling Columbus OM on
page 52
24
CHAPTER 2
Installing Columbus OM
Description
See
page 24
page 26
(UNIX only.) If you are installing two or more instances on the page 29
same computer, and you want the instances to share some of the
Columbus OM programs, choose a common directory
(UNIX only.) Make sure that the X-Server with Virtual Frames
Buffer is installed
page 28
page 29
Licensing
Columbus OM is licensed by Macro 4 to run on a specified computer for a
specified period of time. A license is provided either in a license file or as a set of
license keys.
Using a license
file
If you have a set of license keys, see Using a set of license keys on page 25.
Copy the license file to anywhere on the computer on which you want to install
Columbus OM; when you install Columbus OM, it will ask you for the
location of the license file, and then move it to where it needs to be.)
If you copy the file by using FTP, make sure that the file is transferred in binary
mode.
Copy the new license file into the folder in which the License Manager is
installed.
CHAPTER 2
Installing Columbus OM
Use the Services icon in the Window Control Panel. The License Manager
service is called M4 License Manager.
UNIX
1
Type
./cr_lrm.opsys start
./cr_lrm.opsys stop
Using a set of
license keys
If you license is in the form of a set of license keys, you enter the keys when you run
the installation program.
Updating the license keys
If you need to update your license keys, use the keyset command.
Before running the keyset command, make sure that the %UNIQDIR% environment
variable contains the path of the Columbus OM instance whose license you are
updating.
To display your license information
Type:
keyset -q
25
26
CHAPTER 2
Installing Columbus OM
Type:
keyset
System name: MyHost
Make sure that the name is the same name that you supplied to Macro 4 when
you requested the license.
Enter key 1:
Type the license keys in order. After each license key, press Enter.
After the last license key, press Enter twice.
License name
Type a name to identify the license, for example, the name of your company.
The license name will be displayed when you run a Columbus OM command.
License number:
Network connectivity
Columbus OM components that are installed on different computers communicate
by using the TCP/IP protocol and some network services. You must make sure that
all the computers use the port numbers for the services.
Columbus OM services
The basic Columbus OM network services are:
Service
Port number
Used for
uniqcs
2006 (suggested)
printer
515 (standard)
2001 (suggested)
You can use different port numbers from those suggested above; but you must use
the same port number for any given service on all computers (hosts and PCs) in the
Columbus OM network.
If required, you can create two or more independent Columbus OM networks by
running each network on different port numbers.
CHAPTER 2
Installing Columbus OM
(Windows.) The installation program sets the port numbers for you. Check that
the port number is not already being used by looking in the computers services
file.
(UNIX.) You must add the uniqcs service and port number to the services file,
after you have installed Columbus OM.
File location
UNIX
/etc/services
Microsoft
Windows 95/98
\windows\services
Microsoft
Windows NT, 2000,
XP and later
%SystemRoot%\system32\drivers\etc\services
Novell NetWare
\etc\services
Creating a user
(Windows 2000
and later)
Select Start
Select the Advanced tab, and then click the Advanced button.
In the Local Users and Groups window, click Users in the left-hand pane.
On the Action menu, click New User to display the New User dialog box.
Settings
Control Panel.
Clear User Must Change Password at Next Logon and select Password
Never Expires.
Select Start
Settings
Control Panel.
27
28
CHAPTER 2
Installing Columbus OM
In the Local Security Settings windows, click + (plus sign) next to Local Policy
in the left-hand pane, then click its sub-entry User Rights Assignments.
Click the username of the new account (uniq) in the Names list.
Click Add to display the PC\username combination in the Add Names list.
Click OK to close the Select Users or Groups dialog box, and then click OK
again to close the Local Security Policy Setting window.
Creating a user
and user group
(UNIX)
The user group will have the appropriate access rights to the directories and
files.
You are recommended to create a user called uniq, and a user group called
uniqgrp, and use them only for Columbus OM.
If you install two or more Columbus OM instances, use the same user and user
group for all the instances.
Note
CHAPTER 2
Installing Columbus OM
Folder names
(Windows only.) The path for the installation folders must not include any
space characters. Other than this restriction, standard Windows naming
conventions apply.
(UNIX only.) The recommended location for the main Columbus OM folder is
/usr/uniq.
The name of the folder does not relate to the name of the instance; you specify
that name later in the installation process.
make sure that the folder can be accessed by all the instances, typically by
setting its owner to uniq and its access group to uniqgrp.
upgrade all instances which share files at the same time to make sure that they
are compatible.
X-Server and virtual frame buffer (HP-UX, Linux and Solaris) on page 30
4.3.3.75
4.3.3.50
COMMITTED
COMMITTED
If the reply is blank, it indicates that X-Server is not installed; you must install
the X11.vfb module by following the instructions below.
29
30
CHAPTER 2
Installing Columbus OM
The X11.vfb module is available from the AIX V4.3.3 installation CD-ROMs and
from the AIX Version 4 Update CD-ROM.
1
Login as root.
Press F4, and then select the CD-ROM drive (for example, /dev/cd0).
Press ENTER.
The preview installation starts.
Starting the
virtual frame
buffers
Login as root.
HP-UX:
nohup Xvfb :n -screen 0 1x1x24 -cc 4
Linux:
Xvfb :n -screen 0 1600x1200x24 &
Solaris:
/usr/X11R6/bin/Xvfb :n -screen 0 1x1x24 -cc 4 2>>logfile &
CHAPTER 2
Installing Columbus OM
Replace:
ISAPI Extensions
ISAPI Filters
Basic Authentication
Windows Authentication
Click Next.
Click Install.
When the items have been installed, click Close, and then close IIS Server
Manager.
Click Edit.
Change the port number to something other than 80 (for example, 81), and
then click OK. (80 is used by the Columbus IOP web interface, so the default
website must use a different number.)
31
32
CHAPTER 2
Installing Columbus OM
CHAPTER 2
Installing Columbus OM
Checklist
License format
License information (set of keys or
file) available
Using a license file
Location of license file
Choose one of:
Port number
Installation folder
Operating system
Port number for Columbus OM
uniqcs service (for example, 2006)
Columbus OM username (for
example, uniq). On Windows,
include the PC name or domain
name
(UNIX only) Columbus OM user
group created (for example, uniqgrp)
Installation folder
(UNIX only) Commands directory
name
(UNIX only) X-Server with VFB is
installed
To use Columbus OM WebChannel:
Web server installed
Columbus IOP deployments
Web browser is installed
Web server is installed
33
34
CHAPTER 2
Installing Columbus OM
CHAPTER 2
Installing Columbus OM
Check that you have the information that the installation program needs. For
more information, see Checklist on page 33.
The easiest way to create a responses file is to install Columbus OM by using the
installation program as usual, and record the values that you enter.
1
Complete the dialog boxes, and run the installation program to completion.
The installation program records the values that you put in the dialog boxes in
a responses file called setup.iss. The file is in the Windows folder.
On the computer on which you want to install another copy of Columbus OM,
set up the environment as described in Preparing to install Columbus OM on
page 24.
If required, edit the responses file to make the values appropriate for this copy
of Columbus OM.
Replace folder with the path of the folder that the responses file is in, for
example: setup -s f1c:\windows\setup.iss.
The installation program installs Columbus OM, using the values that are in
the responses file; no dialog boxes appear.
4
When the installation program has finished, check the setup.log file that is in
the same folder as the responses file.
35
36
CHAPTER 2
Installing Columbus OM
Return code
Description
Success
-1
General error
-2
Invalid mode
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-51
-52
-53
CHAPTER 2
Installing Columbus OM
Install the support applications that a Columbus IOP deployment uses. For
more information, see Support applications for Columbus IOP deployments
on page 37.
Check that you have the information that the installation program needs. For
more information, see Checklist on page 33.
Installation instructions
a web browser
PHP
37
38
CHAPTER 2
Installing Columbus OM
Option
IOP Installer
Columbus Accounting
Destination Folder
Instance Name
License Details
Create User
Accounting Service Use the default values (that is, 0.0.0.0 and 8084).
Create Accounting
Database
Columbus OM
Setup Type
Service Logon
Type the name and password of the user that you want to
control the Columbus OM service.
When the installation program asks if you want to configure the Accounting server, click
Yes.
IOP Install (Details Use the default values (that is, localhost and 8084).
of the Accounting
server)
When the installation program asks if you want to configure the Zone server, click Yes.
IOP Install (Details Use the default values (that is, localhost, 8082, and the
of Zone server)
name of the instance as specified above).
CHAPTER 2
Installing Columbus OM
Step
Option
Choose Destination Select the folder in which you want to install MAGIK.
Folder
PHP Location
Web server
Select the web server that you want to use: either IIS or
Apache.
Desktop Shortcut
Selection
Make sure that the following policies include the uniq user:
Log on locally.
Make sure that the uniq user has full Administrator authority over the folder in
which Columbus Accounting is installed:
Make sure that the file contains an entry for the Columbus IOP instance and
Columbus Accounting, like this:
#
# Name
-----------IOP
Accounting
Same
Path
type?
----------------------- ----C:\ColumbusOM
Yes
C:\ColumbusAccounting
Yes
Product
------Print
Batch
If the file does not contain either of these entries, add them.
7
39
40
CHAPTER 2
Installing Columbus OM
Make sure that the file contains an entry for Columbus Accounting, like this:
#
# Name
Path
------------ ----------------------Accounting
C:\ColumbusAccounting\
Same
type? Product
----- ------Yes
Batch
Specify how users names and passwords are to be validated. (Delete the
semicolon that is in front of the method that you want to use; insert a semicolon
at the front of the methods that you do not want to use.)
To
Use
Macro4_Auth_Adapter_Om
Magik_Auth_Adapter_Ldap
The name or IP address of the computer that xmlserver is on, and the port
number on which it listens. If xmlserver and the IOP interface are on the same
computer, you can set xmlserverHost to localhost.
xmlserverInstance = text
CHAPTER 2
Installing Columbus OM
Log on as root.
When the installation program has finished, review the contents of the
warnings file. To do this, change to the installation directory, and then type:
more warnings
If you see a warning about SAP R/3 not being available on this platform, a
small number of integration capabilities, for example the use of the
csulin_sap validation program by uqserver, cannot be used.
8
41
42
CHAPTER 2
Installing Columbus OM
Configuring Columbus OM
Configuring Columbus OM
This section describes how to configure Columbus OM and the operating system
after you have installed Columbus OM.
These steps enable the Columbus OM program to work. After you have completed
these steps, additional steps will be necessary to configure it for your environment,
for example, to control printers and enable users to print documents.
Step
Description
See
below
below
page 44
page 45
If you have only one Columbus OM instance, you have to update this file only
if you want to change the instance name. For example, if you might add other
instances later, you could change PRINT to PRINT1.
Occasionally, some sites require that instances are not aware of each other;
however, in most cases, it is easier to administer and use Columbus OM if all
the instances on a host are aware of each other.
CHAPTER 2
Installing Columbus OM
Configuring Columbus OM
Path
-------------------------------------------------C:\Columbus OM\print1
C:\Columbus OM\print2
Same
type?
----Yes
Yes
Product
------PRINT
PRINT
The first line describes the instance that the file belongs to.
The other lines describe the other instances on the host that you want to use with it.
Fields
Name
The full path of the folder in which the instance is installed, for example:
"C:\Columbus OM\print1" or /usr/uniq/print1. If the path include
spaces, enclose it in quotation marks.
Same type?
If the instance is the same type (that is, Print, Fax or Dispatch) as the instance
that to which the file belongs, specify Yes.
If they are different types, specify NO.
Product
Path
-------------------------------------------------"C:\Columbus OM\print1"
"C:\Columbus OM\print2"
Same
type?
----Yes
Yes
Product
-------PRINT
PRINT
The systems.tab file for the second print instance might look like this:
#
# Name
# ---------P2
P1
Path
-------------------------------------------------"C:\Columbus OM\print2"
"C:\Columbus OM\print1"
Same
type?
----Yes
Yes
Product
-------PRINT
PRINT
If you then install a Columbus OM fax instance, the systems.tab files might
become:
43
44
CHAPTER 2
Installing Columbus OM
Configuring Columbus OM
Path
-------------------------------------------------"C:\Columbus OM\print1"
"C:\Columbus OM\print2"
"C:\Columbus OM\fax1"
Same
type?
----Yes
Yes
No
Product
-------PRINT
PRINT
FAX
Same
type?
----Yes
Yes
No
Product
-------PRINT
PRINT
FAX
Same
type?
----Yes
No
No
Product
-------FAX
PRINT
PRINT
Path
-------------------------------------------------"C:\Columbus OM\print2"
"C:\Columbus OM\print1"
"C:\Columbus OM\fax1"
Path
-------------------------------------------------"C:\Columbus OM\fax1"
"C:\Columbus OM\print1"
"C:\Columbus OM\print2"
In the instance that you do not want to run uqserver, edit the
servers\servers.tab file. This file lists all the servers that the instance runs.
Id
--
Program
-------
AI?
---
AT?
---
AS?
---
Master?
-------
uqserver
Yes
Yes
Yes
Yes
Inserting a hash symbol (#) at the start of the line for uqserver.
# Name
# ---. . .
# uqserver
. . .
Id
-2
Program
-------
AI?
---
AT?
---
AS?
---
Master?
-------
uqserver
Yes
Yes
Yes
Yes
Notes
If there is only one Columbus OM instance on the host, you do not have to edit
this file.
CHAPTER 2
Installing Columbus OM
Configuring Columbus OM
local users: those running Columbus OM Explorer on the PC where you have
installed Columbus OM
Select Start
Double-click the Administrative Tools icon, and then double-click the Local
Security Policy icon.
In the Local Security Settings windows, click the + next to Local Policy in the
left-hand pane, then click its sub-entry User Rights Assignments.
For a local user, double-click Log on locally. For a remote user, double-click
Access this computer from network.
Click the username of the new account (uniq) in the Names list.
Click Add to display the PC\username combination in the Add Names list.
Click OK to close the Select Users or Groups dialog box, and then click OK to
close the Local Security Policy Setting window.
Settings
Control Panel.
The post-installation configuration steps for Windows are now complete, and you
can start the new instance. See Starting Columbus OM on page 48.
Description
$UNIQDIR
$PATH
$UNIQ_GROUP
Only if Group Security is in use: The printer group to which the user
belongs. If undefined, Columbus OM searches
$UNIQDIR/security/groupsec.tab to determine the users
group membership and thus the available actions.
45
46
CHAPTER 2
Installing Columbus OM
Configuring Columbus OM
Variable
Description
$WOPQ_GROUP
Only if Group Security is in use: The printer group to which the user
belongs for the purpose of the Printer Operations display. If
undefined, Columbus OM searches
$UNIQDIR/security/groupsec.tab to determine the users
group membership and thus the displayable printers.
$UNIQTERM
With the exception of $TERM and $UNIQTERM, the variables are specific to each
Columbus OM instance, and must be properly defined for all users requiring access
to that instance. For example, if you have installed two Columbus OM instances,
users wanting to use the first instance might set $UNIQDIR to /usr/UniQ/print1
(and the other variables accordingly), while users of the second instance might set it
to /usr/UniQ/print2.
To initialize the variables, see:
Setting variables To set the variables statically, add these lines to each users .profile file:
(Bourne and
UNIQDIR=installation_directory
export UNIQDIR
Korn shells)
UF_HOME=$UNIQDIR/uniform
export UF_HOME
PATH=$PATH:bin_directory
UNIQ_GROUP=printer_group
WOPQ_GROUP=printer_group
UNIQTERM=terminal_type
export
export
export
export
PATH
UNIQ_GROUP
WOPQ_GROUP
UNIQTERM
# if needed
# if needed
# if needed
Alternatively, run a Columbus OM script to set the first three values dynamically
by adding these lines to each .profile file:
. installation_directory/setup
UNIQ_GROUP=printer_group
WOPQ_GROUP=printer_group
UNIQTERM=terminal_type
export UNIQ_GROUP
export WOPQ_GROUP
export UNIQTERM
# if needed
# if needed
# if needed
Setting variables To set the variables statically, add these lines to each users .login file:
(C shell)
setenv
setenv
set
setenv
setenv
setenv
UNIQDIR
UF_HOME
PATH
UNIQ_GROUP
WOPQ_GROUP
UNIQTERM
installation_directory
$UNIQDIR/uniform
( $PATH bin_directory )
group
# if needed
group
# if needed
terminal_type
# if needed
Alternatively, run a script to set the first three values dynamically by adding these
lines to each .login file:
CHAPTER 2
source
setenv
setenv
setenv
Environment
variables for
multiple
instances
Installing Columbus OM
Configuring Columbus OM
installation_directory/csetup
UNIQ_GROUP
group
# if needed
WOPQ_GROUP
group
# if needed
UNIQTERM
terminal_type
# if needed
If you have two or more Columbus OM instances on the same host, you can make
all of the instances available to users. There are two ways of doing this.
Method 1: Environment switching
Create a series of shell scripts, one for each instance, which set $UNIQDIR,
$UF_HOME and $PATH to refer to that instance. A user can run the appropriate script
prior to typing the uq command in order to invoke the appropriate menu interface.
Method 2: Queue switching
1
Make sure that are all the instances are at the same release level.
Set $UNIQDIR and $UF_HOME to refer to one instance, which will be the default
instance.
if you have two Columbus OM fax instances and three Columbus OM print
instances, $PATH must include only one of the Columbus OM fax command
directories and one of the Columbus OM print command directories. If you
have installed all the Columbus OM binaries in a single directory, $PATH need
refer only to that directory.
To
Do this
Type uq
47
48
CHAPTER 2
Installing Columbus OM
Starting Columbus OM
Starting Columbus OM
Starting Columbus OM (Windows)
Columbus OM is installed as Windows service which starts automatically
whenever the computer starts. You can also start the service manually.
To start the Columbus OM service manually
1
Select Start
Right-click the appropriate name in the right-hand pane to display the shortcut
menu.
Settings
Control Panel.
Log on as uniq.
If you are using the Columbus License Manager, start it. (See Starting and
stopping License Manager on page 25.)
Type:
syq -ai
Log on as root.
Add these lines to a startup script which is appropriate for your UNIX system.
UNIQDIR=installation_directory
export UNIQDIR
$UNIQDIR/programs/commands/syq -ai
CHAPTER 2
Installing Columbus OM
Starting Columbus OM
When you start the Columbus OM service, it runs a Columbus syq -ai
command to start the servers.
When you stop the Columbus OM service, it runs an syq -atnw command to
stop the servers. The syq -atnw command waits for the servers to stop cleanly.
When all the servers have stopped cleanly, the Columbus OM service itself
stops.
You can specify alternative commands for the Columbus OM service to use when
it stops and starts. For example, you can stop Columbus OM more quickly by using
the uqshutdown command instead of syq -atnw. The uqshutdown command tries
to stop each server; if a server does not stop within a short period, the command
kills it.
To specify an alternative start command
The uniqservice program can monitor the other Columbus OM services, and
shut them down if a process has stopped. To enable this feature, do the following:
1
49
50
CHAPTER 2
Installing Columbus OM
Architecture: VMWare ESX 3.5 supports a maximum of four virtual CPUs for
each virtual machine. Columbus programs use all available CPUs; if future
versions of VMWare support more CPUs, performance should improve.
Columbus programs can be installed across two or more virtual machines;
however, this might cause management overheads and delays in
communications between services.
Requirements
Power off the system by shutting down Windows in the usual way. Do not use
the ESX Servers Suspend/Resume Virtual Machine feature.
For more information about improving the performance of ESX Server, see the
VMWare document, Performance Tuning Best Practices for ESX Server 3
(available from http://www.vmware.com). Macro 4 does not support systems in
which the requirements that are described above have not been met. Even if the
system is optimally configured, there might still be performance overheads which
are outside the control of Macro 4.
CHAPTER 2
Installing Columbus OM
Upgrading Columbus OM
Upgrading Columbus OM
This section describes how to upgrade an existing Columbus OM instance to a new
version.
To upgrade a Columbus OM instance (Windows)
The upgrade process automatically stops any Columbus OM services that are
running.
1
Download the installation files, and then run the installation script in the same
way as for installing Columbus OM.
For more information about how to do this, see Installing Columbus OM
(UNIX) on page 41.
51
52
CHAPTER 2
Installing Columbus OM
Uninstalling Columbus OM
Uninstalling Columbus OM
Windows
Use the Add/Remove Programs icon in the Windows Control Panel.
UNIX
1
Delete references to the instance from the operating system startup script.
CHAPTER 2
Installing Columbus OM
Reference
Reference
License management
The following parameters can be set in the system defaults file (default.tab):
Action_On_LicenseFail command
A command to be run if the license file appears to be invalid: this could happen
if the Columbus License Manager that validates the license file is not available.
For example, the command could send an email message to the administrator.
The command can include the %MESSAGE substitution variable, which contains
either Forced shutdown in n hours or Forced shutdown NOW, as
appropriate.
Columbus OM continues to operate for 24 hours after the license validation
fails, giving you time to restart the License Manager.
LicenseManagerPort number
The name of the host computer on which the License Manager runs.
The default value is localhost.
MacAddress address
The MAC address of the host computer on which the License Manager runs.
53
54
CHAPTER 2
Installing Columbus OM
Reference
55
CHAPTER 3
Chapter 3
Columbus OM utilities
Program
See
Columbus OM Explorer
page 56
page 57
page 63
page 70
page 78
page 83
page 86
56
CHAPTER 3
Columbus OM utilities
Columbus OM Explorer
Columbus OM Explorer
Columbus OM Explorer enables you to access Columbus OM instances (on both
Windows and UNIX) from a PC running Windows.
To install Columbus OM Explorer
1
When the installation program has finished, check that the services file includes
an entry for the uniqcs network service. See Network connectivity on
page 26 for more information.
CHAPTER 3
Columbus OM utilities
You install the IOP Universal Driver, and then add a printer to Windows
which uses it. For more information about how to do this, see below.
You print a document to the printer. The printer driver sends the document to
Columbus OM.
If you are using the zone printing feature, Columbus OM analyzes the content
of the document, and then selects an appropriate printer on which to print it.
You might need to convert the codes that the printer driver puts in the print files
that it creates to codes that are specific to the printer that you use. For more
information about printer code mapping, see Printer code mapping on page 529.
if you know the information that you want to put in the dialog boxes, in silent
mode. This mode is particularly suitable when you have to install IOP
Messenger on several computers.
at the same time as the other IOP desktop components: IOP Messenger and
the Windows Gateway. For more information about how to do this, see IOP
desktop components on page 78.
To install the IOP Universal Driver in silent mode (that is, without any dialog
boxes appearing), change to the folder that the installation program is in, and then
type at the command line:
filename /s /v"/qn INSTALLDIR=folder LOCAL_LANG=language
ONCALL_PRINTER=Yes|No"
Parameters
filename
The path and name of the folder in which you want to install the driver, for
example: C:\Program Files\Macro 4\IOP Universal Driver
57
58
CHAPTER 3
Columbus OM utilities
LOCAL_LANG=language
To make the printer that is used with the driver an on-call printer for use with
a IOP deployment, specify Yes.
The default value is No.
To install the IOP Universal Driver and other desktop components
To install the IOP Universal Driver at the same time as the other IOP desktop
components: Columbus OM Messenger and the Windows Gateway. For more
information about how to do this, see IOP desktop components on page 78.
Settings
Follow the onscreen instructions until you reach the Install Printer Software
step.
Click Browse.
The Locate File dialog box appears.
Navigate to the folder in which the printer driver is installed (for example,
c:\Program Files\Macro 4\Columbus OM PCL Driver).
CHAPTER 3
Columbus OM utilities
Do this
Check that the IOP Universal Driver is shown in the Printers box, and then
click Next.
If the Use Existing Driver dialog box appears, select Replace existing driver,
and then click Next.
change the text that is displayed next to the options and controls
59
60
CHAPTER 3
Columbus OM utilities
Count
No
12
CHAPTER 3
Columbus OM utilities
To control which options are available in the Properties dialog box, do the
following:
To
Do this
make a control unavailable (that is, it is Set the value in the Display
visible, but greyed-out)
Show/Hide column to No, and set the
value for the Hide_attributes
property to No.
hide a control (that is, make it
invisible)
Do not change any other values (for example, the Count value) or the items
in the lists (for example, NONE, STAPLE, and SADDLE_STAPLE in the example
above).
3
Navigate to the folder in which the printer driver is installed (for example,
c:\Program Files\Macro 4\Columbus OM PCL Driver).
Columbus Options
Urgency
Immediate
Within 10 minutes
Within 30 minutes
Within 1 hour
This AM/PM
Today
The left column contains the identifiers of the controls; the right column
contains the text that is displayed for each control.
61
62
CHAPTER 3
Columbus OM utilities
Create an icon file version of the logo. The image must be 32 x 32 pixels.
CHAPTER 3
Columbus OM utilities
the computer that the Columbus OM instance is on: you need either its name
or IP address. For an IOP deployment, you need the name or IP address of the
computer that the zone server is on.
Installation options
The Windows Gateway can be installed:
at the same time as the other IOP desktop components: IOP Messenger and
the IOP Universal Driver. For more information about how to do this, see IOP
desktop components on page 78.
63
64
CHAPTER 3
Columbus OM utilities
on a cluster. For more information about how to do this, see Installing the
Windows Gateway on a cluster on page 64.
If you are using Windows in any language other than English, stop the
Windows Print Spooler.
Navigate to the folder that the Windows Gateway installation program is in,
and then double-click the setup.exe file.
When the installation program has finished, you can add a printer to use the
Windows Gateway: see Adding printers to use the Windows Gateway on
page 65.
When you install the Windows Gateway, the installation program has to stop
the local print spooler. Usually, stopping the local print spooler triggers a
failover to the cluster print spoolers; stopping these print spoolers before you
install the Windows Gateway prevents this failover from happening.
Install the Windows Gateway on the active node in the cluster by following the
instructions above.
Install the program at the main console for the node; do not use a remote
desktop session.
Install the Windows Gateway on all the other nodes that are in the cluster.
Again, install the Windows Gateway at the main console for each node; do not
use a remote desktop session.
Run.
CHAPTER 3
Columbus OM utilities
In the Run dialog box, type \\ (two backslash characters), and then either the
name of the cluster or its IP address, for example:
\\mycluster
Click OK.
Using the Add Printer wizard, create a shared printer. This printer is the
shared clustered printer.
On all of the other nodes, add a printer. Set the printer type to Network
Printer, and then connect to the shared cluster printer by typing the IP address
of the cluster and the name that you gave it above.
You can now use the Windows Gateway in the clustered environment.
Settings
Select Columbus OM Port from the list of port types, and then click Next.
The Columbus Port dialog box appears.
Click OK.
65
66
CHAPTER 3
Columbus OM utilities
In the Install Printer Software step, make sure that Manufacturer is set to
Macro 4, and Printers is set to Columbus OM PCL Driver, and then click
Next.
In the Use Existing Driver step, make sure that Keep existing driver is
selected, and then click Next.
In the Name Your Printer step, specify the name that the printer has in
Columbus OM to identify it, and then click Next.
Description
Name
Zone Server
Host
Port No
Instance
Printer
Medium
CHAPTER 3
Columbus OM utilities
Property
Description
Ticket
Encrypting documents
To encrypt the document, set either or both of the During Transfer and On Disk
properties.
To
AES128
AES192
AES256
NONE
To use this feature, do not select either Send accounting information only to
server? or Enable Local Port.
For more information about encrypting documents, see Encrypting documents on
page 374.
Using Columbus OM Accounting
If you are using Columbus OM Accounting, set these properties:
Property
Description
Send accounting
To send only a summary of the document (instead of the
information only to document itself) to Columbus OM, select this option. The
server?
summary includes the documents name, the owner, the
page count, and so on. To enable the Accounting module
to process the information, set the Accounting medium to
the medium that is used by the module.
Enable Local Port
PJL?
67
68
CHAPTER 3
Columbus OM utilities
CHAPTER 3
Columbus OM utilities
Replace file with the path and name of the port definition file.
In the Printers window, delete all printers that use the Columbus OM port.
Select any of the remaining printers, and then display its properties.
Settings
Printers.
To delete multiple Columbus OM ports, you can create a list of the ports, and then
use the rm_portmon command.
1
Create a text file that lists the ports that you want to delete. The file can have
any name. Put each port on a separate line, for example:
MyPort1
MyPort2
MyPort3
Replace file with the path and name of the list of ports file.
69
70
CHAPTER 3
Columbus OM utilities
IOP Messenger
IOP Messenger
IOP Messenger enables you to send messages to other users. The messages
automatically appear on the users screen. In an IOP deployment, Columbus OM
can send messages to users to tell them when their document has been printed, and
which printer was used.
You can:
check which zone you are registered in, and change it.
IOP Messenger must be installed on each computer to which you want to send
messages.
To
See
if you know the information that you want to put in the dialog boxes, in silent
mode. This mode is particularly suitable when you have to install IOP
Messenger on several computers.
at the same time as the other IOP desktop components: Columbus Printer
Driver and the Windows Gateway. For more information about how to do this,
see IOP desktop components on page 78.
Navigate to the folder that contains the IOP Messenger installation program.
Double-click the installation program file, and then follow the onscreen
instructions.
CHAPTER 3
Columbus OM utilities
IOP Messenger
Value
Zone Server
Zone Number
Use domain/user
Restrict user
The name of the computer that the zone server is on. The default value is
LocalHost.
ZONE_PORT=number
The number of the TCP/IP port that the zone server uses. The default value is
2006.
MENU_STRING=\"string\"
The text of the option on the settings menu for which the default value is
Launch Website.
71
72
CHAPTER 3
Columbus OM utilities
IOP Messenger
INSTALLDIR=folder
The folder in which you want to install IOP Messenger. The default value is
C:\Program Files\Macro 4\ColumbusOM Messenger.
ZONE_SERVER1=server
ZONE_PORT1=port
ZONE_SERVER2=server
ZONE_PORT2=port
The name and port numbers of any failover servers to be used. The default
value for the names is blank. The default value for the port numbers is 2006.
USE_DOMAIN=0|1
change the communications port, if the default one (2009) is already used by
another program
specify the location of the IOP interface, enabling users to access it from the
IOP Messenger menu.
On each computer on which IOP Messenger is installed, click the Start button
on the Windows Desktop, and then navigate to Programs Columbus OM.
In the Target box, add the port number to the end of the command, for
example:
"C:\Program Files\Macro 4\ColumbusOM Messenger\uqmesser.exe" 2007
Click OK.
To enable users to access the IOP interface from IOP Messenger, set the IOP_URL
parameter in the system defaults file (default.tab) to the interfaces URL.
CHAPTER 3
Columbus OM utilities
IOP Messenger
Syntax
xmessage destination text
[UNIQ_MESSAGE|UNIQYESNO|NET_SEND|UNIXWRITE|EMAIL]
Parameters
destination
text
The text of the message. If the text includes spaces, enclose it in quotation
marks.
To split a message over two or more lines, separate the lines with %%NL, for
example: "Your document has been printed on%%NLthe colour
printer".
To include a URL, start it with http:// or www.
UNIQ_MESSAGE|UNIQYESNO|NET_SEND|UNIXWRITE|EMAIL
Specify
UNIQ_MESSAGE or UM
NET_SEND or NS
UNIXWRITE or UW
EMAIL or EM
uid is the number of an entry that is in the pending queue of the instance that
you are using to send the message.
When the user clicks a button, Columbus OM puts a value in the entrys
Server Info property.
If the user clicks
Yes
YESNO=Y
No
YESNO=O
73
74
CHAPTER 3
Columbus OM utilities
IOP Messenger
Value
SMTP_Domain text
SMTP_Sender text
The email address from which the messages are sent, for
example, [email protected].
SMTP_Server text
Do this
all users
an individual user
Windows:
%UNIQDIR%\media\users\domain\userid.tab
UNIX:
%UNIQDIR%/media/users/userid.tab
Example
To send a message to a computer called MyPC01, use a command like this:
xmessage MyPC01 "Colour printer available again" UM
CHAPTER 3
Columbus OM utilities
IOP Messenger
Do this
delete a pending job from Right-click the IOP Messenger icon, and then click
the list
My Print Jobs. Right-click the job, and then click
Remove Job.
Using IOP features with IOP Messenger
These features are available if you are using IOP Messenger with a IOP
deployment.
Right-click the IOP Messenger icon in the system tray, and then do one of the
following:
To
Do this
75
76
CHAPTER 3
Columbus OM utilities
IOP Messenger
Right-click the IOP Messenger icon in the system tray, and then click Settings.
Set the following properties for each instance. (The Primary tab is for the main
Columbus OM instance that you use; the Backup 1 and Backup 2 tabs are for
alternative instances that might be used if the primary instance is not available.)
Property
Description
Zone Server
ZonePort
Display Time
If you do not want to receive any messages from IOP Messenger, right-click the
IOP Messenger icon in the system tray, and then click Exit.
CHAPTER 3
Columbus OM utilities
IOP Messenger
Filename
message_skin.bmp
Size
Transparency colour
Filename
recent_skin.bmp
Size
Transparency colour
Buttons
OK button filenames
No button filenames
Size
unpressed
OK_button_up.bmp
mouse-over
OK_button_hover.bmp
pressed
OK_button_hover.bmp
unpressed
Yes_button_up.bmp
mouse-over
Yes_button_hover.bmp
pressed
Yes_button_hover.bmp
unpressed
No_button_up.bmp
mouse-over
No_button_hover.bmp
pressed
No_button_hover.bmp
Filename
messenger_icon.ico
Size
32 32 pixels
77
78
CHAPTER 3
Columbus OM utilities
Specify the values that you want to use for the desktop components by setting
the parameters in the configuration files:
Component
Configuration file
See
page 79
Windows Gateway
GatewayConfig.cfg
page 80
IOP Messenger
MessengerConfig.cfg
page 81
Copy the installation program to the computer on which you want to install the
desktop components.
Put the configuration files where they can be accessed from the computer on
which you want to install the desktop components.
Replace path with the name of the folder in which you have put the
configuration files. Include the computer name, if appropriate, for example:
\\mycomputer2\myfiles.
While the installation program runs, ignore any dialog boxes about Unsigned
driver that appear. The installation programs handles these dialog boxes
automatically.
If there are any errors in configuration files, the installation program stops. It
reports the errors in log file called Solution_Install_Log.txt.
CHAPTER 3
Columbus OM utilities
Parameters
You must include all these parameters in the file.
DESTINATION_DIR=folder
The main folder in which you want to install the desktop components. The
installation program puts each component in a separate subfolder of this main
folder.
Specify the full path of the folder, for example: c:\Program Files\Macro 4.
Do not include a slashmark at the end.
INSTALL_SOFTWARE_ONLY=TRUE|FALSE
The path and name of the folder that the configuration files
(GatewayConfig.cfg, MessengerConfig.cfg, ompcl.cfg, ompcl.gdp,
ompcl.txt, and OMMessenger_Translations.cfg) are in. The files can be
on a different computer: if so, specify the path as \\computername\path.
UPDATE_GDP_FILE=TRUE|FALSE
To use your own version of the IOP Universal Drivers ompcl.gdp file, specify
TRUE. Put the file in the folder that is specified by the
GENERAL_FILES_LOCATION parameter.
To use the default ompcl.gdp file, specify FALSE.
UPDATE_CFG_FILE=TRUE|FALSE
To use your own version of the IOP Universal Drivers ompcl.cfg file, specify
TRUE. Put the file in the folder that is specified by the
GENERAL_FILES_LOCATION parameter.
To use the default ompcl.gdp file, specify FALSE.
UPDATE_DRIVER_LANG_FILE=TRUE|FALSE
To use your own version of the IOP Universal Drivers language file
(ompcl_txt.cfg), specify TRUE. Put the file in the folder that is specified by
the GENERAL_FILES_LOCATION parameter.
To use the default language file, specify FALSE.
UPDATE_LANG_FILE=TRUE|FALSE
79
80
CHAPTER 3
Columbus OM utilities
The folder in which Columbus OM Gateway puts its log files (for example,
c:\logs).
ACCOUNTING_FILE=filename
The file that Columbus OM Gateway uses for Columbus Accounting (for
example, ACCOUNTING.txt).
SPOOLER_NAME=text
The name of the Windows Print Spooler service (for example, Print
Spooler).
PRINTER_NAME=text
The name of the default IOP printer. The default name is IOP.
PORT_NAME=text
Parameters
INSTANCE=text
The name of the Columbus OM instance that the Gateway will send
documents to.
For an IOP deployment, specify the name of the zone server instance.
HOST=text
CHAPTER 3
INSTANCE1=text
HOST1=text
PORTNO1=number
MEDIUM1=text
PRINTER1=text
TICKET1=text
Columbus OM utilities
INSTANCE2=text
HOST2=text
PORTNO2=number
MEDIUM2=text
PRINTER2=text
TICKET2=text
The name of the port to be used if you are printing locally (for example, LPT1).
MIRRORENABLE=Yes|No
If the instance is the zone server for the IOP deployment, specify Yes.
ACCOUNTING=text
To validate against both the domain and the name part of a username (for
example, mydomain\john), specify No.
To validate against only the name part, and ignore the domain, specify Yes.
ENCRYPTION=None|128|192|256
ENCRYPT_DISK=None|128|192|256
Parameters
ZONE_SERVER=text
ZONE_PORT=number
The name of the computer that the zone server is on, and the port number that
it uses.
81
82
CHAPTER 3
Columbus OM utilities
ZONE_SERVER1=text
ZONE_PORT1=number
The name of the server that the first back-up instance is on, and the port
number that it uses.
ZONE_SERVER2=text
ZONE_PORT2=number
The name of the server that the second back-up instance is on, and the port
number that it uses.
MENU_STRING=text
If the IOP deployment does not use the domain, specify NO.
RESTRICT_USER=YES|NO
CHAPTER 3
Columbus OM utilities
Follow the instructions for installing the PC Printer Channel (see above).
PC Printer
83
84
CHAPTER 3
Columbus OM utilities
Do this
Click OK.
Type a name for the configuration file, and then click Save.
If you are using TCP/IP: Create a separate port and configuration file for each
printer, and start multiple instances of the PC Printer Channel, each
referencing one of the configuration files see Using the PC Printer Channel
configuration files below.
If you are using LPD/LPR: Create a separate queue for each printer. You need
only one instance of the PC Printer Channel (which always listens on the
LPD/LPR port 515).
CHAPTER 3
Columbus OM utilities
The full path of the folder that the configuration file is in. The default value is
the folder that the PC Printer Channel application is in.
-file: file
In Columbus OM, create a printer server. Use a name which relates to the
PC/printer combination.
where host is the PC running the PC Printer Channel and port is the port
defined on that PC. If you are using LPD/LPR, the port number is 515.
3
TCP/IP
printout
LPD/LPR
If there are multiple printers on the PC, define multiple printer servers, each
using a different port or queue.
85
86
CHAPTER 3
Columbus OM utilities
The NetWare host must be running Novell NetWare version 5.1 (Support Pack
Revision 04) or higher, with NDPS patch ndp21p4.exe.
The NetWare host must have been updated with the latest Novell patches.
See http://support.novell.com/misc/patlst.htm for more information.
Type:
load nwconfig.
Type the path in the format volume:\directory., and then press Return.
On the Columbus OM Novell Gateway Main menu, select Install for version
5.x of NetWare, and then press Return. Wait for the Installed successfully
message.
CHAPTER 3
Columbus OM utilities
Installed files
The following files are installed on the NetWare host:
File
Description
\macro4\config.tab
\macro4\nqueue.tab
\macro4\history2
\macro4\dayDD.log
\system\uqlc.nlm
\system\m4cngate.nlm
Post-installation setup
Updating the hosts file
On the NetWare host, edit the file \etc\hosts to include an entry for the
NetWare host itself:
ip_address
nw_host
Parameter
Value
ip_address
nw_host
port/tcp
87
88
CHAPTER 3
Columbus OM utilities
Parameter
Value
service
port
The port number should generally be set to 2006, and must match
the value specified on the Columbus OM hosts see Network
connectivity on page 26.
Value
Hostname
NetWare
Set to 5.
NWDS
Novell_Username
Novell_User_
Password
Server
Set to print.
Service
Owner
Process_Held_
Entries
Banners
omit banners.
Scan_Interval
CHAPTER 3
Columbus OM utilities
Parameter
Value
Banner1, 2, 3
Normal_Attr
Display attributes
The value of the Normal_attr parameter is an integer in the range 0-255, used as a
bit-mask.
Bit
Decimal
Effect if set
128
64
32
16
Enter appropriate values: press Return after each field. The password is not
echoed.
89
90
CHAPTER 3
Columbus OM utilities
Press ESC, and then save the data. The values that you enter here are written to
the file \macro4\config.tab.
Edit the \etc\hosts file (again) to include an entry for the Columbus OM
host:
ip_address
cd_host
Parameter
Value
ip_address
cd_host
This step enables M4CNGATE to send ACKs back to the originating system.
2
Create a dummy NetWare print queue, but do not associate a print server
with it.
Edit the \macro4\nqueue.tab file to reference the dummy print queue.
Add an entry of the form:
local_queue
cd_host
cd_instance
cd_printer
Parameter
Value
local_queue
cd_host
cd_instance
cd_printer
CHAPTER 3
Columbus OM utilities
nw_host
Parameter
Value
ip_address
nw_host
port/tcp
Parameter
Value
service
port
nw_host:nw_queue
nw_host:nw_queue/nw_server
nw_host:ndps_printer
Parameter
Value
local_printer
nw_host
nw_queue
nw_server
ndps_printer
91
92
CHAPTER 3
Columbus OM utilities
If you are using NDPS, ensure that you have started the NDPS Broker and
started the NDPS Manager for your NDPS printers.
Request Info
Current Status
1
0
0
Outstanding (history)
:
Successful
:
Failed
:
Transferred to Columbus OM:
0
0
0
0
Field
Description
Total Active threads The number of run lines (including one for this
display).
Total Connections
serviced
Current connections
Outstanding
(history)
Successful
Failed
Transferred to
Columbus OM
Current Status
CHAPTER 3
Columbus OM utilities
The keyboard might remain locked for a short while, and then the server process
terminates.
Type:
load nwconfig
From the menu, select Product Options, and then select Install a product
not listed.
Type:
load nwconfig
From the main menu, select Deinstall for version 5.x of Netware.
93
94
CHAPTER 3
Columbus OM utilities
95
CHAPTER 4
Chapter 4
Managing servers
96
CHAPTER 4
Managing servers
Server types
Server types
Columbus OMs features are provided by the following servers. For more
information about how to use and configure each server, see the appropriate
section.
Core features
Feature
Server
See
printmaster
page 125
Printing documents
printer
page 129
Enhanced printing
xprinter
page 188
statserver
page 439
uqsfcache
page 441
Control processing
dispatch
page 320
Feature
Server
See
accserver
page 572
crserver
page 344
aspserver
page 348
dcsserver
page 580
evserver
page 438
uqsapcache
page 552
xmlserver
page 598
Feature
Server
See
Faxbox modems
faxbox
page 483
faxmaster
page 485
haslerfx
page 486
pfax
page 490
haslerpr
page 489
Feature
Server
See
netmaster
page 114
CHAPTER 4
Managing servers
Server types
Feature
Server
See
repmaster
page 401
uqserver
page 403
Feature
Server
See
filein
page 234
ftserver
page 232
lpdserver
page 227
mailin
page 459
Feature
Server
See
mailer
page 458
Feature
Server
See
ldapserver
page 516
SecureJet
page 528
Input channels
Output channels
IOP features
97
98
CHAPTER 4
Managing servers
Adding servers
Adding servers
1
instance icon
Value
Server name A name to identify the server. The name can include letters,
numbers, and underscore characters. It cannot include spaces.
Attributes
Autostart
Autostop
Display at
command
prompt
Includes the server in the list when you use an syq command;
for more information, see Command line on page 103.
Click OK.
To enable the server so that it can be used, click it, and then click the Enable
Server toolbar button.
CHAPTER 4
Managing servers
Configuring servers
Configuring servers
Command line
Navigate to the servers folder: %UNIQDIR%\servers\servername, and then edit
the config.tab file.
Columbus OM Explorer
Navigate to: Advanced tab
Modify.
Columbus OM Servers
server
Servers menu
If your system is set up to refresh servers automatically when you change their
configuration, the change takes place immediately. See Refreshing servers
automatically below.
If your system is set up to refresh servers only when they start, you must stop
the server and then restart it. See Starting servers on page 101.
Yes
No
99
100
CHAPTER 4
Managing servers
Configuring servers
dcs server: If you change the Outgoing or StatusCheck parameters for the
dcs server, the server does not reload its configuration, because these
CHAPTER 4
Managing servers
Starting servers
Starting servers
Starting servers manually
Columbus OM Explorer
Advanced tab instance icon
Server
toolbar button.
Columbus OM Servers
server icon
Start
Command line
To
Use
start a server
syq -ALL_INITIATE|-ai
Add an syq command to the startup file (see Stopping servers below).
If you are using a command to start or stop selected servers, specify which
servers to include by following the rest of these steps:
3
Click a server, and then click either (or both of) Autostart and Autostop.
Click OK.
101
102
CHAPTER 4
Managing servers
Stopping servers
Stopping servers
Columbus OM Explorer
Navigate to: Advanced tab instance icon
icon Stop Server
toolbar button.
Columbus OM Servers
server
Command line
To
Use
stop a server
freq
/count
(if time is
omitted)
syq -ALL_TERMINATE|-atn
uqstop
CHAPTER 4
Managing servers
Monitoring servers
Monitoring servers
Displaying the status of servers
Columbus OM Explorer
Navigate to: Advanced tab
instance icon
Columbus OM Servers.
Command line
To
Use
syq -ALL_STATUS|-as
syq -ALL_ACTIVE|-aa
To include a server when you use this command, set its AS? property to YES in the
servers.tab file (see servers.tab: List of servers on page 104).
General processing
activity
%UNIQDIR%\servers\server\dayDD.log
DD is the day of the month that the log file covers
(day01.log, day02.log, and so on, up to day31.log).
%UNIQDIR%\servers\server\activity.log
103
104
CHAPTER 4
Managing servers
Reference
Reference
servers.tab: List of servers
The servers.tab file contains information about all the servers in an
Columbus OM instance, including:
Content
The file contains one line for each server, with these fields:
Field
Description
Name
Id
Program
AI?
YES|NO
YES starts the server when you use an syq -ALL_INITIATE
command.
AT?
YES|NO
YES stops the servers when you use an syq -ALL_TERMINATE
command.
AS?
YES|NO
YES includes the server when you use an syq -ALL_STATUS.
Master?
YES|NO
YES if it is a process server; NO if it is a printer server.
Example
# Name
# --------------#
printmaster
statserver
ftserver
lpdserver
netmaster
uqserver
Id Program
AI? AT? AS? Master?
-- ------------- --- --- --- ------10
12
3
4
11
2
printmaster
statserver
ftserver
lpdserver
netmaster
uqserver
Yes
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
CHAPTER 4
Managing servers
Reference
Server numbers
Number
Server type
netserver
uqserver
ftserver
lpdserver
batchmaster
faxmaster
telexmaster
faxprint
10
printmaster
11
netmaster
12
statserver
17
dispatch
18
dcs
19
asp
21
uqsfcache
22
uqsapcache
105
106
CHAPTER 4
Managing servers
Reference
-GROUP|g
(UNIX only.) Also stops any operating system child processes that are
associated with the server.
-REPORT|r
Displays the servers process id, but does not stop it.
-NO_BANNER
-NO_WARNING
-QUEUE_NAME instance
-SET_USER username
-SILENT
-VERBOSE
Use
stop a server
If the command has no effect, it indicates that you are not authorized to use it; try
again, including the -su user option, replacing user with user name of a
Columbus OM implementor or administrator.
To use this form of the command, your user name must be in the su_opt file.
Options
-NO_BANNER|-nb
-NO_WARNING|-nw
-QUEUE_NAME|-qn instance
-SET_USER user
-SILENT|-si
107
CHAPTER 5
Chapter 5
Configuring a
Columbus OM printing
environment
Columbus OM supports several types of print environment: most installations use
a combination of the different types.
Local printing
Local printing enables users to print documents on printers that are controlled by
the instance to which they are connected.
Users add entries to the Columbus OM pending queue, which is monitored by the
printmaster server. It looks for requests that are to be printed on local printers.
When it finds one, it sends the document to the printer. When the printer has
finished processing the document, printmaster moves it out of the pending queue
and into the completed queue.
Columbus OM
Explorer
Columbus OM
pending queue
printmaster
printer
completed queue
The printmaster server is configured for you when you install the Columbus OM
print instance. However, you might need to change the configuration to meet the
your requirements: see Configuration for local printing on page 111.
Distributed printing
Distributed printing enables users to print documents on printers that are
controlled by Columbus OM print instances other than the one to which they are
connected. These printers are known as remote printers.
108
CHAPTER 5
Users add entries to the Columbus OM pending queue, which is monitored by the
netmaster server. It looks for requests that are to be printed on remote printers.
When it finds one, it sends the request to the instance that controls the printer. The
request is added to that instances pending queue, and then that instances local
printing environment processes the document. The printmaster server sends it to
the printer. When the document has finished, the remote printer sends a message
back to netmaster, and then netmaster moves the document out of the pending
queue and into the completed queue.
Columbus OM
Explorer
HOST A
pending queue
HOST B
pending queue
printmaster
completed
queue
printer
completed
queue
To set up a distributed print environment, you must create a list of the remote
printers that you want users to have access to. netmaster is configured for you
when you install the Columbus OM print instance, but you might need to change
its configuration to meet your requirements. See Configuration for distributed
printing on page 113.
CHAPTER 5
Columbus OM
Explorer
HOST A
Columbus OM
HOST B
Columbus OM
printers
HOST C
Columbus OM
printers
HOST D
Columbus OM
printers
109
110
CHAPTER 5
Setting parameters
Setting parameters
To configure Columbus OM, you must set parameters to values.
Some parameters belong to individual programs (called servers) and affect only
that server. For more information, see Configuring servers on page 99.
Some parameters can be set at both instance level and server level. In this case,
the parameter at server level overrides the same parameter set at instance level.
This means that you can set a value that is suitable for most servers at instance
level, and then configure an individual server to use a different value if
required.
Columbus OM Explorer
1
Click
instance icon
View menu
Options
The name of a parameter indicates which group it is in. For example, the
AEQ_Default and AEQ_Index parameters are in the AEQ group.
3
Click the parameter, and then set the value you want.
Click OK.
Example default.tab
# Parameter
# ---------------------Address
Medium
Monitoring
AEQ_Default
AEQ_Index
Print_Index
APQ_Val_Attribs
APQ_Val_Dest
Auto_Purge
Auto_Archive
Auto_Extend
Highest_UID
...
Value
-------------------------------SalesPr1
print
ON
stdin
No
No
No
No
0
0
0
99999
CHAPTER 5
parameter that you are most like to change controls how often it scans the queue for
new entries:
Parameter
Value
Scan_Interval
To process an entry with two servers (for example, to print an entry, and then
archive it), all that you have to do is set this parameter. For more information,
see Example: Processing an entry with two servers below.
To process an entry with multiple servers (for example, to print an entry, fax it,
and then archive it), set this parameter, and use it with the dispatch features.
For more information, see Dispatch example: Processing with multiple servers
on page 313.
111
112
CHAPTER 5
This parameter affects all servers. It does not affect the syq -uc and syq -uf
commands. (syq -uc sets an entrys status to Completed; syq -uf sets an entrys
status to Failed.)
Example: Processing an entry with two servers
This example describes how to archive all entries after they have been printed.
1
When the archive server has processed the entry, its status changes to
Completed. Because the entry is now Completed, and its medium matches
the Completion_Medium, Columbus OM moves it to the completed queue.
Sequential printing
Documents usually are processed in the order that you add them, but is possible, if
you add a large document and then a small document, for Columbus OM to
complete processing the small document and send it to the printer before it
completes processing the large document.
To ensure that Columbus OM always processes documents in the order that you
add them, do the following:
To
Do this
CHAPTER 5
In the Print1 instance, define Host B as a remote host, and the printer as a remote
printer.
You can then use the remote printer in the same way as you use a local printer.
Columbus OM
Explorer
Host A
Columbus OM
Print1 instance
HOST B
Columbus OM
Print2 instance
printer
See
page 114
Set the parameters for netmaster to configure how it connects to page 114
the remote hosts.
The parameters that you set for netmaster affect every remote
host to which it connects. If necessary, change the connection for
individual hosts.
page 116
113
114
CHAPTER 5
Step
See
page 120
page 121
Specify the remote hosts and users who are authorized to use the
printers that are controlled by the current instance.
page 377
Add one line for each printer, using the entry format below.
Entry format
printer
location
Field
Value
printer
location
CHAPTER 5
To enable netmaster to login to the remote host that it is transferring the file
to, set this parameter:
Parameter
Value
Remote_User
To control what happens if netmaster cannot send the entry to the remote
host the first time that it tries, set these parameters:
Parameter
Value
Timeout
Attempts_Limit
Postpone_Time
Action_On_
Postponement
If you send more entries to the same host while it is still unavailable,
netmaster postpones processing them. It sets their Next_Attempt time to now
plus the value of the Host_Recheck parameter (in the config.tab file). It does
not change the entrys status to Postponed, and it does not run the
Action_On_Postponement command.
4
To control the traffic over the network when netmaster transfers the entries to
the remote hosts, set these parameters:
Parameter
Value
Delivery_Rate
115
116
CHAPTER 5
Parameter
Value
File_Compress and
File_UnCompress
Columbus OM
Add an entry for each host. using the format shown below.
Entry format
For each remote host, add an entry like this (all on one line):
host "[ delivery_rate ],[ compress_command ],
[ uncompress_command ],[failover_host ],[service]"
See the parameters below, and also Example netmaster hosts file (nmhosts.tab) on
page 117.
Parameters
host
CHAPTER 5
delivery_rate
To control the rate at which netmaster transfers the data to the remote host,
you can specify a maximum delivery rate (in characters per second).
To
Specify
- (dash)
compress_command, uncompress_command
To reduce network traffic, you can tell netmaster to compress the files before
sending them and then uncompress them when they reach the remote host.
If you use this feature, you must specify both a command to compress files and
a command to uncompress the files. For example, on Windows, you can use
gzip. On UNIX, you can use compress or gzip.
To
Do this
failover_host
117
118
CHAPTER 5
provide the current status of the job every time that it changes
provide only the final status of the job (either Completed or Failed)
ignore the status (that is, set the status to Completed as soon as the job has
been transferred to the remote host).
Parameter
Complete_On_Transfer NO
Value
5 (seconds) or more.
Parameter
Complete_On_Transfer NO
Value
0 (zero)
CSUNIQ
CHAPTER 5
Ignore status
This will cause transferred entries to complete immediately. This option minimizes
network traffic by removing returned status information. However, the user has to
check on the remote server to check the progress of their job. This option is most
suitable for automated environments.
To configure this, set these parameters:
Server/file
Parameter
Complete_On_Transfer YES
Value
0
NO
On the master instance where you will maintain the list of remote printers, set
these parameters for netmaster:
Parameter
Value
Get_Remote_Tab
NO
Unknown_Dest
IGNORE or FAIL
Use_Routing
NO
119
120
CHAPTER 5
Value
Get_Remote_Tab
Either n or ONCE.
To update the remote printers table every n seconds,
set it to n. The recommended minimum value is 900
(that is, every 15 minutes).
To update the table only when netmaster starts, set it
to ONCE.
Name_Server
Unknown_Dest
IGNORE or FAIL
Use_Routing
NO
Set Unknown_Dest to
IGNORE
FAIL
FORWARD
poll the peer systems to see if they know the printer (see POLL
also Polling the remote systems below).
The default value is IGNORE.
Polling the remote systems
If an entry is sent to a printer that Columbus OM does not know about, you can tell
Columbus OM to poll the peer systems to see if they know the destination by
setting these parameters for netmaster:
Parameter
Value
Unknown_Dest
POLL
Peers
If one of these hosts knows about the printer, netmaster transfers the entry to it. If
none of the hosts knows about the printer, Columbus OM sets the requests status to
Failed and moves it to the completed queue.
CHAPTER 5
Handling
unavailable
hosts
To specify an alternative host to use if the first host cannot be used (for
example, because its network connection is unavailable), see Handling
unavailable hosts below.
To specify an alternative instance to use if the first instance is busy (that is, its
pending queue already contains a maximum number of entries), see Handling
busy systems on page 123.
You can specify an instance on an alternative host to try if the first host is
unavailable. This alternative host is called the failover host. netmaster transfers the
documents to the failover host, but it keeps checking if the first host becomes
available again. When it does, netmaster reverts to using that one.
You can use any host that has a Columbus OM print instance with the same name as
the first instance that was tried. It could be either an instance on a different host, or
an instance on the originating host.
Example
In this example, there are three hosts (mars, jupiter and saturn), and each host
has two Columbus OM print instances.
In the Print1 instance on mars, you can define the Print2 instance on jupiter as
a remote host. This enables someone using Columbus OM Explorer on the PC that
is connected to Print1 on mars to use a printer that is controlled by Print2 on
jupiter.
Columbus OM
Explorer
Host mars
Host jupiter
Host saturn
Print1
Print2
Print2
Print2
Print3
Print4
In case jupiter becomes unavailable, you can set up a failover host to use instead.
You can use any instance with the same name as the first instance tried. In this
example you could use either:
121
122
CHAPTER 5
Columbus OM
Explorer
Host mars
Host jupiter
Host saturn
Print1
Print2
Print2
Print2
Print3
Print4
Columbus OM
Explorer
Host mars
Host jupiter
Host saturn
Print1
Print2
Print2
Print2
Print3
Print4
Change the last (fourth) parameter to the name of the failover host to be used.
Specify
Postpone_Time
Max_Hosts_Tries
Host_Recheck
CHAPTER 5
When the period is over, netmaster tries again to access the remote host.
It keeps trying, up to the maximum number of attempts that is specified by the
Max_Host_Tries parameter.
If netmaster still cannot access the remote host, then it looks in the hosts table
to see if a failover host has been specified, and then tries to transfer the
document to the failover host instead.
While it is using the failover host, netmaster keeps checking the original host,
at periods that are specified by the Host_Recheck parameter.
If the original host becomes available again, netmaster stops using the remote
host, and uses the original host instead.
Handling busy
systems
You can specify a maximum number of entries that can be held in an instances
pending queue, and an alternative instance to transfer extra entries to if that
maximum number is exceeded.
To do this, use the nmbusy.tab file.
If you do not specify an alternative remote instance, the entries stay in the local
pending queue until the remote instance is no longer busy.
File location and name
%UNIQDIR%\config\nmbusy.tab
Entry Format
Add one entry for each remote host and instance. Each entry has this format:
host1:instance1[:limit] host2:instance2
Field
Value
1 host1:instance1
123
124
CHAPTER 5
Field
Value
2 limit
3 host2:instance2
Example entries
MyHostA:MyInstance1:2000
MyHostB:MyInstance2
MyHostB:MyInstance2
MyHostC:MyInstance3
This example starts the same as the previous example: if the number of entries
in the pending queue for MyInstance1 exceeds 2000, netmaster transfers the
extra entries to MyInstance2. If or when the number of entries in
MyInstance2s pending queue exceeds 3000, netmaster does one of the
following:
MyHostA:MyInstance1:2000
MyHostB:MyInstance2:3000
MyHostC:MyInstance3:1000
MyHostB:MyInstance2
MyHostC:MyInstance3
MyHostA:MyInstance1
In this example, there is a loop of failover instances. If all the instances are
busy, entries stay in the local pending queue until one is no longer busy.
CHAPTER 5
Reference
Reference
printmaster servers: Handling print documents
The printmaster server monitors the queue for entries with a medium of PRINT,
and passes them to an appropriate local printer server.
Configuration file
%UNIQDIR%\servers\printmaster\config.tab
Configuration parameters
Action_On_Blocked command
The medium name which marks a queue entry as suitable for processing by this
server.
Port_Hold YES|NO
YES to hold directly-connected devices open whenever the scheduler is
running; NO (the default) to allow them to revert to idle when their respective
The interval in seconds between successive scans of the queue. The default is
10.
Server server
The name of the server, which must be the same as the name of the folder that
the configuration file is in.
125
126
CHAPTER 5
Reference
Content
The file contains any number of ROUTE statements, optionally preceded by any
number of DEFINE statements. Each statement occupies one line, with three spaceseparated fields.
DEFINE statements
A DEFINE statement provides a shorthand definition of a sequence of instances.
DEFINE route host:instance[/host:instance]...
Field
Value
route
instance_list
ROUTE statements
A ROUTE statement contains an ordered sequence of instances used to reach a given
destination.
ROUTE destination host:instance[/host:instance]...
Field
Value
destination
host:instance
The filename extension indicates the language that the file is for. For
example, lang.deu contains the German language text.
CHAPTER 5
Reference
At the command line, change to the %UNIQDIR%\lang folder, and then do one
of the following:
To
Do this
Type:
langtab code -b filename
Replace code with the filename extension, and filename with the name of the
language file.
For example, to compile the German language file, lang.deu, type:
langtab deu -b lang.deu
To set the language
127
128
CHAPTER 5
Reference
129
CHAPTER 6
Chapter 6
Setting up printers
For each printer that you want to use with Columbus OM, you add a printer server.
The printer server tells Columbus OM how to connect to the printer, and how you
want to use it (for example, the font to use by default and whether you want it to
print banner pages in front of each document).
For more information, see Adding printers on page 130.
An important part of configuring a printer is selecting its printer type. A printer type
defines some basic characteristics of printers (for example, the fonts available, the
paper orientation and finishing commands). The printer types that you are most
likely to need are already set up for you. You can also create your own printer
types. See Defining printer types on page 152.
To make printing more efficient, you can get Columbus OM Explorer to choose
the most suitable printer from a group of similar ones. You do this by creating
printer classes. See Creating printer classes on page 157.
To make it easier for users to find the printers that have been set up specifically for
their use, you can create printer groups. See Creating printer groups on page 158
130
CHAPTER 6
Setting up printers
Adding printers
Adding printers
To
See
turned on.
Overview
This feature uses the xsearch command.
Step
See
below
Run the xsearch command that covers the range of IP addresses, and page 131
includes the option to create a configuration file.
Run the p_mk command using the configuration file to add the printers page 133
to Columbus OM.
Configuring the
xsearch
command
CHAPTER 6
Setting up printers
Adding printers
Language
-------ALL
ALL
ALL
ALL
ALL
ALL
ALL
Port
------515
9100
515
9100
515
9100
9100
Channel_Type
-----------SNMP
RAW
LPD
RAW
LPD
RAW
RAW
Running the
xsearch
command
Syntax
xsearch start_address end_address [file]
[-a] [-c] [-f] [-p number] [-s|-sx email_address] [-si|-v]
[-t number] [-x]
Parameters
start_address end_address
The path and name of the file in which the configuration information is to be
put. You can then use the file with the p_mk command. See also Configuring
the xsearch command on page 130.
The default file name is xsearch.mk.
-a
Produces a report (in PCL format) with information about the printers found.
The report file is called xsearch.PCL.
-c
Prints a one-page audit report on the printer found; -s includes all printers; -sx
includes only printers that have not been found before.
The report includes your email address to indicate who is running the audit.
131
132
CHAPTER 6
Setting up printers
Adding printers
-si
Excludes printers that have already been set up in Columbus OM; in other
words, includes only new printers.
-v
This command searches for printers whose IP address is between 10.0.20.0 and
10.0.20.255, and then adds their configuration information to a file called
MyPrinterFile.
xsearch 10.0.20.0 10.0.20.255 -p 9100
This command searches for printers that are on only port number 9100, and
then adds their configuration information to a file called xsearch.mk.
xsearch 10.0.20.0 10.0.20.255 MyPrinterFile -si -x
This command searches for new printers. You could use this in a dispatch rule,
for example:
COMMAND "xsearch 10.0.20.0 10.0.20.255 MyPrinterFile -si -x"
COMMAND "p_mk -f MyPrinterFile"
the name of the printer. If Columbus OM cannot get the name from the
printer, it sets the name to printern
the description of the printer (for example, "HP Color LaserJet 8500")
The configuration file also contains a comment that tells the p_mk command to set
the driver to xprinter.
You can change or add to these values before using the file with the p_mk
command.
CHAPTER 6
Adding printers
with the p_mk
command
Setting up printers
Adding printers
where keyword is a printer parameter and value is a valid setting for that
parameter, enclosed in quotation marks "..." if it contains spaces.
To assign multiple paper types to a printer, use:
PAPER="papertype[,papertype][...]".
-QUEUE_NAME|-qn instance
This command creates a printer called MyPrinter, and assigns three paper types
to it:
p_mk MyPrinter Device="NETWORK 10.0.20.0 9100"
Paper="A4,Letter,B5"
133
134
CHAPTER 6
Setting up printers
Adding printers
This command creates a printer called MyPrinter, and assigns three paper types
to it:
p_mk MyPrinter Device="NETWORK 10.0.20.0 9100"
Paper="A4,Letter,B5"
then you could create the printer servers by using this command:
p_mk -f myservers.def
instance icon
CHAPTER 6
Setting up printers
Adding printers
Columbus OM Explorer creates the new printer. To see the new printer in the
list, you might need to click the Refresh toolbar button
.
3
To make the printer available for printing documents, you must enable the
printer, if you have not already done so. See Managing printer servers below.
If you are using printer groups to maintain security, add the new printer to the
appropriate groups. See Access to printers on page 376.
If you have already set up a printer server which has similar properties to the new
one, you can copy it and use it as the basis of the new one. To do this, click the
printer server and then click Duplicate on the Printer menu.
Printer tab
Printer
A name to identify the printer.
The name can include letter, numbers and underscore characters. It cannot contain
spaces. The maximum length is 16 characters.
Printer Id
(Optional) A description for the printer.
DeviceType
Specify how Columbus OM can connect to the printer by selecting one of these
options:
For a printer that
Select
Device
LPR/LPD
Modem
For information about Fax, see Redirecting documents from a print instance to
a fax instance on page 469.
Enable Printer
To enable the printer so that it can be used as soon as you have finished setting it
up, select this option.
To enable the printer later, see Managing printer servers on page 151.
Details tab
Specify the connection to the printer. For information about how to do this, see
page 146. The fields that are displayed depend on which Type you selected on the
Printer tab.
135
136
CHAPTER 6
Setting up printers
Adding printers
On the Details tab, set the Device/File name to the port specification, for
example: LPT1 (on a Windows host) or /dev/lp147 (on a UNIX host).
If the direct connection uses a serial line, you must also specify the line
characteristics.
To specify the line characteristics
1
Add an entry for each parameter, specifying the name of the parameter, and its
value, like this:
SPEED
19200
Example
This example shows the parameters and values that are suitable for almost all cases:
IgnoreDefinition
Speed
Csize
Stopb
Parity
Xin
Xout
Inlcr
Icrnl
Igncr
Ocrnl
Onlcr
Onlret
Min
Time
No
19200
8
1
Off
On
On
Off
Off
Off
Off
Off
Off
1
0
Parameters
Values
Description
CSIZE
6|7|8
ICRNL
OFF|ON
IGNCR
OFF|ON
IgnoreDefinition
YES|NO
CHAPTER 6
Setting up printers
Adding printers
Parameter
Values
Description
INLCR
OFF|ON
MIN
number
OCRNL
OFF|ON
ONLCR
OFF|ON
ONLRET
OFF|ON
PARITY
EVEN|ODD|NONE
Parity bit.
SPEED
number
Baud rate.
STOPB
number
Stop bits.
TIME
number
XIN
OFF|ON
XOUT
OFF|ON
Notes
MIN and TIME can be set to the following values.
The unit for MIN is a character count, and for TIME is an interval measured in tenths
of a second. In most cases, the preferred setting for MIN is 1, and TIME is 0, so that
the receipt of a single character is sufficient to satisfy a read.
Case
Behaviour
MIN > 0
TIME > 07
The read sleeps until the MIN and TIME mechanisms are
activated by the receipt of the first character. As soon as
one character is received, the timer is started.
If MIN characters are received before the timer expires,
the read is satisfied (note that the timer is reset upon
receipt of each character).
If the timer expires before MIN characters are received,
the characters received to that point are returned to the
user (note that at least one character will be returned
because otherwise the timer would not have been
enabled).
137
138
CHAPTER 6
Setting up printers
Adding printers
Case
Behaviour
MIN > 0
TIME = 0
MIN = 0
IME = 0
Logon as root.
Start smit.
Select Devices
Printer/Plotter
Select Devices
TTY
Remove printer.
Add a TTY
RS232
port.
CHAPTER 6
TCP/IP
connection
Setting up printers
Adding printers
Description
Host Name
Port Number
The port number might have been set up by the user when configuring the printer.
On some hosts, this number is predefined: on many types, it is 2000 plus the
number of the connection.
If the printer uses a network card, the port number is often 9100.
The Columbus OM print instance includes a program called porttest that might
help find out the number.
Using the porttest program to find the port number
1
Type:
porttest host [range]
where:
1 to 9999.
The results that the porttest command return are not guaranteed to be accurate.
lpr/lpd protocol
Use the lpr/lpd protocol only if there is no other way of connecting to the printer,
because it does not support all the printer control features. This might be necessary
for a printer that is:
connected to the network using a network card that supports only the lpr/lpd
protocol, or
on another host computer that is non-Open, but does support the lpr/lpd
protocol.
Description
Host Name
Port Number
515
139
140
CHAPTER 6
Setting up printers
Adding printers
Property
Description
Queue Name
Sends the data before the control information. Most lp daemons do not require
this option. If you use this option, you cannot also use the -z option.
-c class
Specifies a filetype (the default filetype is binary files, which works for most
systems). Different lp daemons support different filetypes, including:
f
Formatted file (that is, discard the HT, CR, FF, LF, and FF characters).
PostScript file.
-i pid
Truncates the local hostname that is used in constructing control and data file
names. This option is required by some JetDirect cards. The flag can be:
"."
"nnn"
".nnn"
-p
CHAPTER 6
Setting up printers
Adding printers
-z
Allows zero byte files. If you use this option, you cannot also use the -b option.
Attaching the lprout properties (UNIX only)
The lprout driver program uses the privileged socket 515 to communicate with
the lp daemons. This means that the lprout program usually needs to have special
access rights.
To change the access rights
1
Logon as root.
Type:
cd $UNIQDIR/programs/servers
chown root lprout
chmod u+s lprout
ls -l lprout
Connecting to a
printer by a
modem
Select
Device
Network
More fields appear, where you specify more details about the connection.
141
142
CHAPTER 6
Setting up printers
Adding printers
For a modem connected to a different host, specify the Host Name and the
Port Number.
Specify
Dial_Command
Modem_Set
Connect_Text
Timeout
Connect_Delay
Disconnect_Delay The interval (in seconds) to pause after sending the data
On the Modem tab for the printer, select File, and set it to:
%UNIQDIR%\servers\server\modems.tab
CHAPTER 6
Setting up printers
Adding printers
In modems.tab, create one line for each modem/printer connection, using the
entry format shown below.
Entry format
Field
Description
Device
Init
Reset
Dial
Example
# Device
# -----------/dev/tty0
/dev/tty1
Using a
command
instead of an
actual printer
Init
----ATZ
ATZ
Reset
----ATZ
ATH0
Dial
-----------ATDT
ATS0=255DT
Connected
---------------CONNECT
"CONNECT 9600"
Do this
set how long Columbus OM should wait Set Linger_Time to n (seconds). The
for the printer to confirm that it has
recommended number is 3600.
received all the data
143
144
CHAPTER 6
Setting up printers
Adding printers
To
Do this
CHAPTER 6
Setting up printers
Description
printername
class
-c class
-f list
-a
All printers.
-a string
-x
The name of the Columbus OM instance on the current host that the printers
are in.
Example
p_mod MyPrinter -x Hard_Queue=Yes Delivery_Mode=Secure
This command changes the values of two properties of a printer that uses the
xprinter driver.
145
146
CHAPTER 6
Setting up printers
Use
list the names of print servers that are in p_ls [-QUEUE_NAME instance]
a Columbus OM instance
delete print servers from Columbus OM p_rm server[ server]...
[-QUEUE_NAME instance]
[-QUEUE_NAME instance]
The name of a file that contains a list of the print servers to be deleted. Put each
printer on a separate line.
-QUEUE_NAME|-qn instance
The name of the Columbus OM instance (which must be on the current host)
that the printer servers are in.
Do this
CHAPTER 6
Setting up printers
To
Do this
Use
-ENABLE|-e
-DISABLE|-d END
-DISABLE|-d NOW
-KILL|-k
-INSERT|-i class
-EXTRACT|-x class
-MOUNT|-m paper_type
-UNMOUNT|-u paper_type
-DEVICE|-v device
-QUERY|-q
147
148
CHAPTER 6
Setting up printers
Use
-PAUSE|-p
-RESUME|-r position
position specifies where you want the
job to restart:
n
From page n.
+n
-n
-TRANSFER|-t server2
-LINEUP|-l n
Common parameters
-HELP|-h
-NO_BANNER|-nb
-NO_WARNING|-nw
-QUEUE_NAME|-qn instance
-SILENT|-si
CHAPTER 6
Setting up printers
or
uniqlpstat [options]
Display the print request acceptance status of all printers, or those in the list.
The list can be either:
-c [list]
Display the members of all printer classes, or those in the list (see above).
-D -p [list]
Display the settings of all printers, or those in the list (see above), in a userfriendly format.
-d
Display the settings of all printers, or those in the list (see above), in a longer
format.
-o [list]
Display the status of all print requests, or those in the list (see above) of
printers, classes, and entry ids.
-P [list]
Display the paper types supported by all printers, or those in the list (see
above).
-p [list]
Display the status of all printers, or those in the list (see above).
149
150
CHAPTER 6
Setting up printers
-R [list]
Display the ranked status of requests on all printers, or those in the list (see
above).
-r
Display the status of print requests on the default destination for all users, or
those in the list (see above).
-v [list]
Display the path names of the device drivers associated with all printers, or
those in the list (see above).
UNIX: Intercepting the operating systems lpstat command
UNIX only: To make sure that the Columbus OM version of lpstat is used instead
of the standard UNIX version, see Intercepting the lp and lpstat commands on
page 224.
If the printer is on a different computer: the hostname of the computer, and the
name of the Columbus OM instance that controls the printer.
CHAPTER 6
Setting up printers
Click the printer server, and then click a command on the Printers menu.
Right-click the printer server, and then click a command on the shortcut menu.
To
Modify
Duplicate
enable the printer server so that it can be used for printing Enable
documents
prevent the printer server from being used temporarily
Disable
Remove printer
from instance
151
152
CHAPTER 6
Setting up printers
Click Attribute Types, and then click one of the attributes on the pop-up
menu.
instance icon
For each attribute type you can specify one or more names and their values.
For example, to specify the fonts that are available, add a name for each font
(Times, Courier and so on), and for each of these, specify the value that
creates that font.
4
Description
Name
Value
Click Add.
Click OK.
CHAPTER 6
Setting up printers
instance icon
Style properties
Property
Description
Name
A name for the paper type. The name can include letters and
numbers; it cannot include underscores.
Font
Pitch
Page Length
Page Delay
153
154
CHAPTER 6
Setting up printers
Options properties
Property
Description
Hopper
Output Hopper
Commands
Finishing
Forms_Mode
Set Forms_Mode to
SIMPLEX
no overlay
Orientation properties
Property
Description
Orientation
Presentation
Description
Simplex
Single sided.
Duplex (SE)
Duplex (LE)
CHAPTER 6
Setting up printers
Option
Description
Simplex
Single sided.
Duplex (SE)
Duplex (LE)
In Columbus OM Explorer, right-click the icon for the printer, and then click
Mount/Unmount Paper.
In the Mount/Unmount Paper Types dialog box, select the paper types to
mount. You can select as many types as appropriate.
Click OK.
Do this
155
156
CHAPTER 6
Setting up printers
On the instances to which you want the paper types to be copied, set these
configuration parameters for netmaster:
Parameter
Set to
Get_Paper_Tabs
Yes
Name_Server
To make the changes effective, stop and then restart the netmaster server on
all the instances.
CHAPTER 6
Setting up printers
In the Available Printers list, select the printers that you want to add to the
class.
instance icon
Click Add.
Columbus OM Explorer adds the printers to the Current Printers list.
When you have added all the required printers to the class, click OK.
Do this
delete a class of
printers
157
158
CHAPTER 6
Setting up printers
Click a printer or class that you want to add, and then click Add.
instance icon
When you have added all the required printers to the group, click OK.
Do this
delete a group of
printers
File location
Printer groups are stored in files in the %UNIQDIR%\media\groups\ folder. The
name of the file is the same as the name of the printer group.
Each file contains a list of the printer servers that are in the group.
CHAPTER 6
Setting up printers
Reference
Reference
alias.tab: Server class definitions
The alias.tab file maps server classes to their associated component servers.
File location and name
%UNIQDIR%\servers\alias.tab
Content
The file contains one line for each printer or stream in a class, with two
space-separated fields.
Field
Value
class
server
Content
The file contains one line, with any number of comma-separated fields.
Server,keyword1,keyword2,keyword3,...
159
160
CHAPTER 6
Setting up printers
Reference
Value
attribute
value
Attributes
The configurable name identifiers applicable to a Columbus OM instance are listed
in %UNIQDIR%\menus\def_paper; however several of the names in that file are
actually merged into a composite Attributes setting:
Attributes attribute_list
A space-separated list of apq options enclosed in quotes "...", from this list:
-CO file
-FI file
-F file
-HP file
-OR file
-OH file
-PT file
-PR file
Forms_Mode SIMPLEX|DUPLEX|DUPLEX2|BOILERPLATE
the languages that the printer supports (for example, PCL or PostScript)
CHAPTER 6
Setting up printers
Reference
features that can be used as selection criteria by the xselect command, for
example, its resolution (DPI), its duplexing capabilities, and whether it can
print in colour. For more information about the xselect command, see
xselect: Selecting a suitable printer on page 324.
the current queue.
Requirements
For Columbus OM to get the information from a printer, the printer must be:
turned on.
Syntax
xcaps printer [snmp] [-q] [-v]
Parameters
printer
The printer: its IP address, its host name, or the name that has been set up in
Columbus OM.
snmp
(Can be used if printer is a printer name.) Uses SNMP to find out the printers
capabilities instead of the channel that is specified for the printer in its
Channel_Type parameter.
-q
or
xcaps MyPrinter
161
162
CHAPTER 6
Setting up printers
Reference
163
CHAPTER 7
Chapter 7
You can change how the printer operates by changing its configuration parameters.
For all the parameters, Columbus OM uses a default setting, which in most cases
will provide the results that you want.
To set the configuration parameters, see page 164.
To
See
print a banner page at the start of every Printing banner pages on page 172
document
change the format of documents
164
CHAPTER 7
If you are adding a new printer: In the Add New Printer dialog box, click
the Advanced Settings tab.
Click
instance
The list includes only the configuration parameters that apply to the type of
printer that you selected on the Printer tab.
3
Click the parameter whose value you want to change. For more information
about the parameters, see Configuring the printer features on page 163.
Click OK.
CHAPTER 7
Floor
Ceiling
For example:
210 16 Oct 12:45:04 Invalid document format
The number must be a three-digit number that indicates the type of error, and
what you want Columbus OM to do:
Number range
Description
Columbus OM action
000 099
100 199
Temporary error
200 299
Fatal error
300 399
Configuration error
Set the Input_Filter parameter to the path and name of the program.
165
166
CHAPTER 7
Select
Only
No
Codes_Accepted
Codes_Barred
Changing
document
formats
If the printer is able to recognize the format of the document, set the printers
Set_Language parameter to No.
If the printer is unable to recognize the format of the document, set the printers
Set_Language parameter to Yes.
You can change the format of a document by using a filter program before it is
printed. For example:
CHAPTER 7
To convert ASCII (plain text format) files to PostScript, see Converting text
documents to PostScript on page 167.
Method 1
Set the Input_Filter parameter to the path and name of the filter.
Method 2
1
Set the Code_Filter parameter to the path and name of the filter program.
167
168
CHAPTER 7
Applying overlays
Applying overlays
If your printer supports overlays, this section explains how to set up Columbus OM
so that overlays can be applied to documents. Columbus OM prints the overlay on
top of the document to create the final output.
To apply an overlay, you need to:
Creating an
overlay
the back of the first sheet of the document (that is the second page of data)
the front of all the other sheets in the document (the odd-numbered pages)
the back of all the other sheets in the document (the even-numbered pages).
Print the document to a file, using a printer driver that is supported by the
printer that you want to use.
Give the file the same name as the paper type to which it relates.
where:
printer_type is the name of the printer type that will use the overlay.
Use
INITF
the back of the first sheet of the document (that is the second page INITB
of data)
OVLYF
OVLYB
CHAPTER 7
Applying overlays
The application used to create the overlay might have included unwanted
information. To tidy the file, use the ovclean program (see ovclean: Create
overlay files on page 169.
Avoid print commands such as printer reset (<Esc>E) because they can affect
the subsequent printed data.
On HP printers and compatibles, do not use these escape codes:
<Esc>E (printer reset)
<Esc>&|#X (number of copies)
<Esc>&|#S (simplex/duplex instructions)
<Esc>&|#A (paper size), or any other codes that are described as paper
control
<Control-L (formfeed)
If a value is SET in the overlay file, it remains set when the main data is printed,
unless you specifically reset the value.
If the printer does not support overlays in hardware (the graphic cannot be
stored in the printers memory), then the file must include a cursor position to
the origin (0,0) at the end to reset the print position ready for the user data.
169
170
CHAPTER 7
Applying overlays
-install|-i
Use macro number to specify the conversion process; the default is 14.
-paper|-p
Set Forms_Mode to
SIMPLEX
BOILERPLATE
If duplex printing is being used, you must set up files that contain the
commands to set up the printer into the correct mode. These are:
PORTRAIT
Simplex portrait.
LANDSCAPE
Simplex landscape.
DUPPORTLE
DUPLANDLE
DUPPORTSE
DUPLANDSE
Set Forms_Flash to
HARD
SOFT
CHAPTER 7
Applying overlays
Some printers have extra memory that can store graphical overlays, so
Columbus OM has to send the overlay to the printer only once, at the start of
the document. If the printer does not have this extra memory, then
Columbus OM has to send the overlay with each page, which slows down the
printing.
171
172
CHAPTER 7
For a PCL printer, the banner page can include substitution variables (see
page 603). You can simulate large characters by including the keyword banner.
For example, if you include BANNER %OWNER, Columbus OM prints the owners
name in large characters. To specify the maximum width of this large text, include
a number in brackets after BANNER, for example: BANNER(80) %OWNER.
To print the banner page on different paper to that used for the document itself,
you might be able to include control characters at the start (to select an alternative
paper tray) and at the end (to reset the paper tray). For more information, see the
printers documentation.
If the printer supports both PostScript and non-Postscript documents, you can
create two banner files.
Configuring Columbus OM to print banner pages
To print a banner page
Do this
Value
Banner
Yes
Banner_File
The path and name of the file that contains the banner
page. If the banner page is in PostScript format, set the
Banner_PSFile parameter instead.
CHAPTER 7
Parameter
Value
Banner_FF
PostScript_End
173
174
CHAPTER 7
Formatting documents
Formatting documents
This section explains the parameters that you can use to format documents.
You might not need to set any of the parameters because most applications that
produce documents also format them.
To
See
define text to be printed at the top or bottom of Headers and footers below
every page
control the printer, for example to specify the
default font to be used
make wide documents fit the page by changing Formatting text files to fit the
the orientation or pitch
paper on page 178
Headers and
footers
Intervention strings on
page 177
You can add a header and a footer at the top and bottom of every page.
1
Create a file that defines the format of the header or footer (see Header and
footer file format below).
The file can be stored anywhere on the host.
To print both a header and a footer, create a separate file for each.
Value
Header and/or
Footer
Page_Width
Parameters
text
CHAPTER 7
Formatting documents
The text that you want to be printed. The text can include substitution
variables, for example %TIME for the current time or %DOCUMENT for the
documents filename.
lines
The number of blank lines to be printed between the header or footer and the
rest of the document.
Example file
LEFT %OWNER
CENTRE %DOCUMENT
RIGHT Page %MESSAGE
BEFORE_GAP 0
AFTER_GAP 1
Printer control
Report1.doc
Page 1
Use the following parameters to control the printer, for example, to add form feeds.
To
Parameter
Value
Command
Finishing
Suffix
CR_Required
force the printer to print a
carriage return character after
every newline character
Yes
Yes
Format
Format
175
176
CHAPTER 7
Formatting documents
To
Parameter
Value
Yes
Default font
where:
name
-sn
-xn
-yn
-in
-ln
For example:
/ Courier -s10 -x30 -y780 -i11 -l66
Other formatting To set default values for the hopper, orientation and so on, set these parameters.
For each parameter, specify the control codes that select the default value that you
defaults
want. For information about the control codes to use, see the printers
documentation.
These parameters might be overriden by the values set for the printers paper type.
These parameters do not affect PostScript printers.
Parameter
Hopper
input hopper
Orientation
Output_Hopper
output hopper
CHAPTER 7
Formatting documents
Parameter
Pitch
Presentation
For example, to set the default pitch to 10 on an HP LaserJet printer, set the Pitch
parameter to <esc>&k0S.
Intervention
strings
You can create documents that contain control codes to change values such as the
font and orientation.
1
Specify
string filename
string(filename)
Replace:
string with a word that indicates what the command does. For example,
to change the font, you could use ##CHANGEFONT. You can use any word, as
long as that word does not appear anywhere in the main text of the
document.
filename with the name of the file that you created in step 1.
To tell Columbus OM what string you have used, specify one of the
following parameters:
To specify a string that
Co_Intervention_String
Fi_Intervention_String
specifies a font
Ft_Intervention_String
Hp_Intervention_String
Or_Intervention_String
Pr_Intervention_String
Pt_Intervention_String
Example
Create a file that contains the control codes that change the font to Helvetica.
Call the file helvetica.cmd.
In the document, at the point where you want to change the font, add:
177
178
CHAPTER 7
Formatting documents
##CHANGEFONT(helvetica.cmd)
3
Formatting text
files to fit the
paper
You can make sure that documents that are in ASCII-text fit on the paper by either:
changing the paper orientation (for example, if the file contains very long lines,
you can print it on landscape orientation instead of portrait)
Value
Prefix
Input_Filter
A number of characters. Documents that contain lines of this length or less are
affected by what you specify in attribute value1. Documents that contain
lines longer than this length are affected by what you specify in value2.
printer
What you want to change the attribute to if the document contains short lines,
for example PORTRAIT or 12.
value2
What you want to change the attribute to if the document contains long lines,
for example LANDSCAPE or 16.
Example 1
..\..\programs\tools\rotate 80 ORIENTATION PORTRAIT LANDSCAPE
Example 2
..\..\programs\tools\rotate 80 PITCH 12 16
CHAPTER 7
Formatting documents
Error handling
If the rotate program encounters any errors, Columbus OM disables the printer
and writes a message in its day log.
Error
Description
Printing multiple Multiple page images can be printed on a single side of paper, by reducing the size
page images on of each page image. This feature is available for ASCII format files printed on HP
and compatible printers.
single sheets
A four page document
is usually printed on
four sides
Page 1
Page 1
Page 2
Page 2
Page 1
Page 2
Page 3
Page 4
Page 3
Page 1
Page 2
Page 3
Page 4
Page 3
Page 4
Page 4
179
180
CHAPTER 7
Formatting documents
Set these parameters for the printer (see Configuring the printer on page 164):
Parameter
Set to
Format
No
Any_Paper
Yes
Paper_Mandatory
No
Output_Filter
To enable the user to select what type of multiple images to print, set
Output_Filter to:
%UNIQDIR%\programs\tools\multipage %SERVER_INFO
Then mount the paper types that are associated with multipage printing: one or
more of 1UP, 2UP and 4UP (see Assigning paper types to a printer on
page 155). You can also create your own paper types that print multiple images
by setting their Orientation to either 2UP or 4UP.
When you add a print request, choose the appropriate paper type.
To set a default which the user can override by choosing a paper type, set
Output_Filter to:
%UNIQDIR%\programs\tools\multipage -p images %SERVER_INFO
CHAPTER 7
Assured delivery
Assured delivery
Assured delivery tells you when a page or a document is printed instead of when it
has been sent to the printer.
This feature works with PJL-enabled printers (including HP printers and
compatible printers) that are connected to the host or to the network.
With this feature, the printer pauses at the end of each page, after every 2000
characters, or at the end of each document. When it has confirmed that the text has
been printed, it prints the next part of the text.
To use it, set the printers Driver parameter:
To check
Set Driver to
pjlout -t
pjlout
pjlout -e
181
182
CHAPTER 7
Set the Attempts_Limit parameter to the maximum number of times that you
want Columbus OM to attempt to print a document.
If it cannot print the document after this number of attempts, it sets the
documents status to Failed, moves it to the completed queue, and stops
trying to print it.
If you want Columbus OM to try only once to print each document, set this
parameter to either 0 or 1:
0 tries to print the document once, and sets the documents status to
Completed whether or not it was successful.
1 tries to print the document once, and if it fails, sets the documents status
to Failed.
2
Set the Postpone_Time parameter to specify the interval (in seconds) between
trying again to print a document if it fails the first time.
CHAPTER 7
Value
Batch_Aliases
Yes
Alias_Limit
Alias_Banner
Alias_Banner_File or
Alias_Banner_PSFile
183
184
CHAPTER 7
185
CHAPTER 8
Chapter 8
See
how to configure a device to use xprinter Configuring a printer to use the xprinter
driver on page 188
the modes in which xprinter can deliver xprinter delivery modes on page 189
documents
control what happens if a page or
document does not print
control what happens if a printer cannot Handling stalled printers on page 195
complete a document
print banner pages at the start of a
document or to warn of problems
186
CHAPTER 8
Channel types
Channel
Description
Example
COMMAND
IPP
NLPD
PJL
RAWLPD
CHAPTER 8
Channel
Description
Example
SNMP
VIP
WLPD
XLPD
XPP
XPP1
XPP printers.
The XPP1 protocol is used to
send data and to control the
device. This channel is usually
used only for testing and resolving
problems with the XPP/XPP2
protocol.
XPP printers.
187
188
CHAPTER 8
In the Add New Printer dialog box, select XPrinter, and then click the
XPrinter Details tab.
Property
Description
Host Name
Port Number
Channel Type
On Advanced Settings tab, set other parameters as required, and then click
OK.
CHAPTER 8
standard
Standard
delivery mode
Secure delivery
mode
Parameter
Value
Server
Medium
Device
Channel_Type
PJL
Delivery_Mode
""
In secure delivery mode, Columbus OM sends the document one page at a time.
Columbus OM sends the next page only when the printer has sent a message
confirming that it has finished printing the previous page.
If Columbus OM does not receive the confirmation message from the printer, it
can take remedial action. See Handling delivery failures on page 195.
Secure printing is slower than other methods.
Requirements
This feature cannot be used with devices that have an onboard queue.
Value
Server
Medium
189
190
CHAPTER 8
Overlapping
delivery mode
Parameter
Value
Device
Channel_Type
PJL
Delivery_Mode
secure
Page_Mode
intelligent
Overlapping delivery mode with xprinter provides fast delivery with end-to-end
security.
Columbus OM sends the documents to the printer as fast as it can. It sets the status
of an entry to Completed only when the printer has confirmed that it has finished
printing the document.
If an error occurs, remedial action can be taken. If the job control language is PJL,
recovery is at page level. An error banner page can be printed, indicating if any
pages might have been duplicated.
Overlapping delivery mode is faster than secure printing (see Secure delivery
mode on page 189), and is secure at document level.
Requirements
Value
Server
Medium
Device
Delivery_Mode
Overlapping
Value
Channel_Queue
Hard_Queue
Max_Overlap
CHAPTER 8
Raw delivery
mode
Raw delivery mode is similar to the standard printer driver operation. There is no
communication with the printer. As soon as Columbus OM has sent all of the data
for a document to the printer, it sets the status of the entry to Completed.
To configure a device to use raw delivery mode
Value
Channel_Type
RAW
Device
Medium
Server
191
192
CHAPTER 8
the reprinting of a document that had an error and was not completed
The banner page is separate from the document: that is, it is produced by
Columbus OM and not by the application that produced the document; and it is
not included in the page count for the document.
Printing banner
pages
Description
Banner
Set to Yes.
See also Printing banner pages on page 172.
XBanner_Type
Error_Banner
XError_File
Set the XBanner_Type parameter according to the printer languages that the
printer supports.
If the printer supports
Set XBanner_Type to
only text
TXT
PCL
only PostScript
PS
PCL
CHAPTER 8
Description
XBanner_File
XNormal_Message
XReprint_Message
XResume_Message
XTemplate_File
Banner pages
available
how many pages are still to be printed, and if any pages will be reprinted
(taking into account the action that is specified by the Unconfirmed_Action
parameter: see Handling delivery failures on page 195).
To print these banner pages, use the Error_Banner and XError_File parameters.
193
194
CHAPTER 8
Customizing the
banner pages
To customize the banner pages, edit the template files that are in the
Columbus OM config folder.
Banner page template files
There are separate files for each format:
xtemplate.pcl
xtemplate.ps
xtemplate.txt.
In the template file, you can change the literal text and substitution variables. For
example, the xtemplate.pcl file looks like this:
UID:
%UID
Name: %DOCUMENT
Owner: %OWNER
%MESSAGE
%UNIQDIR%\config\xnormal_message.tab
xpreprint_message.tab
xresume_message.tab.
More information about how to use these files is contained in the files themselves.
To change the language in which the message is displayed, see Changing the
language used for banner pages below.
These files are used by all xprinter devices. To change the messages used by a
specific xprinter device, see Using different banner pages on page 193.
To print the messages that are displayed on the banner pages in a different
Changing the
language, do the following:
language used
for banner pages 1 Copy the set of files for the appropriate language from the %UNIQDIR%\lang
folder to the %UNIQDIR%\config folder.
2
CHAPTER 8
Set Unconfirmed_Action to
RESTART
RESUME
Leave blank.
See also Banner pages for warnings and errors on page 193.
The device must support PJL, and the Channel_Type parameter must be set to
PJL.
The delivery mode must be either secure or standard (as indicated by the
devices Delivery_Mode parameter). See also xprinter delivery modes on
page 189.
Printers
Actions.
printer
195
196
CHAPTER 8
Entry format
The file contains one line for each status.
status
delay
action
offset
destination
Field
Value
Offline_Error
Processing
Cover_Open
Offline_No_Error
Ready
Error
Offline_No_Info
Ribbon_Jam
Intray_Empty
Other
Ribbon_Low
Intray_Missing
Outtray_Full
Service
Maintenance
Outtray_Missing
Toner_Low
Marker_Missing
Outtray_Near_Full
Unavailable
No_Ribbon
Paper_Jam
Unknown
No_Toner
Paper_Low
Warmup
Offline
Paper_Out
The period (measured in seconds) that the status must last for, before the
action is performed.
Description
DISABLE
FAIL
IGNORE
REDIRECT
REPOSITION
Description
-n
CHAPTER 8
Field
Value
+n
Skip n pages.
(Used with the REDIRECT action.) The name of the printer to use. The
printer must be the same type as the original printer.
Delay(secs)
----------12
15
5
64
50
5
Action
---------REPOSITION
REDIRECT
REDIRECT
FAIL
DISABLE
REDIRECT
Offset
------5
0
0
Destination
-----------
MyPrinter2
MyPrinter2
MyPrinter2
If the printer reports that its toner is low, and the message appears for at least
12 seconds, Columbus OM reprints the previous 5 pages of the document, and
then prints the rest of the document.
If the printer reports that its cover is open (perhaps because it is being
serviced), Columbus OM redirects the document to a different printer,
MyPrinter2.
197
198
CHAPTER 8
Value
Server
name
Medium
Device
Channel_Queue
Channel_Type
SNMP
Delivery_Mode
Overlapping
Hard_Queue
Yes
Value
Server
name
Medium
Device
Channel_Queue
Channel_Type
XLPD
Delivery_Mode
Overlapping
Hard_Queue
Yes
Value
Server
name
Medium
Device
CHAPTER 8
Parameter
Value
Channel_Queue
Channel_Type
NLPD
Delivery_Mode
Overlapping
Hard_Queue
Yes
Value
Server
name
Medium
Device
Channel_Queue
Channel_Type
WLPD
Delivery_Mode
Overlapping
Hard_Queue
Yes
Value
Server
name
Device
Channel_Type
VIP
Delivery_Mode
Overlapping
Hard_Queue
Yes
Map_Prio_0 to
Map_Prio_9
Profile_Exit
VIP_Data_Root
VIP_Data_Root_Name
VIP_Directory
199
200
CHAPTER 8
Parameter
Value
VIP_Directory_Name
VIP_Force_Disk_Mode
(Optional.)
Yes writes the document to the shared disk.
No writes the document to the device socket.
Value
Channel_Type
IPP
Device
ippinfo
ippinfo is not recommended for use with Xerox printers.
Xerox printers always return the worst case status: for
example, if a paper tray is empty, ippinfo reports that the
printer is unavailable, even if other paper trays contain
paper. (See also Quick_Ipp below.)
Quick_Ipp
Yes or No
CHAPTER 8
Parameter
Value
URI_Extension
Delivery_Mode
Value
Channel_Type
COMMAND
Device
"myscript myargs"
201
202
CHAPTER 8
Reference
Reference
xprinter configuration
Configuration file
%UNIQDIR%\servers\printer_name\config.tab
Configuration parameters
The following parameters are specific to xprinter. If you cannot find a parameter
in this section, see Other xprinter configuration parameters on page 208.
Accounting_DB_Method
Accounting_DB_Type
These values override the values that are set in the system defaults files.
Accounting_XML_Port number
Accounting_XML_Server text
To analyze
Do this
Specify ALL.
CHAPTER 8
Reference
To analyze
Do this
no document formats
Specify NONE.
selected document
formats
Block_Size number
The maximum size (measured in bytes) of the blocks of data that are to be sent
to the printer.
This parameter is used only if PAGE_MODE is set to BLOCKED.
The default size is 500000.
BlockAct_Messages YES|NO
YES sends a pop-up message to the entry owner if the entry becomes blocked.
See also Message_Type.
Channel_Queue queue
The name of the onboard queue. For example, on DocuCenter devices, the
queue is print.
The default value is print.
Channel_Type SNMP|PJL|XPP|RAW|VIP|XLPD|NLPD|IPP
The channel type. For more information, see Devices supported by xprinter
on page 186.
Check_Page_Meter Yes|No
(Used with the RAW and RAWLPD channel types.) Enables assured delivery
by checking when a document has finished that the printers page counter
increases by the same number of pages that are in the document.
This feature can be used with printers that have a lifetime page counter that can
be accessed by their MIB.
Columbus OM records the page count both before and after printing the
document in the printers day logfile.
See also the Page_Meter_Wait parameter.
Check_Status Yes|No
data to it. When the printer becomes available again, Columbus OM starts
sending data to it.
No assumes that the printer is always available, and sends the data to it without
checking.
203
204
CHAPTER 8
Reference
The interval at which xprinter tries to connect to a printer, if it can not connect
at the first attempt.
To specify the interval in seconds, put only the number, for example:
Connect_Interval 10.
To specify the interval in milliseconds, put the number followed by m, for
example: Connect_Interval 1000m.
The minimum value is 0. The maximum value is 32767.
The default value is 1.
Connect_Retries number
The delivery mode. For more information, see xprinter delivery modes on
page 189.
For standard delivery mode, specify "".
Device "NETWORK host port"
The delay after breaking a connection and before continuing; some networks
require a short recovery period after disconnecting.
To specify the value in seconds, use only the number (for example,
Disconnect_Delay 1).
To specify the value in milliseconds, use the number followed by m (for
example, Disconnect_Delay 1000m)
The default value is 4 (seconds).
Error_Messages YES|NO
YES sends a pop-up message to the owner if an error occurs. See also
Message_Type.
Forms_Flash YES|NO
YES sends a forms overlay to the printer to be printed with the document.
You can specify a different forms overlay for each paper type. Put the file that
contains the forms overlay in this folder:
%UNIQDIR%\media\print\printertype\FORMS\INITF\papertype
CHAPTER 8
Reference
Hard_Queue YES|NO
YES indicates that the printers onboard queue is disk-based (non-volatile).
IDOL_Analysis YES|NO
YES analyzes IDOL documents to find out their requirements. See also
Analysis_Mode.
Incomplete_Timeout number
The maximum time (measured in seconds) that Columbus OM waits for the
printer to return a message confirming that an entry has been completed. After
this time, it moves the entry to the completed queue, and sets its status to
Incomplete.
Job_Control PJL|JOB_TICKET
The job control protocol that is used to control the printer and to separate the
datastream.
Value
Description
PJL
Job_Ticket
An application for changing the job control. Columbus OM submits the job
control to the application, the application changes it, and then Columbus OM
uses the result.
Job_Control_Rules filename
The network card to which a server binds. This parameter is required only if
the computer has multiple network cards (which means that it also has multiple
host names).
The value can be:
205
206
CHAPTER 8
Reference
Max_Overlap number
Value
NS
UW
Page_Meter_Wait number
PCL6_Analysis YES|NO
YES analyzes PCL 6 documents to find out their requirements. See also
Analysis_Mode and PCL_Analysis.
PCL_Analysis YES|NO
YES analyzes PCL documents to find out their requirements. See also
Analysis_Mode and PCL6_Analysis.
PDF_Analysis YES|NO
YES analyzes PDF documents to find out their requirements. See also
Analysis_Mode.
PostScript YES|NO
YES indicates that the printer supports PostScript.
Profile_Exit text
CHAPTER 8
Reference
PSD3_Analysis YES|NO
YES analyzes PostScript level 3 documents to find out their requirements. See
also Analysis_Mode.
Removed_Action CANCEL|COMPLETE|FAIL|INCOMPLETE
Specifies the status to be applied to entries that disappear from the LPD queue
between scans without having apparently been printed. This might happen if a
user deletes the entry; if the job is so small that it completes in the interval
between scans; or if the printer is slow to update its queue.
The default value is CANCEL.
Response_Timeout number
Specifies the maximum time (measured in seconds) that xprinter waits for a
status message from a printer after sending a job to it. If the printer does not
send a status message within this time, xprinter assumes that a problem has
occurred, and then tries to send the job again.
The default value is 90 (seconds).
Start_Messages YES|NO
YES sends a pop-up message to the entry owner when the entry is started. See
also Message_Type.
Sync_Check_Limit number
specific end-of-page marker, by adding a formfeed to force the last page out of
the document. Without this feature, there might be delay of about one minute
for the last page is output.
Unconfirmed_Action RESTART|RESUME|COMPLETE
Do this
207
208
CHAPTER 8
Reference
To
Do this
take no action
Use_Doc_Suffix Yes|No
Yes identifies the format of a document by using its file name extension. For
example, .txt identifies the format as TEXT.
No identifies the format by examining the content of the file.
Wait_For_Close Yes|No
Yes waits for printer messages before closing a connection. This might take a
few seconds before connection can be closed: in an environment with high
throughput, you can close the connection without waiting for the messages by
setting the parameter to No.
(Used with Emtex VIP-connected printers.) Controls how plain text is handled:
XRX sends plain text as DJDE. The default value is PCL.
XPP_TIMEOUT n
The maximum time (measured in seconds) that xprinter waits for a printer to
respond (for example, to report that it is XPP-capable; that it has printed a
block of data; or how much memory it has available).
The default time is 120 seconds.
Other xprinter configuration parameters
xprinter also has the following configuration parameters:
These configuration parameters specify how banner pages are produced. for
more information, see Banner pages for xprinter on page 192.
Error_Banner
XBanner_File
XBanner_Type
XError_File
XNormal_Message
XReprint_Message
XResume_Message
XTemplate_File
Parameters starting with VIP (for example, VIP_Data_Root) are used with
Emtex VIP-connected printers. For more information, see Configuring Emtex
VIP-connected printers on page 199.
These configuration parameters are the same as for a printer server. For more
information, see page 129.
CHAPTER 8
Action_On_Completion
Action_On_Failure
Action_On_Postponement
Action_On_Start
Action_Pre_Completion
Any_Paper
Attempts_Limit
BackChannel
Banner
Ceiling
Floor
Hold_Connect
Input_Filter
Keepalive_Time
Medium
Paper
Paper_Mandatory
Pause_Time
Postpone_Time
PostScript
Printer_ID
Query_Printer
Scan_Interval
Server
Status_Type
Reference
209
210
CHAPTER 8
Reference
211
CHAPTER 9
Chapter 9
Adding entries
There are several ways of adding entries for processing by Columbus OM.
In a production system, entries are usually added by using the command line.
On UNIX, you can intercept lp requests and lpr/lpd requests, and then add
them to Columbus OM.
To integrate Columbus OM with another application, you scan folders for files
that the other application has created, and then add them to Columbus OM.
Users without direct access to a Columbus OM instance can still use it to print
documents, if they can transfer files to the host on which a Columbus OM
instance is installed.
To
See
page 212
page 216
page 224
page 234
page 232
212
CHAPTER 9
Adding entries
Do this
Disabled
printer
Do this
CHAPTER 9
Adding entries
To
Do this
Printing documents
Document formats for printing
Printing documents
1
Under the instance icon, select the type of printer that you want to use:
Folder
Description
Printers
Remote Printers
Printer Classes
In the navigation pane, click the printer or printer class that you want to use.
213
214
CHAPTER 9
Adding entries
Select
On Local (ASCII)
On Local (Binary)
On Server
In the Document box, type the path and name of the file, or click the
(Browse) button.
Select the Medium that indicates the server that you want to process the
document, usually print.
Do this
Do this
CHAPTER 9
Adding entries
To
Do this
control how long the document is to be On the Details tab, set the Retain for
kept on the Completed queue when it
option.
has been processed
delete the document when it has been
processed (instead of moving it to the
Completed queue)
Do this
215
216
CHAPTER 9
Adding entries
The document is the literal text string, which should be enclosed in quotation
marks "..." if it contains spaces.
Specifying the destination
Use one of these keywords to specify the destinations to be used. Columbus OM
adds a separate queue entry for each destination. For multiple documents and
multiple destinations, Columbus OM sends the first document to all destinations,
then the second document, and so on. If the destination is omitted, the default is
taken from the Address system parameter (in the default.tab file). The
destination must be 80 characters or less.
-ADDRESS_FILE|-af file
The destinations are listed in the file that you specify. Each destination has one
of these forms:
destination
destination
# string
The optional string is included in the queue entry for identification purposes,
but can be overridden by -REMARK_FILE and -REMARK_TEXT.
CHAPTER 9
Adding entries
-ADDRESS_TEXT|-at destination
A destination appropriate to the function that you are using, for example, a
printer, a fax number, or an email address. For the Columbus OM dispatch
instance, it does not represent a conventional destination and so can be any
character string, which can be tested in the rules.
Specifying the qualifiers
The command normally adds and changes entries in the pending section of the
queue instance which is defined by the value of %UNIQDIR%. You can affect this,
and the commands output, using these qualifiers.
-ARCHIVE|-ar [number]
Change an entry in the completed section of the queue. The only attribute
which you can change is -RETENTION_DAYS.
-NO_BANNER|-nb
-NO_WARNING|-nw
-QUEUE_NAME|-qn instance
-SILENT|-si
Only when adding entries: Create number queue entries for each source
document.
-ENCRYPT|-enc|-en [NO|YES|AES128|AES192|AES256]
Only when adding entries: Controls whether the document file is encrypted when
it is on the queue. The encryption system that is used is AES (Rijndael).
217
218
CHAPTER 9
Adding entries
Only when adding entries: The first page of the source document to be processed;
earlier pages are discarded from the queued file. The default is the start of the
file.
-HELP|-h
Set the entrys status to Held; it will not be processed until released (using
-RELEASE).
-MEDIUM|-m medium
The transmission medium. The available media are defined in the media.tab
file.
-NO_COPY|-nc
Only when adding: Use the source document directly, rather than take a
temporary copy. Cannot be used with -FROM_PAGE and -TO_PAGE.
-NO_READ|-nr
Only when adding: Do not read the source document (to determine its size), also
do not take a temporary copy. Used to save time when queuing very large
documents. Cannot be used with -FROM_PAGE and -TO_PAGE.
-ORIGINAL_UID|-ou entry_id
The entry belongs to user_id. If you do not use this parameter, the entry
belongs to the user whom you are logged in as.
-PAGE_LENGTH|-pl number
CHAPTER 9
Adding entries
-PC number
Specifies the page count (instead of using Columbus OMs features to count the
pages).
-PRIORITY|-p number
The identification of the program which created the queue entry (useful when
entries are being added directly from an application). Must be 32 characters or
less.
-RELEASE|-r
Only when changing entries: Change the entrys status from Held (set using -HOLD)
to New, so that it can now be processed.
-REMARK_FILE|-rf file
file contains a queue entry annotation.
-REMARK_TEXT|-rt string
string is a queue entry annotation of up to 80 characters, enclosed in
quotation marks "..." if it contains spaces.
-REPORT_UID|-ru file
Only when adding: If the attempt to add the source document to the queue is
successful, its entry_id is written to the file; otherwise, 0 is written.
-RETENTION_DAYS|-rd number
The minimum number of days that the entry should be retained on the
completed queue after having been processed.
To delete the entry as soon as it has been completed successfully, specify -1.
-SECURITY_LEVEL|-sl {number|text}
Specifies the security level to be applied. The security levels are listed in the
seclev.tab file. You can specify either the number or the description.
-SECURITY_GROUP|-sg text
Specifies the security group to be applied, that is, a user group file in the
security folder, without the u_ prefix.
-SERVER_TEXT|-st string
219
220
CHAPTER 9
Adding entries
-TIME|-t time
The earliest point at which the source document should be processed, one of:
hh:mm
-TO_PAGE|-tp number
Only when adding: The last page of the source document to be processed; later
pages are discarded from the queued file. The default is the end of the file.
apq command
To add print entries or change the properties of existing entries from the command
line, use the apq command.
Syntax for adding an entry
apq [documents] [destination] [option...] [qualifier...]
1 or POSTSCRIPT or PS
CHAPTER 9
Adding entries
2 or PCL
4 or PDF
5 or BENSON
8 or HTML
10 or EPSON
12 or AFPDS
other numbers
user-specified encodings
The medium of the server that is to process the entry, usually PRINT.
-NON_POSTSCRIPT|-nps
type to be used.
-PITCH|-pt file
Sets the character spacing to be used: put the control codes for the character
spacing in a file in the %UNIQDIR%\media\print\printer_type\PITCH
folder, and then specify the name of the file here.
221
222
CHAPTER 9
Adding entries
-POSTSCRIPT|-ps
Sets the presentation to be used, by applying the control codes that are in the
file specified. The file must be in this folder:
%UNIQDIR%\media\print\printer_type\PRESENTATION.
-SPECIAL_COPY|-sc
The following options for the apq command have the same effect as for the aeq
command: for more information, see Specifying the options on page 217.
-ALIAS|-as string
-CHAIN|-c [entry_id]
-CHILD
-COPIES|-cp number
-FROM_PAGE|-fp number
-HELP|-h
-HOLD|-h
-NO_COPY|-nc
-NO_READ|-nr
-ORIGINAL_UID|-ou entry_id
-OWNER|-o user_id
-PAGE_LENGTH|-pl number
-PRIORITY|-p number
-PROGRAM|-pg string
-RELEASE|-r
-REMARK_FILE|-rf file
-REMARK_TEXT|-rt string
-REPORT_UID|-ru file
-RETENTION_DAYS|-rd number
-SECURITY_LEVEL|-sl {number|string}
-SECURITY_GROUP|-sg string
-SERVER_TEXT|-st string
-SPECIAL_COPY|-sc
-TIME|-t time
-TO_PAGE|-tp number
CHAPTER 9
Adding entries
223
224
CHAPTER 9
Adding entries
or
uniqlp [option...] file...
A list of files to be submitted. Include the paths to the files. To specify two or
more files, separate their paths by using a space. The paths can include
wildcard characters.
-atime
+[DD.]hh:mm
-bN|-bY
(Columbus OM.) To print a banner page, use -bY. To omit the banner page,
use -bN.
-c
Take a temporary copy, rather than use the source document directly.
CHAPTER 9
Adding entries
-dprinter
(Columbus OM.) number is the last page of the source document to be sent to
the destination; the default is the end of the file.
-fnumber
(Columbus OM.) number is the first page of the source document to be sent to
the destination; the default is the start of the file.
-gusername
(Columbus OM.) Adds the entries as belong to the user specified (instead of the
user whom you are logged in as).
-h
(Columbus OM.) Sets the status of the entries to Held. They will be printed
only when they are released.
-jentry_id
(Columbus OM.) A range of pages is being specified (using -f and -e) but the
document is not paginated using formfeed characters: therefore, page breaks
are to be calculated by counting number lines per page. The default is obtained
from the paper_type definition, or from the destination.
-m
225
226
CHAPTER 9
Adding entries
-rstring
CHAPTER 9
Adding entries
Start lpdserver.
The lpdserver server listens on the same TCP/IP socket as the lpr/lpd
process (number 515), and then translates incoming lpr/lpd requests to
Columbus OM print queue entries.
In the instances systems.tab file, add the other instances, in the order that
you want lpdserver to check them.
lpdserver looks at the name of the printer that the user has selected for an
entry (for example, Accounts).
the control and data file set must be sent as a pair, one immediately after the
other
227
228
CHAPTER 9
Adding entries
You have a system in which spool requests are added to a client instance of
Columbus OM. This instance sends the entries to a server instance of
Columbus OM. You want the server instance to print the entries in sequence.
1
On the client, set this parameter in the system defaults file (default.tab):
UID_order
YES
On the server, set the same parameter in the system defaults file:
UID_order
YES
Example 2
You have a system in which lp/lpr spool requests are added to a client instance of
Columbus OM. This instance sends the entries to a server instance of
Columbus OM. You want the server instance to print the entries in sequence.
1
YES
YES
"syq -tnw lpdserver 5/2"
AUTO
YES
Configuring lpdserver
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Action_On_AddFailure script
Specifies a command to be obeyed in the event that a request was not added
successfully to the pending queue.
CHAPTER 9
Adding entries
For example, this example stops lpdserver if it cannot add to the queue thus
alerting subsequent lp/lpr requests:
Action_On_AddFailure
Action_On_Shutdown command
A command to be run when the server stops. For more information, see
Operating system actions during processing on page 417.
Bundle_Files YES|NO
All items from the lp/lpr command line will be put in one queue entry.
This parameter cannot be used with RestrictedMode YES.
Class CRYPT|DEST|IGNORE|PAPER|SECLEV|SOURCE
The action to be taken when the server is sent a Receive Job subcommand C
specifying a class name.
To
Specify
IGNORE
use the class value as the entrys encryption method (the value
must be No, Yes, AES128, AES192 or AES256)
CRYPT
DEST
PAPER
SECLEV
SOURCE
Local_Host host
The network card to which a server binds. This parameter is required only if
the computer has multiple network cards (which means that it also has multiple
host names).
The value can be:
Controls what happens if the lpdserver cannot write the data file that it receives
to the disk (for example, if the disk is full). Setting this parameter to Yes sends a
NAK to the sender immediately.
229
230
CHAPTER 9
Adding entries
Preprocess OWNER|PAPER|ALIAS=DF_NAME[n:m]
Extracts the owner name, paper type, or alias from the document filename.
Specify the position of the value that is in the filename by using [n:m]. (Include
the brackets.)
n is the number of the character where the value starts. If the value starts at
the start of the filename, you can omit the n part.
m is the number of the character where the value ends. If the length of the
value varies, you can omit the m part.
For example, if the filename includes the owners name like this:
ABCDE0123SMITH (where SMITH is the owners name)
you can set the owner property of the entry when it is added to the print queue
by specifying: PREPROCESS OWNER=DFNAME[10:14] (if the name is always 5
characters) or PREPROCESS OWNER=DFNAME[10:] (if the name always starts at
the 10th character but can be any length).
Priority n
A number from 1 to 9 which lpdserver will set as a priority on all the requests
it receives.
RestrictedMode YES|NO
YES to send a response back after the entry has been added to the pending
queue. (Normally lpdserver sends a response back to the sending process
after the print request has been received but before it has been added to the
pending queue.)
RestrictedMode YES also ensures that entries are added to the pending queue
in sequence. (Note that lpdserver can only honour the sequence if a regular
form of the lpr/lpd protocol is used. Thus lpr requests which result in the
control and data file set not being sent as a contiguous pair are excluded as are
additional copies that are specified on the command line.)
Because indexing large PCL files might cause the protocol to time-out, it is
recommended that AEQ_index is set to NO in the systems default
(default.tab) when using this mode.
It is recommended that Action_On_AddFailure is set for use with this mode.
Scan_Instances YES|NO
YES (the default) to transfer incoming lpd requests to the instance where the
specified printer is configured; NO to queue it on the local instance.
Security_Level number
The security level to be applied to entries. The security levels that you can use
are stored in the seclev.tab file.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
CHAPTER 9
Adding entries
Service service
The full path of a folder used to hold documents temporarily, used instead of
the systems default temporary location which might have insufficient capacity.
AUTO means that the temporary file will be created in
UNIQDIR%\queue\document. This is the preferred option since an additional
The interval in seconds at which the server suspends its normal listening
function in order to perform any necessary housekeeping. The default is 10.
Zero_Is_ASCII Yes|No
Tells Columbus OM how to process files whose size is indicated in the data file
to be zero.
Yes tells Columbus OM to finish the job immediately. Use this setting only
if your lp/lpr programs set the file as zero and send only ASCII files.
No tells Columbus OM to wait for the timeout period and then finish the
job.
231
232
CHAPTER 9
Adding entries
Choose a folder (on the Columbus OM host) into which users will transfer the
files that they want to be processed.
Configure ftserver to tell it which folder you have chosen, how often you
want it to check the folder, and so on. See Configuration parameters for
ftserver below.
In the file, list the Columbus OM commands that you want ftserver to
process (for example, apq and aeq).
Against each command, specify the maximum amount of time (in seconds) that
you want ftserver to spend servicing a request of that type, for example:
aeq 10
apq 10
Value
Incoming_Directory
The folder in which users will put the files that they
want processed.
The value can include operating system variables
${name} and Columbus OM variables %name.
CHAPTER 9
Adding entries
Parameter
Value
Wait_Time
Start_Delay
one file containing the command that you want Columbus OM to use to
process the document (usually an apq command).
Create the command file with the same name as the document file, but with C
instead of D, for example: myreport.C01. The C can be uppercase or
lowercase.
or
apq %s -at print1 -rt "Transferred from mainframe"
4
Transfer the document file and the command file to the folder specified by
ftservers Incoming_Directory parameter. Make sure that the document
file is put into the folder before the command file.
The ftserver server monitors the folder, and when it finds a document file
and matching command file, adds them as an entry to the pending queue.
Tracking errors
If ftserver can not issue the command, it:
puts an error message in a file called filename.Enn (where the filename and
nn are the same as in the original file)
renames the original files by putting B (or b) on the end.
233
234
CHAPTER 9
Adding entries
You specify a folder for the filein server to scan. You put the files that you
want it to process into this folder or subfolders of it (or you configure the
application that creates the files to put them there).
In single mode, the filein server looks for files in the folder. When a file
stops growing in size, Columbus OM processes it.
If the processing succeeds, Columbus OM deletes the file.
If the processing fails, Columbus OM moves the file to another folder.
In batch mode, the filein server looks in the subfolders. When an end of
batch file appears in the folder, Columbus OM processes all the other files
that are in the folder.
If the processing succeeds, Columbus OM deletes the files and the
subfolder.
If the processing fails, Columbus OM moves the files to another folder, and
deletes the subfolder.
You can configure the filein server to send the files either to a specific
destination, or to select a destination according to the requirements of the files.
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Server filein
Set to filein.
Medium text
The medium that you will assign to the entries that you want the server to
process.
Action_on_Start command
Action_on_Postponement command
Action_on_Completion command
Action_on_Failure command
Action_on_Shutdown command
The maximum number of times that the server tries to select a destination.
CHAPTER 9
Adding entries
This parameter applies only if the Auto_Select parameter is set to Yes. See
also the Postpone_Time parameter.
Auto_Select Yes|No
To use a specific destination, set this parameter to No, and then set the
Destination parameter.
To select a device from the device pool, set this parameter to Yes, and then set
the Devpool, Select_Criteria, and Sort_Criteria parameters.
Destination text
The name of the device pool file to be used. For more information about
creating a device pool file, see Creating a pool of devices on page 327.
To use
Do this
%UNIQDIR%media\xselect\pool
\devpool.tab
a specific file
To use this parameter, you must also set the Auto_Select parameter to Yes.
Directory_Read_Order OLDEST_FIRST|UNSORTED
Specifies the order in which the server processes the files that are in the
scanned folder:
OLDEST_FIRST processes the files in the order in which they were put in
the folder.
(Applies only if Scan_Mode is set to BATCH.) The name of the file that will be
added to the scanned folder to indicate that the batch is complete.
See also the Queue_EOB and Scan_Mode parameters.
Empty_Wait n
235
236
CHAPTER 9
Adding entries
Error_Dump folder
Period (measured in seconds) to wait after a file stops growing, before the
filein server starts to process it.
See also the Scan_Mode parameter.
Owner text
The name of a file to be added to the front of each file that is processed.
Queue_EOB FIRST|LAST|NO
NO
LAST
FIRST
Scan_Interval n
The frequency (measured in seconds) at which the filein server scans the
folder.
See also the Scan_Root parameter.
Scan_Mode BATCH|BOTH|SINGLE
The mode in which the filein server is to work: one of SINGLE, BATCH or
BOTH. See also How the filein server works on page 234.
Scan_Root folder
CHAPTER 9
Adding entries
Select_Criteria filename
The selection criteria file to be used. For more information about creating a
selection criteria file, see .
To use
Do this
media\xselect\select\
select_criteria.tab
a specific file
Specify ALL.
The sort criteria file to be used. For more information about creating a sort
criteria file, see Selecting from similar devices on page 329.
To use
Do this
media\xselect\sort\
sort_criteria.tab
a specific file
237
238
CHAPTER 9
Adding entries
Reference
Reference
System parameters
These parameters can be set in the system defaults file (default.tab).
Address server
The destination used if you use the aeq or apq command without specifying
one: a print server, a fax number, or whatever is appropriate for the instance.
AEQ_Default ERROR|PROMPT|STDIN
What happens if you use the aeq, afq or apq command without specifying the
source of the document:
ERROR
PROMPT
STDIN
APQ_Val_Attr YES|NO|printer_type
YES validates device-related attributes (font, hopper, orientation, and so on) in
an apq command.
NO adds the request to the queue without validation.
A printer class
A remote printer
APQ_Val_Dest YES|NO
YES validates the destination server in an apq command.
NO adds the request to the queue without validation.
(UNIX only.) YES ignores signals (which are sometimes issued spuriously)
when a document is being added to a queue.
NO issues a warning message.
The medium used if you use the aeq command without specifying one.
CHAPTER 9
Adding entries
Reference
PCL_Converter XREQS|NONE
Specifies the program that is used to process documents that are in PCL format;
the program usually used is xreqs. (xreqs supersedes the PCLRead program
that was used in earlier versions of Columbus OM).
NONE turns off print indexing.
The printer options used if you use the apq command without specifying them.
Priority number
239
240
CHAPTER 9
Adding entries
Reference
241
C H A P T E R 10
Chapter 10
Managing entries
To
See
display the entries that are in the queue Displaying entries on page 242
change the properties of an entry
242
CHAPTER 10
Managing entries
Displaying entries
Displaying entries
Displaying entries using Columbus OM Explorer
Selecting the queues that are displayed
1
Click Config.
In the Queue Options dialog box, select the queues that you want to display,
and then click OK.
In the Columbus OM Preferences dialog box, click the Options tab, and then
click Filter Queue.
In the Filter Queue dialog box appears, select the criteria that you want the
documents to meet to be included in the display.
Click OK.
In the Queue Buffering dialog box, click Cache, and then type the maximum
number of documents that you want displayed at once.
Click OK.
Columbus OM Explorer changes the queue so that only the first group of
documents is displayed.
CHAPTER 10
Managing entries
Displaying entries
toolbar button.
Do this
move a column
243
244
CHAPTER 10
Managing entries
Displaying
information
about a
document
Displaying entries
To
Do this
The Status column gives more information about the progress of a document.
Status
Description
Blocked
The paper type specified for the document is not available on the
printer. There are two solutions: you can either change the paper
type specified, or mount the paper type on the printer. See
Restarting Blocked documents on page 259.
Complete?
Completed
Failed
Failed?
Held
New
Paused
Postponed
Printing
Started
CHAPTER 10
Displaying the
contents of a
document
Managing entries
Displaying entries
Status
Description
Transferred
TxStarting
(and other Tx
statuses)
Do this
display a confirmation
On the View menu, click Options. In the Preferences
message before displaying dialog box, click the File Types tab. In the Prompt
very big documents
box, specify a size (in megabytes); if a document is
bigger than this size, Columbus OM displays a
confirmation message before opening it.
Navigating the document
To
Do this
Click OK.
move forwards to the next occurrence of On the Search menu, click Find Next.
the text
print the document again (add it to the
queue as a new entry)
245
246
CHAPTER 10
Managing entries
Displaying entries
Do this
See
getacc:
Reporting
information
about entries
The getacc command produces a report about entries in the pending and
completed queues.
To
See
Options for this command are case-sensitive; for example, you must use -pf (not
-PF), and so on.
Selecting entries by their number
Syntax
getacc number [, number] ... [options]
CHAPTER 10
Managing entries
Displaying entries
Parameters
number
An entry number. The entry can be in either the pending queue or the
completed queue. You can also specify a range of numbers, for example: 1100.
options
See Specifying the format of the report on page 247, Specifying the name and
location of the report file on page 249 and Other options on page 249.
Selecting entries by their completion date
Only entries that are in the completed queue have a completion date.
Syntax
getacc -f from_date -t to_date [options]
Parameters
from_date
The completion date and time of the earliest entry that you want to include.
You can specify either a relative or absolute value:
To specify an absolute date and time, use: hh.mm [dd Mon yyyy]
For example:
-4:00
4 hours ago
-2.00:00
2 days ago
14:45
2:45pm today
to_date
The completion date and time of the latest entry that you want to include.
options
See Specifying the format of the report below, Specifying the name and
location of the report file on page 249 and Other options on page 249.
Specifying the format of the report
-pf filename
-sf filename
-pf adds extra text to the start of the report.
-sf adds extra text to the end of the report.
filename is the name of the file that contains the text to be added. The text can
247
248
CHAPTER 10
Managing entries
Displaying entries
Specifies the name of a file that defines the format in which the entries are to
appear. The file is a text file containing one or more lines of data, including
substitution variables (see Substitution variables on page 603) to indicate
where information about an entry is to appear. For an example of the file, see
Example on page 249.
Columbus OM looks for the file in the
%UNIQDIR%\media\accdata\templates folder. If the file is in a different
If you use this option, you cannot also use the -tl option.
-tl filename
Uses different formats in the report, according to the medium of the entry. In
the file, specify the template file to be used for each medium, and (optionally)
the prefix file and template file to be used for all media, in this format:
type
filename
type
The item that the file specified is to be used for, that is, one of:
prefix_file, suffix_file, the name of a medium, or *
(asterisk) for all media not otherwise mentioned.
filename
For example:
prefix_file
print
fax
*
suffix_file
MyStartFile.txt
MyPrintTemplate.txt
MyFaxTemplate.txt
MyGeneralTemplate.txt
MyEndFile.txt
If you select the entries by their entry number, and do not use -tf or -tl,
Columbus OM uses -tf %UNIQDIR%\media\accdata\templates\
template.tab.
If you select the entries by completion date, and do not use -tf or -tl,
Columbus OM uses -tl $UNIQDIR\media\accdata\lists\list.tab.
If you use this option, you cannot also use the -pf, -sf or -tf options.
CHAPTER 10
Managing entries
Displaying entries
The name of the file to be created. If the file already exists, Columbus OM
overwrites it.
The default location is %UNIQDIR%\media\accdata\reports. To create the
file in a different folder, include it in the filename.
If you use this option, you cannot also use the -rd, -rs or -rt options.
-rd folder
A temporary suffix to be used while the file is being created. When the file is
complete, Columbus OM changes the suffix to the one specified by the -rs
option.
This suffix must be different from the suffix specified by the -rs option.
If you use this option, you cannot also use the -rf option.
Other options
-no_banner|-nb
-queue_name|-qn instance
-silent|-si
249
250
CHAPTER 10
Managing entries
Displaying entries
%UID,%DESTINATION,%STATUS,%PAGES,%XREQ(LARGEST_PAGE)
To produce a file with more formatting in it, you could use a template file like this:
Entry number: %UID
Device:
%DESTINATION
Total pages: %PAGES
Status:
%STATUS
Max page size: %XREQ(LARGEST_PAGE)
Status:
New
Max page size: 12420
Entry number: 99
Device:
myprinter2
Total pages: 10
Status:
Completed
Max page size: 30317
The liq command displays the entries that are in the pending and completed
liq: Displaying
queues.
pending and
completed queue
Syntax
entries
liq [option...]
This command starts the queue display. For information about the commands that
you can use once it is displayed, see Using the queue display on page 252.
By default, the command displays all the entries in the pending queue and
completed queue of the current instance that belong to you. To display entries in
other ways, use the following options:
Specifying the options
-ADDRESS_TEXT|-at text
Displays any users entries from the pending queue, and your own entries from
the completed queue.
-DUMB|-d
Displays entries in plain text, that is with features such as reverse video.
CHAPTER 10
Managing entries
Displaying entries
-ENTRIES|-e number
Displays entries from a different instance. The instance must be on the current
host computer.
-STATUS|-ss status...
none
fax entries
-cs, -ft, -ov, -po, also HP, HPC, HPF, PCL, PCLC, PCLF, PS,
PSC, PSF, TEXT, TEXTC
print entries
-b, -co, -dc, -f,-fi, -hp, -nps, -oh, -or, -pp, -pr, -ps,
-pt
-SUMMARY|-s file
Changes the format of the display. f you do not include this, Columbus OM
uses the format that is defined in the %UNIQDIR%\config\liqsum.tab file.
-VDUMODE|-v command|OFF
251
252
CHAPTER 10
Managing entries
Displaying entries
Other options
-HELP|-h
-NO_BANNER|-nb
Description
L entry_id
entry_id
xinfo: Displaying To display information about entries that have been sent to a printer, but are not
yet complete, use the xinfo command. This command works with printers that use
information
the
xprinter driver.
about entries
Syntax
xinfo printer [interval]
Parameters
printer
The printer: either its IP address or the name that has been set up in
Columbus OM.
interval
CHAPTER 10
uqwhy: Finding
why an entry is
not printing
Managing entries
Displaying entries
To find out why an entry is not printing, use the uqwhy command:
Syntax
uqwhy entry_id [-QUEUE_NAME|qn instance] [-NO_BANNER|nb]
Parameter
entry_id
Value
AEQ_Index
Yes
Yes
PS_Count_NonDSC
If you are using a PostScript printer and the page count for
a document is shown as 0, try setting the
PS_Count_NonDSC system parameter to Yes.
Temp_Path
Use_xreqs
253
254
CHAPTER 10
Managing entries
Displaying entries
If you are using a PCL printer, the page count for a document may be shown as
-1 to start with, while Columbus OM creates the index for the document.
CHAPTER 10
Managing entries
Changing entries
Changing entries
Changing entries using the command line
To change the properties of an entry by using the command line, use the aeq
command. For more information, see aeq command on page 216.
See
To stop a document
Do this
permanently
Do this
255
256
CHAPTER 10
Managing entries
Changing entries
To
Do this
Do this
Do this
split the document, to print it on two or Click Pause. Right-click the printer
more printers at the same time
again, and then click Split Print Job.
transfer the rest of the document to a
different printer (ASCII documents
only)
CHAPTER 10
Managing entries
Resubmitting documents
Resubmitting documents
Resubmitting documents using the command line
To resubmit an entry that is in the pending, completed, or archive by using the
command line, use the rsq command.
Syntax
rsq entry_id [entry_id]...
[-ARCHIVE|-ar number] [-OWNER|-o] [-RELEASE|-r]
common_parameters
To resubmit two or more entries, specify their entry numbers separated by spaces.
The maximum number of entries that can be specified is 100.
Options
Entries are resubmitted as belonging to the same user who submitted them, and
with Held status, unless you use one or more of these options:
To
Use
-ARCHIVE|-ar number
number is the number of the archive
-OWNER|-o
-RELEASE|-r
Common parameters
-HELP|-h
-NO_BANNER|-nb
-NO_WARNING|-nw
-QUEUE_NAME|-qn instance
-SILENT|-si
257
258
CHAPTER 10
Managing entries
Resubmitting documents
Do this
Do this
as soon as possible
If you want the documents Remark field set to indicate which document it is a
reprint of, select Reprint Remark.
CHAPTER 10
Managing entries
Restarting documents
Restarting documents
Restarting documents using the command line
To restart documents by using the command line, use the opq command. For more
information, see Managing the entries on page 148.
Do this
Do this
restart the document at the page where it Right-click the printer that was printing
was paused
the document, and then click Resume.
restart the document, and reprint some
of the pages
259
260
CHAPTER 10
Managing entries
Deleting entries
Deleting entries
Deleting entries using the command line
To delete entries from the queue by using the command line, use the req
command.
Syntax
req entry_id... [option...]
Do this
a single entry
Use
-ARCHIVE|-ar number
number is the number of the archive
-COMPLETED|-c
-STATUS|-ss text
-OWNER|-o user_id
-ANY_OWNER|-ao
CHAPTER 10
Managing entries
Deleting entries
Common parameters
For more information about these parameters, see Common parameters on
page 602.
-HELP|-h
-NO_BANNER|-nb
-NO_WARNING|-nw
-QUEUE_NAME|-qn instance
-SILENT|-si
Example
req 12000-13000 -c -ao -ss cancelled
Deletes all entries from the completed queue with numbers that are in the
range specified, and whose status is Cancelled.
Stop all the servers for the instance. (See Stopping servers on page 102.)
In Columbus OM Explorer, click the Advanced tab, and then click the icon
for the instance.
On the Maintenance menu, point to Purge Queue, and then click Pending,
Completed or Archive.
In the Number of Days to Retain box, specify which entries you want to
keep. For example, to keep all entries that are less than one week old, type 7.
You can create a journal file that records how many entries are deleted:
To
Select
Overwrite
Append
None
Click OK.
261
262
CHAPTER 10
Managing entries
Deleting entries
The entries deleted from the pending queue are discarded, so use this feature
with care. Entries in the pending queue are ones that are waiting to be
processed, so if there are entries that have been waiting a long time, it might
indicate a problem.
The entries deleted from the completed queue can be either discarded or
moved to an archive queue.
Value
Purge_Time
Auto_Pending_Queue
Auto_Completed_Queue
CHAPTER 10
Managing entries
Deleting entries
Parameter
Value
Auto_Purge
100 NO_JOURNAL
100 NO_JOURNAL
Value
Description
Keep_Cancelled
Keep_Failed
These parameter applies whether the completed queue is purged by using the Auto
Purge command in Columbus OM Explorer, the syq -pc command,
printmasters Auto_Purge parameter, or the Auto_Purge parameter in
default.tab (see above).
263
264
CHAPTER 10
Managing entries
Reference
Reference
System parameters
These parameters can be set in the system defaults file (default.tab):
LIQ_Entries number
YES
OWN
265
C H A P T E R 11
Chapter 11
Managing queues
The completed queue contains entries that are have finished processing (either
successfully or unsuccessfully).
The archive queue contains entries that have been completed, and are being
stored for future reference.
Columbus OM moves the entries between the queues as appropriate. The archive
queue is just one of several ways of storing documents: for more information, see
Archiving documents on page 335.
To
See
decrease the disk space occupied by the Reducing the capacity of queues on
queues
page 268
ensure that the queues are correctly
organised
266
CHAPTER 11
Managing queues
Do this
CHAPTER 11
Managing queues
Use
syq -EXTEND_PENDING|-ep n
Use
syq -FORCE_EXTEND_COMPLETE|-fec n
Use
syq -FORCE_EXTEND_ARCHIVE|-fea n
when it becomes full. If you do not want the pending queue to be automatically
extended, set this parameter to 0. (However, if the pending queue is full, and
cannot be extended, you can not add any more entries.)
267
268
CHAPTER 11
Managing queues
Auto_Pending_Compress n
Auto_Complete_Compress n
Compress_Time hh:mm[,hh:mm]
CHAPTER 11
Managing queues
Value
queue
Use
Abbreviation
-ARCHIVE[n]
-ar[n] or -a[n]
-COMPLETED
-c
pending
-PENDING
-p
number
file
269
270
CHAPTER 11
Managing queues
Set Fix_Interval to
OFF
The dispatch server also fixes the queues automatically. If you do not want it to do
this, set the Auto_Fix parameter in the system defaults file (default.tab) file to No.
Find out if the queue needs to be fixed by using one of these commands:
To
Use
syq -CHECK_PENDING|-cp
syq -CHECK_COMPLETE|-cc
syq -CHECK_ARCHIVE|-ca
If the results of the command indicate that the queue needs to be fixed, use one
of these commands:
To
Use
CHAPTER 11
Managing queues
271
272
CHAPTER 11
Managing queues
Indexing queues
Indexing queues
To improve performance of accessing entries, the pending queue and completed
queues can be indexed. This is particularly effective when the maximum entry id
number (set by the Highest_UID parameter in the default.tab file) is exceeded
and Columbus OM starts renumbering the entries at 1.
To index the queues
1
Pending
Complete
Yes
index no queues
No
Command
Pending
syq -fp
Completed
syq -fc
If necessary, check the index by using the syq -cp or syq -cc commands.
CHAPTER 11
Managing queues
Value
Lowest_UID
Highest_UID
instance icon
View menu
Options
Defaults tab
Adding.
273
274
CHAPTER 11
Managing queues
Value
menu
Options
Defaults tab
instance icon
View
Adding
This parameter affects the entire instance. To control the size of documents
accepted by each printer, see Testing the size of documents on page 154.
CHAPTER 11
Managing queues
Reference
Reference
liqsum.tab: liq display format
The liqsum.tab file defines the default display format used by the liq command,
which displays entries that are in the queue.
The same structure is also used for the %UNIQDIR%\config\arqsum.tab file,
which defines the default display format used by the arq command.
File location and name
%UNIQDIR%\config\liqsum.tab
Content
On the first line, specify the (number of characters) of the display, for example:
SCREEN_WIDTH 96
The format:
Data type Value
timestamp
other types L aligns the value to the left; R aligns the value at the right.
5
The spacing (blank spaces) between this column and the next. The
default value is 1; a value of zero is permitted.
275
276
CHAPTER 11
Managing queues
Reference
Example
# Column
# Name
# ----------UID
OWNER
NAME
PAGES
DESTINATION
PAPER
DATE
DATE
STATUS
Column
Column
Title
Width
----------- -----Entry
5
Owner
5
Document
14
Pages
5
Printer
10
Paper
8
'Date '
0
'Time '
0
Status
9
Format or
Justification
------------R
L
L
R
L
L
'DD MON'
'HH:MI'
L
Trailing
Spaces
-------1
1
1
1
1
1
1
1
1
Displayable properties
Property
Description
ALIAS
ATTEMPTS
CHAIN_UID
CHARACTERS
CHILD_FLAG
CRYPT_TYPE
DATE
DATE_CREATED
DATE_QUEUED
DESTINATION
DOC_CODE
DOC_ICODE
DOCUMENT
DOCUMENT_TYPE
FIRST_DATE
HOST_NAME
LATEST_DATE
LINES
LSTATUS
MASTER
MEDIUM
CHAPTER 11
Managing queues
Reference
Property
Description
NAME
NEXT_DATE
ORIG_UID
OWNER
PAGE_LEN
PAGES
PAPER
PREV_REM
PREV_STATUS
PRIORITY
0 (lowest) to 9 (highest).
PROGRAM
REMARK
REMARK_TYPE
RETAIN_DAYS
RETAIN_DATE
RSTATUS
SEC_GROUP
SECLEV
SECLEV_NAME
SERVER_INFO
STATUS
SUPP_REM
UID
277
278
CHAPTER 11
Managing queues
Reference
279
C H A P T E R 12
Chapter 12
Controlling Columbus OM
with the dispatch server
make sure that all documents printed by users in a particular department are
printed on their printer
put long documents on hold so that other documents can be printed first
combine separate documents into a single item or print only selected pages
from a document
process documents with multiple servers (for example, print an entry, fax it,
and then archive it).
280
CHAPTER 12
Dispatch server
properties
To
See
These are the dispatch server properties that you are most likely to want to change.
For information about other properties, see dispatch server configuration
parameters on page 320.
Parameter
Value
Medium
The medium that is assigned to entries to indicate that you want this
server to process them (usually dispatch).
PrintCmd
CHAPTER 12
Creating rules
Creating rules
To configure a dispatch server to perform different actions on different
documents, you create rules. Each rule specifies:
which documents you want it to affect (for example, all those being sent to a
specific destination, or all those that contain a specific piece of text)
what you want to do with those documents (for example, put them on hold, or
print them on a specific printer).
Set the Rules_File property to specify the rules file that you want the server to
use.
Click OK.
On the File menu, click Save, and then close the Rules File Editor.
To make the server use the new rules file, you might need to restart it: for more
information, see Refreshing the server on page 99.
When you change the rules for a dispatch server, and then restart it, Columbus OM
checks that the rules are valid. If the rules are not valid, Columbus OM
immediately stops the dispatch server to ensure that the invalid rules are not
applied to any documents.
1
If the server has not started, find out what errors are in the rules by checking
the dispatch servers day log file.
See Log files on page 419.
Correct the errors, and then try to start the dispatch server again.
281
282
CHAPTER 12
Rule format
Rule format
This section describes the format for a single rule in a dispatch servers rules file.
Each rules file can contain as many rules as you need.
Each rule must have:
A condition: this specifies which documents you want the rule to affect.
One or more actions: these specify what you want to do with the documents
selected by the condition.
Optionally, actions for the document that are not selected by the condition.
Rule syntax
RULE name
CONDITION expression
[action
[action]...]
[final action]
[flow control action]
[ELSE
[action
[action]...]
[final action]
[flow control action]
]
Parameters
name
The name of the rule. Each rule must have a different name.
CONDITION expression
A condition that selects the documents that you want the rule to affect. For
more information, see Selecting documents using a condition on page 284.
action
What you want to do with the document: for example, release it for further
processing or defer it. For more information, see Specifying the actions on
page 291.
flow control action
What you want Columbus OM to do after processing this part of the rule: for
example, stop processing or move to another rule in the rules file. For more
information, see Specifying the actions on page 291.
CHAPTER 12
Rule format
You can split long lines over several lines by putting a backslash character (\) at
the end of every line except the last.
Example rules
This rule selects documents that have been sent to the laser1 printer and prints
them on the laser2 printer instead.
RULE rule1
CONDITION %DESTINATION = laser1
PRINT laser2
This rule directs print jobs to printers based on their page count. Jobs exceeding 50
pages are printed on the laser1 printer. Jobs of 50 pages or less are printed on the
laser2 printer.
RULE rule1
CONDITION (%PAGES > 50)
PRINT laser1
ELSE
PRINT laser2
283
284
CHAPTER 12
Only documents that meet the condition will be affected by the actions that
follow it.
Documents that do not meet the condition will not be affected by the actions.
For these documents, you can specify a different set of actions (by using the
ELSE section of a rule).
a specific piece of text in a specific place (works only with ASCII format files)
Condition syntax
To
Use
test a value
or
CONDITION !([^] item operator value)
CONDITION ALWAYS
specify a condition that is always
met, so that the actions that follow or
are performed on every document
CONDITION TRUE
CONDITION NEVER
specify a condition that is never
met, so that the actions that follow or
are never performed (this might be
CONDITION FALSE
useful when testing a rule)
Parameters
^
Reverses the test, so that documents that do not meet the rest of the condition
will be affected by the rule.
item
CHAPTER 12
strings
numbers.
operator
Function
Equal to
!= or <>
Not equal to
<
Less than
<=
>
Greater than
>=
value
The value that you want to test the item for: a string, number, a substitution
variable, or a macro (see Defining macros on page 288). If it is a string, put it
in quotation marks.
For a list of the substitution variables available, see Substitution variables on
page 603.
When testing a substitution variable for specific text, the text can include
wildcard characters. For more information, see Testing using wildcard
characters on page 286.
Examples
This rule affects all documents that are sent to printer1. These documents are not
printed; their status is set to Failed:
RULE rule1
CONDITION %DESTINATION="printer1"
FAIL
This rule also affects all documents that are sent to printer1. However, including
^ makes the test case-insensitive, so the rule also affects documents that are sent to
Printer1, PRINTER1, and so on:
RULE rule1
CONDITION ^%DESTINATION="printer1"
FAIL
This rule affects all documents that are not sent to printer1. These documents are
printed on a different printer:
RULE rule2
CONDITION !(%DESTINATION="printer1")
PRINT printer2 ALL
285
286
CHAPTER 12
Combining conditions
You can combine conditions by using these operators:
Operator
Function
& or &&
| or ||
Examples
This rule selects documents that Columbus OM has tried to print more than three
times and have a priority of 1, and puts them on hold:
RULE rule2
CONDITION (%ATTEMPTS>3) & (%PRIORITY=1)
HOLD
This rule selects entries made by any one of the three users listed:
RULE rule3
CONDITION (%OWNER="john") | (%OWNER="mary") | (%OWNER="chris")
PRINT laser1 ALL
Wildcard characters
Symbol
Matches with
[abc]
[^abc]
Matches anything that starts with abc, for example: abc, abcd, abcxyz.
CHAPTER 12
abc?
Matches anything that starts with abc, followed by any one character, for
example: abca, abcc, abcx (but not abc or abcxyz).
a[bcC]d
Matches with a string which starts with a, ends with d and includes one of
the characters in the brackets, for example: abd, acd, aCd.
Syntax
To search for the
text on
Use
Parameters
string
The number of the page on which you want the dispatch server to look for
the text.
startpage-endpage
A range of pages (two integers, separated by a hyphen), specifying the first and
last pages on which you want the dispatch server to look for the text.
Using %CONTENTS in a condition
In the condition, test for either a positive number or 0.
To select documents in which the text does appear at the specified location, test
for a positive number:
287
288
CHAPTER 12
To select documents in which the text does not appear at the specified location,
test for 0.
CONDITION %CONTENTS("SALES DEPT", 1, 2) = 0
Examples
This condition selects documents where the text SALES DEPT appears at column 1,
line 2 on any page of the document.
CONDITION %CONTENTS("SALES DEPT", 1, 2) > 0
This condition selects documents where the text SALES DEPT appears at column 1,
line 2 on page 5.
CONDITION %CONTENTS("SALES DEPT", 1, 2, 5) > 0
This condition selects documents where the text SALES DEPT appears at column 1,
line 2 on page 5, 6, 7 or 8.
CONDITION %CONTENTS("SALES DEPT", 1, 2, 5-8) > 0
This condition selects documents where the text SALES DEPT does not appear at
column 1, line 2 on any page of the document.
CONDITION %CONTENTS("SALES DEPT", 1, 2) = 0
Example
This condition is met when BUNDLE1 contains four documents.
CONDITION %DOCUMENT = BUNDLE1 && %BUNDLED = 4
Return value
If the document is not a bundle, the function returns the value zero.
Defining macros
To define a macro to use in a CONDITION, use the following syntax.
Syntax
The definition must be before the CONDITION in which the macro is referred to.
To define a macro, use:
CHAPTER 12
Parameters
name
or
?name(argument)
Example
This rule shows some ways of using macros in a condition.
289
290
CHAPTER 12
RULE rule1
DEFINE a(z) "MyPrinterz"
DEFINE b "SALES"
CONDITION %DESTINATION = ?a(1) && %OWNER = ?b
SET DESTINATION "MySalesDepartmentPrinter1"
ADVANCE ReleaseDocument
CONDITION %DESTINATION = ?a(2) && %OWNER = ?b
SET DESTINATION "MySalesDepartmentPrinter2"
ADVANCE ReleaseDocument
RULE ReleaseDocument
CONDITION ALWAYS
SET MEDIUM PRINT
RELEASE
CHAPTER 12
Description
BUNDLE
COMMAND
DAYLOG
ENFORCE
SET
Final actions
Keyword
Description
COMPLETE
DEFER
FAIL
HOLD
RELEASE
Description
ADVANCE
NEXT
Stops processing the current rule, and then starts the next rule in
the file
STOP
ADVANCE
The ADVANCE action stops processing the current rule, moves to another rule that is
further down the rules file, and then starts processing that one.
Syntax
ADVANCE rulename
291
292
CHAPTER 12
Parameter
rulename
CHAPTER 12
and so on
BUNDLE
The BUNDLE action adds a document to a bundle.
BUNDLE can be used only with documents that are not encrypted.
Syntax
BUNDLE name [DEFER=n] [ALIAS=text] [DESTINATION=text]
[OWNER=text] [SOURCE=text] [range]
Parameters
name
293
294
CHAPTER 12
ALIAS=text
DESTINATION=text
OWNER=text
SOURCE=text
Set the alias, destination, owner or source of the bundle to the text specified.
text can include substitution variables.
The default value for DESTINATION is bundle. The default values for ALIAS,
OWNER and SOURCE are the same value as the original queue entry.
range
Specifies whether you want the action to be carried out on the entire document
or only part of it. For more information, see Specifying a range on page 304.
Example
This rule creates a bundle called REPORT1. It adds documents to a bundle called
REPORT1; when five documents have been added to the bundle, it prints them all
at once.
RULE create_bundle
CONDITION %BUNDLED = 0
BUNDLE REPORT1
DAYLOG 700: New bundle: Entry %UID added
CONDITION %BUNDLED > 0
BUNDLE REPORT1
DAYLOG 703 Entry %UID added to bundle
CONDITION %BUNDLED = 5
PRINT MyPrinter
DAYLOG 703 Bundle printed
STOP
COMMAND
The COMMAND action carries out a system command on the selected document.
Syntax
COMMAND[(code[,code]...)] command [range]
CHAPTER 12
Parameters
code
Columbus OM assumes that if the exit code from the command is 0, the
command was successful.
If
Specify
COMMAND(code)
COMMAND(-)
To find out what the exit code was, use the %EXIT substitution variable.
command
?DEST?
range
Specifies whether you want the action to be carried out on the entire document
or only part of it. For more information, see Specifying a range on page 304.
Example
COMMAND "uqvar -s newtime %DATE+300s"
This action runs the Columbus OM uqvar command. The uqvar command
sets the Columbus OM user variable called newtime to five minutes after the
current time.
COMMAND(1) MyCommand.bat
This action runs a batch file called MyCommand.bat. If the exit code is 1,
Columbus OM assumes that the batch file completed successfully. If the exit
code is anything else, Columbus OM assumes that the batch file failed.
DAYLOG 700 Entry %UID: About to run MyCommand.
COMMAND "MyCommand"
CONDITION %EXIT!=0
DAYLOG 700 MyCommand failed for entry %UID.
COMMAND xmessage %OWNER "Your entry %UID: MyCommand failed"
COMMAND "syq -tn dispatch"
295
296
CHAPTER 12
COMPLETE
The COMPLETE action completes an entry. Columbus OM transfers the entry from
the pending queue to the completed queue, and sets its status to Completed.
Syntax
COMPLETE [text]
Parameter
text
Text to be added:
DAYLOG
The DAYLOG action adds a message to the dispatch servers day log file.
Syntax
DAYLOG number text
Parameters
number
This example adds a message to the servers log file, and then runs a command. If
the command fails, you can look in the log file to see how far the rule reached.
CHAPTER 12
DEFER
The DEFER action postpones an entry either for a specific period or until a specific
date and time.
Syntax
To defer an entry
Use
for a period
Parameters
period
dd is the number of days. This is optional. If you include it, separate it from
the number of hours by using a period (dot or full stop).
hh is the number of hours. Separate it from the number of minutes by using
a colon.
time
Mon is month (the first three letters of its name: JAN, FEB, MAR and so on).
yy is the year (the last two digits: 10, 11, 12 and so on).
text
297
298
CHAPTER 12
DEFER +7.00:00
Defers until 1400 hours. (If the time is already past 1400 hours today, then the
entry will be deferred until 1400 hours tomorrow.)
DEFER 14:00 31 JAN 12
This rule controls the progress of a bundling task which builds a bundle report1
using six source documents. Each time the task is processed, the %BUNDLED variable
is set to the number of documents that are in the bundle. While the number is less
than six, the task is deferred by ten minutes to retain it in the queue.
RULE test_defer2
CONDITION (%DOCUMENT="report1") && (%BUNDLED<6)
DEFER +0:10
ENFORCE
The ENFORCE action applies printing properties to the document, overriding those
set by the user. You can force the document to be single-sided or double-sided, or
in colour or black-and-white, and you can set the n-up number and the
resolution.
Usage
To use ENFORCE on a document, the document must be in either PCL or PJL
format, and it must be copied to the Columbus OM queue.
ENFORCE can be used only with documents that are not encrypted.
Syntax
Use one or more of these commands:
To
Use
ENFORCE PJL_TONER_SAVING NO
CHAPTER 12
To
Use
FAIL
The FAIL action sets the status of the entry to Failed, and then moves it from the
pending queue to the completed queue.
Syntax
FAIL "text"
Parameter
text
Displays a message. Use this to provide an explanation for why the entry failed.
The text can include substitution variables (see Substitution variables on
page 603).
Example
This rule controls bundle report1 by monitoring the time. When the time reaches
10:00, the entry is stopped.
RULE test_fail
CONDITION (%DOCUMENT="report1") && (%TIME~"10:*")
FAIL "Entry Overrun"
HOLD
The HOLD action sets the entrys status to Held.
Syntax
HOLD "text"
Parameter
text
Displays a message. Use this to provide an explanation for why the entry was
put on hold.
The text can include substitution variables (see Substitution variables on
page 603).
299
300
CHAPTER 12
Example
This rule checks the remark attribute of an entry. If the remark attribute is set to
hold this entry, the dispatch server holds the entry.
RULE test_hold
CONDITION (%REMARK="hold this entry")
HOLD "Held by user"
When the document is ready to be printed, you can release it by using the Release
command in Columbus OM Explorer, but you must also change the Remark field:
if you do not, then this rule will still affect the document and Columbus OM will
put it on hold again.
NEXT
The NEXT action stops processing the current rule, and then starts processing the
next rule that is in the file.
Syntax
NEXT
Example
For an example using the NEXT action, see Dispatch example: Data
transformations on page 309.
PRINT
The PRINT action prints the selected documents.
To specify the command that is to be used to print the documents, set the dispatch
servers PrintCmd property. For more information, see Configuring a dispatch
server on page 280.
For more control over printing, use the SET and RELEASE actions instead of PRINT
(see SET on page 302 and RELEASE on page 301). For an example of how use
these actions, see ADVANCE on page 291.
PRINT can be used only with documents that are not encrypted.
Syntax
PRINT printer [printer...] [range]
CHAPTER 12
Parameters
printer
The name of the printer on which you want to print the selected documents.
To
Do this
Specifies whether you want the action to be carried out on the entire document
or only part of it. For more information, see Specifying a range on page 304.
Example
This rule selects a document called reports and prints it on both the laser1 and
laser2 printers.
RULE test_print1
CONDITION ( %DOCUMENT = reports )
PRINT laser1 laser2 ALL
This rule prints all the pages of a document except the first on the laser1 printer.
RULE test_print2
CONDITION ( %DOCUMENT = reports )
PRINT laser1 PAGES 2-$
RELEASE
The RELEASE action releases an entry so that it can be immediately reprocessed; it
puts the entry back in the pending queue with its status set to New.
This action is usually used after changing the properties of the entry to that is
processed differently this time. To change the properties, use the SET action (see
SET on page 302).
One property that you are likely to have to change is the entrys Medium
property so that is processed by a different server. The original value of the
medium would have been set to indicate that you wanted it to be processed by a
dispatch server. For example, to print the document, change the medium to the one
that is used by printmaster (usually print).
Syntax
RELEASE ["text"]
Parameter
text
301
302
CHAPTER 12
SET
The SET action sets the value of a property of the entry, for example, to change its
medium or its destination.
Syntax
SET property value
Parameters
property
Description
ALIAS_PATH
ATTEMPTS
Number of attempts
BANNER
CHAIN
Chain-after entry id
CHARS
CHILD_FLAG
COPIES
DEFER
Defer time
DOC_CODE
DESTINATION
Destination
DOCUMENT_PATH
HOST_NAME
JOBCONTROL
LINES
CHAPTER 12
Property
Description
MASTER
MASTER_FLAG
MEDIUM
Medium name.
See also Dispatch example: Processing with multiple
servers on page 313.
ORIG_UID
OWNER
Owner id
PAGES
PAPER
Paper type
PRIORITY
Priority (0 to 9)
PROGRAM
Program id string
REMARK
Remark text
RETAIN_DAYS
SECLEVEL
SET SECGROUP
Security group.
See also Access to documents by security level on
page 370.
SERVER_INFO
Server information.
Changing this property also changes the values of these
properties: BANNER, COPIES, JOBCONTROL, PAPER,
VIPDEVICE and VIPPROFILE.
STATUS
SUPP_REM
Supplementary remark
VIPDEVICE
VIPPROFILE
VIP profile
XFEROK
Example
For an example that uses the SET action, see Dispatch example: Testing document
properties on page 310.
303
304
CHAPTER 12
STOP
The STOP action stops processing all the rules for the current entry.
Syntax
STOP
Example
For an example that uses the STOP action, see Dispatch example: Data
transformations on page 309.
Specifying a range
For the BUNDLE, PRINT and COMMAND actions, you can include a range that specifies
which part of the document you want the action to be carried out on.
The range can be:
specific pages
To specify
Use
ALL
a specific page
PAGES pagenumber
several pages
PAGES pagenumber[,pagenumber]
a range of pages
PAGES startpage-endpage
PAGES startpage-$
PAGES %CONTENTS(parameters)
AREA file:area
Parameters
startpage
CHAPTER 12
file:area
The name of an area description file, and the name of an area in it. For
information about how to create an area description file, see Area description
files on page 305.
Area description
files
If you often use the same range in rules, you can store its definition in a separate
file, and then in the rules, use a reference to that file instead of the range itself. If
you decide to change the condition, you only have to change it once, in the
definition file, instead of every occurrence of it in the rules file.
These definition files are called area description files.
When you have created an area description file, you can refer to it a rule by using
the AREA keyword in the range. For more information, see Specifying a range on
page 304.
To create an area description file
1
Click the dispatch server icon, and then click the Edit Area Description File
toolbar button
.
In the Area Description File Editor dialog box, type the name of the file you
want to create or edit.
Click OK.
The Area Description File Editor appears.
Identifies the area description. The name must be unique within the area
description file (but areas defined in other files can have the same name).
305
306
CHAPTER 12
FROM
Specifies the start of the selection. To start the selection to start on a page
relative to the page selected by the rest of the expression, include the offset
value.
TO
Specifies the end of the selection. To include only a single page, as specified by
the FROM parameter, omit the TO parameter.
expression
An expression that specifies where to look for the text. See below.
Area description expressions
{ column, line, [page_number,] [!] "match_text" }
Parameters
column, line
The position of the text in the page: the number of the column, and the number
of the line.
To search for text at any column on a specified line, set column to zero.
To search for text in any line at a specified column, set line to zero.
To search for text at any column and in any line, set both column and line
to zero. Note, that the text searched for must appear within a single line
that is, it must not be spread over a line-break.
page_number
The number of the page on which to search for the text. To search every page,
omit this parameter.
! (exclamation mark)
Reverse the condition so that the expression selects documents where the
match text does not appear at the specified location.
text
Function
& or &&
| or ||
CHAPTER 12
This area description selects the page before the first page in a document that has the
text Sales Department at column 24, line 4.
MATCH { 0, 0, "" }
AREA targetb
FROM -1 { 24, 4, "Sales Department" }
END
This area description selects a page which contains either the string 1996 or 1997 at
column 24, line 4.
MATCH { 0, 0, "" }
AREA targeta
FROM { 24, 4, "1996" } || { 24, 4, "1997" }
END
This area description selects the first page in a document that has the text Sales
Department anywhere in line 4.
MATCH { 0, 0, "" }
AREA targeta
FROM { 0, 4, "Sales Department" }
END
This area description selects the first page in a document that has the text Sales
Department at column 3 on any line.
MATCH { 0, 0, "" }
AREA targeta
FROM { 3, 0, "Sales Department" }
END
This area description selects the first page in a document that has the text Sales
Department anywhere on the page. The text searched for must appear within a
single line: that is, it must not be spread over a line-break.
MATCH { 0, 0, "" }
AREA targeta
FROM { 0, 0, "Sales Department" }
END
307
308
CHAPTER 12
Description
Complete?
Completed
Either:
Failed
Either:
Failed?
Held
New (with no defer time set) The last action applied to the entry was RELEASE
CHAPTER 12
See note 1
See note 2
> %TEMPFILE.tmp"
CONDITION %EXIT != 0
DAYLOG 700 Entry %UID: crlf transform failed
FAIL crlf transform
STOP
ELSE
COMMAND " mv %TEMPFILE.tmp %TEMPFILE"
SET MEDIUM print
DAYLOG 700 Entry %UID: crlf transform succeeded
RELEASE
STOP
RULE afp2pcl
CONDITION ALWAYS
# commands to handle AFP-to-PCL transformations
See note 3
See note 4
# and so on...
The first section moves processing to the rule whose name matches the
PROGRAM parameter (-pg) that has been specified for the entry:
309
310
CHAPTER 12
RULE SelectProgram
CONDITION ALWAYS
ADVANCE %PROGRAM
In the crlf rule, the condition means that the following actions are always
applied.
CONDITION ALWAYS
COMMAND " cat %TEMPFILE | crlf
> %TEMPFILE.tmp"
The COMMAND action copies the document to temporary file, and then processes
that file by running the crlf application.
3
This section tests the exit code from the crlf application.
CONDITION %EXIT != 0
DAYLOG 700 Entry %UID - crlf transform failed
FAIL crlf transform
STOP
ELSE
COMMAND " mv %TEMPFILE.tmp %TEMPFILE"
SET MEDIUM print
DAYLOG 700 Entry %UID - crlf transform succeeded
RELEASE
STOP
The rest of the file contains rules to handle other transformation applications
that may be used.
The rule analyzes the document by using the xreqs command. For more
information about this command, see xreqs: Analyzing document requirements
on page 322.
CHAPTER 12
Rules
RULE select
CONDITION ALWAYS
DAYLOG 700 Entry %UID
COMMAND "xreqs ?FILE? %UID -q -f"
DAYLOG 700 Entry %UID medium is %UQVAR(MEDIUM,)
See note 1
See note 2
The COMMAND action runs the xreqs command. The xreqs command analyzes
the requirements of the document (indicated by ?FILE?), and then records the
requirements in a local variables file (indicated by -f). The name of the
variables file include the entrys id, so that Columbus OM can find it again later
in the rule.
The information in the variables file includes the number of pages, which will
be used later in the rule.
The DAYLOG action writes an entry in the dispatch servers logfile. The entry
includes the MEDIUM value, extracted from the local variables file (indicated by
%UQVAR(MEDIUM,).
2
This section tests the number of pages that are in the document.
CONDITION %UQVAR(PAGES,) <= 20
SET DESTINATION LIGHT
SET MEDIUM PRINT
SET ATTEMPTS 0
RELEASE
ELSE
SET DESTINATION HEAVY
SET MEDIUM PRINT
SET ATTEMPTS 0
RELEASE
If the number of pages is more than 20, Columbus OM sets its destination
to the HEAVY printer.
311
312
CHAPTER 12
Then Columbus OM sets the entrys medium to PRINT, and releases it. This
puts the entry back in the pending queue with its status set to New, ready to
be processed by the server that uses the PRINT medium.
Columbus OM send a message to the user, stops the dispatch server by using
the syq command, and then stops processing the document.
%%NL splits the message over two lines, like this:
CHAPTER 12
Entry 54321:
xselect failed
3
The rest of the rule applies if the xselect command succeeds. This condition
tests what the MEDIUM variable has been set to by the xselect command:
CONDITION %EXIT != 0
COMMAND "xmessage %OWNER ""Entry %UID:%%NLxselect failed"" "
COMMAND "syq -tn MyServer"
STOP
If the value is not print, it indicates that the xselect command could not find
a suitable printer to print the document. Columbus OM puts the document on
hold.
4
This section applies if the MEDIUM variable is print, which indicates that the
xselect command found a suitable printer:
ELSE
SET DESTINATION %UQVAR(NEWDEST,)
SET MEDIUM %UQVAR(MEDIUM,)
SET ATTEMPTS 0
RELEASE
COMMAND "xmessage %OWNER ""Entry %UID:%%NLSent to\
%DESTINATION"""
Columbus OM sets the destination and medium for the entry to the values that
the xselect command put in the NEWDEST variable (that is, the printer it
selected) and MEDIUM variable (which is PRINT). It sets the entrys number of
attempts back to 0, and then releases the entry for processing again. This time it
will be processed by the server that uses the PRINT medium, which is usually
printmaster.
313
314
CHAPTER 12
CONDITION always
SET MEDIUM print
SET PROGRAM complete
RELEASE
STOP
RULE complete
CONDITION always
COMPLETE
STOP
# Job ticket A: Print, fax, archive, and then complete
RULE TicketA
CONDITION always
NEXT
# Step 1
RULE TicketA:1
CONDITION always
SET MEDIUM print
SET PROGRAM TicketA:2
RELEASE jt_a:1 %MEDIUM
STOP
# Step 2
RULE TicketA:2
CONDITION always
SET MEDIUM fax
SET PROGRAM TicketA:3
RELEASE jt_a:2 %MEDIUM
STOP
# Step 3
RULE TicketA:3
CONDITION always
SET MEDIUM archive
SET PROGRAM TicketA:4
RELEASE jt_a:2 %MEDIUM
STOP
# Step 4
RULE TicketA:4
CONDITION always
COMPLETE TicketA:4 Finished.
STOP
(-pg sets the entrys Program property. In this example, it is used to control the
rule that is applied to the entry.)
Analyzing these rules
1
CHAPTER 12
The unknown rule applies only if the entrys Program property is blank.
RULE unknown
CONDITION always
SET MEDIUM print
SET PROGRAM complete
RELEASE
STOP
RULE complete
CONDITION always
COMPLETE
STOP
This rule applies at the start of processing an entry. It moves the processing to
the TicketA:1 rule.
RULE TicketA
CONDITION always
NEXT
change the entrys Medium to that of the next server that you want to
process it
set the entrys Program property to that of the next rule that you want to
apply to it
release the entry so that it goes back into the Pending queue, ready to be
processed by the next server.
315
316
CHAPTER 12
The TicketA:1 rule changes the entrys Medium to print and its Program
property to TicketA:2, and then releases it.
# Step 1
RULE TicketA:1
CONDITION always
SET MEDIUM print
SET PROGRAM TicketA:2
RELEASE TicketA:1 %MEDIUM
STOP
Releasing the entry means that it is now in the queue with its medium set to
print; this means that it is picked up by the printmaster server.
When printmaster has finished processing it, it checks the
Completion_Medium parameter in default.tab. This is set to dispatch, so
printmaster changes the entrys medium to dispatch, its status to New, and
leaves it in the pending queue.
Now the entry is picked up by the dispatch server again, which applies the
entire set of rules again, starting with the Process_Job_Ticket rule.
This time, the ADVANCE %PROGRAM command moves the processing to the
TicketA:3 rule.
5
The rules for steps 2 and 3 work in the same way as the rule for step 1.
# Step 2
RULE TicketA:2
CONDITION always
SET MEDIUM fax
SET PROGRAM TicketA:3
RELEASE TicketA:2 %MEDIUM
STOP
# Step 3
RULE TicketA:3
CONDITION always
SET MEDIUM archive
SET PROGRAM TicketA:4
RELEASE TicketA:3 %MEDIUM
STOP
They change the Medium to that which will be recognized by the next server
that is to process it, change the Program to indicate the next rule that is to
process it, and then release the entry back to the queue.
6
CHAPTER 12
317
318
CHAPTER 12
If the master entry might be amended during the processing cycle, set these
parameters:
File
Parameter
Value
DCS_Medium
dispatch servers
configuration file
(%UNIQDIR%\servers
Processed_Delivered
Yes
\dispatch\config.t
ab)
3
If the entry is new, Columbus OM submits it the dcs application, and marks it
as a master entry.
If the entry is a master entry, Columbus OM checks the status of its children.
This condition checks whether the entry is a child entry that failed.
CONDITION %CHILD_FLAG = Yes & %PREV_STATUS = Failed
FAIL child
STOP
This condition checks whether the entry is a child entry. The previous
condition will have already selected the child entries that failed, so this
condition selects the child entries that did not fail.
CONDITION %CHILD_FLAG = Yes
COMPLETE child
STOP
This section affects entries that are neither master entries or child entries, that
is, New entries.
CHAPTER 12
ELSE
COMMAND "aeq %BROWSE_PATH -cp 3 -at %DESTINATION -m print -ou
%UID -child"
SET MASTER_FLAG Yes
RELEASE
STOP
To use this rule in your environment, replace the aeq command with a
command that submits the master entry to your dcs application, and
configure the dcs application to submit the child entries that it creates back
to Columbus OM.
To simulate a dcs application for this example, the child entries are created
by using an aeq command to submit copies of the original document. The
-ou parameter connects them with the original entry, and the -child
parameter makes them children of that entry.
The next time that these rules are applied to it, the
CONDITION %MASTER_FLAG... clause will select it, so processing will move to
The Resolve rule checks the status of a master entrys children, and then sets
the status of the master entry to match.
This condition is met if none of the child entries are waiting to be processed
(that is, they have all been processed), and one or more has failed:
CONDITION %CHILDREN_WAIT = 0 & %CHILDREN_FAIL > 0
FAIL master + %CHILDREN_FAIL children fail %CHILDREN_OKAY OK
STOP
If this condition has been met, the FAIL clause sets the status of the master
entry to Failed, and then stops processing it.
7
This condition is met if all the children have been processed, and none have
failed. (If any had failed, the previous condition would have applied.)
CONDITION %CHILDREN_WAIT = 0
COMPLETE master + %CHILDREN_OKAY children all OK
STOP
Columbus OM sets the status of the master entry to COMPLETED, and then
stops processing it.
8
This section is reached only if any of the children are still waiting to be
processed.
ELSE
DEFER +0:00:05 waiting for %CHILDREN_WAIT of %CHILDREN
STOP
Columbus OM defers the master entry for 5 seconds. After that, it applies the
rules again.
319
320
CHAPTER 12
Reference section
Reference section
dispatch server configuration parameters
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Action_On_Completion command
Action_On_Failure command
Action_On_Postponement command
Action_On_Shutdown command
Action_On_Start command
Action_Pre_Completion command
The interval (in seconds) at which you want Columbus OM to try to send the
document again if it fails.
CHAPTER 12
Reference section
from remote hosts. Use Yes only if there is a rule that has been defined to
deal with such entries, and there is not netmaster server able to process them.
No tells the dispatch server to ignore ACK/NAK queue entries. Use this value if
the ACK/NAK mechanism is disabled (see the ACK_Command and
Status_Feedback parameters in the default.tab file), or if netmaster processes
ACK/NAK entries.
The default value is No.
Process_Delivered Yes|No
To enable the dispatch server to process entries whose status is Delivered, set
this parameter to Yes. (These entries are processed in addition to the entries
that the server usually processes, such as New and Waiting.)
This feature is useful when using the dispatch server to process master and
child entries: the status of a master entry changes to Delivered when its child
entries have been added to the pending queue, so this parameter enables the
master entry to be processed by the dispatch server.
Rules_File filename
The path and name of the rules file to be used by the server.
The path can be an absolute path (for example, c:\data\MyRules.tab) or a
relative path (for example, ..\dispatch2\MyRules.tab).
If the rules file is in the servers folder, you can omit the path.
The interval (in seconds) at which the server scans the queue to see if there are
any entries for it to process.
The default is 10.
Server server
The name of the server; this must be the same as the name of the folder that the
configuration file (%UNIQDIR%\servers\server\config.tab) is in.
321
322
CHAPTER 12
Reference section
Temp_Path folder
A folder for the temporary files that the server creates. Its capacity must be
bigger than the size of the largest file being submitted. Columbus OM deletes
the temporary files when it has finished using them.
If you do not set this parameter, Columbus OM creates the temporary files in
one of these locations:
Windows
UNIX
analyzes the requirements for a document (for example, its format, whether it is
single-sided or double-sided, and whether it is colour or black-and-white)
counts the number of pages that are to be printed, taking into account the
number of pages in the document, whether the document is single-sided or
double-sided, and how many copies are required.
This command is often used with the dispatch features. For an example, see
Testing the contents of documents on page 287.
Supported document formats
Document formats that are supported by the xreqs command include: AFPDS,
Benson plotter, BMP Bitmap, Canon GL, Epson, GIF, HTML, IDOL, IGP, JPEG,
Microsoft Excel spreadsheet, Microsoft Word, OCE PCL, PDF, plain text, Rich
Text, SAP OTF, SAP RDI, Xerox DJDE, Xerox Metacode, XML, and Zebra ZPL.
Syntax
xreqs [uid] [file] [[-q] [-f [variables_file]]]
Parameters
You can specify the document to be analyzed by using either its entry id or its
name (or both).
uid
The entry id. If you include this parameter, Columbus OM records the results
of the command in a file called %UNIQDIR%\queue\document\xuid.req. uid
has zeroes in front of it to make it 7 characters long, for example:
x0004321.req.
file
Uses <alias> instead of <filename> when checking the suffix to the determine
the document type.
CHAPTER 12
Reference section
-d
(Used with the -q parameter.) The variables file in which the variables are to be
stored.
To use
Do this
-h
Value
CHARS
COPIES
DOCTYPE
APPLICATION
LINES
TITLE
ORIENTATION
PLEX
COLOURMODE
SHEETS
323
324
CHAPTER 12
Reference section
Variable
Value
NUP
URGENCY
MEDIA_SIZE
MEDIA_WEIGHT
MEDIA_TYPE
MEDIA_COLOUR
PAGES
Example report
To produce a report like this, omit the -q parameter.
Document type is PCL
( 2)
( 1)
6 (
Print
1
208079 bytes /
34680 bytes
0 records) Sheets:
Recipient:
Tot pgs:
Portrait
Simplex
600 dpi
Monochrome
Tot sheets:
Quality: Normal
CHAPTER 12
Reference section
Parameters
You can specify the file to be analyzed by using either its entry id or its name.
uid
The entry id for the file. If you include this parameter, Columbus OM records
the documents print requirements in a file and creates a report of the device
selection. If you run the command again with the same uid, Columbus OM
gets the results from this report file.
The print requirements file that Columbus OM creates is called:
%UNIQDIR%\queue\document\xuid.req.
The file that contains the criteria to be used to select a printer. See Specifying
the selection criteria on page 328.
To use
Do this
select\select_criteria.tab)
folder
the select_criteria.tab file that is Specify only -c (with no filename).
in the current folder
a specific file in any folder
Specify -c all
-f [variables_file]
Do this
325
326
CHAPTER 12
Reference section
-o [sort_table]
The file that contains the features to be taken into account when two or more
printers meet the selection criteria. See Selecting from similar devices on
page 329.
To use
Do this
folder
the sort_criteria.tab file that is in Specify only -o (with no filename).
the current folder
a specific file in any folder
Specify -o time
-p [device_pool_file]
The file that contains the list of possible devices from which Columbus OM can
select one. See Creating a pool of devices on page 327.
To use
Do this
folder
the devpool.tab file that is in the
current folder
-v
Displays information about the document and the printer that the command
selects.
z number
(Used with Columbus IOP deployments). Specifies the number of a zone. The
printers in the zone are listed in file called:
%UNIQDIR%\media\zones\zonenumber.tab.
This parameter takes precedence over the -p parameter.
CHAPTER 12
Reference section
Creating a pool
of devices
The pool of devices is a list of the possible devices from which Columbus OM can
select the one that is most appropriate to print a document.
Columbus OM Explorer
To create the default pool of devices that the xselect command uses, navigate to
Advanced tab instance icon Printers folder View menu Options
XPrinter tab Config Add.
To create other pools, see devpool.tab format below.
devpool.tab format
The default location is the $UNIQDIR\media\xselect\pool folder.
The default file name is devpool.tab.
Different locations and file names can be used and specified when you run the
xselect command.
Entry format
name min_pages max_pages cost quality
The file contains one entry for each printer that you want Columbus OM to
consider.
Field
Value
name
min_pages
max_pages
cost
quality
327
328
CHAPTER 12
Reference section
Example of devpool.tab
# Min Max Cost
# Printer name Pages Pages per page Quality
# ---------------- --------- --------- --------- --------xerox440 10 0 1 9
npi05ed6c 0 0 0 1
The selection criteria indicate which features you want Columbus OM to consider
Specifying the
selection criteria when selecting an appropriate printer.
Columbus OM Explorer
To create the default list of selection criteria that the xselect command uses,
navigate to Advanced tab instance icon Printers folder View menu
Options XPrinter tab Selection.
To create other pools, see below.
select_criteria.tab file
The default location is the $UNIQDIR\media\xselect\select folder.
The default file name is select_criteria.tab.
Different locations and file names can be used and specified when you run the
xselect command.
Entry format
The file contains one entry for each selection criteria that you want Columbus OM
to consider.
criteria used description
Field
Value
used
Used
---Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Description
-------------------------------------"Only printers which are enabled are considered"
"Size of document tested against min for printer"
"Size of document tested against max for printer"
"Printer must support the required language"
"Printer must have a booklet maker"
"Printer must be capable of bursting"
"Printer must be capable of Decollating"
"Printer must be capable of Page Collation"
CHAPTER 12
OFFSET
STAPLING
PLEX
IMAGE_SHIFT
RESOLUTION
COLOUR
OUT_BIN
IN_TRAY
MEDIA_NAME
MEDIA_ATTR
Selecting from
similar devices
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
"Printer
"Printer
"Printer
"Printer
"Printer
"Printer
"Printer
"Printer
"Printer
"Printer
must
must
must
must
must
must
must
must
must
must
Reference section
If Columbus OM finds two or more devices in the pool that meet the requirements,
you can tell it how to select a device, based on which device will be fastest, which
device will be cheapest, or which device will produce the best quality.
Columbus OM Explorer
1
To create the default list of properties that the xselect command uses, navigate
to Advanced tab instance icon Printers folder View menu Options
XPrinter tab Sort.
Add TIME, COST, and QUALITY to the Available list in the order that you want
Columbus OM to take them into account. Put the most important feature first.
Description
COST
QUALITY
TIME
329
330
CHAPTER 12
Reference section
Examples
If cheap printing is more important than speed, and speed is more important than
quality, specify:
COST
TIME
QUALITY
Accessing the
To
Do this
information
produced by the display the information that is produced Use the -v parameter with the
by the xselect command while it runs command
xselect command
Use the -f parameter with the
put the results of using the xselect
command into Columbus OM variables command
Use the uqvar command (see User
variables on page 612)
Value
JOBCOST
MEDIUM
"print"
NEWDEST
NEWTITLE
PAGES
REMARK
"printer selected"
CHAPTER 12
Reference section
Variable
Value
JOBCOST
MEDIUM
If the uid parameter was used with the command, this value
is the same as the original medium that was specified for the
entry.
If the uid parameter was not used, this value is "dispatch".
NEWDEST
PAGES
REMARK
Structure
The file may contain one or more entries in the following format. Each entry
comprises these lines:
REQUIREMENT {PAPER|COLOUR} [text[,...]]
[SECURITY
filename]
ACTION
{IGNORE|REJECT}
APPLICATIONS {ALLOW|DENY}
[text[,...]]
Parameters
REQUIREMENT {PAPER|COLOUR} [text[,...]]
331
332
CHAPTER 12
Reference section
Specifies a feature (that is, PAPER or COLOUR), and a list of properties of that
feature that are controlled.
For PAPER, the text can be A1, A2, A3, A4, EXECUTIVE, LEDGER, LEGAL,
LETTER, and so on.
For COLOUR, the text can be FULL, HIGHLIGHT, or MONOCHROME.
To list two more properties, separate them by commas. Either do not include
any spaces or put the list in quotation marks, for example: REQUIREMENT
PAPER A1,A2,A3 or REQUIREMENT PAPER "A1, A2, A3".
SECURITY filename
Specifies a security file that lists the users who can use the feature. The files are
in the Columbus OM security folder.
Specifies what happens if a job requires a feature that the owner is not allowed
to use:
To
Specify
REJECT
print the job, but not use the feature that is not
allowed
IGNORE
Specifies the applications that are either allowed or not allowed to use the
feature. (All other applications have the opposite rights.) To specify the
applications, use one or more of the following:
Examples
This example allows documents that are on large sizes of paper to be printed by
only the users who are listed in the xsel_paper file:
REQUIREMENT
SECURITY
ACTION
APPLICATIONS
PAPER
A1,A2,A3,LEDGER
xsel_paper
REJECT
ALLOW
*
CHAPTER 12
Reference section
This example allows only documents that are generated by Microsoft Word to be
printed in full or highlight colour:
REQUIREMENT
ACTION
APPLICATIONS
COLOUR
REJECT
ALLOW
FULL,HIGHLIGHT
WINWORD
333
334
CHAPTER 12
Reference section
335
C H A P T E R 13
Chapter 13
Archiving documents
See
Transferring documents to
Columbus DW on page 341
336
CHAPTER 13
Archiving documents
Type the following command, and then follow the onscreen instructions:
uq_mkarchive
Auto_Archive
Archive
Archive_Compress
Archive_UnComp.
Value
Archive
Auto_Archive
n[NO_JOURNAL|nj]
Auto_Purge
CHAPTER 13
Archiving documents
To save disk space, you can compress the entries that are in the archive queue by
setting the following parameters in the system defaults file (default.tab).
However, if you use this feature, you cannot browse the contents of the documents
that are in the archive queue.
Parameter
Value
Archive_Compress
Archive_Uncomp
The commands specified must accept two arguments: the first is the name of the
uncompressed input file, and the second is the name of the compressed output file
to be written.
To display a list of the archive queues
instance
View menu
Options
Command line
Type this command:
arq [option...]
The archive queue display appears. For information about the commands that you
can use in the archive queue display, see Using the archive queue display on
page 338.
Specifying the options
-ADDRESS_TEXT|-at text
Display entries whose destination starts with text specified, ignoring case.
-ANY_OWNER|-ao
Displays entries belonging to any user. To display only entries that belong to
you, omit this option.
-ARCHIVE|-ar [number]
Display entries from the archive queue with the number specified. To display
entries from the current archive queue, omit this option.
-DUMB|-d
Display entries in plain text without using the escape characters that invoke
advanced terminal capabilities such as reverse video.
337
338
CHAPTER 13
Archiving documents
Displays the entries, and then exits without prompting for further commands.
Use this option with -DUMB and -SUMMARY to pipe standard output into a file.
-OWNER|-o user
none
fax entries
print entries
-b, -co, -dc, -f,-fi, -hp, -nps, -oh, -or, -pp, -pr, -ps,
-pt
Displays the entries in the format specified by file, using the rules defined in
the %UNIQDIR%\config\liqsum.tab file.
-VDUMODE|-v command|OFF
The full path of an operating system command to be used to display text files,
or OFF to display as for a dumb terminal.
-HELP|-h
-NO_BANNER|-nb
-QUEUE_NAME|-qn instance
Description
L entry_id
CHAPTER 13
Archiving documents
Command
Description
entry_id
%UNIQDIR%\config\arqsum.tab
%UNIQDIR%\config\liqsum.tab
For more information about the structure of these files, see liq: Displaying pending
and completed queue entries on page 250.
If none of these files exists, Columbus OM uses a built-in default definition.
-WRITE_ARCHIVE|-wa number
-WRITE_ARCHIVE_APPEND|-waa number
-WRITE_ARCHIVE_OVERWRITE|-wao number
-WRITE_ARCHIVE_NOJOURNAL|-wan number
-WRITE_ARCHIVE_EXACT|-wae number
-WRITE_ARCHIVE_EXACT_APPEND|-waea number
-WRITE_ARCHIVE_EXACT_OVERWRITE|-waeo number
-WRITE_ARCHIVE_EXACT_NOJOURNAL|-waen number
syq
syq
syq
syq
syq
syq
syq
syq
-FORCE_WRITE_ARCHIVE|-fwa number
-FORCE_WRITE_ARCHIVE_APPEND|-fwaa number
-FORCE_WRITE_ARCHIVE_OVERWRITE|-fwao number
-FORCE_WRITE_ARCHIVE_NOJOURNAL|-fwan number
-FORCE_WRITE_ARCHIVE_EXACT|-fwae number
-FORCE_WRITE_ARCHIVE_EXACT_APPEND|-fwaea number
-FORCE_WRITE_ARCHIVE_EXACT_OVERWRITE|-fwaeo number
-FORCE_WRITE_ARCHIVE_EXACT_NOJOURNAL|-fwaen number
Replace number with the age (number of days) of the entries that you want to
move. (If an entrys RETENTATION_DAYS parameter is set to more than this number,
Columbus OM does not move it.)
Columbus OM writes information about which entries it moves in a file called
.\archive.jnl.
339
340
CHAPTER 13
Archiving documents
To
Use
CHAPTER 13
Archiving documents
Create a file whose name includes the index shortnames and some example
values. You will use this file later to test the pickup points for the indexes when
you create them.
For example, if you intend to use index boxes called UID, OWN (for the owner),
and DOC (for the document name), you could create a file called
UID=1,OWN=MyUser,DOC=MyReport.txt.
This file simulates the files that crserver transfers from Columbus OM to the
postbox folder.
341
342
CHAPTER 13
Archiving documents
Make a note of the archives postbox folder; you will use it again later when
you tell Columbus OM where to put the documents that it transfers.
3
Make sure that the user under which Columbus OM runs has full access rights
to the archives postbox folder, so that Columbus OM can transfer the files into
the folder and check their progress.
The medium that you will apply to documents to indicate that you want them
to be processed by crserver, for example: Archive.
Postbox_Dir folder
The path and name of the postbox folder for the Columbus DW archive that
you want to store the documents in. This is where Columbus OM will put the
documents that are to be archived.
The default value is %UNIQDIR%\media\warehouse\postbox.
Postbox_File shortname=value[,shortname=value]...
The Columbus DW indexes and values under which you want the documents
to be stored. Separate the indexes by using a comma.
value is the value for the index, usually a substitution variable. For more
CHAPTER 13
Archiving documents
Columbus OM uses this information in the name of the file that it puts into the
postbox folder. Columbus DW extracts the index boxes and values from the
file name to index it. You must ensure that the file names are unique; the
easiest way to do this is to include the %UID substitution variable as one of the
index values.
For information about the other configuration parameters for crserver, see
crserver: Other configuration parameters on page 344.
Tracking the progress of documents that have been archived
You can control when Columbus OM changes the status of a document that has
been transferred to Completed.
To set the status to Completed
when
Do this
Value
Complete_On
Set to FBFILE.
The effect of this is to put two more files in the postbox
folder directory for each document file that is archived.
These files are:
Success or Failed.
message.
index_string is the same as the name of the document
Postbox_Suffix
343
344
CHAPTER 13
Archiving documents
Set the Each archive thread runs this batch file every [n] seconds during
archive option to:
m4cxretrv.exe %FullFileName %Activity %ErrorMessage
Set the task to archive only files that have the filename extension that is
specified by the Postbox_Suffix parameter.
PRINT %DESTINATION prints the document on the printer that the user
specified.
SET MEDIUM Archive changes the medium to Archive so that the document
will be recognized by crserver.
RELEASE releases the entry so that it can be processed again. This time it will be
processed by crserver, which submits it to a Columbus DW archive.
For more information about the dispatch server, see Controlling Columbus OM
with the dispatch server on page 279.
CHAPTER 13
Archiving documents
For example, if Check_Frequency is set to 12, the server checks the postbox
after every 12 scans of the queue. If Scan_Interval is set to 10, the server
checks the postbox every 12 x 10 seconds = 2 minutes.
Escape_Char character
The escape character to be used in file names to indicate that the following
three characters represent the ASCII code for a character.
Characters might need to be replaced by their ASCII codes if they are
characters that the operating system does allow or that have some other special
meaning to Columbus DW.
The default character is % (percent). You are unlikely to need to change this
character.
Feedback_Fail text
Feedback_Okay text
Feedback_Proc text
Parameter
Feedback_Fail
Feedback_Okay
Feedback_Processing
Failed
Processing
Guard_File filename
The suffix added to the end of the name of the document files that are put in
the postbox folder.
If you are using file-based feedback (that is, the Complete_On parameter is set
to FBFILE), it might be appropriate to specify a fixed suffix. You can then set
the Columbus DW archive task to archive only files with that suffix, and ignore
the feedback files (which have these suffixes: .out and .err).
To
Do this
345
346
CHAPTER 13
Archiving documents
To
Do this
Specify NONE
Specify AUTO
The path and name of a temporary file to be used to hold the document while
the server copies it to the postbox. This feature ensures that Columbus DW
starts archiving the document only when the entire document is in the postbox.
The server copies the document to the temporary file. When the temporary file
is complete, the server moves it to the postbox folder and renames it, ready for
Columbus DW to start archiving it.
The folder for the temporary file must be different from the postbox folder.
If there are multiple crserver servers, the Postbox_Temp must be different for
each one.
If you set this parameter, do not set Guard_File.
Scan_Interval number
The interval in seconds between successive scans of the queue. The default is
10.
Server text
The server name. This must be the same as the name of the folder that the
servers configuration file (%UNIQDIR%\servers\server\config.tab) is in.
Translate_Chars "character[character]..."
Character
ASCII code
Backslash
092
Slash
047
Colon
058
Asterisk
042
Question mark
063
Quotation mark
"
034
Less than
<
060
Greater than
>
062
124
CHAPTER 13
Archiving documents
Name
Character
ASCII code
Percent
037
Equals
061
Comma
044
Underscore
095
046
The equals, comma, and period characters are translated only when they
appear in an index value. They are not translated when they separate fields in
the filename (see Postbox_File).
347
348
CHAPTER 13
Archiving documents
Configuration parameters
Action_On_Completion command
Action_On_Failure command
Action_On_Start command
The name of the archive application. Other applications might require other
formatter-specific parameters in this file.
Attempts_Limit number
The maximum number of attempts to archive a queue entry before setting its
status to Failed. The interval between attempts is set by Postpone_Time.
Directory folder
The string in entry_id.out which denotes that the job has failed. The
default is FAILURE.
Incoming_Allowed YES|NO
YES to process queue entries with the medium specified by Medium; NO (the
default) to ignore such entries.
Leave_CMD YES|NO
YES to retain the command file; NO (the default) to delete the jobs command
file after the number of attempts specified in Attempts_Limit.
Medium ARCHIVE
CHAPTER 13
Archiving documents
Postpone_Time number
The string in entry_id.out which denotes that the job is currently being
processed. The default is PROCESSING.
Scan_Interval number
The interval in seconds between successive scans of the queue. The default is
10.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Status_Interval number
The string in entry_id.out which denotes that the job has succeeded. The
default is SUCCESS.
Target_System WIN|UNIX
WIN to use Windows end-of-line characters in entry_id.cmd; UNIX (the
The uniqcs service matches an entry in the services file defining the port
(normally 2006) that is used for communication between hosts.
349
350
CHAPTER 13
Archiving documents
351
C H A P T E R 14
Chapter 14
Security
To ensure that only authorized users can view and print documents, send faxes and
control the output management features, Columbus OM includes extensive
security features.
Basic system security
The basic system security features cover the requirements of most installations:
Any user that can log on to the computer on which Columbus OM is installed can
print and manage their documents. They can use any printer.
You can control who can access Columbus OM administration features (such as
managing other users documents, enabling printers, adding printers, and changing
the system files) by adding users to user groups; different user groups can access
different features.
Advanced system security
To
See
352
CHAPTER 14
Security
See
use (or ignore) a Windows domain name Using instances on both Windows and
in mixed-platform environments
UNIX on page 379
create a guest user id
CHAPTER 14
Security
existing user names and passwords (for Windows, UNIX or SAP R/3)
Set Login_csuniq to
csulin_al
csulin_pam
csulin_external program
program.
When you type your username and password
to access Columbus OM, it sends them to the
external program. It also sends a security
number. The external program must validate
the username and password; if they are valid, it
must send the same security number back to
Columbus OM as confirmation. When
Columbus OM receives the confirmation, it
logs you in.
validate users against an LDAP
system
353
354
CHAPTER 14
Security
Do this
Specify the LDAP system by setting these parameters in the system defaults file,
defaults.tab:
Parameter
Value
LDAP_Host
LDAP_Port
The port number that the LDAP system uses. If you are
using SSL/TSL authentication, use 636.
The default value is 389.
LDAP_CertPath If you are using SSL/TSL authentication: The full path to the
security certificate.
3
If all the DNs have the same format, with only the user id being different,
specify that format. To indicate where the user id appears, use %s, for
example:
sn=%s,cn=Sales,cn=MyCompany
If the DNs can have different formats, specify LIST. Put the list of possible
formats in the LDAPlist.tab file (see LDAPlist.tab: Possible DN formats
on page 355).
If you know the appropriate format of the DN to be used for each user,
specify LOOKUP. Put the list of user ids and their DNs in the
LDAPusers.tab file (see LDAPusers.tab: DN formats for LDAP systems
on page 355).
If you are using the LIST or LOOKUP value for the LDAP_UserDN parameter,
create the LDAPusers.tab and LDAPlist.tab files.
CHAPTER 14
Security
The file contains a single column of LDAP user DN formats, as shown below.
To show where the user id should be inserted into the format, use %s.
Example
# LDAP User DN
# -----------------------------------sn=%s,cn=MyCompany
sn=%s,cn=Accounts,cn=MyCompany
sn=%s,cn=Admin,cn=MyCompany
You can add entries to this file manually. If the LDAP_UserDN parameter is set to
LIST, Columbus OM also adds entries that it finds to work.
File location
%UNIQDIR%\config\LDAPusers.tab
Entry format
The file contains one entry for each user id. Each entry contains a user id and the
corresponding format of the DN to be used to validate that user in the LDAP
system.
355
356
CHAPTER 14
Security
Field
Value
The format of the DN for the user. The format can include %s, which will
be replaced with the user id, for example:
sn=%s,cn=Sales,cn=MyCompany.
Example
# User id
# -------------------user1
user2
*
LDAP User DN
-----------------------------------sn=%s,cn=Sales,cn=MyCompany
sn=%s,cn=Support,cn=MyCompany
sn=%s,cn=MyCompany
In this example, if you log in as user1, Columbus OM uses this LDAP DN:
sn=user1,cn=Sales,cn=MyCompany.
If you log in with a username other than user1 and user2, Columbus OM uses
this LDAP DN format: sn=username,cn=Sales,cn=MyCompany.
Do this
csupwd -t number
number is the default number of days
CHAPTER 14
Security
To
Do this
csupwd -q userid
csupwd -l
csupwd -u userid
-o oldpassword
-n newpassword
csupwd -u userid
-f -n newpassword
csupwd -u userid
-o oldpassword -e expiry
csupwd -d userid -f
Parameter
Value
-u userid
-n password
357
358
CHAPTER 14
Security
Parameter
Value
-o oldpassword
-e expiry
Use
Example
dd Mon [yy]yy
31 Jan 2012
dd/mm/[yy]yy
31/01/2012
ddmm[yy]yy
310112
Specify -e +n
Specify -e NO.
For example:
To force the user to change their password
Use
after the first 30 days, and then every 30 days after that -e +30
when they first login, and then every 30 days
-e +30 -i
-i
Replace instance with the name of the instance which has the main password file.
This command moves the user ids and passwords from the current instances
password file to the specified instances password file. The command succeeds only
if the entries do not clash.
To use this option, your user id must be in the pwd_r security file.
CHAPTER 14
Security
Type:
$UNIQDIR/programs/commands/command
where command is one of the csulin commands shown above, for example:
$UNIQDIR/programs/commands/csulin_al
3
Type the username, password, and then test, on separate lines, like this:
john
mypassword
test
The program tells you whether the username and password are valid.
359
360
CHAPTER 14
Security
Do this
CHAPTER 14
Security
operators
administrators
Do everything that operators can do, and also view other users
entries, change the size of the queues, and delete all entries from
the queues.
implementors
Adding a user to a user group also enables them to can view, change and delete
entries made by any other user in the group.
Managing user groups
To
See
In Columbus OM Explorer, click the Advanced tab, and then click the icon
for the instance that the user group is in.
Under Columbus OM Security, click the type of group to which you want to
add the users:
To add users to
Click
Other
Operator Privileges
Other
Administrator Privileges
361
362
CHAPTER 14
Security
To add users to
Click
Other
Implementor Privileges
To
Do this
Click Add.
Click the user or group in the list at the right, and then click Remove.
In Columbus OM Explorer, click the Advanced tab, and then click the icon
for the instance that the function is in.
Under Columbus OM Security, click the group that contains the function.
CHAPTER 14
Security
Select the users that users you want to be able to use the function:
To allow access to
Do this
everyone
no one
Select No Users.
Click OK.
In Columbus OM Explorer, click the Advanced tab, and then click the icon
for the instance.
In the Add Group dialog box, select User Group, and then type a name for
the group.
Click OK.
363
364
CHAPTER 14
Security
In Columbus OM Explorer, click the Advanced tab, and then click the icon
for the instance that the user group is in.
uqallowed [username]
uqallowed
Security files
File location
The security files are in the %UNIQDIR%\security\ folder.
File content
To enable users to access a feature, add one or more of these entries to the security
file for that feature:
To enable access by
Add
a user
members of a Columbus OM user group & (ampersand), and then the name of the
user group. For example, putting
&implementors in a security file gives
access to all users who are listed in the
implementors file.
no users
/No_Users/
CHAPTER 14
Security
Feature
a_printer
aeq_mod
aeq_o
aeq_sl1 to
aeq_sl99
group_mod
mod_at
mod_at_c
modq_full
nmhosts_mod
opq_a
opq_a_own
opq_c
opq_c_own
opq_n
opq_n_own
opq_p
opq_p_own
req_a
req_ao
req_c
req_o
rsq_o
syq_u
syq_u_all
syq_wa
365
366
CHAPTER 14
Security
Feature
arq_ao
arq_det
arq_o
arq_view
Feature
liq_ao
liq_ap
List all entries in the pending queue, and their own entries in
the completed queue.
liq_det
liq_g
liq_o
liq_view
liq_view_g
Feature
g_printergroup
opq_a_own
opq_c
opq_c_own
opq_d
Disable a printer.
opq_e
Enable a printer.
opq_l
Line up a printer.
opq_m
opq_s
opq_s_own
opq_t
opq_t_own
CHAPTER 14
Security
File
Feature
opq_u
opq_v
p_printer
paper_mod
paper_rem
printer_ops
ptype_mod
ptype_rem
wopq_ag
Feature
logs_view
opq_i
opq_k
opq_o
Duplicate a server.
opq_x
server_add
server_mod
Modify a server.
server_rem
Delete a server.
syq_i
Start a server.
syq_s
syq_tn
Stop a server.
uqkill
Feature
cshosts_mod
lang_b
mod_secdest
mod_seclev
nmhosts_mod
pwd_a
367
368
CHAPTER 14
Security
File
Feature
pwd_f
pwd_r
pwd_t
pwd_w
remtab_mod
remtab_view
syq_dd
sysdef_mod
Feature
syq_ea
syq_ec
syq_ep
syq_fa
syq_fc
syq_fp
syq_ja
syq_jc
syq_jp
syq_pa
syq_pc
syq_pp
CHAPTER 14
Security
Access to documents
Access to documents
This section explains how to control who can view, change and delete documents
that are in the queue.
To
See
Set up a user group, and then add the users who are to be in the team to it. See
Access to administration functions on page 361.
Yes
Set these access rights. For information about how to do this, see Access to
administration functions on page 361.
Function
Give access to
Add Entry to Queue Functions Add entries for other All users
user
List Queue Entry Functions List all in pending queue the user group
List Queue Entry Functions
4
To add an entry as owned by a team, use the apq command with the -o option
set to the team name.
369
370
CHAPTER 14
Security
Access to documents
(Optional.) Control which users can use each of the security levels.
Do this
CHAPTER 14
Security
Access to documents
See
use the command line (aeq, afq and apq Use the -Security_Level and
commands)
-Security_Group parameters.
For more information, see aeq
command on page 216.
use the lp command
The security level for the server that is processing the document.
The security level for the destination that the document is sent to.
The default security level for the instance, set in the system defaults file
(default.tab).
If none of these values have been set, Columbus OM applies no security level to
the document.
If a user is not allowed to use the security level that Columbus OM calculates, it
applies the maximum level that they are allowed to use.
For each device for which you want to set a default security level like this:
destination level
371
372
CHAPTER 14
Security
Access to documents
Parameter
Value
destination
level
The default security level for documents that are sent to the
device. The security levels that you can use are stored in the
%UNIQDIR%\config\seclev.tab file (see seclev.tab: Security
levels below).
To turn off security for a destination, either delete the entry from
this table, or set the level to 0.
For each security level, add an entry by using the entry format shown below. The
maximum number of entries is 99.
Each entry specifies a security level, and the actions that members of different user
groups are not allowed to perform on documents with that security level.
Entry format
level description actions actions actions actions
Field
Description
A number, 1 99.
The lowest level of security, usually for documents that all users can access,
is 1. Use as many other levels as you need, up to the highest level of 99.
The rest of the fields list the actions that members of different user groups are not
allowed to do to documents with the security level. Users who are not in any of
these groups cannot perform any actions on documents with the security level.
3
CHAPTER 14
Security
Access to documents
Description
ALL
BROWSE
DETAIL
MODIFY
NONE
REPRINT
Reprint a document.
SUMMARY
To specify an action, use either the full name or the first three characters (for
example, MODIFY or MOD).
To specify multiple actions, separate them by using a comma.
Example security levels file
Operator
--------------NONE
MOD,REPRINT
MOD,REP,DET
ALL
Administrator
------------NONE
MOD,REP
MOD,REP
ALL
Implementor
----------NONE
NONE
NONE
MOD,BRO,REP
If you apply the lowest security level, Unclassified, to a document, any user
can see it in the queue, change it, display its contents and so on.
If you apply the highest level of security, Top Secret, to a document, only
implementors can see the document in the queue, change it, and reprint it.
Other users cannot see it in the queue.
373
374
CHAPTER 14
Security
Access to documents
Encrypting documents
You can store documents in encrypted format when they are on the queue or while
they are being transferred to another computer.
Encrypted documents can be printed only on printers that use the xprinter
driver. (They cannot be printed on printers that use the printer driver.)
Filters cannot be used with encrypted documents.
To enable encryption
Value
AEQ_Index
Yes
Use_XReqs
Yes
If these parameters are not set to Yes, you can still encrypt documents by using the
parameters that are described below; however, you will not be able to use the
xselect command to select a printer for the encrypted documents, and
Columbus OM might not be able to count the number of pages that are in the
encrypted documents.
To encrypt a single document while it is in the queue
Add the document to the queue by using the -encrypt parameter with the aeq or
apq command, for example:
aeq -df MyReport.txt -at MyPrinter1 -encrypt
To encrypt all documents while they are in the queue
Set the Disk_Encrypt parameter in the system defaults file (default.tab) to one
of these values:
To
Set Disk_Encrypt to
AES128
AES192
AES256
NO
CHAPTER 14
Security
Access to documents
To encrypt all documents while they are transferred to another computer, set the
Net_Encrypt system parameter in default.tab to AES128, AES192 or AES192.
If you use this feature, Columbus OM encrypts the document, and then transfers it
across the network. When the document arrives at the new instance:
375
376
CHAPTER 14
Security
Access to printers
Access to printers
By default, a user who can access Columbus OM can use any of the printers that it
controls.
To
See
control who can access a specific printer Using printer security groups below
control access to printers from other
hosts
In the Add Group dialog box, click the type of group you want to create.
To control who can
User Group
Printer Group
Click OK.
To add users to the group, see Access to administration functions on page 361.
If you have created a Printer Group, turn on the printer security feature by
setting the Printer_Secfiles parameter in default.tab to Yes.
CHAPTER 14
Security
Access to printers
Do this
allow all users to access the printers from Delete the trusted hosts file.
any other host
allow selected users access to the
printers from selected hosts
Entry format
Each entry must contain two fields:
Field
Value
The users who can access Columbus OM from the host. Separate the user
names by using a comma or a space.
To specify all users, put * (asterisk).
"root,jls, mab"
"fdd, nrt"
"aen"
"*"
In this example:
root, jls and mab can access the instance from the mars host
fdd and nrt can access the instance from the host which is on the 10.1.4.15
TCP/IP address
377
378
CHAPTER 14
Security
Access to printers
any user can access the instance from the jupiter host.
CHAPTER 14
Security
Set Any_Domain to
Yes
No
Locking files
To specify how files are locked, to prevent two users from accessing the same file at
the same time, set this parameter in the system defaults file (default.tab):
ULM_Method
To
MUTEXES
SEMAPHORES
379
380
CHAPTER 14
Security
Using Columbus OM Explorer, login to the instance that the function is in, as a
user whose name is in the %UNIQDIR%\security\lock_u file.
Click Yes.
Configuring servers
Modifying security
when it checks a security file that refers to a Windows user group (if it is logged
in as the user whose group membership is being checked).
If the file does not exist or it is out-of-date, Columbus OM can check whether a
user is a member of only the local and global groups; it cannot check whether they
are a member of domain local and universal groups.
CHAPTER 14
Security
listwingrps -c [-f]
listwingrps domain\userid -i
[-p password] [-f]
listwingrps userid -v
Parameter
Value
domain\userid
-p password
-f
Find the name of the file that controls access to the function: see Security files
on page 364.
Create a shell script with the same name plus a .scr extension (for example,
aeq_mod.scr). Write the shell script so that it:
returns any other value if the user is not allowed to access the function.
381
382
CHAPTER 14
Security
Reference section
Reference section
groupsec.tab: Administration of printer access control
The groupsec.tab file supports administration of access control to Columbus OM
printers.
File location
%UNIQDIR%\security\groupsec.tab
Entry format
The file contains one line for each security-controlled function or command. Each
line contains these fields:
Field
Value
Only users in that group (or a higher one) are authorized to update the list
of users in the access_file.
Notes
1
The outcome of that evaluation determines which (if any) of the access_files
in %UNIQDIR%\security you are permitted to update.
The effect of updating an access_file is to change the list of users who are
authorized to perform the function controlled by that access_file.
Content
The file contains one line for each security-controlled function or command. Each
line contains these fields:
CHAPTER 14
Security
Reference section
Field
Description
Only users in that group (or a higher one) are authorized to update the list
of users in the access file.
Notes
1
The effect of updating an access file is to change the list of users who are
authorized to perform the function controlled by that access file.
The Local_Host parameter indicates the network card to which a server binds.
This parameter is required only if the computer has multiple network cards
(which means that it also has multiple host names).
The value can be:
383
384
CHAPTER 14
Security
Reference section
The name of a communications protocol, normally tcp. See also the Service
parameter.
Scan_Interval number
The interval in seconds at which the server suspends its normal listening
function in order to perform any necessary housekeeping. The default is 10.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Service service
(UNIX only.) NO refers to the original user id (ignoring any change by means of
the su command) when checking an access file.
YES refers to the new user id su has been used.
CHAPTER 14
Security
Reference section
(Windows only.) YES searches for user groups specified in security files in both
local and global groups.
NO searches only global groups.
385
386
CHAPTER 14
Security
Reference section
387
C H A P T E R 15
Chapter 15
This section explains how to integrate two or more instances of Columbus OM.
To
See
388
CHAPTER 15
The server that uses the uniqcs service is called uqserver. uqserver is
automatically configured when you install Columbus OM.
Specifying the port number
1
File location
%SystemRoot%\system32\drivers\etc
PC running Microsoft
Windows
UNIX
/etc
Add a line like this, if something similar does not already exist:
service
port/tcp
# Columbus OM service
Replace:
service with a name for the Columbus OM service. The usual name is
uniqcs.
port with any port number that is not already being used: the usual
number is 2006.
Add the line anywhere in the file, except as the last line of the file. The usual
place to add the line is so that the port numbers are in order.
For example:
uniqcs
3
2006/tcp
# Columbus OM service
If you have used a name that is not uniqcs for the service, set the UQ_Service
parameter in the system defaults file (default.tab) to the name that you have
used.
CHAPTER 15
Content
Add one entry for each instance, with these fields:
Field
Description
The name of the instance. Each instance on the host must have a different
name. The name can contain letters and numbers. The maximum length
of the name is 10 characters.
The full path of the folder in which the instance has been installed.
YES or NO:
YES : The instance is the same type (that is, PRINT, FAX, MAIL, DISPATCH,
and so on) as the one to which the systems.tab file belongs.
NO indicates a different product.
Example
# Name
# ---------DISPATCH1
FAX1
PRINT2
Path
-------------------------------------------------C:\ColumbusOM\dispatch1
C:\ColumbusOM\fax1
C:\ColumbusOM\print2
type?
----No
No
Yes
Product
--------DISPATCH
FAX
PRINT
389
390
CHAPTER 15
copy files that you change from one instance to another, so that you have to
change the files in only one place
Using repmaster
The instance that you want to copy the files from is the master instance. On the
master instance, you specify:
a list of the instances that you want to copy files to, and a list of the files that you
want to copy
a list of the folders that you want to be cleaned, and a list of the files and folders
that they are allowed to contain.
You can maintain different lists of files to be copied and folders to be cleaned for
each instance.
The instances that you want to copy the files to and clean folders on are the client
instances. Run repmaster on each client instance. At specified times, repmaster
checks:
if any of the files that you have specified on the master instance have changed,
and if they have, it copies them to the client instance
if any of the folders that you have specified contain files or subfolders that are
not on the list of allowed items, and if so, it deletes those items.
Repmaster works only on files and folders that are in the main Columbus OM
folder, %UNIQDIR%.
Copying files
You can specify which files on the master instance you want repmaster to monitor.
When one of these files is changed, repmaster copies it from the master instance to
the client instance.
Repmaster can copy either the file that is changed, or a file in a different location.
Copying a file from a different location is useful when:
the master instance and the client instance are on different operating systems
(for example, to transfer files from Windows to UNIX, or between different
types of UNIX)
the contents of the file need to be different (for example, the instances might
need different values in the system defaults file, default.tab).
repmaster can also handle file deletions: if a file on the master instance is deleted,
repmaster can also delete the file from the client instance.
CHAPTER 15
Cleaning folders
Repmaster can make sure that folders contain only the files you want, by
automatically deleting unwanted files.
You specify a folder, and a list of the files and subfolders that it is meant to contain.
At specified times, repmaster checks the folders, and then deletes any files and
subfolders that are not on the list. (Repmaster does not delete any files that have
been copied from the master instance, even if they are not on the list of allowed
files.)
You can configure repmaster to check the list of allowed items against either the
master instance or the client instance.
a list of the client instances (see Specifying the client instances on page 391)
a list of the files to be copied to the client instances, and the folders on the client
instances to be cleaned (see Specifying the files and folders on page 392).
replicate.tab format
replicate.tab contains three columns, like this:
# Hostname
# -------------mars
mars
mars
mars
saturn
jupiter
*
1
Instance
-----------print1
print2
*
*
*
*
*
Identifier
-----------mars1
mars2
mars1,mars2
mars_general
saturn,general
jupiter,general
default
Specify the host and name of an instance, and one or more identifiers for the
instance. You will use the identifier later as part of the name of the file in which
you list the files and folders that you want to be copied and cleaned.
391
392
CHAPTER 15
You can use the same list of files and folders for more than one instance:
To
Do this
use the same list for all the instances on Specify the hostname, set the instance
a host
to * (asterisk), and then specify an
identifier.
use the same list for all other hosts and Set both the hostname and the
instances that are not otherwise
instance to * (asterisk), and then
mentioned in this file
specify an identifier.
Example
Using the file shown above, you would create:
a list called mars1, that contains the files that you want copied to the print1
instance on the mars host
a list called mars_general for all the instances on mars, except print1 and
print2
a list called general for all the instances on both saturn and jupiter, and
also lists called saturn and jupiter, for when you want to apply changes to
only one of those hosts.
a list called default for all other instances on all other hosts.
File name
id_identifier.tab.
Replace identifier with the identifier that is specified in the replicate.tab file,
for example, id_mars1.tab or id_general.tab.
CHAPTER 15
File format
1
You can specify default values for the entries in the file that follow, for
example:
DEFAULT CLEAN FILES
In each folder section, list the files that you want to copy and the files that you
do not want do be deleted by using entries like this:
FETCH servers.tab
FETCH alias.tab
ALLOW myfile.txt
For more information, see Specifying the known files and subfolders on
page 394 and Specifying the files to be copied on page 395.
Example
DIR myfolder CLEAN ALL
FETCH myfile.txt
FETCH myfile2.txt
This example ensures that the myfolder folder contains only copies of
myfile.txt and myfile2.txt, and no other files or subfolders.
Specifying
default values
To specify default values for the rest of the entries in the file, add one or more lines
using the syntax shown below. The default values apply to the entries that follow in
the file, so you can change the default values further down the file by putting more
DEFAULT entries in the appropriate places.
Syntax
DEFAULT CLEAN|ALLOW|WHERE|WHENCE|DELOK value
Parameter
Value
CLEAN|ALLOW|
WHERE|WHENCE|
DELOK
The item for which you want to set the default value. For
more information about the keys and the possible values, see
the sections indicated.
Keyword
See
CLEAN
ALLOW
WHERE
393
394
CHAPTER 15
Parameter
Specifying the
folders
Value
WHENCE
DELOK
To specify a folder that you want repmaster to get files from or to clean, add a line
like this:
DIR folder
Parameter
Value
folder
Example
To copy a file from the Columbus OM servers\printermaster folder, use:
DIR servers\printmaster
Deleting
unknown files
and folders
To delete unknown files and folders from the folder that is specified by the DIR
parameter, include the CLEAN option:
DIR folder [CLEAN FILES|FOLDERS|ALL|NONE]
Parameter
Value
CLEAN FILES
CLEAN FOLDERS
CLEAN ALL
CLEAN NONE
To specify what the known files and subfolders are, use an ALLOW line (see
Specifying the known files and subfolders on page 394).
Example
To clean the Columbus OM servers\printermaster folder, use one of:
DIR servers\printmaster FILES
DIR servers\printmaster FOLDERS
DIR servers\printmaster ALL
Specifying the
known files and
subfolders
To specify the files and subfolders that are allowed in the folder specified by DIR,
that is, the ones that you do not want to be deleted, add one or more ALLOW lines:
ALLOW name [FILE|FOLDER|ALL [MAIN|ALT|CLIENT]]
CHAPTER 15
Parameter
Value
name
FILE|FOLDER|ALL
MAIN|ALT|CLIENT
FILE
FOLDER
ALL
ALT
Example
DIR myfolder CLEAN ALL
ALLOW *.doc
This example ensures that the myfolder folder contains only files with the file
name extension of .doc. All other files and subfolders are deleted.
To specify the files that you want to be copied from the folder specified by the DIR
Specifying the
files to be copied line, add one or more FETCH lines, like this:
FETCH name [TEXT|BIN [MAIN|ALT [YES|NO] [nnnn|COPY|IGNORE]]]]
Parameter
Value
name
TEXT|BIN
The format of the files: TEXT for text format; BIN for binary
format.
The default value is TEXT.
MAIN|ALT
395
396
CHAPTER 15
Parameter
Value
ALT
YES deletes the file from the client instance if it is not on the
master instance.
COPY
IGNORE
Using an
alternative
source for files
Repmaster usually copies the files from the folder specified in the DIR line to the
same folder on the client instance. However, you can copy the files from a different
folder. For examples of why you might do this, see Copying files on page 390.
To copy the files from a different folder
1
On the master instance, put the source files in this folder, or a subfolder of it:
%uniqdir%\media\replicate\files\identifier
In the FETCH line in the id_identifier.tab file, use the ALT parameter (see
ALT on page 396).
Example
DIR servers
FETCH servers.tab ALT
This example copies the servers.tab file from the alternative folder on the master
instance to the servers folder on the client instance.
CHAPTER 15
397
398
CHAPTER 15
Entry format
Add one entry for each remote computer that uses a different service. The format
of each entry is like this:
hostname[:instance]
service
Parameters
hostname[:instance]
If there is more than one instance on the computer, you must include the
instance name.
service
The name of the service on which the instance listens for messages.
Example
# Host/instance
# ---------------myhost1:print1
myhost1:print2
myhost2:print3
myhost3
Service
---------uniqcs1
uniqcs2
uniqcs3
uniqcs1
The print2 instance on the myhost1 computer uses the uniqcs2 service.
The print3 instance on the myhost2 computer uses the uniqcs3 service.
CHAPTER 15
Entry format
Each entry contains two fields:
Field
Description
host
One line can contain an asterisk (*) in this field, signifying all other
remote hosts not explicitly mentioned.
2
users
Example
# Host
# ---hostA
hostB
Users
----"john, mary, pat"
*
This file enables three users on host A to use Columbus OM, and all users on host
B to use it.
399
400
CHAPTER 15
Reference
Reference
System default parameters
These parameters can be set in the system defaults file (default.tab):
Client_Mode CSUNIQ
Specifies the network card to be used by servers that listen for connections (for
example, uqserver and lpdserver). This feature might be useful where a one
network card controls intranet connectivity (internal) and another controls
internet (external) connectivity, and enables sites to prevent external users from
accessing the print environment.
You can specify the network card by using either its IP address or hostname.
Local_Host host
In cases where this computer has more than one host name (possibly due to
multiple network connections): the definitive local name as far as this
Columbus OM instance is concerned (so should not be set to 0.0.0.0). The
default is to use the computers operating system name.
No_Login_Data YES|NO
YES prevents the instance in which it is set from requesting system parameter
information when communicating with an instance at or below V3.2.0e; NO (the
default) to allow the instance in which it is set to request system parameter
information when communicating with an instance.
The service used for communication between host computers. uniqcs must
match the name of an entry in the services file defining the port (normally
2006).
UQ_Timeout numberA/numberB|off
CHAPTER 15
Reference
seconds) that a package may remain active after returning a reply to the
client. Use this option if packages occasionally stop responding, and need
to be tidied up.
The minimum value is 10. To keep the packages always active (that is,
disable this timeout), specify 0. The default value is 300.
Mandatory parameters
Fetch_Time [hh:mm [, hh:mm]...]
When you want repmaster to contact the master instance to see if any files have
changed. By default, repmaster does this every day at the times specified; to do
this on only specified days, use the Fetch_Days parameter (see below).
The maximum number of times that you can specify is 25.
The default value is not to contact the master instance.
Master_Host text
To find out what actions repmaster would take, without actually taking the
actions, set this parameter to Yes. Repmaster puts a report of the actions that it
would take in its day log file.
The default value is No.
401
402
CHAPTER 15
Reference
Fetch_Days number[,number]...
Specifies one or more days of the month on which you want repmaster to
perform its tasks. For example:
To
Set Fetch_Days to
Specifying 31 performs the task in only months that contain 31 days: for
example, January and March, but not February.
To specify the time on these days at which repmaster performs the task, use the
Fetch_Time parameter.
Fetch_Immediate [Yes|No]
To fetch files or clean folders immediately, instead of waiting until one of the
times specified by Fetch_Time, set this parameter to Yes while repmaster is
running.
Repmaster contacts the master instance, copies the files and cleans the folders
as required, and then sets this parameter back to No.
Fetch_Startup [Yes|No]
Yes makes repmaster contact the master instance when it starts. This is in
addition to the times that are specified by the Fetch_Time parameter.
The name of a medium. You can use any medium, for example: print.
Repmaster does not use the medium, but some other programs expect every
server to have a medium.
Remote_User [text]
Description
Minimum information: the start and end of each fetch, any errors
encountered, and the overall result (success or failure).
CHAPTER 15
Reference
Level
Description
The name of the server, usually repmaster. Once set up, this must not be
changed.
Timeout n
The network card to which a server binds. This parameter is required only if
the computer has multiple network cards (which means that it also has multiple
host names).
The value can be:
403
404
CHAPTER 15
Reference
The name of a communications protocol, normally tcp. See also the Service
parameter.
Scan_Interval number
The interval in seconds at which the server suspends its normal listening
function in order to perform any necessary housekeeping. The default is 10.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Service service
Minimum value
Maximum value
Windows
3600
UNIX
600
405
C H A P T E R 16
Chapter 16
This section explains the features that you can use to monitor the use of
Columbus OM.
To
See
406
CHAPTER 16
Most printers can return a basic, one-line status report (for example, Offline
or Paper Low). To get this information, set the printer servers BackChannel
parameter, and make sure that the BackChannel parameter in the system
defaults file (default.tab) is not set to OFF.)
Some printers can also return a more detailed, multi-line status report. To get
this information, set the printer servers Query_Printer parameter.
If you do not which of these reports your printer can return, you can set both
parameters.
To find out the status information command
1
Find out if the printer supports a printer MIB (Management Information Base).
To do this, see the printers documentation, or see Checking for printer MIB
support on page 407.
CHAPTER 16
If the printer does support a printer MIB, you get the status information from it
by using Columbus OMs uqsnmpinfo command: see Using the printer MIB
to get status information on page 408.
2
If the printer does not support a printer MIB, check the printers
documentation for a command that the manufacturer has supplied.
If there is a command supplied, set the BackChannel and Query_Printer
parameters to its value.
If the printer does not have its own command, you can use one of the other
commands that Columbus OM supplies:
Printer type
OCE printers
PJL-enabled printers that are set up for pjlinfo (see page 412)
assured delivery by using the pjlout
driver
Checking for
printer MIB
support
zplinfo
other printers
When you have set the printers status information command, start statserver,
and then see Displaying the printer status in Columbus OM Explorer on
page 412.
This section describes how to find out if a printer supports a printer MIB. There are
two types of printer MIB:
Most printers support either the common printer MIB or a private printer MIB;
some printers support both. If the printer supports both, you can check which
provides the most useful information.
To check if the printer supports the common printer MIB
1
Replace printerid with either the network name of the printer or its IP
address.
If the printer supports the common printer MIB, a response like this appears:
407
408
CHAPTER 16
If there is a private printer MIB entry for the printer, make a note of its
ENTERPRISE_NO.
If the printer supports both the common printer MIB and a private printer MIB,
you can choose which MIB provides the most useful status information. To do this,
compare the information for the printer MIBs in the oids.tab file.
Using the printer MIB to get status information
Set the printer servers BackChannel and Query_Printer parameters as follows.
Options
[-c community:port]
(Used with printers that have external JetDirect cards with multiple ports.)
Specify the SNMP community and the port number (usually 1, 2 or 3).
printerid
Either the network name of the printer or its TCP/IP network address.
enterprise_no
(Used only if you want to get status information from a private printer MIB.)
The ENTERPRISE_NO of the private printer MIB.
CHAPTER 16
kwikinfo
Set the printer servers BackChannel and Query_Printer parameters to use the
following command:
Syntax
kwikinfo printerid
Parameter
printerid
ncrdinfo
Find the type of network card that the printer uses by typing:
ncrdinfo -c detect printerid [community]
If Columbus OM can identify the network card, it displays a message like this:
Printer Card Detection
----------------------- This product has an enterprise-specific number of 253.
-- This product calls itself: HP Ethernet Multi-Environment, JetDirect
--- The card is made by Hewlett-Packard.
or
AXIS
-- Which means you have a choice of:
-hpjd
-axishp
If the network card is axishp or hpjd, you can use information in the
ncrdinfo command. See ncrdinfo on page 409.
If the network card is axis, hr1514 or lexmark, you have to specify
additional information. See Finding the additional information required
below.
Type:
ncrdinfo -x -c cardtype printerid
409
410
CHAPTER 16
The message shows the additional information that you need to specify in the
ncrdinfo commands -e parameter. In this example, the message shows that
the network card uses port 1, so the command you specify looks like this:
ncrdinfo -c hr1514 -e 1 10.20.0.244
Description
axishp
axis
Axis
hpjd
HP JetDirect
hr1514
lexmark
Lexmark
-e extras
Use if the network card is axis, hr1514 or lexmark: see Finding the
additional information required above.
-t
Displays exactly what the printer returns to the request for status.
printerid
lprinfo
Set the printer servers BackChannel and Query_Printer parameters to use this
command:
Syntax
lprinfo host [queue] [options]
or
lprinfo -p printer [options]
CHAPTER 16
Parameters
host
The name of the host (as specified in the etc/hosts file) that is running the lp
daemon (lpd) or, if the network card supports the lpd protocol, the name of
the printer.
queue
The lpd queue name. If it is the same as the host, then you can omit this
parameter.
-p printer
oceinfo
Option
Description
-a
-b
-c number
-l number
-m number
-q service
-r
-s
-t timeout
-u character
-x string
-zz
To get status information from Oce printers, set the printer servers BackChannel
and Query_Printer parameters to:
oceinfo host
Replace host with either the name of the printer as specified in the etc/hosts file,
or its TCP/IP address.
411
412
CHAPTER 16
pjlinfo
To get status information from PJL-enabled printers that use the pjlout driver, set
the printer servers BackChannel and Query_Printer parameters to use the
following command.
Printer type
Command
Local printer
Remote printer
Parameters
host
The name of the host that the Columbus OM instance that controls the printer
is on.
-p printer
Do this
display the information returned by the See Displaying the information from
printers BackChannel command or
statserver on page 413.
Query_Printer command
create a list of printers that are reporting See Printer Warnings folder on
a problem
page 414.
display a printers web page
CHAPTER 16
To
Do this
display the information that is provided Click the Advanced tab, and then click
by the statserver command
Printers. The status information is
displayed in the Back Channel column.
display the BackChannel column
Edit the %UNIQDIR%\config\oids.tab file, and then find the section for the
printer MIB that Columbus OM uses to get status information from the printer.
This can be either a private printer MIB or the common printer MIB: which
Columbus OM uses depends on the value that you set the BackChannel
command to (see Using the printer MIB to get status information on
page 408).
For example, the common printer MIB might look like this:
413
414
CHAPTER 16
# 1
Common Printer MIB
#
ENTERPRISE_NO
"Common Printer MIB" 1
#
# Key
Description
Oid
# ----------------------------------- -------------------------------DESCRIPTION
Description
1.3.6.1.2.1.25.3.2.1.3.1
DEVICESTATUS
"Device Status"
1.3.6.1.2.1.25.3.2.1.5.1
PRINTERSTATUS
Status
1.3.6.1.2.1.25.3.5.1.1.1
PRINTERERROR
"Error Code"
1.3.6.1.2.1.25.3.5.1.2.1
DEFAULTINPUT
"Default Input"
1.3.6.1.2.1.43.5.1.1.6.1
CONSOLEBUF1
"Console 1"
1.3.6.1.2.1.43.16.5.1.2.1.1
CONSOLEBUF2
"Console 2"
1.3.6.1.2.1.43.16.5.1.2.1.2
BACKCHANNEL
Backchannel
"%CONSOLEBUF1%"
END_ENTERPRISE
# ------------------------------------------------------------------------
For the printer, make a list of all the printer messages that could be displayed in
the Back Channel column. To find out the possible messages, do one of the
following:
Simulate the various error conditions (by, for example, removing the paper
trays and taking the printer offline), and then make a note of the text that
appears in the Back Channel column.
CHAPTER 16
Backchannel text
---------------------"Close"
"Jammed"
"Down"
"Offline"
"Load"
"Paper"
"Unavailable"
"Warning"
"Other"
"Unknown"
"Toner"
"NoResponse"
Example
If, when you remove a paper tray, the text Insert Tray 1 appears in the Back
Channel column, add a row like this to the backchannel.tab file:
PAPER_OUT
"Insert"
When you remove the tray, Columbus OM displays the printer in the Printer
Warnings folder.
415
416
CHAPTER 16
In the Columbus OM Preferences dialog box, click the Printers tab, and then
click Refresh.
Set the Scan Rate to the interval (measured in minutes) at you want
Columbus OM Explorer to scan printers looking for problems.
Click OK.
This feature scans only enabled printers; it does not scan disabled printers.
CHAPTER 16
The commands can include substitution variables, for example %DOCUMENT for the
current document and %DATE for the current time. For a list of the substitution
variables that can be included, see Substitution variables on page 603.
To
Do this
Parameter
Executed when
Action_On_Completion
Action_On_Failure
Action_On_Incomplete
Action_on_New
Action_On_Shutdown
Action_On_Start
Action_Pre_Completion
417
418
CHAPTER 16
Completed queue
syq -JOURNAL_COMPLETE|-jc [entry_id] [file]
syq -JOURNAL_COMPLETE_APPEND|-jca [entry_id] [file]
syq -JOURNAL_COMPLETE_OVERWRITE|-jco [entry_id] [file]
Archive queue
syq -JOURNAL_ARCHIVE|-ja [entry_id] [file]
syq -JOURNAL_ARCHIVE_APPEND|-jaa [entry_id] [file]
syq -JOURNAL_ARCHIVE_OVERWRITE|-jao [entry_id] [file]
To
Do this
Include file
The default names are pending.jnl,
completed.jnl, and archive.jnl
CHAPTER 16
Log files
Log files
Columbus OM records information about what the servers and printer servers do
in log files.
Command line
The log files are in the %UNIQDIR%\servers\servername folder.
Columbus OM Explorer
Navigate to: Documents tab
Logs
instance icon
Maintenance menu
Browse
Log files
File
General processing
activity
%UNIQDIR%\servers\server\dayDD.log
DD is the day of the month that the log file covers
(day01.log, day02.log, and so on, up to day31.log).
%UNIQDIR%\servers\server\operator.log
Standard output
messages
%UNIQDIR%\servers\server\driver.log
[date] is the date for which you want information, one of:
dd
ddmm
The day (01, 02 ... 31) of the specified month (01, 02 ... 12).
>file puts the information into the file that is specified. If you do not include
419
420
CHAPTER 16
Log files
Replace file... with a list of the report files that you produced.
CHAPTER 16
File logging
FILE filename
events
FORMAT format
SNMP logging
SNMP host:port
events
CONFIG config
Custom logging
CUSTOM filter
events
FORMAT format
CONFIG config
Parameters
filename
(For file logging.) The path and name of the file in which the events are to be
recorded.
The name can include environment variables, and the date and time (by using
substitution variables). For example:
FILE ${UNIQDIR}\media\events\events-%DATE(YYMMDD).log
421
422
CHAPTER 16
host
(For SNMP logging.) The computer to which the SNMP traps are to be sent:
specify either its hostname or its IP address.
See also SNMP enterprise numbers on page 436.
port
(For SNMP logging.) The port number or service name to which the SNMP
traps are to be sent. Most enterprise management systems listen on port
snmp-traps, trapd or 162.
filter
(For custom logging.) The name of the application that is used to process
events.
events
Do this
Specify ALL
record no events
Specify NONE
a single event
For a shortcut to specify groups of events that you want to use more than once
in the file, see Specifying groups of events on page 425.
CHAPTER 16
format
The format in which the event information is recorded in the log file. Use these
substitution variables (they are different from the standard substitution
variables). For basic information about an event, use %LOGDATA.
Substitution
variable
Description
%%
%CLASS
%CODE
%DATE
%DESCRIPTION
%EVENTD
%EVENTX
%LOGDATA
Information comprising:
This is the format used in the event logging feature that was
available in versions before Columbus OM 4.4.
%MICRO
%NPARAM
%PARAMn
%PRODC
%PRODD
423
424
CHAPTER 16
Substitution
variable
Description
%PRODS
%PRODX
%SECONDS
%TIME
%TYPEn
${name}
config
(For SNMP logging and custom logging.) Configuration data, specified by using
one or more of the following items:
Data
Description
max_events=number
max_time=seconds
restart=number|Yes|No
CHAPTER 16
Data
Description
stderr=Yes|No
stopcmd=command
verify=Yes|No
Example 2:
In this example, the separator character is + (plus sign):
CONFIG +max_events=20 + stopcmd=save;quit
range of events, use a hyphen for example, P145-155. To specify all events
that start with the same code, use the code followed by * (asterisk). To nest
groups, use &name.
2
425
426
CHAPTER 16
For example:
GROUP
GROUP
GROUP
GROUP
print
common
user
other
P145-155
C76,C77,C86,C102
U*
&common,&user
# Filter 1
# -------FILE ${UNIQDIR}\media\events\printlog.%DATE(YEAR-MO-DD).tab
&print
#
# Filter 2
# -------FILE ${UNIQDIR}\media\events\otherlog.%DATE(YEAR-MO-DD).tab
&other
(This file is also used for defining your own events. For more information, see
Defining additional events to be recorded on page 427.)
File format
1
In the userevent.tab file, start the section specifying the standard events that
you want to redefine with this keyword:
STANDARD_EVENTS
Description
-----------------"Added new entry"
C77
P145
P147
"Entry started"
"Entry completed"
Arguments
--------%UID %DOCUMENT_PATH
%DESTINATION %OWNER %PRIORITY
%UID %DOCUMENT_PATH
%DESTINATION %OWNER %PRIORITY
""
""
Field
Description
Event
CHAPTER 16
Field
Description
Description
Arguments
To validate the file, see Validating the user events file on page 428.
Defining the
events
(This file is also used for redefining standard events. For more information, see
Redefining standard events on page 426.)
File format
The userevent.tab file contains these sections:
Section
Description
ARGUMENT_TYPES
USER_EVENTS
STANDARD_EVENTS
Code
A number to identify the argument type, 51 100.
Description
A description of the argument. This text is returned by the %TYPEn substitution
variable. The maximum length of the description is 15 characters.
427
428
CHAPTER 16
Product
User
Priority
Uid
Queue
Server
Paper
Program
Other
Type
Licence
Medium
Instance
Class
Destination
Security
Chars
Attempts
Pages
Status
Revision
PageNo
Arguments
--------51,52
53,53,53
Description
---------------------"Fatal system error"
"Statistical data record"
Event
Event number, 1 9999.
Class
Event class, one of: Admin, Audit, Detail, Error, Fatal, Security, and Stats.
See also Event classes on page 429.
Arguments
A list of argument types (as specified in the ARGUMENT_TYPES section). Separate
multiple argument types with commas. There must be no spaces between the items.
Description
Text describing the event.
Validating the
user events file
CHAPTER 16
Generating
user-defined
events
To generate user-defined events, use the logevent program. logevent can be run
from scripts or other applications as required.
logevent can also be used to generate standard events.
Syntax
logevent number arguments
Parameters
number
51,52
53,53,53
Event classes
To record information about event of a specific type, use these classes in the events
parameter (see events on page 422):
For information about
Use
FATAL
errors such as Servers active cannot fix, Queue fixed - still corrupt ERROR
use of the administration functions
ADMIN
auditing events, for example: Server starting and Queue fixed - now AUDIT
OK
when a user tries to access a function that they are not authorized to use SECURITY
429
430
CHAPTER 16
Use
DETAIL
STATS
Event codes
Event codes comprise a letter that indicate the product (C for Common, F for Fax,
or P for Print), and a number, as shown in the sections below.
Event codes: C (Common: All products)
No
Class
Description
Arguments
C1
Audit
Server starting
Program, Other
C2
Audit
Program
C3
Fatal
System error
Program, Other
C7
User
C8
User
C9
User
C10
Security Auth fail: View queue entries for other users User
C11
C12
Security Auth fail: View arch. entries for other users User
C13
User
C14
User
C15
User, Priority
C16
User
C17
User, Queue
C18
User, Queue
C19
User
C20
User
C21
User
C22
User
C23
User
C24
User
C25
User
C26
User
C27
User
User
CHAPTER 16
No
Class
Description
C28
User, Queue
C29
User
C30
User
C31
User
C32
User
C33
User
C34
User
C35
User
C36
C37
User
C38
User
C39
User
C40
User
C41
C42
User
C43
Admin
Copy server
Server, Server
C44
Admin
Kill server
Server
C45
Admin
Server
C46
Admin
Check queue
Queue
C47
Admin
Compress queue
Queue
C48
Error
Queue corrupt
Queue
C49
Audit
Queue OK
Queue
C50
Admin
C51
Admin
Extend queue
Queue
C52
Admin
Fix queue
Queue
C53
Admin
Queue
C54
Error
Queue
C55
Audit
Queue
C56
Admin
Initiate server
Server
C57
Admin
Terminate server
Server
C58
Admin
C59
Admin
C60
Admin
Arguments
Queue
431
432
CHAPTER 16
No
Class
Description
Arguments
C61
Admin
Purge queue
Queue
C62
Admin
Queue
C63
Admin
C64
Admin
C65
Admin
C66
Admin
C67
Audit
Queue
C68
Error
Queue
C69
Admin
C70
Admin
C71
Admin
C72
Admin
Remove a server
C73
Admin
C74
Admin
C75
Audit
Queue, User
C76
Stats
Program, User,
Uid
C77
Stats
Program, User,
Uid
C78
Stats
Program, User,
Uid
C79
Stats
Program, User,
Uid
C80
Stats
Program, User,
Uid, Other
C81
Stats
Program, User,
Uid
C82
Stats
Program, User,
Uid
C83
Stats
Program, User,
Uid, Other
C84
Stats
Program, User,
Uid, Other
C85
Stats
Program, User,
Uid, Other
Server
Server
Server
CHAPTER 16
No
Class
Description
Arguments
C86
Stats
Program, User,
Uid, Other
C87
Stats
Job completed OK
Program, User,
Uid, Other
C88
Stats
Program, User,
Uid, Other
C89
Stats
Program, User,
Uid, Other
C90
Stats
Program, User,
Uid
C91
Stats
Program, User,
Uid
C92
Stats
Program, User,
Uid
C93
Stats
Program, User,
Uid
C94
Stats
Program, User,
Uid
C95
Stats
Program, User,
Uid, Other
C96
Admin
Server, Class
C97
Admin
Server, Class
C98
User
C99
User
C100 Fatal
Program, Server
C101 Audit
Server, User,
Other
C102 Stats
Program, User,
Uid, Other
C103 Stats
Program, User,
Uid, Other
C104 Stats
Uid, User
C105 Audit
Queue, Count
C106 Audit
Queue, Count
C107 Audit
Queue, Count
433
434
CHAPTER 16
Class
Description
Arguments
F5
Admin
Server
F6
Admin
Sending a fax
Server, Destination
F7
Admin
Receiving a fax
Server
F8
Error
Entry postponed
Destination,
Owner, Uid, Other
F9
Error
Entry failed
Destination,
Owner, Uid, Other
F10
Fatal
Fatal error
Server, Other
F11
Audit
Server, Other
Class
Description
Arguments
P1
Fatal
Printer offline
Server
P2
Fatal
Printer busy
Server
P3
Fatal
Server
P4
Fatal
Server
P5
Fatal
Server
P6
Fatal
Server
P7
Fatal
Server
P8
Fatal
Server
P9
Fatal
Server
P10
Fatal
Printer problem
Server
P11
Fatal
Server
P12
Fatal
Server
P13
Audit
Printer starting
Program, Revision
P14
Audit
Program
P15
Audit
Initiate printer
Server
P13, P14 and P15 are used only if the Use_Print_Events parameter in
the system defaults file (default.tab) is set to Yes.
P100 Security Auth fail: Abort current printout
User
User
User
User
User
CHAPTER 16
No
Class
Description
Arguments
User
User
User
User
User
User
P114 Admin
Server
P115 Admin
Server
P116 Admin
Server
P117 Admin
Server
P118 Admin
Server
P119 Admin
Server
P120 Admin
Enable printer
Server
P121 Admin
Lineup printer
Server
P122 Admin
Server, Paper
P123 Admin
Server, Paper
P124 Admin
Server
P125 Admin
Server
P126 Admin
Server, Server
P127 Admin
Server, Server
P128 Admin
Add a printer
Server
P129 Admin
Modify a printer
Server
P131 Admin
Paper
P132 Admin
Paper
P133 Admin
Paper
P134 Admin
Type
P135 Admin
Type
P136 Admin
Type
P137 Admin
Server
P138 Admin
P139 Audit
P141 Audit
435
436
CHAPTER 16
No
Class
Description
Arguments
P142 Audit
Printer started
Server
P144 Audit
Printer stopped
Server
P145 Audit
Server, Uid
P147 Audit
Server, Uid
P148 Error
Entry postponed
Server, Uid
P149 Error
Entry failed
Server, Uid
P150 Audit
Entry transferred
Server, Uid
P151 Audit
Server, Uid
P152 Error
Server, Uid
P153 Audit
Entry blocked
P154 Audit
Entry processed
Server, Uid
Enterprise number
Common
1.3.6.1.4.1.2196
1.3.6.1.4.1.2196.1
Fax
1.3.6.1.4.1.2196.3
Dispatch
1.3.6.1.4.1.2196.7
CHAPTER 16
running.
FB_Action_On_Complete script
require detailed information on the progress of print jobs. In this case, set
Ack_Command to invoke the traditional ACK/NAK mechanism which reports
status back to an originating (remote) host only when a print job succeeds or
fails.
To return detailed status information to a remote host, also set
Status_Feedback to a number (of 5 or greater) or YES (equivalent to a number
of 10). The effect then is to report status back to the remote host as soon as it
changes from New > Starting > Printing > Complete/Failed/Postponed, and
also to report supplementary information (for example, Printing Page n) every
number seconds.
437
438
CHAPTER 16
Configuration parameters
Action_On_Shutdown command
A command to be run when the server stops. For more information, see
Operating system actions during processing on page 417.
Error_Continue Yes|No
When the server starts, it checks the configuration of the filter programs.
Yes tells evserver to ignore any errors, and continue working. Events for
the filters that contain errors are cached; they can be processed by
correcting the errors, and then restarting evserver.
Flush_Filter Yes|No
Events are written first to a common file, and then copied to a separate file for
each event filter.
To
Do this
Specify Yes.
Specify No.
Each FILE filter reformats event records, and then writes the record in a logfile.
To write each record to the logfile as it is available, specify Yes.
To write records in groups, when enough events have been processed to force
the file to be flushed to disk, specify No.
The default value is No.
CHAPTER 16
Max_Reads number
Not used.
Server text
When you stop evserver, it stops the filter programs. This parameter tells it
how long (measured in seconds) to wait for them to stop. If a filter program is
still running after this time, evserver forces it to stop.
If you want evserver to wait forever for the filter programs to stop (and never
force them to stop), specify 0.
The default value is 0.
Wait_Time number
How long (measured in seconds) that the server sleeps when there are no
events for it to process.
439
440
CHAPTER 16
BcCollector YES|NO
YES uses the multi-threaded bccollector program to get status information.
NO uses the less efficient (single-threaded) BackChannel method to get status
information.
The default value is YES.
Device_Callback [stat_mon]
Set to stat_mon only when a print instance is integrated into the SAP R/3
environment, using R/3 access method E: callback. Otherwise, leave blank
(the default).
Ignore_Disabled YES|NO
YES prevents statserver trying to collect the status of printers that are disabled.
Doing this might help to reduce network traffic.
Max_Sessions number
The medium name which marks a queue entry as suitable for processing by this
server.
Notify_Instance host:instance
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
CHAPTER 16
Stagger_Time number
The local port number on which statserver listens for SNMPv1 traps. Can be
specified as a port number or service name; standard values are either 162 or
snmp-trap.
Trap_Manager host
The name of the service that statserver uses to send the information. This is
used if statserver is sending the information to a different instance (specified by
using the Notify_Instance parameter).
The default service is uniqcs.
Setting the Scan_Interval and Stagger_Time parameters
The best values to use for Scan_Interval and Stagger_Time depend on the
number and type of printers and the speed of the computer.
For a system with relatively few printers (perhaps 10 or fewer), you can reduce
Stagger_Time, or even set it set to zero.
For a system with a lot of printers (100 or more), you might need to increase
both Scan_Interval (for example, to 20) and Stagger_Time (for example, to
20 if most printers have printer MIB support, or 100 otherwise).
information that has been superseded, and then sends the rest all at once to the
appropriate host. This means that it has to login only once to the host for each
group of messages.
To use this feature, you must also set the Status_Feedback parameter in the
system defaults file (default.tab) to 5 seconds or more.
441
442
CHAPTER 16
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Action_On_Shutdown command
Action_On_Start command
Columbus OM deletes the backup copy after it has processed the statuses, or
when uqsfcache stops normally.
The default value is Yes.
BlackList_Secs number
If uqsfcache cannot login into a host, this parameter tells it how long to wait
(measured in seconds) before it tries again (instead of repeatedly trying to
login). uqsfcache accumulates the statuses for the host until it becomes
available again.
If you set this parameter, make sure that its value is the same as or more than
the value of the Scan_Interval parameter.
The default value is 60 seconds.
Feedback_Actions YES|NO
YES tells uqsfcache to perform the actions that are specified by the
FB_Action_On_Complete and FB_Action_On_Failure parameters in the
system defaults file (default.tab).
NO tells uqsfcache to ignore those parameters.
Log_Bad_Instance YES|NO
This parameter might be useful if you are using uqsfcache with another
instance that is on the same computer, and that instance is not in the
systems.tab file.
In this situation, uqsfcache sends the status messages by the network (instead
of writing them directly to the instances cache file), and then puts an error
message in its logfile.
If you do not want these error messages recorded (because, for example, you
have deliberately omitted the instance from the systems.tab file), set this
parameter to No.
The default value is Yes.
Process_Level number
When the number of records in the cache file reaches this level, uqsfcache
starts processing them. Processing can also start after the interval that is
specified by the Scan_Interval parameter.
CHAPTER 16
A userid that Columbus OM can use to login to a remote host computer that it
needs to send feedback to.
The default userid is uniq; if there is no user called uniq on the remote host
computer, set this parameter.
Scan_Interval number
Sends every status change to the hostnames listed, not only the latest status
change.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Threshold_Secs number
The maximum number of cache records to keep in memory: if the cache file
exceeds this number for more than the time specified by the Threshold_Secs
parameter, the memory is freed and then re-allocated as required.
The default value is 1000 cache records.
443
444
CHAPTER 16
445
C H A P T E R 17
Chapter 17
Processing email
messages
This section describes how send email messages and process incoming email
messages by using Columbus OM.
Sending email messages
To send a document as an email message, you add it to the queue in the same way
as any other type of entry. The document can be sent as either the text of the email
message or as an attachment to the email message.
The entries are processed by the Columbus OM mailer server. It transfers the entry
to your email application (such as Microsoft Exchange), and then the email
application sends it to its destination (that is, an email address).
For more information, see Configuring Columbus OM to send email messages on
page 446.
Processing incoming email messages
Columbus OM can monitor a mailbox for incoming email messages, and then add
them to its queue for processing such as printing.
Columbus OM can apply special processing to:
For more information, see Processing incoming email messages on page 451.
446
CHAPTER 17
Value
Server Name
Program
Select mailer.
Value
SMTP_Server
Domain
Sender
Message File
Default text for the body of the email messages. The file
must be in the %UNIQDIR%\servers\server_name
directory.
For information about the other configuration parameters for the mailer server, see
mailer server configuration parameters on page 458.
On the Document tab, set the entrys Medium to Mail, and then type the
email address in the To box.
CHAPTER 17
To
Do this
add CC recipients
Include this parameter so that the document is processed by the mailer server.
447
448
CHAPTER 17
-at address
Includes the file specified as an attachment to the email message. For example:
aeq message.txt -at [email protected] -m mail
-st "-fa"
Includes the file specified as the text of the email message. For example:
aeq message.txt -at [email protected] -m mail -st "-fb"
This command sends an email message with the content of the message.txt
file as its text.
-sn address
Specifies the senders email address, overriding the value of the mailer servers
Sender parameter. For example, to send an email message from
[email protected], use:
aeq -at [email protected] -dt "Your file %UID has completed"
-st "-sn [email protected]" -m mail
Examples
To send a document as an attachment to an email message
1
The -at parameter specifies the address to which the email message is sent.
-dt specifies the body of the message. -st specifies the document file to be
attached. -m mail ensures that the entry is processed by the mailer server.
To send an email message without an attachment
1
CHAPTER 17
Put the text that you want to be used as the body of the email message into a
file.
Set the mailer servers Message_File parameter to the location and name of
the file.
Put the text that you want to be used as the body of the email message into a
file called, for example, mymessage.txt.
To include the contents of a file in the text of the email message, use -fb in the -st
parameter text, For example:
aeq message.txt -at [email protected] -m mail -st "-fb -cc
[email protected]"
To specify the senders email address
To specify the senders email address, set the mailer servers Sender parameter.
To specify a different senders email address when you add an entry, use the -st
parameter. For example, to send an email message from
[email protected], use:
aeq -at [email protected] -rt "File completed"
-dt "Your file %UID has completed"
-st "-sn [email protected]" -m mail
To send carbon copies
To send the email message to other email address as CC (carbon copies), use -cc
address in the -st parameter text, for example:
aeq message.txt -at [email protected] -m mail
-st "-cc [email protected] -cc [email protected]"
This command sends the email message to John, and carbon copies to Mary and
Pat.
To change the format of documents
To specify a format to which all documents are to be converted, use the mailer
servers Convert_To parameter.
449
450
CHAPTER 17
CHAPTER 17
It can process delivery failure messages that have been received in reply to
email messages sent by the Columbus OM mailer server.
After the mailin server has processed an email message, it deletes it from the
mailbox.
To monitor two or more mailboxes, you can create multiple mailin servers.
Value
Server Name
Program
Select mailin.
Value
POP3_Server
The name of the computer that the mailbox that the server
is to process is on.
POP3_User
POP3_Pass
451
452
CHAPTER 17
Value
SMTP_Server
SMTP_User
SMTP_Domain
For information about the other configuration parameters for the mailin server,
see mailin server configuration parameters on page 459.
copies any attachments from the email message, and then puts them in the
queue\document folder
Description
Alias
Destination
Medium
Owner
Program Id
CHAPTER 17
Property
Description
Remark
Server Info
Attachment files
Columbus OM puts the attachment files in the queue\document folder. Their
filenames are included in the Server Info property, and they have this format:
xentryid_n.att
For example, if the original email message has three attachments, and its entry
number is 456, the attachment files are called x0000456_1.att, x0000456_2.att
and x0000456_3.att.
Create an email message, and then set its Subject field to:
ColumbusOM Auto
In the text of the email message, add one section for each attachment to specify
how you want the attachment to be processed, using the syntax shown below.
Send the email message to the mailbox that the mailin server uses (that is, the
user specified by the POP3_User parameter).
453
454
CHAPTER 17
Syntax
ATTACHMENT n
DESTINATION text
MEDIUM text
[ALIAS text]
[REMARK text]
[RESPOND]
Repeat this section for each attachment that you want to process. To process a
single attachment in two or more ways, you can specify two or more sections with
the same ATTACHMENT number.
Parameters
Value
ATTACHMENT
The number of the attachment that the instructions apply to. The
first attachment to the email message is number 1.
DESTINATION
MEDIUM
ALIAS
REMARK
RESPOND
Example
This email message has two attachments and contains this text:
CHAPTER 17
ATTACHMENT 1
MEDIUM PRINT
DESTINATION myprinter1
RESPOND
ATTACHMENT 1
MEDIUM MAIL
DESTINATION [email protected]
RESPOND
ATTACHMENT 2
MEDIUM PRINT
DESTINATION myprinter1
RESPOND
From this email message, the mailin server creates these entries in the queue:
It also sends an email message back to the sender, confirming that it has add the
entries to the queue, and indicating the entry numbers.
It copies the attachments to the queue folders. This means that the attachments
can be accessed by, for example, the Columbus OM dispatch features. The files
are listed in the entrys Server Info property.
It sends a reply to the sender with information about what it has done.
455
456
CHAPTER 17
UQ (
(that is, hyphen space UQ space open-parenthesis) anywhere in the subject line. This
indicates that the original email message was sent by the Columbus OM mailer
server. To configure the mailer server so that it adds this text, set its
Check_Delivery parameter to Yes.
Configuring the mailin server to handle delivery failures
Set these parameters:
Parameter
Value
Process_Undeliverable
Yes
Undeliverable_Subject
Specify the text that in the Subject line that marks the
email message as a delivery failure, for example:
Undelivered Message: To specify two or more
items of text (for example, to handle other
languages), separate them by using a semicolon. The
default text is Undeliverable:
Undeliverable_Medium
Value
Alias
Destination
Medium
Original UID
CHAPTER 17
Property
Value
Owner
Program Id
Remark
Server Info
property.
group is the original email messages Security_Group
property.
n is the total number of attachments.
file1 ... filen are the names of the attachments.
457
458
CHAPTER 17
Configuration parameters
Action_On_Completion command
Action_On_Failure command
Action_On_InCompletion command
Action_On_Postponement command
Action_On_Shutdown command
Action_On_Start command
Action_Pre_Completion command
The maximum number of attempts to process a queue entry before setting its
status to Failed. 0 prevents postponement, failing after the first attempt. The
interval between attempts is set by Postpone_Time.
Check_Delivery Yes|No
Yes adds the text - UQ (entry_id) to the subject line of the email message.
This text can be used by the mailin server to identify the original email message
that caused a delivery failure message to be returned.
Convert_To type
The document type to which the attachments are to be converted, for example
PDF. The implementor must ensure that the suitable conversion utility exists.
Domain domain
This parameter controls what happens if an attachment file that has been
specified for an entry cannot be found:
To not send the entry (and set its status to Failed), set this parameter to
Yes.
To send the entry in any case, set this parameter to No.
Message_File filename
The name of a file that contains the text to be used as the body of the email
message.
If this parameter is empty, or the file specified does not exist, Columbus OM
uses the contents of the file that is specified by the entrys -df parameter (or the
text that is specified by the or -dt parameter) as the body text.
CHAPTER 17
Postpone_Time number
The interval in seconds between successive scans of the queue. The default is
10.
Sender address
The name of a server running a suitable SMTP mail server, such as Microsoft
Exchange.
Configuration parameters
Action_On_Shutdown text
A command to be run when the server is shut down. For more information, see
Operating system actions during processing on page 417.
Destination text
459
460
CHAPTER 17
Process_Undeliverable Yes|No
See Configuring the mailin server to handle delivery failures on page 456.
The default value is No.
Program text
The frequency (measured in seconds) at which the server scans the mailbox for
incoming email messages.
The default value is 10.
Security_Level integer
The name of the server. This must be the same as the name of the folder that
the configuration file is in (%UNIQDIR%\servers\server\config.tab).
SMTP_Domain text
The name of the host that the SMTP daemon or service to be used for sending
replies is on.
SMTP_User text
See Configuring the mailin server to handle delivery failures on page 456.
The default value is dispatch.
CHAPTER 17
Undeliverable_Medium text
See Configuring the mailin server to handle delivery failures on page 456.
The default value is dispatch.
Undeliverable_Program text
See Configuring the mailin server to handle delivery failures on page 456.
The default value is Undeliverable:
461
462
CHAPTER 17
463
C H A P T E R 18
Chapter 18
Configuring a fax
environment
Columbus OM
Explorer
Columbus OM
pending queue
fax modem
telephone
system
fax server
completed
queue
printer for
confirmation copies
You add an entry to the pending queue by using Columbus OM Explorer or the
command line, specifying the document you want to send and the telephone
number that you want to send it to. The medium applied to the entry must match
the medium used by the server that you want to process it.
The fax server checks the pending queue to see if there are any requests that it is to
process. When it finds one, it passes the request to the fax modem, dials the
telephone number and sends the fax. Then it moves the entry to the completed
queue, with its status set to indicate whether it was successful or not.
You can configure Columbus OM to print a copy of the faxes that you send. The
copies are printed by the faxprint server.
464
CHAPTER 18
Additional features
Reduce the cost of sending a fax by using the least-cost faxing feature. For more
information, see Least-cost faxing on page 467.
Redirect and blacklist fax numbers: For more information, see Redirecting and
blacklisting fax numbers on page 466.
Receiving faxes
To
From
fax modem
receives fax, and
then transfers it to
Columbus OM
Columbus OM
fax server
pending queue
faxmaster
message to
recipient
faxprint
printer
When a fax modem receives a fax, the fax server that controls the modem receives
the document and puts it in the pending queue, marked as an incoming fax.
The document can then be printed, sent onto to the recipient, or both.
Printing is controlled by the faxprint server. It scans the queue for incoming
faxes, and then prints them.
Distribution is controlled by the faxmaster server. When it finds an incoming
fax in the queue, faxmaster compares the fax number that the document was
sent from against a list that you set up. The list tells faxmaster who the
recipient should be (for example, if the fax is from 0123 - 444 555, then the
recipient is Mary Smith). Then faxmaster sends an email to the recipient,
and it can also pass the document to faxprint for printing.
Multitech modems
CHAPTER 18
465
466
CHAPTER 18
Add a fax server for each fax modem that you want Columbus OM to use.
Make sure that Outgoing Allowed option is selected.
See Adding servers on page 98.
Create a file called out_commands that contains the commands to initialize the
modem for sending a fax. For more information about the commands to use,
see the modems documentation.
Do this
specify the control codes that might be Set the Lost_Exchange parameter. To
received from the modem to indicate
specify two or more control codes,
that it has lost contact with the exchange separate them by using a space
character.
control attempts to reset the modem
In the file, create one entry for each fax number that you want to redirect or
blacklist. Each entry comprises three fields, separated by spaces.
CHAPTER 18
Field
Value
Example entries
09875556666 01237778888
0123334444
In this example:
faxes that a user sends to 0987 555 6666 are redirected to 0123 777 8888
faxes that a user sends to 012 333 4444 are not sent.
Least-cost faxing
Least-cost faxing enables requests sent from one Columbus OM fax instance to be
processed by a different Columbus OM fax instance one that has the lowest
telephone call cost to the final destination of the fax. For example, to send a fax
from France to the USA, the document could be added to a Columbus OM fax
instance in France; Columbus OM transfers the request to the instance in the USA;
and then that instance faxes the document. A national (or even local) call is used
instead of an international one.
To configure Columbus OM for least-cost faxing
1
Edit the remote.tab file in the Columbus OM fax instances config folder. (If
the file does not already exist, you can create it.)
Add an entry for each remote host. See the entry format and example below.
In the Columbus OM fax instance, set each fax servers Ack_Medium parameter
to Print.
Value
A dialling code. To mark the end of the dialling code, use *. For example,
001* identifies all faxes send to a number starting with 001.
The Columbus OM print instance: the hostname and the instance name,
separated by a colon.
467
468
CHAPTER 18
usa:fax1
france:fax1
uk:fax1
This example shows a least-cost faxing solution that might be used by a company in
the UK, that also has offices in New York and Paris.
Documents sent to fax numbers that start with 001 are transferred for
processing by the fax1 instance on the usa host, from where they can be sent
at local or national callrates.
Similarly, documents set to fax numbers that start with 0033 are transferred to
the fax1 instance on the france host.
All other documents are processed by the fax1 instance on the uk host.
Polling (Faxback)
To support polling (also known as faxback), where someone calls your fax
number and in response, you fax back a document, set these parameters:
Parameter
Value
Poll_Doc
Poll_Type
Poll_Wait_Ack
Format
Set Poll_Type to
ASCII text
Text
Hasler T4
T4
The maximum time in minutes that the server will wait for an
acknowledgement signal after responding to the poll request.
The minimum value is 1.
Parameter
Value
Print_Outgoing
Yes
Medium_for_Print
FaxPrint
Medium
FaxPrint
faxprint
CHAPTER 18
Parameter
Value
Medium_for_Print
FaxPrint
faxprint
Medium
FaxPrint
third-party
application
Columbus OM
print instance
Columbus OM
fax instance
fax modem
To use this feature, the print and fax instances must be on the same host.
To add a printer server that redirects documents to a Columbus OM
fax instance
1
Set the Instance the name of the Columbus OM fax instance to be used.
To specify a default fax number to be used if one is not specified with an entry,
set Fax number.
Click OK.
In the Columbus OM fax instance, create a server that uses the netmaster
program, and set its Medium parameter to print.
469
470
CHAPTER 18
Fax the page to a Columbus OM fax modem that supports incoming calls.
Look in the Columbus OM fax queue for the fax, and make a note of its entry
number.
Check and modify the file as required by using a graphics program (for
example, PaintBrush).
If the file needs to be transferred to another computer for modification, it must
be transferred as a binary file.
Type:
pcx2has file.pcx file.has [-F][-M rows]
where file is the name of the PCX-format file, without the .pcx extension.
Columbus OM creates a Ascom Hasler T4-format file called file.has.
Include the -F flag if the graphic is the correct aspect ratio for fine mode.
Use the -M rows option to truncate the end of the graphic when trailing
white space is included.
The next step depends on what sort of modem the file is to be used for:
For an Ascom Hasler HFU modem
CHAPTER 18
Convert the Ascom Hasler T4 format file to the Class 2 T4 format by typing:
has2pfax file.has
Convert the Ascom Hasler T4 format file to the D&CE T4 format by typing:
has2dce file.has
Command syntax
Name of
converted file
has2dce file
file.dce
PCX format
file.pcx
has2pfax file
file.g1
Parameters
file
Convert from coarse to fine format by doubling the number of rows and
halving the height of the pixels.
Converting from PCX format
To convert a raster graphic file from PCX format to Hasler T4 fax format, use this
command:
pcx2has file.pcx file.has [-F] [-Mnumber]
Parameters
file
471
472
CHAPTER 18
-Mnumber
Do this
Embedding
commands in
documents
Support
Syntax
.ALIAS text
Support
Syntax
.DESTINATION fax_number
Replace fax_number with the number of the fax machine that the
document is to be sent to.
.FONT: Changing the font
Support
Syntax
.FONT font_file
CHAPTER 18
Support
Syntax
.GRAPHIC graphics_file
Fax machine
Filename extension
pfax
.pfax
haslerfx
.has
faxbox
.dce
Support
Class 2
Syntax
.OVERLAY file
Replace file with the name of the file to be applied. The overlay
file must:
Support
Syntax
.OWNER login_id
Support
Syntax
.PROGRAM source_program
Support
Syntax
.REMARK "text"
473
474
CHAPTER 18
Replaced with
%DATE(MON DD YEAR)
%TIME
%DATE_CREATED
%OWNER
For information about other date and time formats, and other substitution
variables, see Substitution variables on page 603.
Example
This example shows how embedded commands and substitution variables can be
used in an document file:
.OVERLAY logo
SENT:
TO:
FROM:
John Smith
Mary Brown
Adding coversheets
You can add a one-page coversheet to the front of a document. Users can add a
different coversheet when they send a fax, which will replace the default one.
Creating a
coversheet file
Create a file that contains the information you want on the coversheet. See
Creating a coversheet file below.
Set the Coversheet parameter for the fax server to the path and filename of
the coversheet.
File format
The coversheet file must be in ASCII (plain text), PCL or T4 format.
CHAPTER 18
File location
The coversheet file must be on the same host computer as the Columbus OM fax
instance.
Filename extension
The coversheet file must have one of these filename extensions, to identify what
format it is:
ASCII
PCL
.pcl
pfax T4
.pfax
haslerfx T4
.has
Substitution variables
A coversheet that is in ASCII format can include substitution variables to enable
entry-related information to be added when the coversheet is sent. For a list of the
substitution variables, see Substitution variables on page 603.
Embedded commands
A coversheet in ASCII format can include embedded commands to include
graphics, change fonts and so on. For more information about embedded
commands, see Embedding commands in documents on page 472.
For the pfax program, the coversheet can include any of the Columbus OM
fax facilitys embedded commands.
For the haslerfx program, the coversheet can include only the .GRAPHIC and
.FONT commands.
475
476
CHAPTER 18
Use Columbus OM Explorer. For more information, see Sending faxes using
Columbus OM Explorer below
Use the command line. for more information, see Sending faxes using the
command line on page 477.
Class 2
Ascom
Hasler HFU
D&CE Faxbox
ASCII
Bitmap
HP PCL3
HP PCL5
PostScript
CHAPTER 18
Document properties
Property
Description
Destination
Medium
To
Do this
The telephone numbers to which you want to send the documents are listed in
the file that you specify. In the file, each telephone number must be on a
separate line.
477
478
CHAPTER 18
-ADDRESS_TEXT|-at fax_number
The path and name of a file that contains a coversheet which is to be sent at the
head of each source document. If the file is in the
%UNIQDIR%\media\fax\covers folder, you can omit the path.
-FILE_TYPE|-ft encoding
TEXT
Plain text
pfax
haslerfx
faxbox
PS
PostScript
pfax
haslerfx
faxbox
PCL
pfax
haslerfx
HP
pfax
haslerfx
faxbox
-MEDIUM|-m medium
Use
-ovn [file]
-ovn [file]
-ov OFF
file is the full path and name of the file that contains the overlay.
CHAPTER 18
479
480
CHAPTER 18
Receiving faxes
Receiving faxes
Configuring Columbus OM to receive faxes
1
Value
Incoming_Allowed
Yes.
Action_on_Start
Add a fax server for each fax modem that might receive faxes. Make sure that
the Incoming Allowed option is selected.
Configure what you want the fax server to do with the incoming faxes:
To
See
Create a file called in_commands that contains the commands to initialize the
modem for receiving a fax (see the examples below). For more information
about the commands to use, see the modems documentation.
Check what value the faxprint servers Medium parameter is set to, and then
set the fax servers Medium_for_RX parameter to the same value.
CHAPTER 18
Receiving faxes
Example
This example configuration file for faxprint shows values that product suitable
output for printing faxes on a HP LaserJet 4050 printer that supports 600dpi.
# Key
# ---------#
Server
Medium
Attributes
New_Page
Pre_Doc
Value
Disp?
-------------------------------- -----
faxprint
No
Faxprint
Yes
"aeq -at hp4 -df %s -qn print"
Yes
\f\033*p0X\033*p8Y\033*b1M\r\n
Yes
\033E\0339\033&l0L\033&l0E\033*t600R\033*p0X\
033*p8Y\033*b1M\r\n
Yes
Post_Doc
\033*rB
Yes
Strtgraf
\033*b%dW
Yes
Prntmode
Horizontal
Yes
Trunc_White Yes
Yes
Hdots
4760
Yes
Hdensity
2
Yes
Vdensity
3
Yes
Char_len
8
Yes
Parity
None
Yes
Scan_Dir
Down
Yes
LaserjetII No
Yes
(The value for the Pre_Doc parameter should be on a single line in the actual file.)
Check what value the faxmaster servers Medium parameter is set to, and then
set the fax servers Medium_for_RX parameter to the same value.
In the file, add one line for each source of incoming faxes, as described below.
Entry format
For each entry, specify these fields, separated by spaces.
Field
Value
The user id who will be the owner of faxes from this source.
The medium to be used for faxes received from this source (usually
FaxPrint).
481
482
CHAPTER 18
Receiving faxes
Field
Value
The path where incoming faxes from this source are to be copied. You can
include substitution variables. If the path or file name contain spaces,
enclose it in quotes.
Example
"0123 444 555" "John Smith" mab FaxPrint "Mary Brown" C:\Faxes
default
""
rec FaxPrint "Reception" C:\RecFaxes
In this example:
faxes received from 0123 444 555 are distributed to the user mab, and copied to
C:\Faxes.
faxes received from all other numbers are distributed to the user rec, and
copied to C:\RexFaxes.
CHAPTER 18
Server
See
Ascom Hasler
Haslerfx
faxbox servers:
Faxbox modems
below
Pfax
page 490
Multitech modems
Pfax
page 490
Faxbox
page 483
Pfax
page 490
The command character recognized by the modem; usually set to a caret (^).
Default_File_Type TEXT|HP
TEXT (the default) to assume that fax documents without an explicit type are
encoded as plain ASCII text; HP to assume that the encoding is HPs PCL5.
Device string
483
484
CHAPTER 18
Dial_Prefix code...
A sequence of control codes sent to the modem prior to the fax_number, for
example to select an external telephone line.
Faxbox30 YES|NO
YES (the default) if the modem is a Faxbox 30 model; NO if it is a Faxbox model.
Flow_Control TRANSPARENT|NORMAL
TRANSPARENT if the modem has been configured for Transparent flow control;
NORMAL (the default) otherwise.
Incoming_Allowed YES|NO
YES to accept incoming documents and process them as specified by
Incoming_To; NO (the default) to ignore such entries.
Incoming_Format FINE|COARSE|ANY
FINE to accept faxes in fine T4 format; COARSE to accept coarse T4 format; ANY
(the default) to accept either format.
Incoming_Speed 2400|4800|9600
The maximum baud rate at which to accept incoming faxes. The default is
9600.
Incoming_To HOST|MONITOR|BOTH
Description
HOST
MONITOR
BOTH
The maximum number of attempts to send a fax before setting the entrys
status to Failed.
Medium FAX
The medium name that identifies the queue entries that the server processes.
CHAPTER 18
Medium_For_RX FAX_IN
The medium name for queue entries which are automatically created to handle
incoming documents.
Monitor_Format 8|24
format.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Timeout number
The medium name which marks a queue entry as suitable for processing by this
server.
485
486
CHAPTER 18
Outgoing_Allowed YES|NO
YES to periodically scan the folder specified by Outgoing_Directory and
process files of appropriate format that are found there; NO (the default) to
ignore the Outgoing_Directory parameter.
Outgoing_Directory folder
The full path of a folder which is periodically scanned under the control of the
Outgoing_Allowed parameter. The folder can include substitution of
operating system variables ${name} and Columbus OM variables %name.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Wait_Time number
monitors the queue for entries with a medium of FAX, and transmits them, and
receives incoming faxes, and adds entries with a medium of FAX_IN to the
queue.
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Ack_Medium PRINT
CHAPTER 18
Coversheet file
Dial_Prefix code...
A sequence of control codes sent to the modem prior to the fax_number, for
example to select an external telephone line.
Incoming_Allowed YES|NO
YES to accept incoming documents and add them as queue entries with the
medium specified by Medium_For_RX; NO (the default) to ignore such entries.
Left_Margin number
The distance by which the text of an outgoing fax is shifted to the right,
establishing a blank left-hand margin. A value of 200 represents one inch; the
default is zero.
Line_Numbers YES|NO
YES to insert a number at the start of each line of text, ensuring that no material
is lost in transmission; NO (the default) otherwise.
Lost_Exchange code code...
The medium name which marks a queue entry as suitable for processing by this
server.
Medium_For_Print FAXPRINT
The medium name for queue entries which are automatically created to handle
printed confirmation of outgoing documents.
487
488
CHAPTER 18
Medium_For_RX FAX_IN
The full path of a file transmitted in response to a poll request from the modem.
The file can include substitution of operating system variables ${name} and
Columbus OM variables %name. See also Poll_Type.
Poll_Type TEXT|T4
TEXT (the default) if the file specified by Poll_Doc is encoded as plain ASCII
text; T4 if the encoding is Hasler T4 format.
Poll_Wait_Ack number
The delay (measured in minutes) after which a poll response attempt is deemed
to have failed. The default is 2.
Print_Outgoing YES|NO
YES to create a queue entry, with the medium specified by Medium_For_Print,
to print a confirmatory copy of each outgoing document; NO (the default)
otherwise.
Reset_Interval number
The security level to be applied to entries. The security levels that you can use
are stored in the seclev.tab file.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
Update_Time YES|NO
YES (the default) to periodically adjust the modems internal clock to reflect
system time on the Columbus OM host; NO otherwise.
CHAPTER 18
An operating system command which prints a queue entry. The command can
include substitution of operating system variables ${name} and Columbus OM
variables %name, and also the special value %s (the document file).
Char_Len 7|8
Use 7 if the printer requires binary data to be sent in seven-bit chunks; use 8
(the default) otherwise.
Hdensity 1/3|1/2|1|2|3
The maximum number of dots that the printer can output horizontally across a
page.
LaserJetII YES|NO
YES if the printer is compatible with an HP LaserJet II; NO (the default)
otherwise.
Medium FAXPRINT
The medium name which marks a queue entry as suitable for processing by this
server.
New_Page code...
The sequence of control codes to cause the printer to start a new page.
Parity ODD|EVEN|NONE
The sequence of control codes to reset the printer after printing a document.
Pre_Doc code...
489
490
CHAPTER 18
Scan_Dir UP|DOWN
The security level to be applied to entries. The security levels that you can use
are stored in the seclev.tab file.
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
StopGraf code...
The sequence of control codes to deselect raster mode at the end of a graphical
line.
StrtGraf code...
The sequence of control codes to select raster mode at the start of a graphical
line.
Trunc_White YES|NO
YES to truncate trailing white space on a page; NO (the default) otherwise.
Vdensity 1/3|1/2|1|2|3
Configuration parameters
Ack_Medium PRINT
CHAPTER 18
Attempts_Limit number
(If Banner_Reqd is YES.) Text to be printed at the top of each page. You
include operating system variables ${name} and Columbus OM substitution
variables %name. For example, %UID prints the entry number and %TIME prints
the current time.
Banner_Reqd YES|NO
YES print a banner line at the top of every page. The format of the banner, with
text specified by the Banner parameter, is:
date
text
Page N of M
The page width in characters within which the banner line is created. The
default is 80, although 92 is a better fit if using the default banner font.
Coversheet file
Dial_Prefix code...
A sequence of control codes sent to the modem prior to the fax_number, for
example to select an external telephone line. The default is T.
Incoming_Allowed NO
NO (the default) to ignore incoming documents.
Left_Margin number
The distance by which the text of an outgoing fax is shifted to the right,
establishing a blank left-hand margin. A value of 200 represents one inch; the
default is zero.
491
492
CHAPTER 18
Line_Numbers YES|NO
YES to insert a number at the start of each line of text, ensuring that no material
is lost in transmission; NO (the default) otherwise.
Max_Resets number
The medium name which marks a queue entry as suitable for processing by this
server.
Medium_For_Print FAXPRINT
The medium name for queue entries which are automatically created to handle
printed confirmation of outgoing documents.
Out_Commands file
To pad out short pages (that is, pages that are not completely filled) with spaces
to the full A4 page length (297mm), specify YES.
The default value is YES.
Print_Outgoing YES|NO
YES to create a queue entry, with the medium specified by Medium_For_Print,
to print a confirmatory copy of each outgoing document; NO (the default)
otherwise.
Reset_Interval number
The security level to be applied to entries. The security levels that you can use
are stored in the seclev.tab file.
CHAPTER 18
Server server
The name of the server, which must be the same as the name of the folder
holding %UNIQDIR%\servers\server\config.tab.
493
494
CHAPTER 18
495
C H A P T E R 19
Chapter 19
See
adding printers
displaying information about the queues Displaying the queues on page 521
managing servers
managing users
This section provides general information about setting up an IOP deployment for
zone printing, OnCall (pull) printing, and Scan2Print (quota-based scanning and
printing). Exact procedures depend on the hardware that you are using, and might
require more specific information from the hardware supplier or Macro 4.
To install an IOP deployment, see Installing a Columbus Intelligent Office
Printing (IOP) deployment on page 37.
496
CHAPTER 19
CHAPTER 19
printers in zone A
virtual
printer
Windows
Gateway
Columbus OM
instance
virtual
printer
users in zone B
Windows
Gateway
printers in zone B
You connect to a virtual printer that uses the IOP Universal Driver. You
have to do this only once.
You set your current zone by using IOP Messenger or IOP Desktop.
IOP Messenger is a small application that is displayed on the Windows task
bar. You have to set your zone only when you start using the IOP features, and
when you move to a different zone.
You print your document to the virtual printer, by using the Print command
from any Windows program in the same way as if you were printing directly to
a real printer.
The virtual printer connects to the Columbus Windows Gateway, and the
Columbus Windows Gateway connects to the Columbus OM instance
Columbus OM calculates the best printer for the document from the group of
printers that are in your zone, based on one or more of these criteria:
the requirements of the document, for example, if the user has requested
colour, duplex, stapling and so on
It can also compare the cost and speed of printing a document in the selected
zone with the cost and speed using a printer that is in a special reprographics
zone, and suggest the cheapest or fastest option to the user.
6
IOP Messenger displays a message on the users computer to tell them when
the document is ready, and which printer was used.
497
498
CHAPTER 19
zone server
Columbus OM
instance
You print your document in the usual way by using the IOP Universal Driver:
select the OnCall option in the printer dialog box.
The IOP Universal Driver connects to the Windows Gateway, and then
Windows Gateway connects to the Columbus OM instance.
You go to a printer to collect your document. The printer can be any printer in
the IOP deployment. At the printer, you identify yourself by inserting a swipe
card or typing a PIN number.
Depending on the type of printer, either it prints all the documents you
have sent, or it has a screen that displays a list of documents that you have
sent to print, and you can select which ones you want to print.
IOP OnCall can be used with zone printing. In this case, the printer might
suggest a different printer on which you could print the document, which
might be faster or cheaper.
Columbus OM releases the document from its queue, and then sends it to the
printer.
CHAPTER 19
The user interface that Columbus OM provides asks the user how many copies
they want; whether the document to be scanned is single-sided or double-sided;
whether they want to print it in black-and-white or colour.
tells the user that their quota is not enough to process it.
499
500
CHAPTER 19
Use the IOP web interface to create the zones (groups to contain printers that
are at a similar location), and add the printers.
See Working with zones on page 502 and Working with printers on
page 506.
If required, control the features that users can use, and create rules to establish
when alternative printers are to be used.
See Working with enforcements on page 517 and Working with diversions
on page 519.
For zone printing deployments, you usually install the gateway and the driver
on each users computer, and then set up a printer on that computer. You
should also install IOP Messenger on each computer. See also Static and
roaming users (desktops and laptops) on page 498.
For OnCall deployments, you usually install the gateway and the driver on the
same computer as Columbus OM, and then create a shared printer. On each
users computer, enable access to the shared printer. This method minimizes
the amount of software that has to be installed.
CHAPTER 19
Type the username and password of the administrator user that you created
when you installed Columbus OM.
In the username, include the domain, for example: mynetwork\uniq.
501
502
CHAPTER 19
Levels
Zones
CHAPTER 19
In the Create Zone Template pane, set the properties of the hierarchy, and then
click Create zone structure.
503
504
CHAPTER 19
You have to use only the levels that you need. For example, for a small
deployment, you might use only Areas and Zones.
Configuring zones
To configure a zone, navigate to IOP Zone Administration
then navigate to the zone.
Value
Title
Description
Image
Value
Instance
Description
Colour
Size
The zone to be used if the request is too big for the selected zone.
Capacity
Time
Failure
CHAPTER 19
Zone devices
Specify the devices that are in the zone. To add a zone, click Add Device to Zone,
and then specify its properties.
505
506
CHAPTER 19
Adding printers
1
Columbus OM displays the IP address range of the network (or a portion of it)
on which it is installed: Change the IP addresses if required.
Columbus OM will create a default name for each printer that it find; the name
starts PRT, for example: PRT00001. To use a different name, click the
Advanced tab, and then change the Auto name prefix.
Click Scan.
Columbus OM scans the IP addresses, and then displays the printers that it
finds.
CHAPTER 19
Configuring printers
To set the properties of a printer, navigate to OM Devices
click the printer.
Value
Medium
Device type
Description
COMMAND
DIRECT
NETWORK
Printer Id
Printer Type
Channel Type
507
508
CHAPTER 19
Value
BackChannel
Attempts Limit
Pause Time
Postpone Time
Delivery mode
Accounting DSN,
User and Password
Value
Any paper
Supports PostScript
Click the Zone Devices tab, and then click Add Device to Zone.
Select the printers that you want to add, and then click Save.
CHAPTER 19
Type the range of IP addresses that you want to scan, and then click Scan.
Columbus OM scans the IP address for card readers, and then displays the
devices that it finds.
3
Select the card readers that you want to add to Columbus IOP, and then click
Configure selected readers.
Columbus OM configures the readers. You can check what it does by accessing
the card readers webpage in your web browser. The webpage should show
that the card readers remote host IP address is the same as that of the OnCall
Server that you specified above.
OnCall
See also Configuring multiple printers for Oncall printing on page 511.
509
510
CHAPTER 19
Value
OnCall Type
Associated Printer
Value
Station ID
Authorization Type
Value
Authorization Server
Specify 443.
Device Administrator ID
and Password
Value
OnCall Type
Associated Printer
CHAPTER 19
Value
Authorization Type
Select Xerox.
Authorization Server
Specify 443.
Device Administrator ID
and Password
Description
Native (Windows/UNIX)
login id and password
Employee/Card number
only
Employee/Card number
and PIN
Specify the prompt and help text that are to be displayed on the printers
screen for the login id and the password or PIN, if used.
In a text file, create a list of printers, each on a separate line. Each entry must
have this format:
ipaddress [user] [password] [ip_address:port]
The only field that you have to include for each printer is the IP address.
Field
Value
ipaddress
511
512
CHAPTER 19
Field
Value
user password
ip_address:port
Value
filename
user
password
ip_address:port
-A|-O|-S
-Q
Service
Parameter
OnCall
-O
-S
All services
-A
CHAPTER 19
Entry format
For each Columbus OM instance that is to be scanned to see if it has any jobs that
belong to a user, add an entry like this:
host
instance
service
domain
Parameters
host
If the instance is on a Windows host: The default user domain that is used.
Example file
# Hostname
# -------myhost1
myhost1
myhost2
Instance name
------------PRINT1
PRINT2
PRINT3
Service
-------2007
testport
2007
Domain/OS
--------MYDOMAIN
MYDOMAIN
UNIX
This example specifies three instances to be scanned. PRINT1 and PRINT2 are on
the myhost1 computer, which uses Windows. PRINT3 is on the myhost2
computer, which uses UNIX.
513
514
CHAPTER 19
Value
Get_Quota
The path and name of the program that stores the users quotas.
The program must accept as input the users name.
Set_Quota
If the program has a quota for the user, it must write the
quota to standard output, and return 0.
If the program does not have a quota for the user, it must
write 0 to standard output, and return 1.
The path and name of the program that decrements the users
quota after processing the document. The program must accept
as input the users name, and return either 0 (quota successfully
changed) or 1 (quota not successfully changed).
If the card reader and printer have not yet been added to Columbus OM, see
Configuring card readers for OnCall printing on page 509.
In the Configure OnCall Station pane, click the EIP Applications tab, and
then click Scan2Print.
OnCall Stations,
CHAPTER 19
Managing users
Managing users
Adding users manually
1
Navigate to Users
Specify the user properties as described below, and then click Save.
User Admin.
Value
Name
Login Id
Department
Email address
Card Id
Rules
Property
Value
Current zone
Type the zone that the user is in. Users can also set and
change their zone by using the IOP Desktop and IOP
Messenger.
515
516
CHAPTER 19
Managing users
Navigate to Users
On the LDAP Attribute Mapping tab, map the IOP properties (that is, the
Variable column) to the attributes that are used in the LDAP system.
Click Save.
LDAP Settings.
CHAPTER 19
Enforcements.
Managing enforcements
To
Do this
Value
Description
Rule type
Attribute
Applies an enforcement to
Document
name
517
518
CHAPTER 19
Property
Value
User
CHAPTER 19
Diversions.
Managing diversions
To
Do this
Value
Description of rule
Zone to base
calculations on
The reprographics zone: that is, the zone that contains the
other printers that you you want Columbus OM to
calculate the cost and speed of using.
Destination for
diversion
519
520
CHAPTER 19
Property
Value
Cost threshold
Time threshold
Additional
information:
Instructions and
Link
Specify the text that you want to appear in the message that
is sent to the user when the diversion rule applies.
CHAPTER 19
Managing Columbus OM
Managing Columbus OM
The IOP interface provides some similar features to Columbus OM Explorer for
managing queues, documents, and servers, and setting the system default
parameters.
Displaying the queues
Navigate to Queues, and then click All Pending Jobs or All Complete Jobs.
Columbus IOP displays a summary of the queues for each Columbus OM instance.
To
Do this
delete a document
reprint a document
Click Resubmit.
521
522
CHAPTER 19
Managing Columbus OM
Monitoring servers
To
Do this
Navigate to OM Administration
System Defaults.
CHAPTER 19
Managing Columbus OM
523
524
CHAPTER 19
This section describes how to set your zone and track documents by using IOP
Desktop. To do perform these tasks by using IOP Messenger, see Using IOP
features with IOP Messenger on page 75.
Zones contain one or more printers from which Columbus IOP selects the most
appropriate one for each document that you print. For example, if the
document is in colour, Columbus IOP prints it on a colour printer.
Zones usually reflect the geography of your organization. For example, there
might be a zone for each site; for each floor in a building; or for each room.
Setting your zone enables Columbus IOP to print your documents on your
nearest printer.
When you have set your zone, Columbus IOP remembers it until you change
it. When you move to a different location, you must set your new zone.
CHAPTER 19
Type your username and password, and then click Sign In.
Find your location by using the navigation pane at the left of the screen.
next to an item indicates that there are more items within it: to see
those items, click the item.
next to an item indicates that the item is a zone: to see the printers
that are in the zone, click the item.
When the zone that you want is displayed, click Set as your Current Zone.
Printing documents
When you have set up an IOP printer, you can use it in the same way as you print
to any printer, that is, by using the Print command in a Windows application.
To print a document
1
The Columbus IOP printer has some extra properties that you might want
to use; for more information, see To set the printer properties below.
Click Print.
For more information about printing in Windows, see the applications
documentation.
525
526
CHAPTER 19
To track the progress of the document, see Managing documents on page 527.
In the Print dialog box, select the Columbus OM printer, and then click
Properties.
The Properties dialog box appears.
Click OK.
CHAPTER 19
Managing documents
Managing documents
Click the document that you want to manage, and then do one of the following:
To
Do this
display a document
Click Remove.
Click Hold.
Click Release.
Click Resubmit.
527
528
CHAPTER 19
For each SecureJet device, create a Columbus OM printer that uses the
securejet server.
For more information about how to create a printer, see Setting up printers on
page 141.
Configure the securejet server to process jobs that have a specific medium
attached.
To configure the securejet server, see securejet server configuration
parameters on page 534.
Users submit jobs to Columbus OM, and set the Medium of the job to that used
by the securejet server.
CHAPTER 19
For each printer or group of printers that use a different set of specific
commands, you must create a file that maps the general commands to the
specific commands.
This file is called printer_codes.tab. For more information about its format,
see printer_codes.tab file on page 529.
printer_codes.tab file
The printer_codes.tab file maps the PJL comments that Columbus OM puts in
PCL files to printer-specific commands.
File location and name
media\print\printer_type
529
530
CHAPTER 19
The name of the folder, printer_type, must be the same as the value of the
Printer_Type parameter for the printers to which the file applies.
File format
The printer_codes.tab file can contain these type of entries:
entries to change escape characters (see To change escape codes on page 531).
substitution
location
key
The general PJL comment that Columbus OM puts in the PCL file. You can
see the comments by opening the PCL file in a text editor; they are in the
header section, in a block that starts @PJL COMMENT UNIQ START
JOBTICKET.
Use one of these values:
COLLATE
NAME
PIN
COLOURMODE
NEEDED
PUNCH
COPIES
OUT-TRAY
SECURE
COSTCENTRE
OWNER
STAPLE
END
PAPER_COLOUR
START
FILE
PAPER_SIZE
TONER_SAVING
METHOD
PAPER_TYPE
substitution
Description
%n
The nth value element in the PJL comment. The value elements
are numbered from 1, after the keyword. For example, to extract
1800 from the following comment, use %1:
@PJL COMMENT UNIQ NEEDED 1800
%CR
%NL
CHAPTER 19
%LOOKUP(key,file,column)
file is the name of the lookup file, without its .tab extension.
column is the number of the column that contains the value. The first
column in a file is number 0.
Where you want the substitution command to be put in the print file. Use one
of these values:
Value
Description
(empty)
Yes
PCL
SUBPCL
string2
SUBSTITUTE
string1
The text in the file that you want to change. The text is case-sensitive.
string2
Represents
Octal character
%ESC
Escape character
octal 033
%CR
octal 015
%LF
octal 012
%NL
octal 012
To use this feature, you must also set the printers Page_Mode parameter to
Intelligent.
531
532
CHAPTER 19
Example
This example printer_codes.tab file shows entries that are suitable for a Xerox
WorkCentre device.
# Job control substitutions
#
# Key
Substitution
Outside?
# -------START
COPIES
METHOD
NEEDED
STAPLE
PUNCH
COLLATE
OWNER
FILE
NAME
SECURE
PIN
PAPER_TYPE
Description
colour_modes.tab
paper_colours.tab
paper_sizes.tab
paper_tray.tab
paper_types.tab
CHAPTER 19
In each file, add an entry for each Key that Columbus OM uses, and the
Substitution value that is specific to the printer, as shown in the examples below.
colour_modes.tab: Example
Key
-----------------mono
colour
Substitution
-----------GRAYSCALE
COLOR
paper_colours.tab: Example
Key
-----------------WHITE
BUFF
BLUE
Substitution
---------------White
Buff
Blue
paper_sizes.tab: Example
Key
-----------------A4
A3
Letter
Legal
Substitution
-----------26
27
2
3
X
---------5657
Y
----------8177
paper_tray.tab
Key
-----------------INTRAY1
INTRAY2
INTRAY3
Substitution
----------31
32
33
paper_types.tab: Example
Key
-----------------PLAIN
LETTERHEAD
PREPRINTED
Substitution
--------------------Standard
Letterhead
Preprinted
Length
-----8
10
10
533
534
CHAPTER 19
(UNIX only.) The host, instance and port number of a Columbus OM system
on a Windows computer that validates users names and passwords when they
log on to the IOP interface. Separate the host, instance and port number by
using colons, for example:
Login_Server
myhost:ColumbusOM:2000
Mess_To_Source_On text
Sends messages to the source host instead of the owner. To do this, specify
some text in this parameter, and then put the same text in the queue entrys
Program field.
Columbus OM compares the value of this parameter and the text in an entrys
Program field. If they match, Columbus OM sends the message to the source
host; if they are different, Columbus OM sends the message to the owner of the
entry.
OnCall_Rls_Medium text
The host, instance name, and port number that the zone server is on.
Parameter
Server text
The medium that will be applied to jobs to indicate that they are to be
processed by the SecureJet server: usually print.
Auth_Validator program
The program used that is used to validate a users details (that is, when the
AUTH command is received from the SecureJet device).
The default value is csulin.
CHAPTER 19
Action_On_Start script
Action_On_Shutdown script
YES indicates that the SecureJet ids in the SJuser.tab file are
case-insensitive; that is, john in the file represents john, JOHN,
John and so on.
NO indicates that the SecureJet ids in the SJuser.tab file are case-sensitive;
Number of days (1 99) that the job stays in the SecureJet devices queue. (This
does affect how long it stays in the Columbus OM queue.)
The default value is 5.
PortNo number
How often (number of seconds) that the server checks the SecureJet terminal
for a shutdown request.
Zip_Command command
Zip_Delete command
Zip_Filename filename
For versions 7 and 7a of the Securejet protocol, the data must be compressed
before it is sent to the SecureJet device.
SecureJet protocol version
7
7a
Format
gzip file
zip file
Zip_Command
pkzip %s.zip %s
del %s.zip
535
536
CHAPTER 19
7a
%s.zip
Entry format
For each Columbus OM instance that is to be scanned to see if it has any jobs that
belong to a user, add an entry like this:
host
instance
service
domain
Field
Value
host
service
domain
Example file
# Hostname
# -------myhost1
myhost1
myhost2
Instance name
------------PRINT1
PRINT2
PRINT3
Service
-------2007
testport
2007
Domain/OS
--------MYDOMAIN
MYDOMAIN
UNIX
This example specifies three instances to be scanned. PRINT1 and PRINT2 are on
the myhost1 computer, which uses Windows. PRINT3 is on the myhost2
computer, which uses UNIX.
CHAPTER 19
Configuration parameters
Server text
The interval (measured in minutes) at which the server synchronizes the files.
The default value is 1440.
Entry format
For each user, add a entry specifying their SecureJet id and their Columbus OM
user name. The user name may include the users domain; you can specify a default
domain in the deployment.tab file (see deployment.tab: Listing the
Columbus OM instances on page 536).
For example:
1234-00-6789
3456-00-8765
9876-00-5432
john
mary
sales\pat
If any of the SecureJet ids are the same as the Columbus OM user names, you can
add an entry that covers all those users like this:
*
(That is, put an asterisk in the SecureJet id column, and an equal sign in the
Columbus OM user name column. This entry must be the last entry in the file.)
To control whether the names are case-sensitive, use the Ignore_SJUser_Case
parameter in the SecureJet server configuration file (see above).
537
538
CHAPTER 19
Entry format
For each SecureJet device, add an entry that specifies the device and the
Columbus OM printer server that controls it.
Example file
# Securejet device
# ---------------MySJ100.mycompany.intranet.com
MySJ101.mycompany.intranet.com
Columbus OM server
-----------------SecureJet01
SecureJet02
When a user requests a PRINT from the SecureJet device MySJ100, Columbus OM
sends the job to the printer that is controlled by its SecureJet01 server.
539
C H A P T E R 20
Chapter 20
Integrating Columbus OM
with SAP R/3
This section explains how to integrate Columbus OM into a SAP R/3 environment
so that it can manage the printing and faxing of documents generated by SAP R/3.
This section assumes that you are familiar with using the Columbus OM and
SAP R/3 configuration features.
To
See
540
CHAPTER 20
printers and
fax modems
SAP R/3
SAP R/3
spool server
Columbus OM
network
Columbus OM
host
printers and
fax modems
In this environment, an SAP R/3 job is sent from SAP R/3 to its spool server. The
spool server sends the job to the Columbus OM instance that is on the same
computer. Columbus OM either processes the job itself, and then sends it to a
printer or fax modem, or it sends the job to another Columbus OM instance to be
processed.
Multiple SAP R/3 instances and Columbus OM OMS
SAP R/3
printers and
fax modems
SAP R/3
network
Columbus OM
host
printers and
fax modems
CHAPTER 20
In this environment, an SAP R/3 job from any of the SAP R/3 instances goes
through the SAP R/3 spool server to the Columbus OM instance that is on the SAP
R/3 spool server host. Columbus OM sends the job to its final destination for
printing or faxing.
Furthermore, in either the single or multiple SAP R/3 instance environment, both
of the following scenarios are also possible:
To reduce the loading on the Columbus OM instance on the SAP R/3 spool
server host, you can install two or more Columbus OM instances on the host,
each providing a separate interface to the OMS.
A Columbus OM instance that is on the same computer as SAP R/3 can send
jobs from SAP R/3 to printers that are attached directly to the computer.
SAP R/3
printers and
fax modems
SAP R/3
Columbus OM
Columbus OM
host
printers and
fax modems
printers and
fax modems
network
printer status.
Columbus OM reports changes in job status and device status according to whether
its callback caching feature is used:
If the callback caching feature is used, Columbus OM stores the job and printer
status changes in a file, and then sends them to SAP R/3 at regular intervals.
Callback caching minimizes network traffic and allows recovery from network
unavailability or unscheduled downtime, allowing status change to be stored
until they can be successfully returned to the originating SAP R/3 instance.
If the callback caching feature is not used, Columbus OM sends the job status
changes to SAP R/3 when they happen, by using SAP R/3s RFC mechanism.
541
542
CHAPTER 20
Columbus OM sends printer status changes only if there are any jobs in the
printers queue. For example, if you take a printer offline, but there are no jobs
in its queue, Columbus OM does not report the change in status to SAP R/3.
RFC call or callback
SAP R/3
SAP R/3
spool server
Columbus OM
Columbus OM
host
printers and
fax modems
network
Availability
Access method E with callback is available in SAP R/3 versions V4.0 and above.
CHAPTER 20
Enabling the SAP R/3 spool server host to interface with Columbus OM on
page 543.
Description
Windows
Type
set UNIQDIR=path
543
CHAPTER 20
Using the SU01 transaction, create a new user account, specifying either the
S_ABAP_ALL (all authorizations for ABAP/4) profile or the S_XMI_XOM_A
(authorizations for external management interfaces XOM) profile.
544
CHAPTER 20
Value
Real OMS
A name for the real OMS. Use a name that includes the
host and the Columbus OM instance, for example:
MYHOSTPRINT1.
Description
Tasking
Job status
Device status
Value
Initialization
instance
Initialization
command
Reconfiguration How often the caching server checks with SAP if there are
request
any configuration changes. Typically, this value is set to 60
(seconds). If you leave it blank, the server checks every 300
seconds.
5
545
CHAPTER 20
546
Value
Logical OMS
Description
Real OMS
Tasking target
Target for
callback
The name of the SAP R/3 host to which the RFC call will
be made when submitting a job using this logical OMS.
Devices
Select Callback.
Jobs
CHAPTER 20
Value
Command path
Submit
Job cancel
Job query
Defining a printer
For each Columbus OM printer that you want to use from SAP R/3, you must
create an output device in SAP R/3, and associate it with a logical OMS. You can
associate the same output device with any number of logical OMSs.
To define a printer
1
From the spad transaction, select Output Devices, and then make sure that
the Edit toolbar button is selected.
The Spool Administration: Create Output Device dialog box appears.
547
CHAPTER 20
548
Value
Output device
A name for the printer. You can use any name that you
like. This name is used only within SAP; it does not affect
Columbus OM.
Short name
Device
Attributes
Spool server
Device class
Lock printer in
SAP System
Other properties
CHAPTER 20
Value
Host spool
access method
Host printer
Logical OMS
Set the values on the Output attributes and Tray info tabs to your
installations requirements.
None of the values on these tabs affect Columbus OM.
549
550
CHAPTER 20
Configuring Columbus OM
Configuring Columbus OM
To configure Columbus OM, complete the following procedures in the order
shown.
1
Returning status information to the originating SAP R/3 instance on page 551.
Controlling security
Decide whether or not to add the SAP R/3 host usernames to the security file
(aeq_o) of the Columbus OM instance on the SAP R/3 spool server host.
If no SAP R/3 host usernames are specified in the security file, jobs can be
submitted to the Columbus OM OMS by any SAP R/3 host.
If you want to restrict access to the Columbus OM OMS to specific SAP R/3
hosts, add only those host usernames to the security file.
Value
Program
dcs
OUTGOING
Repeat these steps for each of the Columbus OM instances that are on the SAP
R/3 spool server host.
CHAPTER 20
Configuring Columbus OM
Value
SAP_NOTIFY
Yes
Status_Feedback
Add the name &implementors to the sap_passwd file. This file is in the
instances security folder.
Change to the folder where the instance is installed, and then set up the
Columbus OM environment variables:
Platform
Do this
UNIX (C shell)
Type:
source csetup
UNIX (Bourne or
Korn shells)
Type:
Windows
Type:
. ./setup
set UNIQDIR=c:\dir
If there is more than one SAP instance on the host, or you want to use the
SAP feedback caching server uqsapcache, check that this line has been
added to the file:
SAP_IDENTIFIER INSTANCE
If you are specifying SAP hosts by host name, add this line to the file:
SAP_IDENTIFIER HOST
551
552
CHAPTER 20
Configuring Columbus OM
Reduced network usage: one login when the system starts, and one network
transaction handle multiple responses.
Amount of feedback (that is, the report level) is configurable by the SAP user.
Device feedback is available even if a device does not have any outstanding
jobs.
Value
SAPJOB_CACHE
filename Yes|No
filename is the name of the cache file in which job
job callbacks.
CHAPTER 20
Parameter
Value
SAPDEV_CACHE
filename Yes|No
Yes|No
Yes forces stat_mon to deliver SAP feedback about any
Columbus OM printer status.
For each SAP instance that will be served by the caching server, there must be
an entry in the saphosts.tab file. To maintain the file, type:
sappasswd
Yes
For example:
sapcachini sapcache_1 myroms myinstance myclient x x
sapcachini starts uqsapcache, and informs the ROMS server it is responsible
for.
sapcachini is also called by SAP as each ROMS is started. Each ROMS has
one caching server which is responsible for it. A caching server may be
responsible for more than one ROMS.
553
554
CHAPTER 20
Registering Columbus OM
1
Extract the contents of the SLDREG Columbus OM.zip file into a folder.
Parameter
Value
host
port
user passw
When Columbus OM has been registered, you can delete the files that you
extracted from the zip file.
Make a note of what the DEST parameter is set to. As supplied, it is set to
UNIQSAP, and does not usually need to be changed.
CHAPTER 20
Value
ASHOST
RFC_TRACE
Value
client_number
The number of the SAP R/3 client (000 999). The default
value is 000.
destination
-keep
To maintain a trace file, include this flag. You must also set
the RFC_TRACE entry in the saprfc.ini file, as described
above.
If you do not include this flag, the trace file is deleted.
Specifies how long Columbus OM should attempt to lock the cache file. When
the uqsapcache server needs to open the cache file, or when other servers
want to provide cached feedback to SAP, the cache file needs to be locked. If
the file is already in use, uqsapcache and the SAP feedback programs
uqsap_jc and uqsap_dc retry once every second for the number of seconds
that is specified by this parameter. If the cache file is still not available, the
server stops the attempt until its next scheduled attempt.
The minimum value is 1. The maximum value is 10.
SAPDEV_CACHE filename
If this entry is given with a filename, SAP feedback for devices is cached into
this file, in the %UNIQDIR%\media\cache folder.
SAPJOB_CACHE filename
If this entry is given with a filename, job feedback for devices is cached into
this file, in the %UNIQDIR%\media\cache folder.
SAP_DEVICES YES|NO
If set to YES, SAP feedback about any Columbus OM printer status is delivered
to SAP. SAP_DEVICES can also be inserted in the config.tab file for any
Columbus OM printer, however the entry there will override any entry in the
default.tab file.
555
556
CHAPTER 20
SAP_GWSERV string
The gateway service, matching an entry in the services file defining the port
used for gateway communication.
SAP_LANG string
The password associated with the RFC user_id, encrypted using the
sappasswd command.
SAP_RFC_USER user_id
If set to YES, the uqsap_can command is extended so that jobs are removed
from the host to which it is being transferred.
INSTANCE specifies that all of the entries are for multiple instances on one
SAP host.
target required by SAP, there must be an entry, as described below. All entries
in the file are treated as pertaining to a SAP instance.
CHAPTER 20
The host name, SAP instance name or IP address of the SAP host.
"user_id, password, string, string, string, host, YES|NO, client"
Parameter
Value
user_id
password
string
string
string
host
YES|NO
client
To create an archive of the successful callbacks files, set this parameter to Yes.
The default value is No.
The archive files are stored in the servers folder. They are named after the
date. For example, the archive file that contains the callbacks that were sent on
January 31 is called Cache31.archive.
The archive files remain for one month. For example, the archive file for
January 1 will be overwritten by the archive file for February 1.
557
558
CHAPTER 20
LOGGING VERBOSE|NO
The password associated with the RFC user_id, encrypted using the
sappasswd command.
SAP_TRACE YES|NO
Optional parameter, the default is NO. If set to YES a dev_rfc file is written
during RFC dialogue, which might aid in the investigation of RFC problems.
Configuration parameters for multiple upsapcache servers
If you have multiple uqsapcache servers, you can override the values that are set
in the system defaults file (default.tab). If you do not set these parameters for an
individual server, Columbus OM uses the values that are in default.tab for it.
SAP_CLIENT number
The client number of the default SAP system for SAP cached feedback.
SAP_GWHOST host
The hostname or IP address of the SAP gateway host. See also saphosts.tab
file: SAP hosts on page 556.
SAP_GWSERV string
The gateway service, matching an entry in the services file defining the port
used for gateway communication.
SAP_HOST hostname
The name of the default SAP host to log into for cached RFC feedback.
SAP_LANG string
Set to R/3.
SAP_RFC_USER user_id
The name of the default SAP Real Output Management System accessed for
SAP cached feedback.
SAP_SYSNR number
The default system number of the SAP system accessed for SAP cached
feedback.
CHAPTER 20
Report levels
The current required report level for each LOMS has to be honoured. The concept
of report level is that SAP may request that only more important information be
sent regarding a job. In particular, you can tell upsapcache that only final
messages (for example Completion or Failure) should be sent. The SAP defined
report levels are:
Status code
Meaning
01
Completion
02
03
04
Status change
05
Informational
As each queue entry status is changed, it will have an appropriate report level
attached to it.
See
Description
uqsap_can
uqsap_jq
uqsap_poll
uqsap_poll
uqsap_sub
Utility commands
uqsap_can: job
cancellation
Command
See
Description
sappasswd
sapcachini
page 569 Starts uqsapcache, and informs the ROMS server for
which it is responsible.
uqsap_can removes jobs that are in a state of transfer. If the REQ_HOP parameter in
%UNIQDIR%\config\default.tab is set to YES, uqsap_can also tries to remove
559
560
CHAPTER 20
Full syntax
uqsap_can entry_id ... [-all] [-qn instance] [-REQ]
The name of the Columbus OM instance that the entries are in. Include this if
there is more than one Columbus OM instance on the computer.
-all
Cancel the specified entries, whether or not they were submitted by SAP R/3.
To cancel entries only if they were submitted by SAP R/3, omit this parameter.
-REQ
To
Do this
Output format
The output comprises multiple lines giving the status of the cancelled print
requests. Each line has six space-separated fields.
version job class area result string
version
The result code; one of: 1 = Printed; 2 = Not printed; 3 = Partly printed;
4 = Possibly printed.
CHAPTER 20
string
uqsap_jq: job
query
Basic syntax
uqsap_jq &EL
Syntax
uqsap_jq entry_id ... [-all] [-qn instance]
The name of the Columbus OM instance that the entries are in. Include this if
there is more than one Columbus OM instance on the computer.
-all
Display the specified entries, whether or not they were submitted by SAP R/3;
the default is to display the entries only if they were submitted by SAP R/3.
Output format
The output comprises multiple lines giving the status of the selected print requests,
with these fields:
version job class area result position pages time string
version
561
562
CHAPTER 20
result
The result code; one of: 1 = Printed; 2 = Not printed; 3 = Partly printed;
4 = Possibly printed.
position
uqsap_poll:
device polling
Command format
Define the DPOLL command as either of:
uqsap_poll -poll &P -rmg "&EG"
uqsap_poll -poll &P -uid &EL
Full syntax
uqsap_poll -poll printer { -rmg "string" | -uid entry_id... }
[option...]
Poll the queue entries whose Columbus OM entry_ids are given in the spaceseparated list.
-all
Display the specified entries, whether or not they were submitted by SAP R/3;
the default is to display the entries only if they were submitted by SAP R/3.
-max n
CHAPTER 20
Output format
The output comprises one line giving the status of the specified device, followed by
multiple lines giving the status of the selected print requests. The device status line
has five space-separated fields.
version device class area string
version
The result code; one of: 1 = Printed; 2 = Not printed; 3 = Partly printed;
4 = Possibly printed.
563
564
CHAPTER 20
position
uqsap_poll:
device/queue
query
Basic syntax
uqsap_poll &P -all
Full syntax
uqsap_poll printer [option...]
Display the specified entries, whether or not they were submitted by SAP R/3.
The default is to display the entries only if they were submitted by SAP R/3.
-max number
The name of the Columbus OM instance. Include this if there is more than one
Columbus OM instance on the computer.
-system string
The calling SAP R/3 system (for compatibility with earlier versions of the
interface).
Output format
The output comprises one line giving the status of the specified device, followed by
multiple lines giving the status of the selected print requests. The device status line
has five space-separated fields.
version device class area string
version
CHAPTER 20
device
The result code; one of: 1 = Printed; 2 = Not printed; 3 = Partly printed;
4 = Possibly printed.
position
565
566
CHAPTER 20
entry_id
The document alias, with each space character prefixed by a backslash (\).
uqsap_sub: job
submission
Full syntax
uqsap_sub -df file -at printer -sid string -rmg "string"
[option...]
CHAPTER 20
-delay n
Set the entrys status to Held; it will be processed only when it is released.
-m text
Page count.
-pi
567
568
CHAPTER 20
establish a connection to the originating SAP R/3 instance in order to report job
status information.
CHAPTER 20
If the saphosts.tab file does not exist, Columbus OM assumes that there is
only one SAP R/3 instance on the site, and uses the SAP_ parameters in
%UNIQDIR%\config\default.tab to define the connection.
If saphosts.tab does exist, Columbus OM attempts to match the entries it
contains against the originating host held as one of the jobs queue attributes
to determine the appropriate SAP R/3 instance where the status information
is to be reported. If no host matches, the SAP_ parameters in default.tab are
used.
sapcachini: SAP
cache
initialization
Example
sapcachini sapcache_1 myroms myinstance myclient x x
569
570
CHAPTER 20
571
C H A P T E R 21
Chapter 21
Integrating other
applications
See
Columbus Accounting
Integration with
Columbus Accounting on page 572
other programs, using the user program User Program Interface on page 583
interface (API)
Integration with other Columbus applications is described elsewhere in this
manual, or in the other applications documentation:
Application
See
572
CHAPTER 21
the Windows Gateway, when you use the Send accounting data to queue
option
xprinter, when the Accounting_DB_Method parameter (in the system defaults
file, default.tab, or the xprinter configuration file) is set to QUEUE.
Configuration file
%UNIQDIR%\servers\server_name\config.tab
Configuration parameters
Action_Pre_Completion text
Action_On_Completion text
Action_On_Start text
Action_On_Failure text
Action_On_Postponement text
Action_On_Shutdown text
The number of the port on which the accounting database listens. The default
value is 8082.
Accounting_Host text
The maximum number of times that the server tries to process an entry. After
this number, the server sets the status of the entry to Failed.
The minimum number is 1. The maximum number is 100.
CAT_Dot_Count Yes|No
The medium associated with the queue entries that the server is to process. This
is usually accounting.
CHAPTER 21
Mode XMLRPC|QUEUE|FORWARD
If you are using Columbus Accounting, specify FORWARD. The default value
is XMLRPC.
Port number
The socket used for incoming accounting transactions. The default value is
8084.
Postpone_Time number
The period (number of seconds) for which the server postpones an entry if it
cannot be processed. After this period, the server tries to process the entry
again.
Remote_Scan Yes|No
The interval (number of seconds) at which the server scan the queue for entries
to process.
Send_Encrypted Yes|No
The name of the database: for MySQL, use UniQAccM; for Access, use
UniQAcc.
Accounting_DB_Method DIRECT|XMLSERVER|QUEUE
XMLSERVER
573
574
CHAPTER 21
QUEUE
Accounting_DB_Password text
The xnacc_get_acct command gets information from Xerox printers that support
network accounting, and puts it in the Columbus Accounting database.
To specify the Columbus Accounting database, set these parameters in the system
defaults file (default.tab): Accounting_XML_Server and
Accounting_XML_Port.
If the Columbus Accounting xmlserver is not listening on the specified server and
port, the xnacc_get_acct command puts the information temporarily in a file
called offacc.xml; next time you run the command, it tries again to send the
information that is in this file to Columbus Accounting.
Syntax
xnacc_get_acct device|ALL [-gap] [-p|-np] [-u|-nu]
[-t connect_timeout/read_timeout] [-v]
Parameters
device|ALL
The name of the device from which you want to get information. The name of
the device is specified in the xnacc.tab file (see xnacc.tab file: List of devices
on page 575).
To get information from all the devices that are listed in xnacc.tab file, specify
ALL.
-gap
Gets all records from the device, and then deletes them from the device.
CHAPTER 21
If you include this parameter, you must also include -u or -nu, to indicate
whether you want the records sent to Columbus Accounting.
-u|-nu
-u sends the information that is collected from the device to
Columbus Accounting.
If you include -u, you must also include -p or -np, to indicate whether you
want to include print records.
The default value is -nu (that is, the information is not sent to
Columbus Accounting).
-p|-np
-p includes scan, copy, fax and print records.
-np includes only scan, copy, and fax records (that is, not print records).
-t connect_timeout/read_timeout
The connect and read timeouts (each expressed as a number of seconds) used
while communicating with the devices, for example: -t 30/10.
The default value is specified by the xnacc_timeouts parameter in the system
defaults file, default.tab.
-v
Verbose output: displays the full network accounting record when the
command runs.
xnacc.tab file:
List of devices
The xnacc.tab file lists the devices from which you want to get information by
using the xnacc_get_acct command.
File name and location
%UNIQDIR/config/xnacc.tab
File format
address
port
SSL
type
Parameters
device
575
576
CHAPTER 21
SSL
xnacc_purge:
Delete Xerox
network
accounting
records
The xnacc_purge command deletes all network accounting records that have been
read by the xnacc_get_acct command from one or more devices. Records that
have not yet been read stay on the device.
Syntax
xnacc_purge device|ALL [-t connect_timeout/read_timeout]
Parameters
device|ALL
The name of the device from which you want to delete the records. The name
of the device is specified in the xnacc.tab file (see xnacc.tab file: List of
devices on page 575).
To delete the records from all the devices that are listed in xnacc.tab file,
specify ALL.
-t connect_timeout/read_timeout
The connect and read timeouts (each expressed as a number of seconds) used
while communicating with the devices, for example: -t 30/10.
The default value is specified by the xnacc_timeouts parameter in the system
defaults file, default.tab.
System
parameter
Default value for the connect and read timeouts (each expressed as a number of
seconds) used while communicating with the devices, for example: -t 30/10.
This parameter is used by the xnacc_get_acct and xnacc_purge commands.
CHAPTER 21
For SNA, if a Windows NT host is being used, Windows NT version 3.5 or 4.0,
and SNA Server Version 3.0 are required.
Value
TYPE
UNIQ
PROTOCOL
TCP
EATNAMe
TCPRPort
TCPPRTNM
TCPSYSNM
577
578
CHAPTER 21
Parameter
Value
UNIQID
UNIQPASS
UNIQNODE
user
where:
In Columbus OM, define a dedicated printer server to print the requests sent
from ColumbusZ. Set these parameters for the printer:
Parameter
Value
Ack_Command
VER
Any_Paper
Yes
CR Required
No
Leading FF
No
Trailing FF
No
Value
COMMSERV
server_id
TYPE
UNIQ
PROTOCOL
TCP
AUTOSTART
YES
HANDSHAKE
NO
CHAPTER 21
Parameter
Value
TCPPORT
EATNAME
Logon to the Columbus OM printer host using a username that is valid for both
the Columbus OM print facility and ColumbusZ.
installed.
Value
Complete_on_Transfer
YES
Remote_User
You can now print a document from Columbus OM using the remote printer.
579
580
CHAPTER 21
Configuration parameters
Action_On_Completion command
Action_On_Failure command
Action_On_Incomplete command
Action_on_New command
Action_On_Postponement command
Action_On_Processed command
Action_On_Shutdown command
Action_On_Start command
Action_Pre_Completion command
log.
CHAPTER 21
Formatter StreamServe|Generic|GenericNP
The name of the formatter associated with this server. If the formatter does not
accept data from on stdin, set to GenericNP.
LogChecker command|NO
By default, the DCS checks the formatterfs error log. If you want the DCS to
send the entries to another program for checking, specify the operating system
command here. If the command returns zero, the DCS assumes that the
formatter worked correctly. If the command returns any value other than zero,
the DCS assumes that the formatter operated incorrectly: it fails the master
entry and deletes any child entries.
If you do not want the DCS to check the error log, specify NO.
Medium medium
The medium which marks a queue entry as suitable for processing by this
server.
Outgoing YES|NO
YES if this server is responsible for scanning the queue for jobs to be transferred
to the formatter; NO otherwise. See also the StatusCheck parameter below.
Program command
The number of times that the server attempts to release each child document
after the document processing application has finished processing them. The
interval between each attempt is 1 second.
The minimum number is 1. The maximum number is 10.
The default number is 1.
Increasing the number of attempts might be useful on fast computers
(particularly those with multiple CPUs) if the Semaphore file locking
mechanism is unavailable.
Scan_Interval number
The interval in seconds between successive scans of the queue. The default is
10.
Server server
The name of the server, which must be the same as the name of the folder that
the configuration file is in.
Skel file
The full path of a folder containing skeleton StreamServe argument files. The
server selects the skeleton file %DESTINATION.arg (if it exists) or default.arg
(otherwise), appends the SSArg values, and passes the resulting set of
arguments to the Program.
581
582
CHAPTER 21
SSFailLevel number
A StreamServe log message whose severity (in the range 0.99) is number or
higher causes the job to be failed and any children to be deleted.
SSLog YES|NO
YES if this server is responsible for checking the StreamServe log file; NO
otherwise. See SSFailLevel and SSMsgLevel parameters.
SSMsgLevel number
A StreamServe log message whose severity (in the range 0.99) is number or
higher is written to the Columbus OM day log and, if applicable, the SAP R/3
event log.
StatusCheck YES|NO
YES if this server is responsible for collating the status values of the children of a
master job; NO otherwise. See also the Outgoing parameter.
Timeout number
Specifies the maximum time (measured in second) that the server waits for the
formatter to finish.
If the formatter does not finish the document in this time, the server stops the
formatter, and sets the status of the entry to Failed.
To wait forever, specify 0.
The default value is 0.
Verify_After number
Controls how often the server verifies the status of child entries: If the server
finds a master entry whose child statuses have not changed after number scans
of the queue, the server verifies the list of child statuses, by searching the queue
for children of the specified master. This is to make sure that the list is correct.
If there are a lot of master entries whose child status have not changed,
increasing this number might reduce the amount of CPU usage.
The default value is 10.
To never verify the child statuses, specify 0.
System parameter
This parameter can be set in the system defaults file (default.tab):
DCS_Medium text
The medium applied to a master entry is added to the pending queue for
processing by the dcs server.
The medium that is applied to the master entry must be different from the
medium that is applied to the child entries.
The default value is the medium with number 20 in the media.tab file, which
is usually the Generic type.
CHAPTER 21
the two header files qentry.h and upi.h which must be included in your
program,
examples of the API in use.
"qentry.h"
"upi.h"
int uniqae(
int
int
uniq_entry
);
action,
Q_VERSION,
*entry_struct
Parameters
action
UPI_K_MOD
or one of:
UPI_K_RESUB
UPI_K_RESUBMINE
583
584
CHAPTER 21
+ UPI_K_ARCHIVE
+ UPI_PUT_ARCH(n)
Q_VERSION
The uniq_entry data structure. See Queue entry data structure on page 592.
Description: adding an entry
To modify the attributes associated with a single entry_id, provided that the entry
has not yet been processed (that is, remains within the pending queue and is not
locked), first call uniqge() or uniqli() to retrieve the entry. Modify the attributes
as required, then call uniqae() to modify the queue entry.
Description: resubmitting an entry
The function returns UPI_OK if successful; otherwise an error reply. See Function
return values on page 595.
Examples
To fetch the attributes and update the priority of entry 1234 on the pending queue:
CHAPTER 21
#include
"upi.h"
#include
"qentry.h"
int
myReply;
long
myEntryId;
uniq_entry myEntry;
. . .
myEntryId = 1234;
myReply = uniqge(myEntryId, UPI_K_PENDING, Q_VERSION, &myEntry);
if (myReply != UPI_OK) { /* error handling */ . . . }
if (myEntry.priority < 9) myEntry.priority++;
myReply = uniqae(UPI_K_MOD, Q_VERSION, &myEntry);
if (myReply != UPI_OK) { /* error handling */ . . . }
. . .
"upi.h"
char *uniqer(
int
);
reply
Parameter
reply
585
586
CHAPTER 21
Example
"qentry.h"
"upi.h"
int uniqge(
long
int
int
uniq_entry
);
entry_id,
action,
Q_VERSION,
*entry_struct
Parameters
entry_id
or one of:
UPI_K_PENDING
UPI_K_COMPLETE
UPI_K_BOTH
UPI_K_ARCHIVE
UPI_K_ARCHIVE
+ UPI_PUT_ARCH(n)
+ UPI_K_PREV
CHAPTER 21
Q_VERSION
The uniq_entry data structure. See Queue entry data structure on page 592.
Description: initializing an entry
To fetch the attributes associated with a single entry_id, just call uniqge() with
one of the other action values; on return, entry_struct contains the entrys
attributes.
Description: retrieving sequential entries
To fetch the attributes associated with a sequence of entries, first retrieve a single
entry by specifying its entry_id as described above. Then, add UPI_KEY_NEXT or
UPI_K_PREV to the action value and call uniqge() repeatedly. On each return,
entry_struct contains the next (or previous) entrys attributes; when there are no
further entries, the function returns UPI_NOT_FOUND.
Return values
The function returns UPI_OK if successful; otherwise an error reply. See Function
return values on page 595.
Additionally, the function sets UPI_CLD_FLAG after retrieving a child entry, and
UPI_MST_FLAG after retrieving a master entry.
Example
"qentry.h"
"upi.h"
int uniqli(
int
int
int
int
char
long
long
uniq_entry
long
);
action,
Q_VERSION,
attr_count,
attr_nums[],
*attr_vals[],
skip_entries,
max_entries,
*entry_struct[],
*entry_count
587
588
CHAPTER 21
Parameters
action
UPI_K_COMPLETE
UPI_K_BOTH
UPI_K_ARCHIVE
UPI_K_ARCHIVE
+ UPI_PUT_ARCH(n)
Q_VERSION
Documents alias.
A wildcard string.
UPI_F_CSTAT
A name or number.
UPI_F_DEST
Documents destination.
A wildcard string.
UPI_F_DOC
Document name.
A wildcard string.
UPI_F_MED
Transmission medium.
A name or number.
UPI_F_ODEST
Documents original
destination.
A wildcard string.
UPI_F_OWN
A wildcard string.
UPI_F_PRI
A comma-separated list of
digits.
UPI_F_PROG
A wildcard string.
UPI_F_REM
A wildcard string.
UPI_F_UID
An entry_id, or a range
entry_id-entry_id.
attr_vals
string*
*string
*string*
CHAPTER 21
str*ng
skip_entries
The number of entries, all matching the selection criteria, to be skipped before
returning the subsequent entries in entry_struct[]. The value should
normally be zero, but could be used to skip previously-returned entries on a
second or subsequent call to uniqli() if the number of matching entries
exceeds max_entries.
The queue is volatile, and might change between calls to uniqli(); we advise
you to set max_entries large enough to hold all selected entries.
max_entries
specified selection criteria. Entries are selected only if they match all specified
criteria, except that, if the same attributes appears more than once in attr_nums[],
entries are selected if they match any of the corresponding attr_vals[] strings.
For example:
attr_nums[ ]
attr_vals[ ]
[0]=UPI_F_PRI
[0]="9"
The priority is 9.
[0]=UPI_F_PRI
[1]=UPI_F_OWN
[0]="9"
[1]="root"
[0]=UPI_F_PRI
[1]=UPI_F_OWN
[2]=UPI_F_OWN
[0]="9"
[1]="root"
[2]="uniq"
Return values
The function returns UPI_OK if successful; otherwise an error reply. See Function
return values on page 595.
Example
status is Failed.
589
590
CHAPTER 21
#include
#include
#define
#define
int
long
char
uniq_entry
"upi.h"
"qentry.h"
MAX ATTR 10
MAX_ENTS 1000L
myReply, myAttrCount = 0, myAttrNums[MAX_ATTR], i;
myEntryCount;
*myAttrVals[MAX_ATTR], myCriteria[MAX_ATTR][64];
myEntry[MAX_ENTS];
myEntry[i].owner_id,
myEntry[i].doc);
"upi.h"
int uniqre(
long
int
);
entry_id,
action
CHAPTER 21
Parameters
entry_id
UPI_K_FORCE
Description
uniqre() removes an entry from a queue. Entries can normally be removed only if
they have not yet been processed (that is, remain within the pending queue and are
not locked).
Return values
The function returns UPI_OK if successful; otherwise an error reply. See Function
return values on page 595.
Example
591
592
CHAPTER 21
Examples
code = uniqsi(UPI_K_DIR, "/home/COM/Print1");/* Unix directory */
code = uniqsi(UPI_K_DIR, "C:\\COM\\Print1"); /* Windows folder*/
code = uniqsi(UPI_K_NAME, "Print1");
/* Instance name */
Error codes
UPI_BAD_KEY ("Bad key in call")
Name not found in the systems.tab file, or the folder does not contain a
Columbus OM instance.
STATUS_CANCELLED
STATUS_DIALLING
STATUS_FAILED
STATUS_FAILED_FULL
STATUS_FAIL_LIMIT
STATUS_FAIL_LIMIT_FULL
STATUS_HELD_SERVER
STATUS_HELD_USER
STATUS_NEW
CHAPTER 21
STATUS_POSTPONED
STATUS_RELEASE
STATUS_SENDING
STATUS_SENT
Sent to destination.
STATUS_SENT_FULL
STATUS_SENT_LIMIT
STATUS_SENT_LIMIT_FULL
STATUS_STARTING
STATUS_TRANSFER
STATUS_WAITING
Waiting to be processed.
A date and time in the format returned by the standard C time() function,
defining the moment after which the next attempt to process the entry might
start. When adding an entry, you must set dt_next_attempt to either zero or a
value greater than the current time. When modifying an entry, any value
greater than zero is valid.
char medium[17]
The entry_id by which this entry was originally known (for example, on a
remote computer from where it was transferred to this queue).
char owner_id[33]
593
594
CHAPTER 21
char postscript
UPI_DC_PS
PostScript
UPI_DC_PCL
UPI_DC_PDF
UPI_DC_BEN
UPI_DC_HTML
short priority
The minimum number of days that the entry should be retained on the
completed queue after having been processed.
char serv[81]
CHAPTER 21
long chars
A date and time in the format returned by the standard C time() function,
defining the moment when the entry was placed in the queue.
long dt_first_attempt
A date and time in the format returned by the standard C time() function,
defining the moment when the first attempt to process the entry started.
long dt_latest_attempt
A date and time in the format returned by the standard C time() function,
defining the moment when the latest attempt to process the entry started.
char host_name[33]
archive queue.
Successful.
UPI_BAD_UID
UPI_BAD_VERSION
UPI_EXPIRED
UPI_ILLEGAL
UPI_NO_LICENCE
595
596
CHAPTER 21
Invalid address.
UPI_BAD_CHAIN
UPI_BAD_COPYFLAG
UPI_BAD_DOC
Invalid document.
UPI_BAD_DOCTYPE
UPI_BAD_HOSTNAME
UPI_BAD_MEDIUM
Invalid medium.
UPI_BAD_NEXT_TRY
UPI_BAD_OUID
UPI_BAD_OWNER
UPI_BAD_PAGELEN
UPI_BAD_PRIORITY
Invalid priority.
UPI_BAD_PSFLAG
UPI_BAD_REMFILE
UPI_BAD_REMTYPE
UPI_BAD_RETAIN
UPI_BAD_SIFILE
UPI_BAD_SITYPE
UPI_BAD_SRC_HOST
UPI_BAD_STATUS
Invalid status.
UPI_IN_USE
Entry is in use.
UPI_MIN_SIZE
UPI_NOT_FOUND
UPI_NOT_HELD
UPI_NOT_PENDING
UPI_NOT_YOURS
UPI_NO_DOC
No document specified.
UPI_AQ_READ
UPI_AQ_WRITE
UPI_BAD_NOTIFY
UPI_CQ_FULL
UPI_CQ_OPEN
UPI_CQ_READ
UPI_CQ_WRITE
UPI_DF_COPY
UPI_DF_NOT_Q
UPI_NO_ARCHIVE
CHAPTER 21
UPI_PQ_FULL
UPI_PQ_OPEN
UPI_PQ_READ
UPI_PQ_WRITE
UPI_RF_COPY
UPI_RF_NOT_Q
UPI_SF_COPY
UPI_SF_NOT_Q
597
598
CHAPTER 21
The name of the server. Do not change the value of this parameter.
Action_Frequency number
Description
%PARAM0
%PARAM1
%PARAM2
%PARAM3
%PARAM4
%MESSAGE
%DATE
The current system date. The default format is: dd Mon yy.
%TIME
Cache_SQL Yes|No
CHAPTER 21
Yes stores the command in a cache file. The cache file is in xmlservers
folder, and it is called sqlYYYY-MM-DD.cache (where YYYY-MM-DD is the
The character encoding that is used for both input and output XML
transactions.
The default value is the value of the XML_Codepage parameter in the system
defaults file, default.tab.
Document Yes|No
Yes traces transactions.
Environment variable=value[;variable=value]...
Sets one or more environment variables. Replace variable with the name of
the environment variable, and value with its value.
For example:
Environment
ODBCINST=/usr/local/etc
Get_Quota
The network card to which a server binds. This parameter is required only if
the computer has multiple network cards (which means that it also has multiple
host names).
To accept calls only on a specific network card, specify the host name or IP
address of that card.
To accept calls on any network card, specify 0.0.0.0
xmlserver also accepts calls on port 8084 from any host. To allow xmlserver
to accept only calls that were generated locally, set this parameter to
localhost.
Login_csuniq command
Set to the same value as the Login_csuniq parameter for uqserver: see
Login_csuniq command on page 404.
Port number
599
600
CHAPTER 21
Protocol SOAP|XMLRPC
601
C H A P T E R 22
Chapter 22
Parameters, variables
and attributes
602
CHAPTER 22
Common parameters
Common parameters
The following parameters are available for most commands, where indicated.
To
Include this
parameter
Abbreviation
-QUEUE_NAME instance
-qn instance
-su user
-NO_BANNER
-nb
-NO_WARNING
-nw
-SILENT
-si
-VERBOSE
-h
-v
CHAPTER 22
Substitution variables
Substitution variables
The following attributes of the queue entry currently being processed are available
to the server as substitution variables.
%%
Text defined by the user, as specified by the -ALIAS option. If the alias is a file,
value is the file name (not including the path).
%ALIAS_PATH
Text defined by the user, as specified by the -ALIAS option. If the alias is a file,
the value is the files full path.
%ATTACHMENTS
The number of attempts that have been made to process the entry.
%BROWSE_PATH
If the document has been copied into the queue, this variable contains the
path to the temporary file.
If the document is on the local computer and has not been copied into the
queue, this variable contains the path to it.
%CFG(text)
The value of the parameter called text from current servers configuration file,
config.tab. The name of the current server is given by the %SERVER variable.
See also Configuration files with multiple parameters with the same name
below.
%CHAIN
The number of another entry, which must be processed before this entry.
%CHARS
For a master entry: How many of its child entries have finished processing.
603
604
CHAPTER 22
Substitution variables
For a master entry: How many of its child entries have failed.
%CHILDREN_OKAY
For a master entry: How many of its child entries have completed.
%CHILDREN_WAIT
For a master entry: How many of its child entries are waiting to be processed.
%DATE(date_format)
The current date: see Date and time formats on page 610 and Date and time
arithmetic on page 611.
%DATE_CREATED(date_format)
The date and time when the entry was added to the pending queue: see Date
and time formats on page 610 and Date and time arithmetic on page 611.
%DESTINATION
PostScript
PostScript
PCL
Benson
HTML
Type n
%DOC_ICODE
PostScript
3, 5, 7, 931
user-specified encodings
%DOCUMENT
CHAPTER 22
Substitution variables
%EXIT
(Used only with the dispatcher server.) The exit status of the most recent
COMMAND action.
%FIRST_DATE(date_format)
The data and time of the first attempt to process this entry: see Date and time
formats on page 610 and Date and time arithmetic on page 611.
%FONT
For entries that have been transferred from another instance: the entrys
number in the original instance. The number has zeroes in front of it to make it
7 digits long (for example: 0004321).
%FULL_UID
The entrys number. The number has zeroes in front of it to make it 7 digits
long (for example: 0004321).
%HOPPER
The destination of the job: the name of the computer that the instance is on,
and the name of the instance (for example, myhost:Print1).
To get only the host name, use %HOST_NAME(HOST).
To get only the instance name, use %HOST_NAME(INST) or
%HOST_NAME(INSTANCE).
%INSTANCE
The name of the computer that the current instance is on, and the name of the
instance (for example, myhost:Print1).
To get only the host name, use %INSTANCE(HOST).
To get only the instance name, use %INSTANCE(INST) or
%INSTANCE(INSTANCE).
%LATEST_DATE(date_format)
The date and time of the most recent attempt to process this entry: see Date
and time formats on page 610 and Date and time arithmetic on page 611.
%LINES
605
606
CHAPTER 22
Substitution variables
%MEDIUM
The data and time of the next attempt to process this entry: see Date and time
formats on page 610 and Date and time arithmetic on page 611.
%NL
The number of pages in the source document (based on one of: %LINES /
%PAGE_LEN, a count of formfeeds, or analysis of the PCL/PostScript).
%PAGES_PRINT
CHAPTER 22
Substitution variables
See also Configuring the connection to the remote hosts on page 114.
%PARAM2
The host that a printer is on. This substitution variable is used only within a
printers configuration table.
%PRIORITY
More information about the entry: either the name of a file containing the
information, or the information itself.
%REMFILE(number)
The minimum number of days that the entry is to be retained in the completed
queue.
%SEC_GROUP
607
608
CHAPTER 22
Substitution variables
%SERVER_INFO
The name of the computer and instance on which the entry originated (for
example, myhost:Print1).
To get only the host name, use %SOURCE_HOST(HOST).
To get only the instance name, use %SOURCE_HOST(INST) or
%SOURCE_HOST(INSTANCE).
%STATUS
Contents
%TEMPFILE_A
Attachments to ...\document\xentry_id.att
an incoming
email message
%TEMPFILE
%TEMPFILE_D
%TEMPFILE_E
%TEMPFILE_F
Document
requirements
%TEMPFILE_G
%TEMPFILE_I
%TEMPFILE_N
%TEMPFILE_O
%TEMPFILE_P
...\image\xentry_id.rle
%TEMPFILE_Q
...\image\xentry_id.inf
%TEMPFILE_R
Remark file
...\remark\xentry_id.br
%TEMPFILE_S
%TEMPFILE_X
...\document\xentry_id.req
The current time: see Date and time formats on page 610 and Date and time
arithmetic on page 611.
CHAPTER 22
Substitution variables
%TO_PAGE
The number of the last page of the source document to be sent to the
destination.
%UID
Use
%UQVAR(name)
%UQVAR(name,)
%UQVAR(name,file)
Replace:
file with the full path and name of the variables file.
The value of the parameter called text in the current entrys requirements file
(xnnnnnnn.req). See also Configuration files with multiple parameters with
the same name below.
%XSTAT(text)
The value of the parameter called text in the current servers xstatus.tab
file. See also Configuration files with multiple parameters with the same name
below.
Configuration files with multiple parameters with the same
name
Some of the substitution variables, for example %CFG, provide the value of a
parameter from a configuration file. Some configuration files can contain two or
more parameters with the same name. To indicate which one you want, include its
number.
For example, if a printer has two or more paper types mounted, its configuration
file contains two or more PAPER parameters. To specify that you want the first
paper type, use %CFG(PAPER,1); to specify that you want the second paper type,
use %CFG(PAPER,2), and so on. If you omit the parameter number (for example,
%CFG(PAPER), Columbus OM returns the value of the first parameter.
609
610
CHAPTER 22
Substitution variables
Value
DD
DAY
The short day name: Mon, Tue, Wed, Thu, Fri, Sat or Sun.
HH
MI
MM
MON
SS
YEAR
YY
Value
AP
HX
JUL
The Julian day number within the year: 001, 002, ..., 365
(366).
MO
MONTH
Examples
For an event at 4:27 in the afternoon of 17th March 2012, some possible formats
are:
DD/MM/YY
17/03/12
MM/DD/YEAR
03/17/2012
DD MONTH YEAR
DAY DDMONYY
Fri 17Mar12
HH:MI
16:27
HX:MI AP
CHAPTER 22
YEARMMDD HHMMSS
Substitution variables
20120317 162749
+|- number h
+|- number d
+|- number m
+|- number y
Examples
If it is currently 4:27 in the afternoon of 17th March 2012, some possible formats
are:
%DATE+1d
18 Mar 12
%DATE+2m(MM/DD/YEAR)
05/17/2012
17 March 2015
%DATE-1d(DAY DDMONYY)
Thu 16Mar12
%TIME+5h
21:27:00
%TIME-300s(HX:MI AP)
04:22 PM
611
612
CHAPTER 22
User variables
User variables
uqvar: Maintain Columbus OM variables
The uqvar command:
The uqvar command can be used with both the standard Columbus OM variables
file (%UNIQDIR%\config\uqvar.tab), and local variables files for use with the
dispatcher server.
Syntax
uqvar [-g|-l|-s|-i] [-f [filename]] [-qn instance] [nb]
Parameters
To
-g variable
-l variable [variable]...
-l
-s variable value
-i variable value
delete a variable
-d variable [variable]...
-f [filename]
-f
-qn instance
-h
613
Index
A
a_printer file 365
abandoning documents that are being
printed 255
abanner.pcl file (example banner) 172
access
controlling 369
IOP web interface 501
operating system security 360
shell scripts 379
to administration functions 361
to Columbus OM instances 353
to documents 370
to printers 376
access files
superuser 384
validating users 384
access method E with callback
configuring Columbus OM 550
configuring SAP R/3 543
overview 542
Access_Script parameter
system 381
Accounting_DB parameter
default.tab 573
Accounting_DB_Method parameter
default.tab 573
statserver 439
Accounting_DB_Password parameter
default.tab 574
Accounting_DB_Type parameter
default.tab 574
Accounting_DB_User parameter
default.tab 574
Accounting_Host parameter
accserver 572
Accounting_Port parameter
accserver 572
Accounting_Refresh_Secs
statserver 439
Accounting_XML_Port parameter
default.tab 574
xprinter servers 202
Accounting_XML_Server parameter
default.tab 574
xprinter servers 202
accserver 572
ACK/NAK mechanism 118
Ack_Command parameter
default.tab 437
system default 118, 119
Ack_Medium parameter
fax server 467
haslerfx servers 486
pfax servers 490
action statements
dispatch server 291
Action_Frequency parameter
xmlserver 598
Action_On parameters 417
Action_On_AddFailure parameter
lpdserver 228
Action_On_Blocked parameter
printmaster servers 125
Action_On_Cancelled parameter
xprinter servers 202
Action_On_Completion parameter 417
accserver 572
asp servers 348
crserver 344
dcs servers 580
dispatch servers 320
faxbox servers 483
faxmaster servers 485
filein server 234
614
Index
lpdserver 229
mailer servers 458
mailin servers 459
pfax servers 490
repmaster 401
securejet server 535
uqsfcache 442
Action_on_Shutdown parameter
filein server 234
Action_on_SQLError parameter
xmlserver 598
Action_On_Start parameter 417
accserver 572
asp servers 348
crserver 344
dcs servers 580
dispatch servers 320
faxbox servers 483
faxmaster 480
faxmaster servers 485
filein server 234
haslerfx servers 486
mailer servers 458
pfax servers 490
securejet server 535
uqsfcache 442
Action_Pre_Completion parameter 417
accserver 572
dcs servers 580
dispatch servers 320
mailer servers 458
activity log files (servers) 103
Add New Entry
dialog box 213
adding
documents 211
entries 211
entries, authorization to 365
entries, from command line 216
fax documents 477
paper types 153
printers to printer classes 147
servers 98
Adding Entries dialog box 273, 274
Address parameter
default.tab 216, 238
adjacent zones (IOP)
capacity 504
colour 504
failure 504
size 504
time 504
administrators (access file)
usage for access control 383
usage for printer access 382
Index
uniqli() 587
uniqre() 590
uniqsi 591
APPLICATION (Columbus OM variable)
323
apq command (printing documents) 220
alternative hosts 400
defaults for print options 239
priority, default 239
validating destinations 238
validating parameters 238
APQ_Val_Attr parameter
default.tab 238
APQ_Val_Dest parameter
default.tab 238
Archive medium (crserver) 342
archive queue
authorization to list entries 366
browsing entries 366
creating 336
description 18
displaying entries, authorization to 366
fixing 270
journal files 418
listing entries, authorization to 366
listing other users entries 366
setting up 336
size 267
statistics 266, 337
archive.jnl file (list of deleted entries) 261,
418
Archiver parameter
asp servers 348
archiving entries
automatically 263
Columbus DW 341
Completion_Medium parameter 112
Area Description File editor 305
area description files 305
creating 305
Arg parameter
dcs servers 580
arq command
configuring format 275
display format 275
arq_ao (access file) 366
arq_det (access file) 366
arq_o (access file) 366
arq_view (access file) 366
arqsum.tab file 339
format and usage 275
ASCII format documents 214
ASCII text files
fitting to paper 178
asp server 348
assured delivery (secure printing) 181
615
616
Index
B
BackChannel column 413
displaying 413
BackChannel parameter
default.tab 406
OCE printers 411
printer server 406, 408, 410
system default 437
Backup documents 259
Backup_Cache
uqsfcache 442
banner pages 172
for batches of documents 183
for print entries 220
formfeeds 173
in Columbus OM Explorer 214
setting with dispatch 302
xprinter 192
Banner parameter
pfax servers 491
printer server 172
Banner_FF parameter
printer server 173
Banner_File parameter
printer server 172
Banner_PSFile parameter
printer server 172
Banner_Reqd parameter
pfax servers 491
Banner_Width parameter
pfax servers 491
banner.pcl file (example banner) 172
Batch_Aliases parameter
printer server 183
BcCollector parameter
statserver 440
binary format documents 214
binding network cards 400
blacklist file 466
BlackList_Secs
uqsfcache 442
blacklisting fax numbers 466
Block_Size parameter
xprinter servers 203
BlockAct_Messages parameter
xprinter servers 203
blockact.tab file (blocked printer actions)
195
example 197
reloading 100
blocked documents 259
restarting 259
blocked printers (xprinter) 195
Index
C
cache files
SAP feedback for devices 555
SAP job feedback 555
uqsapcache, configuring 555
CACHE_ARCHIVING parameter
uqsapcache servers 557
Cache_SQL parameter
xmlserver 598
CACHELOCK_TO parameter
default.tab 555
caching callbacks from SAP R/3 552
callbacks from SAP R/3
caching 552
cancelled entries
and the autopurge feature 263
cancelling
current document 255
carriage return characters
printing 175
CAT_Dot_Count parameter
accserver 572
CC recipients, adding to email messages
447
Ceiling parameter
netmaster 116
printer server 165
%CFG substitution variable 603
%CHAIN substitution variable 603
chaining documents 215
with dispatch 302
changing properties of entries
from command line 216
changing zones (IOP)
using Columbus IOP interface 525
channel types
xprinter 186
Channel_Queue parameter
printer 190
xprinter servers 203
Channel_Type parameter
xprinter 189
xprinter servers 203
Char_Len parameter
haslerpr servers 489
character counts for bundles 320
characters in a document
setting with dispatch 302
CHARS (Columbus OM variable) 323
%CHARS substitution variable 603
Check_Delivery parameter
mailer servers 458
Check_Frequency parameter
crserver 344
Check_Page_Meter parameter
xprinter servers 203
Check_Status parameter
xprinter servers 203
checklist for installation 33
child entries
setting with dispatch 302
%CHILD_FLAG substitution variable 603
%CHILDREN substitution variable 603
%CHILDREN_DONE substitution
variable 603
%CHILDREN_FAIL substitution variable
604
%CHILDREN_OKAY substitution
variable 604
%CHILDREN_WAIT substitution
variable 604
Class parameter
lpdserver 229
classes (printer) 157
Client_Mode parameter
default.tab 400
clusters
Columbus Windows Gateway 64
Co_Intervention_String parameter
printer server 177
Codepage parameter
xmlserver 599
Codes_Accepted parameter
printer server 166, 167
Codes_Barred parameter
printer server 166, 167
Codes_Filtered parameter
printer server 167
colour printers
access to 331
in alternative zones 504
colour_modes.tab file 532
COLOURMODE (Columbus OM
variable) 323
Columbus Accounting
integration with 572
617
618
Index
sending information to 67
Xerox devices 574
Xerox printers 574
Columbus DW
integration with 341
using with dispatch server 344
Columbus IOP
access from IOP Messenger 72
interface, opening 501
printer, using 525
web interface 75
Columbus OM
introduction 15
overview 16
Columbus OM Explorer 242
adding entries 212
changing entries 255
deleting entries 261
displaying items 243
installing 56
Preferences dialog box 242
Printer Warnings folder 414
printing documents 212
uninstalling 56
upgrading 56
Columbus OM Novell Gateway
configuring 87
deleting 93
installing 86
starting and stopping 92
upgrading 93
Columbus OM PC Printer Channel
configuration files 85
configuring 83
installing 83
starting 84
Columbus OM ports 63
creating 65
creating multiple 68
deleting 69
Columbus OM variables
maintaining from command line 612
Columbus Options (Printer Properties
dialog box) 526
Columbus Windows Gateway 497
cluster installation 64
Columbus Accounting 67
creating ports 68
creating ports, multiple 68
deleting ports 69
encrypting documents 67
installing 63
IOP deployments, use with 500
logfile 68
troubleshooting 68
ColumbusZ
Index
extending 267
failed entries, deleting 263
fixing 270
indexing 272
journal files 418
purging entries 262, 263
size, increasing 267
statistics 266, 337
Completed status 244
completed.jnl file (list of deleted entries)
261, 418
Completion_Medium parameter
archiving documents with 112
default.tab 111, 313, 317
Completion_Messages parameter
xprinter servers 204
Compress_Time parameter
printmaster servers 125, 268
compressing 268
documents for network transfer 115,
116
queues 268
queues, automatically 125
queues, from command line 268
compressing queues
automatically 268
CONDITION (dispatch server statement)
284
combining 286
macros 288
syntax 284
condition statements in dispatch rules 284
confidential documents 370
config.tab file
printmaster 125
server configuration 99
configuration
overview 18
printers 164
servers 99
confirmation copies (faxes) 468
Connect_Delay parameter
printer server 142
Connect_Interval parameter
xprinter servers 204
Connect_Retries parameter
xprinter servers 204
Connect_Text parameter
printer server 142
%CONTENTS (dispatch server variable)
287
contents of documents
testing (Columbus OM print) 165
testing with dispatch server 287
control characters
in documents 177
619
620
Index
D
D&CE T4 format
converting Hasler T4 format files to
471
data transformations
example 309
date and time formats in substitution
variables 610
%DATE substitution variable 604
%DATE_CREATED substitution variable
604
day log files (servers) 103, 419
DAYLOG (dispatch server action) 296
dcs server
medium for master entry 582
Outgoing parameter 100
refreshing configuration 99
StatusCheck parameter 100
DCS_Medium parameter
default.tab 582
dcsserver 580
SAP R/3, integration with 550
DEBUG parameter
dcs servers 580
def_linedef file 136
def_paper file 160
default medium 238
Default_File_Type parameter
faxbox servers 483
haslerfx servers 487
pfax servers 491
default.tab file
editing 110
example 110
DEFER (dispatch server action) 297
deferring documents 215
deferring entries
dispatch 302
DEFINE (dispatch server statement) 288
deleting
printers, command line 146
deleting entries
Columbus OM Explorer 261
from command line 260, 268
from completed queue 263
immediately after processing 215
Delivered status
processing entries with dispatch 321
delivery failures
xprinter 195
delivery modes (xprinter) 189
overlapping 190
raw 191
secure 189
standard 189
delivery rate
for individual hosts 116
over network 115
Delivery_Mode parameter
printer 190
xprinter 189
xprinter servers 204
Delivery_Rate parameter
netmaster 115, 116
printer server 144
deployment.tab file
for IOP OnCall (pull) printing 512
for SecureJet devices 536
Destination parameter
filein server 235
mailin servers 459
destination security level file (secdest.tab)
371
%DESTINATION substitution variable
604
Destination_Security parameter
(default.tab) 370
destinations
for fax entries (afp command) 477
setting with dispatch 302
unknown (in distributed printing) 120
Device parameter
faxbox servers 483
haslerfx servers 487
pfax servers 491
printer 190
xprinter 189
device pool file (devpool.tab)
creating 327
filein server 235
using 326
device selection criteria file
(select_criteria.tab) 328
device type, setting 147
Device_Callback parameter
statserver 440
Devpool parameter
filein server 235
devpool.tab file (device pool) 327
Dial_Command parameter
printer server 142
Dial_Prefix parameter
fax servers 466
faxbox servers 484
haslerfx servers 487
pfax servers 491
directories (UNIX)
commands 29
Directory parameter
asp servers 348
Directory_Read_Order parameter
Index
621
622
Index
Dry_Run parameter
repmaster 401
duplex (double-sided printing) 177
E
editing dispatch rules 281
email messages 445
attachments 447, 448
CC recipients 447
configuration 446
processing 445, 451
receiving 451
senders address 448, 449
sending 446
standard text 449
subject line 447
embedded commands in faxes 472
Empty_Wait parameter
filein server 235
Emtex VIP-connected printers 187
xprinter configuration 199
enabling
devices, Columbus OM Explorer 212
devices, command line 147
servers 98
encrypting documents 374
Columbus Windows Gateway 67
for network transfer 375
on the queue 217
SAP integration 567
ENFORCE (dispatch server action) 298
enforcements (IOP) 517
enterprise map
example 502
enterprise numbers for SNMP traps 436
entries
adding 211
adding from command line 216
adding using lp 224
changing from command line 216
deleting 259
deleting from command line 268
displaying 242
displaying in Columbus OM Explorer
242
managing 241
entry numbers
controlling 273
range 273
unique across instances 273
Environment parameter
xmlserver 599
environment variables
setting for xmlserver 599
UNIX 45, 46
EOB_File parameter
filein server 235
error log files
servers 103
Error_Banner (printer parameter) 192
Error_Continue parameter
evserver 438
Error_Dump parameter
filein server 236
Error_Messages parameter
xprinter servers 204
error.log files (servers) 103
escape codes
mapping 529, 531
Escape_Char parameter
crserver 345
event classes 429
event codes 430
event logging 421
event classes 429
event codes 430
printer events 438
user-defined events, adding 427
user-defined events, generating 429
eventlog.tab file (event logging
configuration) 421
evserver (event logging)
Action_On_Shutdown 438
configuration 438
Error_Continue 438
Flush_Filter 438
Flush_Logfile 438
Max_Reads 439
Medium 439
Server 439
Shutdown_Wait 439
Wait_Time 439
evserver servers 421
%EXIT substitution variable 605
extending queues 267
automatically 267
F
FAIL (dispatch server action) 299
Fail_on_Missing_Atts parameter
mailer server 458
failed documents 182
auto-purge feature 263
dispatch requests 320
distributed printing 114
faxes 466
print requests 182
Failed status 244
Failed? status 244
failover hosts (distributed printing) 121
Index
Failure_Text parameter
asp servers 348
fax documents
adding from command line 477
changing from command line 477
command line 477
converting graphic formats 471
destinations (afq command) 477
embedded commands 472
formats 476
from Columbus OM print 469
least-cost faxing 467
sending 476
sending using Columbus OM Explorer
476
fax environment 463
configuring 463, 466
confirmation copies 468
modems, supported 464
overview 20
redirecting documents from Columbus
OM print 469
fax modems
list of in an instance 212
supported 464
fax numbers for fax entries 477
fax print servers
Attributes 480
fax servers
Ack_Medium 467
Attempts_Limit 466
Dial_Prefix 466
Lost_Exchange 466
Max_Resets 466
Medium_For_RX 480
Medium_for_RX 481
Poll_Doc 468
Poll_Type 468
Poll_Wait_Ack 468
Reset_Interval 466
faxback feature 468
faxbox server 483
Faxbox30 parameter
faxbox servers 484
faxes
PCL format documents 239
receiving 464
sending 463
substitution variables 474
faxmaster server 464, 485
faxmaster servers
Action_on_Start 480
configuration file 485
configuration parameters 485
Incoming_Allowed 480
faxprint server 463, 464
faxprint servers
Medium 480
FB_Action_On_Complete
default.tab 442
FB_Action_On_Complete parameter
default.tab 437
FB_Action_On_Failure
default.tab 442
FB_Action_On_Failure parameter
default.tab 437
Feedback_Actions
uqsfcache 442
Feedback_Fail parameter
crserver 345
Feedback_Okay parameter
crserver 345
Feedback_Proc parameter
crserver 345
Fetch_Days parameter
repmaster 402
Fetch_Immediate parameter
repmaster 402
Fetch_Startup parameter
repmaster 402
Fetch_Time parameter (repmaster) 401
Fi_Intervention_String parameter
printer server 177
file locking (mutexes and semaphores) 379
File_Compress parameter
netmaster 115, 116
File_UnCompress parameter
netmaster 115, 116
filein server 234
Action_On parameters 234
Attempts_Limits 234
Auto_Select 235, 237
configuration file 234
configuration parameters 234
Destination 235
Devpool 235
Directory_Read_Order 235
Empty_Wait 235
EOB_File 235
Error_Dump 236
Incoming_Wait 236
Medium 234
Owner 236
Postpone_Time 236
Prefix 236
Queue_EOB 236
refreshing configuration 99
Scan_Interval 236
Scan_Mode 236
Scan_Root 236
Security 236
623
624
Index
Security_Level 236
Select_Criteria 237
Server 234
Sort_Criteria 237
Filter Queue dialog box 242
finishing command line
default 239
finishing control codes for print entries
221
Finishing parameter
printers 175
%FIRST_DATE substitution variable 605
fix queue 270
Fix_Interval parameter
printmaster 125, 270
Floor parameter
netmaster 116
printer server 165
Flow_Control parameter
faxbox servers 484
Flush_Filter parameter
evserver 438
Flush_Logfile parameter
evserver 438
folders
installation 28
Font parameter
printers 176
%FONT substitution variable 605
fonts
control codes for print entries 221
default for printing 176, 239
specifying using intervention strings
177
Footer parameter
printer server 174
footers
adding to documents 174
force-fix queue 270
Format parameter
printer 180
printer server 175
formatter applications
integration with 580
Formatter parameter
dcs servers 581
formatting documents 174
formfeeds
at end of documents 176
at start of documents 175
between pages 175
Forms_Flash parameter
printer server 170
xprinter servers 204
Forms_Mode parameter
paper type definition file 160
G
g_printer_group file 366
GatewayConfig.cfg file 80
Get_Paper_Tabs parameter
netmaster 156
Get_Quota parameter (xmlserver) 514
Get_Remote_Tab parameter
netmaster 119, 120
getacc command 246
Ghostscript
temporary files location 253
GhostScript parameter
default.tab 253
global (Windows user groups) 380
go to page number 256
group_mod (access file) 365
groups (printer) 158
groupsec.tab file 45, 382
Guard_File parameter
crserver 345
guest login 379
H
Hard_Queue parameter
printer 190
xprinter servers 205
has2dce command (convert graphic file
format) 471
has2pcx command 470
has2pfax command 471
Hasler T4 format files
converting from PCX 471
converting to D&CE T4 format 471
haslerfx server 486
document security levels 370
haslerpr server 489
Hdensity parameter
Index
I
IBM serial ports
printers connected to 138
ICRNL parameter
line.def 136
IDOL_Analysis parameter
625
626
Index
Columbus OM Explorer 56
Columbus OM Novell Gateway 86
Columbus OM PC Printer Channel 83
Columbus OM PCL driver 57
Columbus Windows Gateway 63
IOP Messenger 70
license file 24
without user interaction 35
instances 16
controlling access to 353
definition 16
integration with other applications 571
Intelligent Office Printing (IOP) 495
intervention strings in documents 177
IOP (Intelligent Office Printing) 495
desktop components, installing 78
interface 501
introduction 496
Oncall pull printing 498
printer driver 57
queue status 521
zone printing 496
zones 502
IOP Messenger
access to Columbus IOP 72
configuring 72, 76
customizing 77
installing 70, 78
languages 77
messages, receiving 75
sending messages 72
starting 75
stopping 76
using in xmsessage command 73
using with IOP 497
IOP Universal Driver 57
adding printers 58
configuring 59
installing 57, 78
using 57
using in IOP deployments 500
using with IOP 497
IOP_URL parameter (default.tab) 72
IOPSolutionConfig.cfg file 79
IPDS devices 187
xprinter configuration 199
IPP channel type (xprinter) 186, 200
ippinfo program for BackChannel 200
IPv6 addresses
uqserver usage 403
J
.jnl files 418
job ticket
functionality with dispatch 313
K
Keep_Alive parameter
xmlserver 599
Keep_Cancelled parameter
default.tab 263
Keep_Failed parameter
default.tab 263
Keepalive_Time parameter
printer server 143
kwikinfo command 409
L
landscape orientation
converting to portrait 178
lang files (language settings) 126
lang folder 126
lang_b access file 127, 367
langtab command (compiling language
files) 126, 127
access to 367
language files 126
access to 367
compiling 127
Language parameter
default.tab 127
languages
Columbus OM instance 126
IOP Messenger 77
LaserJetII parameter
haslerpr servers 489
%LATEST_DATE substitution variable
605
LDAP system
usernames and passwords in 355
LDAP_CertPath parameter (defaults.tab)
354
LDAP_Host parameter (defaults.tab) 354
LDAP_Port parameter (defaults.tab) 354
LDAP_UserDN parameter (defaults.tab)
354
LDAPlist.tab file 355
ldapserver 536
LDAPusers.tab file 355
Index
Leading_FF parameter
printers 175
least-cost faxing 467
Leave_CMD parameter
asp servers 348
Left_Margin parameter
haslerfx servers 487
pfax servers 491
Lexmark PrintCryption printers
using with xprinter 186
LFCR parameter
faxbox servers 484
license file 24
installing 24
updating 24
using 24
license keys 24, 25
using 25
license manager 24
host 53
MAC address 53
port number 53
starting 25
stopping 25
LicenseManagerHost parameter
default.tab 53
LicenseManagerPort parameter
default.tab 53
licensing 24
line counts for bundles 320
Line_Numbers parameter
faxbox servers 484
haslerfx servers 487
pfax servers 492
line.def file 136
LINES (Columbus OM variable) 323
%LINES substitution variable 605
Linger_Time parameter
printer server 143
liq command (list queue) 250
configuring format 275
display format 275
printer security groups 264
liq_ao (access file) 366
liq_ap (access file) 366
liq_det (access file) 366
liq_g (access file) 366
LIQ_Guest parameter
system 379
liq_o (access file) 366
LIQ_Pgroups parameter
default.tab 264
liq_view (access file) 366
liq_view_g (access file) 366
liqsum.tab file 275, 338, 339
627
628
Index
default.tab 273
lp command 224
client/server mode 226
concatenating files 226
configuring 226
document security levels 371
messages 226
syntax 224
validating destinations 226
lp requests
converting to Columbus OM print
entries 227
LP_Concatenate parameter
default.tab 226
LP_Message parameter
default.tab 226
LP_QLocal parameter
default.tab 226
LP_Val_Dest parameter
default.tab 226
lpd-enabled printers
getting status information from 410
lpdserver 227
Action_On_AddFailure 228
Action_On_Shutdown 229
binding network cards 400
Bundle_Files 229
Class 229
configuring 227
document security levels 370
Local_Host 229
Medium 229
multiple instances 227
Nak_Immed 229
ownership 28
Preprocess 230
Priority 230
refreshing configuration 99
RestrictedMode 228, 230
Scan_Instances 230
Security 230
sequential printing 112, 227
Server 230
Service 231
SuperLock 231
Temp_Path 228, 231
Timeout 231
using 227
Wait_Time 231
Zero_Is_ASCII 231
lpr/lpd protocols
replacing process with Columbus OM
227
used with xprinter 187
lprinfo command 410
lprout
M
m4regClient command 512
MAC address
license manager 53
MacAddress parameter
default.tab 53
macros (in dispatch server rules) 288
mailer server
Action_On parameters 458
Attempts_Limit 458
Check_Delivery 458
configuring 446
Convert_To 458
Domain 446, 458
Fail_on_Missing_Atts 458
Message_File 446, 458
Postpone_Time 459
Scan_Interval 459
Sender 446, 459
SMTP_Server 446, 459
mailin server 451
Action_On_Shutdown 459
Destination 459
Medium 459
Owner 459
POP3_Pass 451, 459
POP3_Server 451
POP3_User 451, 459
Process_Undeliverable 456, 460
Program 460
Scan_Interval 460
Security_Group 460
Security_Level 460
Server 460
SMTP_Domain 460
SMTP_Server 460
SMTP_User 460
Subject_Case_Sensitive 456, 460
Undeliverable_Dest 456, 460
Undeliverable_Medium 456, 461
Undeliverable_Program 461
Undeliverable_Subject 456, 461
managing
entries 241
servers 521
Map_Prio_n_TO parameter
Index
629
630
Index
N
NAK_Immed parameter
lpdserver 229
%NAME substitution variable 606
%NAME_PATH substitution variable 606
Name_Server parameter
netmaster 119, 120, 156
ncrdinfo command 409
Net_Encrypt parameter
default.tab 375
netmaster hosts file (nmhosts.tab) 116
netmaster server
Action_On_ Postponement 115
Action_On_Failover 606
Action_On_FailoverBack 606
alternative hosts 121
Attempts_Limit 115
Ceiling 116
Columbus OM fax 469
Complete_On_Transfer 118
configuration file 114
configuring 114
delivery rate 117
Delivery_Rate 115, 116
description 107
distributed printing, overview 113
failover mode 121
File_Compress 116
File_UnCompress 116
Floor 116
Get_Paper_Tabs 156
Get_Remote_Tab 119, 120
Host_Recheck parameter 122
Max_Host_Tries 122
Name_Server 120, 156
overview 20
paper types, distributing 156
Peers 120
Postpone_Time 115, 122
refreshing configuration 99
remote host connections 114
remote printers list, distributing 119
Remote_User 115
status information from remote hosts
118
Timeout 115
unknown printers, handling 120
Unknown_Dest 119, 120
Use_Routing 119, 120
network
communications 18, 388
connectivity 26
searching for printers 130
network cards
binding 400
getting status information from 409
New status 244
New_Page parameter
haslerpr servers 489
NEWDEST variable 330
newline characters
followed by carriage return characters
175
NEWTITLE variable 330
NEXT (dispatch server action) 300
Next_Attempt (document property) 115
%NEXT_DATE substitution variable 606
%NL substitution variable 606
NLPD channel type (xprinter) 186
nmbusy.tab file 123
nmhosts_mod (access file) 365, 367
nmhosts.tab file 116
nmhosts.tab file (netmaster hosts) 116
access to 365, 367
example 117
failover hosts 122
No_Login_Data parameter
default.tab 400
nofb.tab file 412
non-PostScript printers 166
Notify_Instance parameter
statserver 440
Notify_User parameter
Index
statserver 440
Novell Gateway See Columbus OM Novell
Gateway
NPS controllers
Xerox DocuPrint configuration 198
null characters
at end of documents 176
NUP (Columbus OM variable) 324
O
OCE printers
getting status information from 411
oceinfo command 411
OCRNL parameter
line.def 137
offacc.xml file 574
Offline_File parameter
accserver 572
Oh_Intervention_String parameter
printer server 177
oids.tab file 413
checking for private printer MIBs 408
OMMessenger_Translations.cfg file 77
ompcl_text.cfg (IOP Universal Driver
configuration file)
location 61
ompcl.cfg (IOP Universal Driver
configuration file) 60
OnCall printing 506
medium for released documents 534
OnCall_Rls_Medium parameter
default.tab 534
ONLCR parameter
line.def 137
ONLRET parameter
line.def 137
operating system user ids 384
operator.log files 419
operators
log files 419
operators (access file) 382, 383
operators (user group)
document security levels 372
opq command (manage print servers) 146
opq command (manage printer servers)
copying printer servers 147
device type, setting 147
disabling printer servers 147
enabling printer servers 147
EXTRACT 147
MOUNT 147
paper types, unmounting 147
printer classes, maintaining 147
QUERY 147
stopping printer servers 147
631
632
Index
overview 16
Output_Filter parameter
haslerfx servers 488
pfax servers 492
printer server 180
Output_Hopper parameter
printer server 176
ovclean command 169
overlapping delivery mode (xprinter) 190
overlays 168
creating 168
creating from command line 169
for fax entries 478
owner
setting with dispatch 303
Owner parameter
filein server 236
mailin servers 459
%OWNER substitution variable 606
P
p_ls command (list printers) 146
p_mk command 133
syntax 133
p_mk command (configuring printers) 130
searching for printers 131
p_mk.tab file 159
p_mk.tab file (printer configuration file)
134
p_mod command
example 145
p_mod command (change printer
properties) 145
p_printer file 367
p_rm command (delete printers) 146
Pad_A4 parameter
pfax servers 492
page counting 253
for bundles 320
PCL documents 239
using xreqs command 253
Page_Delay parameter
paper type definition file 160
%PAGE_LEN substitution variable 606
Page_Length parameter
paper type definition file 160
Page_Meter_Wait parameter
xprinter servers 206
Page_Mode parameter
xprinter servers 206
Page_Width parameter
printer server 174
pages
reprinting 259
selecting for printing 214
skipping 256
PAGES (Columbus OM variable) 324,
330
%PAGES substitution variable 606
%PAGES_PRINT substitution variable
606
PAM (Pluggable Authentication
Management) 353
paper
control codes for print entries 221
default 239
paper sizes, access to 331
%PAPER substitution variable 606
paper types 153
adding 153
assigning to printers 155
distributing across network 155
file format 160
mounting 147
setting with dispatch 303
unmounting 147, 155
paper_colours.tab file 532
Paper_Mandatory parameter
printer 180
paper_mod (access file) 367
paper_rem (access file) 367
paper_sizes.tab file 532
paper_tray.tab file 532
paper_types.tab file 532
parallel printers 136
parameters
setting 110
PARITY parameter
line.def 137
Parity parameter
haslerpr servers 489
partial printing
PCL documents 239
passwords
file (pwd.tab), using 384
redirection 358
shared between instances 358
testing 359
PATH environment variable 45
Path_Format parameter
asp servers 348
Pause_Nulls parameter
printer server 144
paused status 244, 259
restarting 259
pausing the current document 256
PCL format documents
converting 166
processing 239
PCL printers
page counts 254
Index
PCL viewer
opening 245
using 245
PCL_Analysis parameter
xprinter servers 206
PCL_Converter parameter
default.tab 239
PCL6_Analysis parameter
xprinter servers 206
PCLREAD (PCL document processing)
239
PCX format files
converting to Hasler T4 format 471
pcx2has command 470, 471
PDF_Analysis parameter
xprinter servers 206
Peers parameter
netmaster 120
pending queue
deleting entries automatically 262
deleting entries from command line
268
description 18
displaying entries 366
displaying entries from command line
250
extending 267
extending automatically 267
fixing 270
indexing 272
journal files 418
listing entries 366
purging entries 262
size 267
statistics 266, 337
pending.jnl file (list of deleted entries) 261,
418
permitted commands for ftserver 232
permitted.tab file 232
pfax server 490
document security levels 370
PHP, installing for a Columbus IOP
deployment 37
pitch
control codes for print entries 221
default 239
setting 177
specifying using intervention strings
177
Pitch parameter
printer server 177
%PITCH substitution variable 607
PJL channel type (xprinter) 186
PJL comments 529
PJL-enabled printers
getting status information from 412
633
634
Index
print servers
administering from command line 146
changing from command line 145
displaying information from command
line 150
Print_Banner
system parameter 172
Print_Command parameter
default.tab 239
Print_Index
default parameter 253
Print_Outgoing parameter
fax server 468
haslerfx servers 488
pfax servers 492
PrintCmd parameter
dispatch server 280
dispatch servers 321
printer access control 382
printer classes 157
adding servers 147
creating 157
in Columbus OM Explorer 213
maintaining 157
printer code mapping 529
printer configuration from command line
159
printer drivers
IOP universal driver 57
Printer Error Checking dialog box 416
printer features
finding from the command line 160
printer groups 376
creating 158
maintaining 158
printer MIBs 406, 407
Printer parameter
securejet server 535
printer parameters
Action_on parameters 417
Alias_Banner 183
Alias_Banner_File 183
Alias_Banner_PSFile 183
Alias_Limit 183
Any_Paper 155, 180
Attempts_Limit 182
BackChannel 406, 408, 410, 411
Banner 172
Banner_FF 173
Banner_File 172
Banner_PSFile 172
Batch_Aliases 183
Ceiling 165
Co_Intervention_String 177
Codes_Accepted 166
Codes_Barred 166
Index
Codes_Filtered 167
Command 175
Connect_Delay 142
Connect_Text 142
CR_Required 175
Delivery_Rate 144
Dial_Command 142
Disconnect_Delay 142
Driver 181
Fi_Intervention_String 177
Finishing 175
Floor 165
Font 176
Footer 174
Format 175, 180
Forms_Flash 170
Forms_Mode 170
Ft_Intervention_String 177
Header 174
Hold_Connect 143
Hopper 176
Hp_Intervention_String 177
Input_Filter 178
Keepalive_Time 143
Leading_FF 175
Linger_Time 143
Modem_Reset 142
Modem_Set 142
Oh_Intervention_String 177
Or_Intervention_String 177
Orientation 176
Output_Filter 180
Output_Hopper 176
Page_Width 174
Paper_Mandatory 180
Pause_Null 144
Pitch 177
Postpone_Time 182
PostScript 166
PostScript_Filter 167
Pr_Intervention_String 177
Prefix 175, 178
Presentation 177
Pt_Intervention_String 177
Query_Printer 406, 408, 410, 411
Scan_Interval 143
Set_Language parameter 166
Suffix 175
Timeout 142
Trailing_FF 176
Trailing_Nulls 176
UID_order 112
Use_Reserved_Ports 187
Printer Properties dialog box
Columbus Options 526
printer queues
displaying from command line 252
printer security groups 264
printer servers
configuring 164
configuring for status feedback 406
copying 135, 147, 151
deleting 151
device type, setting 147
disabling 151
displaying activity from command line
419
enabling 151
fax type 469
Input_Filter 167
IOP, configuring 526
log files 419
managing 151
paper types, mounting 147
refreshing configuration 99
setting up 129
setting with dispatch 302
status changes 416
printer service 26
printer status information
in Back Channel column 413
in Detailed Status window 413
in Printer Warnings folder 414
printer types 152
adding 152
Printer Warnings folder 213, 414
Printer_Banner (printer parameter) 192
printer_codes.tab file 529
printer_ops (access file) 367
printer_parameters
PostScript_End 173
Printer_Secfiles parameter
system 377
printer.d file 159
%PRINTERHOSTNAME substitution
variable 607
printers
access to 376, 377, 382
adding, using Columbus OM Explorer
134
alternative names 157
banner pages 172
checking for problems 212
classes 157
configuring 163
connecting to 136
connection type, command 143
connection, closing 208
controlling documents 165
controlling, authorization to 367
deleting 146
635
636
Index
disabling 212
displaying status from command line
149
displaying status information from 412
enabling 212
getting status information from 406
groups 158, 376
IBM serial ports 138
list of 146
list of in an instance 212
modem connected 141
mounting paper types 155
overlays 168
pausing 256
resuming 256
searching for 130, 131
security 376
selecting for a document 324
serial line definition 136
serial port connection 138
setting up 129
status 212
unknown (in distributed printing) 120
unmounting paper types 155
users 376
using multiple printers for one
document 256
using, authorization to 365
waiting for messages 208
web page, displaying 412
printing documents 525
advancing 256
at a specific time 215
command line 220
configuration for 107
controlling when 215
dispatch server command 280, 321
incoming faxes 480
multiple printers 256
overview 524
with dispatch server 300
Printing status 244
printmaster server 19, 107, 125
Action_On_Blocked 125
Auto_Complete_Compress 125, 268
Auto_Complete_Purge 125
Auto_Completed_Queue 262
Auto_Pending_Compress 125, 268
Auto_Pending_Purge 125
Auto_Pending_Queue 262
Compress_Time 125, 268
configuration parameters 125
configuring 111
description 107
Fix_Interval 125, 270
Medium 125
Port_Hold 125
Purge_Time 125, 262
refreshing configuration 99
Scan_Interval 111, 125
Server 125
print-only faxes 469
priority
authorization to use priority levels 365
default 239
setting with dispatch 303
Priority parameter
default.tab 239
lpdserver 230
%PRIORITY substitution variable 607
private printer MIB 407
PrntMode parameter
haslerpr servers 489
Process_Acks
dispatch parameter 321
Process_Delivered
dispatch parameter 321
Process_Level
uqsfcache 442
Process_Undeliverable parameter
mailin server 456
mailin servers 460
processing with multiple servers 111
Processing_Text parameter
asp servers 349
Profile_Exit parameter
xprinter servers 206
Program parameter
dcs servers 581
mailin servers 460
%PROGRAM substitution variable 607
Protocol parameter
xmlserver 600
PS_Analysis parameter
xprinter servers 206
PS_Count_NonDSC parameter
default.tab 253
system 253
ps_filter program 167
PSD3_Analysis parameter
xprinter servers 207
Pt_Intervention_String parameter
printer server 177
ptype_mod (access file) 367
ptype_rem (access file) 367
pull printing
with SecureJet devices 498, 528
Purge_Time parameter
printmaster 262
printmaster servers 125
purging entries
Index
automatically 263
purging queues
Columbus OM Explorer 261
pwd_a (access file) 367
pwd_f (access file) 368
pwd.tab file 356
access to 367
Q
qcompress command 268
qentry.h file 583, 592
Query_Printer parameter
OCE printers 411
printer server 406, 408, 410
queue buffering 242
queue entries
access to 369
adding from command line 216
changing from command line 216
Queue_EOB parameter
filein server 236
Queue_Index parameter
default.tab 272
default.tab file 272
queues 18
administration 18
buffering display of documents 242
changing entries 255
compressing automatically 268
compressing from command line 268
controlling document sizes 274
deleting entries 260, 262
deleting entries from command line
268
displaying 266
displaying contents of documents 245
displaying documents 242
displaying from command line 250,
252
displaying in IOP interface 521
displaying information about entries
244
displaying statistics 521
entry numbers 273
extending 267
fixing 270
increasing size 267
indexing 272
journal files 418
managing 265
purging entries 261
refreshing display 243
size 267
statistics 266, 337
queues, automatically 268
R
ranges
specifying in dispatch server 304, 305
RAW channel type (xprinter) 186
assured delivery 203
checking page meter 203
checking printer status 203
raw delivery mode (xprinter) 191
RAWLPD channel type (xprinter) 186
receiving faxes
configuration 480
redirecting fax numbers 466
refreshing display 243
refreshing server configuration 99
registering with Columbus IOP
zone 524
Registration parameter
xmlserver 600
RELEASE (dispatch server action) 301
Release parameter
dcs servers 581
releasing documents
with dispatch server 299
remark
setting with dispatch 303
text for documents 215
%REMARK substitution variable 607
REMARK variable 330
%REMFILE substitution variable 607
remote hosts 113
access from 399
configuring 116
connection to 114
logging into 115
polling for unknown destinations 120
remote instances
communications with 398
remote printers 114
access to 377
distributing list of 119
in Columbus OM Explorer 213
overview 19
routes to 126
setting up 113, 114
Remote_Scan parameter
accserver 573
Remote_Scan_Interval parameter
accserver 573
Remote_User parameter
netmaster 114, 115
repmaster 402
uqsfcache 443
remote.tab file 114, 368
637
638
Index
S
SAP R/3 539
feedback, cache files for devices 555
feedback, cache files for jobs 555
feedback, printer status 555
gateway service name 556
hosts file 556
integration with 539
job callback 556
language 556
mode 556
Index
Scan_Dir parameter
haslerpr servers 490
Scan_Instances parameter
lpdserver 230
Scan_Interval parameter
accserver 573
asp servers 349
crserver 346
dcs servers 581
dispatch servers 321
filein server 236
mailer servers 459
mailin servers 460
printer server 143
printmaster 111, 125
securejet server 535
statserver 440, 441
uqserver 384, 404
uqsfcache 443
Scan_Mode parameter
filein server 236
Scan_Root parameter
filein server 236
Scan2Print 499, 514
searching for printers on the network 130,
131
%SEC_GROUP substitution variable 607
secdest.tab file (destination security) 371
%SECLEV substitution variable 607
%SECLEV_NAME substitution variable
607
seclev.tab file (document security levels)
370
secure delivery mode (xprinter) 189
secure printing
assured delivery 181
with SecureJet devices 528
SecureJet devices 528
mapping to printer servers 538
mapping users 537
scanned instances 536
SecureJet server 534
SecureJet server
configuring 534
security
access files 364
displaying user permissions 364
documents 370
encrypting documents 374
levels 370
operating system 360
operating system ids 384
overview 21
security levels
authorization to use 365
file (seclev.tab) 370
639
640
Index
Index
641
642
Index
ownership 28
refreshing configuration 99
Scan_Interval 440, 441
Send_Traps 440
Server 440
Stagger_Time 441
Trap_Listener_Port 441
Trap_Manager 441
Trap_Manager_Port 441
UQ_Service 441
status
of documents in queues 244
servers, displaying 103
setting with dispatch 303
xprinter entries 195
status feedback 437
action on completion 437
action on failure 437
errors, recording 437
excluding hosts 412
from remote hosts 118
status information
displaying printer 412
from remote hosts 118
getting from printers 406
status logs
for entries using xprinter printers 195
status reporting
system default parameter 437
%STATUS substitution variable 608
Status_Feedback parameter
default.tab 437, 550, 551
system default 118, 119
Status_Interval parameter
asp servers 349
StatusCheck parameter
dcs server 100
dcs servers 582
STOP (dispatch server action) 304
Stop Server toolbar button (Columbus OM
Explorer) 102
STOPB parameter
line.def 137
stop.bat file (alternative stop commands)
49
StopGraf parameter
haslerpr servers 490
stopping
Columbus OM, alternative procedures
49
documents (Columbus OM Explorer)
255
License Manager 25
printer servers, command line 147
servers 102
servers, command line 106
StreamServe
integration with 580
StrtGraf parameter
haslerpr servers 490
su command (UNIX) 384
su_opt file 106
subject line of email messages, changing
447
Subject_Case_Sensitive parameter
mailin server 456
mailin servers 460
substitution variables 603
date and time formats 610, 611
embedding in faxes 474
Success_Text parameter
asp servers 349
Suffix parameter
printers 175
SuperLock parameter
lpdserver 231
superuser (UNIX) 384
%SUPP_REM substitution variable 608
supported devices (xprinter) 186
Sync_Check_Limit parameter
xprinter servers 207
Sync_Interval parameter
ldapserver 537
syq command
ALL_ACTIVE 103
ALL_INITIATE (servers) 101
ALL_STATUS 103
ALL_TERMINATE 102
ALL_TERMINATE_WAIT 102
CHECK_ARCHIVE 270
CHECK_COMPLETE 270
CHECK_PENDING 270
EXTEND_ARCHIVE 267
EXTEND_COMPLETE 267
EXTEND_PENDING 267
FIX_ARCHIVE 270
FIX_COMPLETE 270
FIX_PENDING 270
FORCE_EXTEND_ARCHIVE 267
FORCE_EXTEND_COMPLETE 267
FORCE_EXTEND_PENDING 267
FORCE_FIX_ARCHIVE 271
FORCE_FIX_COMPLETE 271
FORCE_FIX_PENDING 271
INITIATE (server) 101
JOURNAL options 418
STATUS 103
TERMINATE 102
TERMINATE_WAIT 102
syq -pc command (purging completed
queue) 263
syq_dd (access file) 368
Index
643
644
Index
Use_Print_Events 438
Use_Reserved_Ports 141
Use_xreqs 253
xnacc_timeouts 576
Zone_Server 534
system security
overview 21
systems.tab file 42, 389
format 42, 43
T
Target_System parameter
asp servers 349
TCP/IP communications 26
TCP/IP connection to printers 139
Team_Working parameter
system 369
teams 369
Temp_Path parameter
default.tab 253
dispatch server 322
dispatch servers 322
lpdserver 228, 231
%TEMPFILE_ substitution variables 608
temporary files
dispatch server 322
Ghostscript 253
terminating servers 102
terminating servers from command line
all 106
text browser
opening 245
using 245
text files
fitting to paper 178
Text_Analysis parameter
xprinter servers 207
Threshold_Secs
uqsfcache 443
Threshold_Size
uqsfcache 443
TIFF_Analysis parameter
xprinter servers 207
time formats in substitution variables 610
TIME parameter
line.def 137
%TIME substitution variable 608
Timeout parameter
dcs servers 582
faxbox servers 485
lpdserver 231
netmaster 115
netmaster server 115
printer server 142
repmaster 403
uqserver 404
xmlserver 600
TITLE (Columbus OM variable) 323, 330
%TO_PAGE substitution variable 609
Trailing_FF parameter
printers 176
xprinter servers 207
Trailing_Nulls parameter
printers 176
Transferred status 245
Translate_Chars parameter
crserver 346
Trap_Listener_Port parameter
statserver 441
Trap_Manager parameter
statserver 441
Trap_Manager_Port parameter
statserver 441
Trunc_White parameter
haslerpr servers 490
trusted hosts file 377
trusted hosts file (cshosts.tab) 399
2UP paper type 179
Tx status 245
U
UID number 273
%UID substitution variable 609
UID_order
printer parameter 112
system parameter 112
ULM_Method parameter
default.tab 379
Unconfirmed_Action parameter
printer 207
xprinter 195
Undeliverable_Dest parameter
mailin server 456, 460
Undeliverable_Medium parameter
mailin server 456, 461
Undeliverable_Program parameter
mailin servers 461
Undeliverable_Subject parameter
mailin server 456, 461
uninstalling
Columbus OM Explorer 56
Columbus OM Novell Gateway 93
uniq user 27, 28
access rights on Windows 2003 28
UNIQ_GROUP environment variable 45
uniqae() function 583
uniqcs service 26, 42, 56, 388, 400
adding to services file 42
UNIQDIR environment variable 45
uniqer() function 585
Index
645
646
Index
Use_Doc_Suffix parameter
xprinter servers 208
Use_Print_Events parameter
default.tab 438
Use_Reserved_Ports parameter
default.tab 141
printer 187
Use_Routing parameter
netmaster 119, 120
Use_su_id parameter
default.tab 384
Use_XReqs parameter
default.tab 253
Use_XReqs parameter (default.tab) 374
user (uniq) 27
user access 351
administration functions 361
control shell scripts 379
distributed printing environment 377
locking functions 380
Microsoft Windows 45
to documents 370
to files 360
to functions 362
to printers 376
to queue entries 369
user files 74
user groups
access to functions 362
deleting 364
printer 376
teams 369
uniqgrp 28
user variables
maintaining from command line 612
userevent.tab file
additional events 427
redefining events 426
validating 428
%USERID substitution variable 609
UserID_Case_Sensitive parameter
default.tab 384
usernames
case-insenstive on UNIX 384
testing 359
users
displaying permissions from command
line 364
ids shared between instances 358
IOP interface 515
validating against operating system
384
V
Validate_Peer parameter
xmlserver 600
Validate_Remote_Owner parameter
default.tab 384
Validate_UserID parameter
default.tab 384
validating user ids 384
variables
Columbus OM, maintaining 612
variables (Columbus OM) 323
PAGES 324
variables files
maintaining 612
vbf (Virtual Frames Buffer) 29
Vdensity parameter
haslerpr servers 490
Verify_After parameter
dcs servers 582
VIP channel type (xprinter) 187
VIP_Text_As parameter
xprinter servers 208
virtual environments 50
virtual frame buffers 30
installation 29
starting 30
virtual frames buffer
installing 29
starting 30
VMWare environments 50
W
Wait_For_Close parameter
xprinter servers 208
Wait_Time parameter
evserver 439
faxmaster servers 486
ftserver 232, 233
lpdserver 231
repmaster 403
web interface
accessing 501
web page for printers, displaying 412
wildcard characters
in dispatch rules 286
Windows 2003
uniq user rights 28
Windows Gateway
creating ports 65
installing 78
printer definitions 65
Windows Gateway See Columbus
Windows Gateway
WinLocalGroups parameter
default.tab 385
system 362
WLPD channel type (xprinter) 187
Index
X
XBanner_File (printer parameter) 193
xbanner_type (printer parameter) 192
xcaps command (finding printer features)
160
Xerox printers
Columbus Accounting 574
DocuCentre 187
DocuCentre 440ST 198
DocuColor 198
DocuPrint with DocuSP controller 198
DocuPrint with NPS controllers 198
DocuPrint with Windows controller
199
DocuSP 187
DocuTech 198
example configurations 198
network accounting 574
NPS 186
WorkCentre 187
XError_File (printer parameter) 192
XIN parameter
line.def 137
xinfo command (displaying information
about entries) 252
XLPD channel type (xprinter) 187
xmessage command (sending messages)
72
email system, specifying 74
example 74
syntax 73
XML_Codepage parameter
default.tab 600
xmlserver
environment variables, setting 599
Get_Quota 514
parameters 598
refreshing configuration 99
Set_Quota 514
xnacc_get_acct command 574
xnacc_purge command 576
xnacc_timeouts parameter
default.tab 576
xnacc.tab file (list of devices) 575
XNormal_Message (printer parameter)
193
xnormal_message.tab 194
XOUT parameter
line.def 137
XPP channel type (xprinter) 187
XPP printers 187
647
648
Index
Z
Zebra label printers 200
Zero_Is_ASCII parameter
lpdserver 231
Zip_Command parameter
securejet server 535
Zip_Delete parameter
securejet server 535
Zip_Filename parameter
securejet server 535
zone printing 496
components 497
creating zones 502
Zone_Server parameter
default.tab 534
zones (IOP) 502
alternative 504
changing using Columbus IOP
interface 525
changing using IOP Messenger 75
definition 524
devices, allocating 508
displaying 75
displaying list of 525
managing 502
properties 504
registering 524
skeleton hierarchy, creating 503
ZPL_CHANNEL channel type 200
zplinfo BackChannel command 200
www.macro4.com
We welcome feedback on our documentation. Please email us at:
[email protected]