OM Plus DM Admin Guide
OM Plus DM Admin Guide
COPYRIGHT NOTICE
Copyright © 2003-2021 by Plus Technologies All rights reserved. Any other use is prohibited. No part of this book may be
reproduced or transmitted in any form or by any means, electronic or mechanical, without the written permission of Plus
Technologies This includes photocopying, recording, or an information storage and retrieval method, including posting to the
Internet.
OM Plus™ is undergoing continual revision, refinement, and expansion in order to include additional features. This
documentation is believed to be accurate and reflects the product at the time of publication.
However, Plus Technologies assumes no responsibility for its use or for any infringements of patents or other rights of third
parties that may result from its use. Plus Technologies reserves the right to change this product at any time without notice.
TRADEMARKS
OM Plus, Context Delivery, Report Bundler, Report Distributor, PD Plus, Fleet Manager and LP Plus are trademarks of Plus
Technologies. All other products and company names are trademarks of their respective companies.
All other company and product names may be trademarks of their respective owners. The information contained herein is
subject to change without notice.
PUBLISHED BY
Plus Technologies
Page | 2
A portable document format (PDF) version of this guide is located in the Help folder in the OM Plus installation directory. To
open the PDF guide, Adobe Acrobat Reader version 4.0 or higher must be installed on the computer. The latest version of
Acrobat Reader can be downloaded from www.adobe.com at no charge.
With Adobe Acrobat Reader it is possible to display, search, copy, print pages, and click hyperlinks. It is also possible to click
headings or page numbers in the table of contents or references in the text to display those headings or pages.
For help using PDF files, from the Adobe Acrobat Reader Help menu, click Reader Help or Reader Guide, depending on which
version of Reader is installed.
If you have questions about OM Plus and are unable to find answers in this guide, contact Plus Technologies in one of the
following ways:
• Web: www.plustechnologies.com
• Telephone: +1.937.847.0614
• Fax: +1.937.384.0842
Plus Technologies Support is available Monday through Friday from 8:00 A.M. to 8:00 P.M., Eastern Time (GMT -5 hours),
expect on certain U.S. holidays. They are Memorial Day, July 4th, Labor Day, Thanksgiving Day, Christmas Eve and Day and New
Year’s Day.
Additional support packages are available including an 8:00 A.M. to 11:00 P.M. or even 24x7 support.
Page | 3
Notices………………………………………………………………………………………………………………2
Trademarks.....................................................................................................................................2
Published By ....................................................................................................................................... 2
Ease of use....................................................................................................................................16
Page | 4
Installation ................................................................................................................. 26
Destinations ........................................................................................................................ 26
Classes ........................................................................................................................ 26
Types ........................................................................................................................... 43
i-Sat ............................................................................................................................. 43
System ................................................................................................................................ 47
Client .................................................................................................................................. 60
Security ............................................................................................................................... 63
Page | 5
Page | 6
OM Plus Delivery Manager Administration Guide
Printer Status .............................................................................................................. 82
Form ........................................................................................................................... 88
Page | 7
OM Plus Delivery Manager Administration Guide
Status .......................................................................................................................... 88
Title ............................................................................................................................. 88
User ............................................................................................................................ 88
Page | 8
OM Plus Delivery Manager Administration Guide
Nomatch or Lastmatch .............................................................................................. 102
Starting on UNIX………………………………………………………………………………………………………104
Page | 9
OM Plus Delivery Manager Administration Guide
Configuring OM Plus for SAP Callbacks ...................................................................... 125
Page | 10
OM Plus Delivery Manager Administration Guide
dcclpdser ........................................................................................................................... 159
dccmount…………………………………………………………………………………………………………………………164
dccmsghelp…………………………………………………………………………………………………………………….165
dccnetstat……………………………………………………………………………………………………………………….166
dccprtval………………………………………………………………………………………………………………………..167
dccqval…………………………………………………………………………………………………………………………..168
dccrange………………………………………………………………………………………………………………………..169
dccrdedit….……………………………………………………………………………………………………………………170
dccreject……………………………………………………………………………………………………………………..…171
dccreset………………………………………………………………………………………………………………………….172
dccsapstat……………………………………………………………………………………………………………………….173
dccsapsub……………………………………………………………………………………………………………………….174
dccscan (UNIX)………………………………………………………………………………………………………………..175
dccscan (Windows)………………………………………………………………………………………………………….176
dccsched………………………………………………………………………………………………………………………….177
dccshut…………………………………………………………………………………………………………………………….178
dccstat……………………………………………………………………………………………………………………………...179
dccstatdef………………………………………………………………………………………………………………………….180
dccsuspall…………………………………………………………………………………………………………………………. 181
dccsuspend………………………………………………………………………………………………………………………..182
dccswitch………………………………………………………………………………………………………………………….183
dccview…………………………………………………………………………………………………………………………….184
disable………………………………………………………………………………………………………………………………185
enable………………………………………………………………………………………………………………………………186
hexdump……………………………………………………………………………………………………………………………187
installcdplus……………………………………………………………………………………………………………………….188
Page | 11
OM Plus Delivery Manager Administration Guide
lpadmin………………………………………………………………………………………………………………………………….189
lplinkonly……………………………………………………………………………………………………………………………….192
lppusers……………………………………………………………………………………………………………………………….…193
lpstat……………………………………………………………………………………………………………………………………..194
omlogusers………………………………………………………………………………………………………………………….…195
ompremove………………………………………………………………………………………………………………………….…196
omqdepth…………………………………………………………………………………………………………………………….….197
omremsetup…………………………………………………………………………………………………………………………….198
omresolve……………………………………………………………………………………………………………………………….200
ACCEPTUNKNOWN ………………………………………………………………………………………………………………….204
COPYBREAK ……………………………………………………………………………………………………………………………..204
DATATYPE …………………………………………………………………………………………………………………………….….204
FILEBREAK ………………………………………………………………………………………………………………………………..204
HOLDPRINTED ……………………………………………………………………………………………………………………….…205
LPDEST ……………………………………………………………………………………………………………………………………..205
LPDGRAPHICS …………………………………………………………………………………………………………………………..205
LPPATTR …………………………………………………………………………………………………………………………………...205
LPPAUTO …………………………………………………………………………………………………………………………………..206
LPPAUTOMODE ………………………………………………………………………………………………………………………...206
LPPCONFIRM ………………………………………………………………………………………………………………………...…..206
OMPLUSACK ……………………………………………………………………………………………………………………………...206
PRTCNTL …………………………………………………………………………………………………………………………………….207
PTPARENT ………………………………………………………………………………………………………………………………….207
SILENT……. ………………………………………………………………………………………………………………………………….207
VIEW80 ……………………………………………………………………………………………………………………………………...207
Page | 12
OM Plus Delivery Manager Administration Guide
VIEW132 …………………………………………………………………………………………………………………………208
Page | 13
OM Plus Delivery Manager Administration Guide
INTRODUCING OM PLUS DELIVERY MANAGER
OM Plus Delivery Manager, the document output management software solution from Plus Technologies, provides
advanced delivery and control of documents across complex network environments to multiple destination types.
These destination types include printers, fax systems, email systems, web sites and intranet sites. Additionally, OM
Plus Delivery Manager provides robust, streamlined destination management.
Companies depend on the creation and delivery of documents such as reports, checks, bills of lading, invoices and
pick tickets. Typically, these documents are then handed off by the business application to the operating system
for delivery (traditionally, to a printer). Unfortunately, operating systems, such as Windows, UNIX or Linux have
not been designed to handle the production delivery of documents across an enterprise. These operating system
limitations may impact company business and add unnecessary support costs.
Due to the limitations of existing operating systems, problems asrise with reliable and confirmed document
delivery, centralized management and control, document integration with electronic forms, and the supportability
of the entire enterprise’s document-delivery systems. Documents are lost, not delivered correctly or in a timely
manner, and customer satisfaction or business processes suffer.
OM Plus receives documents from a variety of systems in a variety of formats. It manages the reliable delivery of
the documents to multiple destination types including , printers, fax servers, email servers, Web sites, and Intranet
sites without any changes to the enterprise application. The application prints and OM Plus completes the rest.
Companies with large enterprise application implementations will create large volumes of documents. OM Plus is
designed to manage all aspects of the document delivery process within the enterprise and solve document
delivery problems.
OM Plus runs on all popular server operating systems including, commerical Microsoft, UNIX, and Linux/open-
source servers. OM Plus is designed to be robust, efficient, as well as simple to install and run. Installations take
less time than similar solutions because many of the functions are automated. This ease of installation and use is a
major difference from other enterprise management products. In most cases OM Plus does not require changes to
the host applications because it replaces or co-exists with the print subsystem of the operating system. When the
application calls the native spooling system it is really calling OM Plus. OM Plus is compliant with most ERP
applications, including SAP, PeopleSoft, Oracle, QAD and more. OM Plus is fully SAPTM R/3 certified.
OM Plus Delivery Manager
OM Plus provides advanced document delivery of enterprise documents. The wide-ranging document delivery
feature set includes:
• Integrated delivery to printers, fax servers, email servers, web sites and Intranet sites based document
data or other spool file information.
• Automatic routing of jobs to the backup server, if the primary server becomes unavailable.
• Automatic notification (email or pager notification or job re-routing) if destinations become disabled or if
job delivery fails (or other customer identified events).
• With many devices, OM Plus can provide advanced delivery confirmation, not just printer buffer
acceptance of data, but print function completion status.
• Scalable upward and downward (for example > 4000 destinations and hundreds of thousands of daily
print jobs on a single system).
• Comprehensive audit logs of every function and process involved in the print process involved in the print
process (logs also include information regarding destination use, individual and group accounting and
more).
• An open, easy-to-use client interface that reflects job and destination status on a single screen and
provides control with a rich tool set for administration.
• Security features to control end user access to functions, documents and devices (security can be set at
individual or group levels).
• Delayed print purging to enable re-printing of documents without having to re-create them from within
the application.
• Support for rich content documents including page range and next page capabilities.
P a g e 15 | 221
OM Plus Delivery Manager
EASE OF USE
OM Plus has multiple end user interfaces including a Client interface, Browser interface and terminal interface for
UNIX users.
The Client interface runs on any Java Runtime Environment (JRE)-capable computer and supports JRE 1.5 or higher.
The Browser interface allows access to the application from any browser.
There is a character-based (“green screen”) interface with list menus for UNIX terminals.
The Browser interface is available as an add-on application to OM Plus. For information, contact your Plus
Technologies Account Manager.
SERVER REQUIREMENTS
OM Plus Server supports Windows Server 2012 – 2019, as well as most commercial UNIX operating systems
including, Sun Solaris 8, 9, 10 and 11, HP-UX 11.x and greater, IBM AIX 5.1 and greater, Red Hat Enterprise Linux
version 7 and greater, Red Hat AS/ES 3.0 and greater open source operating systems an other comparable Linux
operating systems.
On Windows, the minimum system requirements are a 2+ GHz processor, with 4+ GB of RAM and 80+ GB of disk
space. Disk space requirements vary based on document volume and length of time before purging documents.
For UNIX, the minimum system requirements include 128MB of memory, a 500 MHz processor and 500 MB of disk
space, plus space for spool files. Disk space requirements vary based on document volume and length of time
before purging documents.
CLIENT REQUIREMENTS
The OM Plus Client supports Windows 7 and Windows 10. To ensure proper performance, install the OM Plus
Client on a computer/OS minimum requirements.
The OM Plus Client can also be installed on many Unix and Linux distributions with a graphical desktop.
OM Plus is a powerful yet user friendly output management software platform that system administrators can use
to manage printing, resolve problems and provide additional functionality to the output process. Users can also
use the system to manage their own output environment. OM Plus has complete security and is easy to integrate
into most systems to provide quick access and control of the output. OM Plus can also allow for the viewing of
requests, allow for rules or administrator to decide whether or not to print, to print select pages, cancel requests,
move requests to other destinations and more. In each case OM Plus can provide the power and ease of use
needed to manage any output environment.
P a g e 16 | 221
OM Plus Delivery Manager
With any new software product there is a learning curve to overcome before effectively using it. OM Plus was
made to be as easy-to-use and comprehensive as possible.
Installing OM Plus does not disturb current printing jobs. OM Plus is a separate delivery system that can be
configured to work entirely independently of the native spooling system. In many cases, OM Plus is configured to
work in conjunction to the native system.
The OMHOME and LPHOME environment variables, set by OM Plus, are very important to system operation.
OMHOME is used on Windows operating systems. LPHOME is used on UNIX and Linux operating systems. These
variables are set to the fully qualified path name of the folde or directory where OM Plus is installed.
If OM Plus is not installied in the default folder or directory, it can be located from the command line by issuing the
following:
Operating System Command
Windows echo %OMHOME%
UNIX echo $LPHOME
Throughout this guide will be references to these variables. These variables are interchangeable and represent the
default values listed for each operating system unless otherwise indicated. For example, if %OMHOME% is printed
for Windows, it is possible to replace it with $LPHOME for UNIX.
INSTALLING OM PLUS
INSTALLING ON WINDOWS
OM Plus can be installed on Windows Server 2008-2019, Windows 7 and Windows 10.
1. Navigate to the directory containing the OM Plus install file and execute it.
2. When prompted, select the folder to select the installation directory.
3. The installation will complete.
If the installation directory is changed, make sure there are no spaces in the path. For example, changing the folder
name to C:\Progam Files (with a space) would cause a problem.
P a g e 17 | 221
OM Plus Delivery Manager
• AdminServ
• lpdServ
• iSat
• iSATServ
• e2eServ
• ompLogServ
• omippServ
• ompServ
• RemoteServ
• omScanServ
• schedServ
• statusServ
• ommsemailclient
1. From the Windows Start menu, Plus Technologies OM Plus DM and then OM Plus DM Server.
P a g e 18 | 221
OM Plus Delivery Manager
The lpdServ is the OM Plus LPD listener. If it is not expected that this system will receive print jobs using this port, it
is not necessary to have this service running. Also, it is common to find the default LPD port (515) blocked by a
firewall or anti-virus or being used by the native Windows LPD Listener.
The iSat Client, Server and Scan Service will not start as part of the “Start All” function as typically, it is not needed.
OM Plus also makes changes to the Windows environment. For example, it adds the system environment variable,
OMHOME, which is the location of the OM Plus installation (the default is C:\plustech\omplus\server)
If an existing version of OM Plus is already installed on Windows and it is time to upgrade or install a new version,
the new version can be installed while retaining all the user definitions set in the existing version. To do this, the
services must first be stopped, and the existing version must be uninstalled using the following settings.
1. From the Windows Start menu, select Plus Technologies OM Plus DM and then OM Plus DM Server.
P a g e 19 | 221
OM Plus Delivery Manager
3. From the Windows Start menu, select Plus Technologies OM Plus DM and then uninstall OMPlus DM
Windows Server. The Uninstall screen appears.
4. Select Keep all user definitions (destinations, etc.), and then click Uninstall.
The OM Plus Server is no longer installed, but all user definitions remain intact.
5. Install the new version of OM Plus, and then restart all services. For installation information, refer to
installing on Windows.
INSTALLING ON UNIX/LINUX
OM Plus Delivery Manager can be installed on most commercial UNIX and Linux operating systems including, Sun
Solaris 8, 9 and 10, HP-UX 11.x and greater, IBM AIX 5.1, 5.2 and greater, Red Hat Enterprise Linux Version 7 and
greater, Red Hat AS/ES 3.0 and greater open source operating systems and other comparable Linux operating
systems.
The OM Plus Delivery Manager installation process uses the uncompress command. Please ensure that the
system is able to use this utility is installed or that a compatible utility has been linked in its place. To install
properly, you must be logged in as root.
./ominstall
4. To start services, type dccadmin > Services > Click Enter on the services to start
To ensure that the LPHOME environment variable is properly set you must log out and in again.
For information on the daemons associated with OM Plus, refer to the following table.
Daemons Description
Admin Server Performs administrative system functions. The client requires this to function correctly.
To run, issue the dccbkadm command.
LPD Server Recieves requests from other hosts using the LPD/LPR Protocol. To run, issue the
dcclpdser command.
Network Status Used for remote coomunication. The client requires this to function correctly. To run,
issue the dccbkst command.
P a g e 20 | 221
OM Plus Delivery Manager
OM Plus Server Receives requests from other OM Plus application. To run, issue the dccompser
command.
Scheduler Dispatches requests. OM Plus requires this to function correctly. To run, issue the
dccshed command.
Remote Service Transfer printer definitions between OM Plus Servers. This service must be started from
the command line by issuing the dccpingrem command. To stop it, the process must be
killed.
iSat Service Recieves requests via the OMGateway for remote iSats (internet print client).
IPP Service Recieves inbound IPP Procotol print jobs.
The OM Plus Interface and System-to-System communication relies on IP listeners. There must be clear network
communication for that functionality. In the event of an error please check firewall setting and make sure those
ports are not blocked.
The daemons can be set to execute automatically at boot time so the spooling services are automatically available.
To do this make symlinks in the rc startup and the init d directory.
To set the daemons to start at boot time, run the following command:
# dcclplink
For OM Plus to function properly, the environment variable LPHOME must be set to the base OM Plus directory
(for example, /usr/lpplus) and the path must contain an entry for the OM Plus applications (for example,
/usr/lpplus/bin). During the OM Plus installation, an entry is placed in the /etc/profile. To determine if the
environment is set to use OM Plus, from the command line, enter #env.
The following example appears displaying the env command output with the OM Plus variables indicated in bold.
HOME=/
HZ=100
LOGNAME=root
LPHOME=/usr/lpplus
LPPCONFIRM=
MAIL=/var/mail/root
NONAMESERVER=1
PATH=/sbin:/usr/sbin:/usr/bin:/etc:/usr/lpplus/bin
TERM=vt100
TERMCAP=/etc/termcap
P a g e 21 | 221
OM Plus Delivery Manager
TZ=EST5EDT
In addition to the environment varibles, OM Plus adds the following lines to the services file.
dccbkst 53971/tcp
OM Plus 53972/tcp
dcce2eser 53973/tcp
dccbkadm 53974/tcp
dccpingr 53975/tcp
If OM Plus is already installed on UNIX the new version can be installed while retaining all the user definitions set
in the existing version. To install over an existing version, first stop all services (daemons) and then install the new
version. To stop the daemons, run dccadmin and then from the services menu select the services to stop. For
information, refer to dccadmin. Once all daemons are stopped, procedd to installing to UNIX.
Before performing an update or in place re-install, be sure to back up the $LPHOME directory in order to be able to
restore the original installation in case of any unforeseen events.
P a g e 22 | 221
OM Plus Delivery Manager
INSTALLING ON WINDOWS
Execute the provided OM Plus DM Client installation file. The installation process will prompt for the location to
install to, default is C:\PlusTech\OMPlus\Client3\. After the files have been put in place, the installer will open a
configuration window to the “Hosts” tab. Enter the name of the OMPlus server or servers to connect to using the
“Add” button in the lower right, click “Save” in the lower left and then exit. The OM Plus Client installation is now
complete.
CONFIGURING ON WINDOWS
Configuring a destination in Windows consists of two parts, the second of which is optional. First, a destination
must be created and then, if desired , it may be linked to a Windows print queue.
The main advantage of “linking” to a Windows printer is that it allows native Windows applications to use
Windows default spooler to enter jobs into OM Plus. Also, it allows for easier printer sharing in a Windows
environment.
Even if a destination is linked to a Windows printer, jobs can be spooled directly to that destination using the
command line. Also, a destination may be linked to more than one Windows printer.
CREATING A DESTINATION
To configure the first OM Plus destination on Windows, Click on Windows Start Menu > Plus Technologies OM Plus
> OM Plus Administration > Destinations > Destination. The OM Plus Destination screen will be displayed.
To create a new destination, select “Destinations” under the host name you wish to create the destinations on and
then click “New” in the bottom left corner. A window will appear asking for a name and the type of destination to
be configured. Select a type and then input the required information.
For a first destination, Plus Technologies recommends using a Network Printer running in Raw TCP mode. The
address in this case can be the IP address or resolvable host name for printer and the port should be 9100. Once
this has been configured, select “Finish” to create the destination.
From the Windows Start Menu > Plus Technologies OM Plus DM > OM Plus DM Queue Linker
P a g e 23 | 221
OM Plus Delivery Manager
CONFIGURING ON UNIX/LINUX
2. Using the Enter key, from the Setup menu select Destination Configuration.
P a g e 24 | 221
OM Plus Delivery Manager
OM Plus Delivery Manager also uses the ncurses-libs.i686 library. This is not always included in 64 bit operating
systems. If you see a warning to this effect at this point, please install the library before continuing.
UNIX/LINUX Keyboard Tip: If you are connecting to a UNIX/LINUX system via a Terminal Emulator program (like
Putty or PowerTerm) then you may not have the correct key mapping. If that is true then you will not be able to
use the keyboard function keys. OM Plus will accept a combination of the control key and “f” followed by the
function number. (ex. hold down crtl and tap the “f” key like you’re doing a find command, then release and tap 3
to create an F3 command.)
The most common way to spool a request is to print to a Windows-defined printer. This is the printer linked to the
OM Plus destination that corresponds with where the requests is to be sent. This option is also available if the
Windows destination is a shared printer on another computer running OM Plus . For additional parameters, refer
to the dcclp command in Using the Command Reference.
Requests can be spooled to OM Plus from the command line by issuing the dcclp command with a -d [destination]
parameter. For example:
This causes the /etc/profile file to print to the destination defined for OM Plus, as firstprinter. For additional
parameters, refer to the dcclp command in Using the Command Reference.
If the LPD Server service is running, requests can be spooled to OM Plus by using the LPD/LPR Protocol. The target
is hostname:queuename, where hostname is the name of the computer running OM Plus, and queuename is the
OM Plus defined destination where the request should be delivered. For information, refer to the operating
system documentation.
P a g e 25 | 221
OM Plus Delivery Manager
OM Plus has a feature that can be used to link OM Plus to the native UNIX system. It is useful for legacy software
that uses UNIX spooling commands.
In order to just replace the native lp with OM Plus, run the lplinkonly command to copy the native lp program and
then link it to dcclp.
OM Plus also comes with a program that has the ability to link to the native LPR command. To do so, link from the
native LPR to $LPHOME/bin/dcclpr, and then use LPR.
It is imperative that you run dcclpunlink before performing and operating system upgrade. Failure to do so may
overwrite required OM Plus components. After the upgrade you may run dcclplink.
INSTALLATION
In Windows, execute the OMPlusDMClientInstall_x.x.x.xxxx.exe file. The installation process will prompt for the
location to install to, default is C:\PlusTech\OMPlus\Client3\. After the files have been put in place the installer
opens a configuration window to the “Hosts” tab. Enter the name of the OM Plus server or servers to connect to
using the “Add” button in the lower right, click “Save” in the lower left and then exit. The OM Plus DM Client
installation is now complete.
DESTINATIONS
CLASSES
Destination classes are groups of printers to which it is possible to spool collectively. In traditional load balancing
schemes, the printers receive jobs in a round robin fashion (Job 1 to printer 1, job 2 to printer 2, 3 to 3, 4 back to 1,
5 to 2, etc). While OM Plus typically follows this pattern, it will not send a job to a printer it knows to be currently
active, therefore accelerating printing by more evenly distributing the print jobs.
OM Plus also has the ability to determine which printers in a class have the correct forms mounted to them. This
would all a user or program to send multiple types of jobs to the same class but have OM Plus intelligently
distribute those jobs to the correct printers based on the forms mounts required by the documents.
P a g e 26 | 221
OM Plus Delivery Manager
Standard classes and members can be added and deleted. To access this component, from the OM Plus Control
Panel, click Classes. The following Class Maintenance screen appears.
ADDING A CLASS
A new standard class, which is a group of printers to which jobs can be collectively spooled, can be added.
Requests will be printed to the first available printer in this working group in a round robin fashion. A class cannot
be given the same name as a destination.
DELETING A CLASS
An existing standard class can be deleted when it is no longer desired to collectively spool to a group of printers.
A message appears asking for confirmation to delete the class and its contents.
2. Click Yes.
P a g e 27 | 221
OM Plus Delivery Manager
New destinations can be added to an existing standard class to enlarge the group of printers to which jobs can be
collectively spooled. The destination to add to a class must already be defined as a destination in OM Plus.
A destination can be deleted from an existing standard class in order to remove it from the group of printers to
which jobs are collectively spooled.
P a g e 28 | 221
OM Plus Delivery Manager
Destination management is one the most used functions of OM Plus. New destinations can be added and existing
destinations can be modified or deleted. To access this component, from the OM Plus Control Panel, click
Destination, and then the following OM Plus Destination Configuration screen appears.
The Destination Manager interface screen was created to allow quick and easy edition of OM Plus Destinations,
even in large numbers.
ADD
Click the “New” button in the lower left corner of the screen. The Add New Destination screen will appear.
Alternately, right click on “Destinations” beneath the host name and select “New” from the popup menu.
P a g e 29 | 221
OM Plus Delivery Manager
Input a name for this destination, then select the type for this destination. After clicking “Next” the window will
change to ask for more specific information depending on the category.
Note: Due to the ‘Destination Name’ being the key to the record, it is not possible to rename the destination. If you
change the name and save you will create a new destination. You will have to create the new destination and save
it, then delete the old destination. For this reason, OM Plus will not permit classes or destinations to have the same
name.
The destinations name from the previous will be brought over. The drop down menu for “Protocol” will display for
network printers, but will display “Type” for other groups. Similarly, the device configuration fields will change
depending on what is selected from the drop down. See “Device” below for more details on the options presented
in each case.
Of note, though, is the “Poll Mode” option. This option, when configured, allows the printer to be configured to
send jobs to a remote i-Sat print server. For more information on i-Sat and i-Sat Plus servers and devices, refer to
the i-Sat documentation.
P a g e 30 | 221
OM Plus Delivery Manager
Quick Product Reference: i-Sat is a solution for delivering print jobs to remote sites where reliable connections to
the printers cannot be guaranteed. When Poll Mode is enabled, a properly configured i-Sat server will connect to
the OM Plus DM server to retrieve the printer configuration and any jobs to be delivered to that printer. Since the
remote server is initiating the connection, this often is a more reliable solution for remote sites.
DELETE
Right click on the name of the destination to be deleted, then select “Delete”. A window will appear to confirm the
deletion.
CLONE
A destination can be copied or cloned. To do so, right click on the name of the destination, then select “Clone”. A
window will appear asking for the name of the new destination.
EDIT
Select the destination from the left hand side. The settings from that destination will load in the main panel.
SAVE HOST
To aid in defining destinations quickly and accurately in a distributed environment, OM Plus can save destinations
to multiple OM Plus servers at the same time. To do so, select multiple hosts from the “Hosts” drop down menu in
the upper left corner. Right click on each host name in the destination selection list and make sure “Save Host” is
checked. The hostname will turn green. Now, any, destinations created or edited here will be saved to all Save
Hosts.
DEVICE
RAW TCP
The destination takes data over a raw TCP connection. This can be used to communicate with terminal/printer
servers or laser printers with network interface. This is the preferred mode for printing to a remote network device
because of its simplicity and low overhead.
The address here should be the host name or IP address of the device. “Port” is the port number on which to
communicate with the device . Most devices will use port number 9100.
This is also the Mode used for the Print Confirmation. Please see PJL/MPCL Job Confirmation Types.
P a g e 31 | 221
OM Plus Delivery Manager
LPD/LPR
The network destination uses the LPD/LPR Transfer Protocol. Most network print devices support the LPD/LPR
Proctocol. The device for this destination type can be the host name, for example, hpjet18. Some destinations also
require a queue name. For the proper queue name, refer to the manufacturer’s documentation.
IPP (OUTBOUND)
The network destination uses the Internet Printing Protocol (IPP). Most network print devices support IPP. The
destination requires a URL.
Local modes are used for destination that do not require a transfer to another system. These include locally
attached printers, as well as processes.
DIRECTORY
The Destination Device field displays an existing directory for output. For example, a directory called /reports/save
for saving output requests with OM Plus. A tilde (“~”) character in the directory path expands to the user ID of the
submitting user, therefore, if the directory path is specified as /reports/~, requests that user Bob submits would be
written to /reports/Bob and reports that user Tom submits would be sent to /reports/Tom. By default, the file
name is the request name, RIDXXXXX. This may be overwritten by the -o file=filename request parameter.
Permissions on the destination directories should be set to prevent unauthorized user access to the contents. The
target directory must already exist; OM Plus will not create it.
BTPM QUEUE
This destination type is specifically designed to work with Bottomline’s eComIntergrate products. For more
information on configuring this device, please contact Bottomline.
This mode can be used for vendor-supplied software to route output requests. Some network terminal/print
server vendors supply software filters for the delivery system to use. There is usually a better OM Plus mode to use
instead of these filters. See Event Processing: Windows Events, pipe.bat.
REPORT BUNDLER
A queue designed to hold bundled requests until they are to be released to another destination. Reports
submitted to this type of destination will be saved and held until an acceptable trigger event causes them to be
released.
REPORT DISTRIBUTION
The destination connects to the Report Distributor pseudo-printer. Reports submitted to this type of destination
will be broken into sub-reports based on content. The sub-reports then spool as new OM Plus requests. The
P a g e 32 | 221
OM Plus Delivery Manager
Destination Device field is the path to a working directory for temporary files (for example, /tmp). See the section
on Report Distributor for more details.
VIRTUAL
The destination is generic process destination, used to provide an environment to a specific process. When a job is
sent to this Destination Type, it is de-spooled into a ‘User Filter’ process that provides the data to a process (script
/ program / utility) and returns that process exit code back to the OM Plus system.
The Destination Device field should contain the name of the Windows-defined printer to where the request should
be sent. For eample, an HP LaserJet 4 printer connected to the parallel port of the Windows print server and
defined to Windows as HPLJ4 would be configured in OM Plus using a windows mode and a device of “HPLJ4”.
PARALLEL (UNIX)
Used to connect to a destination attached to the local server through a parallel port.
A printer connected to server by a serial line. The device field should be the location of the serial port (eg,
/dev/term/tty006).
Note: Serial mode destinations assume a standard set of settings: 9600 baud, 7 data bits, 1 stop bit, even parity
and software flow control. In order to modify these settings, you must use the test based interface in the server.
STD OUT
OM Plus will output the result of the print steam to standard out which can then be routed to an executable
process for additional processing.
SERVER TO SERVER
These modes are used for connecting to remote systems, but not typically to print devices directly.
Note: Destinations using system-to-system modes do not honor the command parameters on the spooling system.
With the exception of the -h, which places a job on hold, all parameters pass to the remote system for handling.
Destinations using these modes do not determine the mounted form before thransferring to the remote system.
The form will be handled there.
OM PLUS LPD
Mode used to connect with a LPD Server. The server address and queue name must be given. “ex, legacy LP Plus,
Linux, and UNIX”
P a g e 33 | 221
OM Plus Delivery Manager
OM PLUS SERVER
Windows and UNIX. The destination is on a remote host system running OM Plus. This mode is used for passing
requests between OM Plus systems, features encrypted transport, End-To-End status, and status tracing. An
address and queue name must be specified.
FTP
The destination is a directory on a remote system. FTP Protocol can be used for the transfer. By default, the file
name for the transfer is the request name RIDxxxxx. This may be overwritten by the -o file=filename request
parameter. Enter the address, the target directory and the user name to use when connecting to this server. A “~”
character in remotedir expands to the user ID of the submitting user. If remotedir begins with a “/ ” it is treated as
an absolute path on the remote computer. If it does not, it is treated as a path relative to the home directory for
the login ID used for the transfer. If the user is not specified, it defaults to the ID used when submitting to OM Plus.
The $LPHOME/security/remotelogins file contains a table of host, user, and passwords for the FTP mode transfer.
On Unix, make sure this file has permissions set to 600 to avoid compromising the remote user IDs. For example,
ftp.somplace.com, someuser will transfer to the home directory of someuser.
The destination print queue on another host computer supports the LPD/LPR Protocol. The host can be a Windows
computer, UNIX system, Novell server, mainframe, or any other system that supports LPD/LPR printing. This mode
may also be appropriate for a network printer that spools to disk before printing. The server address must be given
along with a viable queue name on that device.
ELECTRONIC DELIVERY
This set of modes is used to send documents and notifications through other electronic means.
The print requests are routed to an email server using Blat (Windows) or Sendmail (Unix).
FAX
The print requests are routed to a fax server such as RightFax or VisiFax.
PAGER
TYPE
Type is used to link a Windows Print driver with a OM Plus Destination. In a properly configured system, OM Plus
will automatically create shared Windows print queues for devices defined with a type. For setting up types, see
Types configuration screen.
P a g e 34 | 221
OM Plus Delivery Manager
TIMERS
This is a collection of time out and maximums for the destination. In all cases but purge delay a value of “0” means
unlimited.
PURGE DELAY
Amount of time, in seconds, for a job to remain in the queue after cancellation or completion
WRITE TIMER
OPEN TIMER
The amount of time, in seconds, for OM Plus to open a connection to the destination.
CLOSE DELAY
The amount of time a connection is allowed to remain open after the close command has been sent.
** In streaming mode, this is the maximum amount of time allowed between jobs before the connection to the
destination is closed.
RETRY TIMER
P a g e 35 | 221
OM Plus Delivery Manager
TRANSMIT RATE
The speed at which jobs will be transferred to a destination. Mostly useful for legacy dot matrix type devices or
printers at remote sites with limited bandwidth.
The maximum number of pages a document can have and still printed on this device.
FAILOVER
This allows for a failover destination to be designated for this device. To set a device to use the included failover
logic, check the “Failover Error” box. If desired, select an alternate failover destination from the drop down menu
or select the original destination to retry jobs on this printer until successful.
MISCELLANEOUS
PRINT BANNER
Should the banner page be printed for request spooled to this device?
On some printers and for some print jobs a line feed will be indicated but not a carriage return, causing the job to
appear to have a “stair step” line of text off the right side of the page. This setting, when enabled, changes plain
line feeds into carriage return line feeds that will reset the test line to the left edge after each line.
P a g e 36 | 221
OM Plus Delivery Manager
Inserts a form feed at the end of each job if one is not already present.
Inserts a form feed at the end of each copy of a job if one is not already present.
HOLD DEFAULT
PURGE DEFAULT
DEFAULT FORM
The name of the form that, by default, is defined to this destination. For more information on forms, see Form
Maintenance.
CONTROL FILE
The full path name to a custom script to be used by this destination. The print job is delivered to the filter on
standard in and the job is returned using standard out. If the filter does not return anything on standard out, this is
a valid condition and OM Plus will accept that there is nothing further to process.
Determines whether the control file will be processed as part of the print job when the custom data filter is
executed.
NOTIFICATIONS
What user or group should be notified in case of an error with this device.
Useful for legacy devices that may not support all print stream, or for destinations that use scripting for processing
only certain types of data.
P a g e 37 | 221
OM Plus Delivery Manager
TAMPER RESISTANCE
Note: This field is interpreted by the model, make sure to use the latest model included with our software.
FREQUENCY
How often OM Plus should apply the Tamper Resistant Printing to jobs for a printer.
VERSION
MACRO
P a g e 38 | 221
OM Plus Delivery Manager
MY PRINT DELIVERY
TYPE
• Queue – Jobs are released by any authenticated user for a defined queue.
• User –Jobs are released by the authenticated user who created the job.
IP ADDRESS
The actual IP address that the requests will come from. For external card readers this is the card reader address.
For “embedded” solutions this should be the address of the printer.
HOLD QUEUE
Is the print queue that contains the jobs that can be released to this printer.
QUEUE LABEL
P a g e 39 | 221
OM Plus Delivery Manager
EXTENSIONS
Extensions can be used to configure custom parameters for a printer. These are used exclusively in custom
implemenations and should not be used without direction from Plus Technologies.
ADVANCED
The advanced tab provides a centralized list of some advanced features. Most of these settings are intended for
use by legacy or power users. In several places the functionality is duplicated in other screens (Mode, Device, PJL,
SNMP, etc) but some are unique to this screen.
MODEL
Models can be defined to provide additional functionality to the destination. This must be the name of an
executable script located in the models directoy.
SUPPORT
A comment field that can be used to give the name or contact information for a support technician.
TRANSLATE TABLE
Translation tables are used to substitute characters in the print stream. The translation table must be a specially
formatted file located in the “trans” folder.
PCAP
This is a print control file that will be inserted at the beginning of a print job. While some users still use these, in
most cases it is better and more efficient to use a different method.
Dynamic destination classes function the same as standard classes, with the major exception being that users in
the security group assigned to the dynamic class can change destinations in the class. In addition, unlike a standard
class a dynamic class can belong to only one security group. To access this component, from the OM Plus Control
Panel, double-click Dynamic Class Maintenance, and then the Dynamic Class Maintenance screen appears.
GROUP MAINTENANCE
The Request Status screen may use destination groups to refine its data. For example, with anything more than
thirty destinations defined, it can be difficult to find a particular printer in the list. Printers can be grouped by type
of printer (color, directory, or laser), location (southeast or northwest), or floor and a printer can be assigned to
more than one group. To access this component, from the OM Plus Administration, double-click Group
Maintenance, and then the following Group Maintenance screen appears.
Note: Destinations must be added to the group before using them in the status menus. When using the Lookup
menu on the Request Status screen, select Groups to view the defined groups.
P a g e 40 | 221
OM Plus Delivery Manager
ADDING A GROUP
Add a group to narrow the search for a printer in the Request Status screen. A group can be defined based on type
of printer, location, or floor and it is possible to assign a printer to more than one group.
DELETING A GROUP
A group can be deleted when it is no longer needed. For example, if groups were defined by floor, and there were
no longer printers on a particular floor, the group for that floor could be deleted.
A message appears to confirm the deletion of the group and its contents.
2. Click Yes.
Destinations are added to an existing group to narrow the search for a particular printer. For example, new color
printers could be added to the Group “Color”. A printer can be assigned to more than one group.
Note: The destination to add to a group must already be a defined destination in OM Plus.
P a g e 41 | 221
OM Plus Delivery Manager
Destinations can be deleted from a group when the printer is retired, or when it is longer needed to appear on the
Request Status screen in a particular group. To do this, select the group destination to delete, and then click Delete
Member. The destination no longer appears in the list.
P a g e 42 | 221
OM Plus Delivery Manager
TYPES
This screen is used to define the drivers to be used with different types of printers. For setting a printer type, see
Types in the destination configuration screen.
The first field should be a one word description of the device type. The second field should be the exact name
precisely as it appears in the driver list on the target Windows server.
i-SAT
The i-Sat interface provides an additional means of managing printers defined to different remote i-Sat units. This
can also be done on an individual destination basis through the “poll mode” field on the destination configuration
screen.
P a g e 43 | 221
OM Plus Delivery Manager
To create a new i-Sat, Select File > Add i-Sat. A dialog box will appear asking for the name of the new i-Sat.
REMOVING AN i-SAT
To remove an i-Sat, select the i-Sat in the tree and select File > Remove i-Sat. Click “yes” to remove.
To add a device to i-Sat, open the OMPlus Control Panel and create a new destination. Enter a Destination name
and select Network Printer then click Next. Enter the IP address and check the checkbox next to Poll Mode.
To remove a device in i-Sat, Open the OM Plus Administration and select a destination that was added to i-Sat.
Enter uncheck the checkbox next to Poll Mode.
PUSH UPDATE
Select the button, this will force the OM Plus server to update the remote i-Sat with a list of destinations that
should be defined on that system.
REQUEST LOG
Select the button, this will display a copy of the log for the selected i-Sat on the local machine. This process
can be very useful for remote troubleshooting.
P a g e 44 | 221
OM Plus Delivery Manager
NOTIFICATION ADDRESS
This tool allows notification addresses to be entered. This is used to mask the true email addresses for users or
distribution groups that will be receiving emails from the OM Plus system.
To add a new address, select “Add Address” from the command menu. To remove an address, select the address
then select “Delete Address” from the command menu.
This tool is designed to be used with EPIC EMR systems. It is meant to configure a list of options for Epic Print
Records that can be passed to an EPIC Transform Server. Unless the client is configured to allow it, this screen will
not appear on most OM Plus installations.
P a g e 45 | 221
OM Plus Delivery Manager
HOST
The host name where the OM Plus print queue wil be defined. These are typically the same as the host name
where this configuration file is created, but special cases can arise where a different server should be used to
deliver jobs to a specific printer. This field can be used to direct traffic in that way.
FILTER
A text based filter for quickly finding EPR or OM Plus queues in the table.
EPR QUEUE
OM PLUS QUEUE
The name of the OM Plus queue that will handle delivery of the print job.
PRINTER TYPE
With the Types screen, this will define that print driver that should be used to render the job on the transformer
Server. This field will be passed to the Transform Server and a Windows queue for that driver will be created to
render the job ready for print on the Transform Server before tranferring it to the host specified in the first field.
TRAY
SIMPLE / DUPLEX
PAPER SIZE
The size of the sheet that should be used for this EPR.
MEDIA TYPE
P a g e 46 | 221
OM Plus Delivery Manager
FILE COMMANDS
REMOVE RECORD
IMPORT RECORDS
Allows a .cvs of EPR records to be imported into the system. For proper formatting, please contact OM Plus
support.
SYSTEM
ADVANCED FORMS
An Advanced Form in OM Plus has a specific and useful utility. With an Advanced Form attached to an OM Plus
data stream, that data stream can be split and redirected to any number of other OM Plus Destinations. The split
can be equal or in blocks of hundreds, ot the data stream can be kept whole.
Advanced forms can be added, modified, or deleted in the Client Interface. To access this component, from the
OM Plus Control Panel, double-click Advanced Forms, and then the following Advanced Forms screen appears.
The Advanced Form can have a number of uses. Its given use is to split a data stream to a number of destinations,
but by setting the ‘Type’ to ‘all’ it is possible to send entire copies of the data stream to a number of different
Destinations. This is often used as a distribution list.
Only the OM Plus Data streams noted as simple, PCL-1 or Post-DSC can be split using an Advanced Form. For more
information, see Data Types.
P a g e 47 | 221
OM Plus Delivery Manager
An existing form can be updated and saved with another name by selecting the form, and then from the File menu,
selecting Save As.
An existing form can be deleted by selecting the form, and then from the File menu, selecting Delete.
LINES
Enter the lines per page, which is used for page counting purposes only. OM Plus counts pages by counting form
feeds, if present in the output job, or by counting the number of lines until it reaches the lines per page value. OM
Plus will NOT insert form feed characters into the data after the line per page value.
PURGE
Select whether or not to spool the original output job and separate the segments. When an advanced form is used,
the output job that initially spools can be optionally printed along with any segments, or removed after all
segments of the advanced form spool. Setting the Purge column to Y deletes the initially spooled report without
printing. This option would be used so that a complete copy of the intial report is not printed in addition to its
separate components as defined by the form.
DESTINATION
P a g e 48 | 221
OM Plus Delivery Manager
The fprint program options that may appear if an electronic form file is selected.
FORMS
Which standard form to use with a segment. The default is the form for the segments print destination.
TYPE
View the section of the original spooled output job to send to this segment.
ALL
Delivers the document to multiple destinations, and each destination recieves a complete copy of the report.
SPLIT
Sends an equal amount of the original output job to this segment. For example, if there are three segments, the
original output job is split into thirds.
NUMBER OF PAGES
Specifies the number of pages this destination should accept for each segment. For example, if the goal is to send
100 pages to segment one, 50 pages to segement two, and 150 pages to segment three, the parameters would be
100, 50, and 150 respectively. If the spool file contains more pages than specified for the total number of
segments, the last segment recieves all the additional pages.
FORMS MAINTENANCE
OM Plus uses the form name associated with an output job to ensure the correct paper is loaded in the destination
before printing. The form name for the output job must match the form mounted on the destination, which is
usually set when the job spools by using the -f form_name command option of dcclp.
For example, when accounts payable wants to print checks and use special check paper or special micro toner
cartridges, the check output job would spool using the form name “checks” and when the checks out job is
submitted it will not print until the correct paper or toner is loaded in the printer. By mounting the form checks on
the destination through OM Plus before loading the new paper in the destination, all other output jobs in the
destinations queue not needing the form checks are held while the check job prints. When the check job
completes, stock (default paper) can be returned to the destination and the form that was on the destination
before the check job can be mounted.
P a g e 49 | 221
OM Plus Delivery Manager
Note: If either LPPlus or OM Plus is the destination mode indicating a transfer to a remote system, the form ID
passes to the remote system. Transfers take effect immediately, therefore ignoring the currently mounted form.
System mode will also transfer the request immediately, but the form ID is not passed.
• Standard Forms: Ensures that the correct paper is loaded in the destination and sends a download file to
the destination before the output job.
• Advanced Forms: De-spools to multiple locations, divides a report equally over multiple destinations, or
divides a report based on a preset number of pages per section.
To access this component, from the OM Plus Administration, System double-click Forms, and then the following
Form Definition screen appears.
Standard forms can be added, modified or deleted to ensure the correct form is loaded for the output job.
CREATING FORMS
MODIFYING FORMS
To modify existing forms, select the form from the Form Name field, make changes, and then click Save. When a
message appears indicating the form is updated, click OK.
P a g e 50 | 221
OM Plus Delivery Manager
DELETING FORMS
Select the form from the Form Name field, and then from the File menu, select Delete. When a message appears
to confirm the deletion of the form, click Yes.
FIELDS
FORM NAME
Select an existing name, or enter a name for a new form. Assign the form a functional name (for example, checks
or PO). The form will be referenced by this name on the spooling command line or from the request status screen.
MOUNT REQUIRED
Does this form need mounted to the printer before a request can print. Operator intervention may or may not be
required for mounting forms. If “N” is selected, any spooled file requesting this form will automatically de-spool
regardless of the form mounted on the destination. If “Y” is selected then a request will only de-spool if the form
mounted in the selected destination matches this form. Otherwise the request is marked with a status of “fpend”.
See the ‘fpend’ event script, under the ‘Using Event Processing’ section of this manual.
Enter the value to use for page counting purposes. On some data types, OM Plus counts pages by counting form
feeds, if present in the output job, or by counting the number of lines until it reaches the lines per page value. In
the example, the check contains 22 lines per page. If this is not set correctly, the number of pages OM Plus counts
will differ from the number of pages that print.
If set to ‘Y’, a copy of the file name in the Copy Download File From Host File field is sent to the destination before
the output job. If set to ‘N’, the download file is not sent.
Indicate to allow the form file (if a true electronic form) to exist for Windows in the
%OMHOME%\form\<FORMNAME> folder and for UNIX in the $LPHOME/form/<FORMNAME> directory with the
required filename downloaded. This file was created the first time the form was a defined from this screen. The
Client allows the downloaded file to be updated from a more recent or another file on the computer by selecting
this option. The Character-based interface requires the form to be deleted and re-added to update the
downloaded file.
If set to ‘Y’, a copy of the file name in the Copy Download File From Host File field is sent to the destination after
the output job. If set to ‘N’, the download file is not sent.
P a g e 51 | 221
OM Plus Delivery Manager
COPY POSTLOAD FILE FROM HOST FILE
Indicate if this file, if similar to the downloaded file, should allow for resetting of the destination after de-spooling
with this form. Selecting this option allows for Windows %OMHOME%\form\<FORMNAME>\ postload and UNIX
$LPHOME/forms/<FORMNAME>/postload file to be updated without deleting and re-adding the form.
For OM Plus on UNIX, there is a built in health check to determine the status of the installation and confirm that it
is operating properly. To access this component, from the OM Plus Administration, double-check Health Check and
a prompt appears asking for the host to check and whether to automatically fix any issues. Regretfully, some
issues, such as file permissions, cannot be fixed with this process.
Plus Technologies support representatives may ask for this command to be executed and for any error messages
that appear to be relayed in order to help resolve problems.
See the section Configuring Mutltiple OM Plus Installations in a Distributed Environment for more information
about this feature.
P a g e 52 | 221
OM Plus Delivery Manager
REGISTRATION STATUS
From the OM Plus Administration, click Registration Status, and then the following System Registration Status
screen appears.
Note: If you are moving an OM Plus installation from one computer to another, contact Plus Technologies Supoort
so they can create a new registration key for you.
HOSTS
TRP
P a g e 53 | 221
OM Plus Delivery Manager
See the section on R3/SAP Interface for more information about feature.
The RID spans system is used to limit the range of RID numbers that a particular OM Plus server will use. When
multiple servers are to be set up to use this system one of the OM Plus servers must be designated the span host.
This is done by putting that host’s own name in the Span Host field.
Add a line containing host, starting RID, and ending RID for each OM Plus server in the enterprise. Starting RIDs
must be larger than ending RIDs. Ranges cannot overlap. The minimum range is 500, but it is highly recommended
that the range be greater than the maximum number of requests allowed on that system (See System Defaults).
The system that is the Span Host is the only system that needs to be set up using this utility. Periodically the Span
Host will publish the current file to all of the system listed. If a server that is not the Span Host is updated, the
changes will be lost as soon as the real Span Host publishes its list.
P a g e 54 | 221
OM Plus Delivery Manager
SYSTEM SETTINGS
The System Default component is similar to the Client Configuration component, except that it is used for the OM
Plus Server. The settings include parameters that the OM Plus Server uses to operate. To access this component,
from the OM Plus Administration, click System, System Settings and then the following System Default screen
appears.
Note: The ‘Maximum Requests’ and ‘Maximum Dests’ are important sections in system tuning. If the Maximum
Dest field is not set to greater than the license number of destinations, you will not be able to use that maximum
number. If the ‘Maximum Requests’ are not set to exceed the number that would be expected to be listed in the
“Status Screen” at a given time, the jobs exceeding that number will not de-spool.
SYSTEM DEFAULTS
1. From the System Defaults screen, change the default options, as needed.
2. Click Save
P a g e 55 | 221
OM Plus Delivery Manager
Stand Alone: Is a server that runs alone and is not part of a group.
Primary Server: Is a server that acts as the first source for data and responds to queries.
Maximum Destinations: Enter the maximum number of destinations that will be defined on this system.
Maximum Virtual Dests: Enter the maximum number of virtual destinations that will need. (minimum of 3)
Maximum Jobs: The number of concurrent requests (printed, interrupted, or otherwise) for which to reserve
memory.
Default Printer: Select the destination to send spool requests if not destination is psecified on the spool command
line.
Accounting: Select whether or not OM Plus will write records to the acctlog file each time a requests de-spools.
Track Parent / Child: Should OM Plus keep track of any parent/child relationships between requests.
Hold Jobs: Select a global setting to ensure that all requests spooling to OM Plus spool with a Hold status.
Purge Jobs: Select whether or not to set all requests to purge automatically.
Require Form Mounts: Require that the form specified by the job matches the form mounted to the destination.
Message Queue Keys (Linux/UNIX Only): These are the keys that UNIX uses for identifying OM Plus message
queues. These values should only be changed at the request of a Plus Technologies support person.
P a g e 56 | 221
OM Plus Delivery Manager
DESTINATION DEFAULTS
Note: Changing the values of these settings does not change the values of any destination that has already been
defined. Only newly added destinations will be affected.
Fail-Over Requests: Will a new destination automatically fail over to a defined alternate destination?
Purge Jobs: Will jobs sent to a new destination purge after completion by default?
Hold Jobs: Will jobs sent to a new destination be held for release by default?
Open Time: Enter the number of seconds OM Plus will use to try and open a connection to a network device.
Write Time: Enter the number of seconds OM Plus requires to try to write data to a destination before marking the
request interrupted and disabling the destination. A successful write to the destination resets this timer.
Purge Delay: Enter the amount of time in seconds to keep a printed request before purging or archiving it. It has a
value range of 0-99999.
P a g e 57 | 221
OM Plus Delivery Manager
Close Delay: Enter the number of seconds OM Plus holds the connection to this device open to allow it to flush its
buffers.
Metering (CPS): Enter the number of characters per second to transfer to the target device. This is useful if there is
limited bandwidth.
Type: The default type to use when creating a new device. For more information, see Types.
Interface Model: This setting is what model to use for a printers interface script. Most implementation use the
model that the system selects based on the destinations’s mode.
Default Form: Which form to use as the default for a new destination. A request will default to the form specified
for its destination unless a different one is specified on the command line.
Default Print Control: Which print control to use by default on a new device.
File Break: Should OM Plus append a form feed at the end of each request. To always add a form feed, select
“always.” To add a form feed only when one is not detected, select “conditional.”
Filter Program: Indicates the default user filter for a new destination.
Translation Table: Which translation table to use by default with a newly defined destination. These tables will
translate one sharacter into another. They will not translate strings.
Support Person: Indicates the default support person for a new destination.
Notifications: The default email address to notify in case of problems with a device.
Line Feed Convert: Should the OM Plus convert all line feeds to carriage return line feed.
Copy Break: Select whether or not to append a form feed between each copy in a request.
Filter Control File: Should the control file be added to the job before or after processing through a user filter?
PDF Capable: Should a new device be assumed to be capable of printing a PDF file?
Banner Page: Should an OM Plus banner page print before each request.
EXTENSIONS
This screen can be used to define a set of Extensions to pass on to any newly created destination. These can be
used to configure additional functionality as needed for custom solutions.
P a g e 58 | 221
OM Plus Delivery Manager
SYSTEM STATUS
The System Information component can be used to provide a summary of information about the OM Plus system.
To access this component, from the OM Plus Administration, click System Tab, click System Status and then the
following System Information screen appears.
This screen is informational only. It can be very helpful for problem resolutions as it shows disk space and number
of destinations defined. OM Plus support may ask for version number from this screen.
P a g e 59 | 221
OM Plus Delivery Manager
CLIENT
CLIENT SETTINGS
It is possible to establish standards for the interface installation that will not impact the Server settings or installs
of the interface on other computers.
HOSTS
The OM Plus client can connect to multiple servers in a distributed printing environment. These hosts can be
added and managed through this screen. To add a new host to the list, select “Add” and then input the host name
for that server. To remove a server, select it and then click “Remove.”
To select which servers the client will automatically connect to on startup, make sure a check is present in the box
to the left of the of the host name for each desired server.
For large implementations with multiple servers, the “Use Host Selection Dialog” option is provided. This will
present a selectable list of servers rather than the drop down menu. This option will automatically be enabled for
clients connecting to more than 15 OM Plus servers.
For all changes to be finalized, they must be saved using the “Save” button in the lower left corner.
P a g e 60 | 221
OM Plus Delivery Manager
OPTIONS
AUTO UPDATE
The time, in seconds, that will elapse between updates when auto update is turned on. The minimum value is 5.
When sorting requests, child requests will be grouped with their parent requests. This is helpful in seeing a family
tree of requests if the system has spooled requests in between the parent and child requests.
If this box is checked, the “Epic Print Records” tool will be selectable in the OM Plus Administration screen.
The number of requests the client will display in the status screen. More lines will use more memory, but the
effect is not substantial.
If different language files have been installed for the GUI, this provides the option for selecting those files.
INITIAL CONNECTION
The amount of time, in seconds, for the client to attempt to connect to the server.
INITIAL CONNECTION
The amount of time, in seconds, for the client to attempt to connect to the server.
RECORD PREFERENCES
When should OM Plus record the changes made to the request status screen?
TRANSACTION
The amount of time, in seconds, the client will wait while attempting to communicate with the server.
STATUS SERVICE
P a g e 61 | 221
OM Plus Delivery Manager
ADMIN SERVICE
VIEWERS
On this page, the viewers used by different file types can be deined. OM Plus included a viewer for some PCL types,
but additional third party viewers may be required for other types. This field must contain a fully qualified path to
the desired viewer.
P a g e 62 | 221
OM Plus Delivery Manager
SECURITY
With so much functionality and ease of access with printing reports, security in OM Plus becomes more of an issue
than with standard Windows spooling or UNIX lp systems.
OM Plus security usues destination permissions models and groups of users. If the user does not appear in the
security system, they will be assigned to the “guest” group and assigned the privileges given to that group. When
OM Plus is first installed, the default permissions model allows unrestricted use. If a user is added to the security
system, that user can only access destinations to which their group is assigned and only perform functions in the
permissions model applied to the destinations. A user can only be in one security group at a time, but a group can
consist of one or many users.
Before attempting to set up security, Plus Technologies recommends that note is taken of each user, the
destinations to which they need access, the functions they need to perform, and any other users, if any, with
similar needs. It will then be possible to apply this information to OM Plus security. We also recommend backing
up the “security” folder in the OM Plus installation directory before any modifications to secuirty roles in order to
provide a working environment that can be restored easily in case of an unintended lock out.
For information on the applications and their functions, refer to the following table:
Tab Function
Hosts/Domain Displays the users from remote computers that are associated with a local user.
Groups Displays the name of the group, the destinations in the group, and the security models
that apply to each destination.
Logins Displays the login IDs that are associated with a local user. This is used primarily with the
HTML interface.
Models Displays the name of the model and the permission levels to which it is associated.
User List Displays the local users and the group to which they are assigned.
Group Maintenance is used to group the OM Plus users that have common destination and access needs. A
permissions model is applied to each destination.
To set up security groups, complete these tasks in the order they appear.
P a g e 63 | 221
OM Plus Delivery Manager
OM Plus security uses permission models to determine the rights a user has to a destination and the jobs spooled
to that destination.
From the OM Plus Security Maintenance tab, select Model to determine the level of access desired for this model,
per item.
Note: The “Status” option determines which requests a user can see in the Request Status screen. “View”
determines whether or not the user may view the request in one of the viewers.
Information on the other request actions can be found in the Request Actions section.
For information about the access levels and their descriptions, refer to the following table.
Access (Windows) Access (UNIX) Description
None 0 = No Access Cannot perform the function.
Owner 1 = User Access Can perform the function only if the user owns the output
job.
Security Group 2 = Group Access Can perform the function only if the user or another group
member owns the output job.
All 3 = Unrestricted Access Can perform the function regardless of job ownership.
Once the permissions model is saved it can be applied to a destination when defining groups of users in Group
Maintenance.
Note: User access means it is possible to perform the action on requests belonging to the user ID. Group access
means group members can only perform the action on requests belonging to their group ID.
We recommend that you set up a permission model for users and one for administrators.
P a g e 64 | 221
OM Plus Delivery Manager
Group Maintenance is used to group OM Plus users that have common destination and access needs. A
permissions model is applied to each destination.
1. From the OM Plus Security Groups screen file menu, select “New Group”.
2. In the Enter New Group Name field, enter the new group name, and then click OK.
The new group name is now available in the Security Group drop down menu.
After adding a group, one must add destinations to the security group, and then assign the proper permissions
model to the destination.
Note: Once you add all the destinations to the group, it is possible to add user. Users can only belong to one group.
OM Plus uses the name you enter. If you are on UNIX, the name should match the login user ID to the host on which
OM Plus is installed.
P a g e 65 | 221
OM Plus Delivery Manager
1. From the OM Plus Security Group screen, select “Add” from the bottom Destination and Models pane.
3. Select the permission model this group should use for this destination, and then click OK.
P a g e 66 | 221
OM Plus Delivery Manager
A group of printers can be added by clicking the printer icon in the lower left. This will bring up a group selection
screen.
Selecting a group and model will add all printers in that group to this security group.
None: Users may not use any of the printer level or server level functions in OM Plus.
Printer Admin: Users may use printer level functions of OM Plus (adding or removing destinations, changing
destination settings, etc) but not any of the server level functions of OM Plus.
System Admin: Users may use printer and system level functions in OM Plus but may not edit the security profiles.
P a g e 67 | 221
OM Plus Delivery Manager
Local, remote, and login users can be added to a group, but first local users must be added. If a user is added to the
securty system, that user can only access destinations to which their group is assigned and only perform functions
in the permissions model applied to the destinations. A user can only be in one security group at a time, but a
group can consist of one or many users. OM Plus uses the name entered. In UNIX, the name should match the
login user ID to the host on which OM Plus is installed. For information on adding remote and login users, refer to
Adding Remote Users and Adding Login Users.
Note: Users cannot be added to the group “guest” as this is the default group for any unresolved users.
P a g e 68 | 221
OM Plus Delivery Manager
When a spool request comes in from another host system, either via LPD or a linked Windows printer, OM Plus will
attempt to resolve a ‘local’ user name so that it can apply security measures. Remote users are how this is done. If
a request comes in and a local user is not resolved, the request will get whatever the permissions the ‘guest’
security group has.
Remote user are also used to resolve command requests from the OM Plus Client. The client will send the user
name that is logged in to the client system and the host name (or Windows domain name) of that system
whenever it processes a command. Again, if there is no resolved local user, the security permissions will be as the
‘guest’ group.
The local user will be resolved from the combination of what host the remote request came from and what the
user ID from that host was given. For computers connected to a Windows domain, the Host will be the base
domain name (as stored in the USERDOMAIN environment variable).
1. From the OM Plus Security Maintenance Host/Domain screen Click Add User (bottom left button) to
define a remote user to correspond with a pre-defined local user.
2. In the Host/Domain, enter the hostname, IP address, or Windows domain name of the computer on
which the user will work. If an asterisk character (*) is entered in this field, the local user will be resolved
based only on the remote user name.
3. In the User ID field, enter the name the user will enter when logging into the remote system or Domain. If
an asterisk character (*) is entered in this field, the system will not care what the user ID was. It will apply
the local user field to all users ID’s from the associted domain.
4. In the Resolved User field, enter the name of the user to associate, as it appears on the User List tab, and
then click OK. If an asterisk character (*) is entered in this field, the system will use whatever Remote
Users was sent by the system as the local user name.
If an asterisk is put in both the Remote User and Local User Fields, the system will use as the local user the user ID
that the user logged into their session with. They can then be added to the Security groups by their operating
system login ID.
P a g e 69 | 221
OM Plus Delivery Manager
USER LIST
The user list screen is designed to provide a quicker tool for identifying and modifying users and their groups.
Clicking on the headers allows the list to be sorted based on either the group or user name.
In addition, the users list can be edited from this screen. To edit an existing user or users, select the desired users
and then right click and select “Change Group.” A dialog box will appear asking for the new group.
To delete users using this screen, select the users and then right click and select “Delete User.”
This screen also provides two ways to add users to the list. The first is to right click and select “Add User.” A dialog
will appear asking for the user name and the group to which they should be assigned.
The second method is to perform a batch load. This can be especially useful if loading a large number of users at
once. Select “Batch Load” from the Commands menu. An open file dialog will appear. From there, select a comma
separated file that contains the user names and group names to be added to the users list. After selecting a file, a
dialog will appear with two options. To add the new users select “Add/Update.” To clear out the current list and
use only the names in the new list, select “Replace All.”
Note: Be careful when modifying the users list. If you remove your own name from the list or otherwise exclude
yourself from an administrative group you can effectively lock yourself out of the system. OM Plus will attempt to
warn you if this is about to happen, but there are still ways a determined user can circumvent these measures. If
this happens, contact another administrative user or, if there is not one, please contact Plus Technologies support.
P a g e 70 | 221
OM Plus Delivery Manager
The Logins screen makes it possible to set up the user name and password to associate with a specific local user
user ID. This is primarily used for the web interface. If OM Plus recognizes the user name and password upon login,
it uses the local user to which it is associated and not the remote ID.
1. From the OM Plus Security Users screen select Add to add a login user.
2. In the available fields, enter the login user name, the resolved user name, password, and then click OK.
When a user submits a job, OM Plus checks the user ID that is associated with the request and verifies that the
user has permissions to the destination and to the options they selected. If they do, the request proceeds
normally. If they do not, OM Plus rejects the request.
As of OM Plus version 2.6.1, security profiles and settings can be broadcast and synched between OM Plus servers.
For information and training on configuring these settings, please contact OM Plus support.
P a g e 71 | 221
OM Plus Delivery Manager
The most commonly used component of the Client is the Request Status screen. From this screen, it is possible to
view the status of and modify all requests and destinations. To access these components, from the OM Plus
Administration, select the Status tab, click Request Status, and the following OM Plus Request screen appears.
OM Plus indicates the Host and Destination status by color, and the Request status via text in the Stat field.
Requests sometimes change color, thus indicating a status alert.
The Request Status screen that appears in the Client differs from the screens in the Character-based and Browser
interfaces in the following ways.
In the Client, it is possible to view both the request and queue status, which means it is not necessary to have to
access another screen to view or change the status of a destination queue. Text for a host, request, or queue
appears as bold or in color to indicate its status.
P a g e 72 | 221
OM Plus Delivery Manager
Warning: When destinations are rejecting, data may be lost. Make sure the application checks for this condition.
In several of the Client components a Hosts menu appears. There are two types of these menus, Absolute and
Concurrent. In the Absolute menu, a list of hosts defined in the configuration appears. Selecting a host removes
the previous selection. It is to use this in areas where one is working with one host at a time and is the more
prevalent of the two menus. The Concurrent menu makes it possible to select more than one host at a time. It is
used primarily on the Request Status Screen.
SORTING REQUESTS
The requests showing on the current screen can be sorted by a specific column by double-clicking on the column
header. This will sort on that column in ascending order. Double click again for descending order.
If the column selected is the RID column, then a dialog displaying sorting options will be presented. The sort
sequence is whether to sort the RID number in ascending or descending order. The Display Children option is
where to sort child request in the system. If the ‘With Parent’ option is selected, a request will have a ‘P’ next to
the RID Number if it is a parent and a ‘C’ next to it if it is a child. If a request is both a parent and a child it will have
a ‘PC’ next to it. Parent and Child RID numbers will be displayed a bold.
P a g e 73 | 221
OM Plus Delivery Manager
VIEWING REQUESTS
Before jobs can be viewed the appropriate viewer for the data type must be configured in the Client Configuration
screen. OM Plus includes a viewer that can display PCL, Postscript, and other type of documents such as simple,
PDF graphics, etc. For these data types, OM Plus defaults to the DccView (our File View) viewer. To view in the
Request Status window, from the Request Cmds menu, select View Requests.
Note: When in the File View Window, placing the cursor on a character shows a row/column location. This useful
for determining locations for Report Distributor.
DccView displays the data one page at a time. Use the following options to view, locate, and print specific
information.
• On the DccView screen, click Next Page to move to the next page or Previous Page to return to the
previous page
• From the Commands menu, select Find to specify a search.
• From the Commands menu, select Find Next to move to the next instance of the searched item.
• From the Commands menu, Select GoTo Page to jump to a specific page.
• From the Commands menu, Select Print to specify a new range of pages.
P a g e 74 | 221
OM Plus Delivery Manager
It is possible to view the details of any request status and destination by double-clicking the specific request or
destination. Double-click a request and a screen similar to the following appears.
Note: To view this screen from the Character-based interface, on the Request Status screen, select Request Status
Detail Screen, or on the keyboard, press i
P a g e 75 | 221
OM Plus Delivery Manager
Request statuses appear in the Stat field. For information on the status messages and their definitions, refer to the
following table.
Status Definition
activ Output request is de-spooling or being transferred to another host.
busy Queue file for this output request is in use by another OMPlus application.
can Output request is canceled and after the pruge delay time, will be removed from the queues.
cmplt Request for an OMPlus mode destination completed successfully. A parent RID whose children
have all finished printing.
faild Fax or email report failed.
faxed Fax has been sent.
fpend Request is waiting for the proper form to be mounted on the destination.
held Output request is on hold.
intrd Output request failed while spooling or de-spooling (printing).
maild Email report was delivered to the email subsystem.
partl Group fax has been partially sent (some faxes failed). Look at the fax status to determine which
failed.
A parent RID whose children have not all finished printing.
printd Output request has de-spooled successfully.
proc Output request is processing.
“proc” usually indicates a status change is occuring.
purg Output request has been purged from the queue system.
ready Output request is ready to de-spool.
retry On UNIX this state occurs if the OM Plus server has not been able to get a connection or write to
the device for more than 30 seconds. On a Windows server the amount of time can be configured
in the Timeouts settings of the main server interface (not the Client).
“retry” can occur if the destination is off-line when OM Plus tries to de-spool.
sent Report has been sent to an OMPlus or fax mode destination and the final result is not yet known.
spool Output request is spooling (moving into the queue).
susp Output request has been suspended and must be released to de-spool.
timed Output request is set to de-spool at a future date and time.
The future date and time can be seen from the output requests detailed information.
xfer Output request has been transferred to another host over the network or to disk.
2big Report contains more pages than are permitted for delivery to this destination. The request will
either need to be moved to a suitable destination for printing or the destination will need to be
modified.
2dumb Destination will not handle this type of data (for example, PCL or PostScript). The request will
either need to be moved to a suitable destination for printing or the destination will need to be
modified.
P a g e 76 | 221
OM Plus Delivery Manager
It is possible to display, copy, cancel, or change a request or group of requests. The “Requests Commands” menu in
the Client can be accessed either at the top of the screen in the menu bar or by right clicking on the destination
list.
CANCELING REQUESTS
It is possible to cancel selected requests and then purge them immediately or allow the purge time to elaspe. For
instructions on canceling requests, refer to the following table. For instructions on canceling requests, refer to the
following table.
Interface Accessing Method
Character-based On the Request Status screen, select Cancel, or on the keyboard, press c.
Client From the Requests menu or the right click menu, select Cancel Request, when the Cancel
Request screen appears, select either Use Purge Delay or Cancel Immediately, and then
click Yes. If the selected request is a parent of other requests (see Displaying Parent/Child
Information below) options to cancel just the selected job, the job’s children, or the whole
family of jobs will be available.
Note: Purging immediately will delete all data associated with that request and cannot be undone. Only use this
option if you are absolutely sure the request can be deleted.
A print control file is a set of instructions sent to the destination. The file is appended to the data. These
instructions tell the printer to perform a behavior, such as printing landscape or duplex (or both). It is possible to
change the associated print control file for a request, but a request can only have one print control file. For
instructions on changing print control files, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Change Control File, and then from the list, select the
print control file.
Client From the Requests menu, select Change Print Control File, when the Select Print Control
File screen appears, select a file, and then click OK.
P a g e 77 | 221
OM Plus Delivery Manager
COPYING REQUESTS
It is possible to copy a request in full or a range of pages from that request (providing that OM Plus could count the
pages for that data type). After selecting this, a prompt will appear asking for the starting and ending page
number, whether or not to spool the new request on hold, and to which destination it should spool. For
instructions on copying requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Copy Request, all selected requests are copied with
the same parameters.
Client From the Requests menu, select Copy Request, when the Print Report screen appears,
enterthe starting and ending pages, what destination to spool to, and whether or not to
spool the new copy on hold. Then click OK.
CHANGING DESTINATIONS
It is possible to change the request Status Screen to a different destination. For information on changing
destinations, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Destination Change, or on the keyboard, press d, and
then from the list, select the new destination.
Client On the Requests menu or the right click menu, select Destination Change, when the Select
Destination screen appears, select the destination, and then click OK, or left-click the
request to move, and then drag it to the destination.
Note: Drag-and-drop is only available for a single request at a time. To move multiple requests, use the command
menu.
It is possible to change the email addresses that are associated with a request for an email mode destination. For
instructions on changing email addresses, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Email Addresses, press F5 to add and F6 to delete
addresses, and then press F3 to update the request.
Client From the Requests menu, select Email Address, when the Addresses screen appears add or
delete an address, and then click Save.
It is possible to change the fax numbers associated with a request for a fax mode destination. For instructions on
changing fax numbers, refer to the following table.
Interface Accessing Method
Character-based On the request Status screen, select Fax Numbers, press F5 to add and F6 to delete
numbers, and then press F3 to update the request.
Client From the Requests menu, select Fax Numbers, when the Fax Numbers screen appear add or
delete a fax number, and then click Save.
P a g e 78 | 221
OM Plus Delivery Manager
It is possible to change the form that is associated with any request. It does not affect the destination (mount). For
instructions on changing forms, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Form Change, and then from the list, select the form to
apply.
Client From the Requests menu or right click menu, select Form Change, when the select Form
screen appears, select a form, and then click OK. If the form does not appear, select Enter
Form Name, click OK, when prompted enter a new form name, and then click OK.
Note: “Change Form” changes the form that the print job requires. To change the form mounted on the printer, use
the “Mount Form” command from the request menus to change the destination to use that request’s form.
Sometimes a print job generates additional requests (such as a job sent through Report Distributor). OM Plus
retains the relationship information about each family. If the request that is selected is either a parent request (has
generated other requests) or a child (was generated by another request), the option to display the entire family
tree is available.
The destination commands menu is available from this dialog by right-clicking on a request.
Interface Accessing Method
Character-based This feature not available.
Client From the Requests menu, select Display Parent/Children.
P a g e 79 | 221
OM Plus Delivery Manager
HOLDING REQUESTS
It is possible to place all selected requests on hold, which prevents a job from de-spooling to the destination. For
instructions on holding requestings, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Hold, or on the keyboard, press h.
Client From the Requests menu or the right click menu, select Hold.
KEEPING REQUESTS
If a request is set to Keep, it does not purge until a purge command is issued. For information, refer to Purging
Requests. For instructions on keeping requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status Screen, select Keep, or on the keyboard, press k.
Client From the Requests menu or the right click menu, select Keep.
LOGFILE DISPLAY
OM Plus retains a log of all the transactions it performs with the most recent entries displaying first. For
information, refer to Working with the Logfile. For instructions on displaying the logfile, refer to the following
table.
Interface Accessing Method
Character-based On the Request Status screen, or on the keyboard, press I. Then, press -- (minus) to move
backward and + (plus) to move forward.
Client From the Administration menu select Logfile Display or right click on the server names in
the destination panel. If multiple hosts are selected or if multiple log files are available for
any hosts, a logfile selection screen will appear.
MOUNTING FORMS
It is possible to mount a form on a destination so jobs in an fpend status will de-spool. When specifying a form
mount, the destination continues to de-spool the active form. When it completes, the mounted form changes, all
requests specifying the newly mounted form become enabled, and all other requests reflect a status of fpend
(form pending). For instructions on mounting a form, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Mount Form to mount the form for the request. A
prompt will appear asking whether or not to disable the destination when changing the
physical form. If yes, the destination will need to be re-enabled.
Client From the Requests menu or the right click menu, select Mount Form, when the Form
Mount screen appears, confirm mounting the form for this request. A prompt will ask
whether or not to disable the destination while the physical form is changed. If yes, the
destination will need to be re-enabled.
Note: When a form is changed on a destination, the system prompts the user whether to place that destination in a
disabled state to give the user time to change the paper if needed.
P a g e 80 | 221
OM Plus Delivery Manager
The number of copies that have been requested for a specific request can be increased or decreased before the
job actually prints. Once it has printed it can only be increased. For instructions on changing copy counts, refer to
the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Number of Copies, or on the keyboard, press n.
Client From the Requests menu, select Number of Copies, when prompted, enter the number of
copies to print, and then click OK.
CHANGING PRIORITIES
The priority of an output job refers to its position in the queue. If all output jobs have the same priority, then the
order reflects the time they spooled (first in, first out). The priorities range from 0 to 39 with 0 being the lowest
priority. The default priority is 20. For instructions on changing the priorities, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen select priority change from the Command menu, enter the
priority number.
Client From the Requests menu, select Priority Change, when prompted, enter the new priority,
and then click OK.
PURGING REQUESTS
When setting a request to purge, OM Plus will remove it from the system after it has printed. There is a delay
between the actual printing and the purging that equates to the purge delay setting for the destination. For
information, refer to Using Define Destination. For instructions on purging requests, refer to the following table.
Interface Accessing Method
Character-based On the Requests Status screen, select Purge, or on the keyboard, press p.
Client From the Requests menu or the right click menu, select Purge, and when prompted,
confirm purging the request.
RELEASING REQUESTS
If a request is released, the status changes to ready and will be scheduled to de-spool. If a request reflects the
Suspend status, the Restarting Requests command can be issued to start it where it stopped. For instructions on
releasing requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Release, or on the keyboard, press r.
Client From the Requests menu or the right click menu, select Release.
Note: For Raw TCP network destinations configured to use either unidirectional or bidirectional PJL or Stream, OM
Plus can perform a ‘Printer Restart’. OM Plus will send the entire print job down to the printer with instructions to
start printing on the designated page. This is useful for data types that OM Plus cannot do a restart on a page other
than one (i.e. pcl-graphics, PDF, etc.) Unfortunately, not all printers that support PJL support this feature.
P a g e 81 | 221
OM Plus Delivery Manager
RESTARTING REQUESTS
Restarting a request will cause it to start printing on its current destination. Not all data types can be restarted on a
specific page. If OM Plus cannot start from the indicated page it will restart from the beginning automatically. For
instructions on restarting requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Restart, or on the keyboard, press o, and then when
prompted, indicate the page on which to restart the request. If the number given ends in a
lowercase P (p) character, OM Plus will attempt a Printer Restart.
Client From the Requests menu or the right click menu, select Restart, when prompted, enter the
page on which to restart the request, and then click OK. If the ‘Use Printer Restart’ box is
checked OMPlus will attempt a Printer Restart.
PRINTER STATUS
It is possible to retrieve the status of any printer configured to use SNMP. The current SNMP status of the printer
and the last 100 entries in the log pertaining to the printer, appear. For instructions on retrieving a printer status,
refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Destination Status, or on the keyboard, press s.
Client From the Requests menu or the right click menu, select Printer Status, and the Printer
Status screen appears.
SUSPENDING REQUESTS
It is possible to suspend a request to stop it from printing as if it had been interrupted by the system. Suspending a
request does not disable the destination and the next request in the queue will start to de-spool. For instructions
on suspending requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Suspend, or on the keyboard, press s.
Client From the Requests menu or the right click menu, select Suspend, and then when prompted,
confirm suspending the request.
Note: Any data already delivered to the printer’s buffer will still print.
It is possible to trace the status of a request that has been transferred to another OM Plus Server. For instructions
on tracing status requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Trace.
Client From the Requests menu, select Trace, when the Trace screen appears, review the
information, and then click OK.
P a g e 82 | 221
OM Plus Delivery Manager
VIEWING REQUESTS
It is possible to view any request. The application to use to view a request depends on the data type, therefore
requests are not always viewable. For instructions on viewing the requests, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select View Request, or on the keyboard, press v, and the
file content will appear in text format. Most data types, other than simple data types, will
not be legible.
Client From the Requests menu, select View Request, when prompted, enter the starting and
ending pages to view, and then click OK. The application that has been associated with the
data type on the client configuration screen will launch, and then request will appear.
It is possible to change the flag that represents whether or not a benner page prints before a request. If the printer
is set with the default banner value, it is not affected by this command because it only affects the banner OM Plus
appends. For instructions on changing the banner status, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select either Banner On or Banner Off.
Client From the Requests menu, select More, and then select wither Banner On or Banner Off.
Note: The standard OM Plus banner includes the name of the user who spooled the request, the title of the request,
the print control and form name used, the date printed, the Request ID, the hostname of the originating computer
and whether or not this print is a restart or a reprint and if so, which pages are used. This can be customized to
show more or less data if desired.
It is possible to change the advanced form associated with the requests. For instructions on changing advanced
form files, refer to the following table. See the section on Advanced Forms for more details on working with this
tool.
Interface Accessing Method
Character-based On the Request Status screen, select Change to Advanced Form, and then from the list,
select the appropriate form.
Client From the Requests menu, select More, Change Advanced Form File, and then when the
Select Advanced Form screen appears, select the appropriate form file.
It is possible to set a future day and time to de-spool a request. When the scheduled time arrives, the status
changes from Timed to Ready and it de-spools when the destination becomes available. For instructions on setting
scheduled printing, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Time for Delay Printing, and then when prompted,
enter a futre date and time to de-spool.
Client From the Requests menu, select More, Time for Delayed Printing, when the Set Time for
Printing screen appears, enter the date and time to de-spool, and then click OK.
P a g e 83 | 221
OM Plus Delivery Manager
CHANGING TITLES
It is possible to change the title of all the selected requests to a new title, truncated to the first 50 characters. For
instructions on changing request titles, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, select Title Change, and then in the field, enter the new
title.
Client From the Requests menu, select More, Title Change, when prompted, enter the new title,
and then click OK.
UPDATING OPTIONS
It is possible to update the -o options of a request. For instructions on updating options, refer to the following
table.
Interface Accessing Method
Character-based On the Request Status screen, select Update Uptions, and then in the field, enter an
option.
Client From the Request menu select More, then Update Options. When prompted, enter an
option and then click OK.
ACCEPTING REQUESTS
It is possible to set a queue (default option) requests. If the queue is set to accept requests, spooling is enabled to
the target queue. For instructions on accepting requests, refer to following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Accept Requests, and then click Execute.
Client From the Destinations menu, select Accept Requests, and then when prompted, confirm
accepting the request.
It is possible to attach a terminfo file to a destination. For instructions on attaching requests, refer to the following
table. For information about terminfo files, refer to Using Advanded Destination Options.
Interface Accessing Method
Character-based On Destination Status screen, select Attach Host/Terminal.
Client From the Destinations menu, select Attach Terminal, when prompted, enter the device
name, and then click OK.
P a g e 84 | 221
OM Plus Delivery Manager
DISABLING DESTINATIONS
When a destination is set to disable, it continues accepting requests but does not de-spool (print) the request to
the destination device. For instructions on disabling destinations, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Disable Destination, or on the keyboard, press d.
Client From the Destinations menu or the right click menu, select Disable Destination, and then
when prompted, confirm disabling the destination.
Users in a security group assigned to a dynamic class can change destinations in the class. For instructions on
accessing dynamic class maintenance, refer to the following table.
Interface Accessing Method
Character-based This feature is not availble.
Client From the Destinations menu, select Dynamic Class Maintenance, and the Dynamic Class
Maintenance screen appears. It is possible to change any of the destinations in the security
group.
ENABLING DESTINATIONS
When a destination is set to enable, it accepts requests and de-spools (print) the request to the destination
device. For instructions on enabling destinations, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Enable Destination, or on the keyboard, press e.
Client From the Destinations menu or the right click menu, select Enable Destination, and then
when prompted, confirm enabling the destination.
If the item selected in the destination tree is an OM Plus server (one of the root nodes of the tree) it is possible to
display the status of the Daemons/Services.
Interface Accessing Method
Character-based Open DCCADMIN,then check Services menu.
Client Right click on the host name and then select “Daemon Information”.
P a g e 85 | 221
OM Plus Delivery Manager
MOUNTING FORMS
It is possible to mount a form on a destination so that jobs in a fpend status (form pending) will de-spool. When a
form mount is specified, the destination continues to de-spool the currently active form. When it completes, the
mounted form changes and all requests specifying the newly mounted form become ready and all other requests
reflect a status of fpend. For instructions on mounting a form, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Form Mount, and then from the list , select the
form.
Client From the Destinations menu or the right click menu, select Form Mount, when the Select
Form screen appears, select a form, click OK, and when prompted confirm the mounting of
the form. If the form does not appear, select Enter Form Name, click OK, when prompted
enter a name for the form, and then click OK.
LOGFILE DISPLAY
OM Plus retains a log of all the functions it performs with the most recent entries displaying first. For information,
refer to Working with the Logfile. For instructions on displaying the logfile, refer to the following table.
Interface Accessing Method
Character-based On the Request Status screen, or on the keyboard, press I. Then, press – (minus) to move
backward and + (plus) to move forward.
Client Select the Logfile Display option from the Administration menu or right click on a server
name in the destination pane and select “Logfile Display”. If the client is connected to more
than one host, a prompt will appear asking for host log to view.
For some solutions (most notably the Prescription Printing solution) a test page is used to configure the printer. To
force a test page to be printed on the device, refer to the following table.
Interface Accessing Method
Client From the Destinations menu or the right click menu, select Test Page.
PRINTER STATUS
It is possible to retrieve the status of any destination configured to use SNMP. The current SNMP status of the
destination and the last 100 entries in the log pertaining to the destination, appear. For instructions on retrieving a
destination status, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Destination Status, or on the keyboard, press s.
Client From the Destinations menu or the right click menu, select Status, and then the Printer
Status screen appears.
P a g e 86 | 221
OM Plus Delivery Manager
PRINTER PROPERTIES
An administrator can pull up the ‘Define Destination’ screen for a specific destination directly from the request
status screen by selecting the properties of the printer.
Interface Accessing Method
Character-based This feature is not available.
Client From the Destinations menu, select Properties.
REJECTING REQUESTS
It is possible to set a destination to reject requests. If the destination is set to reject requests, it is not possible to
spool anything to this destination. For instructions on rejecting requests, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, select Reject Requests, and then click Execute.
Client From the Destinations menu, select Reject Requests, and when prompted, confirm the
rejecting of the request.
Note: Be careful when setting a destination to reject requests. Destinations in this condition will ignore any jobs
sent to them and, for that reason, data can be lost. To keep jobs from printing from a device, it is ususally
preferable to set that destination to “Disabled” so that jobs will come in, but not out and the data will be preserved.
It is possible to add a translation table to a destination for character translation. This can be especially useful for
transforming text for a destination, such as an older line printer, that may not be able to recognize all characters.
For intructions on selecting a translation table, refer to the following table.
Interface Accessing Method
Character-based On the Destination Status screen, slect Translation Table Select, from the list, select the
table, and then press Enter.
Client From the Destinations menu, select Translation Table Select, when the Translation Table
Select screen appears
It is possible to launch the web browser that is set up in the Client Configuration and connect to the destination’s
URL. The URL must be in a valid URL format, i.e. http://IPADDRESS. For instructions on launching a destination URL,
refer to the following table.
Interface Accessing Method
Character-based This feature is not available.
Client From the Destinations menu or the right click menu, select URL.
P a g e 87 | 221
OM Plus Delivery Manager
The number of requests that appear on the Request Status screen can be limited by using the Lookup commands.
Interface Accessing Method
Character-based From the Status screen, press the ‘3’ key, Lookup. Select from the list displayed and press
Enter.
Client From the Request Status screen, select Lookup. Select from the list displayed and press
OK.
Displays all the disabled destinations and the requests on those destinations.
FORM
Displays all the destinations in a specific group and their requests. See Group Maintenance.
Displays all the currently selected destinations and the requests for those destinations.
STATUS
TITLE
USER
P a g e 88 | 221
OM Plus Delivery Manager
REMOTE HOSTS
(Character-based only) Displays the status information from another OM Plus host.
OM Plus Archive is a module that stores and retrieves documents spooled through OM Plus. In UNIX, the archived
reports can also be compressed. Reports are indicated to be archived with a command line option or from the
Status screen of OM Plus. After the standard purge delay interval, the report is stored for later display. When a
report is retrieved, it is displayed in the OM Plus report viewer and can be viewed or printed.
From the OM Plus Administration, select Archive Tab > Archive Settings
Specifies the time left in the trial period. After this time expires archiving will continue if the job indicates it but it
will not be possible to view or reprint the archive files. Once the system has been licensed, the screen will display
“System Licensed”.
ARCHIVE DIRECTORY
The directory used for archiving. This directory should be on file system that has enough space to do the desired
archiving.
P a g e 89 | 221
OM Plus Delivery Manager
TEMPORARY DIRECTORY
In UNIX, the OM Plus Archive system gives the option of compressing spool files as they are archived. These files
must be uncompressed before they can be viewed or reprinted. The tmp directory is the directory where
compressed archive files will be placed when they are uncompressed.
The OM Plus Archive system gives the ability to automatically remove archived files after the specified amount of
time has passed. This can help ensure that the file system does not fill up. The dccasweep program reads this
parameter and removes archived files that are older than the specified age. Files marked keep will not be removed
even if they are older than the ‘archive age’. The ‘archive age’ is specified as a number of days, months, or years.
Note: If dccsweep does not run, then archived jobs will not be removed.
The OM Plus Archive system creates subdirectories under the archive directory for keeping spool files. The purpose
of this is to enhance performance when searching, etc. This parameter specifies how often subdirectory should be
created. Valid values for these entries are:
The first time compressed file is accessed it is uncompressed into the archive tmp directory. This parameter tells
the dccasweep program how many days (0-365) to leave the file in the tmp directory before removing it. The file is
not removed after each access to minimize the number of times that it is uncompressed. This value should be set
to a number of days to maximize performance, but not so high as to create space problems.
P a g e 90 | 221
OM Plus Delivery Manager
ARCHIVING REPORTS
Archiving spool files takes place at purge time after the report is printed. Marking a spool file to be archived can be
accomplished in any of the following ways:
The first method is to flag the spool file when it is submitted to OM Plus (spooled to dcclp). Setting an “-o”
command line parameter does this. After the report is printed and the purge delay time period has expired , the
spool file is then archived. The Archived command line options for dcclp are described below:
Note: The compression options (*) are available only on UNIX systems.
On OM Plus for Windows systems, archive files are never compressed. These commands are effectively the same
from a compression standpoint.
Note: On Windows, you must reboot the system after setting this variable in order for it to take effect.
The second method is to set the LPPARCHIVE environment variable. This will cause all output jobs to be archived in
one of two ways. If LPPARCHIVE is set to ‘y’, it is the same as having the ‘-o arch’ command line option of dcclp set.
LPPARCHIVE set to ‘u’ is the equivalent to ‘-o archu’. LPPARCHIVE set to ‘yk’ is the equivalent to ‘-o archk’.
LPPARCHIVE set to ‘uk’ is the equivalent to ‘-o archuk’.
Another method is from the Request Status Screen. After an output job is spooled it can be marked for archiving
directly from the archive menu. The indication that the output job will be archived after printing is there will be an
“A” in the “P” (Purge) column of the Status screen (dccstat).
• View Archive File – Displays the Archive Report Selection screen (next page).
• Archive Request – Archive this request. Do not compress the file.
• Archive Request Keep – Archive this request. Do not allow dccasweep to delete.
• Archive Request Compressed – Archive this request and compress the file.
• ArchiveREquest Compress Keep – Archive this request. Do not allow delete.
• Do not Archive – Do not archive this request.
P a g e 91 | 221
OM Plus Delivery Manager
After reports have been archived, they can be retrieved and then viewed, printed, or deleted. From the ‘Archive’
menu in the Request Status screen or the ‘Archive’ Tab in the OM Plus Administration.
Fill in any combination of report attributes and press the ‘OK’ button.
When the query is complete, a listing (above) of reports that match the query is displayed. From this screen single
or multiple reports can be viewed or deleted by pressing , or printed.
Note: The Text field searches all the data within a report. The time to complete this will vary based on the size and
quantity of reports searched and whether or not those reports are compressed.
The program dccasweep, can be executed at any time to clean up the archive directories and the temporary
directories. When executed with no parameters the dccasweep program, using the values set with Archive
Administration, removes the archived files in both the archive directories and the temporary directory used for
repeated report viewing. To only clean up the temporary directory use a -t option.
dccasweep can be executed manually whenever it is necessary to clean up the archive directories, or executed
automatically from the UNIX cron system or Windows’ scheduled tasks program. The LPHOME environment
variable must be set for dccasweep to function correctly. A script should be created that first sets LPHOME, then
executes dccasweep.
P a g e 92 | 221
OM Plus Delivery Manager
Standard OM Plus functionality can be complemented and extended through the use of one or more optional
modules. For information about purchasing these optional components, contact a Plus Technologies Account
Manager.
CONTEXT DELIVERY
Context Delivery is an application that fits between the user or another application and OM Plus. Its purpose is to
evaluate the request for user-defined criteria, and then make decisions based on rules entered by the
administrator. Context Delivery is available as an add-on application to OM Plus. For information, contact a Plus
Technologies Account Manager.
Note: On a Windows-based computer, Context Delivery is installed by default, and you only need an activation key
to use it.
Once Context Delivery is installed and activated it automatically checks for criteria in each spooled file without
specific commands provided by the user.
Context Delivery is structured in levels and can be set up to make document delivery decisions based on multiple
triggers. All level 1 decisions are independent from each other, all level 2 under the same level 1 are independent,
and so forth.
P a g e 93 | 221
OM Plus Delivery Manager
1. Select the upper level on which to add a new piece of criteria and select Add Branch from the commands
menu.
2. From the Type list, select one of the following types of criteria.
Criteria Function
Copies Checks the number of copies requested on the dcclp command line (-n).
Data Type Checks the OM Plus data type as specified with the -T switch on the command line.
This will not change the default data type.
Destination Checks the destination to which the request is being spooled (-d).
Data Contains Searches the file for the specified criteria.
Data Contains (remove) Searches the file for the specified criteria and removes it, if found.
Data Contains (remove Searches the file for the specified criteria and removes the entire line, if found.
line)
Advanced Form Checks the electronic form file specified (-F).
Form Checks the standard or advanced form specified (-f).
Hold Checks to see if the hold flag was specified (-h).
Options Checks the –o command line options.
Priority Checks the value of the requests priority (-q).
Time Checks to see the future time for de-spooling, if set (-w).
Title Checks the title of the request (-t or default).
User Checks the user ID of the user submitting the request.
Note: For the “Data Contains” types, an additional set of options appears. These options allow the lookup to be
limited to a set number of bytes or lines. In the case where a match is not guaranteed, this keeps a potentially large
file from being scanned in its entirely, which could take both time and resources. Limiting the search, if possible, is
considered a best practice approach, but is not required.
P a g e 94 | 221
OM Plus Delivery Manager
3. In the Search Criteria field, enter the value to be compared. This can be a plain text, direct match or, if desired, a
regular expression. If a regular expression. If a regular expression is used, make sure Regular Expression is selected.
Once Context Delivery locates a match, it can change various parameters of the request. Context Delivery sets the
parameters to the level of the most detailed match. If the request matches a level 2, but not an associated level 3,
it will be spooled with level 2 settings.
Once the system reaches a match, the job’s options can be modified. Leaving an entry blank will keep any settings
currently set for that job. Otherwise, the data may be modified. For Priority and Copies, a different number may be
entered. For User and Title, text may be entered. For Timed a time delay may be entered. For the rest, either text
may be entered or, for convenience, an item may be selected from the drop down menu.
In addition, any Regular Expression match may be used as an input in a text field. Entering $MATCH1 will enter the
test that matched the first level’s Regular Expression match. $MATCH2 will return the second level’s match,
$MATCH3 will return the third level’s match.
Note: The Regular Expression matching is probably one of the most powerful things in CD Plus. Say you have a text
document with “FirstName:Frank” and “LastName:Smith”. Entering a regular expression to match – for example:
“(?<=FirstName:). *” for the first parameter and “(?<=LastName:).*” for the second would then allow you to enter
“$MATCH$MATCH2” as the user name to return “FrankSmith” as the user. This would be accurate for any names
entered in the document. This can be used in any text field, for any text in the document, in the title, in the
destination name or anywhere else CD Plus can see text.
P a g e 95 | 221
OM Plus Delivery Manager
While the above information dicates how CD plus does work, it is important to take a minute to discuss how CD
Plus should work. CD Plus will look at every file coming into OM Plus. As such, if it is not configured to be as
efficient as possible, undesired printing delays can result. To see how this plays out, let’s set up an example.
Consider a case where print jobs are being written to a folder and picked up for spooling by the Scan Service. These
jobs contain a destination name at the beginning of the title that CD Plus must find and use. The naming
convention for these destinations is a letter followed by a two digit number (for example A56, K78, Z99). There are,
indeed, 2600 destinations.
The first thing is to fail early and fail often. Set up one quick test will save any non-CD Plus jobs from traveling
through the entire list of parameters. In this case, the easiest thing would be to have the first level filter by
spooling destination. Doing so means that only jobs coming in through the Scan Service would go on for additional
testing while all other jobs immediately fail out and exit CD Plus unchaged. That could significantly reduce the
processing times required for any job that doesn’t need CD Plus.
Next, think in terms of levels. It would be tempting* to set up 2600 second level parameters to test these jobs, but
think about a job headed for destination Z99. That job would have to pass through all 2600 definitions before it
finally matched. This would take time and resources. It would be more efficient to set up 26 second level
parameters to catch jobs by their starting letter, then define things further in a third in a third level parameter that
matches the numbers. This way job Z99 would only check against 126 paremeters. In fact, every job for a
destination starting with a letter except “A” would see significant gains, while “A” printers would only see a slight
loss. There would, though, be 2323 (26 second level and 100 each 3rd level) parameters tht need to be configured.
Note: “Tempting” may not be the right word. However, it is useful to think about the CDPlus configuration file as a
text file (which it is). If you need to enter 2600 different lines, let us know. We have some ways to programmatically
enter that data and create the CD Plus configuration file without typing all that in by hand. In that way, it could be
at least simple.
Even better, think about Regular Expressions. Thinking ahead can save a lot of time. If the printers are defined in
OM Plus using the same naming convention, then a simple regular expression like “[A-Z]\d+” would catch the
destination name and $MATCH# could be used to enter that in the destination field. That could condense 2600
lines of parameters into one. That would be a significant performance gain all around, to say the least.
Finally, if possible, use properties, not data. This whole exercise is looking just at the job title. That is one of the
properties that we can see easily. If CD Plus needs to look into the file using one of the “Data Contains” matches,
try to make that a final step and one only used if every other step has failed. Opening the file to read the data
takes time and resources. It can be done if there’s no other way, but it is, by far, the least efficent thing CD Plus
does. If a file must be opened, limit the reading to as few lines or bytes as possible. If a 400 MB before it lets it fall
through to the next test if it is not limited. If it’s limited to the first 20 lines, then the test will go much faster. If CD
Plus was able to take action before this based solely on the properties of the print job, that would be even better.
This could require some modifactions to the spooling process or application, but if thousands of jobs are affected,
it could provide worthwhile.
P a g e 96 | 221
OM Plus Delivery Manager
REPORT BUNDLER
Report Bundler is a module for OM Plus that allows for the creation of a single print job document from multiple
print job documents. The bundled document ensures all information is delivered at the same time in a single print
job to the desired destination.
While there are many applications for Report Bundler, users will benefit most from its ability to aggregate print
jobs and optimize the performance of their printer hardware. Report Bundler is available as an add-on module to
OM Plus. For more information, contact a Plus Technologies Account Manager.
To configure Report Bundler, first create a local destination using the “Bundle” mode. At this stage, the bundle
type can be determined.
For information on the four bundling type options, refer to the following table.
Option Description
Bundle Bundles reports based on a user defined parameter that must be included on the
command line.
Form Bundles reports based on the selected form.
UserId Bundles reports based on the submitter’s user ID.
Title Bundles reports based on the report title.
P a g e 97 | 221
OM Plus Delivery Manager
After creating a bundle destination, the parameters for that bundle must be defined. To access the Bundle
Parameters screen, click “Report Bundler” from the “Document Conditioning” section of the Control Panel.
On the Bundle Parameters field, each line of the parameter list represents a match to the value in Bundle Type
field defined in the destination definition screen. For information on each value and their definitions, refer to the
following table.
Value Definition
Resolved Value Value to match for this parameter.
Destination Destination to where to spool bundled requests for this parameter.
User User ID to use when spooling this bundle. This allows unique security setups.
LP Options Options to use for this bundle. These options are command options for dcclp command. For
information, refer to Using the Command Reference.
From the Bundle Parameters window, select the Parameters menu, Add Parameter, and then select each field to
enter a value. While each bundle printer can only bundle on one parameter, it can have multiple value matches for
that parameter. If a request is spooled to the bundle printer that does not match any of the resolved values, the
request is marked interrupted. There can be multiples of the same resolve value configured. In this case, the
request will be put into a separate bundle for each of the matching parameters.
The bundler can be configured to bundle all matching jobs for a resolved value that is not defined. By adding a line
that has a resolved value of ‘default’ the system will still bundle like jobs together even if their specific value is not
listed. It will then apool them to whichever destination with whatever options are associated with the default
value.
P a g e 98 | 221
OM Plus Delivery Manager
Jobs are spooled to the Report Bundler destinations just like any other OM Plus destination. All jobs spooled to the
destination will be bundled until a bundle terminating request is submitted. There are two methods for
terminating a bundle.
• Spool the last request with a ‘--o trailer’ option on the command line. For information, refer to dcclp in
Using the Command Reference.
• Spool a job that contains only the word BUNDLETRAILERRECORD with no spaces and in all capital letters.
Once the bundle is terminated all documents spooled since the last terminating request are appended together in
the order received, and they are submitted as one request.
Note: If the system is set to display parent/child relationships the new bundle request will be shown as a child of the
trailer request.
P a g e 99 | 221
OM Plus Delivery Manager
REPORT DISTRIBUTOR
Report Distributor is an application for OM Plus allows users to burst large enterprise reports into individualized
sub-reports based on triggers in the document’s meta data or the document text. These individual sub-reports can
then be sent directly to specific end user requested destinations such as printers, fax machines, email systems,
Web sites, and Intranet sites. Report Distributor is available as an add-on application to OM Plus. For information,
contact a Plus Technologies Account Manager.
OM Plus customers will appreciate the automation of report burst and bind processes, which helps reduce errors
inherent in traditional report distribution processes. Additionally, use of Report Distributor can result in reduced
consumable costs and reduced information latency.
Report Distributor can burst requests only for the following data types:
• simple
• pcl-1
Report Distributor compares each page of a request against a set of independent criteria. For each set of criteria a
new request is generated. Once all the pages have been compared, the new requests are spooled to their
destinations. The sets of criteria are called pages on the interface. If at the end of the compare a page’s criteria
returns true then the document page is added to that criteria’s request. It is possible to add a document page to
multiple requests by meeting multiple criteria. What this allows, for example, is to deliver to a user’s printer or
address only pages of a large report in which they are interested.
To use Report Distributor, a Report Distributor printer must be defined in Destination Configuration, and a path to
a working directory put in the Destination Device field. The working directory is used as working space. When a
report is burst into multiple spool files, this directory is used as the temporary working directory. Then in the
Report Distributor Configuration menu, create a Report Distributor Script File. When a job is spooled to Report
Distributor, this script file is used. If a name is not specified, it saves with the name default. The default file is used
if no file is specified.
For each page, a set of compares must be defined. These compares will look at specifically defined location on the
current document page. A range of rows between 1 and 99 and a range of columns between 1 and 256 define this
location.
For lines other than the first, the location can be defined as relative to the previous line. By using +[value] or –
[value] in the row and column fields.
Report Distributor will evaluate an area that has a position relative to the start point of previous match. This only
works if the relative line uses the AND (&) logical operator.
Within the defined location, Report Distributor will look for a match to a specified string of characters or numbers.
In addition, it can look for numbers larger or smaller than the specified value.
P a g e 100 | 221
OM Plus Delivery Manager
• Oper: logical operator for the row. This is unavailable on the first row. See the list of logical operators
below for more information.
• Ignore: Determines whether the text type trigger will be case sensitive. Alternately, up to 10 characters
can be entered in this field. These characters will be ignored in a numeric trigger.
• From Row: line number on each document page in which to start the search. The values that start with a
‘+’ character allow the row to be relative to match on the previous line.
• To Row: line number on each document page in which to end the search. The values that start with a ‘+’
character allow the row to be relative to a match on the previous line.
• From Col: character column number on each document page in which to start the search. The values that
start with a ‘+’ character allow the column relative to a match on the previous line.
• To Col: character column number on each document page in which to end the search. The values that
start with a ‘+’ character allow the column relative to a match on the previous line.
For each page, an operation must be defined. Take this action in case the criteria evaluate is true. If no
operation is defined, the document page is discarded.
• User: User ID from which the request spools. This allows special security setups.
P a g e 101 | 221
OM Plus Delivery Manager
• LP Options or Delivery: The options for the dcclp command. For information about dcclp, refer to the
Using the Command Reference.
o Alternately a command can be used and Report Distributor will execute this command after all
the pages have been evaluated and it has at least one matched document page.
All operations occer after the document has been completely processed. Any requests that are created here will be
children of the original job sent to the repdist printer.
NOMATCH OR LASTMATCH
Plus Technologies recommends that a page with a single line containing the nomatch type be used as the final test
in the file. This will allow operation (or not) on any document page that has not had a match.
Each Report Distributor file must be set to either nomatch or lastmatch. Nomatch causes pages that do not match
any of the criteria to be operated on by a page with a nomatch line defined. Lastmatch causes any page that does
not match any of the criteria to be operated on by the last test that had a successful match.
LOGICAL OPERATORS
The logical operators allow a row to correlate to a previous row. This allows for multiple criteria on a page for the
purpose of triggering an operation. For information on the operators and their definitions, refer to the following
table.
Operator Definition
& Both this row and the previous row must resolve for this operation to happen.
| Either this row or the previous row must resolve for this operation to happen.
&( A parenthetical compare begins where there are multiple lines within a single set. It compares
the previous line to the result of all lines between this operator and the first parenthetical close.
Both sets must be true for this to be true.
|( Like the &( operator except that either the previous line or the set must be true to return a true
value.
&) A parenthetical compare closes. This line is the last line included in the compare and is evaluated
like the & operator.
|) A parenthetical compare closes. This line is the last line included in the compare and is evaluated
like the | operator.
EXAMPLE
The following example scans each page of a document and looks for the word Print Manager defined by rows 1-10
and columns 60-80. If it finds a match it then looks in the next 10 lines in the same range of columns for either the
number 9375551212 or 9375552121. If there are any dashes or parenthesis in the number they will be ignored. If
either of these numbers is found then the compare has evaluated true. The current page spools to destination
support with a form of letterhead.
If either the first line or both of the second lines fail it will be a nomatch. In this case it will spool to the nomatch
destination selected on page 2.
P a g e 102 | 221
OM Plus Delivery Manager
if(firstline is true)
then
then
endif
endif
P a g e 103 | 221
OM Plus Delivery Manager
OM Plus can be set up to broadcast its destinations to other OM Plus systems. This allows users or applications on
one server to spool to destinations defined on another OM Plus Server.
Before OM Plus installations can broadcast their defined destinations to one another, the proper services must be
running.
STARTING ON WINDOWS
To start the remote service on OM Plus Server with a Windows operating system, from the OM Plus DM Server
screen, select the Services tab, and then confirm that OM Plus Service, End-To-End Service, and Remote Service is
installed and running.
STARTING ON UNIX
To start the remote service on OM Plus Server with a UNIX operating system, run the following command.
$LPHOME/bin/dccpingrem
Note: Unlike the other UNIX services, dccpingrem does not have a separate shut down command. See dccshut for
more details.
Before OM Plus can broadcast its defined destinations and standard classes, the following file must be created.
$LPHOME/system/sendHosts
The file should contain a list of names of all the other OM Plus Servers that should receive the broadcast
destinations. After starting the service or adding or removing a destination, OM Plus will contact all the OM Plus
Servers on this list and inform them of the destination list.
P a g e 104 | 221
OM Plus Delivery Manager
Before an OM server can receive broadcasted destinations, the following file must be created.
$LPHOME/system/receiveHosts
The file should contain a list of the names of all the other OM Plus Servers that should have their destinations
received by this server. When the remote service is started, it will poll all the servers in this file for their list of
printers.
For Windows servers, the names need to be the same as the computers from the Computer Name tab of each
systems System Properties dialog. If the entire domain name is included on the name presented there, use only
the first portion that is the system’s name.
For UNIX/Linux servers, the names need to match the rsult of a uname –n command executed from each system.
ADVANCED SETTINGS
Two other files are used for determining additional settings for the OM Plus server. The first of these files is
located at:
$LPHOME/system/pingParams
The files holds three lines options. The first is “ReceiveAny” which, if set to “y” will allow any host broadcasting its
definitions to add its destinations to this server, regardless of whether or not that server is named in the
receiveHosts file.
The second setting is “SendAny” which, if set to “y” will allow any OM Plus server requesting destinations from the
server to receive those destinations.
“ProxyMode”, if set, will allow an OM Plus server to transmit destinations it recieves from other OM Plus servers as
though they were its own. This can be useful in a secure environment where not all OM Plus servers needing to
share destinations can be found by each other. A central proxy server can be used to relay the destinations from
one to the other.
OM Plus can spool to a remote destination the same way it is possible to spool to a local destination with one
exception, different servers having destinations with the same name.
Note: If an OM Plus server has a local destination with the same name as a remote destination, OM Plus will spool
the job to the local destination. To spool to the remote destination use the hostname in the destination field, i.e
hostname!destination.
P a g e 105 | 221
OM Plus Delivery Manager
The send and receive hosts files can be created and manipulated from the Remote Printing tab in the OM Plus
Administration.
ALIAS
OM Plus also has the option to broadcast its definitions under a different host name. This can be especially useful
in a high availability solution where multiple hosts may exist and function as the same system.
In order to specify a different host name, or alias, enter the new host name in the alias field. This OM Plus server
will now be seen as that host name when sending and receiving destinations.
OM Plus can also receive and send destinations to servers not explicitly defined in the list. In this case, the server
must be set to send to any or receive from any. In send to any, any other OM Plus server that connects to the
server will be allowed to receive a list of destinations from any other server that contacts it. Both of these settings
can be very useful in a large distributed environment, or an environment where print servers are being added or
removed regularly.
PROXY
Currently UNIX only, this option allows an OM Plus to broadcast destinations received from another OM Plus
server as its own. This option would mostly be used in situations where one OM Plus server was serving as a bridge
between two other OM Plus servers who are unable to connect due to security or logistical reasons.
P a g e 106 | 221
OM Plus Delivery Manager
ADDING/REMOVING SERVERS
To broadcast destinations to a remote server, use the appropriate “Add” button to add that server to the “Send”
list. To add a server to ask for destinations, use the “Add” button for the “Receive” list. Servers can be removed
from either list using the corresponding “Remove” button.
SAVE
To update the system, the configuration must be committed using the “Save” button. Closing the window or
selecting a different host without saving will remove all changes.
P a g e 107 | 221
OM Plus Delivery Manager
OM SCAN SERVICE
OM Scan is a utility that can monitor one or several folders in order to output any files written into those folders.
This functionality is especially useful for capturing output from legacy applications that write data to a folder, but
do not provide print spooling capabilities on their own.
Note: The most important thing to remember is that OM Scan will deliver any file to OM Plus Delivery Manager
exactly as it is written to the folder. And, by default OM+ DM will output whatever files it receives to a printer
exactly as it receives them. Therefore, make sure that any file being processed by OM Scan Service can either be
handled by the printer or that appropriate filters are in place to perform any necessary transformations of the data.
P a g e 108 | 221
OM Plus Delivery Manager
From the OM Plus DM Server application, select the “Environment” tab and then select the “Settings” button. In
the screen that pops up, select the “Scan Service Settings” tab and then press the “Configure Scan Service” button.
INITIAL SETTINGS
Clear Messages: Should messages found in the target inbox be marked as read?
P a g e 109 | 221
OM Plus Delivery Manager
FOLDER SCANS
To create a new folder scan process, select the Folder icon from the top of the left pane and fill in the required
fields.
Cycle time: Frequency, in seconds, with which the scan service should check the target folder.
Sorting: In which order should files be spooled if found? Creation time and file name are options, the default is the
order in which the files are found in the folder, which may not be reliable.
Process Sequentially: If a sort order is defined, should the files be processed in that order?
Sub Directories Options: by default the scan service will not scan directories below the target directory. These
settings can modify that behavior.
Script Options: Once a file has been found, the scan service uses a script to understand what to do with the file.
The default behavior is to pass the job to the destination specified in Script Parameter 1 with the options specified
in Script Parameter 2. To change the behavior, change the script specified in the Script Name to another script in
the OM Plus userfilter directory.
Files Removed: After executing the script specified, should the file be removed? This can be turned off of the script
is designed to do something different with the file, but otherwise should remain true.
P a g e 110 | 221
OM Plus Delivery Manager
EMAIL SCANS
User Definition: How should the system connect an email address to a user name. “Use Email address” will use the
user name of the email address (everything to the right of the “@”). “Use File Lookup” uses a map file (specified in
the next line) to match an email address with a user name. “Use Database lookup” uses the database configured in
the next tab.
User Map File: This is complete pathname for a text file to be used to map email addresses to user names.
Keep Messages: Determines if the service should keep or delete messages on the server after retrieving them.
Script options are the same as before. The script defined in the “Script Name” field will be called and passed the
parameters in Script Parameter 1 and Script Parameter 2. By default, the “spoolemail.bat” script will spool the
body of the message as well as any attachments in supported formats.
P a g e 111 | 221
OM Plus Delivery Manager
DATABASE
This configures the database to be used to resolve email address into usernames.
Driver: The type of database used. Currently supports SQL, Oracle and Firebird.
Database: The name of the database or schema that holds the user table.
Table: The table holding the user name and email addresses.
Email Field: Field in the table that contains the email addresses.
P a g e 112 | 221
OM Plus Delivery Manager
OM Plus has two certified SAP interfaces that facilitate the submission of SAP output requests to OM Plus and the
return of request status back to SAP. The older SAP Polling interface periodically queries OM Plus via command line
to determine the status of outstanding requests. It is available for all OM Plus supported operating systems. The
SAP Callback interface is a more efficient and tunable. In callback mode, OM Plus systems establish persistent
connections back to the servers SAP over which request status changes are reported. The OM Plus Callback
interface is only available on the following platforms: AIX, Linux86, HP-UX Itanium, Solaris SPARC and Windows.
There are three steps required to get the interface working properly:
CONFIGURING SAP
SAP configuration consists of defining a Real Output Management System (ROMS) definition, one or more Logical
OMS (LOMS) definition(s), OM Plus commands to be used by SAP and Device definitions corresponding to OM Plus
destinations. These definitions are alldefined via the SAP Spool Administration (SPAD) transaction.
In lieu of creating the SAP OMS definitions from scratch, as described in the following sectins, OM Plus provides a
file ($LPHOME/constants/sapxomcfg.txt) which provides a predefined ROMS (OMPLUS), a callback and a polling
LOMS (OMPCB and OMPPOL) and command definitions corresponding to the configurations defined in the
following sections.
1. From the SPAD Initial Screen, click Utilities > For output management system > import.
2. In File system info., enter the full path to the provided configurations file, substituting the proper value
for $LPHOME (eg. /usr/lpplus/constants/sapxomcfg.txt) then click Server.
3. In Operation, click Import
4. In Options, Click Perform Import (either one).
5. Click the Execute button.
Note: Alternatively, you may transfer the file to your workstation, enter the full path to the file there and select
Frontend computer.
If OM Plus has been installed in a non-default directory, edit the Command path in the Operating System
Commands to reflect the path in the $LPHOME environment variable. (Be sure to include the trailing slash
character!) If callback is to be used, edit the callback LOMS definition (OMPCB) to enter the proper target SAP
system names. Timing and other parameters may also be adjusted. (see SAP Logical OMS & Commands
P a g e 113 | 221
OM Plus Delivery Manager
Configuration) below. It may be useful to create additional callback LOMS definitions if it is desired to have groups
of destinations with differing timing and callback event reporting levels.
If callback is not to be used, the definition for the callback LOMS, OMPCB, may be deleted. Similarly, if polling is
not to be used, the polling LOMS (OMPPOL) definition may be deleted.
The SAP Real OMS configuration defines an instance of an Output Management System, informing SAP of the
OMS’s capabilities. One ROMS definition for OM Plus is required.
1. From the SPAD Initial Screen, click on the Output Management Systems tab, then the Real Output
Management Systems Display button.
2. To define a new ROMS, click on the Create button. (Or double click on an existing ROMS entry to modify
it.) This will bring up the ROMS definition screen.
P a g e 114 | 221
OM Plus Delivery Manager
To use SAP BC-XOM, at least one LOMS to be defined. LOMS definitions support the two types of interfaces –
polling or callback. (Callback, if available, is preferred due to its lower overhead and greater customization
potential).
1. From the SPAD Initial Screen, click on the Output Mangement Systems tab, then the Logical Output
Management System tab, then the Logical Output Management Systems Display button.
2. To define a new LOMS, click on the Create button. (Or double click on an existing LOMS entry to modify
it.) This will bring up the LOMS definition screen.
P a g e 115 | 221
OM Plus Delivery Manager
2. Set a Command group letter to share a single set of command definitions (as defined below) across
multiple LOMS definitions. All LOMS should reference this letter. Otherwise, leave the field blank. Enter
the command definitions for each LOMS separately.
4. If the ‘No info = error’ checkbox in the Jobs section is not visible, click on the ‘Extended config’
button. Clear the ‘No info = error’ checkbox. (This prevents SAP from marking output requests in error if
OM Plus does not respond to a status poll in a timely manner. This could happen due to network errors.)
P a g e 116 | 221
OM Plus Delivery Manager
4. Select ‘Callback’ under the Jobs section. This should cause additional field(s) to display.
5. Enter the desired SAP instance in the Target for callback field.
6. Set a Command group letter to share a single set of commands definitions (as defined below) across
multiple LOMS definitions. All LOMS should reference this letter. Otherwise, leave the field blank. Enter
the command definitions for each LOMS separately.
7. Set ‘Event report level’ to the desired level of reporting (See text below).
8. Select Devices/Queue query and Jobs/Query and Jobs/Can be deleted if it is desired to make these
functions available for this LOMS in the SAP user interface. The query options will cause a Tasking Target
to be requested. Enter the desired SAP server instance.
P a g e 117 | 221
OM Plus Delivery Manager
11. Set Send Period to the maximum interval that OM Plus should accumulate status events for before
returning them to the SAP callback target. (see below)
12. Set Number of Events to the number of status events that can be allowed to accumulate before OM Plus
returns status earlier than the Send Period. (see below)
13. Set the Callback Restart Interval to the number of seconds OM Plus should wait before retrying a failed
callback target.
14. Attribute Record and OMS Configuration should be left blank for future use.
The settings of Event report level, Send Period and Number of Events can have major impact on speed of update
and overhead in SAP and OM Plus. An OM Plus node periodically scans for ready events at the Send Period interval
of any LOMS which are accessing it. If multiple LOMS are accessing an OM Plus node, scans may occure more
frequently to accommodate the requested timing of each LOMS. The scan interval is limited to a minimum of 5
seconds and a maximum of 30 seconds. When a request or its associated destination change status, this event is
filtered by Event report level. If the event is at or above the reporting threshold, it is counted as ready. When a
scan occurs, the event is reported to SAP if the Send Period has elapsed or the Number of Event has been reached.
P a g e 118 | 221
OM Plus Delivery Manager
The following describes the mapping of OM Plus request and destination status changes to SAP Event reporting
level. Each seccessive reporting level allows additional triggering events for status callbacks to SAP, providing
increased visiblity for SAP users. The level of detail available for this processing depends on the configuration of
the OM Plus destination. Maximum detail is provided by destinations configured in termserv mode, with SNMP
and Bidirectional PJL protocols enabled.
FINAL MESSAGES
SAP is only notified when a request completes successfully or is canceled. This setting (along with a Send Period of
a minute or two) is appropriate when request and destination status is to be monitored solely in OM Plus and SAP
needs no progress reporting, beyond a completion notification.
Adds conditions, such as Offline, where request processing generally cannot continue without some form or
intervention in OM Plus or at the printer.
ALSO WARNINGS
As of OM Plus 2.4.0, this has no additional effect because SAP does not act sufficiently differentiate between
Problem and Warning conditions and, in many cases, OM Plus cannot tell if a problem does or does not require
intervention.
Adds request status transitions such as “ready” to “activ” and “retry” conditions.
ALSO INFORMATION
P a g e 119 | 221
OM Plus Delivery Manager
1. Save the LOMS definition. The above steps may be repeated to define multiple LOMS if desired.
2. From either a LOMS definition or the List of LOMS screen, Select the Commands button. Select the
entry corresponding to your system’s operating system. (All Windows systems are considered to be
‘Windows NT’.)
Set a Command group letter to share this set of command definitions across multiple LOMS definitions. All LOMS
should reference this letter. (Otherwise, enter the command definitions for each LOMS separately.)
Unix: /usr/lpplus/bin/
Windows: C:\plustech\omplus\server\bin\
**In Both cases, make sure to include the trailing slash or backslash**
c) Enter the dccsapsub command as shown below into the Submit line:
dccsapsub “&EI” &EG &P &F &o “&T” &C &Y &U “&E2” “&Es” “&E1”
P a g e 120 | 221
OM Plus Delivery Manager
(It is harmless to use quotes around all parameters. The ones shown are required.) The “&E1” parameter is new as
of OM Plus release 2.3.2. It is required for callback, allowing dccsapsub to distinguish between polling and callback
mode requests. If absent, polling will be assumed.
d) Enter the dccsapstat commands shown below into the remaining lines:
Polling: dccsapstat &P &EL
Queue query: dccsapstat -d &P
Job cancel: dccsapstat -c &EL
Job query: dccsapstat -j &EL
** Do NOT use quotes around the $EL prarmeter**
P a g e 121 | 221
OM Plus Delivery Manager
1. From the main Spool Administration Initial Screen, select the Devices/servers tab and click the Output
Device Display button.
2. Select an existing device to edit or click the Create button to define a new one.
3. Device configuration is the same as for other non-OM Plus devices except on the Access Method tab:
a. Set the ‘Host Spool Access Method’ to ‘E: External Management System’.
b. Enter the OM Plus destination queue name into the ‘Host printer’ field.
c. Change the Logical OMS to the desired OM Plus LOMS defined previously.
d. If configuring a polling LOMS, do NOT select the ‘Do Not Query Host Spooler for Output Status’
checkbox.
e. Once all configuration for the device is complete, click save.
4. Return to the List of Output Devices and repeat steps 2 and 3 for all SAP output devices which should be
handled by OM Plus.
The SAP devices are now configured to submit requests to OM Plus for printing and to receive request status from
OM Plus. A job submitted via the OM Plus BCXOM interface will not purge from OM Plus until it has a final status
(prntd, cmplt, xferd, etc.) and SAP has been informed that the request has completed.
P a g e 122 | 221
OM Plus Delivery Manager
The RID span is a method by which each server uses a unique range of RID numbers when request are spooled to
it. OM Plus uses the RID span to know what OM Plus server a request was spooled on. This is important for SAP
because an environment may have more than one SAP server. Any SAP server can query for the status of any
request spooled by any of the SAP servers in the enterprise. The dccsapstat program uses the RID span to
determine which host to connect to in order to get the accurate status.
One OM Plus server needs to designated the span host. It is the span host’s responsibility to publish the RID span
file out to all of the servers.
Note: Even if this is the only server in your enterprise, the SAP interface still requires that the RID spans be properly
set up.
To edit the RID Spans using the Client interface, open the OM Plus Administration > System > RID Spans.
Add a line containing host, starting RID, and ending RID for each OM Plus server in the enterprise. Starting RIDs
must be larger than ending RIDs. Ranges cannot overlap. The minimum range is 500, but it is highly recommended
that the range be greater than the maximum number of requests allowed on that system (see System Defaults).
The system that is the Span Host is only system that needs to be set up using this utility. Periodically the Span Host
will publish the current file to all of the systems listed. If a server that is not the Span Host is updated, the changes
will be lost as soon as the real Span Host publishes its list.
P a g e 123 | 221
OM Plus Delivery Manager
WINDOWS
Open the OM Plus DM Server appplication on the OM Plus server that is going to host the RID span file and select
the ‘Environment’ tab.
Select the ‘Settings’ button and locate the ‘SPAN Host RID Ranges’ tab.
For each OM Plus server in the enterprise a line in the RID Span Control needs to be entered. Type each host name
and a range of RID numbers into the Fields near the bottom of the window and select the add button. Don’t forget
to include the Span Host server. The program will not allow overlapping ranges. Once done, select the ‘Close’
button and this server will propagate the correct RID spans file out to each server in the list.
P a g e 124 | 221
OM Plus Delivery Manager
UNIX
On a Unix server, the Span file needs to be created manually on the span host. Make the following files:
$LPHOME/constants/spanhost
$LPHOME/constants/ridspans
This file should contain an entry for each server in the enterprise. The format of the file is as follows:
hostname,starting_rid,ending_rid
Example:
ibm1,10000,50000
solaris33,50001,99999
Take great care to make sure that none of the RID ranges overlap.
In order to make callbacks, OM Plus must have an initial contact SAP target address as well as login ID(s) and
password(s) for any SAP callback target instances OM Plus may establish contact with. Additionally, if multiple OM
Plus systems are communicating with the same SAP system, they must be made aware of each other so as to be
able to pass updates amongst themselves.
This configuration information is provided by the file sapconfig.NODE file in the $LPHOME/constants directory.
(“NODE” is the name of the host as returned by uname -n.) A sample version of this file, with comments, is
provided as sapconfig.example file may be saved as sapconfig.NODE. Because this file contains login information,
make sure to set the permissions to 0600 and the owner to ‘ompsys2’.
The sapconfig file is a text file with lines of comma separated values. Lines that are blank or begin with a ‘#’
character are ignored. The first field is a single letter record type which determines which parameter field(s)
follow. The L and A records provide login and audit information for SAP target instances not defined in this file by T
records. Thus new targets may be defined in SAP LOMS definitions without having to modify this file. One or more
T records may be added to explicitly define targets and their information. This is useful when targets differ from
the default. The R record(s) define the ROMS this OM Plus node is serving as. If an OM Plus system is serving
multiple independent SAP systems, they must each access OM Plus using a different ROMS name and there would
be multiple entries here. The N records are needed if there is more than one OM Plus system serving an SAP
system. Although the name of the local system is not required, including it means that one can replicate this
configuration file to all the named systems.
P a g e 125 | 221
OM Plus Delivery Manager
L ID SAP login ID
SAMPLE
#----------------------------------------------------------------------------
# Sample SAP callback configuration file for OM Plus
#
# An edited copy of this file should be installed as
# $LPHOME/constants/sapconfig.NODENAME, where NODENAME
# is the node name of the OM Plus host (uname –n). It should be owned by
# ompsys2, permissions 600.
#
# The presence of constants/sapconfig.NODENAME will activate the SAP callback
# feature of dcce2enot. Changing
# (or just ‘touch’ing) this file will cause a soft restart of the SAP
# callback interface.
#
P a g e 126 | 221
OM Plus Delivery Manager
# Lines beginning with ‘#’ and blank lines are ignored.
#----------------------------------------------------------------------------
# ROMS entry(s):
# R,rom_id,initialtarget,retry secs.
R.OMPLUS,host1_N4S_42,120
N,host1
N,host2
N,prtserver
P a g e 127 | 221
OM Plus Delivery Manager
COMMAND REFERENCE
DCCSAPSUB
DEFINITION
FORMAT
dccsapsub
&T Title
&Y Priority
EXAMPLE
dccsapsub “&EI” &EG &P &F &o “&T” &C &Y &U “&E2” “&Es” “E1”
Note: The presence or absence of the quotation marks in this command is very important. Failure to copy these
commands exactly, with or without the appropriate quotation marks, could cause undesired behavior or, at the
least, an inability to print.
P a g e 128 | 221
OM Plus Delivery Manager
DCCSAPSTAT
DEFINITION
This command requests status information from the OM Plus for its SAP certified interface and can also cancel one
or more OM Plus request.
FORMAT
dccsapstat [ -d | -c | -j ]
PARAMETERS
EXAMPLES
Note: It is very important that the &EL parameter is not encapsulated in quotes
P a g e 129 | 221
OM Plus Delivery Manager
COMMAND REFERENCE
ARCADMIN
NAME
arcadmin
SYNOPSIS
Starts the OM Plus Archive administration screen.
SYNTAX
arcadmin
AVAILIBILITY
UNIX
DESCRIPTION
archadmin allows the user configure the OM Plus Archive module.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
archadmin: Opens the OM Plus Archive administration screen.
P a g e 130 | 221
OM Plus Delivery Manager
BUILDHTML
NAME
buildhtml
SYNOPSIS
Builds the web files necessary for the OM Plus web interface.
SYNTAX
buildhtml
AVAILIBILITY
UNIX/Windows
DESCRIPTION
buildhtml creates the files needed for the installation of the OM Plus web interface.
ARGUMENTS
None
Options
None
EXAMPLES
buildhtml: Creates the files for the web interface.
P a g e 131 | 221
OM Plus Delivery Manager
DCCACCEPT
NAME
dccaccept
SYNOPSIS
Sets a destination to accept output jobs.
SYNTAX
dccaccept -d [destination]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccaccept sets a destination to accept jobs that are spooled to it. If a destination is not set to accept jobs, those
jobs will be lost.
ARGUMENTS
<-d destination>: Selects destination to make active.
OPTIONS
[-r reason]: allows user to specify a reason for activating this destination.
EXAMPLES
dccaccept -dlp0: Sets destination “lp0” to active.
SEE ALSO
dccreject
P a g e 132 | 221
OM Plus Delivery Manager
DCCADMIN
NAME
dccadmin
SYNOPSIS
Starts the OM Plus Administration program.
SYNTAX
dccadmin
AVAILIBILITY
UNIX
DESCRIPTION
dccadmin starts the OM Plus administration program that allows the user to modify many of OM Plus’s settings,
manage destinations, start and stop most daemons, etc.
ARGUMENTS
None
Options
None
EXAMPLES
dccadmin: Starts the OM Plus administration program.
P a g e 133 | 221
OM Plus Delivery Manager
DCCASWEEP
NAME
dccasweep
SYNOPSIS
Checks the archive for files to be removed.
SYNTAX
dccasweep [option]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccasweep searches the archive for files that may be removed based on the archive settings and then removes
them.
ARGUMENTS
None
OPTIONS
[t]: Checks and removes only the files in the tmp directory.
EXAMPLES
dccasweep: Clears expired file from the archive.
P a g e 134 | 221
OM Plus Delivery Manager
DCCBKADMIN
NAME
dccbkadmin
SYNOPSIS
Enables the user interfaces to attach to OM Plus for administrative purposes.
SYNTAX
dccbkadmin
AVAILIBILITY
UNIX
DESCRIPTION
dccbkadmin enables the user interface to attach to the main programs for OM Plus.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccbkadmin: Enables the user interfaces to attach to the main programs for OM Plus.
P a g e 135 | 221
OM Plus Delivery Manager
DCCBKST
NAME
dccbkst
SYNOPSIS
Starts the OM Plus Network Status Server.
SYNTAX
dccbkst
AVAILIBILITY
UNIX
DESCRIPTION
dccbkst starts the OM Plus Network Status Server.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccbkst: Starts the OM Plus Network Status Server.
NOTES
You can use the OM Plus Network Status Server to accept and send OM Plus output queue and destination
statuses and commands between OM Plus systems over a TCP/IP network. This must be running on each system
requiring centralized management. OM Plus does not require the Network Status Server to send delivery requests
to other systems or applications supporting the LPD/LPR Protocol. The server listens to socket 53971 (the dccbkst
53971/tcp service in the etc/services file) by default for incoming OM Plus commands. It also uses this socket to
send queue and destination commands to other OM Plus systems.
SEE ALSO
dccbkshut
dccshut
P a g e 136 | 221
OM Plus Delivery Manager
DCCBKSTSHUT
NAME
dccbkstshut
SYNOPSIS
dccbkstshut
AVAILIBILITY
UNIX
DESCRIPTION
Stops the OM Plus Network Status Server.
ARGUMENTS
None
OPTIONS
[host_name]: Defaults include the node name of the system for the host_name. There must be an entry in the
/etc/hosts file for host_name and /etc/services file for dccbkst 53971/tcp.
EXAMPLES
dccbkstshut: Stops the OM Plus Network Status Server.
SEE ALSO
dccbkst
P a g e 137 | 221
OM Plus Delivery Manager
DCCCANCEL
NAME
dcccancel
SYNOPSIS
Cancels an active output job.
SYNTAX
dcccancel [argument]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dcccancel cancels an active output job. Jobs that have not printed and have been canceled will not print and jobs
currently de-spooling will stop.
ARGUMENTS
[-d destination_name]: Cancels the currently active output job for destination_name.
[I RIDxxxxx]: Cancels the output job with Request ID (RID) RIDxxxxx.
OPTIONS
[-k]: Cancels the output job with immediate purge.
EXAMPLES
dcccancels -d destination6: Cancels the currently active (printing) output job on destination6.
dcccancel -I RID0023: Cancels output job RID0023.
P a g e 138 | 221
OM Plus Delivery Manager
DCCDESTCHG
NAME
dccdestchg
SYNOPSIS
Moves all output jobs with a status of “ready” from one destination to another.
SYNTAX
dccdestchg [current_destination] [new_destination]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccdestchg moves all output jobs from one destination to another.
ARGUMENTS
current_destination: Current destination.
new_destination: New output destination.
OPTIONS
None
EXAMPLES
dccdestchg destination3 destination 9: Moves all output jobs currently queued in destination3 to destination9.
P a g e 139 | 221
OM Plus Delivery Manager
DCCDISABLE
NAME
dccdisable
SYNOPSIS
Disables a destination from printing.
SYNTAX
dccdisable –d [destination]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccdisable disables a destination. Any job that spools into this destination will not de-spool. If this destination is
defined in a class for load balancing, it will be skipped.
ARGUMENTS
<-d destination>: Destination to disable.
OPTIONS
None
EXAMPLES
dccdisable -d destination6: Disables destination6
SEE ALSO
dccenable
P a g e 140 | 221
OM Plus Delivery Manager
DCCE2ENOT
NAME
dcce2enot
SYNOPSIS
Starts the “End to End” notification service that sends information regarding requests to a remote server.
SYNTAX
dcce2enot
AVAILIBILITY
UNIX
DESCRIPTION
dcce2enot starts the notification daemon that is used to communicate with other OM Plus servers about requests.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dcce2enot
NOTES
dcce2enot and dcce2eser are typically started and stopped by the scheduler.
SEE ALSO
dcce2eser
P a g e 141 | 221
OM Plus Delivery Manager
DCCE2ESER
NAME
dcce2eser
SYNOPSIS
Starts the “End to End” service that receives information regarding requests from a remote server.
SYNTAX
dcce2eser
AVAILIBILITY
UNIX
DESCRIPTION
dcce2eser starts the daemon that handles communication between OM Plus servers about requests.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dcce2eser
NOTES
dcce2enot and dcce2eser are typically started and stopped by the scheduler.
P a g e 142 | 221
OM Plus Delivery Manager
DCCENABLE
NAME
dccenable
SYNOPSIS
Enables a destination for printing.
SYNTAX
dccenable –d [destination]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccenable enables printing a destination. Jobs will now de-spool (print) from this destination.
ARGUMENTS
<-d destination>: Destination to enable.
OPTIONS
None
EXAMPLES
dccenable -d destination6: Enables destinations6.
SEE ALSO
dccdisable
P a g e 143 | 221
OM Plus Delivery Manager
DCCFREE
NAME
dccfree
SYNOPSIS
Controls the licensing process in OM Plus.
SYNTAX
dccfree
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccfree allows the user to license their system or display the product status.
ARGUMENTS
None
Options
None
EXAMPLES
dccfree enable_file: Apply enable codes from file.
P a g e 144 | 221
OM Plus Delivery Manager
DCCGDISABLE
NAME
dccgdisable
SYNOPSIS
Disables all destinations.
SYNTAX
dccgdisable
AVAILIBILITY
UNIX
DESCRIPTION
dccgdisable disables all destinations.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccgdisable: Disables all destination queues.
SEE ALSO
dccgenable, dccdisable, dccenable
P a g e 145 | 221
OM Plus Delivery Manager
DCCGENABLE
NAME
dccgenable
SYNOPSIS
Enables all destinations.
SYNTAX
dccenable
AVAILIBILITY
UNIX
DESCRIPTION
dccgenable enables all destinations.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccgenable: Enables all destination queues.
SEE ALSO
dccgdisable, dccdisable, dccenable
P a g e 146 | 221
OM Plus Delivery Manager
DCCGRP
NAME
dccgrp
SYNOPSIS
Performs a specified function on a group of output jobs.
SYNTAX
dccgrp [command] [groups]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccgrp performs a specified function on a group of output jobs.
ARGUMENTS
Cancel: Cancels all output jobs in the group.
Form[new_form]: Changes the form for all output jobs in the group to new_form.
Dest[dest2]: Changes the destination for all output jobs in the group to dest2.
Purge: Sets the purge flag for all output jobs in the group.
Restart [n=+x]: Restarts all output jobs in the group at last page + x.
OPTIONS
[pr=x]: All output jobs with the priority x.
[date=job_date]: All output jobs with queue date job_date in the form of YY/MM/DD.
P a g e 147 | 221
OM Plus Delivery Manager
[n=new_form]: Selects the new form when the form command is used.
[n=new_destination]: Selects the new destination when the dest command is used.
[list]: Provides a list of RID numbers that match the given criteria.
[time=num]: Matches any job that is that many days old or older (counted in 24 hour increments). To specify time
in minutes or seconds , add an “m” or “s” immediately after the number.
EXAMPLES
dccgrp dest status=fpend n=destination3: Moves all output jobs with a status of fpend (form pending) to
destination3.
dccgrp restart st=intrd n=+0: Restarts all interrupted output jobs where they stopped.
NOTES
Syntax for changing destination is dccgrp dest [groups] n=[new_dest]
Syntax for restart is dccgrp restart [group] n=+x where x is the number of pages after the interruption to start.
P a g e 148 | 221
OM Plus Delivery Manager
DCCGSUSPEND
NAME
dccgsuspend
SYNOPSIS
Suspends (stops printing) all actively printing jobs on all destinations.
SYNTAX
dccgsuspend
AVAILIBILITY
UNIX
DESCRIPTION
dccgsuspend suspends (stops printing) all actively printing jobs on all destinations. Jobs will need to be released
manually.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccgsuspend: Suspends (stops printing) all actively printing jobs on all destinations.
P a g e 149 | 221
OM Plus Delivery Manager
DCCHEALTH
NAME
dcchealth
SYNOPSIS
Checks OM Plus install and outputs disrepancies.
SYNTAX
dcchealth
AVAILIBILITY
UNIX
DESCRIPTION
dcchealth checks to see if OM Plus is installed correctly and outputs any found disrepancies. This program can
quickly determine and display many basic problems with the OM Plus system, such as permission settings and
corrupted queue entries.
ARGUMENTS
[-c] Display a formatted screen to view progress and results.
OPTIONS
None
EXAMPLES
dcchealth –cf: Displays a formatted screen along with fixing problems, if possible.
P a g e 150 | 221
OM Plus Delivery Manager
DCCINFO
NAME
dccinfo
SYNOPSIS
Lists important information about OM Plus and the system on which it is installed.
SYNTAX
dccinfo
AVAILIBILITY
UNIX
DESCRIPTION
dccinfo lists important information regarding OM Plus and the system on which it is installed.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccinfo: Outputs information regarding the system.
NOTES
Version = Displays version number.
P a g e 151 | 221
OM Plus Delivery Manager
File System Free Bytes = Free space in file system (in bytes).
P a g e 152 | 221
OM Plus Delivery Manager
DCCLOGMSG
NAME
dcclogmsg
SYNOPSIS
Generates an entry in the log.
SYNTAX
dcclogmsg [text]
AVAILIBILITY
UNIX
DESCRIPTION
dcclogmsg creates a new entry in the log.
P a g e 153 | 221
OM Plus Delivery Manager
DCCLOGREP
NAME
dcclogrep
SYNOPSIS
Generates a formatted error log report.
SYNTAX
dcclogrep [options]
AVAILIBILITY
UNIX
DESCRIPTION
dcclogrep generates a formatted error log report.
ARGUMENTS
pw=w Page width. W=100-255. Default is 78.
OPTIONS
[n]: Specifies the number of columns to use for this field.
day=n
date=n
time=n
year=n
lpxnum=n
P a g e 154 | 221
OM Plus Delivery Manager
ridnum=n
message=n
program=n
EXAMPLES
dccloggrep –c date=6 time=8 lpxnum=7 rid=8 message: Starts an interactive program that will allow setup of the
report format with columns for date, time, lpxnumber, rid and message.
NOTES
Columns appear in the order they are listed in the command line.
P a g e 155 | 221
OM Plus Delivery Manager
DCCLP
NAME
dcclp
SYNOPSIS
Main spooling command for OM Plus.
SYNTAX
dcclp [argument] file_name
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dcclp submits output jobs to destinations and changes output jobs after they are in the output queue.
ARGUMENTS
[-d destination]: Desired destination, if not specified the default destination is used.
[-o option(s)]: Used for passing a variety of data to the program. Often used in custom solutions.
[-S character_set]: Specifies an optional character set to use. Not available on HP or AIX systems.
P a g e 156 | 221
OM Plus Delivery Manager
[-T {graphics/simple/post/postNR/ postDSC/pcl-1/pcl-2/pclxl/zpl}]: Specifies the file type for the output job. The
default is for OM Plus to attempt to determine what type of file is being spooled.
This can be overwritten by specifying the file type. See the File Types reference for more information.
COMMON OPTIONS
Archive, arch, archk, archivek, archu, archiveu, archuk, archiveuk: Archives the request when it purges. U means
uncompressed, k means keep regardless of retention time.
nofilebreak, nofb, nof, minusff: Turns off form feeds after each file.
nolfconv, nolfc: Does not do line feed to line feed carriage return conversion.
raw, -raw, r, -r: When printing in lpd/lpr mode this tells receiving end not to manipulate data.
restart=nnnnnnn[p]: Restarts at page nnnnnnn. If the [p] option is added to the end of the page number, OM Plus
will attempt a printer level restart.
tran=afile: Tells OM Plus that the translate table file should be used.
EXAMPLES
dcclp –d destination9 /usr/files/file4: Sends job to destination9.
dcclp –d destination2 –f checks /usr/files/file2: Allows desired standard form. May be a custom form created
through OM Plus administration or any form name. If not specified, the default form is used.
P a g e 157 | 221
OM Plus Delivery Manager
dcclp –d destination5 –h /usr/files/file9: Places the job currently printing on destination5 on hold.
dcclp –i RID0217 –f checks –d dstination3 –n 3: Changes job 0217 output destination to destination3, changes the
required form to checks and changes the number of copies to 3.
dcclp –d destination2 –o banner /usr/files/file2: Turns banner on for the print file.
dcclp –d destination4 –o banner /usr/files/file3: Turns off purge for this print job.
dcclp –d destination2 --p landscape /usr/files/file1: Sends the preload and optional postload file
$LPHONE/prtcntl/landscape/preload to the destination before the print request.
dcclp –d destination1 –s /usr/files/file10: Turns off the verbose information provided when the output job is
submitted.
dcclp –d destination8 –t report6 /usr/files/file6: Changes the title of output job. The default is the file name or
STDIN if piped into dcclp.
dcclp –d destination7 –T postDSC /usr/files/file2: Tells OM Plus that the file is a PostScript file that conforms to the
Document Structuring Conventions (DSC).
dcclp –d destination9 –W 11/30/12,03:10 /usr/files/file4: Sets the job to print at 3:10 AM on the 30th of November
2012.
Note: dcclp has more options than are discussed in this section. For more information on other dcclp options, please
see the “dcclp options” appendix to this manual.
P a g e 158 | 221
OM Plus Delivery Manager
DCCLPDSER
NAME
dcclpdser
SYNOPSIS
Starts the OM Plus Line Print Daemon (LPD) Server.
SYNTAX
dcclpdser hostname service_name
AVAILIBILITY
UNIX
DESCRIPTION
dcclpsder starts the OM Plus Print Daemon (LPD) Server. Must be an entry in the /etc/hosts file for host_name and
/etc/services file for service_name.
ARGUMENTS
[host_name]: Default is node name.
OPTIONS
None
EXAMPLES
dcclpdser: Starts the OM Plus LPD Server with default settings.
dcclpdser bighost destination: Starts the OM Plus LPD Server using the host_name, bighost and service destination,
from the /etc/services file.
NOTES
OM Plus uses the LPD Server to accept output jobs from other applications that support the LPD/LPR Protocol over
the TCP/IP network. OM Plus does not require the LPD Server to send output requests to other applications
supporting the LPD/LPR Protocol. The LPD Server listens to socket 515 by default (destination service in the
/etc/services file) for incoming output jobs. Because only one application can listen to a socket at a time, if the
Unix lp line print daemon is already listening to socket 515 (destination tcp/515 in the /etc/services file) the OM
Plus dcclpdser will fail. Consult your Network Administration documentation for information on stopping the Unix
line print daemon.
P a g e 159 | 221
OM Plus Delivery Manager
DCCLPDSHUT
NAME
dcclpdshut
SYNOPSIS
Stops the OM Plus Line Printer Daemon (LPD).
SYNTAX
dcclpdshut hostname service_name.
AVAILIBILITY
UNIX
DESCRIPTION
dcclpdshut stops the OM Plus Line Print Daemon (LPD) Server.
ARGUMENTS
[host_name]: Default is node name.
OPTIONS
None
EXAMPLES
dcclpdshut: Stops the OM Plus LPD Server with default settings.
dcclpdshut bighost destination: Stops the OM Plus LPD on host bighost and service called destination.
P a g e 160 | 221
OM Plus Delivery Manager
DCCLPLINK
NAME
dcclplink
SYNOPSIS
Replaces the native UNIX lp command with dcclp command.
SYNTAX
dcclplink
AVAILIBILITY
UNIX
DESCRIPTION
dcclplink archives the current UNIX lp command and replaces it with a symlink pointed to dcclp. It also provides the
option to start the lpd daemon on automatically and to capture lpd requests.
SEE ALSO
dcclpunlink
Note: When upgrading the OS on a system it is imperative that you run DCCLPUNLINK prior to the upgrade.
Failure to do so may overwrite key OM Plus files. After the upgrade has completed you may run dcclplink again
to restore the links.
P a g e 161 | 221
OM Plus Delivery Manager
DCCLPR
NAME
dcclpr
SYNOPSIS
Provides LPR functionality and compatibility to dcclp.
SYNTAX
dcclpr -PQueue_Name [-S Server_Name] File_Name
AVAILIBILITY
UNIX
DESCRIPTION
dcclpr accepts traditional lpr commands and transform them into dcclp commands.
ARGUMENTS
-PQueue_Name: Desired queue
EXAMPLES
dcclp -PPrint1 -SOMServ file.txt to the queue “Print1” on “OMServ”
SEE ALSO
dcclpd
P a g e 162 | 221
OM Plus Delivery Manager
DCCLPUNLINK
NAME
dcclpunlink
SYNOPSIS
Unlinks dcclp from the native UNIX lp command.
SYNTAX
dcclpunlink
AVAILIBILITY
UNIX
DESCRIPTION
dcclpunlink removes any links created by dcclplink.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dcclpunlink: unlinks lp from dcclp.
SEE ALSO
dcclplink
P a g e 163 | 221
OM Plus Delivery Manager
DCCMOUNT
NAME
dccmount
SYNOPSIS
Mounts a form on a destination.
SYNTAX
dccmount –d destination_name –f form_name
AVAILIBILITY
UNIX
DESCRIPTION
dccmount mounts a form on a destination.
ARGUMENTS
[-d destination]: Destination to mount form.
OPTIONS
None
EXAMPLES
dccmount –d destination3 –f checks: Mounts the form checks on destination3.
P a g e 164 | 221
OM Plus Delivery Manager
DCCMSGHELP
NAME
dccmsghelp
SYNOPSIS
Decrypts message and error numbers from OM Plus.
SYNTAX
dccmsghelp
AVAILIBILITY
UNIX
DESCRIPTION
dccmsghelp runs the message and erno description program.
ARGUMENTS
[message number]: Writes the text about this message number to stdout.
OPTIONS
None
EXAMPLES
dccmsghelp LPP376E: Looks up and displays the help text about message LPP363E.
dccmsghelp -n131: Looks up and displays the description of an errno 131 for your OM Plus Server’s operating
system.
P a g e 165 | 221
OM Plus Delivery Manager
DCCNETSTAT
NAME
dccnetstat
SYNOPSIS
Check destination and queue status on LPD/LPR systems without OMP installed.
SYNTAX
dccnetstat –d destination_name
AVAILIBILITY
UNIX
DESCRIPTION
dccnetstat uses the LPD/LPR protocol to receive status information if OM Plus is not installed on that system.
ARGUMENTS
[-d destination_name]: Specifies destination to check.
[-h Host_Name]: Checks for the presence of the given host and whether or not the scheduler is running on that
host.
OPTIONS
None
EXAMPLES
dccnetstat –d destination3: Displays the remote systems queue information for the local destnation destination3.
NOTES
OM Plus uses the Network Server Status program to receive status information from systems supporting the
LPD/LPR Protocol. The destination_name must be a valid OM Plus destination with the netprint or system mode.
The information returned displays as it is received from the remote system.
P a g e 166 | 221
OM Plus Delivery Manager
DCCPRTVAL
NAME
dccprtval
SYNOPSIS
Programmatic way to get information from a printer configuration file.
SYNTAX
dccprtval printer_name tag
AVAILIBLITY
UNIX
DESCRIPTION
dccprtval looks up the value of given tag in destination’s configuration file.
ARGUMENTS
printer_name: Name of destination.
OPTIONS
None
EXAMPLES
dccprtval Printer Device: Returns the device information for the destination “Printer”.
P a g e 167 | 221
OM Plus Delivery Manager
DCCQVAL
NAME
dccqval
SYNOPSIS
Returns information from a print queue file.
SYNTAX
dccqval RID##### tag
AVAILIBILITY
UNIX
DESCRIPTION
dccqval returns information from a given request’s queue file when given the proper tag.
ARGUMENTS
RID#####: The RID of the request to query.
OPTIONS
None
EXAMPLES
dccqval RID01717 ST: Returns the status of request 01717.
P a g e 168 | 221
OM Plus Delivery Manager
DCCRANGE
NAME
dccrange
SYNOPSIS
Prints a range of pages from an existing OM Plus job.
SYNTAX
dccrange RIDxxxx r=sssss-eeeee
AVAILIBILITY
UNIX/Windows
DESCRIPTION
Prints a range of pages from an existing OM Plus job. Spools another output job consisting of pages sssss to eeeee.
ARGUMENTS
RIDxxxx: Requests ID for the output job.
R=sssss-eeeee: Range of pages to print from the output job. Spools another output job consisting of pages sssss
through eeeee.
OPTIONS
[d=destination_name]: Specifies destination.
EXAMPLES
dccrange RID00024 r=10-235: Prints pages 10-235 from RID0024 on the same destination.
dccrange RID0024 r=10-235 d=destination3: Sends the range of pages to a new destination.
dccrange RID0024 r=10-235 d=destination3 f=checks: Sends the range of pages to another destination and
specifies the form “checks”.
P a g e 169 | 221
OM Plus Delivery Manager
DCCRDEDIT
NAME
dccrdedit
SYNOPSIS
Opens the Report Distributor editor.
SYNTAX
dccrdedit
AVAILIBILITY
UNIX
DESCRIPTION
dccrdedit opens the Report Distributor configuration screen.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccrdedit: Opens the Report Distributor screen.
P a g e 170 | 221
OM Plus Delivery Manager
DCCREJECT
NAME
dccreject
SYNOPSIS
Sets a destination to reject output jobs.
SYNTAX
dccreject –d destination_name
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccreject sets a destination to reject output jobs. While the destination is rejecting, no output jobs will spool.
ARGUMENTS
[-d destination_name]: Selects the destination to set to reject.
OPTIONS
None
EXAMPLES
dccreject –d destination6: Sets destination6 to reject output jobs.
P a g e 171 | 221
OM Plus Delivery Manager
DCCRESET
NAME
dccreset
SYNOPSIS
Resets portions of the destination’s status.
SYNTAX
dccreset –d printername [-s -l -a -r]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccreset allows portions of a destination’s status to be reset.
ARGUMENTS
-d printername: The name of the destination on which to act.
EXAMPLES
dccreset -d printer -sa: Resets the known SNMP status of “printer” while stopping the currently active request and
setting its status to “interrupted”.
P a g e 172 | 221
OM Plus Delivery Manager
DCCSAPSTAT
NAME
dccsapstat
SYNOPSIS
Requests status information from OM Plus for its SAP certified interface.
SYNTAX
dccsapstat
AVAILIBILITY
UNIX
DESCRIPTION
This command requests status information from OM Plus for its SAP certified interface.
ARGUMENTS
&P: SAP Destination Name.
OPTIONS
None
EXAMPLES
dccsapstat “&P” &EL
NOTES
It is very important that the &EL parameter is not encapsulated in quotes.
P a g e 173 | 221
OM Plus Delivery Manager
DCCSAPSUB
NAME
dccsapsub
SYNOPSIS
Submits requests to OM Plus’s SAP interface.
SYNTAX
dccsapsum <arguments>
AVAILIBILITY
UNIX
DESCRIPTION
This command submits requests to OM Plus’s SAP certified interface.
ARGUMENTS
&EI: SAP spool ID
&T: Title
&Y: Priority
OPTIONS
None
EXAMPLES
dccsapsub “&EI” “&EG” “&P” “&F” “&o” “T” “&C” “&Y” “&U” “&E2” “&Es”
P a g e 174 | 221
OM Plus Delivery Manager
DCCSCAN (UNIX)
NAME
dccscan
SYNOPSIS
Looks at a specified directory for files to print.
SYNTAX
dccscan directory_path cycle_time delay_time dcclp_options
AVAILIBILITY
UNIX
DESCRIPTION
dccscan looks at a specified directory for files to print.
ARGUMENTS
directory_path: Full pathname to an existing directory to scan for files.
cycle_time: cycle_time refers to the number of seconds between scans to see if a file is in the directory.
delay_time: Amount of time in seconds to delay after the file is no longer being written before spooling begins.
This ensures that the application is finished writing the file before OM Plus spools the output job.
dcclp_options: Text that will complete the rest of the dcclp command executed when a file is found.
OPTIONS
None
EXAMPLES
dccscan /tmp/dir 30 5 “-d destination -h -s onopurge”: Scans /tmp/dir every 30 seconds. The delay_time is 5
seconds, which means the amount of time in seconds to delay writing the file before OM Plus spools the output
job. The dcclp options for the scanned files are getting routed to a destination with a hold option (-h) and silence
option (-s) the –o option set to no purge.
P a g e 175 | 221
OM Plus Delivery Manager
DCCSCAN (WINDOWS)
NAME
dccscan
SYNOPSIS
Starts the OM Scan Service
SYNTAX
dccscan
AVAILIBILITY
Windows
DESCRIPTION
dccscan looks at a specified directory for files to print.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccscan
P a g e 176 | 221
OM Plus Delivery Manager
DCCSCHED
NAME
dccsched
SYNOPSIS
Starts the OM Plus scheduler service.
SYNTAX
dccsched
AVAILIBILITY
UNIX
DESCRIPTION
dccsched starts the OM Plus output scheduler. If the scheduler is not running, no jobs will print through OM Plus.
Also starts the End to End status and notification services (dcce2e and dcce2enot) to allow communication
between OM Plus servers.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccsched: Starts the scheduler.
P a g e 177 | 221
OM Plus Delivery Manager
DCCSHUT
NAME
dccshut
SYNOPSIS
Stops the OM Plus scheduler.
SYNTAX
dccshut
AVAILIBILITY
UNIX
DESCRIPTION
dccstop stops the scheduler after all currently printing jobs are finished. No new jobs will de-spool.
ARGUMENTS
[all] : Shuts down all running OM Plus processes.
[-t <service>] : Test. This function checks to see if the service is running, but does not issue a shut down command.
OPTIONS
None
EXAMPLES
dccshut: Shuts down the scheduler after the completion of any active print jobs.
dccshut -i: Stops the scheduler even if there are active jobs.
P a g e 178 | 221
OM Plus Delivery Manager
DCCSTAT
NAME
dccstat
SYNOPSIS
Starts the OM Plus Status and Control program.
SYNTAX
dccstat
AVAILIBILITY
UNIX
DESCRIPTION
dccstat starts the OM Plus Status and Control program in request mode and displays all output jobs and
destinations.
ARGUMENTS
None
OPTIONS
[-d destination]: Starts the OM Plus Status and Control program and only displays output jobs for the specified
destination.
[-u user_id]: Starts the OM Plus Status and Control program and displays only the requests for the specified user
ID.
EXAMPLES
dccstat: Starts the OM Plus Status and Control program in request mode and displays all request and destinations.
dccstat –d destination2: Starts the OM Plus Status and Control program in request mode and displays only the
request and print destintions for destination2.
dccstat –u bob: Starts the OM Plus Status and Control program in request mode and displays only the requets for
the user bob.
dccstat –u $LOGNAME: Starts the OM Plus Status and Control program in request mode and displays only the
requests for the user currently logged in.
P a g e 179 | 221
OM Plus Delivery Manager
DCCSTATDEF
NAME
dccstatdef
SYNOPSIS
Allows the administrator to set up the Status screen.
SYNTAX
dccstatdef
AVAILIBILITY
UNIX
DESCRIPTION
dccstatdef opens an editor that allows the administrator to customize the Status screen.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccstatdef: Opens the Status screen editor.
P a g e 180 | 221
OM Plus Delivery Manager
DCCSUSPALL
NAME
dccsuspall
SYNOPSIS
Suspends all print jobs in OM Plus.
SYNTAX
dccsuspall
AVAILIBILITY
UNIX
DESCRIPTION
dccsuspall suspends all print jobs in OM Plus.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
dccsuspall: Will display a y/n prompt asking if all print jobs should be suspended. If “y” is selected, then all print
jobs will be suspended.
P a g e 181 | 221
OM Plus Delivery Manager
DCCSUSPEND
NAME
dccsuspend
SYNOPSIS
Suspends currently printing output job.
SYNTAX
dccsuspend
AVAILIBILITY
UNIX/Windows
DESCRIPTION
dccsuspend will suspend (stop printing) a currently printing output job.
ARGUMENTS
[-d destination_name]: Suspends the currently printing output job for destination_name.
OPTIONS
None
EXAMPLES
dccsuspend –d destination6: Suspends currently printing output job on destination6.
P a g e 182 | 221
OM Plus Delivery Manager
DCCSWITCH
NAME
dccswitch
SYNOPSIS
Routes output job from one destination to a new destination to a new destination.
SYNTAX
dccswitch original_destination new_destination.
AVAILIBILITY
UNIX/Windows
DESCRIPTOIN
dccswitch will route jobs intended for a specified destination to another destination.
ARGUMENTS
original_destination new_destination: All requests waiting to print on original_destination to be delivered on
new_destination.
OPTIONS
None
EXAMPLES
dccswitch destination2 destination8: Switch request from destination2 to destination8.
dccswitch destination2: Switch request from destination2 to destination found in ALT_des in the destination2
configuration file.
NOTES
The status information will still show the requests with their original destinations. The actual switching occurs at
de-spooling not at spooling. To switch back after the original destination is again able to print, switch the
destination to none. This action can have unintended results if extreme caution is not taken. Please contact
support before using this command as there may be other, safer methods to achieve the same effect.
P a g e 183 | 221
OM Plus Delivery Manager
DCCVIEW
NAME
dccview
SYNOPSIS
Executes the OM Plus viewer.
SYNTAX
dccview RIDxxxxx
AVAILIBILITY
UNIX
DESCRIPTION
dccview executes the OM Plus file viewer. This is usually accomplished through the Status and Control program
dccstat.
ARGUMENTS
[RIDxxxxx]: Refers to the Request ID number for the output job to view.
OPTIONS
None
EXAMPLES
dccview RID00233: Views report with the Request ID of RID00233.
P a g e 184 | 221
OM Plus Delivery Manager
DISABLE
NAME
disable
SYNOPSIS
Disables a destination from printing.
SYNTAX
disable –d [destination]
AVAILIBILITY
UNIX
DESCRIPTION
“disable” disables a destination. Any job that spools into this destination will not de-spool. If this destination is
defined in a class for load balancing, it will be skipped.
ARGUMENTS
<-d destination>: Destination to disable.
OPTIONS
None
EXAMPLES
disable -d destination6: Disables destination6
SEE ALSO
enable, dccdisable, dccenable
P a g e 185 | 221
OM Plus Delivery Manager
ENABLE
NAME
enable
SYNOPSIS
Enables a destination for printing.
SYNTAX
enable –d [destination]
AVAILIBILITY
UNIX
DESCRIPTION
“enable” enables printing on a destination. Jobs will now de-spool (print) from this destination.
ARGUMENTS
<-d destination>: Destination to enable.
OPTIONS
None
EXAMPLES
enable-d destination6: Enables destination6.
SEE ALSO
disable, dccenable, dccdisable
P a g e 186 | 221
OM Plus Delivery Manager
HEXDUMP
NAME
hexdump
SYNOPSIS
Takes data entering the program and outputs it as hex.
AVAILIBILITY
UNIX
SYNTAX
hexdump file_out
DESCRIPTION
hexdump takes data entering the program either as a specified file or through standard in outputs it as hex.
ARGUMENTS
file_out: The file to write the contents of the hex dump to.
OPTIONS
None
EXAMPLES
hexdump output: The file “output” from the current directory will be opened and reported as hex.
P a g e 187 | 221
OM Plus Delivery Manager
INSTALLCDPLUS
NAME
installcdplus
SYNOPSIS
Installs the Content Delivery component.
SYNTAX
installcdplus
AVAILIBILITY
UNIX
DESCRIPTION
installcdplus create and moves into place the files required for the Content Delivery module.
ARUGMENTS
None
OPTIONS
None
EXAMPLES
installcdplus: Installs Content Delivery Plus.
P a g e 188 | 221
OM Plus Delivery Manager
LPADMIN
NAME
lpadmin
SYNOPSIS
Add, modify, and delete the OM Plus destination configuration.
SYNTAX
lpadmin -p destination_name
AVAILIBILITY
UNIX/Windows
DESCRIPTION
lpadmin allows the user to add, modify, and delete the OM Plus destination configuration.
ARGUMENTS
[-c class]: Changes class for destination.
OPTIONS
[-o altdest=<dest>]: Sets the alternate destination.
P a g e 189 | 221
OM Plus Delivery Manager
[-o cmd1=command]: Secure Queue Release (SQR) label to show on the printer panel if the SQR version of My
Print Delivery (MPD) is being used. If SQR of MPD is not being used, then field should be set to none although any
value is acceptable.
[-o filesometimes]: Inserts a form feed at the end of a file if one is not already there.
[-o protadd]: This should be set to the snmp community string value if snmp is turned on.
P a g e 190 | 221
OM Plus Delivery Manager
[-o url=<url>]: Inputs the url of the printer’s internal web server.
[-o url_address]: Inputs the url of the printer’s internal web server.
[-o usrfilter]: Designates a user defined program through which to pass data. This must be a fully defined path to a
local file.
EXAMPLES
lpadmin -plaser -vhost!9100 –o mode=termserv –oolfc: This adds a network destination named “laser” and
translate line feeds to carriage return line feeds.
P a g e 191 | 221
OM Plus Delivery Manager
LPLINKONLY
NAME
lplinkonly
SYNOPSIS
Creates a symlink redirecting the system’s native lp command to dcclp.
SYNTAX
lplinkonly
AVAILIBILITY
UNIX
DESCRIPTION
lplinkonly creates a symlink redirecting native lp to dcclp. This differs from dcclplink in the number of options
available when running.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
lplinkonly: Creates a symlink redirecting native lp to dcclp.
Note: When upgrading the OS on a system it is imperative that you run DCCLPUNLINK prior to the ugrade.
Failure to do so may overwrite key OM Plus files. After the upgrade has completed you may run lplinkonly
again to restore the links.
P a g e 192 | 221
OM Plus Delivery Manager
LPPUSERS
NAME
lppusers
SYNOPSIS
Places a list of users into groups.
SYNTAX
lppusers [-c] file_name
AVAILIBILITY
UNIX/Windows
DESCRIPTION
lppusers takes a comma separated file and saves the values as users and associated groups.
ARGUMENTS
File_name: The name of the file to be used to create or append the new user list.
OPTIONS
[-c]: If used, the current user list will be deleted and a new list created.
EXAMPLES
lppusers -c file_name: Deletes the current user list, then imports the contents of “file_name” as the new list.
SEE ALSO
omplogusers, ompremusers
P a g e 193 | 221
OM Plus Delivery Manager
LPSTAT
NAME
lpstat
SYNOPSIS
Reports the status of jobs and queues in OM Plus.
SYNTAX
lpstat [arguments]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
lpstat can report the status of jobs and destinations in OM Plus.
ARGUMENTS
[-a]: Shows whether destinations are currently accepting or rejecting requests (UNIX only).
EXAMPLES
lpstat: Returns a list of requests in the standard lpstat format.
P a g e 194 | 221
OM Plus Delivery Manager
OMLOGUSERS
NAME
omlogusers
SYNOPSIS
Updates the login users list.
SYNTAX
omplogusers [-c] file_name
AVAILIBILITY
UNIX/Windows
DESCRIPTION
omplogusers takes a comma separated file and uses that to update the list of login users.
ARGUMENTS
file_name: The name of the file to be used to create or append the login users list.
OPTIONS
[-c]: If used, the current login users list will be deleted and a new list will be written using the file.
omlogusers file_name: Appends the contents of file_name to the login users lists.
SEE ALSO
lppusers, ompremusers
P a g e 195 | 221
OM Plus Delivery Manager
OMPREMOVE
NAME
ompremove
SYNOPSIS
Removes the OM Plus system and its components.
SYNTAX
ompremove
AVAILIBILITY
UNIX
DESCRIPTION
ompremove removes the OM Plus system and its components.
ARGUMENTS
None
OPTIONS
None
EXAMPLES
ompremove: Removes OM Plus and its components.
P a g e 196 | 221
OM Plus Delivery Manager
OMQDEPTH
NAME
omqdepth
SYNOPSIS
Returns the number of jobs currently in the queue for a given destination.
SYNTAX
omqdepth [-hHost] -dDestination
AVAILIBILITY
Windows
DESCRIPTION
omqdepth returns the number of requests currently queued for a destination.
ARGUMENTS
-dDestination: The name of the destination.
OPTIONS
[-hHost]: The name of a remote host containing the destination.
EXAMPLES
omqdepth -hPServer -dBundle: Will return the number of requests in the queue for the destination”Bundle” on the
host “PServer”.
P a g e 197 | 221
OM Plus Delivery Manager
OMREMSETUP
NAME
omremsetup
SYNOPSIS
Configures the remote services.
SYNTAX
omremsetup [-s host] [-r host] [-x] [-d] [-h pinghost] [-a y/n] [-t y/n] [-f] [-p]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
omremsetup allows for the configuration of the OM Plus remote services allowing destinations shared across OM
Plus servers.
OPTIONS
[-s host]: Adds an additional send host.
[-c]: Tells the server to send the printer type configuration file with the destination list.
EXAMPLES
omremsetup -s host1 -f: Will add host1 to the sendHosts file and forces an update to be sent to all servers in the
sendHost file.
omremsetup -r host2 -d: Will delete host2 from the recieveHosts file.
P a g e 198 | 221
OM Plus Delivery Manager
omremsetup -h sendServer: Sets the broadcast name for this server to sendServer.
P a g e 199 | 221
OM Plus Delivery Manager
OMRESOLVE
NAME
omresolve
SYNOPSIS
Resolves the IP address for a given hostname.
SYNTAX
omresolve [hostname]
AVAILIBILITY
UNIX/Windows
DESCRIPTION
omresolve returns the IP address and domain name of a system.
ARGUMENTS
[hostname]: Hostname to be resolved. If this is not given, omresolve will report information for the local system.
OPTIONS
NONE
EXAMPLES
omresolve server1: Returns the IP address and domain for server1.
P a g e 200 | 221
OM Plus Delivery Manager
OM Plus has the ability to watch for specific events to occur in the printing process and then take action based on
that event. Specific events have been set up so that when they occur, variables are passed and a shell script
executes (%OMHOME%\event\script_name for Windows and $LPHOME/event/script_name for UNIX). These shell
scripts are tied directly to an event.
The event scripts are completely customizable so that there is flexibility with what can be done when an event
occurs. The following table describes each event and the shell scripts executed when they occur. The event scripts
are located in the %OMHOME%\event folder for Windows and the $LPHOME/event directory for UNIX.
For clarity, the descriptions of the events have been divided by operating system. These scripts are designed so the
OM Plus administrator can modify them as needed.
Note: On UNIX systems the file permissions of these scripts is very important. If the file is writeable by anyone but
the owner the script will not be executed and an error will be recorded in the log.
For information on the event scripts in a Windows environment and their descriptions, refer to the following table.
Event scripts for Windows are in batch (.bat) files.
Script Executes
accept.bat When a destination is set to accept.
arch_err.bat When a request failed to archive correctly.
archiveLog.bat When a log file is archived to the ..\messages\log_archive directory.
cancel.bat When a job is canceled.
connectfail.bat When a network destination has failed its connection.
demon.bat When any OMPlus demon is started or stopped.
destchg.bat When a destination is added, modified, or deleted.
disable.bat When a destination is disabled.
enable.bat When a destination is enabled.
formmount.bat When a new form has been mounted on a destination.
formpending.bat When an output job requires a form that is not mounted on the destination. The output
job reflects a status of form pending (fpend).
lpdfail.bat When an error occurs during an LPD/LPR transfer using netprint, system, or LPPLUS
mode destinations. This script contains the error retry/recovery/failure logic for LPD.
openfail.bat When a non-network destination has failed its connection.
prepurge.bat
prtunavail.bat When a destination request is queued for a disabled printer.
purge.bat When an output has been purged from the OM Plus queue system. This happens after
an output job is canceled or has printed, and after the destination’s purge delay time has
elapsed.
rcvhostremoved.bat When the specified host is removed from the list of hosts from which destination are
received.
reject.bat When a destination is set to reject.
remotedest.bat When remote destinations are either sent or received.
retry.bat When a request gains a retry status.
P a g e 201 | 221
OM Plus Delivery Manager
P a g e 202 | 221
OM Plus Delivery Manager
For information on the event scripts on all supported UNIX and Linux operating system and their description, refer
to the following table.
Script Executes
arch_err.sh When a request failed to archive correctly.
cancel.sh When a job is canceled.
connectfail.sh When a termserv or OMPLUS mode destination has failed to make a network connection.
demon.sh When any OM Plus daemon is started or stopped.
disable.sh When a destination has been disabled.
destchg.sh When a destination is added, changed or deleted.
destsync.sh When a destination is added, change or deleted the destinations will be updated on another
server.
enable.sh When a destination has been enabled.
formmount.sh When a form has been mounted on a destination.
formpending.sh When an output job requires a form that is not mounted on the destination. The output job
reflects a status of form pending (fpend).
initialized.sh When the master server syncs destinations, classes, and models with a backup server.
interface.sh When a destination interface script completes. This occurs for all destinations when any job
attempts to print (de-spool).
logsize.sh When the $LPHOME/messages/log.<hostname> ‘log file’ increases to 10 megabytes. This
script will rename the current log to log.old and the system will create a new working log.
lpdfail.sh When an error occurs during an LPD/LPR transfer using netprint, system, or LPPLUS mode
destinations. This script contains the error retry/recovery/failure logic for LPD.
sysnotify.sh When a destination upon an error sends an email/alert.
sysnotifytext.sh When a destination upon an error sends an email/alert were you can customize the header
and message of the email.
openfail.sh When a non-network destination has failed its connection.
prtunavail.sh When an output job has been submitted to a disabled destination.
purge.sh When an output is to be purged from the OM Plus queue.
remotedests.sh When remote destinations are either sent or received.
spooler.sh When the spooling process ends.
toobig.sh When a job with more than the maximum allowed pages is spooled.
toodumb.sh When the data type of the request differs from data types defined supported by the
destination.
writefail.sh When an output job fails during printing. The output job will be marked interrupted (intrd)
and the destination will be disabled.
P a g e 203 | 221
OM Plus Delivery Manager
ENVIRONMENT VARIABLES
There are several environment variable that can be set that will affect how the OM Plus system performs in one
way or another.
ACCEPTUNKNOWN
Possible Values: y or Y
If this variable is set it will cause the LPD listening service to accept an incoming request that specifies a destination
that is not defined to OM Plus. The request will appear in the Request Status with a status of ready and a
destination of ‘Unknown’.
COPYBREAK
UNIX
Possible Values: y or n
If set, this will cause dcclp to automatically append the copybreak or no copybreak command line parameter to all
jobs spooled.
DATATYPE
UNIX
If set, this will cause dcclp to automatically assign the specified data type to all spooled requests.
FILEBREAK
UNIX
Possible Values: y or n
If set, this will cause dcclp to automatically append the filebreak or no filebreak command line parameter to all
jobs spooled.
P a g e 204 | 221
OM Plus Delivery Manager
HOLDPRINTED
UNIX
Possible Values: y or n
If set, this will cause dcclp to append a hold command to all jobs entering the system.
LPDEST
Sets the default printer for the user in the case that none is specified on the command line.
LPDGRAPHICS
UNIX
Possible Values: N or n
If this variable is set, then OM Plus will attempt to da a data type selection regardless of the presence of the ‘raw’
attribute in the control file, which would normally result in OM Plus setting the datatype to “graphics.”
LPPATTR
Possible Values: B, b, R, r, N, n
Sets the highlighting attribute of the ‘dccstat’ program. Use LPPARRT for a user’s preference or when there are
problems with terminals supporting the defaults. Without being set, dccstat displays the OM Plus version number
and the command options in reverse video and the current cursor position is displayed in bold. Based on these
default settings, the valid optins are:
P a g e 205 | 221
OM Plus Delivery Manager
N or n – no highlighting
LPPAUTO
UNIX
Sets the update and refresh interval for the ‘dccstat’ program. Values are in seconds.
LPPAUTOMODE
UNIX
Possible Values: U or R
Sets the mode that the ‘dccstat’ program uses to automatically update the screen.
U – Update OM Plus queues in real time. New jobs appear and purged jobs disappear.
R – Refresh OM Plus queues. Only updates the current screens information (job status and page counts).
LPPCONFIRM
UNIX
Possible Values: Y
OMPLUSACK
UNIX
Possible Values: Y
Causes the email mode printer to make the data of the spool file the body of the email generated by an email
mode printer instead of an attachment.
P a g e 206 | 221
OM Plus Delivery Manager
PRTCNTL
UNIX
If set, this will cause dcclp to automatically set the print control (-p) option for all jobs spooled.
PTPARENT
If set, this will cause any jobs spooled to be marked as children of the RID number that it is set to.
SILENT
UNIX
Possible: Y
If set, this will cause dcclp to not display any message (including error messages) back to the command line. This is
the same as a “-s” option on the dcclp command line.
VIEW80
UNIX
Possible Values: Valid ASCII representation of the hex control codes to place the users terminal into 80 column
mode.
Used by the OM Plus report viewing program to put the user’s terminal into 80 column mode.
P a g e 207 | 221
OM Plus Delivery Manager
VIEW132
UNIX
Possible Values: Valid ASCII representation of the hex control codes to place the users terminal into 132 column
mode.
Used by the OM Plus report viewing program to put the user’s terminal into 132 column mode.
VIEWCOL
UNIX
Automatically puts the user’s terminal into 132 column mode when viewing a report in the ‘dccstat’ program.
WHEN
UNIX
Sets the OM Plus print time for all jobs spooled. This is the same as using the “-W” option on the command line.
P a g e 208 | 221
OM Plus Delivery Manager
OM Plus retains detailed logfiles of messages and request activities. The behavior and number of each logfile
depends on which operating system that is running. OM Plus retains a log of each system function. The location of
that file.e depends on the operating system. For information, refer to the following table.
Operating System Logfile Location
Windows %OMHOME%\messages\log
UNIX $LPHOME/messages/log.[servername]
Note: This file is a text file that can be opened with any text editor. There is also a Windows based log file that has
many helpful functions for viewing, sorting and searching an OM Plus log. This file can be found in the Windows
OM Plus Server install under %omhome%\bin\ompluslog.exe. If you are using a UNIX/LINUX version of the
software, a version of this utulity can be provided by Support for use on a Windows system.
OM Plus retains a log of all the functions it performs. It is possible to view the main OM Plus logfile from all OM
Plus interfaces. To view the logfile from the Request status screen, right click the server name and select “Logfile
Display.” The logfile appears displaying the most recent entries.
P a g e 209 | 221
OM Plus Delivery Manager
It is possible to view three logfiles on a Windows operating system , the main OM Plus system log, the accounting
log, and the port monitor log.
SYSTEM LOG
OM Plus stores the system messages in %OMHOME%\message\log. The system log contains all the messages
issued by any of the multiple programs contained in OM Plus, and each message is separated into the following
fields.
1. Date of Message
2. Time of Message
3. Process ID Information
4. Message Number
5. Message Text
OM Plus for Windows provides the user with the ability to set the level of detail to record for an entry. It is possible
to set log details from the OM Plus Server, from the Windows Start menu, by selecting Plus Technologies OM Plus
DM, Server, OM Plus DM Server, and then selecting the Environment tab. Click Set Log Details to select the
following additional items that can be recorded in the log.
SCHEDULER SERVICE
Ensures that messages issued by the Scheduler Service are logged in the OM Plus system log. The number of
messages the Scheduler Service issues can cause the logfile to expand repidly. This selection should only be used
for debugging purposes.
ADMIN SERVICE
Ensures that messages issued by the Admin Service are written to the OM Plus system log. When performing many
administrative functions, such as defining a new destination, several messages may appear in the log.
END-TO-END SERVICE
Ensures that messages issued by the Distribution Service are written to the OM Plus system log.
P a g e 210 | 221
OM Plus Delivery Manager
OM TRANSFER SERVICE
Destinations with a mode of OM Plus and multiple OM Plus servers working together use this service extensively.
The number of extra messages that appear in the log depends on the number of destinations using this mode.
Ensures that messages issued by the iSAT are written to the OM Plus system log.
REMOTE SERVICE
Ensures that messages issued by the Remote Service are written to the OM Plus system log.
FILTER
Ensures that messages issued by the filter will be written to the OM Plus System log. The filter runs every time a
request de-spools. This option causes the logfile to expand quickly; therefore use this only for debugging purposes.
DCCLP
Ensures that dcclp command line issued or generated by the port monitor will be written to the OM Plus system
log. This adds an extra line to the log for each spooled item. This feature is useful for debugging purposes.
SOCKET TRANSACTIONS
Ensures that OM Plus logs all types of TCP/IP socket activity, such as connection openings and closings. If the
system has network printers or remote destinations, a large number of entries will appear in the log, therefore this
should only be used for debugging purposes.
Writes a hex dump of all data passed through a TCP/IP socket. Any network access by OM Plus adds large numbers
of lines to the log. Before selecting this option, contact Plus Technologies Support for instructions.
SECURITY
Logs information pertaining to the OM Plus Security system. This creates large numbers of entries in the log. Unlike
the other selections, turning this off removes all messages pertaining to the Security system from the log.
IPP SERVICE
P a g e 211 | 221
OM Plus Delivery Manager
TLS SETTINGS
Configures whether OM Plus Delivery Manager will refuse, accept or require TLS connections.
On a Windows Server, the logfile truncates when it reaches a certain size (default 1.5 MB). If it is larger than 1.5
MB, it is renamed with a date stamp, and then a new log starts.
It is also possible to set limits for how large the logfile can expand. In the Maximum Log Size (in Bytes) field, enter
the size at which OM Plus should truncate the file. In the next field, enter the minimum log size. When OM Plus
truncates the file it retains this number of bytes in history instead of truncating them all. If OM Plus should save
previous logfiles, select Save Log Files, and then in the Save Under Directory field, enter the location.
If the OM Plus for Windows Server is set to use the OM Plus port monitor, a second log retains information about
the starting and stopping of the port monitor. Logfile limits do not affect this log.
It is possible to view two logfiles on a UNIX operating system. They include, the main OM Plus system log and the
accoutning log.
Note: The accounting log is identical for both Windows and UNIX operating systems. For information, refer to
Viewing Accounting Logfiles.
SYSTEM LOGS
OM Plus records all messages in the main OM Plus log, log.[servername], where [servername] is the hostname of
the OM Plus Server.
The main log contains all the messages issued by any of the multiple programs contained in OM Plus, and each
message is separated into the following fields.
1. Date
2. Time
3. Year
4 Message Number
5. Message Text
P a g e 212 | 221
OM Plus Delivery Manager
OM Plus for UNIX allows for the customization of the logs. In all cases, the main OM Plus log contains all the
messages. If OM Plus creates a secondary log, it contains copies of the messages.
The most likely type of secondary log is a separate error log. It is possible to create a log for all error messages by
creating a new file with the name log_errors in $LPHOME/constants. As long as this file exists, copy of all error
messages are saved in the file $LPHOME/messages/Emsg.[servername].
OM Plus checks the sizes of all the OM Plus logfiles at boot time. Any that are greater than or equal to 10
megabytes cause the logsize.sh event from the events directory to run. By default this script will copy the current
log file to logfile.old. This script can be modified to perform log pruning as desired by the administrator.
The entries in the logs are all associated with a message number. Many of these messages are documented for
later reference. It is possible to use the Client interface to search for the definitions of system messages on the
Request Status screen, from the Help menu, by selecting System Messages, entering the message number, and
then pressing Enter.
Note: To search for the definitions of system messages in a Character-based interface, from the command line, run
dccmsghelp. For information, refer to Using the Command Reference.
On the System Defaults screen, if Enable Accounting is set to Yes, the accounting log retains entries of every print
job. This log resides in Windows in %OMHOME%\messages\acctlog and in UNIX in $LPHOME/messages/acctlog.
The accounting log contains the following 12 string fields delimited by a comma. In the Classic File format
ACCT_LOG=”Y”
P a g e 213 | 221
OM Plus Delivery Manager
New filed filter print control which wwas never originally captured
23. Print Control
P a g e 214 | 221
OM Plus Delivery Manager
P a g e 215 | 221
OM Plus Delivery Manager
Email notifications require that a sending email account be configured first. To configure this email account in OM
Plus, open the OM Plus DM for Windows utility on the OM Plus server. Select the “Environment” tab and click the
“Settings” button.
Once there, enter the email server’s address, the sender email address, the login username, the password and the
port number for the server. Close this window to save changes.
Note: This interface is used for setting up a single email account to send emails. If, for some reason, you need to be
able to send emails from multiple accounts, please contact OM Plus support.
P a g e 216 | 221
OM Plus Delivery Manager
Note: The tool OM Plus uses to send emails is not compatible with SSL connections without additional
configuration. If your email server requires SSL, please contact OM Plus for additional assistance in setting up your
server.
First Open OM Plus Administration > Click the Destination Tab > Click Notification Addresses.
Select Commands > Add Address > Enter a Name > Click OK > Enter an Email Address > Click Save.
Second, while still in OM Plus Administration > Click on Destinations > Select the destination(s) that you would like
to receive notifications from > Click on the Miscellaneous Tab > Use the drop box next to Notification and select
the email address.
P a g e 217 | 221
OM Plus Delivery Manager
DATA TYPES
There are 10 data types that are known to OM Plus. When a report is spooled, OM Plus interrogates the data in an
attempt to determine what kind of file is being spooled. The data type determines the following five behaviors of
the OM Plus system with regards to a specific request.
Page Count: Can OM Plus determine how many pages are contained within this file.
Page Indexing: Can OM Plus determine where there are page breaks within this document.
Restart-able: Can OM Plus restart this document from a page other than the first page. This also governs the ability
to copy out a range of pages from this document. Even if this column is marked ‘no’ , a printer restart may be
possible. See ‘Restarting a request’ in the ‘Working with status components’ section.
Line Feed to Carriage Return + Line Feed Conversions: Will this document have Carriage Returns pre-pended to all
of its Line Feed if specified by the system.
Translation: Will this document be filtered through the translation table logic if specified.
P a g e 218 | 221
OM Plus Delivery Manager
Mode: The connection mode for this destination. For more information, see Modes.
Accept Reason: Note field for describing the reason for setting to “accept.”
Metering: The rate, in character per second, that jobs will be sent to the device.
Model: The model this destination will use for processing jobs.
File Break: Will the destination insert a page break after each file?
Copy Break: Will the destination insert a page break after each copy?
Line Feed Carriage Feed: Will the destination convert line feeds to carriage return line feeds?
Close Delay: The amount of time to keep the connection active between jobs in streaming mode.
Write Timer: The amount of time, in seconds, OM Plus will attempt to write a job to this device.
Open Timer: The amount of time, in seconds, OM Plus will attempt to open a connection to this device.
Purge Time: The amount of time, in seconds, jobs will be kept after being marked eligible for purge and before
being purged.
P a g e 219 | 221
OM Plus Delivery Manager
Pend Form: When initiating a form change, this is the form that will be loaded when the device is re-enabled.
P a g e 220 | 221
OM Plus Delivery Manager
Note: This first tab shows the most relevant data in an easy to read format. To find the full queue file contents with
all options and settings (or to find an easier format for copying and pasting into emails), click the second tab.
Title: The title of the job. This will be a file name if coming from the command line or the title assigned by the
Windows print spooler if coming through a linked printer.
Source: Name of the server that spooled the job. In Windows this is often the workstation.
User: The user name of the user who spooled this job.
Pages: The number of pages printed out of the number of pages in this print job. If OM Plus is unable to count the
number of pages due to the data type, it will display the size in bytes with “SB” added to the end.
Data Type: The format in which OM Plus believes this job to be.
Options: Any options that have been assigned using the -o option string.
P a g e 221 | 221