Vous êtes sur la page 1sur 26

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

Columbus Output Management


How to use the WebClient

UQCW-4300-00

Columbus OM 4.3

Publication number

Trademark acknowledgements

UQCW-4300-00 (June 2004)

The following are trademarks of Macro 4: Columbus OM.

Documentation set

Other product and company names mentioned herein may


be the trademarks or registered trademarks of their
respective owners.

The documentation relating to this product includes:

Introduction

How to install Columbus OM

How to configure Columbus OM

How to use Columbus OM

How to use the command line interface

How to use the uq menu interface

How to use the WebClient

How to integrate with SAP R/3

Technical Reference

Making comments
We welcome suggestions from all users regarding our
software products and their accompanying documentation.
Please contact your local Macro 4 representative, email us
at tech.authors@macro4.com, or write to:
Technical Documentation
Macro 4
The Orangery, Turners Hill Road,
Crawley, West Sussex RH10 4SS
United Kingdom
www.macro4.com

License information
Copyright 2004 Macro 4. All rights reserved.
This publication, as well as the software described in it, is
furnished under license and may be used or copied only in
accordance with the terms of such license. The information
in this publication is furnished for informational use only, is
subject to change without notice, and should not be
construed as a commitment by Macro 4. Macro 4 assumes
no responsibility or liability for any errors or inaccuracies
which may appear in this publication.
Except as permitted by such license, no part of this
publication may be reproduced, stored in a retrieval
system, or transmitted, in any form or by any means,
electronic, mechanical, recording or otherwise, without
prior written permission from Macro 4.

Contents

How to use the WebClient UQCW-4300-00

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


Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 1 Introduction to the Columbus OM WebClient . . . . . . . . . 7


Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
WebClient features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2 Installing the WebClient . . . . . . . . . . . . . . . . . . . . . . . . 11


Preparing to install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Checking your environment . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Reviewing the services file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing the software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installing on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Post-installation setup . . . . . . . . . . . . . . . . . . . .
Configuring details of the Columbus OM instances
Configuring Apache . . . . . . . . . . . . . . . . . .
Configuring Sun ONE (iPlanet). . . . . . . . . . . .

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

15
15
17
19

Starting and stopping the software . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

Contents

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

About this manual

This manual describes the Columbus OM WebClient, an HTTP gateway which


enables users to monitor and control Columbus OM print jobs using a web browser
such as Microsoft Internet Explorer (the preferred choice) or Netscape Navigator.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

About this manual

Conventions

Conventions
The following typographic conventions are used:
boldface

Indicates a command or keyword that you should type, exactly as shown.


italics

Indicates a variable for which you should substitute an appropriate value.


monotype

Indicates literal input and output.


Ctrl+D

Indicates two or more keys pressed simultaneously.


[

Brackets surround an optional value.


|

Vertical bars separate alternative values from which you must make a selection.
...

Ellipsis indicates that the preceding element may be repeated.


Files and folders
Files and folders are referred by using Windows conventions, for example
install_dir\conf\columbus.conf. On a UNIX platform, this is equivalent to
install_dir/conf/columbus.conf; read the word folder as meaning

directory.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 1

Chapter 1

Introduction to the
Columbus OM WebClient

Columbus OM WebClient enables users to monitor and control their documents


by using a web browser.
The features are similar to those in the Documents tab of Columbus OM
Explorer. However, unlike Columbus OM Explorer, these capabilities are
available to anybody who has a web browser installed; no Columbus OM-specific
software is needed on the end-user computers.

Architecture on page 8 describes the major system components.

WebClient features on page 9 explains what you can accomplish using the
interface.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 1

Introduction to the Columbus OM WebClient

Architecture

Architecture
The WebClient uses a web server to communicate with Columbus OM instances to
find out their status and control their operation. It displays the information in a web
browser.
Columbus OM hosts

PCs
web
browser

print
instance

printers

Gateway
host
web
browser

web
browser

web
server

print
instance

print
instance

Columbus OM supports these web server applications:

the Apache HTTP server (version 1.3 or later), available from


www.apache.org, or

the Sun ONE (Open Net Environment) HTTP server (also known as iPlanet),
available from www.sun.com/software.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 1

Introduction to the Columbus OM WebClient

WebClient features

WebClient features
The WebClient features are similar to those on Columbus OM Explorer; the style
of information presentation will be familiar to users of that interface.

Device control
To display the status of printers, click Printers in the navigation pane.
You can issue commands to control the devices, such as: Enable, Disable, Abort,
Cancel, Pause, Resume, Back up, Advance, Goto page, Split and Transfer. The
commands may be issued to a single device, selected devices, or all devices. You
can also display the properties of a device, and show the jobs which are scheduled
for it.
Job control
To display the status of jobs, click All Entries in the navigation pane.
The display shows the Pending and Completed sections of the queue. You can
issue commands to control the jobs: Remove, Release, Hold and Copy. The
commands may be issued to a single job, selected jobs, or all jobs. You can also
display the contents of a job, and add a new job to the queue.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

10

CHAPTER 1

Introduction to the Columbus OM WebClient

WebClient features

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

11

CHAPTER 2

Chapter 2

Installing the WebClient

To install or upgrade Columbus OM WebClient on a UNIX or


Windows (NT/2000) host, follow these procedures:

Preparing to install on page 12

Installing the software on page 13

Post-installation setup on page 15

Starting and stopping the software on page 21

The gateway components need be installed on only one host, irrespective of the
number of Columbus OM instances in your network. No additional software is
needed on the hosts running the Columbus OM instances. The only software
needed on the end-user computers is a web browser: Columbus OM WebClient
works with Internet Explorer and Netscape Communicator at Version 4 or above.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

12

CHAPTER 2

Installing the WebClient

Preparing to install

Preparing to install
Before installing the software, there are some preparatory procedures which you
must follow:

Checking your environment below

Reviewing the services file below

Checking your environment


Check your environment before installing the software. The HTTP gateway can be
installed on a computer that:

is running UNIX or Windows (NT/2000)

has at least 1MB of disk space

supports the TCP/IP communications protocol; we use the phrase


your.gateway.host to refer to this computers network address

is running, or is able to run, a supported HTTP server


If a web server is not already available, you must install one before installing
Columbus OM WebClient.

The computer on which you install the web server and the HTTP gateway software
may be (but does not have to be) a Columbus OM host. However, it must be able
to communicate with the Columbus OM hosts which you want to monitor.

Reviewing the services file


Columbus OM products normally use the uniqcs network service for intercomponent communication, but can use another service if appropriate; the HTTP
gateway is able to interact with multiple Columbus OM instances using the same or
different communication services.
The service names must be defined in the /etc/services file (for UNIX) or the
\winnt\system32\drivers\etc\services file (on Windows): for more information,
see the section on Network connectivity in the How to install Columbus OM
manual. The values that you specify on the web server host must be consistent with
the values used by the Columbus OM instances with which you want to
communicate.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 2

Installing the WebClient

Installing the software

Installing the software


To install Columbus OM WebClient, see either:

Installing on Windows below

Installing on UNIX on page 14.

Installing on Windows
Perform these steps:
1

Log on with Administrator access rights.

Put the Columbus OM CD-ROM into your drive.

Locate and open the appropriate Columbus OM product folder.

Double-click Setup.exe to start the installation process.


The Welcome dialog box appears.

Click Next.

You now see one of two dialog boxes:

If the uniqcs network service name is already defined in the services file, a
message box appears showing its allocated port number.
If the uniqcs network service name is not already defined in the services
file, or if you select to change its current value, the Select uniqcs port
number screen appears. Type a port number, and click Next. (For more
information, see Reviewing the services file on page 12).

The installation asks if you want it to configure web server to work with
Columbus OM WebClient. You can configure Apache either:

now, as a part of the installation process. This is the quickest option.


or

after the installation has been completed, by manually editing its


configuration file. To do this, see Post-installation setup on page 15.

To configure Apache now, click Yes.


The Add Instances dialog box appears.

Specify these details:


Host
Type the hostname or IP address of a host running a Columbus OM print
instance.
Service
Either type a service name (for more information see Reviewing the services
file on page 12) or leave it blank to accept the default value uniqcs.
Instance
Type the name of a Columbus OM print instance installed on the host.

10 Click Next.

To add details for another instance, click Yes, and then repeat steps 9 to 10.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

13

14

CHAPTER 2

Installing the WebClient

Installing the software

11 When you have finished adding instance details, click No.

The Column Attributes dialog box appears.


12 Select the columns to be displayed when using Columbus OM to view an

instances Pending and Completed queues, by selecting them in the list. When
you have selected all the required columns, click Next.
13 Click Finish to complete the installation process.
14 Finally, complete the appropriate post-installation procedures. See Post-

installation setup on page 15.

Installing on UNIX
Perform these steps:
1

Log on as root.

Insert the CD-ROM into your drive. Locate and open the appropriate
Columbus OM product folder.

If you already have a supported HTTP web server installed on your computer,
you can skip this step. Otherwise, download and install one of the servers listed
in the previous chapter.

Copy the uniq directory and its files and sub-directories from the CD-ROM to
become a sub-directory of the:

install_dir/htdocs directory (for Apache), or

install_dir/docs directory (for Sun ONE).

where install_dir is the path to the directory where you have installed the
HTTP web server. The uniq directory contains HTML files, stylesheets,
graphics and scripts which the server uses to display information about
Columbus OM instances when requested by web browsers.
5

Copy from the CD-ROM the appropriate version for your operating system of:

apmod_uniq.so to the install_dir/libexec directory (for Apache), or

nsmod_uniq.so to the install_dir/bin/https/lib directory (for Sun ONE).

Next, see Post-installation setup on page 15.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 2

Installing the WebClient

Post-installation setup

Post-installation setup
After you have installed the HTTP gateway components, there are a number of
additional manual steps to be completed.
See

Configuring details of the Columbus OM instances below, and then either

Configuring Apache on page 17, or

Configuring Sun ONE (iPlanet) on page 19.

Configuring details of the Columbus OM instances


Details of the Columbus OM instances whose queue status is to be reported by the
WebClient are contained in a configuration file called columbus.conf. The file can
be placed anywhere; the usual location is in the web servers conf or config folder.
Note

In earlier releases of the WebClient, information on the Columbus OM


instances was configured within the Apache file
install_dir\conf\httpd.conf. If you are upgrading from a previous release,
remove the configuration statements from that file and put them in
columbus.conf.

To configure the file


1

Add one line for each Columbus OM instance which you want to monitor and
control:
ColumbusInstance host[:service] instance

host

The hostname or IP address of a host running a Columbus OM


print instance

service

(Optional.) The name of a service (see Reviewing the services


file on page 12) used for communication with instance on
host. The default is uniqcs

instance

The identification of a Columbus OM instance on that host

To attempt trusted logon to the Columbus OM instances (this feature must


have been properly configured at those instances), add the line:
ColumbusTrusted

To control the language used by the WebClient user interface (the default is
English) add:
for Apache

ColumbusLanguage de|en|fr|it
"install_dir\htdocs\uniq\nls\file"

for Sun ONE

ColumbusLanguage de|en|fr|it
"install_dir\docs\uniq\nls\file"

where install_dir is the path to the folder where you installed the HTTP
web server, and file is uniqnls.de, uniqnls.en and so on.
4

Optionally, add any number of lines defining the attributes of queue entries
which are to be included when displaying an instances pending and completed
queues. If desired, you can specify the attributes display width:

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

15

16

CHAPTER 2

Installing the WebClient

Post-installation setup

ColumbusColumn attribute [width]

The display includes all of the specified attributes, in the order in which
they are defined in this file. Possible values (and default widths) are as follows;
attribute names which include spaces should be enclosed in quotes "...":
Banner
1
Browse Path
30
Chain After
7
Child
6
Command
10
Copy
1
Current Server Remark
20
Date Created
20
Document Coding
10
Document Date
20
Document Name
15
Document Path Name
30
Document Type
1
Entry
7
File Alias
30
File Name
15
File Path
30
File Path Error
30
File Temp
30
Finishing
7
First Attempt
20
Font
10
Format
10
From Page
5
Hopper
7
Host Name
10
Latest Attempt
20
Lines
7
Master
7
Medium Name
10
Next Attempt
20
Orientation
9
Original UID
7
Output Hopper
7
Owner
10
Page Len
3
Pages
5
Paper
7
Path Alias
30
Path Temp
30
Pitch
8
Presentation
10
Previous Server Remark
20
Previous Status
4
Printer
10
Printer Type
10
Priority
1
Program
10

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 2

Remark
20
Remark Type
1
Retention (Days)
Server
10
Server Info
20
Server Type
1
Size
7
Source Host
10
Status
10
Success
10
To Page
5
Tries
3

Installing the WebClient

Post-installation setup

The default attributes are:


Entry
Owner
Status
Document Name
Printer
Size
Date Created

Sample entries
A typical set of columbusconf.txt entries to support connection to four
Columbus OM print instances is:
ColumbusInstance
ColumbusInstance
ColumbusInstance
ColumbusInstance

samson print1
samson print2
delilah print
testbox:2700 print

Configuring Apache
Follow this procedure only if you decided to configure Apache manually on
Windows, or if you are installing on a UNIX host. install_dir is the path to the
directory where you installed the server.
columbus.conf
Specify the location of columbus.conf in an operating system environment
variable:
columbus_init=install_dir\conf\columbus.conf
export columbus_init

Include these commands in the Apache control script bin/apachectl. Make sure
that the columbus_init environment variable is in lowercase.
httpd.conf
Edit the install_dir\conf\httpd.conf file as follows:

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

17

18

CHAPTER 2

Installing the WebClient

Post-installation setup

Add a line defining the Columbus OM load module.


Windows: LoadModule uniq_module modules\ApacheModuleUniQ.dll
UNIX:
Note

LoadModule uniq_module libexec/apmod_uniq.so

Columbus OM WebClient uses Apache DSOs (Dynamic Shared


Objects implemented by the mod_so module) to invoke the
Columbus OM load module at run-time, and will not work if your
configuration file contains a ClearModuleList directive after the
Columbus OM LoadModule directive.

Add a line defining the handler for files with an extension of .uqp:
AddHandler uniq-handler uqp

Add a section defining the handler for virtual document views (note that here
\uniq refers to the sub-folder of Apaches htdocs folder where you copied the
Columbus OM WebClient files):
<Location \uniq\doc>
SetHandler uniq-handler
</Location>

Note

Default home
page

Changes that you make to httpd.conf take effect the next time that the web
server is restarted.

To display the Columbus OM status information, use hypertext links of the form:
http://your.gateway.host/uniq/index.html

If this web server will be used only for serving Columbus OM status information,
you can make this the default page. To do this, edit the configuration file
(httpd.conf):
1

Include this line:


DocumentRoot install_dir\htdocs\uniq

Change the section defining the handler for virtual document views to remove
\uniq:
<Location \doc>
SetHandler uniq-handler
</Location>

You can then display the Columbus OM status information using hypertext links of
this form:
http://your.gateway.host/

That concludes the installation and configuration process.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 2

Installing the WebClient

Post-installation setup

Configuring Sun ONE (iPlanet)


Follow this procedure only if you are installing Sun ONE (iPlanet) on a UNIX host.
install_dir is the path to the directory where you installed the server.
columbus.conf
Specify the location of columbus.conf in an operating system environment
variable:
Columbus_init=
install_dir\https-your.gateway.host\config\columbus.conf

which you should define and initialize appropriately (for example, in the Sun ONE
start script).
magnus.conf
Edit the file install_dir\https-your.gateway.host\config\magnus.conf as follows:
Note
1

Changes that you make to magnus.conf take effect the next time that the
web server is restarted.

Add these two lines to the end of the file. On UNIX:


Init fn="load-modules" funcs="uniq_init,uniq_handler"
shlib="install_dir/bin/https/lib/nsmod_uniq.so"
Init fn="uniq_init"

or on Windows:
Init fn="load-modules" funcs="uniq_init,uniq_handler"
shlib="install_dir\bin\https\lib\NSAPIModuleUniq.dll"
Init fn="uniq_init"
obj.conf

Edit the file install_dir\https-your.gateway.host\config\obj.conf as follows:


1

Add this NameTrans line to the default object:


NameTrans fn="pfx2dir" from="\uniq" dir="$docroot\uniq"
name="uniq"

Make sure that the NameTrans pfx2dir line is before the


NameTrans document-root line.

Add a section defining the handler for uniq virtual document views to the end
of the file:
<Object name=uniq>
Service fn=uniq_handler
</Object>

(Make sure that there are no spaces in front of Service.)


Default home page
To display the Columbus OM status information, use hypertext links of the form:
http://your.gateway.host/uniq/index.html

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

19

20

CHAPTER 2

Installing the WebClient

Post-installation setup

If this web server will be used only for serving Columbus OM status information,
you can make this the default page. To do this, edit the configuration file obj.conf:
1

Change the new NameTrans pfx2dir line to:


NameTrans fn="pxf2dir" from="\" dir="$docroot" name="uniq"

Change the existing NameTrans document-root line to:


NameTrans fn="document-root" root="$docroot\uniq"

You can then display the Columbus OM status information using hypertext links of
the simpler form:
http://your.gateway.host/

That concludes the installation and configuration process.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

CHAPTER 2

Installing the WebClient

Starting and stopping the software

Starting and stopping the software


Follow the instructions in the web servers administration documentation.

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

21

22

CHAPTER 2

Installing the WebClient

Starting and stopping the software

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

23

Index

Apache web server


configuring for WebClient 17
using with WebClient 8
architecture
Columbus OM WebClient 8

services file
WebClient use of 12
Sun ONE web server
configuring for WebClient 19
using with WebClient 8

Columbus OM WebClient
architecture 8
features 9
installing 11
introduction 7
columbus.conf file (WebClient
configuration) 15, 17, 19

uniqcs service
WebClient use of 12

H
HTTP server 8, 12
httpd.conf file (web server configuration)
15

I
installation
Columbus OM WebClient 11
iPlanet web server See Sun ONE web
server

M
magnus.conf file (web server
configuration) 19

O
obj.conf file 19

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

W
WebClient See Columbus OM WebClient

24

Index

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

COLUMBUS OUTPUT MANAGEMENT HOW TO USE THE WEBCLIENT

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

www.macro4.com