Call Toll Free: 1-877-899-7587Outside of U.S.: 1-937-847-0614

Blog Contact Us

Free Trial

Advanced Print Spooling,Print Management and Document Delivery

Print Management and Document Delivery

 

Notices

Copyright Notice

Copyright © 2003-2017 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.
This guide reflects OM Plus™ Delivery Manager version 2.7.0 and Fleet Manager 0.2.4, where applicable

Trademarks

OM Plus, Context Delivery, Report Bundler, Report Distributor, CD Plus, Fleet Manager and LP Plus are trademarks of Plus Technologies. All other products and company names are trademarks of their respective companies.
SAP is a registered trademark of SAP AG.
All other company and product names may be trademarks of their respective owners. The information contained herein is subject to change without notice.

Using this guide

Using This Guide

Plus Technologies is always interested in improving the quality of the software documentation. If any errors or omissions are discovered in this guide, or if you have improvement suggestions, e-mail specific comments to Plus Technologies at [email protected] It is possible to send comments anonymously, or to provide complete contact information so we may contact you. Your input is solicited and welcome.

Using the PDF Version of This Guide

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.

Contacting Plus Technologies Customer Support

If you have questions about OM Plus and are unable to find the answers in this guide, contact Plus Technologies in one of the following ways:

Web: www.plustechnologies.com

Telephone: +1.937.847.0614

US Toll Free: +1.877.899.7587

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), except on certain U.S. holidays. They are New Year’s Day, Memorial Day, July 4th, Labor Day, Thanksgiving Day, Christmas Eve and Day and New Year’s Eve.

Additional support packages are available including an 8:00 A.M. to 11:00 P.M. EST or even 24×7 support.

Introducing OM Plus Delivery Manager

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.

Overcoming Existing System Limitations

Due to the limitations of existing operating systems, problems arise 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.

Managing the Delivery Of Enterprise Documents

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, commercial 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.

Using Advanced Document Delivery

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 on document data or other spool file information.
  • Automatic routing of jobs to the backup server, if primary server becomes unavailable.
  • Confirmation of job delivery.
  • 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 (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.
  • SNMP capability to query destination status.
  • Printer web server access from within OM Plus.
  • Security features to control end user access to functions, documents, and devices (security can be set at individual or group levels).
  • Encryption capabilities between OM Plus servers.
  • Job scheduling and load balancing.
  • Delayed print purging to enable re-printing of documents without having to re-create them from within the application.
  • Re-start, re-direct, and re-print capabilities.
  • Support for rich content documents including page range and next page capabilities.
  • Automatic delivery of multiple copies or portions of documents.

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.

Server Requirements

  • OM Plus Server supports Windows Server 2003, Windows Server 2008, Windows Server 2012, as well as most commercial UNIX operating systems including, Sun Solaris 8, 9 and 10, 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 and 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 128 MB 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 Vista,Windows 7 and Windows 10. To ensure proper performance, install the OM Plus Client on a computer with a minimum of 256 MB of memory.
  • The OM Plus Client can also be installed on many Unix and Linux distributions with a graphical desktop.

Getting Started with OM Plus

Getting Started with OM Plus

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 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.

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.
Before beginning, review the following information.

OM Plus consists of two components:

  • Server: manages the output.
  • Client: allows for user interface with the OM Plus Server.

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.

OMHOME and LPHOME Environment Variables

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 folder or directory where OM Plus is installed.

If OM Plus is installed in the default location, the values include:

Operating SystemVariable NameDefault Value
WindowsOMHOMEC:\plustech\omplus\server
UNIXLPHOME/usr/lpplus

If OM Plus is not installed in the default folder or directory, it can be located from the command line by issuing the following.

Operating SystemCommand
Windowsecho %OMHOME%
UNIXecho $LPHOME

Installing OM Plus

Installing on Windows

OM Plus can be installed on Windows Server 2003 (Enterprise and Standard), Windows Vista, Windows Server 2008, Windows Server 2012, Windows 7 and Windows 10.

To install OM Plus Server on Windows, complete these steps:

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.

Starting the OM Plus Windows Services

OM Plus adds the following seven services to Windows.

  • OMAdminServ
  • OMe2eServ
  • OmMonidotService
  • OMLPDServ
  • ompserv
  • OMSchedServ
  • OMStatusServ
  • omRemoteServ

Once installation is complete OM Plus can be accessed and utilized.

To access OM Plus, complete these steps:

1. From the Windows Start menu, select Programs, Plus Technologies OM Plus, Server, and then OM Plus for Windows.

The OM Plus for Windows screen appears.

OM Plus DM for Windows

2. Click Install All.

Green boxes with check marks appear in the Installed column.

3. Click Start All.

The screen now appears similar to the following.

OM Plus DM for Windows

Changing the Windows Environment

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).

Installing Over an Existing Version

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:

To install over an existing version, complete these steps:

1. From the Windows Start menu, select Programs, OM Plus, Server, and then OM Plus for Windows.

The OM Plus for Windows screen appears.

2. Click Remove All to stop and remove all services.

Empty red boxes appear in the columns.

3. From the Windows Start menu, select Programs, OM Plus, Server, Uninstall, and then Uninstall OM Plus for Windows. 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 Manger 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 Manger 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.

1. Download the appropriate install package for the system.

2. Unpack the package into an empty directory.

3. Run the following command.

./ominstall

( ./OMINSTALL\;1 for HP systems)

and follow the install prompts.

Starting the Daemons

  • For information on the daemons associated with OM Plus, refer to the following table.

DaemonsDescription
Admin ServerPerforms administrative system functions. The Client requires this to function correctly. To run, issue the dccbkadm command.
LPD ServerReceives requests from other hosts using the LPD/LPR Protocol. To run, issue the dcclpdser command.
Network StatusUsed for remote communication. The Client requires this to function correctly. To run, issue the dccbkst command.
OM Plus ServerReceives requests from another OM Plus application. To run, issue the dccompser command.
SchedulerDispatches requests. OM Plus requires this to function correctly. To run, issue the dccsched command.
Remote ServiceTransfers 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.
Monitor ServiceMonitors and controls the status of the other services.

Starting the Daemons at Boot Time

  • 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 directories and the init.d directory.

To set the daemons to start at boot time, run the following command:

# dcclplink

Setting the Unix Environment

  • 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
  • TZ=EST5EDT

Starting the Om Plus Unix Services

  • In addition to the environment variables, 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

Installing Over an Existing Version on Unix

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, proceed to Installing on UNIX.

Installing the OM Plus Client

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 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 Client installation is now complete.

Configuring the First OM Plus Destination

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 Start > Plus Technologies OM Plus > 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 the printer and the port should be 9100. Once this has been configured, select “Finish” to create the destination.

Linking a Windows Printer

To Link a Windows Printer Definition to an OM Plus Destination, complete these steps:

From the Windows Start menu, select OM Plus, Server, and Link Windows Printers & OM Plus Destinations.

Link Windows Printers and OM Plus DM Destinations
The Link Windows Printers and OM Plus Destinations screen appears.

From the Windows Printer column, select the local Windows printer to be linked to the new OM Plus printer destination.

From the OM Plus Destination column, select the OM Plus destination created previously (in this example, W820).

Click Create Link, and then when prompted, click Yes to continue creating the link.

The port name now appears as PlusTech1 and the OM Plus destination appears as W820.

Configuring On Unix/Linux

1. From the command line, enter dccadmin to define an OM Plus destination.

OM Plus Destination Configuration Menu

2. Using the Enter key, from the Setup menu select Destination Configuration.

3. In the following fields, provide the appropriate information.

  • Destination Name: enter a name between 1 and 50 characters, without spaces, to be assigned to this destination.
  • Destination Mode: enter termserv.
  • UNIX Device: enter the hostname or IP address of the network printer followed by an exclamation point (!), and then the number 9100 (for example, printer!9100). This combination of mode and device will work for typical network printers.

4. Press F3 to save the destination, and then Esc to exit.

Sending Requests to OM Plus

Sending Requests from Windows

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 request 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.

Sending Requests from Unix

Requests can be spooled to OM Plus from the command line by issuing the dcclp command with a –d [destination] parameter. For example,

dcclp –d firstprinter /etc/profile

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.

Sending Requests Using Lpd on Windows And Unix

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.

Linking OM Plus to UNIX LP (or LPR)

Linking OM Plus to UNIX LP (or LPR)

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.

To do so, use the dcclplink script: to complete the following tasks:

  • Disable the native lp startup and shutdown scripts.
  • Copy the native lp program and then link lp to dcclp.
  • Replace the native lpstat with OM Plus’s lpstat command.
  • Replace the native enable and disable programs with OM Plus’s enable and disable scripts.

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.

To unlink lp from OM Plus, run the dcclpunlink command.

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.

Working with the OM Plus Client Interface

Installation

In Windows, Execute the OMPlucClientInstall_2.6.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 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 allow 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 form mounts required by the documents.

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.

OM Plus DM Class Maintenance

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.

To add a class, complete these steps:

1. Click Add Class.

2. In the Enter New Class Name field, enter a new class name, and then click OK.

The class appears in the list.

Deleting a Class

An existing standard class can be deleted when it is no longer desired to collectively spool to a group of printers.

To delete a class, complete these steps:

1. Select a class, and then click Delete Class.

A message appears asking for confirmation to delete the class and its contents.

2. Click Yes.

The class no longer appears in the list.

Adding Destinations to Classes

New destinations can be added to an existing standard class to enlarge the group of printers to which jobs can be collectively spooled.

To add a destination to a class, complete these steps:

1. Select a class, and then click Add Member.

The Select Destination screen appears.

Select Destination

2. Select the destination to add, and then click OK.

The destination appears in the list under the class.

Deleting Destinations from Classes

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.

To delete a destination from a class, complete these steps:

1. Select the class destination to be deleted.

2. Click Delete Member.

The destination no longer appears in the list.

Using Define Destination

Destination management is one of 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.

OM Plus DM Destination Manager

The Define Destination interface screen was created to allow quick and easy edition of OM Plus Destinations, even in large numbers.

Adding, Deleting, and Updating Destinations

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.

Add New Destination

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.

Add New Destination

The destinations name from previous screen 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, please see the i-Sat documentation.

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. A green Plus logo will appear on the icon for each Save Host enabled server. Now, any destinations created or edited here will be saved to all Save Hosts.

Device

NETWORK DESTINATION MODES

These destinations require access to a network in order to function.

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 interfaces. 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.

LPD/LPR

The network destination uses the LPD/LPR Transfer Protocol. Most network print devices support the LPD/LPR Protocol. 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.

LOCAL DESTINATION MODES

Local modes are used for destinations 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, RIDnnnnn. 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 eComIntegrate products. For more information on configuring this device, please contact Bottomline.

PIPE EVENT (WINDOWS ONLY)

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 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

This 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.

WINDOWS PRINT QUEUE (WINDOWS ONLY)

The Destination Device field should contain the name of the Windows-defined printer to where the request should be sent. For example, 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 ONLY)

Used to connect to a destination attached to the local server through a parallel port.

SERIAL (UNIX ONLY)

A printer connected to the server by a serial line. The device field should be the location of the serial port (eg. /dev/term/tty006).

STD OUT

OM Plus will output the result of the print stream 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.

OM PLUS LPD

Mode used to connect with a legacy LP Plus server. The server address and queue name must be given.

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 RIDnnnnn. 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 transfers. On Unix, make sure this file has permissions set to 600 to avoid compromising the remote user IDs. For example, ftp.someplace.com, someuser will transfer to the home directory of someuser.

OTHER PRINT SERVER

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 a 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.

EMAIL

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

The print requests are routed to a pager service.

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 the Types configuration screen.

Timers

This is a collection of time outs and maximums for the destination. In all cases but purge delay a value of “0” means unlimited.

OM Plus DM Destination Manager

PURGE DELAY

Amount of time, in seconds, for a job to remain in the queue after cancellation or completion.

WRITE TIMER

Time, in seconds, OM Plus will wait on a write to the destination device.

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

The amount of time, in seconds we will suspend waiting on a write.

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.

MAXIMUM REQUEST SIZE IN PAGES

The maximum number of pages a document can have and still be 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 on 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

OM Plus DM Destination Manager

PRINT BANNER

Should the banner page be printed for requests spooled to this device?

ADD CARRIAGE RETURN TO LINE FEEDS

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 text line to the left edge after each line.

FORM FEED AFTER EACH JOB

Inserts a form feed at the end of each job if one is not already present.

FORM FEED AFTER EACH COPY

Inserts a form feed at the end of each copy of a job if one is not already present.

HOLD DEFAULT

Holds (does not print) all jobs sent to this destination.

PURGE DEFAULT

Allows jobs printed on this destination to be purged.

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

Default Print Control file for this destination.

CUSTOM DATA FILTER

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.

FILTER CONTROL FILE

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.

PRINT STREAMS ALLOWED

Useful for legacy devices that may not support all print streams, or for destinations that use scripting for processing only certain types of data.

Extensions

Extensions can be used to configure custom parameters for a printer. These are used exclusively in custom implementations 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 directory.

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 Class Maintenance

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 Control Panel, double-click Group Maintenance, and then the following Group Maintenance screen appears.
OM Plus DM Group Maintenance

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.

To add a group, complete these steps:

1. Select a host, and then click Add Group.

2. In the Enter New Group Name field, enter a new group name, and then click OK.

The group appears in the list.

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.

To delete a group, complete these steps:

1. Select a group, and then click Delete Group.

A message appears to confirm the deletion of the group and its contents.

2. Click Yes.

The group no longer appears in the list.

Adding Destinations to Groups

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.

To add a destination to a group, complete these steps:

1. Select a group, and then click Add Member.

The Select Additional Group Members screen appears.

Select Additional Group Member

2. Select the destination to add, and then click OK.

The destination appears in the list under the group.

Deleting Destinations from Groups

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.

Types

OM Plus DM Destination 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

OM Plus DM I-SAT Maintenance

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.

Creating a New I-SAT

To create a new i-Sat, right click on the host name and select “Add i-Sat.” A dialog 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 right click on the i-Sat name. Select “Remove i-Sat.”

Adding a Device To An I-SAT

Right click on the i-Sat name and select “Add i-Sat destination.” Select the destination to be added to the i-Sat.

Removing a Device from an I-SAT

To remove a device, right click on the device name and select “remove.”

Push Update

Right clicking on an i-Sat and selecting “push update” 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

This option 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.

Notification Addresses

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+ system.

OM Plus DM Notification Address List

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.

Epic Print Records

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 a Cache server. Unless the client is configured to allow it, this screen will not appear on most OM+ installations.

OM Plus DM EPS to Destination Map

Host

The host name where the OM Plus print queue will 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

The name of the EPR as it appears on the Cache server.

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 the print driver that should be used to render the job on the Epic Print Server. This field will be passed to the EPS and a Windows queue for that driver will be created to render the job ready for print on the EPS before transferring it to the host specified in the first field.

Tray

Which tray number should be associated with the EPR.

Simple/Duplex

Turns on or off duplexing for the device.

Paper Size

The size of the sheet that should be used for this EPR.

MEDIA TYPE

The paper type that should be associated with the EPR.

File Commands

ADD NEW RECORD

Adds a new EPR to the list.

REMOVE RECORD

Removes the selected EPR from the list.

IMPORT FILE

Allows a .csv 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, or 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.

OM Plus DM Advanced Forms

To add an advanced form, complete these steps:

1. In the Advanced Form File field, enter a new form name.

2. In the remaining fields, enter the appropriate information, and then click Save Advanced Form File.

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.

Fields used in this control include:

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 initial report is not printed in addition to its separate components as defined by the form.

Destination

Which OM Plus print destination. This is specified for each segment.

Advanced Form (Optional)

Apply this electronic form to this segment. The default is none.

Advanced Form Options (Optional)

The ffprint 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 receives 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 segment 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 receives 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 line 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 output 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.

OM Plus uses two types of forms, standard and advanced. They are:

  • 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 Control Panel, double-click Forms Maintenance, and then the following Form Definition screen appears.

OM Plus DM Form Definition

Using Standard Forms

Standard forms can be added, modified or deleted to ensure the correct form is loaded for the output job.

CREATING FORMS

1. In the Form Name field, enter a new form name.

2. In the remaining fields, enter the appropriate information, and then click Save.

3. When a message appears indicating the new form is updated, click OK.

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.

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 on 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 on 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.

LINES PER PAGE

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.

ENABLE FORM DOWNLOAD 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 before the output job. If set to N, the download file is not sent.

COPY DOWNLOAD FILE FROM HOST FILE

Indicate to allow the form file (if a true electronic form) to exist for Windows in the %OMHOME%\form\ folder and for UNIX in the $LPHOME/form/ directory with the required filename downloaded. This file was created the first time the form was 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.

ENABLE POSTLOAD 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.

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\\ postload and UNIX $LPHOME/forms/ /postload file to be updated without deleting and re-adding the form.

Health Check (UNIX Only)

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 Control Panel, double-click 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.

The following is an example OM Plus Health Check screen.

OM Plus DM Health Check

Registration Status

OM Plus Registration Status

From the OM Plus Control Panel, click Registration Status, and then the following System Registration Status screen appears.

RID Spans Setup

See the section on R3/SAP Interface for more information about this feature.

OM Plus DM RID Span Maintenance

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 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.

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 Control Panel, click System Settings, and then the following System Defaults screen appears.

System Defaults

OM Plus DM System Settings

To set the system defaults, complete these steps:

1. From the System Defaults screen, change the default options, as needed.

2. Click Save.

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 (virtual and ecivprinter mode) that the system will need (minimum of 3).

Maximum Jobs: The number of concurrent requests (printed, interrupted, or otherwise) for which to reserve memory.

System Notifications: The email address to notify in case of system problems.

Default Printer: Select the destination to send spool requests if no destination is specified on the spool command line.

Accounting: Select whether or not OM Plus will write records to the acctlog file each time a request 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.

Destination Defaults

Initially Accepting: Will a newly created destination automatically receive jobs?

Initially Enabled: Will a new destination automatically release jobs?

Fail-over Requests: Will a new destination automatically fail over to a defined alternate destination?

Alternate Destination: The default 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.

Close Delay: Enter the number of seconds OM Plus holds the connection to this device open to allow it to flush its buffers.

Retry time: Number of seconds allowed between attempts to deliver a job.

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 implementations use the model that the system selects based on the destination’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 character 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.

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 Control Panel, click System Information, and then the following System Information screen appears.

OM Plus DM System Information

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 and serial numbers from this screen.

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

OM Plus Client Settings

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 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.

Options

AUTO UPDATE

Should the request status screen automatically update?

AUTOUPDATE INTERVAL

The time, in seconds, that will elapse between updates when auto update is turned on. The minimum value is 5.

SORT PARENT/CHILD

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.

SHOW EPS MAP

If this box is checked, the “Epic Print Records” tool will be selectable in the OM Plus Administration screen.

REQUESTS PER PAGE

The number of requests the client will display in the status screen. More lines will use more memory, but the effect is not substantial.

MESSAGE FILE EXTENTION

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.

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

The port number for Background Status to use. Default is 53971.

ADMIN SERVICE

The port for Background Administration to use. Default is 53974.

Viewers

On this page, the viewers used by the different file types can be defined. OM Plus includes 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.

Security

With so much functionality and ease of access with printing reports, security in OM Plus becomes more of an issue than with the standard Windows spooling or UNIX lp systems.

OM Plus security uses 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 the security 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.

TabFunction
Hosts/DomainDisplays the users from remote computers that are associated with a local user.
GroupsDisplays the name of the group, the destinations in the group, and the security models that apply to each destination.
LoginsDisplays the login IDs that are associated with a local user. This is used primarily with the HTML interface.
ModelsDisplays the name of the model and the permission levels to which it is associated.
User ListDisplays the local users and the group to which they are assigned.

Using Security Groups

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.

1. Set up permission models.

2. Create new security groups.

3. Select destinations for the groups.

4. Assign proper permission models to each destination.

5. Assign proper administrative privileges.

6. Assign users to groups.

Setting up Permission Models

OM Plus security uses permission models to determine the rights a user has to a destination and the jobs spooled to that destination.

OM Plus DM Security Models

From the OM Plus Security Maintenance tab, select Model to determine the level of access desired for this model, per item.

For information about the access levels and their descriptions, refer to the following table.

Access
(Windows)
Access
(UNIX)
Description
None0 = No AccessCannot perform the function.
Owner1 = User AccessCan perform the function only if the user owns the output job.
Security Group2 = Group AccessCan perform the function only if the user or another group member owns the output job.
All3 = Unrestricted AccessCan 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.

Creating Security Groups

Group Maintenance is used to group OM Plus users that have common destination and access needs. A permissions model is applied to each destination.

To add security groups, complete these steps:

1. From the OM Plus Security Groups screen file menu, select “New Group.”

A prompt appears asking for a name for the 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.

OM Plus DM Security Groups

Selecting a Destination for the Group

After adding a group, one must add destinations to the security group, and then assign the proper permissions model to the destination.

To add a destination, complete these steps:

1. From the OM Plus Security Group screen, select “Add” from the bottom Destination and Models pane.

The Destinations screen appears.

2. Select the destination to add, and then click OK.

The Models screen appears.

Select Model

3. Select the permission model this group should use for this destination, and then click OK.

The Destination and its associated security Model appear.

OM Plus DM Security Groups

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.

A group must also be assigned an administrative level. The administrative levels are:

  • 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+ (adding or removing destinations, changing destination settings, etc) but not any of the server level functions of OM+.
  • System Admin – Users may use printer and system level functions in OM+ but may not edit the security profiles.
  • Full Admin – These users may change any setting in OM+.

Adding Users to Groups

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 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. 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.

To add local users to a group, complete these steps:

1. Navigate to the OM Plus Security Maintenance Groups screen.

OM Plus DM Security Groups

2. Click Add User.

3. In the Enter User Name field, enter a new user name.

The user appears in the list for this group.

Adding Remote Users (Host/Domain)

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 users 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 to define a remote user to correspond with a pre-defined local user.

The New Login screen appears.

New Login

2. In the Host/Domain field, 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 is 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 user ID’s from the associated 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.

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.

OM Plus DM Security User List

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 List.” To clear out the current list and use only the names in the new list, select “Replace All.”

Adding Login Users

The Login screen makes it possible to set up the user name and password to associate with a specific local 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.

The Add Login User screen appears.

New Login

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.

Security in Distributed Environments

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.

OM Plus Status Screen

OM Plus Status Screen

The most commonly used component of the Client is the Request Status screen. From this screen, it is possible view the status of and modify all requests and destinations. To access these components, from the OM Plus Control Panel, select the Status tab, click Request Status, and the following OM Plus Request Status screen appears.

OM Plus DM Request Status

Understanding Client Specific Information

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.

Host Color CodeStatus
BlackOperation is normal.
Red and BoldScheduler service is not running.
RedWarning indicating Max Requests is over 80% of maximum value.
Queue Color CodeStatus
BlackQueue is enabled and ready to de-spool.
GreenRequest is de-spooling on this queue.
BlueQueue is disabled and will not de-spool until it is enabled.
Red boxQueue is rejecting requests and initial spooling will not occur.
Red and BoldRequest active on this destination reflects a retry status. For information, refer to Understanding Request Statuses.
Blue OutlineDestination is redirecting to another destination. Print jobs sent to this device are currently coming out in another location.
Request Color CodeStatus
BlackRequest is enabled and ready to de-spool.
GreenRequest is de-spooling.
RedRequest is interrupted. For errors pertaining to this request, refer to the log.
Red and BoldRequest is de-spooling, but is in a retry state. If the retry condition persists, the job will be interrupted.

Using the Hosts Menu

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 possible 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 as bold.

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 simple text, pcl-1, and pcl-2 type documents. For these data types, OM Plus defaults to the DccView (File View) viewer. To view a request, from the Request Cmds menu, select View Request.

Notices

The request appears in the selected application.

Using Dccview (File View)

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.

Viewing Request Status and Destination Details

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.

RID04865

Double-click a destination and a screen similar to the following appears.

Details

Understanding Request Statuses

Request statuses appear in the Stat field. For information on the status messages and their definitions, refer to the following table.

StatusDefinition
activOutput request is de-spooling or being transferred to another host.
busyQueue file for this output request is in use by another OM Plus application.
canOutput request is canceled and after the purge delay time, will be removed from the queues.
cmpltRequest for an OM Plus mode destination completed successfully.
A parent RID whose children have all finished printing.
faildFax or email report failed.
faxedFax has been sent.
fpendRequest is waiting for the proper form to be mounted on the destination.
heldOutput request is on hold.
intrdOutput request failed while spooling or de-spooling (printing).
maildEmail report was delivered to the email subsystem.
partlGroup 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.
prntdOutput request has de-spooled successfully.
procOutput request is processing.

purgOutput request has been purged from the queue system.
readyOutput request is ready to de-spool.
retryOn 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).

sentReport has been sent to an OM Plus or fax mode destination and the final result is not yet known.
spoolOutput request is spooling (moving into the queue).
suspOutput request has been suspended and must be released to de-spool.
timedOutput request is set to de-spool at a future date and time.

xferOutput request has been transferred to another host over the network or to disk.
2bigReport 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.
2dumbDestination 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.

Accessing Command Selections

Command MenusAccessing Method
Character-basedPress F6 for the command menu. If viewing the Request Status screen, the Request Commands menu appears. If viewing the Destination Status screen, the Dest Commands menu appears.
ClientSelect Requests or Destinations from the menu bar. Alternately, many operations are available through the right click context menu.

Using Request Commands

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 elapse. For instructions on canceling requests, refer to the following table.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Cancel, or on the keyboard, press c.
ClientFrom 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.

Changing Print Control Files

A print control file is a set of instructions sent to the destination. This 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Change Control File, and then from the list, select the print control file.
ClientFrom the Requests menu, select Change Print Control File, when the Select Print Control File screen appears, select a file, and then click OK.

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Copy Request, All selected requests are copied with the same parameters.
ClientFrom the Requests menu, select Copy Request, when the Print Report screen appears, enter the 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 requests to a different destination. For instructions on changing destinations, refer to the following table.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Destination Change, or on the keyboard, press d, and then from the list, select the new destination.
ClientOn 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.

Changing Email Addresses

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Email Addresses, press F5 to add and F6 to delete addresses, and then press F3 to update the request.
ClientFrom the Requests menu, select Email Address, when the Addresses screen appears add or delete an address, and then click Save.

Changing Fax Numbers

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Fax Numbers, press F5 to add and F6 to delete numbers, and then press F3 to update the request.
ClientFrom the Requests menu, select Fax Numbers, when the Fax Numbers screen appears add or delete a fax number, and then click Save.

Changing Form Files

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Form Change, and then from the list, select the form to apply.
ClientFrom 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.

Display Parent/Child Information

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.

Parent Children

The destination commands menu is available from this dialog by right-clicking on a request.

InterfaceAccessing Method
Character-basedThis feature not available.
ClientFrom the Requests menu, select Display Parent/Children.

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 requests, refer to the following table.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Hold, or on the keyboard, press h.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Keep, or on the keyboard, press k.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, or on the keyboard, press l. Then, press – (minus) to move backward and + (plus) to move forward.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn 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.
ClientFrom 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.

Changing Copy Counts

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Number of Copies, or on the keyboard, press n.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen select priority change from the Command menu, enter the priority number.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Purge, or on the keyboard, press p.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Release, or on the keyboard, press r.
ClientFrom the Requests menu or the right click menu, select Release.

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.

InterfaceAccessing Method
Character-basedOn 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. See below.
ClientFrom 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 OM Plus will attempt a Printer Restart. See below.

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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Destination Status, or on the keyboard, press s.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Suspend, or on the keyboard, press s.
ClientFrom the Requests menu or the right click menu, select Suspend, and then when prompted, confirm suspending the request.

Tracing Status Requests

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Trace.
ClientFrom the Requests menu, select Trace, when the Trace screen appears, review the information, and then click OK.

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 requests, refer to the following table.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select View Request, or on the keyboard, press v, and then the file content will appear in text format. Most data types, other than simple data types, will not be legible.
ClientFrom 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.

Changing the Banner Status

It is possible to change the flag that represents whether or not a banner 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select either Banner On or Banner Off.
ClientFrom the Requests menu, select More, and then select either Banner On or Banner Off.

Changing Advanced Form Files

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 also the section on Advanced Forms for more details on working with this tool.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Change to Advanced Form, and then from the list, select the appropriate form.
ClientFrom the Requests menu, select More, Change Advanced Form File, and then when the Select Advanced From screen appears, select the appropriate form file.

Setting Scheduled Printing

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Time for Delay Printing, and then when prompted, enter a future date and time to de-spool.
ClientFrom 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.

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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Title Change, and then in the field, enter the new title.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, select Update Options, and then in the field, enter an option.
ClientFrom the Request menu select More, then Update Options. When prompted, enter an option and then click OK.

Using Destination Commands

Accepting Requests

It is possible to set a queue to accept (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 the following table.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Accept Requests, and then click Execute.
ClientFrom the Destinations menu, select Accept Requests, and then when prompted, confirm accepting the request.

Attaching Terminals (UNIX Only)

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 Advanced Destination Options.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Attach Host/Terminal.
ClientFrom the Destinations menu, select Attach Terminal, when prompted, enter the device name, and then click OK.

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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Disable Destination, or on the keyboard, press d.
ClientFrom the Destinations menu or the right click menu, select Disable Destination, and then when prompted, confirm disabling the destination.

Dynamic Class Maintenance

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.

InterfaceAccessing Method
Character-basedThis feature is not available.
ClientFrom the Destinations menu, select Dynamic Class Maintenance, and then 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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Enable Destination, or on the keyboard, press e.
ClientFrom the Destinations menu or the right click menu, select Enable Destination, and then when prompted, confirm enabling the destination.

Getting Daemon/Service Information

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.

InterfaceAccessing Method
Character-basedOpen DCCADMIN, then check the Services menu.
ClientRight click on the host name and then select “Daemon Information.”

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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Form Mount, and then from the list, select the form.
ClientFrom the Destinations menu or the right click menu, select Form Mount, when the Select Form screen appears, select a form, click OK, and then 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.

InterfaceAccessing Method
Character-basedOn the Request Status screen, or on the keyboard, press l. Then, press – (minus) to move backward and + (plus) to move forward.
ClientSelect 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 the host log to view.

Print Test Page

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.

InterfaceAccessing Method
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Destination Status, or on the keyboard, press s.
ClientFrom the Destinations menu or the right click menu, select Status, and then the Printer Status screen appears.

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.

InterfaceAccessing Method
Character-basedThis feature is not available.
ClientFrom 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.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Reject Requests, and then click Execute.
ClientFrom the Destinations menu, select Reject Requests, and when prompted, confirm the rejecting of the request.

Selecting Translation Tables

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 instructions on selecting a translation table, refer to the following table.

InterfaceAccessing Method
Character-basedOn the Destination Status screen, select Translation Table Select, from the list, select the table, and then press Enter.
ClientFrom the Destinations menu, select Translation Table Select, when the Translation Table Select screen appears, select a table, and click OK.

Launching Destinations URLs

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.

InterfaceAccessing Method
Character-basedThis feature is not available.
ClientFrom the Destinations menu or the right click menu, select URL.

Using Lookup Commands

The number of requests that appear on the Request Status screen can be limited by using the Lookup commands.

InterfaceAccessing Method
Character-basedFrom the Status screen, press the ‘3’ key, Lookup. Select from the list displayed and press Enter.
ClientFrom the Request Status screen, select Lookup, Select from the list displayed and press OK.

All Requests for all Destinations

Displays all the requests.

Disabled Destinations (Client only)

Displays all the disabled destinations and the requests on those destinations.

Form

Displays all the requests with a specific form specified.

Groups (Client only)

Displays all the destinations in a specific group and their requests. See Group Maintenance.

Requests for Selected Destinations

Displays all the currently selected destinations and the requests for those destinations.

Status

Displays all the requests with a specific status.

Title

Displays all the requests with a specific title.

User

Displays all the requests with a specific user.

Goto Page (Character-based only).

Displays the specified page of a multiple page status screen.

Remote Hosts

(Character-based only) Displays the status information from another OM Plus host.

OM Plus Archive System

OM Plus Archive System

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.

Activating and Configuring OM Plus Archive

From the OM Plus Control Panel, select Archive Tab > Archive Settings

OM Plus DM Archive Administration

Days remaining in the trial period

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 a file system that has enough space to do the desired archiving.

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.

How long should archive files be kept

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.

How often should a new archive subdirectory be created

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 a new subdirectory should be created. Valid values for these entries are:

  • Create a new directory every day.
  • Create a new directory every 10 days.
  • Create a new directory once a month.
  • Create a new directory once a year.

How long should files be kept in the temp directory

The first time a 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.

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:

From the Command Line

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 Archive command line options for dcclp are described below:

  • -o arch – Archive this request and compress the file*.
  • -o archu – Archive this request but do not compress the file*.
  • -o archk – Archive this request but do not allow the sweep program to delete it.

  • -o archuk – Archive this request, do not compress it, do not sweep*.
  • -o noarch – Do not archive this request (default).

* On OM Plus for Windows systems, archive files are never compressed. These commands are effectively the same from a compression standpoint.

The LPPARCHIVE Environment Variable

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’.

From the Request Status Screen

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 Files – 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.
  • Archive Request Compress Keep – Archive this request. Do not allow delete.
  • Do Not Archive – Do not archive this request.

Querying Archived Reports

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 Control Panel.

Fill in any combination of report attributes and press the ‘OK’ button.

  • From Date – The starting spool date range to search.
  • To Date – The ending spool date range to search.
  • Title – All or part of the title of a report.
  • User – The user who spooled the report.
  • Destination – The destination where the report was spooled.
  • Text – A text string within the report.

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.

Cleaning up the Archive and Temporary Directories

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.

Document Conditioning Components

Document Conditioning Components

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.

Spooling with Context Delivery Plus

Once Context Delivery is installed and activated it automatically checks for criteria in each spooled file without specific commands provided by the user.

Defining Search Criteria in Context Delivery

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.
OM Plus DM Context Delivery
To define a new criterion, complete these steps:

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.

CriteriaFunction
CopiesChecks the number of copies requested on the dcclp command line (-n).
Data TypeChecks the OM Plus data type as specified with the –T switch on the command line. This will not change the default data type.
DestinationChecks the destination to which the request is being spooled (-d).
Data ContainsSearches the file for the specified criteria.
Data Contains (remove)Searches the file for the specified criteria and removes it, if found.
Data Contains (remove line)Searches the file for the specified criteria and removes the entire line, if found.
Advanced FormChecks the electronic form file specified (-F).
FormChecks the standard or advanced form specified (-f).
HoldChecks to see if the hold flag was specified (-h).
OptionsChecks the –o command line options.
PriorityChecks the value of the requests priority (-q).
TimeChecks to see the future time for de-spooling, if set (-w).
TitleChecks the title of the request (-t or default).
UserChecks the user ID of the user submitting the request.

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 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 text 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.

Decreasing Spooling Time

While the above information dictates 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 unchanged. 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 level parameter that matches the numbers. This way job Z99 would only check against 126 parameters. 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 2626 (26 second level and 100 each 3rd level) parameters that need to be configured.

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 efficient 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 file spools in and does not match, CD Plus will open and read all 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 modifications to the spooling process or application, but if thousands of jobs are affected, it could provide worthwhile.

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.

Configuring Report Bundler.

To configure Report Bundler, first create a local destination using the “Bundle” mode. At this stage, the bundle type can be determined.
Add New Destination

For information on the four bundling type options, refer to the following table.

OptionDescription
BundleBundles reports based on a user defined parameter that must be included on the command line.
FormBundles reports based on the selected form.
UserIdBundles reports based on the submitter’s user ID.
TitleBundles reports based on the report title.

OM Plus DM Bundle Parameters

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 the Bundle Type field defined in the destination definition screen. For information on each value and their definitions, refer to the following table.

ValueDefinition
Resolved ValueValue to match for this parameter.
DestinationDestination to where to spool bundled requests for this parameter.
UserUser ID to use when spooling this bundle. This allows unique security setups.
LP OptionsOptions to use for this bundle. These options are command options for the 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 spool them to whichever destination with whatever options are associated with the default resolved value.

Spooling with Report Bundler Plus

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 then they are submitted as one request.

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 individualized 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 distribution latency.

Report Distributor can burst requests only for the following data types.

  • simple
  • pcl-1

Understanding Report Distributor

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 the 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.

Defining Search Criteria in Report Distributor

For each page, a set of compares must be defined. These compares will look at a 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 a 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.

Each line of a page is defined by the following set of parameters.

  • Oper: logical operator for the row. This is unavailable on the first row. See the list of logical operators below for more information.
  • Type: type of data for which to scan.
    • Text (text): string of text.
    • Numeric (num): number or range of numbers.
    • Nomatch (-mat): no match descriptor.
    • Collate (coll): collate type. It does not return a result for evaluation. Instead it looks in the specified location and generates a separate report for each unique value. This avoids the need to define a trigger for each desired section. The unique value is available to the operation as a variable $COLL (%COLL% on Windows).
  • 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 a 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.
  • <=> (Numeric triggers only)
    • =: trigger on a number is equal to a specified number.
    • <: trigger on a number is less than a specified number.
    • >: trigger on a number is greater than a specified number.
    • !=: trigger on any number that is not equal to a specified number.
  • String/Number: specified text or number for which to scan.

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.

  • Destination: Destination to which to spool.
  • User: User ID from which the request spools. This allows special security setups.
  • LP Options or Delivery Command:
  • The options for the dcclp command. For information about dcclp, refer to the Using the Command Reference.
  • 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 occur 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 sued 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.

OperatorDefinition
&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 93755552121. 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.

OM Plus DM Report Distribution
The logic appears similar to the following.

if(firstline is true)

then

if(secondline is true OR thirdline is true)

then

spool page to lexmark with form letterhead

endif

endif

Configuring Multiple OM Plus Installations in a Distributed Environment

Configuring Multiple OM Plus Installations in a Distributed Environment

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.

Starting Remote Services

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 for Windows 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

Broadcasting Defined Destinations

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 the 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.

Receiving Broadcasted Destinations

Before an OM Plus 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 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 result 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

This file holds three lines outlining three 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 receives 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.

Spooling to Remote Destinations

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.

Editing the receiveHosts and sendHosts Files

The send and receive Hosts files can be created and manipulated from the Remote Printing tab on the Control Panel.
OM Plus DM Remote Setup

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.

Send to any/Receive from any

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 defined to the original server. In receive from any, the server will 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.

Send Type

Determines whether or not OM Plus will send this Printer Type information with the destination updates. This is useful for configuring remote Windows printers on other servers.

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.

OM Scan Service

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.

Starting OM Scan Service

OM Scan Service can be started through the OM Plus (v2) for Windows application.
OM Plus DM for Windows

Configuring OM Scan Service

From the OM Plus (v2) for Windows 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

OM Scan Service Configuration

Debug: Should the scan service run in a debug mode?

Cycle time: Time, in seconds, to check the email server.

Max Threads: Maximum number of concurrent email connections.

Clear Messages: Should messages found in the target inbox be marked as read?

Folder Scans

OM Scan Service Configuration

To create a new folder scan process, select the Folder icon from the top of the left pane and fill in the required fields.

Folder: The folder to monitor.

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.

Process Sub-folders: Should sub folders be processed or ignored?

Max Threads: Maximum number of concurrent threads to use to scan subfolders.

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 if the script is designed to do something different with the file, but otherwise should remain true.

Email Scans

OM Scan Service Configuration

Host: Web address of mail server.

User: User name with permissions to access the desired inbox.

Password: Password for user above.

Port: Port to use to connect to the mail server (optional).

Authorization: The authorization to use to connect to the mailbox (optional).

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.

Cycle time: How often to check this specific inbox.
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.

Database

OM Scan Service Configuration

This configures the database to be used to resolve email addresses into user names.

Server: The host name or IP address for the database server.

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.

User: User name allowed to access the database.

Password: Password for user specified above.

Table: The table holding the user name and email addresses.

Email Field: Field in the table that contains the email addresses.

User Field: Field in the database holding the user names.

SAP R3 BCXOM Interface

SAP R3 BCXOM Interface

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, Linux x86, HP-UX Itanium, Solaris SPARC and Windows.

There are three steps required to get the interface working properly:

1. Configuring ROMS, LOMS and device definitions in SAP.

2. Creating an sapconfig file in the OM Plus constants directory.

3. Setting up an enterprise RID span in OM Plus.

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 all defined via the SAP Spool Administration (SPAD) transaction.

1. Go to the Spool Administration Screen (/nspad).

2. Click on Full Administration to make the Output management systems tab visible, if necessary.

3. From this SPAD Initial Screen, perform the following configurations.

Importing SAP Configuration

In lieu of creating the SAP OMS definitions from scratch, as described in the following sections, 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 configuration 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 Execute button.

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 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.

SAP Real OMS Configuration

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.

N45

2. To define a new ROMS, click on the Create Create button. (Or double click on an existing ROMS entry to modify it.) This will bring up the ROMS definition screen.

3. Edit the ROMS definition as follows:

a. Set ROMS Name and Description as desired.

b. Select ‘Command Line’ under the Tasking attribute.

c. Select all boxes under the Job Status attribute.

d. Select ‘Queue query’ under the Device Status attribute.

e. Enter a Reconfiguration Request delay. This is the interval at which OM Plus will perform an empty callback to check for SAP LOMS reconfiguration if there have been no request status callbacks.

f. The remaining OMS attributes should be deselected and the remaining text fields should be left blank for possible future use.

g. Click the Save button to save the ROMS definition.

SAP Logical OMS & Commands Configuration

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 Management Systems 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.

Configuring a Polling LOMS:

N45
Set the Logical OMS Name and Description as desired.

1. Select the OM Plus ROMS as the Real OMS.

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.

3. Select ‘Polling’ under the Jobs section.

4. If the ‘No info = error’ checkbox in the Jobs section is not visible, click on the ‘Extended config’ Execute 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.)

5. Status Dialog boxes may be set as desired.

6. The entries on the OMS configuration tab should be left blank.

Configuring a Callback LOMS:

1. Select the SAP configuration tab.

N45

2. Set the Logical OMS Name and Description as desired.

3. Select the OM Plus ROMS as the Real OMS.

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 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.

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.

9. Status Dialog boxes may be set as desired.

10. Select the OMS configuration tab.

N45

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 occur 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 changes 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 Events has been reached.

The following describes the mapping of OM Plus request and destination status changes to SAP Event reporting level. Each successive reporting level allows additional triggering events for status callbacks to SAP, providing increased visibility 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.

ALSO PROBLEMS (INTERACTION REQUIRED)

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.

ALSO STATUS CHANGES

Adds request status transitions such as “ready” to “activ” and “Retry” conditions.

ALSO INFORMATION

Adds changes in destination status.

ALL AVAILABLE INFORMATION

Adds confirmed (PJL) page count change.

Sap Logical OMS & Commands Configuration (Continued)

3. Save the LOMS definition. The above steps may be repeated to define multiple LOMS if desired.

4. From either a LOMS definition or the List of LOMS screen, Select the Commands Commands
button. Select the entry corresponding to your system’s Operating System. (All Windows systems are considered to be ‘Windows NT’.)

N45

5. Enter (or verify/correct) the OS Commands fields:

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.)

a. Operating system should be that of the current OS.

b. Enter the fully qualified path to the OM Plus bin directory in the command path. The defaults paths for Unix-based and Windows systems are:

Unix: /usr/lpplus/bin/

Windows: c:\plustech\omplus\server\bin\

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”

(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

e. Save the Commands.

SAP Device Configuration for OM Plus

1. From the main Spool Administration Initial Screen, select the Devices/servers tab and click the Output Devices Display button.

N4S

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.

Setting up the OM Plus RID Span

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 be designated the span host. It is the span host’s responsibility to publish the RID span file out to all of the servers.

To edit the RID Spans using the Client interface, open the Control Panel > System > RID Spans.

OM Plus DM RID Span Maintenance

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 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.

Windows

Open the OM Plus (V2) for Windows application on the OM Plus server that is going to host the RID span file and select the ‘Environment’ tab.

OM Plus DM for Windows

Select the ‘Settings’ button. And locate the ‘SPAN Host RID Ranges’ tab.

Span Host

Select the ‘Current Host’ check box.

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.

Unix

On a Unix server, the Span file needs to be created manually on the span host. Make the following files.

$LPHOME/constants/spanhost

This file should contain the hostname of the span host.

$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

starting_rid is the first RID number in that host’s range.

ending_rid is the last RID in that host’s range.

Example:

ibm 1,10000,50000
solaris 33, 50001,99999

Take great care to make sure that none of the RID ranges overlap.

Configuring OM Plus for SAP Callbacks

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. To activate SAP callback capabilities, an edited version of 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.

TypeParmsMeaning

L

Default login parameters for SAP targets not explicitly defined by T records.

IDSAP login ID
Passwordpassword for SAP login
Clientclient number for SAP login

A

Default SAP Log Audit level for targets not explicitly defined by T records.

Level0 (min) – 3 (max), default 0

T

Explicit SAP session target definition(s).

Target hostSAP target instance in the form host_sys_nnn.
IDSAP login ID
Passwordpassword for SAP login
Clientclient number for SAP login
Audit Level0 (min) – 3 (max), 0 default

R

The Real Output Management System(s) OM Plus is providing to SAP.

ROMS IDThe name of the ROMS.
Initial TargetThe SAP instance OM Plus should contact on startup.
Retry SecondsThe retry interval after a connection failure.

N

The hostname(s) of OM Plus systems (nodes)

HostHostname of another OM Plus system serving the same SAP system(s).

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.

#

# Lines beginning with ‘#’ and blank lines are ignored.

#—————————————————————-

# default login/audit parameters for targets without T entries below

#

# Login:

# L,id,password,client

L,defaultid,defaultpass,001

# Audit level (0-3, 0 default )

# A,level

# A,3

# callback target entry(s):

# T,saphost,login,password,client,audit lvl.

T,host1_N4S_42,targetuser,targetpass,001,1

T,host2_N4S_01,otheruser,otherpass,001,1

# ROMS entry(s):

# R,roms_id,initialtarget,retry secs.

R,OMPLUS,host1_N4S_42,120

# OM Plus SAP Nodes

# If OM Plus is installed on more than one node(host) with SAP requests

# for being forwarded, the OM Plus nodes must be aware of each other

# so that when SAP sends a configuration update to one node, that node

# can forward the information to the others. (These N entries are not

# needed if there is only a single OM Plus system.)

#

# N,hostname

N,host1

N,host2

N,prtserver

Command Reference

DCCSAPSUB

Definition

This command submits requests to OM Plus’ SAP certified interface

Format

dccsapsub

Parameters (All Required)

&EI SAP Spool ID

&EG Reply message

&P SAP Destination Name

&F File to be spooled

&o SAP User ID

&T Title

&C Number of Copies

&Y Priority

&U Banner Flag

&E2 LOMS Flag

&Es SAP System ID

&E1 SAP R3LOMS flags

Example

dccsapsub “&EI” &EG &P &F &o “&T” &C &Y &U “&E2” “&Es” “&E1

DCCSAPSTAT

Definition

This command requests status information from OM Plus for its SAP certified interface and can also cancel one or more OM Plus request.

Format

dccsapstat [ -d | -c | -j ]

Parameters

&P OM Plus Destination Name

&EL Request ID(s) of Desired OM Plus Request(s)

Examples

dccsapstat &P &EL – Returns the status of a print job

dccsapstat -d &P – Returns the status of a print queue

dccsapstat -c &EL – Cancels a print job

dccsapstat -j &EL – Gives a detailed report of a print job’s status

OM Plus Solution Manager Ready

Solution Manager Ready certification requires that we include the following information:

———————————————————————-

Installation Guide for OM Plus

———————————————————————-

Product name: OM_PLUS
Product version: 2

Software component name: OM_PLUS
Software component version: 2

[*] Steps to register product information to System Landscape Directory(SLD)

1. Get the following information for the SLD server,
and log on to the System Landscape Directory.
(User must have a LcrInstanceWriterLD role.)

Host:

Port:

User:

Passwd:

[Manual registration]

2. Create a product name/version and software component name/version

in the software catalog of the SLD.

– Click on “Products”,

and then click on “New Product Version”.

– Enter the following information.

Product name: OM_PLUS

Vendor name: Plus Technologies

Product version: 2

– Click “Create”

– Enter the following information in the fourth empty field.

Technical name: OM_PLUS

– Enter the following information.

Software component name: OM_PLUS

Software component version: 2

Production state: released

– Click “Create”

[Import registration]

2. Choose the following link.

– Administration -> Content -> Import

– Input the provided SLD data zip file path to

“Selected File:” box.

– Click “Import Selected File…”

[XML Transferring registration]

2. Enter the following command with the provided XML file.

– java -cp . example/Test SLD_host http_port user password ThirdPartySystem.OM_PLUS.xml

e.g.

java -cp . example/Test iccsolman40.sap.com 80 3rd_party isvconnect08 ThirdPartySystem.OM_PLUS.xml

[*] After installing OM Plus, please refer to the following path.

a. Default installation path: /usr/lpplus

b. Default log file path: /usr/lpplus/messages/log.<nodename>
(human readable)

c. Default debug file path: /usr/lpplus/messages/debug.<nodename>
(human readable)

d. Default configuration file: /usr/lpplus/constants/sapconfig.<nodename>
(human readable)

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.

buildhtml

NAME
buildhtml

SYNOPSIS
Builds the web files necessary for the OM Plus web interface.

SYNTAX
buildhtml

AVAILIBILITY
UNIX and 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.

dccaccept

NAME
dccaccept

SYNOPSIS
Sets a destination to accept output jobs.

SYNTAX
dccaccept -d [destination]

AVAILIBILITY
UNIX and 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

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.

dccasweep

NAME
dccasweep

SYNOPSIS
Checks the archive for files to be removed.

SYNTAX
dccasweep [option]

AVAILIBILITY
UNIX and 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 files from the archive.

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.

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

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

dccbkstshut

NAME
dccbkstshut

SYNOPSIS
Stops the OM Plus Network Status Server.

SYNTAX
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

dcccancel

NAME
dcccancel

SYNOPSIS
Cancels an active output job.

SYNTAX
dcccancel [argument]

AVAILIBILITY
UNIX and 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
dcccancel –d destination6: Cancels the currently active (printing) output job on destination6.

dcccancel –I RID0023: Cancels output job RID0023.

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 and 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 destination 3 destination 9: Moves all output jobs currently queued in destination 3 to destination 9

dccdisable

NAME
dccdisable

SYNOPSIS
Disables a destination from printing.

SYNTAX
dccdisable –d [destination]

AVAILIBILITY
UNIX and 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

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

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.

dccenable

NAME
dccenable

SYNOPSIS
Enables a destination for printing.

SYNTAX
dccenable –d [destination]

AVAILIBILITY
UNIX and Windows

DESCRIPTION
dccenable enables printing on a destination. Jobs will now de-spool (print) from this destination.

ARGUMENTS
<-d destination>: Destination to enable.

OPTIONS
None

EXAMPLES
dccenable-d destination6: Enables destination6

SEE ALSO
dccdisable

dccfree

NAME
dccfree

SYNOPSIS
Controls the licensing process in OM Plus.

SYNTAX
dccfree

AVAILIBILITY
UNIX and Windows

DESCRIPTION
dccfree allows the user to license their system or display the product status.

ARGUMENTS
None

OPTIONS
None

EXAMPLES
dccfree

dccgdisable

NAME
dccgdisable

SYNOPSIS
Disables all destinations.

SYNTAX
dccdisable

AVAILIBILITY
UNIX

DESCRIPTION
dccgdisable disables all destinations.

ARGUMENTS
None

OPTIONS
None

EXAMPLES
dccgdisable: Disables all destination queues.

SEE ALSO
dccgenable, dccdisable, dccenable

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

dccgrp

NAME
dccgrp

SYNOPSIS
Performs a specified function on a group of output jobs.

SYNTAX
dccgrp [command] [groups]

AVAILIBILITY
UNIX and 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.

Release: Releases all output jobs in the group from hold.

Purge: Sets the purge flag for all output jobs in the group.

Hold: Holds all output jobs in the group.

Nopurge: Sets the no purge (keep) flag for all output jobs in the group.

Restart [n=+x]: Restarts all output jobs in the group at last page + x.

pr=x:Sets job to priority x.

OPTIONS
[pr=x]: All output jobs with the priority x.

[unit=destination]: All output jobs for the destination.

[owner=user_id]: All output jobs for the user [user_id].

[status=job_status]: All output jobs with the OM Plus status [job_status].

[date=job_date]: All output jobs with queue date job_date in the form of YY/MM/DD.

[mine]: All output jobs with the current login ID.

[all]: All output jobs in the OM Plus queues.

[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 hours, add an “m” or “h” immediately after the number.

[ldate=mm/dd/yyyy]: Returns any jobs spooled on or before the given date.

EXAMPLES
dccgrp dest status=fpend n=destination 3: Moves all output jobs with a status of fpend (form pending) to destination 3.

dccgrp cancel unit=destination6: Cancels all output jobs for destination6.

dccgrp hold all: Places all output jobs on hold.

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 changing form is dccgrp form [groups] n=[new_form].

Syntax for restart is dccgrp restart [group] n=+x where x is the number of pages after the interruption to start.

Priority does not work as a criteria.

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.

dcchealth

NAME
dcchealth

SYNOPSIS
Checks OM Plus install and outputs discrepancies.

SYNTAX
dcchealth

AVAILIBILITY
UNIX

DESCRIPTION
dcchealth checks to see if OM Plus is installed correctly and outputs any found discrepancies. 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.

[-f] Fix problems, where possible.

OPTIONS
None

EXAMPLES
dcchealth –cf: Displays a formatted screen along with fixing problems, if possible.

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.

LPHOME= Shows the OM Plus home directory.

PatchLevel= Shows the current patch applied to OM Plus, if applicable.

Current Spool Files = Number of files currently spooling.

Maximum Spool Files = Maximum number of spooling files.

Printers Configured = Number of printers configured in the system.

License = Number of printers allowed in the system.

Message Log Size = size of message log (in bytes).

Accounting Subsystem is (ENABLED or DISABLED) = status of Accounting subsystem.

Accounting Log Size = Accounting log size (in bytes).

File System Free Bytes = free space in file system (in bytes).

File System % Freespace = percentage of free space in file system.

ARCHIVE System is (ACTIVE or INACTIVE) = status of Archive system.

Archive Free Blocks = Number of free blocks in archive system.

Archive % Freespace = Percentage of free space in archive system.

Tracking Number = newnum

dcclogmsg

NAME
dcclogmsg

SYNOPSIS
Generates an entry in the log.

SYNTAX
dcclogmsg [text]

AVAILIBILITY
UNIX

DESCRIPTION
dcclogmsg creates a new entry in the log.

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.

pl=l Page length. l=10-90. Default is 50.

df=filename Fully qualified destination file name. Default is log.rep.

sf=filename Fully qualified source file name. Default is log.

raw Print raw mode – no headers.

-c Use above arguments if any, but stay in interactive curses screen.

OPTIONS
[n]: specifies the number of columns to use for this field.

Leave out spaces between parameter and =.

day=n

date=n

time=n

year=n

lpxnum=n

ridnum=n

message=n

program=n

EXAMPLES
dcclogrep –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.

dcclp

NAME
dcclp

SYNOPSIS
Main spooling command for OM Plus.

SYNTAX
dcclp [argument] file_name

AVAILIBILITY
UNIX and 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.

[-f form_id]: Changes the form ID.

[-F eform]: Designates an electronic form to be used with the request.

[-h]: Places a job on hold.

[-H hold/resume]: Holds a job or releases it from hold.

[-i request_id]: Selects a currently queued job by RID.

[-n copies]: Sets number of copies.

[-o option(s)]: Used for passing a variety of data to the program. Often used in custom solutions.

[-p print_control]: Changes the print control.

[-q priority]: Changes priority.

[-s]: Silent option. The command will put out no messages.

[-S character_set]: Specifies an optional character set to use. Not available on HP or AIX systems.

[-t title]: Changes title of the job.

[-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.

[-W MM/DD/YY,HH:mm]: Future time for printing a job.

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.

banner, ban: Prints banner before output.

continue: Restarts report at current page.

copybreak, cb: Form feeds between copies in a report.

dist=[file]: Select the .dst file to use for Report Distributor.

noarchive, noarch: Does not archive (default).

nobanner, nob, nb: Does not print banner.

nocb,noc,nocopybreak: No form feeds between copies in a report.

nofilebreak, nofb, nof, minusff: Turns of form feeds after each file.

nolfconv, nolfc: Does not do line feed to line feed carriage return conversion.

nopurge, nop: Job will not purge after completion.

purge: Deletes request after printed and purge time expires.

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.

ufilt=aprogram: Tells OM Plus that a program should be used as a userfilter program.

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.

dcclp –d destination5 –h /usr/files/file9: Places the job currently printing on destination5 on hold.

dcclp –i RID0217 –f checks –d destination3 –n 3: Changes job 0217 output destination to destination3, changes the required form to checksand 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 nopurge /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 $LPHOME/prtcntl/landscape/;preload to the destination before the print request.

dcclp –d destination7 –q 1 /usr/files/file2: Changes priority to 1.

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.

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 Line 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.

[service_name]: Default is printer.

OPTIONS
None

EXAMPLES
dcclpdser: Starts the OM Plus LPD Server with default settings.

dcclpdser bighost destination: Starts the OM Plus LPD Server using 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.

dcclpdshut

NAME
dcclpdshut

SYNOPSIS
Stops the OM Plus Line Print Daemon (LPD).

SYNTAX
dcclpdshut hostname service_name

AVAILIBILITY
UNIX

DESCRIPTION
dcclpsder stops the OM Plus Line Print Daemon (LPD) Server.

ARGUMENTS
[host_name]: Default is node name.

[service_name]: Default is destination.

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.

dcclplink

NAME
dcclplink

SYNOPSIS
Replaces the native UNIX lp command with the 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

dcclpr

NAME
dcclpr

SYNOPSIS
Provides LPR functionality and compatibility to dcclp.

SYNTAX
dcclpr -PQueue_Name [-SServer_Name] File_Name

AVAILIBILITY
UNIX

DESCRIPTION
dcclpr accepts traditional lpr commands and transforms them into dcclp commands.

ARGUMENTS
-PQueue_Name: Desired queue.

[-S Server_Name]: Name of server containing that queue.

EXAMPLES
dcclp -PPrint1 -SOMServ file.txt: Spools file.txt to the queue “Print1” on “OMServ.”

SEE ALSO
dcclpd

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

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 dstination]: Destination to mount form.

[-f form]: Form to be mounted.

OPTIONS
None

EXAMPLES
dccmount –d destination3 –f checks: Mounts the form checks on destination3.

dccmsghelp

NAME
dccmsghelp

SYNOPSIS
Decrypts message and error numbers from OM Plus.

SYNTAX
dccmsghelp

AVAILIBILITY
UNIX

DESCRIPTION
dccmsghelp runs the message and errno description program.

ARGUMENTS
[message number]: Writes the text about this message number to stdout.

[-n#]: Writes a description of the errno # 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.

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 destination 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.

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 a given tag in a destination’s configuration file.

ARGUMENTS
printer_name : name of destination.

tag : data tag requested.

OPTIONS
None

EXAMPLES
dccprtval Printer Device : returns the device information for the destination “Printer.”

dccqval

NAME
dccqval

SYNOPSIS
returns information from a print queue file.

SYNTAX
dccqval RID##### tag

AVAILIBILTY
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.

tag : the tag for the information requested.

OPTIONS
None

EXAMPLES
dccqval RID01717 ST : returns the status of request 01717.

dccrange

NAME
dccrange

SYNOPSIS
Prints a range of pages from an existing OM Plus job.

SYNTAX
dccrange RIDxxxx r=sssss-eeeee

AVAILIBILITY
UNIX and 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.

[f=form_name]: specifies a form for the new file.

EXAMPLES
dccrange RID0024 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.”

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.

dccreject

NAME
dccreject

SYNOPSIS
Sets a destination to reject output jobs.

SYNTAX
dccreject –d destination_name

AVAILIBILITY
UNIX and 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.

dccreset

NAME
dccreset

SYNOPSIS
resets portions of the destination’s status.

SYNTAX
dccreset –d printername [-s -l -a -r]

AVAILIBILTY
Windows and UNIX

DESCRIPTION
dccreset allows portions of a destination’s status to be reset.

ARGUMENTS
-d printernam : the name of the destination on which to act.

[-s] : reset the SNMP flags.

[-l] : reset the lock flags.

[-a] : reset to inactive and stop any actively request.

[-r] : cause the active request on this destination to become interrupted.

EXAMPLES
dccreset -d printer -sa : Resets the known snmp status of “printer” while stopping the currently active request and setting its status to “interrupted.”

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.

&EL : Request ID of Desired Request.

OPTIONS
None

EXAMPLES
dccsapstat “&P” &EL

NOTES
It is very important that the &EL parameter is not encapsulated in quotes.

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.

&EG : Reply message.

&P : SAP Destination name.

&F : File to be spooled.

&o : SAP user ID.

&T : Title.

&C : Number of copies.

&Y : Priority.

&U : Banner flag.

&E2 : LOMS Flag.

&Es : SAP system ID.

OPTIONS
None

EXAMPLES
dccsapsub “&EI” “&EG” “&P” “&F” “&o” “T” “&C” “&Y” “&U” “&E2” “&Es”

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.

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

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.

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.

[-i ] – Shut down immediately without waiting for jobs to complete.

[-d destination] – stops a PJL streaming mode destination.

[service_name] – Specify a specific service to shut down only that service.

[-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 all: stops all services.

dccshut -i: stops the scheduler even if there are active jobs.

dcchut bkst: shuts down the OM Plus background status service.

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 destinations for destiatnion2.

dccstat –u bob: Starts the OM Plus Status and Control program in request mode and displays only the requests 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.

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.

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.

dccsuspend

NAME
dccsuspend

SYNOPSIS
Suspends currently printing output job.

SYNTAX
dccsuspend

AVAILIBILITY
UNIX and Windows

DESCRIPTION
dccsuspend will suspend (stop printing) a currently printing output job.

ARGUMENTS
[-d destintation_name]: Suspends the currently printing output job for destination_name.

[-I RIDxxxx]: Suspends the output job with Request ID RIDxxxx.

OPTIONS
None

EXAMPLES
dccsuspend –d destination6: Suspends currently printing output job on destination 6.

dccsuspend –I RID0029: Suspends output job RID0029.

dccswitch

NAME
dccswitch

SYNOPSIS
Routes output job from one destination to a new destination.

SYNTAX
dccswitch original_destination new_destination.

AVAILIBILITY
UNIX and Windows

DESCRIPTION
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.

dccswitch destination2 none: Allow request to print on destination2, no switch.

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.

dccview

NAME
dccview

SYNOPSIS
Executes the OM Plus viewer.

SYNTAX
dccview RIDxxxx

AVAILIBILITY
UNIX

DESCRIPTION
dccview executes the OM Plus file viewer. This is usually accomplished through the Status and Control program dccstat.

ARGUMENTS
[RIDxxxx]: Refers to the Request ID number for the output job to view.

OPTIONS
None

EXAMPLES
dccrview RID0233: Views report with the Request ID of RID0233.

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

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

hexdump

NAME
hexdump

SYNOPSIS
Takes data entering the program and outputs it as hex.

AVAILIBILTY
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.

installcdplus

NAME
installcdplus

SYNOPSIS
Installs the Content Delivery component.

SYNTAX
installcdplus

AVAILIBILITY
UNIX

DESCRIPTION
installcdplus creates and moves into place the files required for the Content Delivery module.

ARGUMENTS
None

OPTIONS
None

EXAMPLES
installcdplus: installs Content Delivery Plus.

lpadmin

NAME
lpadmin

SYNOPSIS
Add, modify, and delete the OM Plus destination configuration.

SYNTAX
lpadmin –p destination_name

AVAILIBILITY
UNIX and Windows

DESCRIPTION
lpadmin allows the user to add, modify, and delete the OM Plus destination configuration.

ARGUMENTS
[-c class]: Changes class for destination.

[-h device]: Changes device name.

[-i interface]: Changes interface for destination.

[-m interface]: Same as –i.

[-p printer_name]: sets printer name.

[-r class]: Same as –c.

[-T terminfo]: Changes the terminfo file.

[-v device]: Same as –h.

[-x]: deletes a destination.

[-z device]: do not verify device when adding.

[-o]: refer to options.

OPTIONS
[-o altdest=<dest>]: sets the alternate destination.

[-o banner]: Include banner.

[-o close=x]: sets close delay timeout.

[-o cmd1 =command]

[-o cmnt =description]

[-o copybreak]: puts a form feed between copies.

[-o filebreak]: puts a form feed after files.

[-o filesometimes]: inserts a form feed at the end of a file if one is not already there.

[-o filter2 =filtername]: Filter the print job goes through.

[-o filter3 =filtername]: Another filter the print job may go through.

[-o form =form_name]: Select a different form.

[-o purgetime=seconds]: sets purge time.

[-o lfc]: LF to CR/LF on.

[-o metering =characters_per _second]: Set throttling to a specific rate.

[-o mode=mode]: Mode for print queue.

[-o nobanner]: No banner selected.

[-o nocopybreak]: turns off form feeds between copies.

[-o nofilebreak]: turns off form feed between files.

[-o nolfc]: LF to CR/LF off.

[-o noteinfo]: text for the note field.

[-o opentime=x]: sets connection open timeout.

[-o pagelimit=x]: sets page limit.

[-o Pcap =Pcap_name]: Select a different Pcap file.

[-o protadd]:

[-o purgetime=x]: sets purgetime.

[-o restore]: restore previous configuration.

[-o sleep=seconds]: sets sleep time.

[-o support=<text>]: places text in the “support” information field.

[-o swdest]:

[-o terminfo]:

[-o trantable =translation_name]: Select a different translation table.

[-o types]: data types allowed for this printer.

[-o url=<url>]: inputs the url of the printer’s internal web server.

[-o url_address]:

[-o usrfilter]: designates a user defined program through which to pass data. This must be a fully defined path to a local file.

[-o writetime=x]: sets write timeout.

[-o xcmd =x_command]

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.

lplinkonly

NAME
lplinkonly

SYNOPSIS
creates a symlink redirecting the system’s native lp command to dcclp.

SYNTAX
lplinkonly

AVAILIBILTY
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.

lppusers

NAME
lppusers

SYNOPSIS
Places a list of users into groups.

SYNTAX
lppusers [-c] file_name

AVAILIBILITY
UNIX and 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

lpstat

NAME
lpstat

SYNOPSIS
reports the status of jobs and queues in OM Plus.

SYNTAX
lpstat [arguments]

AVAILIBILTY
Windows and UNIX

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).

[-a destination] : displays if a destination is accepting or rejecting requests (UNIX only).

[-d] : displays the default destination for the server.

EXAMPLES
lpstat : returns a list of requests in the standard lpstat format.

lpstat –a destination : reports whether or not a destination is accepting or rejecting requests.

omlogusers

NAME
omlogusers

SYNOPSIS
Updates the login users list.

SYNTAX
omplogusers [-c] file_name

AVAILIBILITY
UNIX and 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.

EXAMPLES
omlogusers file_name: appends the contents of file_name to the login users lists.

SEE ALSO
lppusers, ompremusers

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.

omqdepth

NAME
omqdepth

SYNOPSIS
Returns the number of jobs currently in the queue for a given destination.

SYNTAX
omqdepth [-hHost] -dDestination

AVAILIBILITY
Windows

DESCRIPTION
dccqdepth returns the number of requests currently queued for a destination.

ARGUMENTS
-dDestintation : The name of The destination.

OPTIONS
[-hHost] : The name of a remote host containing the destination.

EXAMPLES
ompqdepth -hPServer -dBundle : Will return the number of requests in the queue for the destination “Bundle” on the host “PServer.”

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]

AVAILIBILTY
Windows/UNIX

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.

[-r host] : adds an additional receive host.

[-x] : designates a delete function for the correct file.

[ -d ] : designates a deny host for the specified file.

[ -h pinghost ] : designates the alias hostname to use in advertising dests.

[ -a y/n] : sets receive any.

[ -t y/n ] : sets send any.

[ -f ] : forces the server to send an update to all send hosts.

[ -p ] : sets the server to broadcast destinations using proxy mode.

[ -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 receiveHosts file.

Omremsetup -h sendServer : sets the broadcast name for this server to sendServer.

omresolve

NAME
omresolve

SYNOPSIS
Resolves the IP address for a given hostname.

SYNTAX
omresolve [hostname]

AVAILIBILTY
Windows and UNIX

DESCRIPTION
omresolve returns the IP address and domain name of a system.

ARGUMENTS
[hostname] : Host name 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.

OM Plus Event Processing

OM Plus Event Processing

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.

Using Windows Event Scripts

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.

ScriptExecutes
purge.batWhen an output job 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.
spooler.batWhen the job has been spooled into OM Plus.
typemm.batWhen the data type of the request differs from data types defined supported by the destination.
formpending.batWhen an output job requires a form that is not mounted on the destination. The output job reflects a status of form pending (fpend).
enable.batWhen a destination is enabled.
disable.batWhen a destination is disabled.
formmount.batWhen a new form has been mounted on a destination.
connectfail.batWhen a network destination has failed its connection.
writefail.batWhen an OM Plus mode destination is unable to write to the target server.
retry.batWhen a request gains a retry status.
toobig.batWhen a job with more than the maximum allowed pages is spooled.
destchg.batWhen a destination is added, modified or deleted.
remotedests.batWhen remote destinations are either sent or received. See “Setting Multiple Instances of OM Plus in a Disunited Environment” section in the manual.
streamerr.batWhen there is an error with a job using the ‘Stream’ confirmation type.

Using UNIX Event Scripts

For information on the event scripts on all supported UNIX and Linux operating system and their descriptions, refer to the following table.

ScriptExecutes
arch_err.shWhen a request failed to archive correctly.
cancel.shWhen a job is canceled.
connectfail.shWhen a termserv or OMPLUS mode destination has failed to make a network connection.
demon.shWhen any OM Plus daemon is started or stopped.
disable.shWhen a destination has been disabled.
destchg.shWhen a destination is added, changed or deleted.
enable.shWhen a destination has been enabled.
formmount.shWhen a form has been mounted on a destination.
formpending.shWhen an output job requires a form that is not mounted on the destination. The output job reflects a status of form pending (fpend).
interface.shWhen a destination interface script completes. This occurs for all destinations when any job attempts to print (de-spool).
logsize.shWhen the $LPHOME/messages/log. ‘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.shWhen 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.shWhen a non-network destination has failed its connection.
prtunavail.shWhen an output job has been submitted to a disabled destination.
purge.shWhen an output job is to be purged from the OM Plus queue.
remotedests.shWhen remote destinations are either sent or received. See “Setting Multiple Instances of OM Plus in a Disunited Environment” section in the manual.
spooler.shWhen the spooling process ends.
toobig.shWhen a job with more than the maximum allowed pages is spooled.
toodumb.shWhen the data type of the request differs from data types defined supported by the destination.
writefail.shWhen an output job fails during printing. The output job will be marked interrupted (intrd) and the destination will be disabled.

Environment Variables

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

Windows and UNIX

Possible Values: y or Y

Set so that it is in the environment of the LPD Service.

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

Set so that it is in the user’s environment.

If set, this will cause dcclp to automatically append the copybreak or no copybreak command line parameter to all jobs spooled.

DATATYPE

UNIX

Possible Values: Any valid data type (see Data Types).

Set so that it is in the user’s environment.

If set, this will cause dcclp to automatically assign the specified data type to all spooled requests.

FILEBREAK

UNIX

Possible Values: y or n

Set so that it is in the user’s environment.

If set, this will cause dcclp to automatically append the filebreak or no filebreak command line parameter to all jobs spooled.

HOLDPRINTED

UNIX

Possible Values: y or n

Set so that it is in the user’s environment.

If set, this will cause dcclp to append a hold command to all jobs entering the system.

LPDEST

UNIX and Windows

Possible Values: Any valid destination name.

Set so that it is in the user’s environment.

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

Set so that it is in the environment of the LPD service.

If this variable is set, then OM Plus will attempt to do 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

UNIX (Specifically SCO OpenServer)

Possible Values: B, b, R, r, N, n

Set so that it is in the user’s environment.

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 options are:

B – bold is bold – reverse is reverse (same as defaults.)

b – bold is bold – reverse is bold.

R – bold is reverse – reverse is bold.

r – bold is reverse – reverse is reverse.

N or n – no highlighting.

LPPAUTO

UNIX

Possible Values: Any number from 5 to 600.

Set so that it is in the user’s environment.

Sets the update and refresh interval for the ‘dccstat’ program. Values are in seconds.

LPPAUTOMODE

UNIX

Possible Values: U or R.

Set so that it is in the user’s environment.

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 statuses and page counts).

LPPCONFIRM

UNIX

Possible Values: N

Set so that it is in the user’s environment.

Causes ‘dccstat’ not to prompt for conformation when performing a command.

OMPlusACK

UNIX

Possible Values: Y

Set in the interface model for an email mode printer.

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.

PRTCNTL

UNIX

Possible Values: Any valid print control.

Set so that it is in the user’s environment.

If set, this will cause dcclp to automatically set the print control (-p) option for all jobs spooled.

PTPARENT

UNIX and Windows

Possible Values: The RID number of any current job.

Set so that it is in the user’s environment.

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 Values: Y

Set so that it is in the user’s environment If set, this will cause dcclp to not display any messages (including error messages) back to the command line. This is the same as a “-s” option on the dcclp command line.

VIEW132

UNIX

Possible Values: Valid ASCII representation of the hex control codes to place the users terminal into 132 column mode.

Set so that it is in the user’s environment.

Used by the OM Plus report viewing program to put the user’s terminal into 132 column mode.

VIEW80

UNIX

Possible Values: Valid ASCII representation of the hex control codes to place the users terminal into 80 column mode.

Set so that it is in the user’s environment.

Used by the OM Plus report viewing program to put the user’s terminal into 80 column mode.

VIEWCOL

UNIX

Possible Values: 132.

Set so that it is in the user’s environment.

Automatically puts the user’s terminal into 132 column mode when viewing a report in the ‘dccstat’ program.

WHEN

UNIX

Possible Values: A date in the following format, yy/MM/dd,hh:mm.

Set so that it is in the user’s environment.

Sets the OM Plus print time for all jobs spooled. This is the same as using the “-W” option on the command line.

Working with the Logfile

Working with the Logfile

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 the file depends on the operating system. For information, refer to the following table.

Operating SystemLogfile Location
Windows%OMHOME%\messages\log
UNIX$LPHOME/messages/log.[servername]

Viewing the Logfile Display

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 sever name and select “Logfile Display.” The logfile appears displaying the most recent entries.
OM Plus DM Log

Viewing Windows Logfiles

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%\messages\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

Understanding the Log Details

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 OM Plus, Server, OM Plus for Windows, and then selecting the Environment tab. Click Set Log Details to select the following additional items that to record 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 rapidly. 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 End-to-End Service are written to the OM Plus system log.

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.

Distribution Service

Ensures that messages issued by the Distribution 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 the 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 Transaction

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.

Socket Data Trace

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.

Understanding Logfile Limits

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.

Setting Logfile Limits

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.

Viewing Port Monitor Logfiles

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.

Viewing UNIX or Linux Logfiles

It is possible to view two logfiles on a UNIX operating system. They include, the main OM Plus system log, the accounting log.

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

6. [program that sent message]

Customizing the Logs

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, a copy of all error messages are saved in the file $LPHOME/messages/Emsg.[servername].

Understanding UNIX Logfile Limits

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.

Viewing System Messages

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.

Viewing Accounting Logfiles

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”

1. Date and Time Stamp

2. Request ID

3. Host!Userid

4. Destination

5. Report Title

6. Form Name

7. Number of Pages (zero if page counting is not done)

8. Number of Bytes (characters)

9. Print Time in seconds

10. Exit Code (exit codes are listed below)

11. Group

12. Banner

Additional fields in extended format: ACCT_LOG”E”
13. Datatype (from env DATATYPE)

14. Sent flag if available (see dccfilter exit_func comments)

15. Confirmed pages from printer, if available

16. Confirmed sheets from printer, if available
Additional fields for new reports: ACCT_LOG=”X”
17. WouldHaveBeen destination

18. WouldHaveBeen print control

19. WouldHaveBeen form

20. Original destination

21. Original Print Control

22. Original Form
New field filter print control which was never originally captured
23. Print control
Post 2.5.0 additions for getting counts from the printer
24. Meter mono usage

25. Meter color usage

Exit CodeDescription
0Good – The request has processed correctly.
1Bad Input – No standard in
2Bad Output – No standard out
3Read fail – OM Plus was unable to open the file.
4Bad Env – Something in the environment is wrong
5Write fail – OM Plus was unable to create a new file, overwrite an existing file or transfer a file to a remote destination.
7Dropped carrier (serial) – The serial connection failed unexpectedly.
8Interrupted – The request was not able to be completed due to a resolvable condition.
9Bad parameter count – The parameters passed have caused an error in OM Plus.
10Cancelled – The request was canceled by a user.
11Suspended – The request has been stopped by a user. Jobs in this state must be released.
12Good (network destination) – The transfer to the network destination has competed.
13Unable to connect – OM Plus could not connect with the destination.
17Mailed – Email sent to server
18Failed- Failed Mail, Fax or FTP
19Intrd, not Disabled—Request interrupted, but don’t disable the destination
20Ready, Disable—Mark the request as ready, but disable the destination
21Ready, Not Disable—Mark request ready and leave the destination enabled but don’t send for an interval
22Ready, Not disabled—Mark request ready and immediately retry
23Interrupt—User filter non-0 exit code
24Ready, Disable—Request OK, but disable the destination (For marking destination problems)
25Not Ready—Destination not ready, disable and keep job ready
26Busy—Destination is busy, disable destination, keep job ready
27Re-Run—Don’t disable destination, set request to I_READY
28Delay—Print Failed, set request to timed for delay and don’t disable destination
29Unconfirmed—Data was sent, but can’t confirm that. Don’t disable.
71Bad Setup—Bad fax subprogram setup, missing ftp password
72STTY Fail- Set Seriel options failed
73Open Fail—Could not open device/file
74Print Control—Missing or corrupt print file
75Form Error-Missing or corrupt form-
76File Error—Missing or corrupt file
78Illegal Data Type—Data type not allowed for destination
79Shared Memory Error—Error accessing system shared memory
80No Service—No service specified in /etc/services
81No Socket—Could not connect to system socket resource
82Bad Set Socket—error to set options on the TCP/IP socket
83No Connection—Cannot connect to a host or destinations
84Bad Queue—Cannot access or read omplus queue files
85Bad Report—Cannot access or read omplus report files
87Validation Failure–
89Internal Error—Internal Error to omplus process
90No Processes—Unable to fork at start of job

For example:

Fri Jul 21 11:38:47 2004RID00169,sdev3450!tomp,lp0,Billing21,invoice,1,905,2,0,guest,no

Setting Email Notification

Setting Email Notification

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.

Select the Fax/Email Set Up tab.

Setting

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.

Data Types

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 Feeds if specified by the system.

Translation: Will this document be filtered through the translation table logic if specified.

The Following is a table that lists which of the 5 listed attributes that each data type supports. 

dataTypes

 

 

Destination Details Screen

Destination Details Screen

Destination: The name of the destination.

Mode: The connection mode for this destination. For more information, see Modes.

Device: Location of device.

RID: The RID of the request currently de-spooling to this destination.

Banner: Will the destination attach a banner page by default?

Fbrk: Will the destination insert a page break after each file?

Cbrk: Will the destination insert a page break after each copy?

CrLf: Will the destination convert line feeds to carriage return line feeds?

Pagelimit: The maximum number of pages allowed to be spooled to this destination in one job.

Model: The model this destination will use for processing jobs.

PCAP File: The PCAP file associated with this destination.

Translation Table: Specifies the translation table that will be used.

Form: Form currently mounted to this device.

Pend Form: When initiating a form change, this is the form that will be loaded when the device is re-enabled.

Def Form: The default form for this device.

Terminfo: The terminfo file associated with this device.

SW Dest: The switch destination for this device.

Alt Dest: The alternate destination for this device.

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.

Close Delay Time: The amount of time to keep the connection active between jobs in streaming mode.

Metering: The rate, in characters per second, that jobs will be sent to the device.

Enable Time: Time of last enable.

Enable Reason: Note field for the enable.

Accept Time: Time device was last set to “accept.”

Accept Reason: Note field for describing the reason for setting to “accept.”

Notify Info: Legacy setting for LP Plus users.

Support: Name or contact information for support personnel.

Comments: Notes about this device.

Filter: The default filter used by this device.

User Filter: The user filter to be used by this device.

Two Way Protocol: The method of communication used by this device. For more information, see Job Confirmation Type.

Request Details screen

Request Details screen

RID04863

Request ID (title bar): The RID for this request.

Status: The status of this request. For information on status, see Understanding Request Statuses.

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 name.

Destination: The destination to which this job will despool.

User: The user name of the user who spooled this job.

Date: The date and time the job was spooled.

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.

Priority: The priority of this job. 0 is lowest, 40 is highest. 20 is default.

Copies: Number of copies printed and requested.

Data type: The format in which OM Plus believes this job to be.

Form: The form required for this job.

Options: Any options that have been assigned using the “–o” option string.

dcclp Options

dcclp Options

The follwing set of options requires that the “omstandard” model be replaced with “omplus” in the destination’s configuration. This model currently only exists in UNIX. These options were originally designed around the HP UNIX printer model and, as such, all options may not work with all devices.

10, -10: sets the default font size to 10 pts.

12, -12: sets the default font size to 12 pts.

a, -a:

A3, -A3: sets the paper size to A3.

A4, -A4: sets the paper size to A4.

B4, -B4: sets the paper size to B4.

B5, -B5: sets the paper size to B5.

bold, -bold, b, -b: forces the text of the document to be bold.

c, -c:

C5, -C5: sets the paper size to C5.

COM10, -COM10:

countPCL, -countPCL, cPCL, -cPCL:

cs,[0-9], -cs[0-9]:

DL, -DL:

double, -double, d, -d:

dpi[03-6], -dpi[03-6]:

dq, -dq:

duplex: turns on duplexing.

e, -e:

env, -env:

eopt:

Executive, -Executive: sets the paper size to Executive.

faxnum:

faxopt:

fbst: Form feeds will be inserted after report if the report does not end in form feed.

-FF:

file:

filebreak, FF, FB: inserts a form feed at the end of the file.

filename, filen:

fn=1234567: Phone number 1234567 if passed to fax program.

fo=-n etc: Fax option –N, etc. is passed to fax program.

fp[0-9], -fp[0-9], fp. [0-9], -fp.[0-9]:

fsp, -fsp:

half, -half, 2, -2:

height [0-9], -height [0-9]:

hsi[0-9], -hsi[0-9]:

iso, -iso:

italics, -italics, i, -i:

k8, -k8:

keep:

l[0-9], -l[0-9]:

landscape, -landscape, l, -l: sets the printer to print in landscape mode.

lbbin, -lbbin, lbb, -lbb:

lbin, -lbin, lb, -lb:

legal, -legal:

letter, -letter:

lfconv, lfc: Converts line feeds to carriage return line feeds.

lg, -lq:

lm[0-9], -lm[0-9]:

lpi[0-9], -lpi[0-9]:

mailaddr:

mailopt:

man, -man, m, -m:

mdouble, -mdouble, md, -md:

[email protected]: Email address passed to sendmail/blat programs.

mo=.q etc: Email options passed to sendmail/blat programs.

monarch, -monarch:

nlq, -nlq:

not, notify:

options, -options:

out[0-2], -out[0-2]:

port, -port, portrait, -portrait: sets the printer to print in portrait mode.

psp, -psp:

q[0-2], -q[0-2]:

quarter, -quarter, 4, -4:

r8, -r8:

rawx:

rearbin, -rearbin:

rev, -rev:

rm[0-9], -rm[0-9]:

scs,[0-9], -scs[0-9]:

SELECT_TRAY1: Directs the printer to pull paper from tray 1.

SELECT_TRAY2: Directs the printer to pull paper from tray 2.

SELECT_TRAY3: Directs the printer to pull paper from tray 3.

SELECT_TRAY4: Directs the printer to pull paper from tray 4.

SELECT_TRAY5: Directs the printer to pull paper from tray 5.

SELECT_TRAY6: Directs the printer to pull paper from tray 6.

SELECT_TRAY7: Directs the printer to pull paper from tray 7.

SELECT_TRAY8: Directs the printer to pull paper from tray 8.

sfp[0-9], -sfp[0-9], sfp. [0-9], -sfp. [0-9]:

sfsp, -sfsp:

sheight [0-9], -sheight [0-9]:

sitalics, -sitalics, si, -si:

slant, -slant:

spsp: -spsp:

sq[0-2], -sg[0-2]:

sslant, -sslant:

sstyle[0-2], -sstyle[0-2]:

stty:

style[0-2], -style[0-2]:

supright, -supright:

sweight[0-9], -sweight[0-9]:

tl[0-9], -tl[0-9]:

tm[0-9], -tm[0-9]:

topbin, -topbin:

when printing.

ubbin, -ubbin, ubb, -ubb:

ubin, -ubin, ub, -ub:

supplemental filter for this request.

upright, -upright:

vsi[0-9], -vsi[0-9]:

weight[0-9], -weight[0-9]: Changes the weight of the stroke used when printing.

wpn:

Top
Automating document management and business processes