Columbus Output Management: How To Integrate With SAP R/3

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 integrate with SAP R/3
UQC4-4800-00 Columbus OM 4.8

Publication number Trademark acknowledgements
UQC4-4800-00 (September 2007) Product and company names mentioned herein may be the
trademarks or registered trademarks of their respective
owners.
Documentation set
The documentation relating to this product includes:
License information
■
How to install Columbus OM
Copyright © 2007 Macro 4. All rights reserved.
■
How to configure Columbus OM
This publication, as well as the software described in it, is
■
How to use Columbus OM furnished under license and may be used or copied only in
■
How to use the command line interface accordance with the terms of such license. The information
in this publication is furnished for informational use only, is
■
How to use the uq menu interface subject to change without notice, and should not be
■
How to integrate with SAP R/3 construed as a commitment by Macro 4. Macro 4 assumes
no responsibility or liability for any errors or inaccuracies
■
Technical Reference
which may appear in this publication.
Except as permitted by such license, no part of this
Making comments publication may be reproduced, stored in a retrieval
We welcome suggestions from all users regarding our system, or transmitted, in any form or by any means,
software products and their accompanying documentation. electronic, mechanical, recording or otherwise, without
Please contact your local Macro 4 representative, email us prior written permission from Macro 4.
at tech.authors@macro4.com, or write to:
Technical Documentation
Macro 4
The Orangery, Turners Hill Road,
Crawley, West Sussex RH10 4SS
United Kingdom
www.macro4.com
3
Contents
How to integrate with SAP R/3 UQC4-4800-00
About this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 1 Introduction to the Columbus OM OMS and SAP R/3 . . 7

Columbus OM OMS overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Columbus OM OMS in R/3 environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
R/3 access methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2 Configuration for access method E with callback . . . . 13

Configuring R/3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configuring Columbus OM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Collecting printer status information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Chapter 3 Configuration for access method E with polling . . . . . 33

Configuring R/3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Chapter 4 Configuration for access method L . . . . . . . . . . . . . . . 45

Configuring R/3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Chapter 5 Configuration for access method U . . . . . . . . . . . . . . . 53

Configuring R/3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Chapter 6 Using R/3 user ids to log on to Columbus OM Explorer 59
Chapter 7 Using the Columbus OM command line interface . . . . 61

uqsap_can: job cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
uqsap_jq: job query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
uqsap_poll: device polling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
uqsap_poll: device/queue query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

4 CONTENTS
uqsap_sub: job submission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

sappasswd: encrypt R/3 passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
saphostconv: saphost.tab conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
sapcachini: SAP cache initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Chapter 8 Upgrading Columbus systems to use callback caching . 77
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

5
About this manual
How to integrate with SAP R/3 UQC4-4800-00
This manual describes how to integrate Macro 4’s Columbus OM OMS (Output
Management System) into the SAP R/3 environment so that it can manage the
printing and faxing of documents generated by R/3.
Macro 4 are partners with SAP through the SAP Complementary
Software Program. The Columbus OM OMS has been certified and
validated by SAP as a Complementary Software Program (CSP) that
can be integrated with R/3 via the official BC-XOM interface.
How to use this manual

This manual assumes that you are familiar with using the Columbus OM and R/3
configuration features.
To See
find out more about the Columbus OM ‘Introduction to the Columbus OM

OMS and how it integrates into the R/3 OMS and SAP R/3’ on page 7.
environment
use access method E with callback ‘Configuration for access method E with
callback’ on page 13
use access method E with polling ‘Configuration for access method E with
polling’ on page 33
use access method L ‘Configuration for access method L’ on
page 45
use access method U ‘Configuration for access method U’ on
page 53
use R/3 userids to log on to ‘Using R/3 user ids to log on to
Columbus OM Explorer Columbus OM Explorer’ on page 59
use the Columbus OM command line ‘Using the Columbus OM command
interface line interface’ on page 61.

6 About this manual ■
Conventions
Conventions
The following typographic conventions are used:
boldface Indicates a command or keyword that you should type, exactly
as shown.
italics Indicates a variable for which you should substitute an
appropriate value.
monotype Indicates literal input and output.
Ctrl+D Indicates two or more keys pressed simultaneously.
[ ] Brackets surround an optional value.
| Vertical bars separate alternative values from which you must
make a selection.
... Ellipsis indicates that the preceding element may be repeated.
Files, folders, environment variables and program names

References to files, folders, and environment variables use the Windows
conventions. For example: “the oids.tab file is in the %UNIQDIR%\config\ folder”
in Windows is equivalent to: “the oids.tab file is in the $UNIQDIR/config/
directory” in UNIX.
Where there are important differences, both the Windows and UNIX versions are
shown.

7
CHAPTER 1
Chapter 1 Introduction to the

Columbus OM OMS and
SAP R/3
This chapter provides an overview of how Columbus OM OMS can integrated

with a SAP R/3 system.

8 Introduction to the Columbus OM OMS and SAP R/3 ■
Columbus OM OMS overview
Columbus OM OMS overview

A Columbus OM OMS comprises one or more instances of Columbus OM which
are installed on hosts in a network. The hosts can be Windows (NT or later), UNIX,
or a mixture of both.
The instances provide access to the printers and fax modems in the network. The
printers and fax modems can be either connected to a host or directly connected to
the network.
When a document is submitted to any of the Columbus Central instances, it can be
processed by any of the devices in the network.
network
host printer
Columbus OM
host
printer
printers
Columbus OM

fax modems
printer

Introduction to the Columbus OM OMS and SAP R/3 ■
Columbus OM OMS in R/3 environment
9

Columbus OM can be integrated into the R/3 environment by using the command
line interface.
A Columbus OM instance is installed on the R/3 spool server host, to interface the
spool server to the OMS. R/3 jobs are passed to this Columbus OM instance via
the spool server, and are then routed via the OMS to be printed or faxed at their
designated destinations.
The OMS can handle jobs from:
■ a single R/3 instance (see ‘Single R/3 instance and Columbus OM OMS’
below, or
■ multiple R/3 instances (see ‘Multiple R/3 instances and Columbus OM OMS’
on page 10).
Single R/3 instance and Columbus OM OMS
network
host printer
Columbus OM
host
printer
printers
Columbus OM

host
R/3

fax modems
printer
R/3 spool
server
Columbus OM

Multiple R/3 instances and Columbus OM OMS
network
host printer
Columbus OM
printer host
printers
Columbus OM

host
R/3 R/3
fax modems
printer
R/3 spool
server
host
Columbus OM R/3 R/3
host
R/3
In this setup, an R/3 job from any of the R/3 instances is passed, via the R/3 spool
server, to the Columbus OM instance on the R/3 spool server host. The job is then
routed to its final destination by the Columbus OM OMS, for printing or faxing.
Furthermore, in either the single or multiple R/3 instance environment, both of the
following scenarios are also possible:
■ To reduce the loading on the Columbus OM instance on the R/3 spool server
host, multiple Columbus OM instances can be installed on the host, each
providing a separate interface to the OMS.
■
R/3 jobs can be routed by the OMS to one or more printers attached directly to
the spool server host.
These two scenarios are illustrated in the following diagram.

Introduction to the Columbus OM OMS and SAP R/3 ■
11
network
host printer
Columbus OM
printer host
printers
Columbus OM

host
R/3 R/3
fax modems
printer
R/3 spool
server host
R/3 R/3
Columbus OM
Columbus OM host
R/3
printers Columbus OM
In a Columbus OM and R/3 environment, the number of Columbus OM instances

installed on the spool server host, and the format of the Columbus OM OMS varies
according to the operational requirements of that environment. However, for the
purposes of this document it is assumed that:
1 The requisite number of Columbus OM instances have been installed on the
R/3 spool server host and the post-installation procedures have been
completed (as described in the How to install Columbus OM manual).
2 The Columbus OM instances that comprise the Columbus OM OMS have
been installed on their designated hosts and the post-installation procedures
have been completed (as described in the How to install Columbus OM manual).
3 The OMS has already been configured (as described in the How to configure
Columbus OM manual) and then tested when disconnected from the R/3
environment such that:
■
A document can be successfully printed at each of the printers in the OMS.
■ A document can be successfully faxed from each of the fax modems in the
OMS.
To integrate a Columbus OM OMS into the R/3 environment you have to
configure:

R/3 access methods
■
the Columbus OM instances that comprise the OMS and
■ the R/3 instances.
The method of configuration depends on which of the R/3 access methods you use.
For more information about the R/3 access methods, see below.
R/3 access methods

This section describes the R/3 access methods that can be used. Which access
method to use depends on which version of R/3 you are using.
Available in
Access method SAP R/3 version See
E with callback 4.0 and above ‘Configuration for access method E

with callback’ on page 13
E with polling 3.1i and above ‘Configuration for access method E
with polling’ on page 33
L 3.0 and above ‘Configuration for access method L’ on
page 45
U 1.1 and above ‘Configuration for access method U’ on
page 53

13
CHAPTER 2
Chapter 2 Configuration for access

method E with callback
This chapter describes how to configure both Columbus OM and R/3 to integrate a
Columbus OM OMS into the R/3 environment, when using access method E with
callback.
Availability
Access method E with callback is available in SAP R/3 versions V4.0 and above.
Features
Access method E with callback provides the following information at the R/3 user
interface:
■
print job status
■
fax job status
■
printer status.
Job status changes can also be returned at the request of a user at the R/3 user
interface.
Functionality
When using access method E with callback, changes in job status and device status
are handled in one of these ways:
■
If the Columbus OM callback caching feature is enabled, all job and printer
status changes are written to a file, and are then returned to R/3 at a predefined
interval. 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 R/3 instance.
■ If the Columbus OM callback caching feature is disabled, job status changes
are returned automatically by Columbus OM to R/3, as and when they occur
using R/3’s RFC mechanism (as shown below). The status information is
returned in real time (that is, as and when a status change occurs) using R/3’s
RFC mechanism.

14 Configuration for access method E with callback ■
Configuring R/3
However, a printer status change is reported only if, when its status changes,
there is a print job queued for it. So, for example, if a printer is taken offline but
there is no job queued for it, the change in status will not be returned to R/3.
network
host printer
Columbus OM
printer host
printers
RFC call Columbus OM
or
RFC callback

host RFC call
or
RFC callback
R/3 R/3
fax modems
printer
R/3 spool
server
host
Columbus OM R/3 R/3
host
R/3
To implement this access method you have to configure both R/3 and
Columbus OM.
Configuring R/3
Follow these procedures:
1 ‘Setting up the R/3 spool server host to interface with Columbus OM’ on
page 15.
2 ‘Creating a user account for RFC transactions’ on page 15.
3 ‘Creating an RFC destination in SAP’ on page 16.
4 ‘Creating the real OMS’ on page 17.
5 ‘Defining a logical OMS’ on page 19.
6 ‘Defining a printer’ on page 23.

Configuration for access method E with callback ■
Configuring R/3
15
Setting up the R/3 spool server host to interface with

Columbus OM
To set up the R/3 spool server host to interface with Columbus OM, you have to
modify the environment of the R/3 user who owns (starts and stops) the spool
server, to include the Columbus OM UNIQDIR environment variable.
To modify the spool server owner environment

1 Log on to R/3 using the username and password of the owner of the spool
server.
2 Set up the Columbus OM environment variable UNIQDIR as follows:
On Windows platforms:
■
Set UNIQDIR as a system variable as follows:
set UNIQDIR=path
where path is the path to the Columbus OM instance on the spool server
host that interfaces directly with the R/3 spool server.
On UNIX platforms using the C shell:
■ Add this line to the .cshrc file:
setenv UNIQDIR /path
On UNIX platforms, using the Bourne or Korn shells:
■
Add these lines to the .profile file:
UNIQDIR=path
export UNIQDIR
Next, see ‘Creating a user account for RFC transactions’ below.
Creating a user account for RFC transactions

You must create a user account for exclusive use by Columbus OM on each R/3
instance.
This user account enables Columbus OM to log on to the R/3 instance from which
it received a job and thus report job and printer status changes.
To create an R/3 user account for Columbus OM on an R/3 host

1 Log on to the R/3 host.
2 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.

Configuring R/3
Creating an RFC destination in SAP

In SAP, you must create an “RFC destination”. The RFC destination is used by
printers that you define in SAP to associate them with a specific instance of
Columbus OM.
To create an RFC destination

1 Navigate to Tools Administration Administration Network RFC
Destinations.
2 Click Create.
3 Type a name to identify the RFC destination.

Use a meaningful name. For example, include the host, the Columbus OM
instance and the type like this: MYHOST_PRINT1_RFC.
4 Set the Connection type to T.
5 Type a Description.
6 Type a Language code, for example EN for English.
7 Set the Client to the client Id of the SAP system.
8 On the Destination menu, select Save.
The next dialog box appears automatically.

Configuring R/3
17
9 Click Registration.
10 In the Program ID box, type the same value as the RFC destination in the
previous screen (step 3).
11 Set the remaining values as required.
12 On the Destination menu, select Save.
Creating the real OMS

The real OMS defines how the logical OMSs associated with it obtain job and
printer status information from Columbus OM.
To create the real OMS

1 Using the spad transaction, navigate to Advanced Administration (or Full
Administration).
2 Click the Output Management System tab, click Real Output
Management Systems, and then click the Change toolbar button.
The Create Real Output Management System dialog box appears.

Configuring R/3
3 Type a name for the real OMS.

Use a name that includes the host and the Columbus OM instance, for
example: MYHOSTPRINT1.
4 Type a description for the real OMS.
Use a meaningful description (for example, Columbus OM Print Instance 1 on
MYHOST). Make a note of this description, as you will need it again later.
5 Under Tasking, select Command line.

6 Under Job status, select Query, Deletable and Callback, and clear Polling.
7 Under Device status, select Queue query and Callback.
8 If caching is used, set these values under SAP configuration:
Initialization instance
The SAP instance from which the caching server gets information about the
ROMS, its LOMS and the devices.
Initialization command
The parameters that are required for sapcachini (see ‘sapcachini: SAP cache
initialization’ on page 76).
Reconfiguration request
How often the caching server checks with SAP if there are any configuration
changes. Typically, this value is set to 60 (seconds). If you leave it blank, the
server checks every 300 seconds.
9 Click the Save toolbar button.

Configuring R/3
19
Defining a logical OMS

A logical OMS defines how a particular group of R/3 output devices interface with
the printers in a Columbus OM OMS.
To define a LOMS
1 Using the spad transaction, navigate to Advanced Administration (or Full
Administration).
2 Click the Output Management System tab, click Logical Output
Management Systems, and then click the Change toolbar icon.
3 Click the Create toolbar button.
The Spool Admin.: Create Logical Output Management System dialog box
appears.
4 Type a name for the logical OMS.

5 Type a description for the logical OMS.
Use a meaningful description (for example, Columbus OM PRINT LOMS).
Make a note of this description as you will need it again later.
6 On the SAP configuration tab, select the ROMS that you created earlier (for
example, Columbus OM Print Instance 1 on MYHOST).
The ROMS are identified by their descriptions, not their names.
7 In the Tasking target box, type the name of the R/3 spool server host.
8 In the Target for callback box, type the name of the R/3 host to which the
RFC call will be made when submitting a job using this logical OMS.
9 Under Devices, select Callback.
10 Under Jobs, select Can be deleted and Status dialog boxes.
11 Click the Save toolbar button.
Next, see ‘Specifying the job control commands for a logical OMS’ on page 20.

Configuring R/3
Specifying the job control commands for a logical OMS

For each logical OMS that you create, you have to specify a set of job control
commands. These commands specify how a job will be submitted to the logical
OMS.
To specify a set of job control commands

1 Open the Spool Administration: Operating System Commands (Change)
dialog box for the logical OMS.
2 In the Command path box, type the path to the Columbus OM print instance
on the spool server host that interfaces directly with the R/3 spool server,
appended with \programs\commands\.
3 In the OMS commands section of the dialog box, fill in the Submit, Job
cancel and Job query boxes.
Each OMS command setting comprises a Columbus OM command followed by
a series of Columbus OM parameter – R/3 value pairs and optionally, a series of
Columbus OM parameter – Columbus OM value pairs.
The minimum command sets for printing and faxing a document are shown on
page 20, followed by the complete list of Columbus OM parameter – R/3 value
pairs and Columbus OM parameter – Columbus OM value pairs for each
Columbus OM command.
4 On the Operating systems menu, click Save.
Basic command set for printing a document
OMS command Setting
Submit uqsap_sub -df &F -at &P -rmg "&EG" -sc &m -si "&ES"
-sid &EI -qn qname -pi
Job cancel uqsap_can "&EL" -qn qname
Job query uqsap_jq "&EL" -qn qname

Configuring R/3
21
Basic command set for faxing a document
OMS command Setting
Submit uqsap_sub -df &F -fax "&t" -m fax -rmg "&EG" -sc &m
-si "&ES" -sid &EI -qn qname
Note In both of the above command sets, -qn qname can be omitted if there is
only one Columbus OM instance on the R/3 spool server host.
The Columbus OM parameter – R/3 value pairs and Columbus OM parameter –
Columbus OM value pairs for each Columbus OM command are shown below.
Columbus OM command: uqsap_sub
Columbus OM
parameter R/3 value Value definition Comment
-as "&T" R/3 title of output request

-at &P Printer name Mandatory for
printing
-cp &C Multiple copies
-df &F Document name Mandatory
-fax "&t" Fax number Mandatory for
faxing
-o &O R/3 user ID of owner of
output request
-p &Y R/3 priority of output request
-pp &L Paper type required for
printing
-rmg "&EG" Reply Message Group name Mandatory
-sc &m Client of R/3 user who Mandatory
created output request
-si "&ES" R/3 instance name Mandatory
-sid &EI R/3 spool ID Mandatory
-system &Es Identity of originating R/3 Mandatory, if
instance more than one
host running
R/3
Columbus OM Columbus OM
parameter value Value definition Comment
-b y|n y if burst-page banner

required; n if not required

Configuring R/3
-h held Submits entry to queue with

status Held
-m medium print The default
value
fax Mandatory for
faxing
DCS_Medium Mandatory for
multiple copies
-pi Includes an -sc (special
copy, to index the file)
parameter on the aeq
command
-qn qname Name of Columbus OM Mandatory,
instance on R/3 spool server when more
host than one
Columbus OM
instance on R/3
spool server
host
Columbus OM command: uqsap_can
Columbus OM
"&EL" Job uid Mandatory

host through which job was than one
submitted Columbus OM
instance on R/3
spool server
host
Columbus OM command: uqsap_jq
Columbus OM
"&EL" Job uid Mandatory

host through which job was than one
submitted Columbus OM
instance on R/3
spool server
host

Configuring R/3
23
Note If the R/3 value might contain ‘space’ characters, it must be enclosed in
double quotes (for example, "&EG").
Defining a printer
For each Columbus OM printer that you want to use from R/3, you must create an
“output device” in 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.
2 In the Output device box, type 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.
3 In the Short name box, type an abbreviated name for the printer.
4 Under Device Attributes, specify the printer Device type.
5 Set the Spool server to the local SAP instance.
6 Set the Device class.
This is usually set to Standard printer.
7 Make sure that Lock printer in SAP System is not selected.
8 Set the other fields on the DeviceAttributes tab as required; they are all
optional.
9 Click the HostSpoolAccMethod tab.

Configuring R/3
10 In the Host spool access method box, select E: external output

management system.
11 In the Host printer box, type the name of the printer that is set up in
Columbus OM.
12 In the Logical OMS box, specify the logical OMS that is to be associated with
the printer, as defined earlier (for example, Columbus OM PRINT LOMS).
The logical OMSs are identified by their descriptions, not their names.
13 Set the values on the Output attributes and Tray info tabs to your
installation’s requirements.
None of the values on these tabs affect Columbus OM.
14 On the Output device menu, click Save.
The configuration of R/3 is now complete. Next, you must configure

Columbus OM: see ‘Configuring Columbus OM’ on page 25.

Configuring Columbus OM
25
To configure Columbus OM, complete the following procedures in the order
shown.
1 ‘Handling multiple copies of documents’ below.
2 ‘Returning job status information’ on page 26.
3 ‘Collecting printer status information’ on page 27.
4 ‘Returning status information to the originating R/3 instance’ on page 27.
Controlling security
Decide whether or not to add the R/3 host usernames to the security file (aeq_o) of
the Columbus OM instance on the R/3 spool server host.
■ If no R/3 host usernames are specified in the security file, jobs can be
submitted to the Columbus OM OMS by any R/3 host.
■
If you want to restrict access to the Columbus OM OMS to specific R/3 hosts,
add only those host usernames to the security file.
Handling multiple copies of documents

To enable Columbus OM to handle multiple copies of R/3 documents and to
return job status information to R/3, you must create and start a dcs server
(document composition server) in each of the Columbus OM print instances on the
R/3 spool server host.
To create a dcs server

1 In Columbus OM Explorer, click the Advanced tab.
2 Double-click the icon for a Columbus OM print instance and then, under the
icon, click the Columbus OM Servers folder.
3 On the Servers menu, click New.
4 Type a name for the server.
5 In the Program box, select dcs.

6 If the spool server host is a Windows NT/2000 computer, click the OUTGOING
attribute, and then type No in the Value box.
7 Click OK to create the server.
8 Create a dcs server for all the Columbus OM instances on the R/3 spool server
host.
To start the servers

1 In the right pane, click the icon of the new server.
2 On the Servers menu, click Start.
3 Repeat for each of the new servers.
Next, see ‘Returning job status information’ below.
Returning job status information

Each Columbus OM instance in the Columbus OM OMS and each
Columbus OM print instance on the spool server host must be configured so that
job status information can be returned, for display at the R/3 user interfaces.
To configure a Columbus OM instance

■
Using Columbus OM Explorer, connect to the host on which the instance is
installed and set the instance’s Status_Feedback system parameter to a
number (5 or greater).
The number set determines the interval (in seconds) at which status information
is returned. Keep it as high as possible to minimize network traffic.
Next, see ‘Collecting printer status information’ on page 27.

Collecting printer status information
27

To configure a Columbus OM print instance to collect printer status information,
see the How to configure Columbus OM manual.
Returning status information to the originating R/3 instance

To configure a Columbus OM instance to return job and printer status changes to
the R/3 instance that originated the job, see ‘Configuring RFC calls to an R/3
instance’ below.
Configuring RFC When job and device status changes are returned to the originating R/3 instance
calls to an R/3 using R/3’s RFC mechanism, the status information is returned in real time (that is,
instance as and when a status change occurs).
To configure a Columbus OM instance to make RFC calls

1 Using Columbus OM Explorer, connect to the host on which the instance is
installed and in the instance, set the following system parameters:
SAP_NOTIFY – Yes
Status_Feedback – the time interval (in seconds) at which detailed job status
information will be returned to originating R/3 instance. Set the time interval to
5 or greater.
2 Using your Columbus OM logon name and password, log on to the host where
the instance is installed.
3 Change to the folder where the instance is installed.
4 Change to the security folder and add the name &implementors to the
sap_passwd file.
5 Change back to the folder where the instance is installed.

6 Set up the Columbus OM environment variables as follows:
■
On UNIX platforms, run the csetup or setup program as follows:
– if using the C shell, type source csetup
– if using the Bourne or Korn shells, type . ./setup
■
On Windows platforms, set the UNIQDIR and PATH system variables by
typing:
set UNIQDIR=c:\dir (where c is the drive on which the Columbus OM
instance is installed, and dir is the full path to the installation folder)
set PATH=%UNIQDIR%\programs\commands\%PATH
7 Type sappasswd.

8 In response to the Password: prompt, type the password of the user account
set up on the R/3 host for RFC logons (as set up previously: see ‘Creating a
user account for RFC transactions’ on page 15).
You need to be aware if the Columbus OM instance has been
configured to address a single R/3 instance, or multiple R/3
instances. At present, your system appears to be configured
for a single R/3 instance.
In this case, the SAP RFC password is normally placed in the
Columbus OM instance’s system defaults file.
Do you wish to configure the Columbus OM instance for multiple
R/3 instance support?
■
If the instance will be making RFC calls to a single R/3 instance, proceed
from step 9.
■
If the instance will be making RFC calls to multiple R/3 instances, proceed
from step 13.
9 Type n.
System default table updated
10 Using Columbus OM Explorer, connect to the host on which the
Columbus OM instance is installed and in the instance, set the following system
parameters:
SAP_GWHOST
The name of the host on which the R/3 instance is installed (a maximum of 32
alphanumeric characters).
SAP_GWSERV
The network service name, for example, sapgw00.
The numeric part of the network service name (00 in the above example) must
be the same as the System Number of the R/3 host to which the RFC calls are
to be made.
SAP_LANG
The language used within R/3 (for example, EN for English, DE for German).
SAP_MODE
Set to R/3.
SAP_RFC_USER
The name of the user account set up on the R/3 host for RFC logons (as set up
previously: see ‘Creating a user account for RFC transactions’ on page 15).
If you need to configure another instance to make RFC calls, repeat the
procedure from step 1. Otherwise, that concludes the configuration of
Columbus OM and also concludes the configuration for access method E with
callback.
11 Type sappasswd.
12 In response to the Password: prompt, type the password of the user account
set up on the R/3 host for RFC logons (as set up previously – see ‘Creating a
user account for RFC transactions’ on page 15). Now proceed from step 14.
13 Type y.

29
Enter the name of the R/3 host/instance (<CR> = list):
14 Type the name of the host on which the R/3 instance is installed (a maximum
of 32 alphanumeric characters) in the form HOST_INSTANCE_SYSNO.
No host of this name has been found in the saphosts table
Do you wish to create an entry [N]?
15 Type y.
Additional information is required to add an entry

An R/3 user with SAP_ALL and S_ABAP_ALL priviledges
RFC_USER:
16 Type the name of the user account set up on the R/3 host for RFC logons (as
set up previously – see ‘Creating a user account for RFC transactions’ on
page 15).
Required language within R/3 (e.g EN - English, DE - German)
SAP_LANG:
17 Type the code for the language used within R/3.
SAP mode (normally R/3, but R/2 is valid)

SAP_MODE:
18 Type R/3.
R/3 gateway service (service name for the R/3 gateway)

SAP_GWSERV:
19 Type the network service name (for example, sapgw00).
The numeric part of the network service name (00 in the above example) must
be the same as the System Number of the R/3 host to which the RFC calls are
to be made.
R/3 gateway hostname (hostname of the R/3 gateway)
SAP_GWHOST:
20 Type the name of the host on which the R/3 instance is installed (a maximum
of 32 alphanumeric characters) in the form HOST_INSTANCE_SYSNO.
To configure the instance to make RFC calls to another R/3 instance, repeat
the procedure from step 11.
21 Change to the config folder, and then edit the saphosts.tab file.
22 In the saphosts.tab file, do one of the following:

■
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
(Setting SAP_IDENTIFIER to HOST prevents SAP feedback from being cached,

and means that Columbus OM can provide feedback to only one SAP instance
on the host.)
The configuration of Columbus OM is now complete.

Caching callbacks from Columbus OM

To minimize network traffic and enable recovery if the network or the SAP process
become temporary available, device callbacks and job callbacks from
Columbus OM can be cached. Caching the callbacks means that they are stored
locally until they can be transferred to the SAP host computer.
To enable this feature, you use the caching server: uqsapcache. When
Columbus OM needs to send a callback to the SAP host, it uses the caching server.
If the server cannot send the callback to the SAP host, it stores the callback in the
cache file.
You need one uqsapcache server for each SAP system, even if the SAP systems
are on the same computer. All uqsapcache servers get their connection
information from the sapcachini initialization command in the SAP ROMS.
If you are upgrading from Columbus D 4.100 or UniQ, see also ‘Upgrading
Columbus systems to use callback caching’ on page 77.
Benefits of using callback caching

Callback caching provides these benefits:
■ Guaranteed job and device feedback with recovery if SAP, Columbus OM 4 or
the network becomes available.
■ SAP feedback instance flexibility: if one SAP instance becomes unavailable
then another instance can be used instead.
■ 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.
■
Report level automatically changes in response to feedback amounts. For
example, if there is a lot of feedback, the report level is reduced; when the
traffic settles down, the report level is reset to its original level.
■
Device feedback is available even if a device does not have any outstanding
jobs.
Configuring callback caching

If you have multiple Columbus OM instance, implement callback caching in only
one instance. For this instance, SAP_NOTIFY must be set to YES and there should be
SAPJOB_CACHE and SAPDEV_CACHE entries in default.tab. For all other instances,
SAP_NOTIFY should be set to NO. Use the uqstatusfb server should be used to send
status information from remote instances to the originating Columbus OM
instance.
To implement callback caching, set these parameters in the /config/default.tab
file:
SAPJOB_CACHE filename Yes|No
filename is the name of the cache file in which job callbacks are to be stored.
This file will be in the /media/cache folder.
Yes turns on the caching feature for job callbacks.

31
SAPDEV_CACHE filename Yes|No
filename is the name of the cache file in which device callbacks are to be
stored. This file will be in the /media/cache folder.
Yes turns on the caching feature for device callbacks.
SAP_DEVICES Yes|No
Setting this value to Yes forces stat_mon to deliver SAP feedback about any
Columbus OM printer status.
SAP callback should be cached from only one instance.
Configuring the uqsapcache server

For more information about the configuration parameters for uqsapcache, see the
Columbus OM Technical Reference manual.
Configuring the saphosts.tab file

For SAP instance that will be served by the caching server, there must be an entry
in the saphosts.tab file.
Maintain this file by using the sappasswd command. For more information about
this command, see page 74.
If you have upgraded from a previous version of Columbus OM (or
Columbus OM 4 or UniQ), you can upgrade an existing saphosts.tab file to the
new format by using the saphostconv command. For more information about this
command, see page 75.
Configuring the printers

To force stat_mon to deliver callback to an individual printer, set this parameter in
the printer’s configuration:
SAP_devices Yes
Starting the uqsapcache server

To start the uqsapcache server, use the sapcachini command. For more
information about this command, see page 76.


33
CHAPTER 3

method E with polling
Columbus OM OMS into the R/3 environment, when using access method E with
polling.
Availability
Access method E with polling is available in R/3 versions V3.1i and above.
Features
Access method E provides the following information at the R/3 user interface:
■ print job status
■
fax job status
■ printer status (if the printer is attached to the spool server host).
Functionality
With this access method, R/3 polls the OMS for job status information at a preset
polling interval. Each R/3 instance polls the Columbus OM instance on the R/3
spool server host – through which the job was originally submitted – for the status
information. Printer status feedback can also be returned to the originating R/3
instance, but only if the printer is attached directly to the R/3 spool server host (see
page 10).
The change in status of a local printer is reported only if, when its status changes,
there is a print job queued for it. So, for example, if a printer is taken offline but
there is no job queued for it, the change in status will not be returned to R/3.
A poll for status information can also be initiated manually, by using the R/3 user
interfaces.

34 Configuration for access method E with polling ■
network
host printer
Columbus OM
printer host
printers
Columbus OM

host
R/3 R/3
fax modems
printer
R/3 spool
poll
server
host
Columbus OM R/3 R/3
poll host
R/3
Columbus OM.

Configuration for access method E with polling ■
Configuring R/3
35
Configuring R/3
To configure R/3, complete the following procedures in the order shown.
1 ‘Defining the real OMS’ below.
2 ‘Defining a logical OMS’ on page 36.
3 ‘Specifying the job control commands for a logical OMS’ on page 37.
4 ‘Defining a printer for use by a logical OMS’ on page 41.
Defining the real OMS

The real OMS defines how the logical OMSs associated with it obtain job and
printer status information from the Columbus OM OMS.
To define the real OMS

1 Using the spad transaction, open the Spool Administration: Create Real
Output Management System dialog box.
2 Type a name for the ROMS.

3 Type a description for the real OMS.
In the OMS attributes section of the dialog box:
4 Under Tasking, select Command Line and clear RFC server.
5 Under Job status, select Query, Deletable and Polling, and clear Callback.
6 Under Device status, clear Callback.
■ If local printers are attached to the spool server host, select Queue query.
■
If there are no local printers attached to the spool server host, clear Queue
query.
7 Under Output types, clear Fax.

Configuring R/3
8 On the Real OMS menu, click Save.
Defining a logical OMS

A logical OMS defines how a particular group of R/3 output devices interface with
the printers in the Columbus OM OMS.
To define a LOMS
1 Using the spad transaction, open the Spool Admin.: Create Logical Output
Management System dialog box.
2 Type a name for the LOMS.

3 Type a description for the logical OMS.

Configuring R/3
37
In the SAP configuration section of the dialog box:

4 Type the name of the real OMS that you created earlier.
5 Under Jobs, select Can be deleted and Status dialog boxes.
6 Specify the Tasking target (the name of the R/3 spool server host).
7 On the Logical OMS menu, click Save.
Specifying the job control commands for a logical OMS

For each logical OMS that you create, you have to specify a set of job control
commands. These commands specify how a job will be submitted to the logical
OMS.
To specify a set of job control commands

1 Open the Spool Administration: Operating System Commands (Change)
dialog box for the logical OMS.

Configuring R/3
2 In the Command path section of the dialog box, type the path to the
Columbus OM print instance on the spool server host that interfaces directly
with the R/3 spool server, appended with \programs\commands\.
3 In the OMS commands section of the dialog box, fill in all of the boxes.
Each OMS command setting comprises a Columbus OM command followed by
a series of Columbus OM parameter – R/3 value pairs and optionally, a series of
Columbus OM parameter – Columbus OM value pairs.
The basic (minimum) command sets for printing and faxing a document are
shown below, followed by the complete list of Columbus OM parameter – R/3
value pairs and Columbus OM parameter – Columbus OM value pairs for each
Columbus OM command.
4 On the Operating systems menu, click Save.
Basic command set for printing a document
OMS
command Setting
Submit uqsap_sub -df &F -at &P -rmg "&EG" -sid &EI -qn qname
Polling uqsap_poll -poll &P -rmg "&EG" -qn qname or
uqsap_poll -poll &P -uid "&EL" -qn qname
Queue query uqsap_poll &P -qn qname

Configuring R/3
39
Basic command set for faxing a document
OMS command Setting
Submit uqsap_sub -df &F -fax "&t" -m fax -rmg "&EG"

-sid &EI -qn qname
Polling uqsap_poll -poll &P -rmg "&EG" -qn qnameor
uqsap_poll -poll &P -uid &EL -qn qname
Queue query uqsap_poll &P -qn qname
Job cancel uqsap_can &EL -qn qname
Job query uqsap_jq &EL -qn qname
Note In both of the above command sets, -qn qname can be omitted if there is
only one Columbus OM instance on the R/3 spool server host.
Columbus OM value pairs for each Columbus OM command are shown in the
following tables.
Columbus OM command: uqsap_sub
Columbus OM
-df &F Document name Mandatory

-at &P Printer name Mandatory for
printing
-fax "&t" Fax number Mandatory for
faxing
-rmg "&EG" Reply Message Group Mandatory
name
-sid &EI R/3 spool ID Mandatory
-as &T R/3 title of output request Optional
-o &O R/3 user ID of owner of Optional
output request
-p &Y R/3 priority of output Optional
request
-pc Page count Optional
-pp &L Paper type required for Optional
printing
-cp &C Number of times entry is Optional
added to queue

Configuring R/3
-b y|n y if burst-page banner Optional

required; n if not required
-h held Submits entry to queue
with status Held
-m medium print
fax Mandatory for

faxing
streamserve Mandatory for
multiple copies
-qn qname Name of the Mandatory, when

Columbus OM instance more than one
on the R/3 spool server Columbus OM
host instance on R/3
spool server host
-system r3id Identity of originating Mandatory, if
R/3 instance more than one
host running R/3
Columbus OM command: uqsap_poll
Columbus OM
-poll &P Printer name Must follow

immediately after
uqsap_poll in
OMS Polling
command
-rmg "&EG" Reply Message Group Include if
name -uid list is
omitted
-uid "&EL" Job uid Include if
-rmg “&EG” is
omitted
-qn qname Name of Columbus OM Mandatory, when

instance on R/3 spool more than one
server host through which Columbus OM
job was submitted instance on R/3
spool server host

Configuring R/3
41
Columbus OM command: uqsap_can
Columbus
OM R/3
"&EL" Columbus OM UID Mandatory

-qn qname Name of Columbus OM instance Mandatory, when
on R/3 spool server host through more than one
which job was submitted Columbus OM
instance on R/3
spool server host
Columbus OM command: uqsap_jq
Columbus
OM R/3
"&EL" Columbus OM UID Mandatory

-qn qname Name of Columbus OM instance Mandatory, when
on R/3 spool server host through more than one
which job was submitted Columbus OM
instance on R/3
spool server host
Note If the R/3 value might contain space characters, enclose it in double quotes
(for example, "&t").
Next, see ‘Defining a printer for use by a logical OMS’ below.
Defining a printer for use by a logical OMS

Each printer in a Columbus OM OMS is associated with a logical OMS via an R/3
output device. The same printer can be associated with any number of logical
OMSs.
To define a printer for use by a logical OMS

1 Using the spad transaction, open the Spool Administration: Create Output
Device dialog box.

Configuring R/3

3 In the Short name box, type an abbreviated name for the printer.
In the Device Attributes section of the dialog box:
4 Specify the printer Device Type.
5 Specify the Spool server.
7 In the Host spool access method box, specify E: external output
management system.
8 In the Host printer box, type the name of the printer (the name that was
specified when the Columbus OM OMS was configured).
9 In the Logical OMS box, specify the name of the logical OMS that is to be
associated with the printer.

Configuring R/3
43
That concludes the configuration of R/3.

If you have not yet configured Columbus OM, you must do so now. See
‘Configuring Columbus OM’ on page 44.

To configure Columbus OM, complete the following procedures in the order
shown.
1 To enable Columbus OM to handle multiple copies of R/3 documents and to
return job status information to R/3, you must create and start a dcs server in
each of the Columbus OM print instances on the R/3 spool server host.
For more information, see ‘Handling multiple copies of documents’ on page 25.
2 To enable Columbus OM to return job status information to R/3, you must
configure each Columbus OM instance.
To do this, using Columbus OM Explorer to connect to the host on which the
instance is installed, and then set the instance’s Status_Feedback system
parameter to a number (5 or greater).
The number set determines the interval (in seconds) at which status information
is returned. Keep it as high as possible to minimise network traffic.
3 If there are printers that are directly attached to the R/3 spool server host,
configure Columbus OM to collect the printer status information.
For more information about how to do this, see the How to configure
Columbus OM manual.
4 Decide whether or not to add the R/3 host usernames to the security file
(aeq_o) of the Columbus OM instance on the R/3 spool server host.
■
If no R/3 host usernames are specified in the security file, jobs can be
■ If you want to restrict access to the Columbus OM OMS to specific R/3
hosts, add only those host usernames to the security file.

45
CHAPTER 4

method L
This chapter describes how you configure both Columbus OM and R/3 to
integrate a Columbus OM OMS into the R/3 environment, when using access
method L.
Availability
Access method L is available in R/3 versions V3.0 and above.
Features
Access method L provides the following information at the R/3 user interface:
■ print job status.
Functionality
When integrating a Columbus OM OMS with R/3 using access method L, changes
in print job status are returned to the originating R/3 instance as and when
requested by a user at the R/3 user interface.

46 Configuration for access method L ■
network
host printer
Columbus OM
printer host
printers
Columbus OM

host
R/3 R/3
fax modems
printer
R/3 spool
server
host
Columbus OM R/3 R/3
host
R/3
Columbus OM.

Configuration for access method L ■
Configuring R/3
47
Configuring R/3
To configure R/3, log on to the R/3 instance on the spool server host and complete
the following procedures in the order shown.
1 ‘Specifying the R/3 parameter names and values’ below.
2 ‘Defining a printer for use by R/3’ on page 49.
3 ‘Refreshing the R/3 environment’ on page 50.
Specifying the R/3 parameter names and values

These parameters control how a print request is submitted to the Columbus OM
OMS and how job status feedback is obtained.
To specify the R/3 parameter names and values

1 Using the rz10 transaction, open the dialog box showing the active parameters
for your profile.
2 Add the following parameter names, assigning each an appropriate value and
saving each one:
rspo/host_spool/print
rspo/host_spool/print_answer
rspo/host_spool/print_answer_id
rspo/host_spool/query
rspo/host_spool/answer_format
A typical set of parameter name/parameter value pairs is shown below,

followed by the complete list of Columbus OM parameter – R/3 value pairs and
Columbus OM parameter – Columbus OM value pairs for the Columbus OM lp
and lpstat commands.

Configuring R/3
Typical parameter name/value set for printing a document
Parameter name Parameter value
rspo/host_spool/print D:\Print3415\programs\commands\
lp -d&P -c -n&C -p&L -g&O &F
rspo/host_spool/print_answer &J
rspo/host_spool/print_answer_id request id is
rspo/host_spool/query D:\Print3415\programs\commands\
lpstat -o&P
rspo/host_spool/answer_format D:\Print3415\programs\commands\
lpstat

Columbus OM value pairs for the Columbus OM lp and lpstat commands are
shown in the following tables.
Columbus OM Command: lp
Columbus OM
parameter –
R/3 value pair Value definition Comment
-d&P Printer name Mandatory

-g&O R/3 user ID of owner of output request
-n&C Multiple copies
-oR3par R3par is an R/3 parameter name Passes specified
(for example, &T) R/3 parameter to
Columbus OM
Server Info field
-p&L Paper type required for printing
-rR3par R3par is an R/3 parameter name Passes specified
Columbus OM
Remark field
-tR3par R3par is an R/3 parameter name Passes specified
Columbus OM
File Alias field
Columbus OM
parameter Value definition Comment
-i Submits entry to queue with status Held
R/3 value Value definition Comment
&F Document name Mandatory

Configuring R/3
49
Columbus OM command: lpstat
Columbus OM
parameter –
R/3 value pair Value definition Comment
-o&P Printer name Mandatory
Defining a printer for use by R/3

Columbus OM
parameter Value definition
-a Display the print request acceptance status of all printers

-c Display the members of all printer classes
-d Display the default destination for print requests
-p Display the status of all printers
-r Display the status of the print request scheduler
-s Display a summary of printer status information
-u Display the status of print requests on the default destination for
all users
-v Display the path names of the device drivers associated with all
printers
Each printer in the Columbus OM OMS must be set up as an R/3 output device.
To set up a printer
Device dialog box.

Configuring R/3

3 In the Short name box, type in an abbreviated name for the printer.
7 In the Host spool access method box, specify L: Print locally using LP/LPR.
Refreshing the R/3 environment

Having specified the appropriate R/3 parameter names and values and set up each
Columbus OM OMS printer as an R/3 output device, you must now refresh the
R/3 so that it uses the new configuration.
To refresh the R/3 environment

1 Stop and restart the R/3 instance.
2 Stop and restart the Oracle database.
3 Decide whether or not to add the R/3 host usernames to the security file
(aeq_o) of the Columbus OM instance on the R/3 spool server host.
■ If no R/3 host usernames are specified in the security file, jobs can be
■ If you want to restrict access to the Columbus OM OMS to specific R/3
hosts, add only those host usernames to the security file.

51

Next, see ‘Configuring Columbus OM’ below.
To enable job status information to be displayed in the SAP R/3 interface, you
must configure each Columbus OM instance in the Columbus OM OMS,
including the Columbus OM print instance on the spool server host.
To configure a Columbus OM instance

1 Using Columbus OM Explorer, connect to the host on which the instance is
installed and set the instance’s Status_Feedback system parameter to a
number (5 or greater). Detailed job status information will then be returned to
the originating instance every number seconds.
2 You must also set the Status_Feedback system parameter in the originating
instance. Furthermore, if the status information is being routed to the
originating instance via other instances, you must also set the
Status_Feedback system parameter in each of these instances.
3 Repeat these steps for each Columbus OM instance.

That concludes the configuration of Columbus OM.


53
CHAPTER 5

method U
Columbus OM OMS into the R/3 environment, when using access method U.
Availability
Access method U is available in R/3 versions V1.1 and above.
Features and functionality

Access method U provides the most basic method for submitting R/3 print jobs to a
Columbus OM OMS. With this access method, an R/3 print request is added to the
print queue of the Columbus OM instance on the R/3 spool server host. It is then
routed to its designated destination by the Columbus OM OMS.
There is no job or printer status feedback.

54 Configuration for access method U ■
network
host printer
Columbus OM
printer host
printers
Columbus OM

host
R/3 R/3
fax modems
printer
R/3 spool
server
host
Columbus OM R/3 R/3
host
R/3
To implement this access method, you have to configure both R/3 and
Columbus OM.

Configuration for access method U ■
Configuring R/3
55
Configuring R/3
To configure R/3, complete the following procedures, in the order shown.
1 ‘Configuring the TCP/IP port for R/3 print requests’ below.
2 ‘Defining a printer for use by R/3’ below.
Configuring the TCP/IP port for R/3 print requests

■
Set up the R/3 spool server to send print requests via TCP/IP port 515.
Defining a printer for use by R/3

Each printer in the Columbus OM OMS must be set up as an R/3 output device.
To set up a printer
Device dialog box.

3 In the Short name box, type in an abbreviated name for the printer.
7 In the Host spool access method box, specify U: Print using Berkeley
protocol.

Configuring R/3

Next, see ‘Configuring Columbus OM’ on page 57.

Configuration for access method U ■
57
To configure Columbus OM
1 Stop the lpd daemon in the R/3 spool server host.
2 Start lpdserver in the Columbus OM print instance on the R/3 spool server
host.
That concludes the configuration of Columbus OM.


59
CHAPTER 6
Chapter 6 Using R/3 user ids to log

on to Columbus OM
Explorer
This chapter describes how to configure a Columbus OM OMS so that R/3 user ids
can be used to log on to Columbus OM Explorer.
This feature is available only on certain UNIX platforms. It is not available on
Windows systems.
To find out if your UNIX platform can support this feature

■
Look for a file called csulin_sap in the $UNIQDIR/programs/commands
directory. If this file exists, the feature can be implemented on your system.
To configure the Columbus OM print instance on the R/3 server

1 Open the $UNIQDIR/servers/uqserver/saprfc.ini file.
2 Make a note of what the DEST parameter is set to. You will need to know the
setting later.
As supplied, it is set to UNIQSAP, and does not usually need to be changed.
3 Change the ASHOST parameter to the hostname of the computer on which R/3
is running.
4 If you want to maintain a trace file, set RFC_TRACE to 1. The trace file created
is called dev_rfc.
If you do not want to maintain a trace file, set RFC_TRACE to 0.
5 In Columbus OM, set uqserver’s Login_csuniq parameter to:
csulin_sap [client_number] [SAP R/3 destination] [-keep]
Replace:
client_number
The number of the R/3client. It must be between 0 and 999 (inclusive). The
default value is 000.
destination
Set destination to the value of the DEST parameter in the saprfc.ini file.
The default value is UNIQSAP.

60 Using R/3 user ids to log on to Columbus OM Explorer ■
-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, then the trace file is deleted.
That concludes the configuration of the Columbus OM print instance.

61
CHAPTER 7
Chapter 7 Using the Columbus OM

command line interface
This chapter describes the Columbus OM commands that are specific to R/3 and
which can be run from the Columbus OM command line interface. For
information about other Columbus OM commands, see the How to use the command
line interface manual.
Standard commands
These commands are run automatically during normal R/3 operations. For
diagnostic purposes, they can also be run manually.
Command See Description
uqsap_can page 62 Cancels a job

uqsap_jq page 64 Job query
uqsap_poll page 66 Device polling
uqsap_poll page 68 Device or queue query
uqsap_sub page 71 Submits a job
Utility commands
Command See Description
sappasswd page 74 Used with R/3 access method E with callback (see
‘Returning status information to the originating R/3
instance’ on page 27).
saphostconv page 75 Converts a saphosts.tab file from the format used in
ColumbusD 4.100 and UniQ to the format used for
Columbus OM 4.3.
sapcachini page 76 Starts uqsapcache, and informs the ROMS server for
which it is responsible.

62 Using the Columbus OM command line interface ■
uqsap_can: job cancellation

uqsap_can always removes jobs in a state of transfer. If the REQ_HOP parameter in
%UNIQDIR%\config\default.tab is set to YES, uqsap_can will also attempt to
remove jobs on remote hosts.
Syntax
uqsap_can entry_id ... [-all] [-qn instance] [-REQ]
Parameters and options

entry_id ...
A space-separated list of the Columbus OM identification numbers of the

entries to be cancelled.
-all
Cancel the specified entries, whether or not they were submitted by R/3; the
default is to cancel the entries only if they were submitted by R/3.
-qn instance
The identification of the Columbus OM instance.

-REQ
Including this parameter removes the specified entries from the pending queue.
If you do not include this parameter, the specifies entries are moved to the
completed queue and their status is set to Cancelled.
Command format
Define the CANCEL command as:
uqsap_can &EL
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 interface version number.

job
The job state; one of: 1 = Pre-processing; 2 = Pending; 3 = Printing;

4 = Cannot resubmit; 5 = Can resubmit; 6 = Cancelled; 7 = Gone;
8 = Unknown.
class
The class code; one of: 1 = Error; 2 = Intervention; 3 = No intervention;

4 = Successful.

Using the Columbus OM command line interface ■
63
area
The area code; one of: 1 = Spooler; 2 = Printing; 3 = Formatting;

4 = Network; 5 = Other.
result
The result code; one of: 1 = Printed; 2 = Not printed; 3 = Partly printed;
4 = Possibly printed.
string
An optional message, with each space character prefixed by a backslash (\).

uqsap_jq: job query
uqsap_jq: job query

uqsap_jq displays detailed information on R/3 print requests.
Syntax
uqsap_jq entry_id ... [-all] [-qn instance]
Parameters and options

entry_id ...
A space-separated list of the Columbus OM identification numbers of the

entries to be displayed.
-all
Display the specified entries, whether or not they were submitted by R/3; the
default is to display the entries only if they were submitted by R/3.
-qn instance
Command format
Define the JQUERY command as:
uqsap_jq &EL
Output format
The output comprises multiple lines giving the status of the selected print requests.
Each line has nine space-separated fields.
version job class area result position pages time string
version

job

8 = Unknown.
class

4 = Successful.
area

result

uqsap_jq: job query
65
position
The position in the queue: 0 = Active; ‘–’ = Unknown.

pages
The number of pages printed so far.

time
The estimated number of seconds until completion; ‘–’ = Unknown.

string

uqsap_poll: device polling

uqsap_poll polls the status of a Columbus OM print server or class. By default,
100 entries are displayed.
Syntax
uqsap_poll -poll printer { -rmg "string" | -uid entry_id... }
[option...]
Parameters
-poll printer
Check the specified printer – a server or class.

-rmg "string"
Poll this Reply Message Group.

-uid entry_id...
Poll the queue entries whose Columbus OM entry_ids are given in the space-
separated list.
Options
-all
Display the specified entries, whether or not they were submitted by R/3; the
-max number
Controls the number of entries displayed. The default is the number of

entry_ids given by the -uid parameter; otherwise 100. If number is specified
as -1, all the jobs found are displayed.
-qn instance
Command format
Define the DPOLL command as either of:
uqsap_poll -poll &P -rmg "&EG"
uqsap_poll -poll &P -uid &EL
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

67
device
The device state as an encoded text string qpacnnnnnns.

q = ‘X’ if queue enabled, ‘.’ otherwise;
p = ‘X’ if printer enabled, ‘.’ otherwise;
a = ‘X’ if alarm set, ‘.’ otherwise;
c = ‘X’ if currently printing, ‘.’ otherwise;
nnnnnn = number of jobs in queue;
s = ‘X’ if status incomplete, ‘.’ otherwise.
class

4 = Successful.
area

string

Each job status line has seven space-separated fields.
sapid job class area result position string
sapid
The internal spool identifier.

job

8 = Unknown.
class

4 = Successful.
area

result
position

string

uqsap_poll: device/queue query

uqsap_poll queries the status of a Columbus OM print server or class.
Syntax
uqsap_poll printer [option...]
Parameter
printer
Check the specified printer (a server or class).
Options
-all
Display the specified entries, whether or not they were submitted by R/3. The
-max number
Display a maximum of number entries. The default is the number of

entry_ids given by the -uid parameter; otherwise 100.
-qn instance

-system string
string identifies the calling R/3 system (for compatibility with earlier versions
of the interface).
Command format
Define the DQUERY command as:
uqsap_poll &P -all
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

device
The device state as an encoded text string qpacnnnnnns.

q = ‘X’ if queue enabled, ‘.’ otherwise;
p = ‘X’ if printer enabled, ‘.’ otherwise;
a = ‘X’ if alarm set, ‘.’ otherwise;
c = ‘X’ if currently printing, ‘.’ otherwise;
nnnnnn = number of jobs in queue;
s = ‘X’ if status incomplete, ‘.’ otherwise.

69
class

4 = Successful.
area

string

Each job status line has thirteen space-separated fields.
sapid job class area result position string rmg entry_id size
priority file alias
sapid
The internal spool identifier.

job

8 = Unknown.
class

4 = Successful.
area

result
position

string

rmg
The Reply Message Group; ‘–’ = Not submitted from R/3.

entry_id
The entry’s Columbus OM identification number.

size
The document size in bytes.

priority
The Columbus OM priority.

file
The document file.

alias
The document alias, with each space character prefixed by a backslash (\).

uqsap_sub: job submission
71

uqsap_sub adds an entry to the print queue, where it is allocated a unique
Columbus OM identification number entry_id.
Syntax
uqsap_sub -df file -at printer -sid string -rmg "string"
[option...]
Parameters
All parameters must be supplied.
-df file
file is the pathname to the source document.
-at printer
The destination is the specified printer: a server or class.

-sid string
string is the spool id.
-rmg "string"
string is the Reply Message Group.
Options
-as string
A user-defined document identification of up to 80 characters, enclosed in

quotes "..." if it contains spaces.
-b YES|NO
YES if a burst-page banner is required; NO otherwise.
-cp number
Create number queue entries for each source document.

-delay n
Forces uqsap_sub to sleep for n milliseconds before exiting.

-enc [NO|YES|AES128|AES192|AES256]
Controls whether the document file is encrypted when it is on the queue. The
encryption system that is used is AES (Rijndael).
■
NO adds the document to the queue without encrypting it.
■ YES encrypts the document. Columbus OM uses the method that is
specified by the Disk_Encrypt parameter in the system defaults table
(default.tab). If that parameter is omitted or set to NO, Columbus OM
encrypts the document by using 128-bit keys.
■
AES128 uses 128-bit keys.
■ AES192 uses 192-bit keys.

■
AES256 uses 256-bit keys.
The default value is NO.

-fax fax_number
The document is to be faxed to the specified fax number.

-flush
Forces uqsap_sub to flush the output message before exiting.

-h
Set the entry’s status to Held; it will not be processed until released.
-m medium
The transmission medium, normally PRINT.

-o user_id
The entry belongs to user_id rather than you.

-p number
A digit in the range 1 (highest) to 99 (lowest), to be used when prioritizing tasks.

-pc number
The page count.

-pi
Produce a page index of the document, if possible.

-pp paper_type
The required paper_type.

-qn instance

-sl level
The security level. Corresponds to the Authorization field in R/3.

-system string
string identifies the calling R/3 system (for compatibility with earlier versions
of the interface).
Command format
Define the SUBMIT command as:
uqsap_sub -df &F -at &P -sl &XX -rmg "&EG" -sid &EI -o &O -cp &C
Output format
The output comprises one line giving the status of the print request, with five
space-separated fields.
version job class area result string
version

73
class

4 = Successful.
area

entry_id
The entry’s Columbus OM identification number.

string

sappasswd: encrypt R/3 passwords
sappasswd: encrypt R/3 passwords

sappasswd stores an encrypted R/3 password in the Columbus OM system files
config.tab, default.tab or saphosts.tab.
When handling print jobs received from R/3, Columbus OM needs to establish a
connection to the originating R/3 instance in order to report job status information.
■ If file saphosts.tab does not exist, Columbus OM assumes that there is only
one 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 job’s queue attributes
– to determine the appropriate R/3 instance where the status information is to
be reported. If no host matches, the SAP_ parameters in default.tab are used.
If there is one or more instance of uqsapcache, the encrypted password can
optionally be written to the config.tab file for any one of those servers.
Syntax
sappasswd

saphostconv: saphost.tab conversion
75
saphostconv: saphost.tab conversion

saphostconv converts a saphosts.tab file from the format used in ColumbusD
4.100 and UniQ to the format used for Columbus OM 4.3.
If you are upgrading from ColumbusD 4.105 and later, or any version of
Columbus OM, you do not need to use this command.
Syntax
saphostconv saphosts.tab
Example
For an existing saphosts.tab file:
m4prsrv01_NT1_01 TESTUSER, passwd, EN,R/3,sapgw01,m4prsrv01,,100

hpc360_R45_00 devuser, passwd, EN,R/3,sapgw00,hpc360,
hpc360 devuser, passwd ,EN,R/3,sapgw00,hpc360,yes
Converted output file is saphosts.tab.rev

For each host in saphosts.tab,
you will be prompted for the target name that you wish to use on
that host.
If you wish to use more than one target on the host, enter the
target name with a backslash ('\') after it - you will then be
prompted for further targets for that host. Please note that you
will still need to amend the output file, in particular to set
correct gateway service (sapgwNN) for the given new target(s).
If the host name is already a target enter '-': the target will
be used as is (i.e. the line will be copied).
An empty reply (i.e. you hit return) will force the programme to
move on to the next (if any) host in the input file.
SAP Host m4prsrv01_NT1_01 : Enter Instance #01 for this host:-

SAP Host m4prsrv01_NT1_02 : Enter Instance #01 for this host:-
SAP Host hpc360_R45_00 : Enter Instance #01 for this host:<RET>
SAP Host hpc360 : Enter Instance #01 for this host:hpc360_R45_00\
SAP Host hpc360 : Enter Client #01 for this host:800\
SAP Host hpc360 : Enter Instance #02 for this host:hpc360_R45_03
SAP Host hpc360 : Enter Client #02 for this host:800\
This creates the following saphosts.tab.rev file:
# SAPHOSTS.TAB: New format

# Created by cjw at 11:12 on 06 August 2002
SAP_IDENTIFIER INSTANCE
#Original host m4prsrv01_NT1_01: Entry Copied
#Original host m4prsrv01_NT1_02: Entry Copied
#Original host hpc360_R45_00: Entry removed
#Original host hpc360:
hpc360_R45_00 devuser, passwd ,EN,R/3,sapgw00,hpc360,yes,800
hpc360_R45_03 devuser, passwd ,EN,R/3,sapgw00,hpc360,yes,800
The last new entry must be amended by replacing sapgw00 with sapgw03.

sapcachini: SAP cache initialization
sapcachini: SAP cache initialization

sapcachini is used to start the appropriate instance of uqsapcache if required and
informs the ROMS server for it is responsible for.
sapcachini is 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.
The temporary file, sapisup, is written to $UNIQDIR/servers/sapcache_1. If this
persists for longer than 10 seconds, an error status is reported back to SAP.
Syntax
sapcachini server roms initialzation_instance
client r3flags romsflags
Example
sapcachini sapcache_1 VEGEMITE hpc360_R45_01
800 ssssssss SSSSSSSS
Usage
The last parameters are required, however, they do not contain any information
that cannot be determined as the server starts and collects the configuration from
the SAP system. Enclose these parameters in quotes.

77
CHAPTER 8
Chapter 8 Upgrading Columbus

systems to use callback
caching
If you are upgrading from ColumbusD 4.100 or UniQ, and you want to use the job
and device feedback features in Columbus OM4.3 and later, follow the instructions
below.
If you are upgrading from ColumbusD 4.105 or later versions, or any version of
Columbus OM, these features are automatically implemented; you can ignore
these instructions.
These instructions provide an overview of the steps that are involved. Before using
the instructions, see ‘Caching callbacks from Columbus OM’ on page 30.
Checking the system requirements

Make sure that the system meets these requirements:
■
The SAP system has XOM RFC level 3 support.
■
A Columbus OM distributed environment is installed: that is, there are
Columbus OM client instances installed on the same computer as SAP
instances, and these communicate with remote Columbus OM instances (on
different computers) that are controlling the printers.
■
All the Columbus instances are Columbus OM version 4.3 or later, or
ColumbusD 4.105 or later.
Checking the SAP system

Make sure that the relationships between the SAP ROMS and LOMS match one of
the valid relationships that is described below.
This relationship is valid:

78 Upgrading Columbus systems to use callback caching ■
ROMS 1 LOMS 1 Columbus OM client 1
In this relationship, there is one cache server (which is part of the “Columbus OM
client”) for each ROMS. The cache servers send feedback from Columbus OM to
the ROMS. The relationship is valid because each cache server communicates with
a different ROMS.
This relationship is also valid:
This relationship is valid because each different cache server is communicating with
a different ROMS.
However, this relationship is invalid:
ROMS 1 LOMS 1 Columbus OM
This relationship is invalid because the different cache servers are sending feedback
to the same ROMS. This could lead to inconsistent information.
Configuring the Columbus OM client

1 Make sure that the remote.tab file contains entries for the remote printers.
2 Upgrade the saphosts.tab file to the new format by using the saphostconv
command.
For more information about using this command, see page 75.

Upgrading Columbus systems to use callback caching ■
79
3 Update the default.tab file so that it contains these entries:
ack_command No
sapjob_cache jobcache
sapdev_cache devcache
sap_notify Yes
4 Make sure that these servers are running:

■
uqsapcache
■ netmaster
■ uqserver.
Configuring the Columbus OM server

1 Make sure that there is no saphosts.tab file.
2 Update the default.tab file so that it contains these entries:
ack_command No
status_feedback 10
sap_notify No
3 Update the statserver configuration file so that it contains this entry:
device_callback stat_mon
4 Make sure that these servers are running:

■
printmaster
■ statserver
■
uqserver
Configuring the printers

■ For each printer, update its configuration file (config.tab) so that the file
contains these entries:
backchannel snmpinfo lexmark BACKCHANNEL (or similar command)

sap_devices Yes

80 Upgrading Columbus systems to use callback caching ■

81
Index
A uqsap_jq 64
uqsap_poll 66, 68
access method E with callback
configuring Columbus OM 25
configuring R/3 14 E
overview 13 encrypting documents on the queue
access method E with polling SAP integration 71
configuring R/3 35
overview 33
R
access method L R/3 See SAP R/3
configuring R/3 47 S
overview 45 SAP R/3
access method U access methods 12
configuring Columbus OM 57 user ids, logging on to Columbus OM
configuring R/3 55 Explorer with 59
overview 53 SAP_DEVICES parameter 31
sapcachini command 76
C saphostconv command 75
saphosts.tab file 31
caching callbacks from SAP R/3 30
saphost.tab conversion 75
callbacks from SAP R/3
sappasswd command 74
caching 30
usage when configuring Columbus
Columbus OM commands (integration
OM 27, 28
with SAP R/3)
uqsap_can 62
uqsap_jq 64 U
uqsap_poll 66, 68 uqsap_can command 62
uqsap_sub 71 uqsap_jq command 64
Columbus OM OMS uqsap_poll command 66, 68
in R/3 environment 9 uqsap_sub command 71
overview 8 uqsapcache server 30
commands (integration with SAP R/3) configuration parameters 31
sapcachini 76
saphostconv 75
sappasswd 74
uqsap_can 62

82 Index

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

Columbus Output Management: How To Integrate With SAP R/3

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Columbus Output Management: How To Integrate With SAP R/3

Uploaded by

Copyright:

Available Formats

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

UQC4-4800-00 Columbus OM 4.8

How to integrate with SAP R/3 UQC4-4800-00

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

Chapter 1 Introduction to the Columbus OM OMS and SAP R/3 . . 7

Chapter 2 Configuration for access method E with callback . . . . 13

Chapter 3 Configuration for access method E with polling . . . . . 33

Chapter 4 Configuration for access method L . . . . . . . . . . . . . . . 45

Chapter 5 Configuration for access method U . . . . . . . . . . . . . . . 53

Chapter 6 Using R/3 user ids to log on to Columbus OM Explorer 59

Chapter 7 Using the Columbus OM command line interface . . . . 61

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

uqsap_sub: job submission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Chapter 8 Upgrading Columbus systems to use callback caching . 77

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

About this manual

How to integrate with SAP R/3 UQC4-4800-00

How to use this manual

find out more about the Columbus OM ‘Introduction to the Columbus OM

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Files, folders, environment variables and program names

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Chapter 1 Introduction to the

This chapter provides an overview of how Columbus OM OMS can integrated

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Columbus OM OMS overview

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Columbus OM OMS in R/3 environment

Single R/3 instance and Columbus OM OMS

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Multiple R/3 instances and Columbus OM OMS

Columbus OM R/3 R/3

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

In a Columbus OM and R/3 environment, the number of Columbus OM instances

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

R/3 access methods

E with callback 4.0 and above ‘Configuration for access method E

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Chapter 2 Configuration for access

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Columbus OM R/3 R/3

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Setting up the R/3 spool server host to interface with

To modify the spool server owner environment

Creating a user account for RFC transactions

To create an R/3 user account for Columbus OM on an R/3 host

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Creating an RFC destination in SAP

To create an RFC destination

3 Type a name to identify the RFC destination.

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

12 On the Destination menu, select Save.

Creating the real OMS

To create the real OMS

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

3 Type a name for the real OMS.

5 Under Tasking, select Command line.

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3

Defining a logical OMS

4 Type a name for the logical OMS.

11 Click the Save toolbar button.

COLUMBUS OUTPUT MANAGEMENT HOW TO INTEGRATE WITH SAP R/3