engageone output manager - pitney bowes€¦ · the engageone output manager em edition...

EngageOne Output Manager (EM Edition)

FlexConfigure User Guide

Version: 3.0

Pitney Bowes1 is making this document available to you, free of charge, for use with the software, in order to make your experience more convenient. Every effort has been made to ensure the accuracy and usefulness of this document reflecting our experience. Product information may change after publication without notice.

This document is being distributed on an ʺas isʺ basis and we make no representations or warranties, express or implied, with respect to its accuracy, reliability or completeness and the entire risk of its use shall be assumed by you. In no event shall we be liable to you or any other person, regardless of the cause, for the effectiveness or accuracy of this document or for any special, indirect, incidental or consequential damages arising from or occasioned by your use, even if advised of the possibility of such damages.

All software described in this document is either our software and/or our licensed property. No license either expressed or implied is granted for the use of the software by providing this document and/or content.

Under copyright law, neither this document nor the software may be copied, photocopied, reproduced, transmitted, or reduced to any electronic medium or machine‐readable form, in whole or in part, without our prior written consent.

We will continue to maintain this document and we welcome any clarifications or additional information regarding its content. Address comments concerning the content of this publication to:

Pitney Bowes Building 6006 Hercules WayLeavesdenWatfordWD25 7GSUnited Kingdom

We may use or distribute the information supplied in any way we deem appropriate without incurring any obligation to the submitter of the information

1 Copyright © Pitney Bowes Software. All rights reserved. The following are registered trade marks of Pitney Bowes Inc and/or its

subsidiaries: VIP, VDE, FlexServer, EngageOne, Output Manager, EngageOne, Output Enhancement, EngageOne, Output Manager

EM, Wizard, Direct Access, OfficeMailTM, DFWorks® and Direct Connect™. Other trade marks and registered trade marks used in

this document are acknowledged to be the property of their respective owners.

TABLE OF CONTENTS

Table of ContentsOUTPUT MANAGER EM INSTALLATION ................................................................................................. 7

Installation procedure for Solaris and Linux............................................................................................ 7

Installation procedure for Windows....................................................................................................... 17Before you install..................................................................................................................................... 17Installation................................................................................................................................................ 17

OUTPUT MANAGER EM OPTIONS ...................................................................................................... 34

Changing the FlexConfigure Password ................................................................................................ 34

MANAGING OUTPUT MANAGER EM MODULES .................................................................................... 35

CREATING OUTPUT MANAGER EM MODULES ..................................................................................... 36

User interfaces...................................................................................................................................... 36

CPU ...................................................................................................................................................... 38

Input Receiver....................................................................................................................................... 39Receiving encrypted data records......................................................................................................... 40Setting up the IR configuration file ...................................................................................................... 41

Queue Manager.................................................................................................................................... 42

Printers ................................................................................................................................................. 43LPR driver ................................................................................................................................................ 43MGR driver .............................................................................................................................................. 45Transfer driver ......................................................................................................................................... 473211 driver................................................................................................................................................ 49Xerox driver ............................................................................................................................................. 50External Client ......................................................................................................................................... 52MGR/ENT driver..................................................................................................................................... 55

Checker ................................................................................................................................................ 57

Server ................................................................................................................................................... 58

Backup Server ...................................................................................................................................... 60

Logical CPU.......................................................................................................................................... 62

External Queue..................................................................................................................................... 62

Resource Manager ............................................................................................................................... 64

MGR Control......................................................................................................................................... 64

To MGR ................................................................................................................................................ 68Output Manager profile options ........................................................................................................... 68

QM Helper ............................................................................................................................................ 71

MGR Monitor ........................................................................................................................................ 72Modifying the VIP_CTRL.cfg file ......................................................................................................... 73Modifying the default Output Manager EM Submission Client configuration file ...................... 73Modifying the default Output Manager EM Submission Client configuration file ...................... 74

Recognizing your modules ................................................................................................................... 75

Modifying Output Manager EM modules .............................................................................................. 75

Changing hosts..................................................................................................................................... 75

Deleting Output Manager EM modules................................................................................................. 76

MANAGING USERS ............................................................................................................................ 77

Creating a new user.............................................................................................................................. 77

Changing the Output Manager EM password....................................................................................... 84

Editing users ......................................................................................................................................... 84

Deleting users....................................................................................................................................... 84

Company Filter Selection...................................................................................................................... 85

FLEXCONFIGURE USER GUIDE 3

TABLE OF CONTENTS

MANAGING RESOURCES .................................................................................................................... 86

Adding a new resource ........................................................................................................................ 88

Editing resources ................................................................................................................................. 90

Deleting resources ............................................................................................................................... 90

Adding a new restricted resource ........................................................................................................ 90

Deleting restricted resources ............................................................................................................... 91

COPYING RESOURCE PATHS ............................................................................................................. 92

Definitions ............................................................................................................................................ 92

Resource Path Cloning Utility tabs ...................................................................................................... 93

MANAGING FORMS ........................................................................................................................... 94

Adding a form....................................................................................................................................... 94

Deleting a form..................................................................................................................................... 94

MANAGING THE LPR QUEUE ............................................................................................................. 95

Adding an LPR Queue ......................................................................................................................... 95

Deleting an LPR Queue ....................................................................................................................... 95

CREATING MAPPING RULES .............................................................................................................. 96

Mapping rule order............................................................................................................................... 96

The Mapping Rules screen .................................................................................................................. 97

Creating a rule ..................................................................................................................................... 99Creating a condition.............................................................................................................................. 100

Editing a rule ...................................................................................................................................... 102Editing a condition................................................................................................................................ 102Copying a condition.............................................................................................................................. 102Deleting a condition.............................................................................................................................. 103

Copying a rule.................................................................................................................................... 103

Copying all rules ................................................................................................................................ 103

Moving all rules .................................................................................................................................. 103

Deleting a rule.................................................................................................................................... 104

Deleting all rules ................................................................................................................................ 104

Searching........................................................................................................................................... 104

How the Mapping Rules program is executed ................................................................................... 105

How the Mapping Rules program works ............................................................................................ 107

Mapping Rule hints ............................................................................................................................ 108

Using PERL regular expressions ....................................................................................................... 111

SERVICE CODES ............................................................................................................................. 112

Creating Service Codes ..................................................................................................................... 113

Enabling and disabling Service Codes .............................................................................................. 114

Editing Service Codes........................................................................................................................ 114

Setting a default Service Code .......................................................................................................... 114

Deleting a Service Code .................................................................................................................... 114

Setting a default Service Code for a Client ........................................................................................ 114

VIEWING LOG FILES ........................................................................................................................ 115

Viewing a Component log file ............................................................................................................ 115

JOB QUEUE (BUNDLER) .................................................................................................................. 116

4 FLEXCONFIGURE USER GUIDE

TABLE OF CONTENTS

Bundling jobs, resources and data ..................................................................................................... 116

APPENDIX A: XEROX EPS DRIVER .................................................................................................. 119

Job Start Management ....................................................................................................................... 121

EPS Configuration .............................................................................................................................. 121

APPENDIX B: OUTPUT MANAGER EM EXAMPLE CONFIGURATION FILES ........................................... 122

Configuration file parameters.............................................................................................................. 122

APPENDIX C: VIP/MGR CONTROL EXAMPLE CONFIGURATION FILE .................................................. 124

Configuration file parameters.............................................................................................................. 135Legacy message configuration ............................................................................................................ 141Output Manager message filters......................................................................................................... 144

APPENDIX D: TO VIP/MGR EXAMPLE CONFIGURATION FILE ............................................................ 148


APPENDIX E: MGR MONITOR EXAMPLE CONFIGURATION FILE ......................................................... 158


APPENDIX F: OM_VIP EXAMPLE CONFIGURATION FILE .................................................................... 159

Configuration File Parameters ............................................................................................................ 166

APPENDIX G: OM_VIP DEFAULT CONFIGURATION FILE ................................................................... 174

APPENDIX H: QM DEFAULT CONFIGURATION FILE ........................................................................... 175


APPENDIX I: BACKUP SERVER EXAMPLE CONFIGURATION FILE ......................................................... 178


APPENDIX J: IR DEFAULT CONFIGURATION FILE .............................................................................. 185


APPENDIX K: OM_LPR EXAMPLE CONFIGURATION FILE .................................................................. 189


APPENDIX L: OM_IPP EXTERNAL CLIENT EXAMPLE CONFIGURATION FILE ....................................... 194


APPENDIX M: IPP EXTERNAL QUEUE EXAMPLE CONFIGURATION FILE .............................................. 201


APPENDIX N: OM_XFER EXAMPLE CONFIGURATION FILE ............................................................... 208

Configuration File Parameters .......................................................................................................... 211

APPENDIX O: OM_PEER EXAMPLE CONFIGURATION FILE ............................................................... 216


APPENDIX P: EXAMPLE CHKR CONFIGURATION FILE ....................................................................... 221

chkr configuration file parameters....................................................................................................... 223

APPENDIX Q: UPGRADING ............................................................................................................... 226

APPENDIX R: OFFICEMAIL JOB INFORMATION SENT BY OUTPUT MANAGER EM TO OUTPUT MANAGER 227

APPENDIX S: INSTALLING PRINT CLIENTS ........................................................................................ 229

Xerox LPS & Line print client ............................................................................................................. 229Hardware requirements ...................................................................................................................... 229Software requirements ......................................................................................................................... 229Installation ............................................................................................................................................. 229


TABLE OF CONTENTS

APPENDIX T: ROBUST RESOURCE MODE ......................................................................................... 233

Pre installation tasks .......................................................................................................................... 233

Setup ................................................................................................................................................. 233

APPENDIX U: THE CHANGE_ANY UTILITY ......................................................................................... 236

Introduction ........................................................................................................................................ 236

Change_any syntax ........................................................................................................................... 236

Running change_any ......................................................................................................................... 238

Examples ........................................................................................................................................... 238Paper=letter example ............................................................................................................................ 238DATEFORMAT Example..................................................................................................................... 238RPRTPARM Example ........................................................................................................................... 239

Logging .............................................................................................................................................. 239

Performance Issues ........................................................................................................................... 239

Which fields can be changed ............................................................................................................. 240

APPENDIX V: MATCH COLUMN OPTIONS .......................................................................................... 243

APPENDIX W: BANNER PAGES ........................................................................................................ 253

Xerox & Line mode banner pages ..................................................................................................... 253

Output Manager Banner Pages ......................................................................................................... 255

PCL & PS banner pages.................................................................................................................... 256

APPENDIX X: OUTPUT MANAGER EM LICENSE KEY INSTALLATION .................................................... 258

Oracle ................................................................................................................................................ 258

PostgreSQL ....................................................................................................................................... 259

APPENDIX Y: SSL SUPPORT ........................................................................................................... 260


OUTPUT MANAGER EM INSTALLATION

Output Manager EM InstallationThe EngageOne Output Manager EM Edition installation procedure is different for Linux/Solaris and Windows.

Before attempting installation, both Solaris (or Linux) and the Output Manager EM database must be installed and configured on your machine.

Output Manager EM 3.0 supports Oracle 12c and PostgreSQL 9.4.

Below is given the procedure for Linux and Solaris, for Windows, see Installation procedure for Windows.

Installation procedure for Solaris and LinuxThe installation procedure, given below, assumes that Output Manager EM is being installed on the machine for the first time. Instructions for upgrading can be found in Appendix Q: Upgrading.

To install Output Manager EM, follow the procedure below:

1. On your Output Manager EM machine, logon as the ops user by typing:

# su - ops

2. Test your Java version by typing:

# java –version

If Java is not found or if there is an earlier version than 1.8, install the current version. Set your path to include the directory in which Java has been installed, for example the following command looks for the /usr/java directory for Java first:

# PATH=/usr/java/bin:$PATH

3. Set your DISPLAY variable to define the screen on which the installed software is displayed. To do this type:

# export DISPLAY=hostname:0

Where hostname is the name (or IP address) of the machine you are running the install from. If you are running on the workstation that is to run Output Manager EM the hostname can be found by typing hostname at the command line.

4. Create an installation directory on the server and make that the current directory by typing:

# mkdir /ops/install# cd /ops/install

5. Copy the Output Manager EM Installation software to this directory by typing:

# cp /cdrom/fse/install.tar /ops/install.tar

6. Extract files by typing:

# tar xvf install.tar

7. Run FlexConfigure, by typing:

# ./FlexConfigure install

The Install/Configure Output Manager EM screen is then displayed; this is the interface for FlexConfigure.



Complete the following fields:

In most cases these are the same.

8. Click Connect to the Database.

9. In Enter Database Values complete the following fields:

If this is the first time Output Manager EM has been installed on your machine, the fields are blank and must be filled by the user. Once Activate has been run, FlexConfigure automatically detects the settings.

Output Manager EM Machine

The host name of the machine on which Output Manager EM is to be installed.

Database Machine The host name of the machine on which the Output Manager EM database resides.

FlexConfigure Password

Bydefault, this is ops404, but it may have been changed locally.

Database Type The type of database, either Oracle or PostgreSQL.

DB Name (SID or DSN The SID or DSN of the database; this should be auto detected by FlexConfigure.

User Name The user name set up for the database; this should be auto detected by FlexConfigure.



10. Click OK. You are returned to the Install/Configure Output Manager EM screen, shown below:

If connection was successful, the previously disabled options are enabled, as shown above.

If connection was unsuccessful, return to Enter Database Values and ensure the correct values are specified before clicking OK.

After installation you only need to click Connect to the Database, and type in the FlexConfigure Password in Enter Database Values, before clicking OK to login.

11. In Install/Configure Output Manager EM screen click Install New Output Manager EM Release to install the software on the machine.

12. In the Install Software dialog, click Install New Version.

13. In Select Installation File, navigate to the install.img file and select it and click Open. A status bar is displayed to indicate progress, this closes when the installation is complete. The installation process ensures the following directories are available on the Output Manager EM workstation, creating them if they do not already exist:

User Password The password set up for the database; this should be auto detected by FlexConfigure.

Oracle Home Directory The directory in which the database resides; this should be auto detected by FlexConfigure. This field is diabaled if Database Type is PostgreSQL.

Oracle Version The Oracle version. The default is 12c. This field is diabaled if Database Type is PostgreSQL.

DB Port The port number of the database; this should be auto detected by FlexConfigure.



ops/tmp/ops/smf/ops/acct/ops/logsops/spool/ops/resources/

14. If this is a new install then you need to configure the database with default values. In Install/Configure Output Manager EM select Load Output Manager EM Base Values. The following dialog is displayed:

15. Click OK.

A status bar is displayed to indicate progress.

16. In the Install/Configure Output Manager EM screen:

• If this is a new install click Activate New Install. This is only done once during the initial Output Manager EM installation.

• If this is an update on an existing version, DO NOT click Activate New Install until you are ready to run with the new version.

17. In the Install Software dialog, open the File menu and select Close.

The install of the Output Manager EM software is complete. Before moving to the configuration phase you should log off from ops and then log back into ops. This allows changes made by Activate New Install to be picked up by FlexConfigure.

18. Output Manager EM must reserve a number of TCP/IP ports. A short discussion is made in the section on the Input Receiver. You may want to, at this time update/etc/services to include entries for support of flexcontrol and the IR. Here are sample entries you may want to include. Do not include the entry for a second IR unless required.

OPS_FC 5044/tcp # flexcontrol port

This deletes any previous configuration. If you are restarting the installation and configuration process and have already completed this step, you may skip it this time.

Activate New Install updates a number of files and directory links in /ops. The following files are updated and should be backed up prior to activating the install.

/ops /.profile/ops/version.installed

The following soft directory links are updated. Their contents should be backed up prior to activating the install.

/ops/config/ops/data/ops/data/scripts



OPS_IR 4020/tcp # IROPS_IR2 4021/tcp # IR number 2 OPS_QM 5040/tcp # QMOPS_DQ 5041/tcp # DQ_SRVOPS_JFS 5555/tcp # Java file serverOPS_JTS 5556/tcp # Job ticket serverOPS_RLP 5557/tcp # redirected LDP port (if required)

The workstation must be rebooted for changes in /etc/services to take effect.

See Appendix X: Output Manager EM License Key Installation for how to install the license key.

19. Log into OPS and start FlexConfigure. Restart FlexConfigure by typing FlexConfigure.

20. In the Install/Configure Output Manager EM screen click Setup Output Manager EM Options.

21. In Enter Output Manager EM Values complete the following fields

:

Do not type FlexConfigure install until you are ready to run with the new version.

Company The name of your company or facility; this is displayed in the Output Manager EM GUI.

Retention Time (hrs) The default retention time for all jobs as they enter the system; this is the number of hours a job is retained after printing before deletion.



Interrupted Job State Wait Time (hrs)

The number of hours a job must remain with a status of Interrupted before it can be deleted by the user.

This is only permitted if Allow Interrupted Job Deletion has been set. See Creating a new user.

Copy ConfirmationRequired

If checked, a dialog is displayed if the user attempts to a copy a job out of the Output Manager EM GUI.

This field is only relevant if Allow Copy Job is set in User Administration. See Creating a new user.

Require Job Note on Job Hold

When the GUI is used to hold a job or a report a popup is displayed. The operator enters the reason the action is being taken. This text is available to the GUI and in the audit log.

Enhanced AWS If selected, when AWS is used, it uses UP13, UP14 and UP15 when determining which jobs to dispatch for printing.

Allow AnonymousGUIs

This allows access from User Interfaces on anymachine with network access and a valid username and password. This is typically set to 5, allowing five such instances to connect to Output Manager EM. If set to 0, each machine that a User Interface is allowed to connect from must be defined as a GUI, as described in User interfaces.

Allow Anonymous Clients

Similar to the Allow Anonymous GUIs option, selecting this option allows receipt of print data fromany machine with network access and Output Manager EM Print Submission software. If set to 0, each machine allowed to submit jobs must be defined as a CPU, as described in User interfaces.

Operator Requiredto Print

Whether an operator is required to initiate printing of a job.

Enable Service Codes Select this option if Service Codes are required.

Refer to Service Codes for more information.

Secure Classes Any job classes to be used as secure classes. Secure class jobs require additional passwords to be enteredwhen they are printed.

Secure AWS Classes Any secure job classes that you want to be dispatched through Automatic Work Selection (AWS). Normally secure classes are not eligible for AWS.

Any class entered here should be in the Secure Classes list. If it is not, a warning dialog is displayed, but the class can still be entered.

Locked Classes Classes in the locked classes list.

If a job has a class in this list, the status is set to Completed Locked when the job has completed printing.


http://www.webopedia.com/TERM/L/UNIX.html

http://www.webopedia.com/TERM/L/de_facto_standard.html

http://www.webopedia.com/TERM/L/cross_platform.html

http://www.webopedia.com/TERM/L/cross_platform.html

http://www.webopedia.com/TERM/L/software.html

http://www.webopedia.com/TERM/L/client_server_architecture.html

http://www.webopedia.com/TERM/L/client_server_architecture.html

http://www.webopedia.com/TERM/L/IP_address.html

http://www.webopedia.com/TERM/L/IP_address.html

http://www.webopedia.com/TERM/L/protocol.html


http://www.webopedia.com/TERM/L/TCP_IP.html





Locked Classes

cont.

The status of this job can only be set to READY by an Administrator who has the security privilege to unlock a such a job (see Allow Locked Release).

Whenever this field is changed, Output Manager EM should be restarted.

LDAP ldap//server:port If using LDAP the following must be specified:

ldap(s)://<server>:<port>

ldap for standard LDAP or ldaps if connecting using SSL encryption

<server> ‐ the LDAP server hostname.

<port> ‐ the port being listened on the server. Port 389 is used by default for standard LDAP and port 636 for LDAP over SSL.

Your LDAP administrator will provide the hostname, port and whether SSL is supported.

Refer to Appendix Y: SSL Support.

Password History Count

When a password is changed, the old password is added to password history. The Password History Count determines the number of old passwords retained in the password history list.

Old passwords are retained to ensure that a password is not re‐used too frequently. When a new password is entered, it is checked against the password history list. Only passwords that are not in this list can be used.

Any value from 0 (no password history) to 99 can be entered in this field.

If you reduce the value of the Password History Count, the following warning dialog is displayed:

“Reducing the password history count may result in older history passwords being lost. Do you want to continue?”

If you still want to reduce the Password History Count, click OK.

Password Retry Count The number of times in a row a user can enter an incorrect password before the user id is locked.

User Id Maximum Days Idle

The user id is disabled is it is not used for this period of time. A value of 0 disables the check.

GUI Maximum Minutes Idle

The GUI is shutdown if it is not used for this period of time. After which you will need to login again.



Enhance PasswordSyntax

Enables the use of more complex passwords, for example, mixed case and length. The criteria are as follows:

Eight to twenty characters.

Minimum of two alphabetic characters.

Minimum of two numeric decimal digits.

Minimum of one upper case alphabetic character.

Minimum of one lower case alphabetic character.

Minimum of one special character taken from (~@#$%^&*()_+`‐=\|:;<>?/.). Double and single quotes are not permitted.

No trailing or leading blanks.

No more than two consecutive characters.

The password cannot be a subset of the user name.

Passwords must be change the first time a user id is accessed.

Passwords expire after thirty days.

After three unsuccessful login attempts, a user id is suspended.

After 6 unsuccessful attempts at changing a password, the user id is suspended and automatically logged out unless the user id is the administrator in which case the user id is logged out but not suspended.

Messages displayed on the operator console indicating an unsuccessful login attempt or an unsuccessful password change do not contain the reason the password was rejected.

Advanced GUI Security If selected, the actions of a user is more tightly controlled. See Creating a new user for how to determine the type of advanced security required.

Advanced GUI audit If selected, audit records are created if Advanced GUI Security is used. The audit records are generated when an advanced GUI Security popup is displayed and indicates whether or not the action was allowed.

To display these audit messages (in the System Log) select System Log from the View menu in Output Manager EM Main Status.

Allow Security Checks on Blocks

This field determines what happens when the following apply:

More than one job has been selected.

At least one of the jobs has a secure class (see Secure Classes).



Allow Security Checks on Blocks

cont.

The user attempts to do something to with these jobs, either using the right‐click menu or the toolbar of the Job Queue.

The action can be performed on more than one job at a time, for example, releasing a job that is on hold.

In such a case, if Allow Security Checks on Blockshas been checked, then a security dialog is displayed. The user has to enter their User Name and Password.

If Allow Security Checks on Blocks has not been checked, the user is not allowed the perform the action under these circumstances.=

GUI Block Select Limit The maximum number of jobs that can be selected in the Output Manager EM User Interface for processing at one time.

Report Source Label Type

The file name displayed in the DD name for reports. The options are:

MVS. Display the DD name. This means that for jobs sent from a PC, the field is blank.

PC. Display the source file name. If the job was sent from an MVS system, the field is blank.

ALL. Display the DD name (if available). If the DD name is blank, display the source file name.

GUI shows event Viewer on startup

Selections are:

User Select – The event viewer startup property is governed by a setting in the User Administration panel.

No – The event is not started. A user starts the event viewer by selecting “Event Viewer” from the GUI’s Display tab.

Yes – The event viewer is started.

ENT Resource Capture Path

The path to the location in which captured Output Manager EM resources are saved.

MGR ResourceCapture Path

The path to the location in which captured MGR resources are saved.

NOTE: Both the ENT Resource Capture Path and the MGR Resource Capture Path are used only in MGR/ENT Robust mode and are enabled by setting the following parametersin the vip_cntl configuration file:

RESOURCECAPTURE=YESVS_VIP_OUTPUT_USER_PARM=VS_VIP_VIEW_USER_PARM=VS_DEST_ID_USER_PARM=



22. Click OK.

23. From the Administration menu, select Change Spool Locations.

24. Click OK to accept the default, or re‐type the spool locations.

25. The following dialog is displayed if Output Manager EM is running:

26. In the Install/Configure Output Manager EM screen click Customize Local Components.

27. The Output Manager EM Modules screen displays a list of modules installed during the initial installation phase, usually a Queue Manager (QM), Resource Manager (RESMGR), Input Receiver (IR), five User Interfaces (GUI)s and five Checkers (CHKRs). Typically, only printers and GUIs need to be added after the installation.

To define a new module select Create from the Edit menu. From the resultant menu select the type of module you wish to create.

Refer to Managing Output Manager EM Modules for more information.

28. When you have defined the required modules select Close from the File menu.

29. The Install/Configure Output Manager EM screen select Close from the File menu to end the installation process.

The last three set the VIP_OUTPUT, VIP_VIEW and DESTID job values for the system doing the printing.

Log Directory The directory in which the log files reside.



Installation procedure for WindowsBefore you install

The following must be installed before you install FlexConfigure:

Windows 12 Server.

If using the Oracle Database:

Oracle 12c for Windows.

Or, if using the PostgreSQL database:

PostgreSQL 9.4 for windows

psqlODBC drivers for windows (64 bit)

InstallationThe procedure given below assumes that Output Manager EM is being installed on the machine for the first time. Instructions for upgrading can be found in Appendix Q: Upgrading.

To install Output Manager EM, follow the procedure below:

1. From the Windows Start menu, select Control Panel.

2. Double‐click Administrative Tools.

3. Administrative Tools is displayed, double‐click Computer Management.

Computer Management is displayed.

4. In the left panel, select Local Users and Groups and then Users.

5. Right‐click the right panel, and select New user from the menu.

New User is displayed:

6. In User name, enter opsadmin.

7. Enter a Description.

8. Enter a Password.

9. Re‐type the password in Confirm password.

10. Make sure that User must change password at next logon is unchecked.

11. Click Create.



12. Click Close.

13. In Computer Management, in the left panel, select Local Users and Groups and then Groups.

14. Double‐click Administrators in the right panel.

15. In Administrator Properties click Add.

16. In Select Users, Computers, or Groups click Locations:

17. In Locations select the Host PC name and click OK.



18. In Select Users Enter the object name as opsadmin and click OK.

19. In Administrators Properties, opsadmin is shown, click OK:

The following steps are for Oracle only20. Ensure the ORACLE_HOME and ORACLE_SID environment variables are configured. To

do this, right‐click My Computer and select Properties from the menu. Open the Advanced tab:

21. Click Environment Variables.



22. In Environment Variables click New and add the following variables (if they are not already present) and then click OK.

23. From the Windows Start menu, select Control Panel | Administrative Tools | Services.

24. In Services, right‐click OracleORACLE_HOMETNSListener.

25. From the resultant menu select Properties.

Variable Value

ORACLE_HOME C:\oracle\product\12.1.0

ORACLE_SID OPS



26. In the General tab set Startup type to Automatic.

The following steps are for PostgreSQL only27. If using PostgreSQL, ensure that the Data Sources (ODBC) has been set‐up in:

Control Panel | System and Security | Administrator Tools | Data Souces (ODBC)

It should be configured to use the PostgreSQL ODBC Ansi Driver. If not configured, then select Add.

28. In Create a New Data Source, select PostgreSQL ODBC Driver (ANSI) and clickFinish.



29. In ODBC Data Source Administrator, shown below, click Configure.

30. In PostgreSQL ODBC Driver (psq|ODBC) setup, complete the following fields:

31. Click Test to ensure that you can connect to the database.

32. Click Datasource to open the following:

Server The server name of your machine.

Password ops



Ensure Use Declare/Fetch is selected, if not, the audit_export takes a long time.

33. Click Apply and then OK.

The following steps are for both Oracle and PostgreSQL34. Run the Output Manager EM installation file.

35. In FlexServer Installer click OK.

36. In Winzip Self‐Extractor click Setup.

A blue bar indicates the progress of the installation.

37. In Welcome to the InstallShield Wizard click Next.

38. In Choose Destination Location click Browse and navigate to the one required or accept the default by clicking Next.



39. In Select Features click Next.



40. In the following window type in the Database User Name, for example, ops, and click Next.

41. In the following window type the Database User Password, for example, ops, and click Next.

42. In the following window type the Database System ID, for example, ops, and click Next.

.



43. In the following window type the Database Port ID and click Next.

44. In License Agreement accept the terms of the agreement, by clicking Yes.

45. In Start Copying Files click Next.

A blue bar indicates the progress of the installation.



46. In InstallShield Wizard Complete accept the default by clicking Finish, to reboot your machine.

If you want to run Output Manager EM as a service, it must be installed in administrator mode.

Once your machine has restarted right‐click the Output Manager EM icon on the desktop select Run as administrator from the resultant menu.

The Install/Configure Output Manager EM screen is then displayed; this is the interface for FlexConfigure.


In most cases these are the same.

47. Click Connect to the Database.

Output Manager EM Machine

The host name of the machine on which Output Manager EM is to be installed.

Database Machine The host name of the machine on which the Output Manager EM database resides.



48. In Enter Database Values complete the following fields:

If this is the first time Output Manager EM has been installed on your machine, the fields are blank and must be filled by the user. Once Activate has been run, FlexConfigure automatically detects the settings.

49. Click OK. You are returned to the Install/Configure Output Manager EM screen.

If connection was successful all the options are enabled.

If connection was unsuccessful, return to Enter Database Values and ensure the correct values are specified before clicking OK.

NOTE: After installation you only need to click Connect to the Database, type the FlexConfigure Password and click OK in Enter Database Values to login.

FlexConfigure Password

By default, this is ops404, but it may have been changed locally.

Database Type The oracle type. Either Oracle or PostgreSQL; this should be automatically detected by FlexConfigure.

DB Name Oracle SID For Oracle, this is the SID. For PostgreSQL, this is the DSN.

The SID of the database should be automatically detected by FlexConfigure.

User Name The user name set up for the database; this should be auto detected by FlexConfigure.

User Password The password set up for the database; this should be auto detected by FlexConfigure.

Oracle Home Directory The directory in which the database resides; this should be automatically detected by FlexConfigure.

This option is disabled if PostgreSQL is used.

Oracle Version The Oracle version. The default is 11g.

This option is disabled if PostgreSQL is used.

DB Port The port number of the database; this should be auto detected by FlexConfigure.



50. In Install/Configure Output Manager EM click Install New Output Manager EM Release.

51. In the Install Software dialog click Install New Version.

52. In Select Installation File, navigate to and select the Rwin64.img file and click Open.

A status bar indicate progress and closes when the installation is complete.

The following directories are created, if they do not already exist.

NOTE: What is listed here are the default directories. The install wizard allows you to change root path C:\PB, if desired. See page 23.

The installation process ensures the following directories are available on the Output Manager EM workstation, creating them if they do not already exist.

C:\PB\tmpC:\PB\smfC:\PB\acctC:\PB\ENT3.0\logsC:\PB\opspoolC:\PB\resources

53. If this is a new install then you need to configure the database with default values. In Install/Configure Output Manager EM select Load Output Manager EM Base Values. The dialog right, is displayed:

54. Click OK.

A status bar is displayed to indicate progress.

55. In the Install/Configure Output Manager EM screen:

• If this is a new install click Activate New Install.

This is only done once during initial Output Manager EM installation.

This deletes any previous configuration. If you are restarting the installation and configuration process and have already completed this step, you may skip it this time.



• If this is an update on an existing version, DO NOT click Activate New Install until you are ready to run with the new version.

56. In Install Software, select Activate Install.

57. A message is displayed requiring confirmation: “Do you want to install flexcontrol as a windows service?”. Click Yes.

58. In Install Flexcontrol as a service complete the following fields:

59. Select Automatic. Output Manager EM Windows automatically start when the PC is started.

60. Click Install Service. The message **service created is displayed in Status. If the service installation failed, verify that you started FlexConfigure in administrator mode. If you forgot to start in administrator mode, complete the rest of the installation and install the service later by right‐clicking the FlexConfigure icon and selecting run as a service from the resultant menu and then going through the Activate Install and Install as a service step.

61. If the service is created successfully, test starting the service manually from the services console, open the following:

Control Panel | Administrative Tools | Services

62. Right‐click on the flexcontrol service and select Start from the resultant menu.

User name opsadmin, the user name defined on page 17.

Password The password defined on page 17.



63. If the start fails with the following message the reason maybe caused by Windows Server UAC security.

“Windows could not start the flex control service on Local Computer.”

64. Right‐click flexcontrol in the Services console and select properties, shown below:

65. Open the Log On tab, type in the password, confirm it and click OK.

66. The following message is displayed, click OK to close:

67. The service can now be stopped by right‐clicking flexcontrol and selecting Stop from the resultant menu, shown in step #65.

68. Return to the Install/Configure Output Manager EM window and select File | Exit. This closes Install/Configure Output Manager EM. The Finish FlexServer Installation is removed from the desktop:

69. Double click on the hostkey.bat file. The default location for this file (which may be changed during installation) is:

C:\PB\ENT3.0\bin\hostkey.bat

The Command Prompt is displayed, with Hostkey:



70. Contact Pitney Bowes Customer Support, advise them of the Host ID in return for the security key file.

71. Save this file on your PC.

NOTE: If there is a change to the network card or the drive of the PC, a new security key is required.

72. Open the Command Prompt and navigate to the directory in which the security key file was saved.

The following steps are for Oracle only73. At the Command prompt, type sqlplus.

74. Type ops for the User, and Password.

75. Type in the sqlplus key @xxxxx.key.sql.

Commit Complete is displayed.

76. Type quit and press <Enter> to exit sqlplus and close the command prompt.

The following steps are for PostgreSQL only77. At the Command prompt, type psql‐U ops.

78. Type ops for the Password.

79. Type in Type in \i xxxxx.key.sql.

Commit Complete is displayed.

80. Type \q and press <Enter> to exit psql and close the command prompt.

The following steps are for Oracle & PostgreSQL81. In the Install/Configure Output Manager EM screen click Setup Output Manager

EM Options.

82. In the Install Software open the File menu and select Close.

The install of the Output Manager EM software is complete. Before moving to the configuration phase, log off from ops and log in again. This allows changes made by Activate New Install to be picked up by FlexConfigure.

83. The following ports are used by Output Manager EM and, depending on site configuration requirements, may need to be open in the firewall:

The workstation must be rebooted for changes to take effect in the following directory:

C:\\Windows\System32\drivers\etc\services

See Appendix X: Output Manager EM License Key Installation for instructions on installing the license key.

OPS_FC 5044/tcp # flexcontrol port

OPS_IR 4020/tcp # IR

#OPS_IR2 4021/tcp # IR number 2

OPS_QM 5040/tcp # queue manager



84. Log into OPS and double‐click the FlexConfigure icon..

85. In the Install/Configure Output Manager EM click Setup Output Manager EM Options.

86. In Enter Output Manager EM Values complete the fields as described for the same screen on page 11.

87. Click OK.

88. From the Administration menu, select Change Spool Locations.

89. Click OK to accept the default, or re‐type the spool locations.

90. The following is displayed if Output Manager EM is running:

91. Click OK.

92. In the Install/Configure Output Manager EM click Customize Local Components.

93. Output Manager EM Modules displays a list of modules installed during the initial installation phase, usually a Queue Manager (QM), Resource Manager (RESMGR), Input Receiver (IR), five User Interfaces (GUI)s and five Checkers (CHKRs). Typically, only printers and GUIs need to be added after the installation.

94. To define a new module select Create from the Edit menu.

95. From the resultant menu, select the type of module you wish to create.

Refer to Managing Output Manager EM Modules for more information.

96. When you have defined the required modules, select Close from the File menu.

97. In Install/Configure Output Manager EM, select Close from the File menu to end the installation process.

Do not start FlexConfigure install until you are ready to run with the new version.


OUTPUT MANAGER EM OPTIONS


Output Manager EM OptionsNOTE: In this, and the following sections, Windows screens are shown. Solaris and

Linux screens differ from these only in appearance.

To edit your Output Manager EM options, follow the procedure below:

1. In Install/Configure Output Manager EM select Options from the Administrationmenu. This opens the Enter Output Manager EM Values window.

2. Edit the following fields as necessary, these are described in Output Manager EM Installation and click OK.

Changing the FlexConfigure Password1. In Install/Configure Output Manager EM select Change Password from the

Administration menu. This opens the Change FlexConfigure Password screen.

2. Complete the following fields, shown:

3. Click OK.

NOTE: If running on Solaris, you may get the message “Cannot save new password” displayed. If so, check that the file permissions for /ops/install/flexonfigure.data are set to allow your Solaris ID to write to this file.

Old Password Your old password.

New Password Your new password.

Verify Your new password again.

MANAGING OUTPUT MANAGER EM MODULES


Managing Output Manager EM Modules

During the initial installation phase, usually a Queue Manager (QM), resource manager (RESMGR), Input Receiver (IR), five user Interfaces (GUIs) and five Checkers (CHKRs) are installed. For a simple system, only printers need to be added after the installation.

1. In Install/Configure Output Manager EM open the Administration menu.

2. Select Components. This opens the Output Manager EM Modules screen, which displays a list of modules installed:

Opening the Output Manager EM Modules screen does not close the Install/Configure Output Manager EM screen but is displayed in a separate window. Both screens can be displayed at the same time but only one can be active.

Moving columns In this screen you can move the columns by clicking in the header and dragging to the desired location.

Sorting columns You can sort by a desired column by double‐clicking its heading. Columns are sorted in alphanumeric ascending order.

Refreshing Data Refresh the data in the screen by selecting Refresh from the File menu.

Closing Close the Output Manager EM Modules screen by selecting Close from the File menu.

CREATING OUTPUT MANAGER EM MODULES

Creating Output Manager EM modules

This section describes how to create the different Output Manager EM modules.

User interfacesThe User Interface component (GUI) defines a remote system that is allowed to connect to Output Manager EM as a GUI. Once defined, the GUI software must be installed on the remote system; the procedure for doing this is described in the Output Manager EM User Interface Installation Guide.

By default, five GUI components are setup at initial installation. They are configured to run on the local Output Manager EM machine and must be reconfigured if GUIs are to run on remote systems.

If security on GUIs is not required, you may find it more convenient to allow anonymous GUIs. These are configured in Setup Output Manager EM Options. You must select the number of “unregistered” remote systems that may connect to Output Manager EM at any one time.

To create a GUI, follow the procedure below:

1. Open the Edit menu.

2. Select Create.

3. From the resultant menu select GUI. The Device Properties: <New> screen is displayed, complete the following fields:

Module ID This is a unique number allocated by FlexConfigure. The numbering starts at 1 and increments by 1 for each module added to the system. The Module ID is not shown until the Module has been created.



4. From the File menu select Save.

5. If you do not intend creating or modifying any more modules, select Close from the File menu to return to the Install/Configure Output Manager EM screen.

To modify one of the five default GUIs, follow the procedure below:

1. In Output Manager EM Modules select the required GUI.


3. Select Modify.

4. Modify the necessary fields, these are described in the procedure for creating a GUI on the previous page.

Module Type This is dependent on the selection made from the Edit | Create menu. In this case the Module Type is GUI.

Module Name The name of module of up to eight characters. We recommend GUIn; where n is the next sequential GUI number.

Host The machine on which the GUI runs. This must be either a hostname known to the Output Manager EM server, or an IP address.

Log Count The number of log files retained. The maximum allowed is 99.

Visible Whether this module is visible to users. This option should always be set to Y.

Log Level The severity of the events to be logged. This can be set to Off or a value from 1 through 10. The higher the value the more information in the log.



CPUThe CPU component defines a remote system that is allowed to submit print jobs to Output Manager EM. Along with defining a CPU component you need to install Print Submission software on the remote system. The procedure for doing this is described in the Output Manager EM Print Submission Interface Installation and User Guide.

By default, one CPU component is setup at initial installation. Additional CPUs may be created to allow more than one remote systems to submit print jobs.

If security on CPU’s is not required, you may find it more convenient to allow anonymous CPUs. These are configured in Setup Output Manager EM Options by clicking the radio button for Allow Anonymous clients. Anonymous CPU’s are known as CPU_anon in the Custom Local Component display.

When security is an issue create CPU clients for authorized remote systems as follows:


2. Select Create.

3. From the resultant menu select CPU. The Device Properties: <New> screen is displayed, complete the following fields as described for User interfaces. The only differences are that the Module Type is CPU and the additional field.


5. If you do not intend creating or modifying any more modules select Close from the File menu to return to the Install/Configure Output Manager EM screen.

Icon ID Select the icon you want to represent the CPU module you are creating from the drop‐down. This icon with be displayed in the Output Manager EM User Interface.



Input ReceiverIt is the Input Receiverʹs (IR) task to receive print jobs and store the print data in the Output Manager EM Spool and the job attributes in the Output Manager EM database. Post processing tasks as outlined in:

/ops/scripts/ir_process.sh

on Solaris/Linux servers and

C:\PB\ENTX.X\oracle\scripts\ir_process.sh

on Windows servers

are run prior to setting the job state to Ready. Typical post receipt processing steps include:

a resource check,

finding the page count for the job,

running Mapping Rules see Creating Mapping Rules, and

running one or more ́ changeAnyʹ programs when job attributes are dependent on inputted print data.

A status of Ready is set if all goes well, Resource Hold when resources are missing or Proc Hold when the checking process could not complete due to problems with data. A job status of Incoming can be seen when large print files in are actively being input. Checking is shown when the resource checker is running. A status of Interruptedusually means the remote CPU has lost its connection to Output Manager EM.

During installation one IR entry is made.

To create an IR, follow the procedure below:

1. From the Edit menu, select Create.

2. From the resultant menu, select IR.

3. Device Properties: <New> is displayed. Complete the fields as for User interfaces(see User interfaces). The only difference is that Module Type should be set to IR.

4. From the File menu, select Save.

5. If you do not intend creating or modifying any more modules, from the File menu select Close to return to the Install/Configure Output Manager EM screen.

The default IR configuration file is named IR.cfg.default. It is located in the following directory:

Refer to Appendix J: IR Default Configuration File.

If you wish to be able to submit jobs to Output Manager EM with duplicate names or data files, the config file must contain the following statement:

allowduplicate=yes

By default the IR use TCP/IP port 4020. On Solaris/Linux Servers the port should be recorded in the file /etc/services with the entry:

OPS_IR 4020/tcp

Solaris/Linux /ops/data

Windows C:\PB\ENTX.X\data



On Windows servers ensure the firewall has opened 4020 for use by the IR.

Should site requirements dictate a different port is used, update the IR.cfg file and update the ʺservice = ʺ configuration option.

An IR listens to one port for connections. It can support a large number of clients from many different machines and it is possible to run multiple Input Receivers which would listen on different ports.

NOTE: We do not recommend that additional IRs are defined unless either multiple ports are required, or you are expecting a very high throughput. For additional IRs to be effective in increasing throughput the Output Manager EM hardware platform must have multiple network adaptors connected to multiple networks. If in doubt, contact Pitney Bowes Customer Support.

Receiving encrypted data recordsThe Input Receiver supports encryption by submission clients. These include JES Connect, Peer Server (SE_SRV), and FSESCCL.

FSESCCL encryption parameters are specified via a configuration file or command line. The parameters are ENCRYPT (options are YES and NO), KEY (options are 32 or 64 hexadecimal characters), and MULTIREC (options are YES and NO).

Peer Sever encryption parameters are specified via a configuration file.

The IR supports concurrent encryption and encryption and compression (either Run Length Encoded (RLE) compression or Deflate Compression).

Concurrent compression and encryption are supported by fsesccl and se_srv. A configuration parameter has been added (MULTIREC) to indicate if the IR that is being addressed supports concurrent compression/encryption. If MULTIREC is not set and encryption and RLE compression are both enabled.

The Input Receiver (IR) support for encryption keys may be configured to be IP specific. This allows for enhanced security. A default encryption key can be used for those clients that are not assigned a unique key.

decryptkey. The default AES encryption key value (32, 48 or 64 hexadecimal values). This is used for IP addresses not covered by dec_ipNN.

dec_ipNN. The IP address or hostname of the client that is assigned a unique encryption key. NN is a two digit number between 00 and 19. It corresponds to dec_keyNN. The hostname must be known to the Output Manager EM server (DNS, hosts table, etc).

dec_keyNN. Encryption key for a specific IP address. The NN corresponds to the NN in dec_ipNN.

The decryption keys are 32, 48 or 64 hexadecimal characters (0 to 9 or A to F, character case ignored).

Here are some examples of keys:

decryptkey = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6F0F1F2F3F4F5F6F7

dec_ip can be a hostname or ip address

dec_ip00 = tortompc

dec_key00 = 00112233445566778899AABBCCDDEEFF

dec_ip01 = 192.168.0.100



dec_key01 = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6

NOTE:

• Wildcards are not allowed in the IP address (192.168.0.* are not supported). Any unmatched pairs are discarded, for example, dec_key03 without dec_ip03.

• The IR processes the IR.cfg file at start‐up. If there is a configuration error, for example, invalid decryption key, an error message is written to the IR log and the IR exits. The IR.cfg can be processed dynamically as well when the IR processes a new connection (to JESConnect, SE_SRV, FSESCCL). This allows adding new keys or updating encryption keys without restarting the IR. Configuration file errors detected on new connections are logged but do not cause the IR exit. For clients that have already connected (INCOMING JOB), the decryption key remains unchanged for that connection until the connection is lost.

• If the IR fails to decrypt an encrypted record (mismatched decryption keys), it returns an error status to the sender and drop the connection. In addition, a log message is written to the IR log. The job is in an interrupted state.

• The IR decryption requires a license key.

Setting up the IR configuration fileThe IR configuration file is not automatically created by FlexConfigure. When one is required, the file should be copied from the IR.cfg.default file to the modname of the IR.

For Solaris/Linux servers:

cd $ROOT/data

cp IR.cfg.default IRname.cfg

For Windows servers:

cd C:\PB\ENT3.0\data

copy IR.cfg.default IRname.cfg

Where IRname is the name of the IR module (IR in uppercase by default).

The config file name is case sensitive.



Queue ManagerThe Queue Manager (QM) provides the automatic operation of Output Manager EM, such as automatic work selection. It is also the central process by which the other components communicate.

During installation one QM module is created, the system does not support more than one of these.

To create a QM, follow the procedure below:

1. Open the Edit menu and select Create.

2. From the resultant menu select QM. The Device Properties: <New> screen is displayed. Complete the fields as described for User interfaces. The only difference is that the Module Type is QM.



By default, the length of Output Manager EM Job ID is eight characters, however the upper and lower limit of job ids can be specified in the QM configuration file. The setting for this are:

JOBIDLOWLIMIT=XXXXXXXX

Where xxxxxxxx represents the lowest job id allowed.

JOBIDHIGHLIMIT=XXXXXXXX

Where xxxxxxxx represents the highest job id allowed.

REPORTIDLOWLIMIT=XXXXXXXX

Where xxxxxxxx represents the lowest report id allowed.

REPORTIDHIGHLIMIT=XXXXXXXX

Where xxxxxxxx represents the highest report id allowed.

Any limit that cannot be converted to a valid numeric value is ignored; as is any invalid combination of high and low limits and high limits that are too high. These conditions are flagged in the QM proclog.

The handling of delete report requests from the GUI is modified to move the job log to the next report of the job when the report is the first report in the job (see Logging System).



PrintersThe Output Manager (OM) controls sending the print data to the output device (usually a printer). The OM reads the data from the spool and the job information in the database and combines them into a format that is acceptable to the output device. The OM may send the data through a print client for data transformations and direct device control. There are several different OMs used in Output Manager EM, depending on the type of input data and output device.

LPR driverThe LPR Driver is used to send print files via the lpr protocol. The driver has site configurable banner pages for PostScript data streams. The start and end banner pages are defined by the files startban.ps and endban.ps. These can be found at the following locations or on Output Manager EM:

These files are standard PostScript files; text with *…* are dynamic values that are replaced at print time by job or printer values. The values are:

This driver is for PostScript and PCL network printers. There are two lpr clients:

om_lpr This uses the Solaris based lpr command that requires a copy of the print file exist as a file on the workstation before the data is sent. This means data is pulled out of the Output Manager EM Spool; a file is created and sent via LPR.

This is a Solaris only option.

om_lpr has been deprecated but continues to be distributed.

fse_lpr This pulls the data from Output Manager EM and fires it over TCP/IP without the need for intermediate disk files.

To create an LPR Printer, follow the procedure below:


2. From the resultant menu select Printer.

3. From the Printer menu select LPR Driver.

4. Open the System tab and complete the fields as described for the System tab in LPR driver. For LPR Printers the Module Type is OM:LPR Driver.


Windows C:\PB\ENT3.0\data

jobname jobid

userroom groupname

userid class

formsid building

department printer

time date



5. Open the Banners tab and complete the fields as previously described.

6. Open the Company tab and complete the fields as previously described.

7. Open the AWS tab and complete the fields as described in LPR driver. This tab allows you to select the additional inputs, multiple selections can be made from: Line, AFP, XRX, PCL, PS, PDF, VIPP.

8. Open the Specific tab, complete the following fields :

LPR Driver Leave unchecked to use the Solaris lp to drive the LPR. Check this field to use the Output Manager EM fselpr to drive the LPR.

This field must be checked when Output Manager EM is running on a Windows platform.

Server This field can only be used if the above field is checked. Enter the LPR server (or printer) that the OM uses.

Queue The default logical print queue on the device that print data is being sent to. Syntax is machine name followed by queue name, for example, DocuPrint:simplex.

RDW Check this box if the data being sent to the device is to include IBM standard four‐byte Record Descriptor Words (rdw).


10. A configuration file is created. Check the settings in this file are correct. See Appendix K: OM_LPR Example Configuration File.




Using a dynamic VP fieldBy setting the following parameter in the config file the job is queued to the virtual printer(t_opod_job_podi.vp) on the job. If no virtual printer is present use the queue that is defined on the OM(t_opom_om.drvr).

USE_VIRTUAL_PRINTER=YES

The default for this is USE_VIRTUAL_PRINTER=NO; therefore the absence of this parameter does not change the om_lpr functionality.

This command is only effective if om_lpr is attempting to use the ops_lpr and not the standard Solaris lp command. The t_opom_om.server must be manually updated with the server name or IP Address, and the OM with the queue name in the queue field.

MGR driverThis is the component used to drive Output Manager attached IPDS, Metacode, PCL, PostScript and PDF printers.

When using Output Manager print drivers, several files on the server can be built to control parameters on a job, class, form, or printer basis. Files with the extension .vipopt are added to the commands sent to the print drivers. The files are:

<printername>.vipopt the name of the printer<jobname>.vipopt the job name<formname>.vipopt the name of the form on the printer, not the job. If

the form on the printer contains a wildcard ‘*’, theform of the job is used instead.

<class>.vipopt class of the job

The vipopts must be added in the order shown above, with <printername>.vipoptfirst and <class>.vipopt last. <printername>.vipopt has the highest priority and <class>.vipopt has the lowest priority.

Print drivers may use configuration files for additional configuration details. The om_PB output module, used for Output Manager driven printers, reads certain optional configuration files.

These files can be found at the following locations:



The contents of the file are any valid profile options as specified by the Prisma/X+ or Output Manager User Guides. An example of this is to create a FORMNAME.vipopt with a PAGECONTROL option that controls the tumbling desired for the n‐up processing of jobs printed with that form.

This is for Output Manager driven LPS or IPDS printers. To create a Output Manager Driver, follow the procedure below:



3. From the Printer menu select MGR Driver.

4. Open the System tab and complete the fields as previously described. For Output Manager Printers the Module Type is OM:MGR Driver.





7. Open the AWS tab and complete the fields as previously described. This tab allows you to select the inputs: Line, AFP, XRX, PCL, PS, PDF, and VIPP.Multiple selections can be made.

8. Open the Line tab and complete the fields as previously described.

9. Open the AFP tab and complete the fields as described in LPR driver.

10. Open the XRX tab and complete the fields as described in LPR driver.

11. Open the Specific tab and complete the following fields:

Device Manager The name of the machine running Output Manager.

Port The port being used by Output Manager.

Sequence Numeric sequence of the printer attached to Output Manager.

MGRUser Drive The drive on the Output Manager machine on which the MGRUser directory resides.

MGRUser Path The path to the MGRUser directory.

Resource Drive The drive on the Output Manager machine which is mapped to Output Manager EM resources.

Resource Path The path to the Output Manager resources on the Output Manager EM machine.

Virtuals Drive The drive on the Output Manager machine on which the Virtuals directory resides.

Virtuals Path The path to the Output Manager Virtuals directory on the Output Manager machine.





For configuration file options, see Appendix F: OM_VIP Example Configuration File.

Transfer driverThe Transfer Driver is used to transfer a print file from Output Manager EM to another networked device via FTP. The receiving device must have some form of FTP Server running to be able to receive the print data.

To create a Transfer Driver, follow the procedure below:



3. From the Printer menu select Transfer Driver.

4. Open the System tab and complete the fields as previously described. For Transfer Printers the Module Type is OM:Transfer Driver.



7. Open the AWS tab and complete the fields as described in LPR driver. This tab allows you to select the inputs: Line, AFP, XRX, PCL, PS. PDF Multiple selections can be made.

8. Open the Company tab and complete the fields as as described in LPR driver.

9. Open the Specific tab, complete the following fields:

SFTP Sets the transfer protocol to SFTP when checked. If not checked FTP is assumed.

Machine The host name of the target machine to which the print data is to be transferred. If the target machine is the same as the sending server, type in DirectCopy.

The host name must be resolvable by the server, either by a DNS server or by the host file on the sending server (for



Solaris/Linux /etc/hosts, for Windows C:\WINDOWS\system32\drivers\etc\hosts).

User The user name used to log onto the remote device to which the print data is to be transferred.

Password The password required to log on as the above user.

Directory The target directory to which the print data is to be transferred. If Machine is set to DirectCopy then this is a locally accessible directory on the sending server.

For Windows, this can be either:

A fully qualified directory location (starting with a drive letter), or

A UNC path (see MAP_TO_DRIVE for how to determine drive letters for a UNC path).

For Solaris/Linux, this is a mounted directory location, for example:

/export/home/user1/ent_omxfer_jobs

Long File Names When checked a 1 is inserted in the database field: T_OPOM_OM.DTF_ID and the job names are built as ‘jobname_reportid.pdlext’ (where pdlext is one of: afp, txt, xrx, pcl or ps).

If not checked the name is built as follows:

[first 3 chars of jobname][5 digits of report id].ctl

[first 3 chars of jobname][5 digits of report id].dat

[first 3 chars of jobname][5 digits of report id].nfoExample:

If jobname is ABCDEFGH and report id is 12345 and PDL is META, the names would be as follows:

Long name

ABCDEFGH_12345.ctl

ABCDEFGH_12345.xrx

ABCDEFGH_12345.nfo

Default

ABC 12345.ctl

ABC12345.dat

ABC12345.nfo

Include RDW bytesfor this device If the RDW check box is checked, then RDW bytes are sent

at the beginning of each record for this device. Otherwise, they are suppressed.



Match fingerprints to print

For use only if this module uses SFTP. Check to verify that the fingerprint matches the expected value before sending any data.

SFTP Fingerprint

For use only if this module uses SFTP. Your SFTP administrator should supply you with the fingerprint to specify here.

Each SFTP server has a fingerprint which is its public host key. This is sent in encrypted format to the client (om_xfer).

The SFTP Fingerprint format will be twenty hexadecimal pairs with a colon in between each pair, for example: A9:AA:0C:86:48:45:80:68:B5:DD:A1:15:F4:85:29:77:B6:E7

:9B:DE)

10. Click Validate Fingerprint if the fingerprints were not provided by the administrator or to verify the fingerprints provided by the administrator.



3211 driverTo create a 3211 Driver, follow the procedure below:


2. Select Create.


4. From the Printer menu select 3211 Driver.

5. Open the System tab and complete the fields as previously described. For 3211 Printers the Module Type is OM:3211 Driver.



8. Open the AWS tab and complete the fields as previously described.







Driver PC The location of the driver for this printer.

Port The port number the printer driver is listening on.

Channel Address in Hex The Channel Address in Hex, of the target device.



The OM3211 output manager used to drive IBM 3211‐type devices have a default configuration file, in the /ops/data directory. The name of this file is <printername>.cfg where the printer name is defined in step 5, above. This name is case‐sensitive. Using this file the printer can be configured for JESConnect emulation, FCB type, etc. Example configuration files are provided in the following location:/ops/data/3211.cfg

Xerox driverTo create a Xerox Driver, follow the procedure below:


2. Select Create.


4. From the Printer menu select Xerox Driver.

5. Open the System tab and complete the fields as previously described. For Xerox Printers the Module Type is OM:Xerox Driver.





8. Open the AWS tab and complete the fields as previously described. Xerox Driver printers support Line and XRX Input. Multiple selections can be made.




Driver PC The location of the driver for this printer.

Port The port number the printer driver is listening on.

Channel Address in Hex The Channel Address in Hex, of the target device.



The OM_XEROX output manager used to drive Xerox LPS/EPS devices have a default configuration file, in the /ops/data directory. The name of this file is <printername>.cfg where the printer name is defined in step 5, above. This name is case‐sensitive. Using this file the printer can be configured for JESConnect emulation, FCB type, etc. Example configuration files are provided in the following location:/ops/data/xerox.cf

The Output Manager EM Xerox printer driver was designed to drive Xerox LPS print controllers using a Bus and Tag connection. The goal is to provide the ability to manage Xerox print resources and control the complete Xerox printing environment. The Xerox print driver contains an Output Manager EM module om_xerox, and a Windows PC running an Output Manager EM driver opsbd.exe that uses a Barr channel card to connect to a Xerox LPS controller.

The Output Manager EM Xerox driver is able to manage your resources and control the programs started on the printer from job to job without operator intervention. Output Manager EM receives status updates from the Xerox LPS controller, allowing for full function operability and accountability.



In addition, the Xerox printer driver allows the Common Control Unit (CCU) to communicate with Xerox DocuPrint Enterprise Printing System (EPS) over TCP/IP.

Refer to Appendix A: Xerox EPS Driver for information on the Xerox EPS Driver, Appendix B: Output Manager EM Example Configuration Files for an example configuration file.

External Client

Refer to External Queue for more information.

External Clients are used when a printer has a built in print queue. You need to create the External Queue before trying to create an External Client. When setting up the External Client, the first thing you should do is go to the Specific Tab and select the Client Type, then the associated External Queue. Once that is done, continue filling in the rest of the fields for the client.

To create an External Client, follow the procedure below:



3. From the Printer menu select External Client.

4. Open the Company tab and complete the fields as described in LPR driver.

5. Open the System tab and complete the fields as described in LPR driver. For External Clients the Module Type is OM:External Client.

6. Open the Queued Job Matching Attributes tab:


Ensure that your External Queue has already been set up before attempting to connect the External Client to it. See External Queue.



Form The type of paper stock currently assigned to this device.

Class The class assigned to the device. Type the required value in the open text field. Values are 0–9, A‐Z and *. A maximum of seven classes can be assigned to a printer.

Dest ID The Destination Id of the device that is to receive the output. Enter a destination name of up to eight characters or use * to select any destination.

Page/Min This is only applicable to continuous paper and is the minimum number of pages required to print or send to this device.

AWS User Param 13‐15

These fields are only displayed if Enhanced AWS has been selected in FlexConfigure (see Enhanced AWS). They are used for Automatic Work Selection (AWS).

If the values in these fields match the corresponding fields, the external client is used for the job.

All 3 fields must match. If a field is blank, then the corresponding value must be blank.

Line Input Select this option if the server is to accept Line Input.

AFP Input Select this option if the server is to accept AFP Input.

XRX Input Select this option if the server is to accept a XRX Input.

PCL Input Select this option if the server is to accept a PCL Input.

PS Input Select this option if the server is to accept a PostScript Input.

PDF Input Select this option if the server is to accept a PDF Input.

VIPP Input Select this option if the server is to accept Xerox VIPP Input. Multiple selections can be made.

Use Job Size Automatically routes large jobs to fast printers, or small jobs to slower printers.

Pages Type in the Minimum and Maximum number of pages that should be sent to this device, both values must be specified for this feature to work.

You can also elect to print the following Pages:

Less than Minimum

Between Minimum and Maximum

Greater than Minimum



7. Open the Specific tab.


Prisma+ Server/Infoprint Server/Docutech Serve

The hostname or IP address of the Prisma+, InfoPrint or Docutech server.

Prisma+ Printer Number/Actual Destination Name

The number of the Prisma+ printer or the name of the external queue to which the job is sent.

Infoprint Ack‐Interval

The interval before acknowledgement is sent/received.

Print Class The print class of the device.

List of External Queues

The external queues connected to this client.

Client Type The only option is IPP Client.

Recreate Config File from Standard Template

Whether a configuration file for the device is created from the standard template.





MGR/ENT driverThis serves as the control interface for the Output Manager EM GUI, which directs all requests to its associated vip_cntl modules. This gives the existing Output Manager EM control model a place to send requests to Print, Cancel, Vary On, Vary Off, etc. In addition, it provides Output Manager EM with place to which to assign default job properties and resource paths based on output device.

To create a MGR/ENT Driver, follow the procedure below:



3. From the Printer menu select MGR/ENT Driver.

4. Open the System tab and complete the fields as previously described. For Output Manager Output Manager EM Printers the Module Type is MGR/ENT Driver.



7. Open the AWS tab

.

8. Complete the fields as previously described. This tab allows you to select the inputs: Line, AFP, XRX, PCL, PS, PDF, and VIPP. Multiple selections can be made.

9. Note the following fields:

PDF Input Select this option if the printer is to accept a PDF Input.

PDF RIP Types The PDF RIP types accepted by the printer.

OfficeMail Input Select this option if the printer is to accept input from OfficeMailTM.

OfficeMail RIP Types

The OfficeMail RIP types accepted by the printer.

Use Job Size AWS Automatically routes jobs based on job size.






13. Open the Specific tab:


MGR Control Use the drop down to select the Output Manager Control module that defines the Output Manager System on which the printer to be used can be found. The drop‐down presents a list of existing Output Manager Control modules and you may select as many as you need. Selected modules are prefixed with a ‘+’ while unselected modules are prefixed by a ‘–‘. Click the required module to toggle between selected and unselected.



Resource Drive The drive on the Output Manager machine which is mapped to Output Manager EM resources.


Virtuals Drive The drive on the Output Manager machine in which virtual resources are saved.

Virtuals Path The path to the virtual resources on the Output Manager machine.

MGR output client type

Use the drop down to select the output type for the printer being used.





CheckerOn receipt of a job, this module checks resources, page counts, etc. By default five Checker (CHKR) processes are created and available for processing jobs when you Activate the session. If your system receives a large number of small jobs, increasing the number of CHKR modules decreases the checking bottleneck but may adversely affect server performance.

To create a CHKR, follow the procedure below:


2. Select Create.

3. From the resultant menu select Checker. The Device Properties: <New> screen is displayed in the System tab; complete the fields as described in the User interfaces. In this case the Module Type is CHECKER.





ServerThe SERVER component sets up a remote file transfer to another Output Manager EM system; it can be either local or at a remote site.

To create a Checker, follow the procedure below:


2. From the resultant menu select Server. The Device Properties: <New> screen is displayed in the System tab; complete the fields as as described in the User interfaces. In this case the Module Type is SERVER:Peer Driver.


4. Open the AWS tab and complete the fields as described in the User interfaces. Multiple selections can be made.

5. Open the Specific tab as shown below:

6. Enter the IP address of the Remote Server.

7. For Line, AFP, XRX, PCL, PS, PDF and VIPP select either of the following:

No Compression Data is sent uncompressed.

Run Length Compression

Data is sent in run length compressed form. This removes repetitions of values and replaces them with a single value.

Deflate Compression

Data is sent in Deflate compressed form.

Deflate compression from the JesConnect program is not supported. Also, the use of Deflate compression/decompression increases the time required to submit a job to Output Manager EM. However, if a job submission process is constrained by network bandwidth, using Deflate compression may result in a smaller elapsed time



for submitting a job (compared to sending uncompressed data).

8. Set the following fields as required:

Resource Control This sets who can determine whether or not job based resources are used for this device. If set to Administrator, this value can only be set in this window using Send Resources. If set to Operator, the value set in Send Resources can be overridden by the value set in the Server Setup window.

Send Resources If set to Yes, resources are sent to the server, to be used as a job based resource.

NOTE:

• See Device setup fields in Viewing a Device’s Setup in the Output Manager EM User Guide.

• Encryption is also supported in the configuration file. See ENCRYPT in Appendix O: OM_PEER Example Configuration File.


10. If you do not intend creating or modifying any more modules, select Close from the File menu to return to the Install/Configure Output Manager EM screen.

If you would prefer your peer server to suppress the sending of external files, the following parameter must be added to its configuration file:

SENDEXTERNALFILES=1

Use 0 when sending jobs to a version of FlexServer Enterprise earlier than 5.2 or to a Output Manager EM that does not require the use of external binary files.

The name of the configuration file is:

<module name>.cfg

Where:

It is located in the following directory:

<module name> is the Module Name specified in the System tab of the Device Properties for the peer server.

cfg is the file extension. This must be lowercase.





Backup ServerThe BACKUP SERVER component allows jobs on an Output Manager EM system, that have completed the resource scanning step, to be sent to another Output Manager EM system automatically. This allows the remote Output Manager EM system to server as a backup to the local system. The backup server can have a job set the same as those sent to the local system. The backup process does not change the status of jobs on the local system, so they are ready for normal printing operations locally.

NOTE: By default, Backup Server is disabled for a new or existing user IDs.

To create a Backup Server, follow the procedure below:


2. From the resultant menu select Backup Server. The Device Properties: <New>screen is displayed in the System tab; complete the fields as described in the User interfaces. In this case the Module Type is SERVER:Backup Driver.


4. Open the AWS tab and complete the fields as described in the User interfaces. Multiple selections can be made.

5. Open the Specific tab as shown below:

6. Enter the IP address of the Backup Server in Backup Output Manager EM.

7. For Line, AFP, XRX, PCL, PS, PDF and VIPP select either of the following:

No Compression Data is sent uncompressed.

Run LengthCompression

Data is sent in run length compressed form. This removes repetitions of values and replaces them with a single value.



8. Set the following fields as required:

See Device setup fields in Viewing a Device’s Setup in the Output Manager EM User Guide.



SENDEXTERNALFILES=1

Use 0 when sending jobs to a version of FlexServer earlier than 5.2 or to a Output Manager EM that does not require the use of external binary files.

The configuration file is located in the /ops/data directory and the name of the file is:

<module name>.cfg

Where:

See Appendix I: Backup Server Example Configuration File for configuration options.

Deflate Compression Data is sent in Deflate compressed form.

Deflate compression from the JesConnect program is not supported. Also, the use of Deflate compression/decompression increases the time required to submit a job to Output Manager EM. However, if a job submission process is constrained by network bandwidth, using Deflate compression may result in a smaller elapsed time for submitting a job (compared to sending uncompressed data).

Resource Control This sets who can determine whether or not job based resources are used for this device. If set to Administrator, this value can only be set in this window using Send Resources. If set to Operator, the value set in Send Resources can be overridden by the value set in the Server Setup window.

Send Resources If set to Yes, resources are sent to the server, to be used as a job based resource.

<module name> Is the Module Name specified in the System tab of the Device Properties for the peer backup server.

cfg is the file extension. This must be lowercase.



Logical CPUThe Logical CPU component is used to set‐up multi‐customer support within Output Manager EM.

To create a Logical CPU module, follow the procedure below:


2. Select Create.

3. From the resultant menu select Logical CPU. The Device Properties: <New> screen is displayed: complete the fields as described in Checker. In this case the Module Type is LOGICAL CPU.



A logical CPU is the same as a Company name. Company names are used to filter which devices can be accessed by the user on the Output Manager EM Main Status window. See User View Restrictions by Company in Creating a new user for how to link one or more company names to a user. This gives the user access to all the devices associated with those company names.

External QueueOutput Manager EM supports IPP printing with the External Queue/External Client model.

The External Queue’s configuration determines the job mix that is transferred to the printer. The External Client is used to monitor the physical printing of the jobs. It is important to define the External Queue prior to defining the External Client.

Refer to the External Client section for information on how to create a client for an external queue.

To create an EQ, follow the procedure below:


2. Select Create.

3. From the resultant menu select External Queue.

4. Open the System tab and complete the fields as previously described. The Module Type is External Queue.



7. Open the AWS tab and complete the fields as previously described. This tab allows you to select the inputs: Line, AFP, XRX, PCL, PS, PDF, and VIPP.Multiple selections can be made.


9. Open the AFP tab and complete the fields as previously described.


11. Open the Specific tab, the layout of this tab depends on the option selected in Queue Type.



12. Queue Type is set to IPP Queue as that is the only type supported.

13. Select whether to Refresh Config Files, this option to refresh the configuration file for this device/queue when the device properties are edited.

14. Complete the fields as follows:



Printer Host Name The IP address of the IPP printer (not the name).

Default Printer Queue The default printer queue name used to address the printer when connecting via IPP. This name should be defined on the printer. Some printers do not respond to IPP commands unless an existing queue name is used in the IPP URI.

Current Submit Hold Status

The current status of the job.

Use Job’s Virtual Printer

If checked, the Job virtual printer property is used as the target queue when submitting a job to the printer.

Operator May Change the Setting of ‘Use Job’s Virtual Printer’

Allow the operator to change the Virtual Printer of the job.



Resource ManagerThe Resource Manager prohibits jobs with missing resources from printing. All release operations go through this process, which provides central control of all resource checking for Output Manager EM.

During installation one Resource Manager entry is made, the system does not support more than one of these.

To create a Resource Manager module, follow the procedure below:


2. Select Create.

3. From the resultant menu select RESMGR. The Device Properties: <New> screen is displayed; complete the fields as described in Checker. In this case the Module Type is RESMGR.



MGR ControlThe MGR Control module serves as the focal point for Output Manager EM interactions with a specific Output Manager system.

The MGR Control is responsible for:

Connecting to the Output Manager Exec and tracking Output Manager job activity for page updates, parent/child relationship, Output Manager job creation (splits only) and Output Manager job deletion.

Rolling up changes in the Output Manager job status/page counts into a change in the Output Manager EM report status. Any change is flagged to the Queue Manager. For jobs in progress at multiple printers/sites, the count is only be updated as it relates to the stated output device in the job table (OPS_PRI_ID). This field is cleared when a job is no longer printing on that device.

Parsing client state change messages, including the status of the current job in progress from the Output Manager Exec and displaying these in OM_VIPFLEX. Validating resource paths for output clients. If a Output Manager EM job is being processed at the Output Manager output client and the resource path for the input client is different from the output, a warning is displayed and issued to the audit event table.

Distributing work to the associated modules. This includes automatic work selection analysis, and work generated by operator activity, for example, sending jobs to Output Manager and printing jobs on a specific printer.

Handling print and submit job requests from the GUI. This includes analysis of whether a job needs to be run through Output Manager input. Jobs that exist on Output Manager should only need to have the output client changed.

Handling requests from the Queue Manager to delete a Output Manager EM job from the Output Manager system.

Handling merge requests from the GUI, including building an appropriate merge profile, generating a new Output Manager EM parent job for the merge and starting the merge on Output Manager.



Warning the operator when the same job has started to print on multiple Output Manager platforms. If possible, the warning should be suppressed for designated reprints. You are not able to print the same job concurrently on a single Output Manager system.

This may only apply to simple jobs without output splitting. A job that is split for output may have different splits printing on multiple Output Manager platforms, however, the current tracking cannot identify splits uniquely. Jobs merged with other jobs have a similar limitation, as Output Enhancement can selectively merge pages from different jobs.

Handling cancel requests from the GUI, these identify which Output Manager EM job to cancel. If the job is under the control of a To MGR module, the module is forced to cancel the job. If the job is marked for delivery, that mark is removed.

Refer to the To MGR section for more information.

To create a Output Manager Control module, follow the procedure below:


2. From the resultant menu select MGR CONTROL.

3. Open the System tab and complete the fields as previously described. For Output Manager Output Manager EM Printers the Module Type is MGR CONTROL.



6. Open the AWS tab:

Automatic Work Selection allows jobs to be selected for printing based on class, form and destination.

Output Manager EM automatically sends print jobs to a printer configured for the class, form and destination that match the print job. A printer can be configured to accept multiple classes but only one form and destination. Jobs requiring special forms are not scheduled until printers are setup and loaded with those forms.



If Automatic Work Selection is required complete the following fields:

Form The type of paper stock currently assigned to this device.

Class The class assigned to the device. Type the required value in the open text field. Values are 0–9, A‐Z and *. A maximum of seven classes can be assigned to a printer.

Dest ID The Destination Id of the device that is to receive the output. Enter a destination name of up to eight characters or use * to select any destination.

Page/Min This is only applicable to continuous paper feeds and is the minimum number of pages required to print or send to this device.

AWS User Param 13‐15These fields are only displayed if Enhanced AWS has been selected in FlexConfigure (see Enhanced AWS). They are used for Automatic Work Selection (AWS).

If the values in these fields match the corresponding fields, the printer is used for the job (if it is the next one available).

All 3 fields must match. If a field is blank, then the corresponding value must be blank.

Line Input Select this option if the server is to accept Line Input.

AFP Input Select this option if the server is to accept AFP Input.

XRX Input Select this option if the server is to accept a XRX Input.

PCL Input Select this option if the server is to accept a PCL Input.

PS Input Select this option if the server is to accept a PostScript Input.

VIPP Input Select this option if the server is to accept Xerox VIPP Input. Multiple selections can be made.

PDF Input Select this option if the server is to accept a PDF Input.

PDF RIP Types The PDF RIP types accepted by the MGR control module.

OfficeMail Input Select this option if the server is to accept a input from OfficeMail.

OfficeMail RIP TypesThe OfficeMail RIP types accepted by the MGR control module.

Use Job Size AWS Automatically routes jobs based on job size.

Pages Type in the Minimum and Maximum number of pages that should be sent to this device. To use this feature both must be specified. You can also elect to print the followingpages:

Less than Minimum

Between Minimum and Maximum

Greater than Minimum



7. Open the Line tab and complete the fields as previously described. If NONE is specified in the FCB field, no default FCB is sent ahead of the job.





Device Manager The name of the machine running Output Manager.

Port The port being used by Output Manager.

Sequence Numeric sequence of the printer attached to Output Manager.



Resource Drive The drive on the Output Manager machine which is mapped to Output Manager EM resources


Virtuals Drive The drive on the Output Manager machine in which virtual resources are saved.

Virtuals Path The path to the virtual resources on the Output Manager machine.



Refer to Appendix C: VIP/MGR Control Example Configuration File for an example of a config file for this module and details of its parameters.



To MGRThis module connects to Output Manager and sends Output Manager EM job data to a specific Output Manager input client, via the Output Manager Exec. There is a one‐to‐one relationship between Output Manager input clients and To MGR modules, where instructions on which jobs are sent to Output Manager are issued from vip_cntl. In addition, it can ‘preempt’ work by aborting a job in progress without putting it on Output Manager EM hold so that it is rescheduled automatically to this module or another suitable one. This module was formerly known as OM_VIP, the properties it has in common with To MGR are PRMODE and Job Size Selection. The module builds Output Manager profiles and set files in the same way as the former OM_VIP module. However, it differs as follows:

The Output Manager commands file must be sent to Output Manager as a modifier and referenced in the Output Manager start job command.

Output Manager modifiers are supported as a resource based on FLASH or other Mapping Rules. If a modifier is applied as a result of mapping rules, the Output Manager modifier must be applied when the job is printed.

If indicated, the job should be configured to generate virtual resources at Output Manager input processing. This involves running a simple Output Enhancement script, unless the job already calls for a input Output Enhancement script, and forcing the virtual resources to be written into the Output Manager job directory (LOCALRESOURCEDIR=YES).

The Output Manager generated Job Id should be requested (using the VPI interface) and a new record in the MGR JOBINFO table added before the job is submitted to Output Manager. This prevents race conditions with vip_cntl updating the same table. To MGR adds the new job entries but vip_cntl completes the information in the table based on MGR JOBINFO messages.

The OUTPUT= statement is not always required. If the specific output client is indicated in the Output Manager controls file or Output Manager EM mapping rules, it is available. Otherwise, the job is sent with HOLDOUTPUT=YES.

The drive mappings are taken from the vip_cntl module. Resource paths are taken from either the OM_VIPFLEX or vip_cntl settings depending on how the job was initiated.

Output Manager profile optionsThe MGR/ENT processing of jobs allows the inclusion of Output Manager profile options from Output Manager EM files based on the printer name, job form name and job name. The To MGR module adds the contents of MODOPT files to the Output Manager profile being created for each job. These files, with a file type of MODOPT are stored in the same Output Manager EM search path as the MGR/ENT modifier files.

When MGR/ENT creates a Output Manager modifier for a job, the contents of the following MODOPT files, found within the modifier search path, are added to the Output Manager modifier being built for the job.

1. A file with a filename matching the printer/ vip_cntl name.

2. A file with a filename matching the Output Manager EM job form name.

3. A file with a filename matching the Output Manager EM job name.

The order in which the files are added follow the list above.



The files to be included are indicated on Output Manager profile/modifier lines that start with the following keyword:

.include_opt <filename>

Where filename is the name of a file with a file type of INCOPT, for example, if .include_opt MYJOB is included in a modifier file, and a file with the name MYJOB.INCOPT is in the Output Manager EM modifier search order path, the contents of MYJOB.INCOPT are added to the modifier for the job sent to Output Manager.

In addition, the filename used in the .include_opt line can have Output Manager EM token values. These are special keywords, starting and ending with “$”, that are replaced with the specified Output Manager EM job property to create the INCOPTfilename. For example:

.include_opt $UP0$_for_me

If the User Parameter 0 value for a job is Time_ticks this causes the contents of the file TIME_TICKS_FOR_ME.INCOPT to be included in the profile, or modifier, if the file exists.

If User Parameter 0 is not defined, the contents of the file _for_me.incopt, if it exists, is included.

The leading and trailing blanks of all substituted values are removed before being substituted into the filename. Embedded blanks in the value cause the substitution to stop at the first blank.

More than one token can be used to generate the filename. If a “$” is part of the filename, the sequence “$$” should be used. The “$$” is then converted to a single “$” in the final filename. With the exception of “$$” and “.”, no other non‐alphanumeric characters are allowed in the name.

The token parameters and Output Manager EM values used are as follows:

Token String Parameter Substituted

$JOBNAME$ Output Manager EM job name

$OUTPUT_NAME$ Output Manager EM output (printer/vip_cntl) name

$OUTPUT_DRIVER$ Output Manager EM output (printer/vip_cntl) driver value

$ORIGSYSID$ Originating system id

$USERID$ Output Manager EM job user id

$USERNAME$ Output Manager EM job user name

$ROOM$ Output Manager EM job room value

$ROOMLONG$ Output Manager EM job long room value

$CLASS$ Output Manager EM job class

$JOBFORM$ Output Manager EM job form

$JOBGROUP$ Output Manager EM job group

$JDL$ Output Manager EM report JDL

$JDE$ Output Manager EM report JDE

$OUTPUT_JDL$ Output Manager EM output (printer/vip_cntl) default JDL



To create a To MGR module, follow the procedure below:


2. Select Create.

3. From the resultant menu select TO MGR.

4. Open the System tab and complete the fields as previously described. For Output Manager Output Manager EM Printers the Module Type is TO MGR.



MGR Control The Output Manager Control module associated with the Output Manager machine you wish to access.

$OUTPUT _JDE$ Output Manager EM output (printer/vip_cntl) default JDE

$OUTPUT _FORM$ Output Manager EM output (printer/vip_cntl) default form

$FCB$ Output Manager EM report FCB

$OUTPUT _FCB$ Output Manager EM output (printer/vip_cntl) default FCB

$DDNAME$ Output Manager EM report DD name

$DESTID$ Output Manager EM report DEST id

$VIRTUAL_PRINTER$ Output Manager EM job virtual printer

$UP0$ Output Manager EM job user parameter 0


… …




Input Type The type of input used in Output Manager, the options are: Line or AFP, XRX, PCL, PS, VIPP, PDF, OfficeMail.

Input Client The name of the input client to be used in Output Manager.

Rip Type This only applies for PDF jobs. Specifies the type of PDF RIP used by Output Manager. The options are 0 (PDF RIP type 0) and 2 (PDF RIP type 2).



Refer to Appendix D: To VIP/MGR Example Configuration File for an example of a config file for this module and details of its parameters.

QM HelperThe QM_Helper acts as a background processor for the QM. When the QM determines it is time to run a AWS scan it sends a request to the QM_Helper, which checks the job queue to find work for the idle printers. If a candidate job is found a message is sent to the QM which then forwards a print request to the idle printer. Job retention scans are scheduled by the QM, which sends a message to initiate the scan by the QM_Helper. In addition, job and report deletion request from the GUIs are forwarded to the QM_Helper.

To create a QM Helper, follow the procedure below:


2. Select Create.

3. From the resultant menu select QM Helper. The Device Properties: <New> screen is displayed in the System tab; complete the fields as described in User interfaces. In this case the Module Type is QM_ Helper.





MGR MonitorOutput Manager Monitor tracks Output Manager jobs that have not yet been sent to Output Manager EM. This includes jobs pre‐processed on Output Manager as well as jobs following a normal Output Manager processing path not related to pre‐processing. These external jobs are identified to Output Manager EM by the lack of a VIPFLEX1 information field in the Output Manager job information record. The “external” job properties are drawn from the Output Manager job information record sent to vip_cntl when the Output Manager job is created.

To create a Output Manager Monitor, follow the procedure below:


2. Select Create.

3. From the resultant menu select Output Manager Monitor. The Device Properties: <New> screen is displayed in the System tab; complete the fields as described in User interfaces. In this case the Module Type is OM_VIP Monitor.





Refer to Appendix E: MGR Monitor Example Configuration File for an example of a config file for this module and details of its parameters.

MGR Control Select the Output Manager Control module to which you wish to associate this Monitor.

MGR Client Type in the name of Output Manager’s output client to be monitored.



Modifying the VIP_CTRL.cfg fileIn order for the Output Manager Monitor to work, the following parameters must be set in the VIP_CTRL.cfg, the first is mandatory and the remainder are optional:

MONITOREXTERNALJOBS

Specifies whether the associated Output Manager system is preprocessing jobs to be submitted to Output Manager EM that are to be monitored by creating external jobs on Output Manager EM. This is mandatory and must be set to Yes.

EXTERNALJOBRETENTIONPERIOD

The retention time for external jobs in hours; this can be set to override the retention period for external jobs. The default is the Output Manager EM default retention period set in FlexConfigure.

EXTERNALJOBEXCLUDE

Set up a filter for external jobs. If set, then Output Manager jobs with a matching VipFlex1 Output Manager profile option are not monitored. Multiple values are specified in multiple externalJobExclude statements. The default is to not exclude any Output Manager jobs if monitoring.

EXTERNALJOBALLOW

Sets up a filter for external jobs. If set, then only Output Manager jobs with a matching VipFlex1 Output Manager profile option are monitored. Multiple values are specified in multiple externalJobAllow statements. The default is to track all Output Manager jobs as external if monitorExternalJobs=yes.

Refer to Appendix C: VIP/MGR Control Example Configuration File for more information on the VIP_CTRL configuration file and parameters.

Modifying the default Output Manager EM Submission Client configuration file

To enable Output Manager jobs to be monitored in the Output Manager Profile to be used in the pre‐processing of the job on the Output Manager System must contain the following command:

POSTJOBCOMMAND=FSESCCL -tagJobid %JOBID -config <FSECE config> <Datastream>

Where:

POSTJOBCOMMAND Instigates the execution of the following command line once Output Manager processing of the job is complete.

FSESCCL The Submission Client required to submit the job to the Output Manager EM System.

‐tagJobid Specifies that the job ID on the Output Manager system is used as the job ID on the Output Manager EM system. This is specified as %JOBID, taken from the Output Manager job.

‐config Specifies that the following config file is to be used. This is <FSECE config>, the path and file name of the default Output Manager EM Submission Client (FSECE) configuration file, for example, C:\afp\VIPUP.



<Datastream> Specifies the path and file name of the datastream to be used, for example C:\AFP\STREAM.AFP.

Modifying the default Output Manager EM Submission Client configuration file

To enable Output Manager jobs to be monitored in the Output Manager EM User Interface the default Output Manager EM Submission Client (FSECE) configuration file must be modified to aid the transfer of the job from the Output Manager system to the Output Manager EM system. The following is an example of the configuration file:

# Default Output Manager EM Submission Client (FSESC) configuration file ## DO NOT MODIFY THESE VALUES #carrcntl ANSIchar1char2char3char4class Aclientname UNIXclienttype UXcompress NOcopies 1dest 10.50.30.13fcb form STD1formdef jobname MOREvippreprocessjobno jobprty 1language EBCDIClog YESnode UNIXpagedef prgname FSE-SCprmode PAGEprtid UNIXDTsysid UNIXtrc notagHost PB-TESTucs usracct 3576usraddr usrbldgusrdeptuseridusrroomverbose YESgroupdesc.

NOTE:

• The jobname parameter specifies the name the job is known by in Output Manager EM’s Job Queue Manager.

• The taghost parameter specifies the external host name to be associated with this job. This should match the external host name being used by VIP_CTRL.



Recognizing your modules1. From the FlexConfigure Administration menu, select Create FlexControl

Configuration. The Create/Modify flexcontrol dialog is displayed.

2. Select one of the following options:

3. Select Append or Overwrite.

4. Click OK.

Modifying Output Manager EM modulesTo modify an existing Output Manager EM module, follow the procedure below:

1. In Output Manager EM Modules, select the required module and do one of the following:

• Select Modify from the Edit menu

• Double‐click the required module.

• Right‐click the required module and select Modify.

This opens the Device Properties screen for the selected module.

Refer to the Creating Output Manager EM modules section for a description.


3. If you do not intend creating or modifying any more modules, select Close from the File menu to return to Install/Configure Output Manager EM.

Changing hostsUnder normal circumstances Output Manager EM is required to run on a server with a fixed IP address. Should the IT department require a change of this IP address, you need to stop Output Manager EM and run the following procedure to change the host:

1. Either select Change Host in the Edit menu, or

Right‐click within the work space and select Change Host from the resultant menu. This opens the Change Host dialog.

2. Select the current host in Old Host Name.

3. Type in the New Host Name.

4. Click OK.

If you have typed in an unknown host or misspelled a hostname a ChangeConfirmation dialog is displayed.

Append This preserves manual edits made to the ‘safe’ areas of flexcontrol.cfg. There are two ‘safe’ areas in this file:

From the start of the file, to the beginning of a list that starts with “#INITTAB ENTRIES”.

From the line starting “#SAFE_AREA_START” to the end of the file.

Overwrite This does a full refresh of flexcontrol.cfg.



Click Cancel.

5. A confirmation dialog is then displayed. Click OK.

The Machine column displays the selected host name.

Deleting Output Manager EM modulesTo delete an existing Output Manager EM module, follow the procedure below:

1. In Output Manager EM Modules select the required module and do one of the following:

• Select Delete from the Edit menu.

• Right‐click on the required module and select Modify from the resultant menu.

2. A confirmation dialog is then displayed. Click OK.


MANAGING USERS

Managing UsersThere are several security‐related aspects of Output Manager EM; one is that all users must have a valid user name and password. Each user can be given individual security rights that control their level of access.

The following are examples of access levels for different types of operators:

Print Operator Printer Device Control

Job Queue Manipulation Printer Page Browsing

Lead Operator The same as the Print Operator with the addition of Secure Operations, if secure class printing features are used. In this case the Lead Operator must enter their user name and password for each operation on those jobs.

System Administrators In addition to the above, Administration and System Configuration access, ensuring that changes at this level remain in the hands of those with the greatest knowledge of the Output Manager EM system.

In addition, read‐only access, that is, a username and password with no privileges, can be provided to users outside the print floor who would need to know the current status of jobs.

Creating a new userTo create a user, follow the procedure below:


2. Select User(s). This opens the Secure Operation window:


User Name Your user name on the Output Manager EM system.

Password The password associated with the user name.


MANAGING USERS

3. Click OK. This opens User Administration:

If you do not have authority to access User Administration, a message to this effect is displayed in Secure Operation. Click Cancel. User Administration does not open.

Note the information displayed in the table at the top of the window. The following information is displayed for all current users:

User ID The user ID.

User Name The name used to log on.

Last Login The last time the used id was used by a GUI to logon to FlexServer.

Password Changed When the password was last changed.

Expires When the password expires. If this is a date, it is the number of days in the Duration column, added to the date in the Password Changed column. If the password has expired, but the account has not been used since the expiry date, this column is set to On Next Logon.

Duration How long a password remains valid, once it has been reset. If 9999 is displayed, then the password is set to


MANAGING USERS

4. Type in the Full Name of the user. This information is displayed on this window only. Up to 120 characters are supported.

5. If necessary, enter a Comment. This information is displayed on this window only. Up to 255 characters are supported.

6. If GUI shows event viewer on startup, in the Enter Output Manager EM Valuespanel was set to User Select, then Show Event Viewer is enabled here. Select the required value from the following:

As per settings in Common.properties The Common.properties is checked for the key

START_EVENT_VIEWER_AT_START_UP. If it is found and set to YES then the event viewer is started as soon as GUI login completes.

Do not show on Startup The event viewer is not started. The setting in

Common.properties is ignored.

Show on Startup The event viewer is started. The setting in Common.properties is ignored.

7. If using LDAP select Use Network Password.

8. Select a value from the Password Duration pull‐down.

The Password Duration determines how long a password remains valid, once it has been reset.

This field depends on which kind of password is to be used:

• A normal password is the default. The options are:

Alternatively, the user can type in a number.; this is the duration that the password remains valid, in days.

The number of days a password remains valid, once it has been reset.

never expire and can be used indefinitely. To change the value in this column, see the Password Durationfield below.

Syntax This is set to Normal or Enhanced. Enhanced syntax allows the use of more complex passwords (for example, mixed case). See Enhance Password Syntax.

30 Days Expires 30 days after it is set.



Never Never expire.

Disabled Disabled and the user ID is locked so it cannot be used. To unlock the user ID, re‐select a password for this user.


MANAGING USERS

• An enhanced password is used if Enhanced Password Syntax was selected in the Enter Output Manager EM Values window. The Duration can only be decreased using this field. The options are:

• A network password is used if Use Network Password was selected in the previous step. The options are:

9. Type in a Distinguished Name. This is for use with LDAP only; this information must be provided by the LDAP System administrator. Generally, the Microsoft Active Directory Distinguished Name format requires the use of a common name (CN). For example, cn=John Smith,ou=piem,dc=tcl,dc=com.

Linux Servers more commonly use the userid (uid) in the distinguished named instead of CN. For example, uid=jsmith, ou=piem,dc=tcl,dc=com.

Refer to Appendix Y: SSL Support.

10. If the Output Manager EM user name matches the uid the authentication code automatically tries to add uid=username to the distinguished name to attempt authentication. For example, there are three Output Manager EM users with distinguished names, as shown below:

In this case, the same distinguished name, ou=piem,dc=tcl,dc=com can be used and the Output Manager EM adds uid=jsmith, uid=bjones or uid=fbrown to the distinguished name based on the user logging in.

The same is true for the common name (cn) used by Microsoft Active Directory. If the cn matches the Output Manager EM user id, then the cn can be left out of the distinguished name. However; if the common name, John Smith, contains a space it will not work because spaces are not supported in Output Manager EM user ids.

11. Depending on your site’s procedures, you may give each operator an individual user id and password or you may have a special user id/password(s) for anyone to use. Each GUI can access each printer, so an operator may use any active GUI

<nn> A range of 1 to 30 days can be selected. The password expires this number of days after it is set.

Disabled The password is disabled and the user ID is locked so it cannot be used. To unlock the user ID, re‐select a password for this user.

Network Set The Password rules and duration are set by the LDAP server

Disabled Disables the password duration and the user ID is locked so it cannot be used. To unlock the password, set the password duration to Network Set.

user name distinguished name

jsmith uid=jsmith,ou-piem,dc=tcl,dc=com

bjones uid=bjones,ou-piem,dc=tcl,dc=com

fbrown uid=fbrown,ou-piem,dc=tcl,dc=com


MANAGING USERS

to control a print job. Each user id has a set of privileges associated with them, select those required from the following:

Allow User Administration

Checking this option gives the user the facility to add/delete users and change passwords. It gives access to User Administration.

Allow Printer Page Browsing

Checking this option allows the user to browse reports.

Allow Printer Device Control

Checking this option gives the user the facility to control (print, pause, resume, etc.) printers.

Allow Secure Operations

Checking this option gives the user the facility to print jobs in secure classes.

Allow Job Queue Manipulation

Checking this option gives the user the facility to control; hold, release, delete, etc. jobs in the queue.

Allow Release Operations

If Advanced GUI Security has been selected (see Advanced GUI Security) checking this option allows the user to use the Release, Recheck, Reprocess and Output Manager Reprint commands.

If Advanced GUI Security has not been selected, this field is disabled. The user is allowed to use Release, Recheck, Reprocess and Output Manager Reprint regardless of the setting of this field.

Allow Delete Job/ Report

Checking this option allows the user to delete jobs and reports.

Auto‐Check Event Security

This field is ignored if Advanced GUI Security has not been selected (see Advanced GUI Security).

If this field is checked, the Security Authorization dialog is displayed only if the logged in user does not have the security privilege for the required operation.

If this field is NOT checked, the Security Authorization dialog is displayed each time the user requests any operation controlled by the “Allow” fields.

This is an additional security check and is expected to be used in environments where the operator leaves the GUI unattended while servicing the printer.

Allow Interrupted Job Deletion

Checking this option allows the user to delete jobs with a status of Interrupted.

Even if this field is checked, interrupted jobs can only be deleted after they have been in that state for a certain number of hours. This number of hours can be set by the user. See Interrupted Job State Wait Time (hrs).


MANAGING USERS

12. The User View Restrictions by Company field is used to determine the devices this user can access.

Allow Copy Job Checking this option allows the user to copy a job out of the Output Manager EM GUI.

In Enter Output Manager EM Values, you can use the Copy Confirmation Required field to display a confirmation dialog when the user attempts a copy. See Output Manager EM Installation.

If Advanced GUI Security has been selected (see Advanced GUI Security) then this option controls access to job splitting as well. In such a case, the user is only allowed to split jobs if Allow Copy Job is selected.

Allow Proc Hold Job Deletion

Checking this option allows the user to delete jobs with a status of Proc Hold.

Allow Backup Server Control

Checking this option allows the user to submit jobs to a backup server. See Backup Server.

Allow View System Log and Spool Space

If Advanced GUI Security has been selected (see Advanced GUI Security) checking this option allows the user to view the system log and spool space.

If Advanced GUI Security has NOT been selected, this field is disabled. The user can then perform these actions regardless of the setting of this field.

Allow Change Password

If Advanced GUI Security has been selected (see Advanced GUI Security) checking this option allows the user to change the password.


Allow Printer Assignment

If Advanced GUI Security has been selected (see Advanced GUI Security) checking this option allows the user to use change printer assignments.


Allow Locked Release This field applies when a job has a class in the Locked Classes list (see Locked Classes). In such a case, when the job completes its status is set to Completed Locked.

If Allow Locked Release has been checked for a user, this user is able to release a job with status Completed Locked for reprinting.

View Invisible Jobs Display jobs that are marked as not visible.

See Visible.


MANAGING USERS

Each device can be linked to a company name using the Company tab (see LPR driver for example). The User View Restrictions by Company field is used to link users to company names. When a user is linked to a company name, the user can access all the devices linked to that company.

There are three main options with this field:

• View All means the user is linked to all company names and therefore has access to all devices.

• View None means the user is linked to no company names, and therefore has access to no devices.

• A list of one or more Company names means the user can access all of the devices linked to all of the company names displayed.

To change this field, click the text box and see Company Filter Selection.

13. Click Add User. This opens the Change Password dialog:

14. The new user’s name is shown in the User Name field. Type in a New Password.

NOTE:

• Passwords expire after thirty days. Ten days prior to expiration, the user is prompted to change their password. After the thirty days, the user may still log in, but is forced to change their password.

• The passwords must be at least six alphanumeric characters in length and the last six passwords are kept and cannot be reused. Each user can change their own password, without being explicitly given User Administration privileges.

• If during login, the password is entered incorrectly three times, a security violation is assumed to have occurred and the account it locked. If this happens, the user’s password must be set to a new value before use. Passwords are stored encrypted; therefore, it is not possible to retrieve a password if it has been forgotten.

15. Confirm the password by typing it in the Verify field.

16. Password to be changed on next logon should be checked if you want to make the user type in a new password the next time they log on.

17. Password Duration determines how long a password remains valid, once it has been reset. See the main window section above for details of how to use this field.


MANAGING USERS

18. Click OK.

The new user is then displayed in the table at the top of the User Administrationscreen.

Passwords may be setup from the operator GUI (from the Administration menu on the main screen) or from the FlexConfigure utility (again, from the Administrationmenu).

Changing the Output Manager EM passwordTo change a password, follow the procedure below:

1. In User Administration select a user from the table at the top of the screen. The user’s name is displayed in the Settings for user field.

2. Click Password to open the Change Password dialog.

See the previous section for details of the fields in this window.

3. Make the required changes and click OK.

Editing usersTo edit a user’s settings follow the procedure below:

1. In User Administration select the required user from the table at the top of the screen. The user’s name is displayed in the Settings for user field.

2. Make the required amendments to the fields described in Creating a new user.

3. Click Apply.

Deleting usersTo delete a user follow the procedure below:

1. In User Administration select the user from the table at the top of the screen. The user’s name is displayed in the Settings for user field.

2. Click Delete. A Confirm Deletion dialog is displayed.

3. Click OK.

The user no longer appears in the table at the top of the screen.


MANAGING USERS

Company Filter SelectionTo display this window, click the text box for User View Restrictions by Company in User Administration. This window is used to determine the devices to which a user has access.

Each device can be linked to a company name using the Company tab (see LPR driverfor example). This window is used to link users to company names. When a user is linked to a company name, the user can access all the devices linked to that company.

To transfer a company from the View Jobs From panel to the Hide Jobs From panel, select it and click the right arrow.

To transfer a company from the Hide Jobs From panel to the View Jobs From panel, highlight it and click the left arrow.

Click All to link the user to all companies. This gives access to all devices.

Click None this button to link the user to no companies. This gives access to no devices.

Click OK to update User View Restrictions by Company with the data displayed in this window.


MANAGING RESOURCES

Managing ResourcesResources (such as fonts, forms etc.) can be stored in two different ways in a Output Manager EM based print system:

Normally, resources are stored on the server. They need to be loaded onto the server during installation and, as resources are updated, the versions on the server must also be updated. These resources are normally stored in the following directory:

There now exists a facility to store resources in a job based directory. This means that they are transferred with the job from the sending server, and are stored in the spooler on the receiving client or server. These resources can only be used for the specific job they relate to.

To implement job based resources, enter a $ sign in the Resource Path field. The job based resource should normally be at the top of the search order (search order 0).

The directory structure for storing resources need not be fixed, but following the guidelines below facilitate later updates. Each resource type should have its own directory. Resources of a given type may be collected in more than one directory if there is a logical separation between them, for example when each application has a different set of resources. Multiple directories are required if resources with the same named exist multiple times, but with different content.

Each printer has its own resource search path, consisting of the directories to search for a given named resource. Each printer could have the same directories in its search path, or different directories as in the case of printers with different resolutions.

Consider the following resource directory structure ‐

/ops/resources/default/afp/font Generic afp fonts/ops/resources/default/afp/over Generic afp overlays/ops/resources/default/afp/fdef Generic afp formdefs/ops/resources/default/afp/pdef Generic afp pagedefs/ops/resources/default/afp/pseg Generic afp pagesegs/ops/resources/default/line/fcb Generic line fcbs/ops/resources/default/xrx/fnt Generic Xerox fonts/ops/resources/default/xrx/frm Generic Xerox forms/ops/resources/default/xrx/lgo Generic Xerox logos/ops/resources/default/xrx/img Generic Xerox images/ops/resources/default/xrx/jdl Generic Xerox jdls/ops/resources/default/xrx/jsl Generic Xerox jsls/ops/resources/default/ps/font Generic PostScript fonts

NOTE: These are specific to the type of print stream and printer at the site. You do not need AFP resources in a Xerox only print site.

The above directories define the locations of fixed resources. More than one directory can be specified for each type. Additional directories structures can be set up for application or site dependent resources, such as:

/ops/resources/site/afp/font Fonts specific to the site/ops/resources/site/xrx/img Images specific to the site

Solaris/Linux /ops/resources

Windows c:\ops\resources


MANAGING RESOURCES

More than one directory can be created for each resource type. When a printer is used with Output Manager EM, a resource search path must be defined for that printer. Following the above structure, the search path should be set up to look for AFP fonts first in:

/ops/resources/site/afp/font

and then in:

/ops/resources/default/afp/font

Once the directory structure has been created, the directories must be populated with resources. If they are not already on a machine with a network connection, they should be loaded onto one. Then the resources copied or FTP’d (in binary format) to the server. During the population of the server, care should be taken to ensure similar case and naming conventions. AFP and line resources should be all upper case, with no extension; Xerox resources should also be upper case and have the following fixed extensions:

Forms .FRM

Logos .LGO

Images .IMG

Fonts .FNT

JDLs .JDL

PostScript font resources should be lower case and have extension .psf.

Since a job may be printed on many different printers, a non‐printer specific set of resource search paths, called Global Resources, must be defined at installation. Certain resources from each job received are identified and must exist in the Global Resources search path, if not the job is placed on resource hold. For AFP jobs, the pagedef and formdef are checked. For PostScript jobs, the fonts are checked (assuming certain formatting consistency). Typically the Global Resources are equivalent to, or are a superset of, resources for a given printer.

After a printer requiring print resources is defined, it must be given a resource search path to find these resources before it can be used. This can be done either in the Output Manager EM User Interface or in FlexConfigure’s Resources screen.

Refer to the Output Manager EM User Guide for information on defining print resources in the Output Manager EM User Interface.


MANAGING RESOURCES

Adding a new resourceTo add a new resource to the Output Manager EM system, follow the procedure below:


2. Select Resources. This opens Device Resources Display:

3. Select the required customer or Global Resources from the Customer drop‐down.

4. Select the require device from the Device drop‐down.

5. Select the type of resource from the Type drop‐down. This can be one of the following:

Type The type of resource you wish to add.

Overlays AFP forms.

Pagedefs AFP controls for formatting the printed page.

Formdefs AFP controls for processing physical sheets of paper.

Pagesegs AFP graphics and images.

Fonts AFP format fonts.

Fcbs Forms Control Buffer.

Image (Xerox) Xerox format images.

Logo (Xerox) Xerox format logos.

Font (Xerox) Xerox format fonts.

JDL (Xerox) Xerox Job Descriptor Library.

FORM (Xerox) Xerox format forms.

Font (PS) PostScript fonts.

Modifier Output Manager Job Profile Modifiers.


MANAGING RESOURCES

6. Click Add New. This opens the Specify New Resources Directory dialog:

The Customer Name, Device Name and Resource Type specified in steps #3 through #5 are displayed as the first three fields in the dialog.

7. Select the Search Order, the default is the number of resources already defined plus one. For example, if you had defined 3 resources, the default would be 4.

NOTE: If you have already defined a number of resources, for instance five and you were adding a further resource, its default Search Order would be 6. If you specified a Search Order of 3, the new resource would be entered as 3, moving all resources with an order higher than 3 up one. That is, the previous #3 would become 4, 4 would become 5, etc.

8. Either type in the Resource Directory path or click Browse to select one.

NOTE: If this is a job‐based resource, enter $ in Resource Directory. This causes the software to look in the job directory of each job for resources.

9. Click OK.

10. The new resource is displayed in the table.

VIPOPT/SETOPT The vipopt and setopt files that om_vip can add to a Output Manager profile and set file.


MANAGING RESOURCES

Editing resourcesTo edit an existing resource, follow the procedure below:

1. In Device Resources Display select the required resource.

2. Either click Edit or double‐click on the required resource. This opens the Edit Resources Directory dialog.

3. Make the required amendments.

4. Click OK.

Deleting resourcesTo delete a resource follow the procedure below:

1. In Device Resources Display select the required resource.

2. Click Delete.

The resource no longer appears in the table at the top of the screen.

Adding a new restricted resourceJob based resources are transferred with a job from a server to another server or a client. In some cases, a resource is only licensed for use on one particular machine or site. In such a case, the resource should be configured as a restricted resource. This means that it cannot be transferred to a server or client as a job based resource. If an attempt it made to do this, the transfer does not take place and an error message is written to the job log.

To configure a restricted resource, do the following:


2. Select Restricted Resources. This opens the Restricted Resources Display.

3. Select one of the options for Device:

4. Click Add New. This opens the Specify New Resources Directory dialog:

5. Either type in the Resource Directory path or click Browse to select one and click OK.

6. Click Refresh to refresh the display. Click Close to close the window.

Common Paths Prevent transfer to all other servers.

<Server name> Prevent transfer to this server only.


MANAGING RESOURCES

Deleting restricted resourcesTo delete a restricted resource (i.e. allow the resource to be used as a job‐based resource) do the following:


2. Select Restricted Resources. This opens the Restricted Resources Display.

3. Select one of the options for Device:

4. Click the Resource and then click Delete.

5. Click Refresh to refresh the display. Click Close to close the window.

Common Paths Prevent transfer to all other servers.

<Server name> Prevent transfer to this server only.


COPYING RESOURCE PATHS

Copying Resource PathsWhen defining new devices, or new customers, it is very time consuming to enter the path to the resources manually each time. A new tool has therefore been created to allow copying of resource paths between customers and devices.

To display this tool:


2. Select Clone Resource Paths to display the Resource Path Cloning Utility:

DefinitionsTo use the Resource Path Cloning Utility, you need to understand the following definitions:

Global/Global

Client/customer (first item) is ʺGlobalʺ, meaning all not otherwise specifically and explicitly defined. Module/Device (second item) is also ʺGlobalʺ meaning it applies to and is used by the Checker.

Client/Global

Client/customer is ʺClientʺ, meaning that a specific customer/client/logical DT is selected by the user. Module/device is ʺGlobalʺ meaning it applies to and is used by the Checker. This combination can be the source or the target of the operation.

Client/Device

Client/customer is ʺClientʺ, meaning that a specific customer/client/logical DT is selected by the user. Module/device is ʺDeviceʺ meaning that the user selects a specific device defined to FlexConfigure to copy/clone resource paths during the operation. This combination can be the source or the target of the operation.


COPYING RESOURCE PATHS

Client/All Devices

Client/customer is ʺClientʺ, meaning that a specific customer/client/logical DT is selected by the user. Module/Device is ʺAll Devicesʺ meaning that all devices defined in FlexConfigure for the specific customer/client/logical DT selected has all applicable resource paths copied/cloned during the operation to the target selection. This combination can be the source or the target of the operation.

Global/Device

Client/customer is ʺGlobalʺ, meaning all not otherwise specifically and explicitly defined. Module/Device is ʺDeviceʺ meaning that a particular device/module, for example, ops_mod_id, is selected indicating the target to which the resource path definitions are copied/cloned during the operation.

Global/All Devices

Client/customer is ʺGlobalʺ, meaning all not otherwise specifically and explicitly defined. Module/Device is ʺAll Devicesʺ meaning that all devices/modules, for example, ops_mod_ids, is selected indicating the target to which the resource path definitions are copied/cloned during the operation.

Resource Path Cloning Utility tabsThe Resource Path Cloning Utility has the following tabs, they are very similar in appearance and the options on each describe their function.

Global/Global to Global/Device

Global/Global to Global/All Devices

Global/Global to Client/Global

Client/Global to Client/Global

Client/Global to Client/Device

Client/Global to Client/All Devices

Client/Device to Client/Device

Client/All Devices to Client/All Devices

Settings ‐ if you select Delete any TARGET rows before new rows are created when any paths are copied, the old path is deleted before the new one is created.

If a resource is already defined for a target, for example, target device, a database error occurs when the system attempts to insert the same resource into the it.

Select the required options on each tab and click Apply.


MANAGING FORMS


Managing FormsThe term form denotes the type of paper loaded into the printer; this could be fanfold or Letter and must be defined in FlexConfigure to ensure it is recognized by your Output Manager EM system.

Adding a formTo add a form to a printer, follow the procedure below:


2. Select Forms Management to open the Forms Management window:

Forms already associated with the printer are shown in the Form Name table.

3. Select the Printer Type that the form is to be associated with, the options are the printers installed on your Output Manager EM system.

4. Click Add Form, this opens the Add Form dialog.

5. Type in the Form Name and click OK.

The new form is displayed in the Form Name table.

Deleting a formTo delete a form from a printer follow the procedure below:

1. In Forms Management select the required Printer Type, for example, Page Driver:

2. Select the form to be deleted.

3. Click Delete Form.

4. A warning is displayed click OK to confirm deletion.

The Form Name is removed from the Forms Management window.

MANAGING THE LPR QUEUE


Managing the LPR QueueLine Printer Remote or LPR is a queue on or for a remote printer or device.

Line Printer Remote or LPR is a printer protocol that uses TCP/IP to establish connections between printers and workstations on a network. The technology was developed originally for BSD UNIX and has since become the de facto cross‐platform printing protocol.

The Line Printer Daemon or LPD software typically is stored in the printer or print server and the LPR software must be installed in the client device. The LPR client sends the print request to the IP address of the LPD printer/server, which in turn queues the file and prints it when the printer becomes available.

Adding an LPR QueueTo add an LPR Queue to a printer, follow the procedure below:


2. Select LPR Queue Management; this opens the LPR Queue Manager window:

Queues already associated with the printer are listed in the Queue Name table.

3. Select the required Printer Type, the options are: LPR Driver, DocuTech, External Docutech.

4. Click Add Queue to open the Add Queue dialog.

5. Type in the Queue Name and click OK.

The queue is shown in the Queue Name table.

Deleting an LPR QueueTo delete an LPR Queue from a printer, follow the procedure below:

1. In LPR Queue Manager select the required Printer Type.

2. Select the Queue Name to be deleted.

3. Click Delete Queue. A warning is displayed.

4. Click OK to confirm deletion.

The Queue Name is removed from the LPR Queue Management window.

CREATING MAPPING RULES

Creating Mapping RulesThe Mapping Rules component of Output Manager EM looks at every job on receipt to determine whether any of its print parameters should be changed. For example, the form of all class C jobs could be set to F2UP, where the rule is set to look for class C jobs and replace the form in the submission parameters with F2UP.

Other uses would be to assign a JDL/JDE to a job received from MVS where those parameters do not exist.

Other uses would be to assign a starting Xerox JDL/JDE to a job received from an MVS host platform where there is no applicable JCL output parameter available to specify these values prior to submission to Output Manager EM.

Mapping rules can also be run manually on a job after it is loaded into Output Manager EM. This can be useful when a job is transmitted to Output Manager EM and no rules are applied to the job because of mismatched rule conditions or the lack of any applicable rules for the job. The mapping rules can be updated or created via FlexConfigure (as described below) and then the Mapping Rule program may be executed by selecting the Reprocess operation from the Job Queue Manager window for the selected job.

NOTE: If a job is received into Output Manager EM and one or more incomplete or incorrectly entered mapping rules is applied to the job upon initial receipt, the submission parameter values stored in the Output Manager EM database may be altered from the original submission values. Correcting the applicable mapping rules and running Reprocess from the Job Queue Manager may or may not produce the desired results as match criteria for one or many mapping rules may no longer produce a match as the values may have been changed during the first execution of the Mapping Rule program.

Mapping rule orderMapping Rules are executed in the order they display in the mapping rules table in FlexConfigure; in effect this is alphanumeric order.

If in either the General or Logical CPU two rules update the same property, for example, test CLASS and change JDE then test FORM and change JDE, the last change is the one that is effective.

If a rule changes a value that is a test for a later rule, the later rule applies the test to the original value. The exception is that a value changed in a General rule applies for tests in a Logical CPU rule because the read table is updated at the end of general rules.

If a job is reprocessed, the job properties read into memory are those from AFTER the original run of Mapping Rules when the job was submitted NOT the job properties at submission time. This may mean that some tests do not trigger on a reprocess.

When a Rule is processed, the conditions are tested in sequence order. Once a condition fails, no further conditions are tested and the next rule is examined. An action can either be linked to specific conditions or held until all conditions are tested, for example:



Test 1: Action 1Test 2: Action 2

Is different from:

Test 1: No ActionTest 2: Action 1No test: Action 2

In the first case, failure of Test 2 after Test 1 passed still applies Action 1. In the second case both tests have to be passed for any action to be applied.

The Mapping Rules are processed as follows:

1. The job properties are read into memory as an original and a copy.

2. The general rules are applied by testing the original and writing to the copy.

3. After all general rules have been tested; the original in memory is updated with the value in the copy.

4. The Logical CPU rules pertaining to the source value in the original in memory are applied by testing the original in memory and writing to the copy.

5. After all Logical CPU rules have been tested, the values in the copy are written to the database.

The Mapping Rules screenTo open the Mapping Rules screen:


2. Select Mapping Rules. This opens the Mapping Rules screen:

The Mapping Rules screen has the following menus:



File This menu has only one option, Close, allowing you to close the screen.

Edit Contains all the options for creating, editing, copying, moving and deleting rules. These are discussed later in this section.

View Contains the following options:

List All Lists all the mapping rules defined on the Output Manager EM system.

Refresh Listed Searches the system for all rules and refreshes the display.

Exclude From List Excludes the rules select in the Rules table from the list. Selecting the option for a specific rule means that the rule is no longer displayed in the table. Excluded rules may be added to the table by selecting List All.

Select All Selects all the rules in the table.

Utilities Contains the following options enabling you to share mapping rules between multiple Output Manager EM sites. Backup and restore mapping rules at your current site, respectively.

Export Listed Rules Produces a comma‐delimited text file containing only the currently listed mapping rules (based upon applicable search criteria or rules that have been excluded from the display).

Import From File Import rules from a comma‐delimited text file previously created using the Export Listed Rules option.

Backup All Backup all the mapping rules on the current Output Manager EM server to a comma‐delimited text file on disk or other media.

Restore All Restores the mapping rules from a comma‐delimited file created using the Backup All option to the current server.



NOTE: The Backup operation does not resolve the numeric Output Manager EM Client ID value(s) stored in the Output Manager EM database to the alphanumeric Client Name as shown in the Client Name list. Therefore, care should be taken if the rules text backup file created is to be restored onto a different Output Manager EM system as the numeric Client ID values may not be the same for corresponding Client Names on the Output Manager EM system where the restore operation is attempted. The backup file may be edited prior to the restore operation on the receiving Output Manager EM system to correctly associate the Output Manager EM Client ID values to the proper Client Name(s) if required. A Client ID value of 0 (zero) is used to indicate <GENERAL> rules.

The format of the file created for the Backup operation is comma‐delimited as follows:

<client-id>,<rule-name>,<seq-nbr>,<match-col>,<match-val>,<repl-col>,<repl-val>

The Export operation resolves the Client ID value stored in the Output Manager EM database to the alphanumeric Client Name as the Export and Import operations were intended to be used for moving Mapping Rules from one Output Manager EM site to another. The only restriction is that the Client Name must be consistent on both Output Manager EM sites for the Import operation to be successful on the receiving Output Manager EM site.

The format of the file created for the Export operation is comma‐delimited as follows:

<client-name>,<rule-name>,<seq-nbr>,<match-col>,<match-val>,<repl-col>,<repl-val>

The Mapping Rules window consists of the following areas:

Rules A list of the rules on the Output Manager EM system. These are listed by Client name and Rule Name in ascending order based upon the binary value of each ASCII string value (in the ASCII encoding scheme, 0 – 9 is lower than A – Z which is lower than a – z.).

Conditions / Replacements List

A list of conditions for the selected Rule.

Search This area, in the top right portion of the screen allows you to search the system for Clients, Rules and Conditions. This is discussed later in this section.

Creating a ruleTo add a new mapping rule to the Output Manager EM system follow the procedure below:

1. From the Edit menu select Insert Rule, this opens the Specify New Rule dialog.

2. Select the Client Name from the drop‐down.

Selecting <GENERAL> applies the rule to all clients.

3. Type in a Rule Name.



We recommend that you give your rules meaningful names reflecting their functions so that they can be easily recognized. The Rule Name is for reference only.

4. Click OK.

The new Mapping Rule is displayed in the Rules table in the top left of the screen.

Now that you have created your rule, you need to add conditions to it:

Creating a conditionYou can add as many conditions to your Mapping Rules as desired. Conditions are listed in the Conditions / Replacements List in the bottom portion of the screen.

To view the conditions for a Rule, select the Rule from the table to display the conditions in the Conditions / Replacements List.

To create a condition, follow the procedure below:

1. Select the required Rule from the Rules table.

2. From the Edit menu select Insert Condition. This opens the Specify Values for New Condition dialog:


Specify Sequence Number

The order in which the conditions are to be met. For example, if your rule has only one condition, the Sequence Number would be 1. If your rule has more than one condition, you can prioritize them.

The drop‐down for this option only shows the sequence numbers available for the created conditions. For example, if you have three conditions and are creating a fourth the sequence numbers are 1 to 4. Should you select 1, the other conditions are re‐prioritized as 2 to 4.

Match Column The selection in this drop‐down list box can be:

The column from the Output Manager EM database that the Rule is to match against using the value entered in the Match Value text entry field, or

Leave blank to indicate that condition checking should continue with the next higher condition number in the current mapping rule.

Any entries in the Replace Column/Value fields are unconditionally applied if the Match Column/Value fields



are left blank. If the Match Column/Value entries are populated, Replace Column/Value entries are applied up to the first non‐matching Match Column/Value entry in any given mapping rule. The

NOTE: Refer to for Appendix V: Match Column Options for details of those that can be set.

Match Value The text entry field which can be either:

Set to an alphanumeric or numeric value (depending on the selection in the Match Column drop‐down selection list) that should be used as the match criteria when looking at the print job’s attributes in the Output Manager EM database, or

Left blank (provided Match Column is also blank) to indicate that condition checking should continue with the next higher condition number in the current rule.

This text entry field allows up to 255 characters to be entered, however, only a portion of the characters entered are used to perform a match based upon the size of the database field selected in the Match Column selection list.

Any entries in the Replace Column/Value fields are unconditionally applied if the Match Column/Value fields are left blank. If the Match Column/Value entries are populated, Replace Column/Value entries are applied up to the first non‐matching Match Column/Value entry in any given rule.

Replace Column A drop‐down selection list which can be either:

Set to one of the fields in the Output Manager EM database to be modified by the Mapping Rule.

Left blank (provided that Replace Value is also left blank) to indicate that condition checking should continue with the next higher condition sequence number in the current Mapping Rule and that no Output Manager EM database modifications are to occur. That is it unpopulated values for Replace Column/Value fields forms a logical ’AND‘ between pairs of Mapping Rule condition sequences.)

Any entries in the Replace Column/Value fields are unconditionally applied if the Match Column/Value fields are left blank. If the Match Column/Value entries are populated, Replace Column/Value entries are applied up to the first non‐matching Match Column/Value entry in any given rule.

Replace Value An editable text entry drop‐down selection list which can be either:



Set to one of the fields in the Output Manager EM database from which to obtain the data to be entered into the database field specified in the Replace Column selection list, for example, if you wish to populate User Parameter 1 with the current contents of the JobName field, or if you wish to set the value of the Virtual Printer to the current value of the Destination ID.

Can be set to any alphanumeric or numeric value, as applicable, based upon the selection in the Replace Column selection list.

This text entry field allows up to 255 characters to be entered, however, only a portion of the characters entered are used to update the Output Manager EM database based upon the size of the database field selected in the Replace Column selection list.

3. Click OK.

The new condition is displayed in the Conditions / Replacements List for the Rule.

Editing a ruleTo edit an existing mapping rule follow the procedure below:


2. Either:

• Select Edit Rule from the Edit menu, or

• Double‐click the required rule to open the Edit Rule dialog:

3. Make the required changes to either the Client Name or Rule Name.

4. Click OK.

You may also need to edit the conditions associated with your rule.

Editing a conditionTo edit an existing condition follow the procedure below:


2. Select the required condition from the Conditions/Replacements List.

3. Either:

Select Edit Condition from the Edit menu, or

Double‐click the required rule to open the Edit Condition dialog.

4. Edit the required fields. These are described in Creating a condition section.

5. Click OK.

Copying a conditionThe copy facility allows you to copy a condition from one rule to another. To do this, follow the procedure below:

1. Select the Rule containing the condition to be copied from the Rules table.




3. Select Copy Condition from the Edit menu.

4. Select the Rule to copy the condition to from the Rules table.

The new condition is displayed in the Conditions/Replacements List for the Rule.

If you need to copy more than one condition, follow the procedure above but in step 2 select the first condition and press <Ctrl> while selecting the other required conditions. Then continue on to step 3.

Deleting a conditionTo delete an existing condition follow the procedure below:

1. Select the Rule containing the condition to be deleted from the Rules table.


3. Select Delete Condition from the Edit menu.

4. A warning is displayed; click OK to confirn deletion.

If you need to delete more than one condition, follow the procedure above, but in step 2 select the first condition and press <Ctrl> while selecting the other required conditions. Then continue on to step 3.

Copying a ruleTo copy an existing mapping rule follow the procedure below:


2. Select Copy Rule from the Edit menu, this opens the Edit Rule dialog.

3. Select the Client Name to which the rule is to be copied.

4. If required, edit the Rule Name.

5. Click OK.

The copied rule is displayed in the Rules table.

Copying all rulesTo copy all rules from one client to another follow the procedure below:

1. Select a Rule listed for the required client from the Rules table.

2. Select Copy All Rules To from the Edit menu.

3. From the resultant sub‐menu, select the client to which the rules are copied.

The copied rules are displayed in the Rules table.

Moving all rulesTo move all rules from one client to another follow the procedure below:




2. Select Move All Rules To from the Edit menu.

3. From the resultant submenu, select the client to which the rules are moved.

The copied rules are displayed in the Rules table with the new client name, these have replaced the rules for the original client, which are not displayed and no longer exist.

Deleting a ruleTo delete a rule follow the procedure below:


2. Select Delete Rules from the Edit menu. This opens a warning dialog.

3. Click OK.

The deleted rule is no longer available in the Rules table.

Deleting all rulesTo delete all rules from one client follow the procedure below:


2. Select Delete All Rules from… from the Edit menu.

3. From the resultant submenu, select the client from which the rules are to be deleted. This opens a warning dialog.

4. Click OK.

The deleted rules are no longer available in the Rules table.

SearchingThe search facility of the Mapping Rules screen allows you to search the Output Manager EM system for Client rules and conditions. To do this, enter your criteria in the boxes, making appropriate selections from the drop‐downs and click Search. The results of your query are displayed in the Rules table and Conditions / Replacements List.



The search facility of Mapping Rules has the following fields:

NOTE: The search criteria are case sensitive.

How the Mapping Rules program is executedThe Output Manager EM Mapping Rule utility (maprule) is usually executed after receipt of a print job into the Output Manager EM Spool and prior to the print file being checked by the Output Manager EM Checker (chkr). The sequence of tasks that occur after a print file in received into the Output Manager EM spool are controlled by the contents of the ir_process.sh file which is usually stored in $ROOT/scripts/oracle on the Output Manager EM platform. The ir_process.sh file is read by the Output Manager EM Resource Manager (RESMGR).

The content of an example ir_process.sh file is shown below:

#!/usr/bin/ksh#=:(################################################################ MODULE: ir_process.sh## AUTHOR:## DATE:## DESCRIPTION: Called from the IR, this script runs IR_CHKR## NOTES:#################################################################### (C) COPYRIGHT PB SOFTWARE 2004. ALL RIGHTS RESERVED.## THIS SOFTWARE IS THE PROPERTY OF PB SOFTWARE. REPRODUCTION OR

Client Name Selecting a Client Name displays all the rules for that client.

Rule Name Specifying the full Rule Name displays all the rules with that name.

Check to wildcard Rule Name

Select this option to enable searches for partial rule names. For example, if you entered A* all the rules with names beginning with ‘A’ are displayed in the Rules table.

Rule ChecksThe Condition

Select the required condition from the drop‐down and in the = box, specify the string the condition is set to. In conjunction with the Rule Checks The Replacement option, this works as a search and replace function.

And Checks The Replacement

Select the required condition from the drop‐down and in the = box, specify the string to replace the once specified in the Rule Checks The Condition box.

Search Click Search to display rules matching your specified criteria. If you click Search when no values have been entered all the rules on the system are displayed in the Rules table.



# OTHER USE OF THIS PROGRAM AND ITS DOCUMENTATION BY ELECTRONIC, # MECHANICAL, PHOTOGRAPHIC, OR ANY OTHER MEANS, IS STRICTLY # PROHIBITED, UNLESS AUTHORIZED IN WRITING BY PB SOFTWARE.################################################################### MODIFICATION HISTORY:## VERSDATEAUTHORCHANGE#################################################################### ModuleID: = “%Z% %M% %I% %E% %Q%#=:(##############################################################maprule $*chkr $*#12/13/02 –jl- no index-gen is default# index-gen $*~

In this example, the maprule program is executed followed by the chkr program. The index_gen utility is commented out by using “#” in the first position of the line in the file. The “$*” value indicates the end of the static command arguments for that particular line, after which the Output Manager EM Resource Manager can add dynamic arguments, for example, “ -job <job-id>”.

The Resource Manager program reads the ir_process.sh file when it is started. While running, it receives messages from the Queue Manager (qm) to perform tasks when:

A job enters the Output Manager EM Spool via the Input Receiver (ir).

A user/operator requests an operation, for example, Recheck, Reprocess, to be performed on a job or set of jobs from within the Output Manager EM GUI.

Based upon receipt of these messages from the Queue Manager, the Resource Manager queues and manages the execution of these tasks in an orderly fashion such that the Output Manager EM machine CPU(s) is not flooded with work to be performed at any given point in time.

The Mapping Rules program is usually coded to execute in ir_process.sh prior to executing the Checker. This is to allow for the setting of job and/or report specific printing parameters that may or may not be established by the sending data transmission (DT) client, which are required to accurately perform resource scanning/discovery and to develop a reasonable estimate of page and side counts when the Checker executes. Examples of print settings that impact how the Checker analyses each print file include, but are not limited to:

Xerox JDL

Xerox JDE

AFP Page Definition

AFP Form Definition

Form Control Buffer

Carriage control type, for example, ANSI, Machine, ASCII, None.

Print Mode, for example, PAGE, LINE, MIXED, META, LCDS, PS, PCL, VIPP.



How the Mapping Rules program worksThe following is a brief description of how the Mapping Rule program works:

1. Are there any Mapping Rules stored on the Output Manager EM Mapping Rule table? If YES, continue. If NO, then EXIT.

2. Obtain a list of Reports that are contained within the Job specified on the command line. For each Report, perform the following tasks.

3. Load all database values from the Job, Report and POD tables that could be altered by a Mapping Rule into Job, Report and POD ‘Original’, ‘Master’ and ‘Working’ memory structures for the current Report.

4. Set the Rule Type to ‘General’ (a Client ID value of zero ‐ 0).

5. Load all unique Mapping Rules Names stored on the Mapping Rule Table into memory in Name ascending order based upon the current Rule Type.

6. Load all associated Mapping Rule Conditions including the Condition Sequence Number, Match Column, Match Value, Replace Column and Replace Value settings into memory in Mapping Rule Name order followed by Condition Sequence Number order.

7. Process Rule Conditions in Rule Condition Sequence Number order for each Mapping Rule.

a. Does the Match Value equal the value loaded in the ‘Master’ copy of the Job, Report or POD structures stored in memory based upon the Match Column selected? If YES, continue. If NO, proceed to the first Rule Condition of the next Mapping Rule and go to step #7a.

b. Are there values stored in memory for the Replace Column and Replace Value for the current Rule Condition? If YES, continue. If NO, proceed to the next Rule Condition in the current (or next) Mapping Rule and go to step #7a.

c. Does the Replace Value entry refer to a Job, Report or POD column variable? If YES, continue. If NO, proceed to step #7e.

d. Obtain the current value referenced by the Replace Value entry from the ‘Master’ copy of the Job, Report or POD memory structure. Place this value in a temporary variable.

e. Copy the Replace Value to a temporary variable.

f. Copy the value stored in the temporary variable to the ‘Working’ copy of the Job, Report or POD variable as appropriate.

g. Are there more Rule Conditions? If YES, continue. If NO, go to step #8.

h. Proceed to the next Rule Condition in the current, or next, Mapping Rule and go to step #7a.

8. When all Rule Conditions for the current Rule Type have been processed, apply any changes that were made to the ‘Working’ Job, Report and POD memory structures to the ‘Master’ Job, Report and POD memory structures, respectively.

9. Is the current Rule Type ‘General’? If YES, continue. If NO, go to step #12.

10. Set the Rule Type to the Client ID currently stored in the ‘Master’ memory structures for client‐specific rules processing.

11. Go to step #6.

12. Are the ‘Master’ and ‘Original’ memory structures different? If YES, continue. If NO, then EXIT.

13. Apply the values currently stored in the ‘Master’ Job, Report and POD memory structures to the Output Manager EM Job, Report and POD database tables, respectively, by using an SQL UPDATE operation.



14. Are there more Reports in the Job? If YES, go to step #3. If NO, then EXIT.

Mapping Rule hintsNOTE: It is strongly recommend that:

• If a job has a PRMODE (Print Mode) of OFMA, it is not changed to another PRMODE.

This prevents the OfficeMail files being transmitted to the print processor.

• If a job has a PRMODE other than OFMA, is it NOT changed to OFMA.

This causes an error at print time.

When you are creating new Mapping Rules, keep in mind that the rules are processed in Rule Name sequence order as each is tested for applicability. There is the possibility that multiple rules can be applicable to the same Job/Report. For example, the first rule processed (General or Client Name‐specific) might check for a Job Form value of STD and change the Job Class value to X. A subsequent rule may check for Job Name equal to TESTJOB and change the Job Class to Y. At the end of phase processing, the Job Class would be set to Y as the last rule that is applied takes precedence when determining what values are written back into the Output Manager EM database.

The set of Client Name‐specific rules that are chosen are determined based on the value of the Client ID (Source) for the job/report at the time when client specific processing in the second phase begins in the Mapping Rules utility. Therefore, a General Rule could change the Source of a particular job/report in the first phase of processing that would alter which Client Name‐specific rules are used when performing second phase processing.

All rules defined as General are processed in the first phase and all rules selected for the applicable Client Name are processed in the second phase. However, not all Rule Conditions within a particular Mapping Rule may be applied as the logic processes each Rule Condition until a Match Column and Match Value pair are evaluated as ‘not equal’ to the appropriate values under comparison in the ‘Master’ Job, Report or POD memory structures. When a ‘not equal’ condition occurs, processing continues with the first Rule Condition in the next available Mapping Rule.

It is not mandatory to populate the Match Column, Match Value, Replace Column and Replace Value fields for a particular Rule Condition.

When the Match Column and Match Value selections are left blank, processing continues without performing a comparison test against the ‘Master’ Job, Report or POD memory structures. In this scenario, if Replace Column and Replace Value selections are defined, the changes are applied to the ‘Working’ Job, Report and POD memory structures without performing a comparison test. Blank Match Column and Match Value selections are treated as a logical ‘Continue’ operation.

When the Match Column and Match Value selections are populated and the Replace Column and Replace Values selections are left blank, the comparison test are performed though no updates are applied to the ‘Working’ Job, Report or POD memory structures. This allows the formation of logical ‘AND’ chains on Match Column/Match Value specifications between multiple Rule Conditions.



Example 1:

These rule conditions are logically performed as:

IF (CLASS=‘A’) AND (FORM=‘STD’) AND (SOURCE=‘MVSA’)THEN (set JDL=’DFAULT’, JDE=’DFLT’ and PRMODE=’META’)ELSE go to next Mapping Rule

Example 2:

These rule conditions are logically performed as:

IF (CLASS == ‘A’) THEN (set JDL=’DFAULT’)ELSE go to next Mapping RuleIF (FORM == ‘STD’) THEN (set JDE=’DFLT’) ELSE go to next Mapping RuleIF (SOURCE == ‘MVSA’) THEN (set PRMODE=’META’) ELSE go to next Mapping Rule

The values populated in the Rule Conditions in the above examples are similar but the behavior and results are VERY different.

In the first example, all of the Match Column/Value conditions must evaluate to TRUE before any of the changes established in the Replace Column/Value fields is applied to the ‘Working’ memory structures. In addition, once all of the conditions are evaluated and found to match successfully, all of the ReplaceColumn/Value settings are performed without any further comparison testing.

In the second example, the only way that all of the replacement actions would occur is if the Job/Report being evaluated matched ALL of the match criteria. If a Job/Report being evaluated had a Class value of A, a Form value of XYZ and a Source value of MVSA, then only the JDL setting of DFAULT would be applied to the ‘Working’ memory structures. The JDE and PR Mode replacement actions would not be applied.

Rule Name No. Match Column

Match Value Replace Column

Replace Value

EX01 1 Class A

EX01 2 Form STD

EX01 3 Source MVSA JDL DFAULT

EX01 4 JDE DFLT

EX01 5 PR Mode META



Replace Value

EX02 1 Class A JDL DFAULT

EX02 2 Form STD JDE DFLT

EX02 3 Source MVSA PR Mode META



Logical OR conditions between multiple Match Column/Value selections requires the creation of multiple Mapping Rules. For example, to achieve the desired results for the following condition statement requires the rule setup displayed in the example:

IF (((CLASS=‘A’) OR (CLASS=‘D’) OR (CLASS=‘T’)) AND (FORM=‘STD’) AND (SOURCE=‘MVSA’))THEN (set JDL=’DFAULT’, JDE=’DFLT’, PRMODE=’META’)ELSE go to next Mapping Rule

Example 3:

The Output Manager EM Checker sets the retention time for each Job received into the Output Manager EM Spool based upon settings on the Output Manager EM Retention Time table (t_oprt_time). Entries on this table control the initial retention time setting based upon configured combinations of Form and Class. The default setting is coded as 72 hours (3 days). If Mapping Rules are to be used to alter the Retention Time for a particular group of Jobs, and this can not be achieved by entering values on the Retention Time table, that is, based upon criteria other than Form and Class, then the maprule program may be executed again in ir_process.sh after chkr to achieve the desired result. In this situation, however, extreme care should be exercised when formulating Mapping Rules as some rules may apply the second time the maprule program is executed which did not apply the first time maprule was executed.

The Output Manager EM Checker may alter the Print Mode (PRMODE) value for certain types of jobs. In particular, LINE mode jobs that are submitted to Output Manager EM that utilize an AFP Form Definition or AFP Page Definition are



Replace Value

EX03a 1 Class A

EX03a 2 Form STD

EX03a 3 Source MVSA JDL DFAULT

EX03a 4 JDE DFLT

EX03a 5 PR Mode META

EX03b 1 Class D

EX03b 2 Form STD

EX03b 3 Source MVSA JDL DFAULT

EX03b 4 JDE DFLT

EX03b 5 PR Mode META

EX03c 1 Class T

EX03c 2 Form STD

EX03c 3 Source MVSA JDL DFAULT

EX03c 4 JDE DFLT

EX03c 5 PR Mode META



automatically switched to MIXED. Print files which are submitted to Output Manager EM as PAGE while also containing line data (other than 5‐able) records or which reference an AFP Page Definition is also reverted to MIXED. If there is a requirement to reset the PRMODE after the Checker is executed, this may also be achieved by running the maprule program again after the chkr program.

Using PERL regular expressionsMatch values allow a variant of PERL regular expressions to be included in the match value of a maprule.

Example:

“JOBAB*|JOB123*” as a match value for the jobname column would match JOBABC, JOBAB as well as JOB1234 and JOB12345. Two rules would have to be created for this.

NOTE: The asterisk (*) means 0 to many characters where previously it meant 1 to many characters.

In addition, “FORM[123]” means FORM1 or FORM2 or FORM3, as the regular expression algorithm is for matching in general and not at the beginning or ending of strings some addition information would be added and would prevent “^” which means beginning and “$” which means end from being used in the string.

For backward compatibility only maprule search values which started with “/” would use the enhance PERL regular expression algorithm and the old algorithm would be used otherwise.

The following special characters can be used with maprules:

NOTE: Refer to the PERL web site for more information on regular expressions at:

http://www.perl.com/doc/manual/html/pod/perlre.html

To manipulate the string to get proper results:

If match string begins with “/”, remove the “/” and add “^” to beginning of string and after every “|” (or) value. In addition, add “$” to the end of the string and before every “|” value. Add “.” prior to any “*” to simulate zero to many instead of the normal PERL meaning of 1 to many of the previous character.

| use this for “or”

[…] one of the characters enclosed in the brackets

* zero to many characters


http://www.perl.com/doc/manual/html/pod/perle.html

SERVICE CODES

Service CodesService codes allow you to create customized codes for use when submitting jobs to output devices, to allow for advanced billing options.

Services codes can be activated or deactivated at any time through FlexConfigure, but should be done after the initial DT/LDTs (customers) have been created.

Open the Service Codes screen:


2. Select Service Codes. This opens the Service Codes screen:

There are two parts to this screen:

Service Codes table

The Service Code Table lists the Service Codes created for this system, the columns are as follows:

Code The Service Code, this can be up to eight alphanumeric characters.

Description A forty‐character description of the code.

Default Usage This column contains one of three values:

SYSTEM DEFAULT The Service Code has been selected as the system’s default code. The SYSTEM DEFAULT is used when a job is printed for the first time and the customer that this job belongs to does not have a customer specific default


SERVICE CODES

set. In other words, the customer default overrides the system default service code.

USED AS DEFAULT The Service Code is the default for one or more customers (DT/LDT).

<Empty> If the field is empty the Service Code has not been assigned as either the system or a customer default.

Client ID Default Service Codes table

The Client ID Default Service Codes Table lists the default Service Codes for selected customers, the columns are as follows:

Customer Name The name of the customer.

The Service Code used when a job belonging to this customer is first printed. The code is annotated with one of the following:

Default Service Code

SYSTEM DEFAULT Where the customer does not have a default Service Code selected.

CLIENT DEFAULT Indicating that this code is the customer’s default Service Code.

Creating Service CodesTo create a Service Code, follow the procedure below:

1. Open the Codes menu.

2. Select Add New Code. The Edit Service Code dialog is displayed:

3. Enter the following fields:

4. If this code is to serve as the system default check Set This Service Code As System Default.

5. Click OK.

Service Code The Service Code, this can be up to eight alphanumeric characters.

Description A forty‐character description of the code.


SERVICE CODES

The new code is displayed in the Service Codes Table.

Enabling and disabling Service CodesTo enable/disable a Service Code:

1. Select the required code in the table.

2. Open the File menu.

3. Either:

• Select Enable Functionality to enable the Service Code, or

• Deselect Enable Functionality to disable it.

Editing Service CodesTo edit a Service Code follow the procedure below:


2. Select Edit Selected Code. The Edit Service Code dialog is displayed.

3. Make the required modifications.

4. Click OK.

The modified code is updated in the Service Codes Table.

Setting a default Service CodeTo set a default Service Code:



3. Select Set Selected Code as System Default.

Deleting a Service CodeTo delete a Service Code:



3. Select Delete Selected Code.

4. A confirmation dialog is displayed, click OK.

The code is then removed from the system and no longer appears in the list of codes.

Setting a default Service Code for a ClientTo set a default Service Code for a client:

1. Select the required client in the Client ID default Service Codes table.

2. Open the Clients menu.

3. Select Set Selected Code for Selected Client. From the resultant menu select the required code.

The code is then shown in the Client ID Default Service Codes Table annotated with <Client Default> next to the customer.


VIEWING LOG FILES


Viewing Log FilesOutput Manager EM has the ability to produce a log file for every Local Component defined to it in FlexConfigure. These logs can be viewed within FlexConfigure.

Viewing a Component log fileTo view a specific Log file, follow the procedure below:

1. In Install/Configure Output Manager EM open the View menu.

2. Select Log files to open the component submenu.

3. Select the required component type. This opens a further submenu displaying the components of the selected type. In the example, on the next page, OM is the component type selected, there are three OM components/printers defined on the Output Manager EM system.

4. Select the required component to open its log:

The above example shows the Log File for the printer VDE5100.

If the job log is longer than can be displayed in the window a scroll bar is available for scrolling through the log. In addition, the log window has the following features:

Search String Allows you to enter an alphanumeric string to search for within the log.

Forward Selecting this option searches forward for the specified string.

Backward Selecting this option searches backward for the specified string.

Refresh Refresh the screen.

Close Close the Job Log window

JOB QUEUE (BUNDLER)

Job Queue (Bundler)Job Queue Bundler gathers all the data and resources required for a job and ‘bundles’ it so that it can be transported to a remote site (for processing) or to Pitney Bowes (for troubleshooting).

The bundler program locates the resources associated with a given job identification number and creates a compressed .tar file. The .tar file contains the job name, copies of the resources required by the job, and copies of the associated data and index files for transport to a remote site. In addition, the .tar file contains, a log file reporting the progress of the bundling procedure and a Submission Client Command Line command file to load the job into the Output Manager EM program.

The location in which the bundled items reside can be controlled with an entry in the open environment table, t_open_env. In addition, this requires that the parm_name parameter is set to BUNDLER_DIR and the parm_valu parameter is set to the path of the required location. The default location is ops/data.

Bundling jobs, resources and dataTo create a .tar file follow the procedure below:

1. In Install/Configure Output Manager EM open the View menu.

2. Select Job Queue (bundler). The following window is displayed:

3. There are two ways in which to select the Job you wish to bundle:

• Select the job from the table in the Job Queue window.

• You can search for the required job using the fields in this window:

Job ID The unique identification number assigned to the job. Type in the job number or place a check‐mark in the box to search all Job IDs. Wild cards may be used as part of the Job ID to display all jobs sharing the specified partial ID.

Job Name The name of the job. Type in the Job Name or place a check‐mark in the box to search all job names. Wild cards may be used as part of the job name to display all jobs sharing the specified partial name. This field is case sensitive.


JOB QUEUE (BUNDLER)

Form The type of paper stock currently assigned to this device. Type in the form name or place a check‐mark in the box to search all forms. Wild cards may be used as part of the form name to display all jobs sharing the specified partial name. This field is case sensitive.

Dest ID The Destination Id of the device that is to receive the output. Enter a destination name of up to eight characters. Wild cards may be used as part of the Destination ID to display all jobs sharing the specified partial ID. This field is case sensitive.

Source The Client from which the job was submitted. Select the required source from the drop‐down or leave blank to search all Sources.

Status The status of the job. Select the required status from the drop‐down or leave blank to search all.

Mode The print mode of the required job. Select the required mode from the drop‐down or leave blank to search all.

Printer A printer on your Output Manager EM system. Select the required printer from the drop‐down or leave blank to search all.

Class The class assigned to the device. Select the required value from the drop‐down.

Prio from The priority on the receiving machine. This can be changed by entering a value in the Prio to field.

Prio to The priority on the target machine.

Reports The number of reports in the job.

4. Click Search display a selection of jobs conforming to your criteria or Reset to clear the fields and begin again.

Select the job you require from the list presented.

5. From the Bundle Job menu select Bundler to open the following:

The Job ID of the previously selected job is shown.


JOB QUEUE (BUNDLER)


Printer A printer on your Output Manager EM system. Select the one required from the drop‐down.

Customer A customer on your Output Manager EM system. Select the one required from the drop‐down

Path The output path name for the bundled (.tar) file. Either type the path in the field or click Path to open the dialog below:

Navigate to the required location and click Select.

6. The Start button is now enabled. Click it to begin bundling.

When the operation is complete the Bundler window appears as shown below:

The Status line indicates whether the bundling was completed successfully.


APPENDIX A: XEROX EPS DRIVER

Appendix A: Xerox EPS DriverThe OM_XEROX output manager, used to drive the Xerox EPS device, has a default configuration file in /ops/data called PRINTERNAME.cfg, where PRINTERNAME is the name of the printer, as shown on the Output Manager EM User Interface, the name is case sensitive. Using this file, the printer can be configured for JESConnect emulation, FCB type, etc. Example config files are provided in /ops/data/xerox.cfg.

Refer to Appendix S: Installing Print Clients for more information on installing the print client for this driver.

Command Line Usage: om_xerox –output ccu mod_id

FlexServer Xerox OM Version 6.0.0.PB Software Inc.Copyright (C) 2004-2005, All Rights Reserved

use:om_xerox[-buffertrace <yes|no>] [-config <file>] [-debug

<yes|no>][-fcbtype <2|3|4|none>] [-help] [-icode

<ASCII|EBCDIC>][-ioffset <offset>] [-iprecode <ASCII|EBCDIC>][-iprefix <prefix>] [-iskip <skip>] [-jesopt][-jestype <2|3>] [-jobstart <yes|no>] [-misprint

<yes|no>][-nettimeout <0-1800>] [-oobtrace <yes|no>][-output <|netbarr|CCU|rdw|dump|adump|null>][-resdl <yes|no|always>] [-throttle <0-20000>] [-

comchecks <yes|no>][-chan1Banner <yes|no>] [-outputfilename <file>][-start_as_idle <yes/no>]<module id>

Default values are shown in square brackets: []

Abbreviations for option names are shown parenthesis: ()

Available options are:

buffertrace Enable buffer tracing? [n] (bt)

configConfiguration file name: [C:\PB\ENT3.0\data\<mod name>.cfg] (c)

debug Display debugging information? [n] (d)

fcbtype Type of FCBʹs to use? [2]

help Display this message. (any unrecognized parameter)

icode Set OPS IDEN DJDE code: [EBCDIC]

ioffset Set OPS IDEN OFFSET: [0]

iprecode Set OPS IDEN PREFIX code: [EBCDIC]

iprefix Set OPS IDEN PREFIX: [$DJDE$]

iskip Set OPS IDEN SKIP: [6]

jesopt Set JES optimization for line jobs? [n]

jestype Type of JES to emulate? [2] (jes)



misprint Should JDL be excluded from resource download? [n]

nettimeoutThe maximum time in seconds to wait for a network response. 0 means never timeout. Default [300]

jobstart Use job‐specific START command? [n] (js)

resdl Download resources? [y]

oobtrace Enable OOB buffer tracing? [n]

output OM output type [netbarr] (out)

where:

NetBarr Network to Barr PC/Channel,

CCU Enterprise Printing System ‐ EPS,

RDW Save to <job id>.dat,

Dump Dump to <job id>.dmp,

Adump Ascii dump to <job id>.dmp,

Null Do not output to anything.

outputfilename name of output file (substitution avail)

throttleSet CPU utilization. A higher number calls for a lesser amount of CPU utilization. Default [8000]

comchecks Should the OM periodically check opsbd status [n]

chan1banner Should the OM insert channel 1 before banners [y]

waitfirstdjdeStart job with RSTACK DJDE if RSTACK delim starts report [n]

multiRstack Should consecutive Rstack be allowed [y]

padResDownloadShould resource download be padded to 512 byte boundary [y]

endingRstack Should ending Rstacks be generated [y]

start_as_idle Should the OM automatically enable AWS on vary on [n]

blankFillDJDEShould DJDE characters before IDEN offset be set to EBCDICblank [n]

suprDataRstacks Should printer setup Rstacks in data be suppressed [none]

where:

NonePrinter Setup Rstacks in data are NOT suppressed,

BothPrinter Setup Rstacks in data at STARTand END are suppressed,

StartPrinter Setup Rstacks in data at STARTare suppressed,

EndPrinter Setup Rstacks in data at END are suppressed.



Job Start ManagementOutput Manager EM controls the switching of start commands on a job by job basis automatically. This option allows the print operator to issue one start command on the Xerox LPS controller, reducing operator errors. The jobstart=no option in the configuration file allows Output Manager EM to control the printing operation and to switch from one program to another. If this option is set to jobstart=yes, your operator is required to start the correct JDE and JDL on the Xerox controller for each individual job. Having jobstart=yes requires a JSL change on your printer to match the criteria to force a Xerox “rstack”, which allows Output Manager EM banner pages to print correctly.

We strongly recommend the use of jobstart=no, in order to fully utilize all the functionality of the Xerox driver. All functions can be implemented with the guidance of Pitney Bowes Professional Services.

EPS ConfigurationBefore the submitting jobs to EPS, the following configuration should be completed:

1. From the EPS main form, go to Setup and select the Gateway menu option.

2. Open the Socket tab. Specify a port of 9100, and the EPS queue.

3. Select Apply.

4. In FlexConfigure, open the Administration menu and select Components|[Module], where the module is the Xerox EPS Printer.

5. Open the Specific tab. Ensure that the Device PC name is the hostname of the CCU box and that the port is 9100.

6. Add the following line to the printer configuration file in /ops/data:

output=ccu

NOTE: Further details on how to use EPS can be obtained from the Xerox DocuPrint Enterprise Printing System procedure manual.


APPENDIX B: OUTPUT MANAGER EM EXAMPLE CONFIGURATION FILES

Appendix B: Output Manager EM Example Configuration Files

Each device on your Output Manager EM system has its own configuration file located in /ops/data and the name of the file is the name of the device with a lower‐case .cfg file extension.

You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example Xerox print driver configuration file is shown below:

# xerox.cfg # Example configuration file for the Xerox Driver # Copy this file to the name of the printer.cfg # NOTE: See command-line help for individual OMs as these are the same# options # Turn on debugging #debug=no # Should text control monitor be enabled (default is no) #monitor=no # Force reset of OPS Barr Driver PC host. (Really not a config option in DB)#setserver=host # Force reset of OM channel address (Really not a config option, in DB) #setchanaddr=hex # Should buffer diagnostic trace be enabled (default is no) #buffertrace=no # Should data be forced to upper-case (default is no) #upcase=no # Should resources be downloaded (default is yes) #resdl=yes # Should job JDL/JDE be started on printer (default is no) #jobstart=no # IDEN PREFIX to use for DJDEs (default is $DJDE$) #iprefix=$DJDE$ # IDEN PREFIX code to use for DJDEs (default is EBCDIC) #iprecode=EBCDIC # Code for IDEN parameters in DJDEs (default is EBCDIC) #icode=ASCII # IDEN OFFlexServerT for DJDEs (default is 0) #iofFlexServert=0 # IDEN SKIP for DJDEs (default is 6) #iskip=6 # END OF CONFIGURATION FILE

Configuration file parametersBUFFERTRACE

Whether to enable buffer trace. The options are Yes and No. The default is No.

DEBUGWhether to turn on debugging. The options are Yes and No. The default is No.

ICODEThe IDEN PREFIX code to use for DJDEs. The options are ASCII and ECBCDIC. The default is EBCDIC.

IPRECODEThe IDEN PREFIX code to use for DJDEs. The options are ASCII and ECBCDIC. The default is EBCDIC.

IOFFLEXSERVERT The IDEN OFFlexServerT for DJDEs. The default is 0.


APPENDIX B: OUTPUT MANAGER EM EXAMPLE CONFIGURATION FILES

IPREFIX The IDEN PREFIX to use for DJDEs. The default is $DJDE$.

ISKIP The IDEN SKIP for DJDEs. The default is 6.

JOBSTART Whether to start the job JDL/JDE on the printer. The options are Yes and No. The default is No.

MONITOR Whether to enable text control monitor. The options are Yes and No. The default is No.

RESDL Whether to download resources. The options are Yes and No. The default is Yes.

SETCHANADDR Force a reset of OM channel address. The default is HEX.

SETSERVER Force reset of OPS Barr Driver PC host. The default is HOST.

UPCASE Whether data is forced to upper‐case. The options are Yes and No. The default is No.


APPENDIX C: VIP/MGR CONTROL EXAMPLE CONFIGURATION FILE

Appendix C: VIP/MGR Control Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example MGR control configuration file is shown below:

# vip_cntl.cfg# Example configuration file for the vip_cntl module######### debug Sets the debug level. Select one of 0, 1, 3, 7, 15, 31, 63, 127, 255, # 511 or 1023.# The default is 0.## debug = 0######### config config_file_name. Typically this parameter is left commented out.# By default /'mod_name'.cfg is used.## config=/ops/data/'mod_name'.cfg######### vipServer = PIOM_Server. Typically this parameter is left commented out.# By default FlexConfigure is used to establish this setting.## vipServer = host_name# OR# vipServer = 127.1.1.1######### vipPort PIOM EXEC listen port. Typically this parameter is left commented# out.# By default FlexConfigure is used to establish this setting and is set to# the PIOM default of 6001.## vipPort = 6001######### holdVDD = <YES|NO> # Places a HOLDVDD into the job profile. The setting can be overridden by # a vip_cntl or a om_vipflex VIPOPT file. A setting of 'holdVDD=YES' is # required to enable the reprint function. The default is NO## holdVDD = NO######### robustPrint = <YES|NO> # Allows PIOM to prebuild virtual resources and to print jobs without an # active PIEM connection. The default is NO.## robustPrint = NO######### allowAWSReschedule = <YES|NO> # Allows vip_cntl to interrupt data transfers to PIOM in order to process # newly arrived higher priority work. The default is YES.## allowAWSReschedule = YES######### BytesLeftAWSLimit = B # The data transfer of a job with fewer than 'B' bytes remaining can not be # interrupted and rescheduled in order to allow a job with a higher



# priority to process. The default is '0'. This disables the 'bytes left' # test.## BytesLeftAWSLimit = 0######### PercentageLeftAWSLimit = P # Similar to BytesLeftAWSLimit but test is based on the percentage of the # data left to transfer. The default is '0'.## PercentageLeftAWSLimit = 0######### OffLineQueuing = <YES|NO> # Selecting YES allows print data to be transferred to PIOM when the target # output devices are OFFLINE. The default is YES.## OffLineQueuing = YES######### OffLinePrinting = <YES|NO> # Selecting YES allows PIEM to submit jobs to PIOM with profile options # that have the job output as soon as possible.Selecting NO has PIEM submit# jobs with profile options that hold the job. The job is released when the # PIOM output client is ready to accept a new job. By selecting NO you are # assured the PIEM OM is available to monitor job output. The default is # YES.## OffLinePrinting = YES######### AutoMountForms = <YES|NO> # Selecting YES allows PIEM to issue a Change Forms command to the PIOM # output client when a job is started by the operator or QM AWS. The # default is YES.## AutoMountForms = YES######### ClearRequestedPrint = <YES|NO> # Print operations requested prior to 'this' vip_cntl startup are # cleared. Print data is not affected. The default is NO.## ClearRequestedPrint = NO######### KeepVariedOn = <YES|NO> # When set to YES, this option allows vip_cntl to automatically vary # itself ONLINE. The '-InactivityTimeOut' governs how often vip_cntl # attempts to connect to PIOM. The default is YES.## KeepVariedOn = YES######### AWS = <YES|NO> # When set to YES, this option allows vip_cntl to move to the ENABLED # state as soon as the connection to PIOM is established. # The default is YES.## AWS = YES######### InactivityTimeOut = s # The number of seconds vip_cntl is to wait before checking for new work. # The default is 60 seconds.## InactivityTimeOut = 60########## Legacy PIOM Message configuration##### filter_vip = nnnnnn # The filter_vip_msg option is used by the OMs to filter out warning



# messages.## ***NOTE*** Coding 'filter_vip_msg = nnnnnn' is the same as coding# 'IgnoreWarningMessages = nnnnnn'.## filter_vip_msg =##### otext_gui_ack = <YES|NO>## OTEXT_GUI_ACK determines how vip_cntl handles 'otext wait' and PIOM# Abort/Continue messages. If set to 'YES', a gui pop-up is displayed# and the operator is given the choice of continuing or aborting the job.# Output is held while the pop-up is displayed.This give the operator the# opportunity to perform printer setup activities. If set to 'NO', an # informative pop-up is displayed and the job is automatically continued.# Default value is YES.## ***NOTE*** Coding 'otext_gui_ack = YES' is the same as coding# 'OperatorAbortContinue = ALL# 'IgnoreAbortContinue = NONE# 'ContinueAbortContinue = NONE# 'AbortAbortContinue = NONE## Coding 'otext_gui_ack = NO' is the same as coding# 'OperatorAbortContinue = NONE# 'IgnoreAbortContinue = NONE# 'ContinueAbortContinue = ALL# 'AbortAbortContinue = NONE## ***** NOTE ***** otext_gui_ack should be coded before the PIOM Message# Filters## otext_gui_ack = YES##### continue_after_abort = <YES|NO>## continue_after_abort - This parameter determines how PIEM reacts to an# abort request. If set to YES only the report currently being output is # affected. If set to NO, all reports in the job are aborted. # Default value is YES.## continue_after_abort = YES##### resourceCapture = <YES|NO>## resourceCapture - This parameter determines if the PIOM station is# working resource capture mode. In this mode, jobs that are sent to this# PIOM station to capture IHRM based resources. Subsequent printing, on a# standard PIOM station, uses the captured resources ahead of resources# found in the normal search path.# Default value is NO.## resourceCapture = NO##### sidewaysProcess = <YES|NO>## Whether the PIOM station is working as a sideways processor. If so, once # a job has completed processing on the PIOM station, its job state is # reset to READY. If nee PIOM modifier when the job state is reset to # READY. Sideways processing does not require the job modifier or the # default modifier be robust (i.e. VDE processing need not be invoked).# Default value is NO.## sidewaysProcess = NO##### vs_vip_output_user_parm = NN## vs_vip_output_user_parm - Sets the user parm value that is# placed in the vip_output value when resource capture or sideways# processing completes. The parameter is only active if resourceCapture or



# sidewaysProcess have been to YES.# There is no default value.## vs_vip_output_user_parm=NN##### vs_vip_view_user_parm = NN# vs_vip_view_user_parm - This parameter sets the user parm value that is# placed in the vip_output value when resource capture or sideways# processing completes. The parameter is only active if resourceCapture or# sidewaysProcess have been to YES.# There is no default value.## vs_vip_view_user_parm=NN##### vs_dest_id_user_parm = NN# vs_dest_id_user_parm - This parameter sets the user parm value that is# placed in the dest_id value when resource capture or sideways# processing completes. The parameter is only active if resourceCapture or# sidewaysProcess have been to YES.# There is no default value.## vs_dest_id_user_parm=NN##### vs_vip_modifier_user_parm = NN# vs_vip_modifier_user_parm - This parameter sets the user parm value that# id placed in the vip_modifier value when resource capture or sideways# processing completes. The parameter is only active if resourceCapture or# sidewaysProcess have been to YES.# There is no default value.## vs_vip_modifier_user_parm=NN##### ignoreCapturedResources = <YES|NO># ignoreCapturedResources - This parameter determines if jobs sent to the# PIOM station should ignore any captured resources within the resource# search path.# Default value is NO.## ignoreCapturedResources = NO######## checkServerName = <YES|NO># checkServerName should be set to NO when the associated PIOM system can# have more than one hostname. This can occur in some high availability# configurations.# Default value is YES.## checkServerName = YES######## monitorExternalJobs = <YES|NO># monitorExternalJobs is set to YES if the associated PIOM system is# preprocessing jobs that are to be submitted to PIEM, and monitoring of# of the preprocessing step is required. PIEM creates an 'external job'# entry on its queue to facilitate monitor of PIOM preprocessing activity.# Default value is NO.## monitorExternalJobs = NO######## externalJobHostName = <name of PIOM host># externalJobHostName can be set to override the PIOM host name associated# with external jobs. The host name is set by fsesccl's tagHost parameter.# By default device name of the PIOM station running the preprocessing step# as setup by FlexConfigure is used.## externalJobHostName = <name of PIOM host>###



#### externalJobRetentionPeriod = <retention time for external jobs in hours># externalJobRetentionPeriod can be set to override the retention period# for external jobs.# The default value is the PIEM default retention period as set up by# FlexConfigure.## externalJobRetentionPeriod = <external retention period>######## externalJobAllow = <VipFlex1 string value># externalJobAllow is used to set up a filter for external jobs. If set,# then only PIOM jobs that have a matching VipFlex1 PIOM profile option are# monitored. More than one externalJobAllow statements can be included in # the configuration file.# The default is to track all PIOM jobs as external if monitorExternalJobs# is set to YES.## externalJobAllow = <VipFlex1 string value>######## externalJobExclude = <VipFlex1 string value># externalJobExclude is used to set up a filter for external jobs. If set,# then PIOM jobs that have a matching VipFlex1 PIOM profile option are NOT# monitored. More than one externalJobExclude statements can be included in # the configuration file.# The default is to not exclude any PIOM jobs if monitoring.## externalJobExclude = <VipFlex1 string value>######## externalJobSubmit = <VipFlex1 string value># externalJobSubmit is used to identify those jobs that must submit a job to# PIEM to be marked as complete. If a PIOM job has a matching VipFlex1 PIOM# profile option then that job will be marked as External Submit Failed# unless a job is submitted to PIEM using the matching tagHost and tagJobId# values in fsesccl. More than one externalJobSubmit statements can be # included in the configuration file.# The default is to not mark any jobs as External Submit Failed.## externalJobSubmit = <VipFlex1 string value>######## queueVipMessages = <YES|NO># queueVipMessages is used to control whether messages from PIOM should be# serviced immediately (NO mode) or queued (YES mode). Use YES if your PIOM # server has a very large number (greater than 10000) of jobs in the PIOM # job queue on a normal basis## *** This option is deprecated. Use of 'portsForHighPerformance' is# recommended when there are number of jobs.## Default value is NO.## queueVipMessages = NO######## queueVipMsgPlayMaxTime = <time in seconds># queueVipMsgPlayMaxTime is the maximum time (in seconds) that will be # spent processing queuedVipMessages before going onto other tasks. This # value is only applicable if queueVipMessages=YES. The default is 1 # second. Larger values can be used to reduce the delay in processing # messages if there is a large backlog of job messages at startup.# Default value is 1.## queueVipMsgPlayMaxTime = 1######## QueueVipMsgPlayMinMsg = <# messages>



# queueVipMsgPlayMinMsg is the minimum number of queueVipMessages that will# be processed for each run. This value is only applicable if # queueVipMessages=YES. It is recommended to leave this value at 1.# Default value is 1.## queueVipMsgPlayMinMsg = 1######## reprintExcludeDeleteWindow = nnnn# reprintExcludeDeleteWindow is used to set the minimum number of seconds# PIEM must wait after the last reprint for a job is completed before it can # attempt to delete the job.## Default value is 0.## reprintExcludeDeleteWindow = 0################## PIOM Message Filters############# PIOM Abort/Continue requests are issued when PIOM needs an operator### to decide if processing of a job is to continue. There are 4### configuration options which determine how vip_cntl handles### abort/continue messages. With them you can configure vip_cntl to:### - ignore all abort/continue messages, do this only if you want### the operator to respond to the messages on the PIOM GUI,### - display all abort/continue messages on the PIEM GUI,### - automatically abort jobs with specific PIOM message codes,### - automatically continue jobs with specific PIOM message codes,### - and configure to ignore some, abort some or continue some.###### PIOM abort/continue are passed through up to 4 filters. Each filter### has the option of marking the message as 'ignorable',### 'postable to PIEM GUI', 'abort the job' or 'continue the job'.### If a filter specifically mentions a 'PIOM Message Number', then### processing by the follow on filters is skipped. The filter names### and order in which they are applied are:###### 1 - OperatorAbortContinue: Messages marked by this filter are### passed to the PIEM GUI.###### 2 - IgnoreAbortContinue: vip_cntl ignores the message. The### operator must use the PIOM GUI to### abort or continue the job.###### 3 - ContinueAbortContinue: vip_cntl automatically continues the### job. No operator confirmation is### required.###### 4 - AbortAbortContinue: vip_cntl automatically cancels the### job.###### Each of the 4 filters take one or more parameters. Parameter are### delimited by a space.###### < NONE | ALL | PIOM Message Number { PIOM Message Number }>###### Specifying NONE or ALL re-initializes a list. Previously listed### message numbers are lost.###### - You may place more than one 'PIOM Message Number' on a filter.### - You may repeat a filter in the configuration file. For example### both of the following have the same effect on vip_cntl.###### ContinueAbortContinue = 027202 129418 32847###### OR###### ContinueAbortContinue = 027202### ContinueAbortContinue = 129418### ContinueAbortContinue = 32847###



############### OperatorAbortContinue = <NONE | ALL | {PIOM Message Number}># This option enumerates Abort/Continue messages numbers that are to# be displayed on the PIEM GUI. By default all messages are forwarded# to the PIEM GUI. You'll first need to specify# 'OperatorAbortContinue NONE'# and then follow with# 'OperatorAbortContinue = NNNNNNNNN'# entries for the those messages which are to be displayed.# The default is ALL.## OperatorAbortContinue = ALL######### IgnoreAbortContinue = <NONE | ALL | {PIOM Message Number}># This option enumerates Abort/Continue messages that are to be# handled on the PIOM GUI.## 'IgnoreAbortContinue = NONE'# is the same as specifying# 'OperatorAbortContinue = ALL'## 'IgnoreAbortContinue = ALL'# is the same as specifying# 'OperatorAbortContinue = NONE'.## The default is NONE.## IgnoreAbortContinue = NONE######### ContinueAbortContinue = <NONE | ALL | {PIOM Message Number}># This option enumerates the messages that are to receive an# automatic continue response.## 'ContinueAbortContinue = NONE' turns off the filter.## 'ContinueAbortContinue = ALL' results in a continue response for all# messages that are not specifically listed with one of the other# filters.## The default is NONE.## ContinueAbortContinue = NONE######### AbortAbortContinue = <NONE | ALL | {PIOM Message Number}># This option enumerates the messages that are to receive an# automatic abort response.## 'AbortAbortContinue = NONE' turns off the filter.## AbortAbortContinue = ALL' results in an abort response for all# messages that art not specifically listed with one of the other# filters.## The default is NONE.## AbortAbortContinue = NONE######### IgnoreInformationMessages = <NONE | ALL | {PIOM Message Number}># Selecting ALL prevents "VIP Info Messages" from being displayed on# the PIEM GUI.## The default is ALL.## IgnoreInformationMessages = ALL######### IgnoreWarningMessages = <NONE | ALL | {PIOM Message Number}># Selecting ALL prevents "VIP Warning Messages" from being displayed



# on the PIEM GUI.## The default is NONE## IgnoreWarningMessages = NONE######### IgnoreErrorMessages = <NONE | ALL | {PIOM Message Number}># Selecting ALL prevents "VIP Error Messages" from being displayed# on the PIEM GUI.## The default is NONE.## IgnoreErrorMessages = NONE############### Note: All abort/continue, information, warning and error####### messages are placed in the vip_cntl log. Abort/Continue####### responses along with an indication of whether they are program####### generated or operator selected responses are placed in the log.######### InputauditMessages = <YES | NO># Indicates whether the vip_cntl is to generate audit messages for# PIOM based input activity.## The default is NO.## *** NOTE: Insure PIOM has auditing disabled to prevent duplicate# messages from being placed on the PIEM audit log.## InputauditMessages = NO######### OutputauditMessages = <YES | NO># Indicates whether the vip_cntl is to generate audit messages for# PIOM based output activity.## The default is NO.## *** NOTE: Insure PIOM has auditing disabled to prevent duplicate# messages from being placed on the PIEM audit log.## OutputauditMessages = NO########## IgnoreVipAbortRequest = <YES | NO># Indicates whether the vip_cntl is to ignore abort requests for job abort# from PIOM.## The default is NO.## *** NOTE: Insure PIOM has been set up to direct all pop-up messages to# the PIOM GUI instead of the PIEM GUI when using this option.## IgnoreVipAbortRequest = NO######### stopVipClientOnWaitTimeOut = <YES | NO># Indicates whether vip_cntl sends a stop message to the PIOM input client# at the same time the to_vipflex module is stopped due to a inactivity# timeout error. If set to YES ensure that the to_vipflex configuration# files allow for an automatically start the PIOM input client. This is# not the default for to_vipflex. Edit the to_vipflex configuration file# and setting 'start_vip_input=YES'.# The default setting is NO.##stopVipClientOnWaitTimeOut = NO######### maxToVipWaitTime = NN# Allows vip_cntl to monitor to_vipflex / PIOM input client status. When# to_vipflex is active the PIOM client state should also be active.# Setting this option to a non-zero value allows vip_cntl to validate# module status every NN seconds. If the PIOM input client is found to be



# inactive for NN seconds during the time to_vipflex is active then a# status update request is sent to the input client. After a 60 second# timeout the status are again checked. If they are found to still be# out of sync, the to_vipflex module is recycled. The configuration# setting in flexcontrol.cfg should be checked to ensure that# the to_vipflex client is configured to automatically restart,# for example with "STOP+1".## See also the stopVipClientOnWaitTimeOut option.## To allow timeout processing to run but not recycle the to_vipflex module# code a value of 720.# A value of less than 60 may result in unnecessary recycle operations on# heavily loaded platforms.# The default is 0. Status inconsistencies are not checked.## maxToVipWaitTime = 0######### ProcessBeforeInitComplete = <Yes/No># Allows vip_cntl to start AWS processes for it's to_vipflex clients prior# to the completion of the vip_control / vip_exec job messages# synchronization. In some cases, the synchronization may take minutes or# even hours to complete if there is large amount of synchronization to# complete.# If set to YES, AWS jobs can be submitted prior to the initialization# completing, however, there may be a delay in job updates to the# newly submitted jobs until the synchronization is complete. This may# result in JOBS showing in a PENDING state, even after the job has# completed sending to PIOM.# *** This is a legacy option. The setting should be left at 'No'.# Use of 'portForHighPerformance' provides for improved PIEM / PIOM queue# resynchronization.## The default is NO.##ProcessBeforeInitComplete = NO######## auditStackedCounts = <Yes/No># Allows the stacked count reported by the vdd2ijet PIOM output client# to be reported in the audit records.# Note that this replaces configuration option useStackedCountForOutput.# Support for useStackedCountForOutput has been removed.## The default is NO.######### portsForHighPerformance = <0 | first of two TCP/IP port numbers># This option enables multi-threaded or High Performance mode.# When the setting is greater than 0 it is the first of two consecutive# TCP/IP port numbers available to by vip_cntl for use by process# communications. A setting of 4040 results in port 4040 and port 4041# being used.# A value of 0 results in single threaded mode, vip_cntl does not require# the use of TCP/IP ports for process communications.## Multi-threaded operations should be used when the PIOM processing can# result in bursts of messaging. Messages are queued on the TCP/IP stack.# Should the rate at which vip_cntl processes messages fall below the rate# at which the PIOM EXEC generates messages, the PIOM EXEC must wait for# vip_cntl to catch up. By using multi-threaded operations, the chances# of the TCP/IP stack filling due to processing time requirements by# vip_cntl are reduced.## Multi-thread mode should be used when# - there are large number short jobs are processed,# - the number of modules in use by PIEM is high,# - network throughput can slow due to heavy load,# - the PIOM EXEC reports it has had to retry a message,# - a need for load balancing is suggested.# The default is 0.### portsForHighPerformance = 0



######### maxMessageStackCount = <integer value># Note: The parameter is only meaningful if multi-threaded mode has been# enabled. Use this parameter when vip_cntl is running on a system# with limited CPU resources.# Should the number of messages in the received message queue exceed this# value, AWS processing pauses until all queued messages have been# processed. A value of 5 times the number of jobs processed per hour# is suggested as a starting point when tuning vip_cntl. 0 disables the# stack count check. If you are processing less that 200 jobs per hour# using this parameter may not show any changes in processing throughput.# The default is 0.## maxMessageStackCount = 0#########postConsoleMessagesToJobLog = <YES | NO># When set to 'NO' PIOM information messages and PIOM warning messages are# placed in the vip_cntl log with the PIOM job id but do not inaccessibly# with a PIEM job id. The messages are not logged in the PIEM job log.# When set to 'YES', the PIEM job id and report id are placed on the log# record in the vip_cntl log and the message is logged in the PIEM job log.# Message processing time is reduced when 'NO' is selected. Use 'NO' if# the CPU continuously runs close 100% and DB usage is the top consumer.# The default is 'YES'.##postConsoleMessagesToJobLog = YES#########moduleCentricAWS = <YES | NO># Use YES' when the job mix tends to be many short jobs rather than a few# large jobs, or when the job count a tends to be higher than the# available to_vipflex module count.# The default is 'NO'.##moduleCentricAWS = NO#########auditWithMessageTime = <YES | NO># Useful only if portsForHighPerformance is set. audit message time is# typically based on the time of day the message is logged. With# portsForHighPerformance is enabled, a large number of messages can be# be queued resulting in a delay between the time a message was received# and the time the audit log entry is made. With this option set to 'YES'# the time of day the message is received is used as the audit time# rather than the time of day it is the logged.# This is useful if you are running many small jobs and you find audit# table event times are not close enough to the times in the OM logs or# PIOM SYSTEM.LOG. The recommend setting is 'NO'.# The default is 'NO'.##auditWithMessageTime = NO#########procLogTime = <YES | NO># Only valid if auditWithMessageTime is enabled.# Set this to 'YES' to append event times to log messages output to the# vip_cntl log. The difference in logged messages is as follows:## 'procLogTime = NO' logs:# May 04 09:42:02: Initialization to QM starts## 'procLogTime = YES' logs:# May 04 09:42:02: Initialization to QM starts (Event Time: May 04 09:40:02.)## The above shows the event occurred 2 minutes prior the log begin updated.# The default is 'NO'##procLogTime = NO#########allowPriorityMessaging = <YES | NO># Only used if portsForHighPerformance is set. Normally 'abort/continue'



# requests are allow to flow through processing at the same rate as audit# and log activity. Should a system be experiencing a large number of log# messages the time it takes the GUI to display the 'abort/continue'# request is delayed. This may delay though put as the operation must wait# for all logging activity to complete prior to being able to respond to# the 'abort/continue' request.# Setting this value to 'YES' allows the PIEM GUI present the# 'abort/continue' pop-up as soon as the message is fielded from PIOM.# It should be noted that auditing of OM activity may be out of step with# job logging. When running with a system that requires strict order in# audit messages (such as DFWorks) this setting should be left as 'NO'.# Use instead the PIOM GUI to respond to 'abort/continue' requests.# The default is 'NO'.##allowPriorityMessaging = NO#########useToVipBusyCheck = <YES | NO># Provides a secondary check that helps prevent AWS jobs from being stuck# in PENDING.##useToVipBusyCheck = YES####onRestartSubmittedJobState = <NONE | SUBMITTED | HOLD | COMPLETED># PIOM continues to print jobs queued to it by PIEM after PIEM is stopped.# When PIEM is restarted any jobs that were in the PIEM SUMBITTED state# prior to PIEM going down and that were printed by PIOM need to have# their status updated.# - NONE or SUBMITTED is leaves the job in SUBMITTED. It may be used# only when manual intervention is planned to take the job out of# SUBMITTED. A job left is SUBMITTED after restart does not accept# GUI commands and may leave the job unavailable to reprint.# - COMPLETED should be used only when it is know that the jobs# sent to PIOM are printed. audit activity for these jobs is limited# and can not mimic normal print auditing.# - HOLD is the preferred choice. Operations may re-submit or delete# jobs as after having reviewing print activity by PIOM.# The default is HOLD.#onRestartSubmittedJobState = HOLD####onRestartSubmittedaudit = <YES | NO># This option requires 'onRestartSubmittedJobState = COMPLETED' to be# configured. Normal PIEM audit is not possible when PIOM prints a job# while PIEM is down. Any reports set to COMPLETED by PIEM on restart# optionally have a single 4098 audit record placed in the audit log.# Use YES to generate the audit record.# The name of the audit record is 'audit UNKNOWN END SIDES' and as the# name suggests, entries in the audit record cannot go guaranteed to# reflect the actual number of pages generated or the actual print time.# Note: PIEM audit associates a printer to a report only once the report# has started print. With reports in the SUBMITTED state no print has# occurred and so no printer is associated with the report. The audit# processor uses VIP_CNTL as the printer to allow generation of the# audit record.# The default is NO.#onRestartSubmittedaudit = NO#########reReadyFailedToStartJobs = <YES | NO># Should a to_vipflex module fail to start data transfer and it aborts the# job without transferring data to PIOM, the job state is set back to READY# or HOLD based on the value of this parameter.# A setting of YES resets the job state to READY making it available to# the next to_vipflex module "ready for work".# A setting of NO results in the job going to HOLD and an operator must# re-ready the job before it data transfer can be re-attempted.# The default is NO.#reReadyFailedToStartJobs=NO#########manageRemoteClientStates = <YES | NO># vip_cntl monitors the state of to_vipflex modules and PIOM clients.# - The PIOM client states are closely monitored. State change requests



# are issued if a module is found to be in an unexpected state.# - vip_cntl AWS does not issue new work to a to_vipflex module unless# it is found to be in the IDLE state and the corresponding PIOM client# is found to be ready to receive a new job.# - Should a module or client fail, vip_cntl attempts recovery.# - vip_cntl takes on the responsibility of starting PIOM input clients.## *** The toVipFlex.cfg parameter "start_vip_input" should be set to "NO".# *** The toVipFlex.cfg parameter "start_as_idle" should be set to "NO".## The default is NO.#manageRemoteClientStates=NO#########allowIdleDpDisconnects = <YES|NO># Do not try to reconnect to a to_vipflex client that has disconnected until# work is available for it. When set to YES the GUI may show the client in# an ONLINE state when there is no active TCP\IP connection to PIOM. This# occurs when the to_vipflex module has disconnected after its# DP_IDLE_SIGNOFF_INTERVAL has expired. See documentation in the to_vipflex# configuration file for usage information on DP_IDLE_SIGNOFF_INTERVAL# option.# The default is NO.#allowIdleDpDisconnects=NO##########RoundRobinVipCntlAWS = <YES|NO>## vip_cntl round robin AWS is useful when more than on vip_cntl modules# has been defined and the work flow does not require jobs to be# processed by a specific server. Jobs are started on the first# available server. The jobs vip_out or "Output Manager Ouput Device"# is set to a comma delimited list of modules where the job may be run.# For print jobs the list may contain om_vipflex module names, and in# the case where jobs are queued to the Output Manager system with# the output client set to OPEROUT the vip_cntl modules name.# For job needing VIP Sideways processing the list typically# consists of vip_cntl modules names. vip_cntl doing the vip_sideways# processing should update the VIP_OUT setting following the completion# of the sideway run. Typically this is using the vs_vip_output_user_parm# setting in the vip_cntl cfg file where the list of om_vipflex printers# available to the job is stored in one of the job UP fields. That list# may be defined as a single om_viflex or a comma delimited list of# om_vipflex modules.## NOTE:# - All vip_cntl that are to be used for round robin processing must# roundRobinVipCntlAWS set to YES.# - The vip_cntl moduleCentricAWS parameter should be configured to YES.##roundRobinVipCntlAWS=NO###End of Configuration File For vip_cntl

Configuration file parametersALLOWAWSRESCHEDULE

Allows vip_cntl to interrupt data transfers to Output Manager in order to process newly arrived higher priority work. The options are Yes and No. The default is Yes.

ALLOWIDLEDPDISCONNECTS

This specifies whether to try to reconnect to a to_vipflex client that has disconnected until work is available for it. When set to YES the GUI may show the client in an ONLINE state when there is no active TCP\IP connection to PIOM. This occurs when the to_vipflex module has disconnected after its



DP_IDLE_SIGNOFF_INTERVAL has expired. See documentation in the to_vipflex configuration file for usage information on DP_IDLE_SIGNOFF_INTERVALoption. The options are YES and NO. The default is NO.

ALLOWPRIORITYMESSAGING

Only used if PORTSFORHIGHPERFORMANCE is set. Normally ʹabort/continueʹ requests flow through processing at the same rate as audit and log activity. Should a system be experiencing a large number of log messages the time it takes the GUI to display the ʹabort/continueʹ request is delayed. This may delay though put as the operation must wait for all logging activity to complete prior to being able to respond to the ʹabort/continueʹ request. The options are:

AUDITWITHMESSAGETIME

Only used if PORTSFORHIGHPERFORMANCE is set. audit message time is based on the time of day an event is queued for logging rather than the time of day the logging occurs. This is useful if you are running many small jobs and you find that audit table event times are delayed when compared to the time the event was logged in the OM log. The options are Yes and No. The default is No.

AUTOMOUNTFORMS

Allow Output Manager EM to issue a Change Forms command to the Output Manager output client when a job is started by the operator or QM AWS. The options are Yes and No. The default is Yes.

AWS

Allows VIP_Ctrl to move to the ENABLED state as soon as the connection to Output Manager is established. The options are Yes and No. The default is Yes.

BYTESLEFTAWSLIMIT

The data transfer of a job with fewer than the specified number of bytes remaining can not be interrupted and rescheduled in order to allow a job with a higher priority to process. The default is 0. This disables the ʹbytes leftʹ test.

CLEARREQUESTEDPRINT

Print partitions requested prior to this VIP_Ctrl startup are cleared. The Print data is not affected. The options are Yes and No. The default is No.

CONFIG

The config file name. The default is /ops/data/'mod_name'.cfg. For example: config /ops/data/uniflex.cfg.

YES Allows the FSE GUI to present the ʹabort/continueʹ pop‐up as soon as the message is fielded from Output Manager. It should be noted that auditing of OM activity may be out of step with job logging. When running with a system that requires strict order in audit messages (such as DFWorks).

NO Use the Output Manager GUI to respond to ʹabort/continueʹ requests. This is the default



DEBUG

Sets the debug level. The values are: 0, 1, 3, 7, 15, 31, 63, 127, 255, 511 or 1023. The default is 0.

HOLDVDD

Places a HOLDVDD command into the job profile. The setting can be overridden by a VIP_Ctrl or a om_vipflex VIPOPT file. A setting of holdVDD=YES is required to enable the reprint function. The options are Yes and No. The default is No.

IGNOREVIPABORTREQUEST

Indicates whether the VIP_Ctrl is to ignore abort requests for job abort from Output Manager. The options are Yes and No. The default is No.

NOTE: Ensure Output Manager has been set up to direct all pop‐up messages to the Output Manager GUI instead of the FSE GUI when using this option.

INACTIVITYTIMEOUT

The number of seconds VIP_Ctrl is to wait before checking for new work. The default is 5 seconds.

KEEPVARIEDON

Allows VIP_Ctrl to automatically vary itself ONLINE. The -

InactivityTimeOut governs how often VIP_Ctrl attempts to connect to Output Manager. The options are Yes and No. The default is Yes.

MANAGEREMOTECLIENTSTATES

VIP_Ctrl monitors the state of toVip modules and Output Manager clients. The client states are closely monitored. State change requests are issued if a module is found to be in an unexpected state. The options are Yes and No. The default is Yes.

VIP_Ctrl AWS does not issue new work to TO_VIP modules unless they are in the IDLE state and the corresponding Output Manager clients are ready to receive data. Should a module or client fail, VIP_Ctrl attempts recovery. VIP_Ctrl takes on the responsibility of start Output Manager input clients.

The START_VIP_INPUT=NO and START_AS_IDLE=NO toVip.cfg parameters must be specified.

MAXMESSAGESTACKCOUNT

This is only meaningful if multi‐threaded mode has been enabled by setting portsForHighPerformance to a non‐zero value. Use when VIP_Ctrl is running on a system with limited CPU cores. Should the number of messages in the received message queue exceed this value, AWS processing pauses until all queued messages have been processed. A value of 5 times the number of jobs processed per hour is suggested as a starting point when tuning VIP_Ctrl. 0 disables the stack count check. If you are processing less that 200 jobs per hour using this parameter may not show any changes in processing throughput. The default is 0.



MAXTOVIPWAITTIME

Allows VIP_Ctrl to monitor TO_VIP/ Output Manager input client status. When TO_VIP is active the Output Manager client state is expect to also be active. Setting this option to a non‐zero value allows VIP_Ctrl to validate module status every NN seconds. If the Output Manager input client is found to be inactive for NN seconds during which time the TO_VIP client is active then a status update request is sent to the input client. After a fixed time out of 60 seconds the status are again checked and if found to still be out of sync the TO_VIP module is recycled. The configuration setting in flexcontrol.cfg should be checked to ensure that the TO_VIP client is configured to restart after a failure, for example with ʺSTOP+1ʺ.

This is setting placed in flexcontrol.cfg when FlexConfigure builds flexcontrol.cfg. See also STOPVIPCLIENTONWAITTIMEOUT .

To allow timeout processing to run that does not recycle the TO_VIP module a value of 720 should be coded. Values less than 60 may result in unnecessary recycle operations on heavily loaded platforms. The default is 0. Status inconsistencies are not checked.

MODULECENTRICAWS

Use YESʹ when the job mix tends to be many short jobs rather than a few large jobs, or when the job count a tends to be higher than the available TO_VIP count. The options are Yes and No. The default is No.

OFFLINEPRINTING

Allows Output Manager EM to submit jobs to Output Manager with profile options that have the job output as soon as possible. The options are Yes and No. Selecting No submits jobs with profile options that hold the job. The job is released when the Output Manager output client is ready to accept a new job. By selecting No you are assured that the Output Manager EM OM is available to monitor job output. The default is Yes.

OFFLINEQUEUING

Allows print data to be transferred to Output Manager when the target output devices are OFFLINE. The options are Yes and No. The default is Yes.

ONRESTARTSUBMITTEDJOBSTATE

Output Manager continues to print jobs queued by FSE after FSE is stopped. When FSE is restarted any jobs that were in the FSE SUMBITTED state prior to FSE going down and that were printed by Output Manager need to have their status updated.

NONE or SUBMITTED leaves the job in SUBMITTED state. It may be used only when manual intervention is planned to take the job out of SUBMITTED. A job left is SUBMITTED after restart does not accept GUI commands and may leave the job unavailable to reprint.

COMPLETED should be used only when it is know that the jobs sent to Output Manager are printed. audit activity for these jobs is limited and can not mimic normal print auditing.



HOLD is the preferred choice. Operations may re‐submit or delete jobs as after having reviewing print activity by Output Manager. The default is HOLD.

ONRESTARTSUBMITTEDAUDIT

This option requires ONRESTARTSUBMITTEDJOBSTATE=COMPLETED to be configured. Normal FSE audit is not possible when Output Manager prints a job while FSE is down. Any reports set to COMPLETED by FSE restart optionally have a single 4098 audit record placed in the audit log. Use YES to generate the audit record.

The name of the audit record is ʹaudit UNKNOWN END SIDESʹ and as the name suggests, entries in the audit record cannot go guaranteed to reflect the actual number of pages generated or the actual print time.

Note: FSE audit associates a printer to a report only once the report has started print. With reports in the SUBMITTED state no print has occurred and so no printer is associated with the report. The audit processor uses VIP_CNTL as the printer to allow generation of the audit record. The default is No.

PERCENTAGELEFTAWSLIMIT

Similar to BytesLeftAWSLimit but the test is based on the percentage of the data left to transfer. The options are Yes and No. The default is No.

PORTSFORHIGHPERFORMANCE

Enables multi‐threaded or High Performance mode. The parameter is the first of two consecutive TCP/IP port numbers to be used for interprocess communications. A setting of 4040 reserves port 4040 and port 4041. If set to 0 single threaded mode is used. The default is 0.

POSTCONSOLEMESSAGESTOJOBLOG

When set to ʹNOʹ Output Manager information messages and Output Manager warning messages are placed in the VIP_Ctrl log with the Output Manager job id but without the FSE job id. The messages are not logged in the FSE job log. Message processing time is reduced when ʹNOʹ is selected. Use ʹNOʹ if the CPU continuously runs close 100% and DB usage is the top consumer.

When set to ʹYESʹ, the FSE job id, report id accompany the message in the VIP_Ctrl log and the message is also logged in the FSE job log. The default is Yes.

PROCESSBEFOREINITCOMPLETE

Allows VIP_Ctrl to start AWS processes for itʹs TO_VIP clients prior to the completion of the vip_control / vip_exec job messages synchronization. In some cases, the synchronization may take minutes or even hours to complete if there is large amount of synchronization to complete.

If set to YES, AWS jobs can be submitted prior to the initialization completing, however, there may be a delay in job updates to the newly submitted jobs until the synchronization is complete. This may result in JOBS showing in a PENDING state, even after the job has completed sending to Output Manager. The options are Yes and No. The default is No.



PROCLOGTIME

Only valid if AUDITWITHMESSAGETIME=YES. Set this to Yes to append event times to log messages output by the audit logger. The difference in the output log message is as follows:

PROCLOGTIME=NO logs ʹMay 04 09:42:02: Initialization to QM startsʹ

procLogTime=YES logs ʹMay 04 09:42:02: Initialization to QM starts (Event Time: May 04 09:40:02.)ʹ

The above shows the event occurred 2 minutes prior the log begin updated. The options are Yes and No. The default is No.

QUEUEVIPMESSAGES

If set to Yes, then messages from Output Manager is queued. If set to No, messages from Output Manager is serviced immediately. YES should be used if your Output Manager server normally has a very large number (greater than 10000) of jobs in the Output Manager job queue. No is default.

REPRINTEXCLUDEDELETEWINDOW

When a job is reprinted, FlexConfigure does not delete the original job while the reprint job is still processing. This is because the reprint job sometimes needs data from the original job file (i.e. the MGR/ENT profile and the set file).

When the reprint job has completed, you may wish to retain the original job for a period of time in case any other reprints are required.

To allow for this, this parameter sets the period of time (in seconds) between when a reprint job completes and when the original job is deleted. If set to 0, the original job is deleted as soon as the reprint job completes.

REREADYFAILEDTOSTARTJOBS

Should a TO_VIP module fail to start data transfer and abort a job without transferring data to Output Manager, the job state is set back to READY or HOLD based on the value of this parameter. A setting of YES resets the job state to READY making it available to next ʺready for workʺ TO_VIP module.

A setting of NO requires an operator re‐ready the job. The default is NO.

ROBUSTPRINT

Allows Output Manager to prebuild virtual resources and to print jobs without an active Output Manager EM connection. The options are Yes and No. The default is No.

ROUNDROBINVIPCNTLAWS

This form of AWS (Automatic Work Selection) is useful when more than one VIP_CTRL modules have been defined and the workflow does not require a specific server to process jobs and are started on the first server available. A comma delimited list of the modules able to run the job is set in the job’s VIP_OUT or ʺOutput Manager Ouput Deviceʺ. For print jobs the list contains OM_VIPFLEX module names, and where jobs are queued to the Output Manager system with the output client set to OPEROUT the VIP_CTRL module name.



For job requiring VIP Sideways processing the list typically consists of VIP_CTRL module names. The VIP_CTRL processing as vip_sideways should update the VIP_OUT setting following completion of the sideway run. Typically this is using vs_vip_output_user_parm in the VIP_CTRL cfg file where the list of available OM_VIPFLEX printers is stored in one of the job UP fields. That list may be defined as a single OM_VIPFLEX or a comma delimited list of OM_VIPFLEX modules.

Note that all VIP_CTRL to be used for round robin processing must have roundRobinVipCntlAWS set to YES. In addition, moduleCentricAWS should be set to YES.

The options are Yes and No. The default is No.

STOPVIPCLIENTONWAITTIMEOUT

Whether VIP_Ctrl sends a stop message to the Output Manager input client at the same time the TO_VIP module is stopped due to a inactivity timeout error. If set to Yes ensure that the TO_VIP configuration files allow for an automatically start the Output Manager input client. This is not the default for TO_VIP. Edit the TO_VIP configuration file and setting start_vip_input=YES. The options are Yes and No. The default is No.

VIPPORT

The Output Manager Exec Listening Port. The default is taken from the database and is set by FlexConfigure. The Output Manager default is 6001.

VIPSERVER

The Output Manager Server. The default is taken from the database and is set by FlexConfigure. Other options are vipServer=host_name or vipServer=ip_address.

USESTACKEDCOUNTFOROUTPUT

Allows the stacked count reported by the vdd2ijet PIOM output client to be reported in the printed pages column in the GUI and in the pages printed audit records for jobs printed by vdd2ijet. The normal printed pages counts will be not be shown or be in the audit records. The options are Yes and No. The default is No.

USETOVIPBUSYCHECK

Provides secondary checking to prevent AWS jobs from being stuck in PENDING.Set the option to Yes only if the to_vipflex module has a TOVip.

The default for R6.0 and below including ENT3.0 is No.

The default for R6.1 and above including ENT3.0 and above is Yes.

Legacy message configuration

CHECKSERVERNAME

Specifies whether the Server name should be checked when the associated Output Manager system can have more than one hostname. This can occur in some high availability configurations. The options are Yes and No. The default is Yes.



CONTINUE_AFTER_ABORT

Specifies how Output Manager EM reacts to an abort request. The options are:

The default is Yes.

EXTERNALJOBALLOW

Sets up a filter for external jobs. If set, then only Output Manager jobs with a matching VipFlex1 Output Manager profile option are monitored. Multiple values are specified in multiple externalJobAllow statements. The default is to track all Output Manager jobs as external if monitorExternalJobs=yes.

EXTERNALJOBEXCLUDE

Set up a filter for external jobs. If set, then Output Manager jobs with a matching VipFlex1 Output Manager profile option are not monitored. Multiple values are specified in multiple externalJobExclude statements. The default is to not exclude any Output Manager jobs if monitoring.

EXTERNALJOBHOSTNAME

The name of Output Manager host. This can be set to override the Output Manager host name associated with external jobs and is supplied as the tagHost parameter to the fsesccl command. The default is the device name set up in FlexConfigure.

EXTERNALJOBRETENTIONPERIOD

The retention time for external jobs in hours; this can be set to override the retention period for external jobs. The default is the Output Manager EM default retention period set in FlexConfigure.

EXTERNALJOBSUBMIT

A VipFlex1 string value that identifies the jobs that must be submitted to Output Manager EM to be marked as complete. If a Output Manager job has a matching VipFlex1 Output Manager profile option then that job is marked as External Submit Failed unless a job is submitted to Output Manager EM using the matching tagHost and tagJobId values in fsesccl. Multiple values are specified in multiple externalJobSubmit statements. The default is not to mark any jobs as External Submit Failed.

FILTER_VIP_MSG

This is used by the OMs to filter out warning messages. Using filter_vip_msg=nnnnnn is the same as using IgnoreWarningMessages= nnnnnn.

IGNORECAPTUREDRESOURCES

Whether the jobs sent to this Output Manager station should ignore any captured resources within the resource search path. The options are Yes and No. the default is No.

Yes Only the report currently being output is affected.

No All reports in the job are aborted.



MONITOREXTERNALJOBS

Specifies whether the associated Output Manager system is preprocessing jobs to be submitted to Output Manager EM that are to be monitored by creating external jobs on Output Manager EM. The options are Yes and No. the default is No.

OTEXT_GUI_ACK

Specifies how VIP_Ctrl handles ʹotext waitʹ and Output Manager Abort/Continue messages. The options are:

The default is Yes.

Using otext_gui_ack=YES is the same as using:

OperatorAbortContinue=ALLIgnoreAbortContinue=NONEContinueAbortContinue=NONEAbortAbortContinue=NONE

Using otext_gui_ack=NO is the same as using:

OperatorAbortContinue=NONEIgnoreAbortContinue=NONEContinueAbortContinue=ALLAbortAbortContinue=NONE

otext_gui_ack should be used before the Output Manager Message Filters.

RESOURCECAPTURE

Specifies whether the Output Manager station is working in resource capture mode, where jobs are sent to the Output Manager station only to capture IHRM based resources. Subsequent printing on a standard Output Manager station uses the captured resources in preference to resources found in the normal search path. The options are Yes and No. The default is No.

VS_DEST_ID_USER_PARM

Sets the user parameter value placed in dest_id when resource capture is successful. This parameter is only active if resourceCapture=YES.

VS_VIP_OUTPUT_USER_PARM

Sets the user parameter value placed in vip_output when resource capture is successful. This parameter is only active if resourceCapture=YES.

VS_VIP_VIEW_USER_PARM

Sets the user parameter value placed in vip_view when resource capture is successful. This parameter is only active if resourceCapture=YES.

Yes A message is displayed in the User interface giving the operator the choice of continuing or aborting the job. Output is held while the message is displayed. This give the operator the opportunity to perform printer setup activities.

No An information message is displayed in the User interface and the job is automatically continued.



Output Manager message filtersOutput Manager Abort/Continue requests are issued when Output Manager needs an operator to decide if processing of a job is to continue. There are four configuration options that determine how VIP_Ctrl handles abort/continue messages. With them you can configure VIP_Ctrl to:

Ignore all abort/continue messages, do this only if you want the operator to respond to the messages on the Output Manager User Interface.

Display all abort/continue messages on the Output Manager EM User Interface.

Automatically abort jobs with specific Output Manager message codes.

Automatically continue jobs with specific Output Manager message codes.

Configure to ignore some, abort some or continue some.

Output Manager Abort/Continue requests are passed through up to four filters, each has the option of marking the message as:

Ignorable

Postable to Output Manager EM User Interface

Abort the job

Continue the job

If a filter specifically includes a Output Manager Message Number, processing by the follow on filters is skipped. The filter names and order in which they are applied are:

1. OperatorAbortContinue: Messages marked by this filter are passed to the Output Manager EM User Interface.

2. IgnoreAbortContinue: VIP_Ctrl ignores the message. The operator must use the Output Manager User Interface to abort or continue the job.

3. ContinueAbortContinue: VIP_Ctrl automatically continues the job. No operator confirmation is required.

4. AbortAbortContinue: VIP_Ctrl automatically cancels the job.

Each of the filters take one or more parameters, delimited by a space.

< NONE | ALL | Output Manager Message Number {Output Manager Message Number}>

Specifying NONE or ALL re‐initializes a list and previously listed message numbers are lost.

NOTE:

• You may place more than one ʹOutput Manager Message Numberʹ on a filter.

• You may repeat a filter in the configuration file. For example both of the following have the same effect on VIP_Ctrl.

ContinueAbortContinue=027202 129418 32847

or

ContinueAbortContinue=027202 ContinueAbortContinue=129418 ContinueAbortContinue=32847

The parameters are as follows:



ABORTABORTCONTINUE

Enumerates the messages to receive an automatic abort response. The options are:

The default is None.

CONTINUEABORTCONTINUE

Enumerates the messages to receive an automatic continue response. The options are:


IGNOREABORTCONTINUE

Enumerates Abort/Continue messages handed on the Output Manager User Interface. The options are:


IGNOREERRORMESSAGES

The options are:


None Turns off the filter.

All Results in an abort response for all messages that are not specifically listed with one of the other filters.

VIP Message Number

Filters only the messages with the specified message number.


All Results in an continue response for all messages that are not specifically listed with one of the other filters.

VIP Message

Number


None This is the same as specifying OperatorAbortContinue=All.

All This is the same as specifying OperatorAbortContinue= None.

VIP Message Number



All Prevents Output Manager Error Messages from being displayed on the Output Manager EM User interface.

Output Manager Message Number




NOTE: All abort/continue, information, warning and error messages are placed in the VIP_Ctrl log. Abort/Continue responses along with an indication of whether they are program generated or operator selected responses are placed in the log.

IGNOREINFORMATIONMESSAGES

The options are:

The default is All.

IGNOREWARNINGMESSAGES

The options are:


INPUTAUDITMESSAGES

Whether VIP_Ctrl generates audit messages for Output Manager based input activity. The options are Yes and No. The default is No.

NOTE: Insure Output Manager has auditing disabled to prevent duplicate messages from being placed on the Output Manager EM audit log.

OPERATORABORTCONTINUE

Enumerates Abort/Continue message numbers displayed on the Output Manager EM User Interface. By default all messages are forwarded to the Output Manager EM User Interface. You first need to specify the following commands for those messages to be displayed.

OperatorAbortContinue=None

OperatorAbortContinue=NNNNNN

The options are None, All and <Output Manager Message Number>. The default is All.


All Prevents Output Manager Info Messages from being displayed on the Output Manager EM User interface.

Output Manager Message Number



All Prevents Output Manager Info Messages from being displayed on the Output Manager EM User interface.

VIP Message Number




OUTPUTAUDITMESSAGES

Whether VIP_Ctrl generates audit messages for Output Manager based output activity. The options are Yes and No. The default is No.

NOTE: Make sure Output Manager has auditing disabled to prevent duplicate messages from being placed on the Output Manager EM audit log.


APPENDIX D: TO VIP/MGR EXAMPLE CONFIGURATION FILE

Appendix D: To VIP/MGR Example Configuration File

Each device on your Output Manager EM system has its own configuration file located in /ops/data and the name of the file is the name of the device with a lower.case .cfg file extension.

You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example configuration file for the to_vipflex driver is shown below:

# tovipflex.cfg# Example configuration file for the to_vipflex Driver# Copy this file to the name of the to_vipflex.cfg# NOTE: See command-line help for individual OMs as these are the same # options.# # NOTE: VIP is the legacy name for PIOM (PI Output Manager) and older# versions are referenced by their legacy name (i.e. VIP 8.4, VIP 8.5, etc).# # Turn on debugging# This option can be used to supplement module debugging. Its use is# secondary and independent of the log level set by FlexConfigure. Should# a debug log be requested, use FlexConfigure and modify the 'Log Level:'# in the module's Device Properties panel.# The default is NO.##debug=NO# otext_gui_ack configures the OM behavior after receiving an otext# wait message. If set to 'YES', a gui pop-up will occur with the otext # message, The operator will have the opportunity to abort or continue the # job. If set to 'NO', the job will be paused and the a pop-up will occur. # To continue the job, the operator will need to right click on the OM icon # and select the "continue" option. The operator can also cancel the job at # this point by selecting the OM cancel option.# The default is YES.##otext_gui_ack=YES# filter_vip_msg - these are msg codes that are sent from PIOM that can be# filtered. Some PIOM messages are duplicated in warning messages as well as# abort_continue messages. The msg Codes listed will be filtered from # warnings.# Specify one message code per 'filter_vip_msg' entries. Up to 10# filter_vip_msg may be include in the to_vipflex configuration file.# The default is 29270, "TCPIP job failed to start".##filter_vip_msg=29270# only_show_known_job_msgs - allows the OM to filter messages based whether# it sent the job for printing. Some PIOM messages are broadcast to all# clients which can result in the same message being posted to the screen# multiple times.# The default is NO.##only_show_known_job_msgs=NO# fast_connect_limit - The value represents the number of times that # to_vipflex will try to connect to the PIOM data provider client # consecutively before sleeping between attempts. The number can be # increased for faster PIEM workstations where 1000 attempts will occur too # quickly for the PIOM server to respond. The number can be reduced if there # is a processing capacity issue on the PIEM platform.# The default value is 0.##fast_connect_limit=0

# vip_connect_backoff# This value represents the time in milliseconds between connect attempts to # PIOM for the data and control connections.# The default is 2000.

#vip_connect_backoff=2000



# vip_connect_timeout # This value represents the time in milliseconds when connection that has # not been made is deemed to have failed. It must also be larger than the # vip_connect_backoff. # The default is 20000.#vip_connect_timeout=20000

# api_retry_DP_connect# When set to YES, the retry of the DP connect using the vip_connect_timeout # and vip_connect_backoff values is performed in the API. This is the # original behavior. When set to NO, the retries (using the same values) are # done at the application layer. In the NO mode, any pending messages are # read off and processed between retries. This will help prevent the # message system from backing up when a data provider connection cannot be # made immediately.#api_retry_DP_connect=NO

# default_modifier# The default_modifier is the name and path of the modifier that are sent to # PIOM if the output_modifier is not set for the job to be transferred. # The default modifier should contain the profile options that invoke an # input VDE script that will convert the resources for "robust" printing.# Linux sample, case sensitive default_modifier=/ops/data/DEFAULT.MOD# Windows sample, if echo %ROOT% gives C:\PB\ENT3.0 then ...#default_modifier=C:\PB\ENT3.0\data\DEFAULT.MOD

# CheckServerName# Controls whether client information messages should be filtered by the # server name defined for this module. This should be set to NO when using # VipFlex in an environment where the input clients may have a different # host name than the executive (high availability clusters or input split # from PIOM executive in a client/server setup). # The default setting is YES.#CheckServerName=YES

# start_vip_input# This parameter controls whether to_vipflex will attempt to start a PIOM # input client if it is not started. If set to 'YES', an input client will # be started on PIOM if a job requiring that input client is submitted to # to_vipflex and the input is not yet started. The default is 'NO'.#start_vip_input=NO

# skip_fcb_when_ansi# This parameter controls whether to_vipflex sends an FCB in the data stream # for LCDS ANSI jobs. When set to 'YES', it will not send the FCB.# The default is 'NO'.#skip_fcb_when_ansi=NO

# abortInputFailedJobs# If set to YES, then to_vipflex will at startup abort any PIOM job that it # started in a previous session that did not complete input data transfer.# The default is NO.#abortInputFailedJobs=NO

# resetVipInput# If set to YES, then to_vipflex will at startup kill and restart the PIOM # input client it is driving.# The default is NO.#resetVipInput=NO

# hosttext_literal_percent# determines how a percent sign (%) will be handled when found in PIOM # profile hosttext information. PIOM interprets single % as a parsing # variable while treating %% as a literal single sign. When # hosttext_literal_percent = Yes, the % found in PIOM profile information # will be converted to %%.# The default value is no.#hosttext_literal_percent=NO

# start_unsent_reports# This option applies to multi-report jobs that are cancelled while # printing. When set to YES, the OM will try to start the reports that have # not yet been sent as part of recovery. This option is provided for legacy # purposes and was required for earlier versions of VIP. For PIOM and VIP



# 8.5 and above, the option should be set to NO.# The default setting is NO.#start_unsent_reports=NO

#endInputFromClientState - This option determines when to_vipflex sends a# 'ready to receive new work' message to the QM. If set to NO, the message# is sent when transfer to the input client completes. If set to YES,# to_vipflex waits for a PIOM CLIENTSTATE_ENDJOB message from the PIOM# EXEC.# A setting of YES is required when the PIOM Input Client is used to start# VDE processing, for PDF input clients, and other cases where input client# does not quickly end processing following the receipt of the last data# bytes of the job.##endInputFromClientState=NO

#dp_idle_signoff_interval - This option sets the data providers idle time# interval. When greater than 0, the to_vipflex module signs off from# PIOM should the time its been idle exceed the specified interval.# to_vipflex automatically signs back into PIOM when new work becomes# available.# The default is 0. The interval is specified in seconds.##dp_idle_signoff_interval=0

# vfv_job_id_view - This option specifies the name of a database view# that is used to add PIEM job id specific options to the# PIOM profile file.# The selected rows have a vfv_id column matches the PIEM job id.# The PIOM profile option name is named view name + "_" + view column name.# The value is string value for the column.# All columns of the view except vfv_id must are string values.# There is no default setting.##vfv_job_id_view=

# vfv_report_id_view - This option specifies the name of a database view# that is used to add PIEM report id specific options to the# PIOM profile file.# The selected rows have a vfv_id column matches the PIEM report id.# The PIOM profile option name is named view name + "_" + view column name.# The value is string value for the column.# All columns of the view except vfv_id must are string values.# There is no default setting.##vfv_report_id_view=

# vfv_mod_id view - This option specifies the name of a database view# that is used to add PIEM module id specific options to the# PIOM profile file.# The selected rows have a vfv_id column matches this PIEM module id.# The PIOM profile option name is named view name + "_" + view column name.# The value is string value for the column.# All columns of the view except vfv_id must are string values.# There is no default setting.##vfv_mod_id_view=

# check_vip_input_endpage - This option specifies that the vipprofile# should be searched for INPUTENDPAGE and INPUTENDSIDE. Setting# INPUTENDPAGE or INPUTENDSIDE in the profile (set via vipopt) can cause the# PIOM input client and data provider to close prior to completing input# processing. If check_vip_input_endpage=YES and INPUTENDPAGE or# INPUTENDSIDE is found, then a success audit record will be posted when the# data provider closes early. Otherwise, a failure audit record will be# posted on transfer complete. Note, if INPUTENDPAGE or INPUTENDSIDE are not# used, then set check_vip_input_endpage=NO to save processing time.# The default is check_vip_input_endpage=NO.##check_vip_input_endpage=NO

# check_vip_input_for_online - This option specifies whether to_vipflex# will check if its associated PIOM input client is READY before it goes# online (vary on). If the PIOM input client is not available or busy



# processing, to_vipflex will not go online. This check cannot be made# if resetVipInput=YES.# The default is check_vip_input_for_online=NO.##check_vip_input_for_online=NO

# check_vip_input_timeout - This option is associated with# check_vip_input_for_online. If check_vip_input_for_online=YES, this# timeout value is how long to_vipflex will wait for the input client state# to be returned after making the request. The value is in seconds.# The default is 5. The timeout is specified in seconds.##check_vip_input_timeout=5

# dp_trailer_timeout - This option sets the timeout when sending a data# trailer for a job. If a data trailer cannot be delivered to PIOM within# the specified number of seconds, then the trailer delivery will be# considered failed. A value of 0 means no timeout is set.# The default is 0.##dp_trailer_timeout=0

# dp_wait_in_processing_timeout - This option sets the number of seconds to# wait for the PIOM input client to respond with a READY message. If the# READY message does not arrive in the configured time, data transfer is# initiated by the to_vipflex module. Legacy modules have this default# internally to 6 seconds. A value of 0 means to wait until the READY# message arrives. Newer modules should use 0.# The new default is 0.##dp_wait_in_processing_timeout=0

# dp_wait_for_ready_sleep - The number of tenths of a second the to_vipflex# module is to sleep while waiting for the PIOM input client to respond with# a READY message. Legacy modules do not sleep and put the to_vipflex module# into a tight loop that may consume excess CPU cycles should the PIOM# system be slow returning the READY message. The default is to wait 1/10# of a second between checks for the READY message. A maximum value of 100# or 10 seconds is imposed internally by the program.# The new default is 1.##dp_wait_for_ready_sleep=1

# recycle_allowed - This option controls the clients reaction to certain# error conditions. When set to YES the client exits when one of the program# monitored error conditions occur. The configuration settings in# flexcontrol.cfg for the client determine when (if) the client is# restarted. Normally FlexConfigure is used to build flexcontrol.cfg and# the restart time is set to 1 minute after an unexpected exit. When set to# NO the client continues processing without trying to recycle itself. At# the time of writing, the only error condition that supports an automatic# recycle is a failure to connect to the PIOM Data Provider. The recovery# includes a RELEASE of PIEM job being processed at the time of the failure.# The RELEASE occurs when the client restarts and is limited to once per# job. Should the connect failure re-occur the job is left in HOLD and must# be released manually.# The default is recycle_allowed=NO.##recycle_allowed=NO

# start_as_idle - This parameter controls whether to_vipflex goes to IDLE or# DRAINED whenever it is varied online. If vip_cntl is set to manage# to_vipflex states (vipcntl_Manages_Clients = YES), then this field must be# set to 'NO'.# The default is 'YES'## start_as_idle=YES

# vipcntl_Manages_Clients - This option declares whether the vip_cntl module# is monitoring to_vipflex module status. This setting must match the# setting of 'manageRemoteClientStates' in the associated vip_cntl module's# configuration file.



# When enabled, to_vipflex is varied on and enabled by vip_cntl once it has# determined the PIOM clients are ready to accept work.# See the vip_cntl default configuration file for more information.# When configuring vipcntl_Manages_Clients = YES, then the following# must also be configured:# 'start_vip_input', documented above, must be set to 'NO' and# 'start_as_idle', documented above, must be set to 'NO'.# The default is 'NO'.## vipcntl_Manages_Clients=NO

# ReReady_out_of_sync_requests - When to_vipflex starts working with a job the# PIEM job state is set to one of the active states, PENDING, SUBMITTING,# etc. Should the job fail to start transfer to PIOM, to_vipflex aborts the# job and sets the PIEM job state to HOLD. This setting allows to_vipflex# to set the state back to READY allowing an alternate to_vipflex to work# with the job. It is important to keep in mind that a job can only be# set back to READY if no bytes have been transferred.# The default is 'NO'.## ReReady_out_of_sync_requests=NO

# job_file_wait_timeout - Declares how many seconds to_vipflex waits for an# "ok to start data transfer" message from PIOM. Normally it takes less than# a second for PIOM to acknowledge the receipt of control files and to issue# a request to start data transfer. Should PIOM be busy or should the# network be experiencing heavier then normal loads, the acknowledgement may# be delayed to the point a timeout occurs. When a timeout occurs the job is# aborted and set back to HOLD (or READY if ReReady_out_of_sync_requests has# been configured to 'YES'). The minimum timeout is 10 seconds.# The default 600.## job_file_wait_timeout=600

##END OF CONFIGURATION FILE

Configuration file parametersABORTINPUTFAILEDJOBS

Whether at startup, to_vipflex aborts any Output Manager job that did not complete input data transfer in a previous session. The options are Yes and No. The default is No.

CHECKSERVERNAME

Whether client information messages should be filtered by the server name defined for this module. This should be set to No when using MGR/ENT in an environment where the input clients may have a different host name from the executive, high availability clusters or input split from Output Manager executive in a client/server setup. The options are Yes and No. The default is Yes.

CHECK_VIP_INPUT_ENDPAGE

Specifies whether the Output Manager profile should be searched for INPUTENDPAGE and INPUTENDSIDE. Setting INPUTENDPAGE or INPUTENDSIDE in the profile (set via vipopt) can cause the Output Manager input client and data provider to close prior to completing input processing. If check_vip_input_endpage=YES and INPUTENDPAGE or INPUTENDSIDE is found, then a success audit record is posted when the data provider closes early. Otherwise, a failure audit record is posted on transfer complete.



NOTE: If INPUTENDPAGE or INPUTENDSIDE are not used, then set check_vip_input_endpage=NO to save processing time.

The options are Yes and No. The default is No.

CHECK_VIP_INPUT_FOR_ONLINE

Specifies whether to_vipflex checks if its associated Output Manager input client is READY before it goes online (vary on). If the Output Manager input client is not available or busy processing, to_vipflex do not go online. This check cannot be made if resetVipInput=YES. The options are Yes and No. The default is No.

CHECK_VIP_INPUT_TIMEOUT

This parameter is associated with check_vip_input_for_online. If check_vip_input_for_online=YES, this timeout value is how long to_vipflex waits for the input client state to be returned after making the request. The value is in seconds. The default is 5 (seconds).


Specifies the behavior of the to_vip after an aborted report is detected in a multi‐report job. The options are:

DEBUG

Turn on debugging

DP_IDLE_SIGNOFF_INTERVAL

This parameter sets the Data Provider Idle Time Interval. If set greater than 0, then the to_vipflex module signs off from Output Manager if there has been no jobs sent to Output Manager in the specified interval. If to_vipflex has signed off from Output Manager, it signs back on when the next job is sent.

DP_TRAILER_TIMEOUT

This parameter sets the timeout when sending a data trailer for a job. If a data trailer cannot be delivered to Output Manager within the specified number of seconds, then the trailer delivery is considered failed.

The default is 0. 0 means no timeout is set.

DP_WAIT_FOR_READY_SLEEP

The amount of time (in tenths of a second) the to_vip module is to sleep while waiting for the Output Manager input client to respond with a READY message.

The default is 1 (1/10 of a second). The software imposes a maximum value of 100 (10 seconds) even if a greater value is specified.

Yes The remainder of the reports in the job is printed.

No The entire job immediately aborts.



DP_WAIT_IN_PROCESSING_TIMEOUT

Sets the number of seconds to wait for the Output Manager input client to respond with a READY message. If the READY message does not arrive in the specified time, data transfer is initiated by the to_vip module.

The default is 0, which means no timeout, a READY message must be received prior to starting data transfer.

DEFAULT_MODIFIER

The name and path of the modifier sent to Output Manager if the output_modifier is not set for the job to be transferred. The default modifier should contain the profile options that invoke an input Output Enhancement script that converts the resources for ʺrobustʺ printing. The default is /ops/data/DEFAULT.MOD.

ENDINPUTFROMCLIENTSTATE

This option determines which event triggers to_vipflex to send a ready message to the queue manager (to receive new work). When set to NO, to_vipflex uses the end of data transfer to mark the event. When set to YES, to_vipflex uses the Output Manager CLIENTSTATE_ENDJOB status to mark the event. If the Output Manager Input Client is used to start Output Enhancement processing, the Input client may not become READY until the Output Enhancement processing completes. In this case, selecting YES may provide better load balancing.

FAST_CONNECT_LIMIT

The number of times that to_vip tries to connect to the Output Manager data provider client consecutively before sleeping between attempts. The default is 0. The number can be increased for faster Output Manager EM workstations where 1000 attempts occurs too quickly for the Output Manager server to respond. The number can be reduced if there is a processing capacity issue on the Output Manager EM platform.

FILTER_VIP_MSG

Message codes sent from Output Manager that can be filtered. Some Output Manager messages are duplicated in warnings as well as abort_continue messages. The messages codes listed are filtered from warnings.

JOB_FILE_WAIT_TIMEOUT

How long to_vip waits for a ʺok to start data transferʺ message from Output Manager. Normally it takes less for a second for Output Manage to # acknowledge the receipt of control files and to issue the request to start data transfer. Should Output Manage be busy or should the network be experiencing heavier then normal logs, the acknowledgement is delayed. If a timeout occurs the job is aborted and set back to HOLD (or READY if ReReady_out_of_sync_requests has been configured to YES). The minimum timeout is 10 seconds. The default setting is 600 seconds.



HOSTTEXT_LITERAL_PERCENT

If set to Yes, a single % character found in Output Manager profile information is converted to a double %%. If set to No (the default), then a single % character found in Output Manager profile information is left as is.

This is necessary because Output Manager treats a single % as indicating a variable name and single % characters are removed as the data is processed. Therefore, if it is necessary to keep % characters in the data, hosttext_literal_percent should be set to Yes.

ONLY_SHOW_KNOWN_JOB_MSGS

Allows the OM to filter messages based on whether it sent the job for printing. Some Output Manager messages are broadcast to all clients which can result in the same message being posted to the screen multiple times. The options are Yesand No. The default is No.

OTEXT_GUI_ACK=YES

Specifies the OM behavior after receiving an otext wait message. The options are:

RECYCLE_ALLOWED

This parameter controls the client’s reaction to certain error conditions. When set to Yes, the client exits when one of the program monitored error conditions occur. The configuration settings in flexcontrol.cfg for the client determine if and when the client is restarted. Normally FlexConfigure is used to build flexcontrol.cfg and the restart time is set to 1 minute after an unexpected exit.

When set to No the client continues processing without trying to recycle itself.

At the time of writing, the only error condition that supports an automatic recycle is a failure to connect to the Output Manager Data Provider. The recovery includes a RELEASE of Output Manager EM job being processed at the time of the failure. The RELEASE occurs when the client restarts and is limited to once per job. Should the connect failure re‐occur the job is left in HOLD and must be released manually. The default is No.

REREADY_OUT_OF_SYNC_REQUESTS

When to_vip starts working with a job the PIEM job state is set to one of the active states, PENDING, SUBMITTING, etc. Should the job fail to start transfer to Output Manager, to_vip aborts the job and sets the PIEM job state to HOLD. This setting allows to_vip to set the state back to READY and allows an alternate

Yes The otext message is displayed as a User interface pop‐up, giving the operator the option to abort or continue the job.

No The job is paused and the a pop‐up is displayed. To continue the job, the operator needs to right‐click the OM icon and select Continue. The operator can cancel the job at this point by selecting the OM Canceloption.



to_vip to work with the job. It is important to keep in mind that a job can only be set back to READY if no bytes have been transferred.

RESETVIPINPUT

Whether at startup to_vipflex kills and restarts the Output Manager input client it is driving. The options are Yes and No. The default is No.

SKIP_FCB_WHEN_ANSI

Whether om_vip skips sending an FCB in the data stream for LCDS ANSI jobs. If set to Yes, the FCB is not sent. The options are Yes and No. The default is No.

START_AS_IDLE

Controls whether to_vip goes to IDLE state or DRAINED state whenever it is varied online. If Vip_control is set to manage the to_vipflex states (VIPCNTL_MANAGES_CLIENTS=YES), then this field should be set to NO. The options are Yes and No. The default is Yes, starts in idle state.

START_UNSENT_REPORTS

If set to no (the default) then unsent reports do not be re‐started. With the latest version of Output Manager, unsent reports are automatically aborted (when cancelled) and it is not necessary to restart them (and can cause the job to fail if there are too many of them). FlexServer versions prior to 8.5 do not automatically cancel unsent reports, and in such a this flag should be set to yes.

START_VIP_INPUT

Whether to_vipflex attempts to start a Output Manager input client if not started. If set to Yes, the input client is started on Output Manager if a job requiring it is submitted to to_vipflex. The options are Yes and No. The default is No.

VFV_JOB_ID_VIEW

The name of the database view that is used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM job ID. All fields in the view must be string values, apart from vfv_id. There is no default setting.

The Output Manager profile option name is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VFV_MOD_ID_VIEW

The name of the database view used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM mod ID.

There is no default setting.

All fields in the view must be string values, apart from vfv_id. The Output Manager profile option is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VFV_REPORT_ID_VIEW

The name of the database view used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM report ID.




All fields in the view must be string values, apart from vfv_id. The Output Manager profile option is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VIPCNTL_MANAGES_CLIENTS

This option declares whether the vip_cntl module is monitoring to_vipFlex module status. This field should match the setting in the ʺmanageRemoteClientStatesʺ field in the associated vip_cntl module configuration file.

When enabled, to_vipflex is varied on and enabled by vip_cntl only once it has determined the remote VIP clients are ready to accept work. See the vip_cntl default configuration for more information. When configuring VIPCNTL_MANAGES_CLIENTS=YES, then START_VIP_INPUT=NO and START_AS_IDLE=NO.

THE DEFAULT IS VIPCNTL_MANAGES_CLIENTS=NO.VIP_CONNECT_BACKOFF=2000

The time, in milliseconds, between connect attempts to Output Manager for the data and control connections. The default is 2000.

VIP_CONNECT_TIMEOUT=20000

The time in milliseconds by which the connection that has not been made is deemed to have failed. This parameter be larger than vip_connect_backoff. The default is 20000.


APPENDIX E: MGR MONITOR EXAMPLE CONFIGURATION FILE


Appendix E: MGR Monitor Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example MGR Monitor driver configuration file is shown below:

# vipclient.cfg# Example configuration file for the Output Manager Client Monitor Driver# Copy this file to the name of the module.cfg# NOTE: See command-line help as these are the same options# wait_vipcntl is the time in seconds that vip_client delays the # automatic vary on after starting the module. Since vip_client checks # associated vip_control before going online, a delay is required to let# the status of its vip_cntl vary online first. The default value is 10 # seconds.#wait_vipcntl=10# wait_on_drained is the time in seconds that vip_client delays setting the # client status to drained. This allows vip_client to appear Active when it # is processing a series of VIP jobs.##wait_on_drained=1

Configuration file parametersWAIT_ON_DRAINED

The time in seconds that the vip_client delays setting the client status to drained. This allows vip_client to appear Active when processing a series of Output Manager jobs. the default is 1.

WAIT_VIPCNTL

The time in seconds that vip_client delays the automatic vary on after starting the module. Since vip_client checks the status of its associated vip_control before going online, a delay is required to let vip_cntl vary online first. The default value is 10 seconds.

APPENDIX F: OM_VIP EXAMPLE CONFIGURATION FILE

Appendix F: OM_VIP Example Configuration File

Each device on your Output Manager EM system has its own configuration file located in /ops/data and the name of the file is the name of the device with a lower‐case .CFG file extension.

You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example OM_VIP configuration file is shown below:

# om_vip.cfg# Example configuration file for the om_vip Driver# Copy this file to the name of the printer.cfg# NOTE: See command-line help for individual OMs as these are the same # options## NOTE: VIP is the legacy name for PIOM (PI Output Manager) and older # versions are referenced by their legacy name, VIP 8.4, VIP 8.5, etc.

# Turn on debugging#debug=no

# otext_gui_ack# configures the OM behavior after receiving an otext wait message. # If set to YES, a gui pop-up is displayed with the otext message, # The operator will have the opportunity to abort or continue the # job. If set to NO, the job is paused and the pop-up is displayed.# To continue the job, the operator will need to right click on the # OM icon and select the "continue" option. In addition, the operator# can cancel the job at this point by selecting the OM cancel # option.#otext_gui_ack=yes

# filter_vip_msg# Msg codes that are sent from PIOM that can be filtered. Some PIOM# msgs are duplicated in warning as well as abort_continue msgs. The# msg Codes listed are filtered from warnings.#filter_vip_msg=29270

filter_vip_msg=29011

# only_show_known_job_msgs# Allows the OM to filter messages based whether it sent the job for# printing. Some PIOM messages are broadcast to all clients which can# result in the same message being posted to the screen multiple# times.# The default is no.#only_show_known_job_msgs=no

# fast_connect_limit# The number of times that om_vipattempts to connect to the PIOM data# provider client consecutively before sleeping between attempts. # The default value is 0. The number can be increased for faster FSE# workstations where 1000 attempts occur too quickly for the PIOM # server to respond. The number can be reduced if there is a # processing capacity issue on the FSE platform.#fast_connect_limit=0



# vip_connect_backoff# The time in milliseconds between connect# attempts to PIOM for the data and control connections.# The default is 2000.#vip_connect_backoff=2000

# vip_connect_timeout# The time in milliseconds when a connection has not been made and# is deemed to have failed. This must be greater than the# vip_connect_backoff.# The default is 20000.#vip_connect_timeout=20000

# api_retry_DP_connect# When set to YES, the retry of the DP connect using the# vip_connect_timeout and vip_connect_backoff values is performed in# the API. When set to NO, the retries (using the same values) are # done at the application layer. In the NO mode, any pending messages # are read off and processed between retries. This helps prevent the# message system from backing up when a data provider connection # cannot be made immediately.#api_retry_DP_connect=NO

# start_vip_input# Whether om_vip attempts to start a PIOM (VIP) input client if it# is not started. If set to YES, an input client ise started on PIOM# if a job requiring that input client is submitted to om_vip and the# input is not yet started.# The default is "no".#start_vip_input=yes

# reset_vip_output# Whether om_vip kills the output client and then restart it when # om_vip is varied on. This should only be set to YES if the PIOM # (VIP) output client is only driven by FlexServer and is not used # for other PIOM output.# The default is "no".#reset_vip_output=yes

# start_vip_output_wait# Used if reset_vip_output=yes and use_vip_output_state=yes. It# sets the delay in seconds that the vip_output client needs to# become READY after sending the reset_vip_output.# The default is value is 3 seconds.#start_vip_output_wait=3

# vip_output_module# This sets the name of the PIOM (VIP) output exe module. This is# required if reset_vip_output=yes and the output exe module for# PIOM is NOT vdd2ipds.##vip_output_module=vdd2ps#vip_output_module=vdd2pcl#vip_output_module=vdd2meta#vip_output_module=vdd2afp#vip_output_module=vdd2ijpds#vip_output_module=vdd2pdf

# start_as_idle# Whether om_vip goes to IDLE state or DRAINED state whenever it is



# varied online.# The default is NO (will start in drained state).#start_as_idle=no

# use_vip_output_state# Whether om_vip goes OFFLINE when it detects that the PIOM (VIP) # output client of the same name goes offline. When set to YES, it# is not possible to print to the printer unless the PIOM output # client is available and started.# The default is "no".#use_vip_output_state=no

# skip_fcb_when_ansi# Whether om_vip skip send an FCB in the datastream for LCDS ANSI# jobs. When set to YES, it will not send the FCB. # The default is "yes".#skip_fcb_when_ansi=yes

# userlib_in_jobset# Whether om_vip handles userlibs. If set to NO, userlibs are placed # in a PIOM USERSET file. If set to YES, the userlibs are prepended# to the PIOM job set statements.# The default is "no".#userlib_in_jobset=no

# only_space_while_paused# Only allow forward space or back space while the printer is# paused. Required for some IPDS printer that require a paused# printer to forward or backspace reliably. This option is not# checked if auto_pause_before_reposition is set.# The default is "yes"#only_space_while_paused=yes

# auto_pause_before_reposition# Automatically pauses the job when a reposition is requested before # sending the reposition command. When set to Yes, the printer is # autopaused. If set to No, no action is taken with the printer. Note # that this has precedence over the only_space_while_paused option.# The default is "yes"#auto_pause_before_reposition=yes

# auto_continue_after_reposition# Whether the printer is auto continued after a reposition. When set # to Yes, the printer is autocontinued. If set to No, the printer # remains in paused state and the operator will manually have to # resume the job.# Note, both auto_pause_before_reposition and # auto_continue_after_reposition cannot be both enabled unless the # VIP_EXEC supports continue_of_parent_allowed.# The default is "yes"#auto_continue_after_reposition=yes

# continue_of_parent_allowed# Whether the VIP_EXEC supports the CONTINUE command on the parent # ID for multi-report jobs. This is required if both # auto_pause_before_reposition and auto_continue_after_reposition # are enabled. Please check with Emtex support to determine if your # version of vip_exec supports this feature. PIOM and VIP 8.4 SP6 # and above should support this feature. Check with Pitney Bowes



# support to determine if your PIOM or VIP version is compatible.# The default is "yes".#continue_of_parent_allowed=yes

# use_client_state_for_pause# If set to YES, the OM pause state is based on the PIOM client # state. In addition, the client_state is used to remove the pause. # If set to NO, the OM pause state is based on receiving the # processPauseResponse.# The default is "yes".#use_client_state_for_pause=yes

# action_during_cross_job# If pause, abort, and reposition commands can be used while the# printer is in cross job recovery or NPRO.# The default is "no"#action_during_cross_job=no

# match_client_with_virtual_server# Matches PIOM client IP address to a virtual PIOM exec IP address. # This stops false client not ready messages from being generated. # The PIOM client IP address is paired to the PIOM exec IP address # using the t_opha_lookup table. The t_opha_lookup table supports # IP addresses only.# The default is "no".#match_client_with_virtual_server=no### vip_input_timeout# The number of seconds that om_vip waits for a PIOM (VIP) input to # start receiving report data after the job/report is started on # PIOM. This should not be used (or set to a very large value) if # multi-report FSE Postscript jobs or multi-report input VDE jobs # are being run due to the inherent time lag between reports # beginning their input processing. # The default value is 0 (no timeout)#vip_input_timeout=0

# reset_vip_input_timeout# The number of seconds that om_vip waits for a PIOM (VIP) input to # start receiving report data after the job/report is started on # PIOM before attempting a reset of the PIOM input client. This value # should be less than the vip_input_timeout if both are not 0. This # should not be used (or set to a very large value) if multi- report # FSE Postscript jobs or multi-report input VDE jobs are being run # due to the inherent time lag between reports beginning their input # processing.# The default value is 0 (no timeout)#reset_vip_input_timeout=0

# wait_for_output_after_cancel# When set to YES, the OM stays in the busy state (green icon) after# a job is cancelled until the PIOM output driver has finished# flushing its page queue.# The default value is NO.#wait_for_output_after_cancel=NO

# wait_for_npro_after_complete# When set to YES, the OM stays in the busy state (green icon) after # a job is completed until the PIOM output driver has finished # flushing its page queue if the FSE job was not started by AWS.



# The default value is NO.#wait_for_npro_after_complete=NO

# process_input_while_paused # When set to YES, the OM continues to send data to the PIOM input # client when the OM has been paused.# The default value is NO#process_input_while_paused=NO

# audit_current_counts# Writes the output page notify messages from PIOM to the FSE audit # table. This increases the tablespace necessary with additional # audit messages.# The default value is no#audit_current_counts=no

# audit_current_input_counts# Write the input page notify messages from PIOM to the FSE audit # table. This increases the tablespace necessary with additional # audit messages.# The default value is no#audit_current_input_counts=no

# audit_stacked_page_count# If set to YES, the stacked count reported by the vdd2ijet PIOM # output client is audited while printing as well as the final stack # count. Note that the final stack count is the count when the job # ends (end of job). This may be less than the actual count if the # stack count increments after the end of job.# The default is NO.##audit_stacked_page_count = NO

# autoMountForms# Mount the job form on the associated PIOM output client when a job # starts.# The default value is yes.#autoMountForms=yes

# audit_in_seconds# Issue additional audit records with duration in seconds.# The default value is no.#audit_in_seconds=no

# output_start_time_on_active# Report output duration is measured from when PIOM output goes # active for the report.# The default value is no.#output_start_time_on_active=no

# default_native_font# Set the font name used as PIOM DEFAULTNATIVEFONT value when it # cannot be set from the report or OM CHAR1 font value.# The default is X0H20080#default_native_font=X0H20080

# hosttext_literal_percent# How a percent sign (%) is handled when found in PIOM profile # hosttext information. PIOM interprets single % as a parsing # variable while treating %% as a literal single % sign. When



# hosttext_literal_percent = Yes, the % found in PIOM profile # information is converted to %%.# The default value is no.#hosttext_literal_percent=no

# abort_wait_time# Time in seconds to wait before issuing an abort request to PIOM # when PIOM requests an abort/continue response.# The default is 0 (no wait).##abort_wait_time=0

# auto_pause_wait_time# Time in seconds to wait after issuing an automatic repositioning # pause issuing the reposition request to PIOM.# The default is 0 (no wait).##auto_pause_wait_time=0

# verify_reposition# When set to YES, the OM checks if a reposition request exceeds the # side count or the job. If so, a prompt is displayed with a warning# message and an Abort/Continue response option.# The default setting is NO.#verify_reposition=NO

# start_unsent_reports# This option applies to multi-report jobs cancelled while printing. # When set to YES, the OM attempts to start the reports that have # not yet been sent as part of recovery. This option is # provided for legacy purposes and was required for earlier versions # of PIOM. For PIOM and VIP 8.5 and above, the option should be set# to NO.# The default setting is NO.#start_unsent_reports=NO

# dp_idle_signoff_interval# Sets the Data Provider Idle Time Interval. If set greater than 0, # then the om_vip module signs off from PIOM if there has been # no jobs sent to PIOM in the specified interval. If to_vipflex has # signed off from PIOM, it signs back on when the next job is sent # This option should be used if routers between FSE and PIOM # automatically disconnect idle network connections. The value is in # seconds.# The default is 0.#dp_idle_signoff_interval=0

# vfv_job_id_view# Specifies the name of the database view used to set PIOM profile # options if the vfv_id field of the view matches the FSE job id. # All fields in the view except vfv_id must be string values. The # PIOM profile option name is view name + "_" + view field name. The # value is the field string value if it exists.## There is no default setting.#vfv_job_id_view=

# vfv_report_id_view# The name of the database view used to set PIOM profile options if # the vfv_id field of th be s view field name. The value is the field # string value if it exists.# There is no default setting.



#vfv_report_id_view=

# vfv_mod_id_view# The name of the database view used to set PIOM profile options if # the vfv_id field of the view matches the FSE module mod id. All # fields in the view except vfv_id must be string values. The PIOM # profile option name will be view name + "_" + view field name. The # value is the field string value if it exists.# There is no default setting.#vfv_mod_id_view=

# vary_off_stops_vip_clients# When set to YES, om_vip issues a stop for the PIOM (VIP) output # client and all associated PIOM input clients when the om_vip module # is varied off from the GUI. The related PIOM output client name is # the same as the om_vip module name. The PIOM input client names are # AFPn, PSn, PDFn, PCLn, XRXn where n is the Sequence number set up # for the om_vip in FlexConfigure.# The default is NO.#vary_off_stops_vip_clients=NO

# filter_duplicate_vip_warnings# When set to YES, the OM ignores duplicate PIOM (VIP) warning # messages that occur within a filtering window. A duplicate PIOM # warning message issued by PIOM within this window is ignored. # The default setting is NO.#filter_duplicate_vip_warnings=NO

# filter_duplicate_vip_warnings_window# The size of the duplicate PIOM (VIP) warning message filter window # in seconds.# The default value is 300.#filter_duplicate_vip_warnings_window=300

# vip_output_handles_copies# Depending on the version of PIOM (VIP) and which output is used, # the algorithm for determining how many pages/sides have printed is # different. This affects the displayed value only while printing. # After the job has completed, the correct page count, including all # the copies, is displayed and audited correctly. For VIP 8.6, this # value should be set to NO. For PIOM and VIP 8.7 and above using # IPDS out, set the value to YES.# The default is YES.#vip_output_handles_copies=YES

# preview_client# When set to YES, om_vip requests PIOM generate PDF files that are # copied back to the PIEM spool. The GUI is used display the PDF file # in preview mode. When in preview client mode, om_vip is not used # for printing. In addition, the config options # preview_PIOM_target_location and preview_PIEM_source_location must # be set.# The default is NO# preview_client=NO

# preview_PIOM_target_location# Used when preview_client=YES. The path to the directory where PIOM # writes the PDF preview files. This directory is shared shared with # PIEM and both PIOM and PIEM must have read/write access to the # directory. PIEM references this directory as # preview_PIEM_source_location.



# There is no default. A sample value shown below.# preview_PIOM_target_location=P:\

# preview_PIEM_source_location# Used when preview_client=YES. It specifies the path to the # directory where PIEM reads the PDF preview file before copying to # the spool directory. This directory is shared with PIOM and both # PIOM and PIEM must have read/write access to the directory. PIOM # references this directory using preview_PIOM_target_location.# There is no default. A sample value shown below.## preview_PIEM_source_location=/ops/preview

# PostScript jobs with RDWs (usually from mainframe) can cause problems# when the RDW is not replaced with a newline character. In some # situations using the newline causes problems. # The default is No

# addNewlineWithRDW = NO

#END OF CONFIGURATION FILE

Configuration File ParametersABORT_WAIT_TIME

When Output Manager requests an abort/continue response, ABORT_WAIT_TIMEis the time (in seconds) that Output Manager EM waits before issuing an abort request to Output Manager. The default is 0 (no wait).

ACTION_DURING_CROSS_JOB

Whether pause, abort and reposition commands can be performed while the printer is in cross job recovery of NPRO. The options are Yes and No. The default is No.

ADD_NEW_LINE_WITH_RDW

Whether4 to add a new line if RDW is encountered.

API_RETRY_DP_CONNECT

If set to Yes, the retry of the DP connect (using the vip_connect_timeout and vip_connect_backoff values) is performed in the API.

When set to No, the retry (using the same values) is performed in the application layer.

When set to No, any pending messages are read off and processed between retries. This helps prevent the message system from backing up when a data provider connection cannot be made immediately.

AUDIT_CURRENT_COUNTS

Whether to write the output page notify messages from Output Manager to the Output Manager EM audit table. This increases the tablespace necessary with additional audit messages. The options are Yes and No. The default is No.



AUDIT_CURRENT_INPUT_COUNTS

Whether to write the input page notify messages from Output Manager to the Output Manager EM audit table. This increases the tablespace necessary with additional audit messages. The options are Yes and No. The default is No.

AUDIT_IN_SECONDS

Whether to issue additional audit records with duration in seconds.

AUDIT_STACKED_PAGE_COUNT

If set to YES, the stacked count reported by the vdd2ijet PIOM output client is audited while printing as well as the final stack count. Note that the final stack count is the count when the job ends (end of job). This may be less than the actual count if the stack count increments after the end of job. The default is NO.

AUTO_CONTINUE_AFTER_REPOSITION

Whether the printer should be auto continued after a reposition. When set to Yes, the printer is auto‐continued. If set to No, the printer remains in paused state and the operator manually has to resume the job. The options are Yes and No. The default is Yes.

NOTE: Neither auto_pause_before_reposition nor auto_continue_after_reposition can be enabled unless the Output Manager exec supports CONTINUE_OF_PARENT_ALLOWED.

AUTO_PAUSE_BEFORE_REPOSITION

This automatically pauses the job when a reposition is requested before sending the reposition command. When set to Yes, the printer is auto paused. If set to No, no action is taken with the printer.

NOTE: This has precedence over the ONLY_SPACE_WHILE_PAUSED option. The default is Yes.

AUTO_PAUSE_WAIT_TIME

The time (in seconds) Output Manager EM waits after issuing an automatic repositioning request to Output Manager. The default is 0 (no wait).

AUTOMOUNT_FORMS

Whether to mount the job form on the associated Output Manager output client when a job starts. The default is Yes.


This parameter describes the behavior of om_vip after an aborted report is detected in a multi‐report job. If set to Yes, then the remainder of the reports in the job is printed. If set to No, the entire job immediately aborts. The default is Yes.

CONTINUE_OF_PARENT_ALLOWED

Determines if the Output Manager exec supports the CONTINUE command on the parent ID for multi‐report jobs. This is required if both the following are enabled.

AUTO_PAUSE_BEFORE_REPOSITIONand AUTO_CONTINUE_AFTER_REPOSITION



Please check with Customer Support to determine if your version of vip_exec supports this feature. VIP 8.4 SP6 and above should support this feature. Check with Customer Support to determine if your Output Manager version is compatible. The default is Yes.

DEFAULT_NATIVE_FONT

Set the font name used for the Output Manager DEFAULTNATIVEFONT value when it cannot be set from the report or the OM CHAR1 font value. The default is X0H20080.

FAST_CONNECT_LIMIT

The number of times that om_vip tries to connect to the Output Manager data provider client consecutively before sleeping between attempts. For faster Output Manager EM workstations the number can be increased, because 1000 attempts occurs too quickly for the Output Manager server to respond. The number can be reduced if there is a processing capacity issue on the Output Manager EM platform. The default value is 0.

FILTER_DUPLICATE_VIP_WARNINGS

When set to Yes, the OM ignores duplicate Output Manager warning messages that occur within a filtering window.

The default is No.

FILTER_DUPLICATE_VIP_WARNINGS_WINDOW

See FILTER_DUPLICATE_VIP_WARNINGS. The time the filtering window is active (in seconds). The default is 300.

FILTER_VIP_MSG

If this message code is sent from Output Manager, do NOT display the message in a warning. This is because some messages are displayed in warnings and abort_continue messages, producing unnecessary duplication. The default is 29011.

HOSTTEXT_LITERAL_PERCENT

If set to Yes, a single % character found in Output Manager profile information is converted to a double %%. If set to No (the default), then a single % character found in Output Manager profile information is left as is.

This is necessary because Output Manager treats a single % as indicating a variable name and single % characters are removed as the data is processed. Therefore, if it is necessary to keep % characters in the data, hosttext_literal_percent should be set to Yes.

MATCH_CLIENT_WITH_VIRTUAL_SERVER

Whether to match a Output Manager client IP address to a virtual Output Manager exec IP address. This stops false ‘client not ready’ messages being generated. The Output Manager client IP address is paired to the Output Manager exec IP address using the t_opha_lookup table. This table supports IP addresses only. The default is No.



ONLY_SPACE_WHILE_PAUSED

If set to Yes, forward and back space is only allowed when the printer is paused. This is required for some IPDS printer that require a paused printer to forward or backspace reliably. This option is not checked ifAUTO_PAUSE_BEFORE_REPOSITION is set. The default is Yes.

ONLY_SHOW_KNOWN_JOB_MSGS

If set, the OM filters messages about whether it sent the job for printing. This is used because some Output Manager messages are broadcast to all clients resulting in the same message being posted on the screen multiple times. The default is No.

OUTPUT_START_TIME_ON_ACTIVE

Whether or not report output duration is measured from when Output Manager output goes active for the report. The default is No.

OTEXT_GUI_ACK

This configures the OM behavior after receiving an otext wait message. If set to Yes, a gui pop‐up occurs with the otext message. The operator has the opportunity to abort or continue the job. If set to No, the job is paused and no pop‐up displays. To continue the job, the operator needs to right‐click on the OM icon and select the Continue option. The operator can also cancel the job at this point by selecting the OM cancel option. The default is Yes.

PREVIEW_CLIENT

When set to YES, om_vip requests PIOM generate PDF files that are copied back to the PIEM spool. The GUI is used display the PDF file in preview mode. When in preview client mode, om_vip is not used for printing. In addition, the config options preview_PIOM_target_location and preview_PIEM_source_location must be set. The default is NO

PREVIEW_PIEM_SOURCE_LOCATION

Used when PREVIEW_CLIENT=YES. It specifies the path to the directory where PIEM reads the PDF preview file before copying to the spool directory. This directory is shared with PIOM and both PIOM and PIEM must have read/write access to the directory. PIOM references this directory using PREVIEW_PIOM_TARGET_LOCATION. There is no default.

PREVIEW_PIOM_TARGET_LOCATION

Used when PREVIEW_CLIENT=YES. The path to the directory where PIOM writes the PDF preview files. This directory is shared shared with PIEM and both PIOM and PIEM must have read/write access to the directory. PIEM references this directory as preview_PIEM_source_location. There is no default. A sample value is PREVIEW_PIOM_TARGET_LOCATION=P:\

PRINTINGSTATUS

If set to YES, indicates that actual printing is occurring. If set to NO, this indicates that the data is being written to file for transfer to a printer. This parameter is used if audit data is being sent to DFWorks. If set to YES, the audit messages refers to



actual printing. If set to NO, the 1.4 messages refers to data transfer rather than actual printing.

PROCESS_INPUT_WHILE_PAUSED

If set to Yes, the OM continues to send data to the Output Manager input client when the OM has been paused. The default is No.

RESET_VIP_INPUT_TIMEOUT

The number of seconds that om_vip waits (after the job (or report) is started on Output Manager) for the Output Manager input to start receiving report data. If this limit is exceeded, a reset of the Output Manager input client is attempted. This value should be less than the VIP_INPUT_TIMEOUT (unless both are 0). This value should not be used (or at least not set to a very large value) if multi‐report Output Manager EM PostScript or Output Enhancement input jobs are being run, because of the inherent time lag between reports.

The default value is 0 (no timeout).

RESET_VIP_OUTPUT

Whether om_vip kills the output client and restart it when om_vip is varied on. This should only be set to Yes when the Output Manager output client is only driven by Output Manager EM and is not used for other Output Manager output. The default is No.

START_AS_IDLE

If set to Yes, om_vip goes to IDLE state when it is varied online. If set to No, om_vip goes to DRAINED state when varied online. The default is No.

SKIP_FCB_WHEN_ANSI

Whether om_vip skips sending an FCB in the data stream for LCDS ANSI jobs. If set to Yes, it do not send the FCB. If set to No, it sends the FCB. The default is No.

START_VIP_INPUT

Whether om_vip attempts to start a Output Manager input client, if the client is not started already and a job requiring that client has been submitted to om_vip. If set to Yes, it attempts to start the client. If set to No, it does not. The default is No.

START_VIP_OUTPUT_WAIT

This is only used if reset_vip_output and use_vip_output_state are both set to Yes. It sets the delay (in seconds) that the Output Manager output client needs to become READY after sending the reset_vip_output. The default is 3 seconds.

START_UNSENT_REPORTS=NO

If set to no (the default) then un‐sent reports are not re‐started. With the latest version of Output Manager, un‐sent reports are automatically aborted (when cancelled) and it is not necessary to restart them (and can cause the job to fail if there are too many of them). VIP versions prior to 8.5 do not automatically cancel unsent reports, and in such a this flag should be set to Yes.



USE_CLIENT_STATE_FOR_PAUSE

If set to Yes, the OM pause state is based on the Output Manager client state. In addition, the client_state is used to remove the pause. If set to No, the OM pause state is based on receiving the processPauseResponse. The default is Yes.

USE_VIP_OUTPUT_STATE

This controls whether om_vip goes OFFLINE when it detects that the Output Manager output client (of the same name) also goes offline. When set to Yes, it is not possible to print to the printer unless the Output Manager output client is available and started. The default is No.

USERLIB_IN_JOBSET

This controls whether om_vip handles userlibs. If set to Yes, the userlibs is attached (as a prefix) to the Output Manager job set statements. If set to No, then userlib is placed in a Output Manager USERSET file. The default is No.

VARY_OFF_STOPS_VIP_CLIENTS

When set to Yes, om_vip issues a stop for the Output Manager output client and all associated Output Manager input clients when the om_vip module is varied off from the GUI.

The related Output Manager output client name is the same as the om_vip module name.

The Output Manager input client names is AFPn, PSn, PDFn, PCLn, XRXn where n is the sequence number set up for the om_vip in FlexConfigure.

The default value is No.

VERIFY_REPOSITION

If set to Yes, the OM checks if a reposition request exceeds the side count for the job. If so, a prompt is displayed with a warning message, and an abort/continue option.

If set to No, the OM do not do the check. The default is No.

VIP_OUTPUT_HANDLES_COPIES

This parameter is used because the way in which Output Manager (or VIP) calculates the number of pages and sides printed has changed since Output Manager 8.6.

If Output Manager EM is running with VIP 8.6, this field should be set to No.

If running with a more recent version of VIP, or with Output Manager, this field should be set to Yes.

VIP_OUTPUT_MODULE

This parameter defines the name of the Output Manager output exe module.

This is required if RESET_VIP_OUTPUT is set to Yes and the output exe module for Output Manager is NOT vdd2ipds.



VFV_JOB_ID_VIEW

The name of the database view used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM job ID. All fields in the view must be string values, apart from VFV_ID.


The Output Manager profile option name is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VFV_MOD_ID_VIEW

The name of the database view used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM mod ID.

There is no default setting. All fields in the view must be string values, apart from vfv_id. The Output Manager profile option is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VFV_REPORT_ID_VIEW

The name of the database view used to set Output Manager profile options if the vfv_id field of the view matches the Output Manager EM report ID.

There is no default setting. All fields in the view must be string values, apart from vfv_id. The Output Manager profile option is <view name>”_”<view field name>. The value for this option (when it exists) is a string value.

VIP_CONNECT_BACKOFF

The time in milliseconds between connect attempts to Output Manager for the data and control connections. The default is 2000.

VIP_CONNECT_TIMEOUT

The time in milliseconds when a connection that has not been made is deemed to have failed. It must be larger than VIP_CONNECT_BACKOFF. The default is 20000.

VIP_INPUT_TIMEOUT

The number of seconds to wait for the Output Manager input client to connect to the Data Provider socket, before aborting the job. This should not be used (in particular not set to a very large value) if multi‐report input Output Enhancement jobs are being run. A value of 0 means that there is no timeout for a Output Manager input to connect to the Data Provider socket. The default is 0.

VIP_OUTPUT_MODULE

This sets the name of the Output Manager output exe module. This is required if ʺreset_vip_outputʺ is set to Yes and the output exe module for Output Manager is NOT vdd2ipds.

The following values are available in the configuration file:

• vdd2ps• vdd2pcl• vdd2meta• vdd2afp• vdd2ijpds



• vdd2pdf

WAIT_FOR_NPRO_AFTER_COMPLETE

If set to Yes, the OM stays in the busy state (green icon) after the job has completed while the Output Manager output drive is flushing its page queue. This only applies if the Output Manager EM job was not started by AWS. The default value is No.

WAIT_FOR_OUTPUT_AFTER_CANCEL

If set to Yes, the OM stays in the busy state (green icon) after a job has been cancelled while the Output Manager output drive is flushing its page queue.

The default value is No.


APPENDIX G: OM_VIP DEFAULT CONFIGURATION FILE


Appendix G: OM_VIP Default Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. The default OM_VIP configuration file is shown below:

# om_vipflex.cfg# Example configuration file for the om_vipflex Driver# Copy this file to the name of the printer.cfg# NOTE: See command-line help for individual OMs as these are the same# options

# Turn on debugging#debug=no

# wait_vipcntl is the time in seconds that om_vipflex will delay starting# an automatic vary on after starting up. Since om_vipflex checks the# status of its associated vip_cntl before going online, the delay allows# vip_cntl vary online first.# The default value is 10 seconds.#wait_vipcntl=10

# start_as_idle - This parameter controls whether om_vipflex goes to IDLE# state or DRAINED state following a successful vary on.# The default is "no" (will start in drained state).#start_as_idle=no

# print_with_vip_cntl - This parameter sets the primary vip_cntl used for# print operations. It is useful when the om_vipflex is associated# with more than one vip_cntl.# The default is to leave the option commented out in which case the# module name configured by FlexConfigure for this OM is used.#print_with_vip_cntl=name of vip_cntl


See Configuration File Parameters for descriptions of all the parameters that may be used in this file.

APPENDIX H: QM DEFAULT CONFIGURATION FILE

Appendix H: QM Default Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. The default QM configuration file is shown below:

# Default configuration file for QM# Available options are as follows## JobIdLowLimit# lower limit for FSE job IDs (default value of 0)# JobIdHighLimit# upper limit for FSE job IDs (default value of 65535)# ReportIdLowLimit# lower limit for FSE report IDs (default value of 0)# ReportIdHighLimit# upper limit for FSE report IDs (default value of 65535)## Note: High limits must be bigger than the low limits. Default configuration file for QM. Available options are as follows:##### JobIdLowLimit# # lower limit for FSE job IDs. The default value is 0.# JobIdLowLimit = 0##### JobIdHighLimit# upper limit for FSE job IDs. The default value is 65535.# JobIdHighLimit = 65535##### ReportIdLowLimit# lower limit for FSE report IDs. The default value is 0.# ReportIdLowLimit = 0##### ReportIdHighLimit# upper limit for FSE report IDs. The default value is 65535.# ReportIdHighLimit = 65535### Note: High limits must be larger than the Low limits for the above## job and report id settings.###### auditInSeconds = yes# issue end job audit records with seconds duration. The default value is # no.# auditInSeconds = no##### singleClientSelects= no # NO Checks for incoming messages from all clients are done simultaneously.# YES Checks each client separately. Use this option if the QM is # repeatedly reporting connection errors.# The default value is no.# # singleClientSelects = no##### SubmittedCompleteDeleteOk = yes# A job found to be in SUBMITTED status with all of its reports in # COMPLETED status is deleted by the Job Retention processor.# The default value is no.



# SubmittedCompleteDeleteOk = no##### awsAllowsCompleteReports# YES- AWS allows a job with report(s) in the COMPLETED state to be # started. At least one report must be in the READY state. If a report is # in a state other READY or COMPLETE AWS does not start the job. The job # state must be READY.# NO - AWS requires all reports be in the READY state. The job state must # be READY.

# The default value is no.# awsAllowsCompleteReports = no###### UpdateSMF# yes - write SMF records after each job go to COMPLETED.# no - do not write SMF records.# The default value is no.# UpdateSMF=no

Configuration File ParametersNOTE: For the following job and report id all high limits must be larger than the low

limits.

JOBIDLOWLIMIT The lower limit for Output Manager EM job IDs. The default value is 0.

JOBIDHIGHLIMITThe upper limit for Output Manager EM job IDs. The default value is 65535.

REPORTIDLOWLIMITThe lower limit for Output Manager EM report IDs. The default value is 0.

REPORTIDHIGHLIMITThe upper limit for Output Manager EM report IDs. The default value is 65535.

AUDITINSECONDSWhether to issue end job audit records with the duration states in seconds. The options are YES and NO. The default value is NO.

SINGLECLIENTSELECTSWhether incoming messages from all clients are checked. Specify NO to check all clients simultaneously, or YES to check each client separately. Use this option if the QM is repeatedly reporting connection errors. The default value is no.

SUBMITTEDCOMPLETEDELETEOKWhether the Job Retention processor deletes jobs in the SUBMITTED state with all of its reports in a COMPLETED state. The options are YES and NO. The default value is NO, where jobs are not deleted by the Job Retention processor.

AWSALLOWSCOMPLETEREPORTSWhether AWS allows a job with report(s) in the COMPLETED state to be started. At least one report must be in the READY state. If a report is in a state other READY or COMPLETE AWS does not start the job. The job state must be READY.



The options are YES and NO. The default value is NO, where AWS requires the job state and all its reports be in the READY state.

UPDATESMFWhether SMF records are written after each job reaches the COMPLETED state. The options are YES and NO. The default value is NO, where SMF records are not written.


APPENDIX I: BACKUP SERVER EXAMPLE CONFIGURATION FILE

Appendix I: Backup Server Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example Backup Server configuration file is shown below:

###

#####

####

####

####

####

####

####

#########

#####

Default configuration file for backup server

DEBUG = 0This is the number of seconds to wait between PING attempts to the remote server # when the backup server is idle. A failed PING results in the backup server taking itself offlineThe default is 30 seconds.RATE_OF_PING=30.This is the number of seconds the backup server waits for a PING response before considering the PING to have failed. The default value is 30 seconds.PING_TIMEOUT=30This is the number of consecutive failed attempts to transfer jobs that causes the backup server to decide that a general failure has occurred and take itself offline. The default value is 3. FAIL_LIMIT=3This is the number of seconds to wait between transfers of data blocks to the remote host. Increase this value only if the remote host or network is typically busy and you need to throttle data transfer.THROTTLE = 0Use 0 when sending jobs to a pre-R5.2.0 version of Output Manager EM or to Output Manager EM that does not require the use of external binary filesSENDEXTERNALFILES = 1ENCRYPT specifies if encryption should be used when sending the job to the Input Receiver on the remote server. Valid options are YES and NO. The default is NO.ENCRYPT = NOKEY specifies the encryption key used when encrypting the data (if enabled). The KEY is defines as 32 or 64 hexadecimal characters. This key must match the decryption key defined on the remote server.KEY = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6MULTIREC specifies that the remote server supports concurrent encryption and compression. The original IR for R5.18 and R5.2 did not support concurrent compression and encryption. IR releases after R5.2 supports concurrent compression and encryption. Check with the system administrator of the remote Output Manager EM to determine the IR on that system has been updated. If both compression and encryption are enabled and MULTREC is set to NO, then compression will be automatically disabled.MULTIREC = NOQ_SendResource specifies a resource file that must be sent with each job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to



#######

############

#############

####################################

the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_ps specifies a resource file that must be sent with each Postscript job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_ps specifies a resource file that must be sent with each Postscript job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource_ps=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_pdf specifies a resource file that must be sent with each PDF job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource_pdf=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_pcl specifies a resource file that must be sent with each PCL job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource_pcl=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_afp specifies a resource file that must be sent with each AFP job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise,set the resource search path as "$/".



#################

##

##########

#########

#####

##

There can be multiple occurrences of this configuration option.Q_SendResource_afp=/ops/resources/a_resource_name(subdirectory - optional)

Q_SendResource_line specifies a resource file that must be sent with each LINE mode job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource_line=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_lcds specifies a resource file that must be sent with each LCDS job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabledto send resources to the remote Output Manager EM system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as "$/subdirectoryname). Otherwise,set the resource search path as "$/". There can be multiple occurrences of this configuration option.Q_SendResource_meta=/ops/resources/a_resource_name(subdirectory - optional)Q_SendResource_captured indicates whether resources stored in the Robust Resource Capture directory should be sent to the remote Output Manager EM system. Note: Captured resources that are job based are saved in the "CAPTURED" subdirectory. To access them, the resource path must be specified as "$/CAPTURED" in FlexConfigure.Valid values are Yes and No. No is the default value.Q_SendResource_captured=NOQ_SkipVipFiles indicates whether Output Manager files (vipopt/setopt/modopt/incopt) should be sent as resources to the remote Output Manager EM system. Yes is the default value. Q_SkipVipFiles=YESEnd of configuration file for backup_srv



Configuration File ParametersENCRYPT

Whether encryption should be used when sending the job to the Input Receiver on the remote server. Valid options are Yes and No. The default is No.

FAIL_LIMIT

The number of consecutive attempts the backup server will attempt to transfer jobs before it is taken that a general failure has occurred and the backup server will go offline. The default value is 3.

KEY

This specifies the encryption key used when encrypting the data (if enabled). The KEY is defined as 32 or 64 hexadecimal characters. This key must match the decryption key defined on the remote server.

The default is F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6.

MULTIREC

Whether the remote server supports concurrent encryption and compression. The original IR for R5.18 and R5.2 did not support concurrent compression and encryption. IR releases after R5.2 will support concurrent compression and encryption. Check with the system administrator of the remote Output Manager EM to determine that the IR on that system has been updated. If both compression and encryption are enabled and MULTREC is set to No, then compression is automatically disabled. Valid options are Yes and No. The default is No.

PING_TIMEOUT

The number of seconds the backup server will wait for a PING response before the PING is taken to have failed. The default value is 30 seconds.

Q_SENDRESOURCE

This specifies a resource file that must be sent with each job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system.

An optional target subdirectory can be specified by adding (subdirectory name)to the end of the resource name.

If the subdirectory is specified, set the resource search path in FlexConfigure as $/(subdirectoryname). Otherwise, set the resource search path as $/.

There can be multiple occurrences of this option.

The default is /ops/resources/a_resource_name(subdirectory - optional).

Q_SENDRESOURCE_AFP

This specifies a resource file that must be sent with each AFP job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system. An optional target subdirectory can be specified by adding (subdirectory name) to



the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as $/(subdirectoryname). Otherwise, set the resource search path as $/. There can be multiple occurrences of this configuration option.

The default is /ops/resources/a_resource_name(subdirectory ‐ optional).

Q_SENDRESOURCE_CAPTURED

This determines whether resources stored in the Robust Resource Capture directory should be sent to the remote Output Manager EM system.

NOTE: Captured resources that are job based are saved in the CAPTURED

subdirectory. To access them, the resource path must be specified as $/CAPTURED in FlexConfigure. Valid options are Yes and No. No is default.

Q_SENDRESOURCE_LCDS

This specifies a resource file that must be sent with each LCDS job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system.

An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name.


There can be multiple occurrences of this configuration option.


Q_SENDRESOURCE_LINE

This specifies a resource file that must be sent with each LINE mode job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system.





Q_SENDRESOURCE_META

This specifies a resource file that must be sent with each Xerox metacode job sent to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system.







Q_SENDRESOURCE_PCL

This specifies a resource file that must be sent with each PCL job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name.




Q_SENDRESOURCE_PS

This specifies a resource file that must be sent with each PostScript job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name. If the subdirectory is specified, set the resource search path in FlexConfigure as $/(subdirectoryname). Otherwise, set the resource search path as $/.



Q_SENDRESOURCE_PDF

This specifies a resource file that must be sent with each PDF job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system. An optional target subdirectory can be specified by adding (subdirectory name) to the end of the resource name.




Q_SKIPVIPFILES=YES

This indicates whether Output Manager files (vipopt/setopt/modopt/incopt) should be sent as resources to the remote Output Manager EM system. Yes is default.



RATE_OF_PING

The is the number of seconds to wait (when the backup server is idle) between PING attempts to the remote server. A failed PING will result in the backup server taking itself offline. The default is 30 seconds.

SENDEXTERNALFILES

The default value is 1. Change this to 0 when sending jobs to a pre‐R5.2.0 version of Output Manager EM, or one that does not require the use of external binary files.

THROTTLE = 0

The number of seconds to wait between transfers of data blocks to the remote host. Increase this value only if the remote host or network is typically busy and you need to throttle data transfer. The default is 0.


APPENDIX J: IR DEFAULT CONFIGURATION FILE

Appendix J: IR Default Configuration File

The default IR configuration file is named IR.cfg.default. It is located in the following directory:

# Default configuration file for IR# Available options are as follows# service -- the port number or service name to listen on# address -- adapter address to bind to specific tcp/ip adapter# traceLevel -- (1 to 10) level of tracing# traceTableSize -- Size of trace table (1 and 2 have special meanings)# 1 - means use log message test stubs# 2 - means dump trace when DT closes a connection# decryptkey -- the default AES encryption key value (32, 48 or 64# hexadecimal values). This will be used for IP addresses# not covered by dec_ipNN.# dec_keyNN -- encryption key for a specific IP address. NN is a two# digit number between 00 and 19. The NN corresponds# to the NN in dec_ipNN.# dec_ipNN -- the ipaddress or hostname of the client that is# assigned a unique encryption key. Corresponds to# dec_keyNN. The hostname must be known to the FSE server# (DNS, hosts table, etc).#setvendorid -- allows the vendor ID to be populated with a# User Parameter from a job. If the user parameter is# blank then unique job id : unique rprt id is used.# Values are 0 - 15 (corresponding to user parameters)#vendoridsep -- allows the separator in the vendor Id to be specified# in configuration file.only 1 character is supported# the default is : (colon) # Values are 0 - 15 (corresponding to user parameters)# opsi_ebc2asc -- a table of code point overrides to be used for# translating# opsi_ebc2asc -- a table of code point overrides to be used for# translating EBCDIC job information into ASCII. The # table layout is can be found in the DEFAULT.ebc2asc# file in the data directory# timeout -- The timeout value specifies the time that IR would# wait for each connection. IR does not wait for wait # for this much time but distributes this time across# the number of active connections.# retries -- The retries count specifies the number of retries that# the IR needs to make to process each connection. Care # must be taken to specify this value as a large value# for a bad connection might lead to busy waiting for# all the other connections which in turn might just die # out.# allowDuplicate -- duplicate reports may be sent. (valid entries are: Y# or N, default is N)# dupChecksPcFn -- the test for a duplicate report includes a check of# computer file name from which the report data was read.# (valid entries are: Y or N, default is Y)# forceNewUniqId -- forces a new unique ID to be generated by the local# system during a peer to peer transmission.


Windows C:\PB\ENTX.X\data



# (Valid entries are: Y or N, default is N)# JESuniqJobNo Attempt to recover JES2 and JES3 jobs that are# interrupted between reports by matching the host node,# userid, jobname and jobno. Some sites use automated# processes that may use the same jobname, userid and# jobno for all jobs. In this case this should be set# to 'N'. (Valid entries are: Y or N, default is Y)

#service = 4020# address = 172.27.12.14#traceLevel = 5#traceTableSize = 3000#service = 9998# 1 2 3 4 5 6 7# 1234567890123456789012345678901234567890123456789012345678901234567890

#sample keys#decryptkey = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6

#dec_ip can be a hostname or ip address#dec_ip00 = tortompc#dec_key00 = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6F0F1F2F3F4F5F6F7

#dec_ip01 = 192.168.0.100#dec_key01 = 00112233445566778899AABBCCDDEE00# setvendorid allows values sent in user parms to be set in vendorid (0-# 15) there is no default value#setvendorid=0# vendoridsep allows the separator between unique job id and unique rprt# id to be set. Default is : vendoridsep=:#opsi_ebc2asc = DEFAULT# allowDuplicate = N# dupChecksPcFn = Y# ignoredescforfsesscl allows the desc parameter to be ignored by the IR# default is no# ignoredescforfsesscl=No# forceNewUniqId=N# JESuniqJobNo=Y

If you wish to be able to submit jobs to Output Manager EM with duplicate names or data files, the config file must contain the following statement:

allowduplicate=yes

By default the IR use TCP/IP port 4020. On Solaris/Linux Servers the port should be recorded in the file /etc/services with the entry:

OPS_IR 4020/tcp

On Windows servers ensure the firewall has opened 4020 for use by the IR.

Should site requirements dictate a different port is used, update the IR.cfg file and update the ʺservice = ʺ configuration option.

Configuration file parametersADDRESS

The adapter address to bind to specific tcp/ip adapter.



ALLOWDUPLICATE

Allow duplicate reports to be sent. Optiona are Y (yes) and N (no). The default is N.

DEC_KEYNN

The encryption key for a specific IP address. NN is a two digit number between 00 and 19. The NN corresponds to the NN in dec_ipNN.

DEC_IPNN

The ipaddress or hostname of the client that is assigned a unique encryption key. Corresponds to dec_keyNN. The hostname must be known to the FSE server (DNS, hosts table, etc).

DECRYPTKEY

The default AES encryption key value (32, 48 or 64 hexadecimal values). This will be used for IP addresses not covered by DEC_IPNN.

DUPCHECKSPCFN

The test for a duplicate report includes a check of computer file name from which the report data was read. Values are Y and N. The default is Y.

FORCENEWUNIQID

This forces a new unique ID to be generated by the local system during a peer to peer transmission. Values are Y and N. The default is N.

JESUNIQJOBNO

Attempt to recover JES2 and JES3 jobs that are interrupted between reports by matching the host node, userid, jobname and jobno. Some sites use automated processes that may use the same jobname, userid and jobno for all jobs. In this case this should be set to ʹNʹ. Values are Y and N. The default is N.

OPSI_EBC2ASC

A table of code point overrides to be used for translating.

OPSI_EBC2ASC

A table of code point overrides to be used for translating EBCDIC job information into ASCII. The table layout is can be found in the DEFAULT.ebc2asc file in the data directory.

RETRIES

The retries count specifies the number of retries that the IR needs to make to process each connection. Care must be taken to specify this value as a large value for a bad connection might lead to busy waiting for all the other connections which in turn might just die out.



SETVENDORID

Allows the vendor ID to be populated with a User Parameter from a job. If the user parameter is blank then unique job id : un.ique rprt id is used. Values are 0 ‐ 15 (corresponding to user parameters).

SERVICE

The port number or service name on which to listen.

TIMEOUT

The timeout value specifies the time that IR would wait for each connection. IR does not wait for wait for this much time but distributes this time across the number of active connections.

TRACELEVEL

The level of tracing from 1 to 10.

TRACETABLESIZE

The size of trace table, this is one of the following:

1 Use log message test stubs

2 Dump trace when DT closes a connection

VENDORIDSEP

Allows the separator in the vendor Id to be specified in configuration file. Only 1 character is supported the default is : (colon) .


APPENDIX K: OM_LPR EXAMPLE CONFIGURATION FILE

Appendix K: OM_LPR Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example OM_LPR configuration file is shown below:

# om_lpr.cfg# Example configuration file for the om_lpr Driver# Copy this file to the name of the printer.cfg

# Turn on debugging (extra messages printed out)#debug=no

# local mode - test only#local=no

# FORCE_QUEUE# This applies when ops_lpr is used as the lpr driver. By default,# ops_lpr sends the job directly to the network port without internally # spooling the job on Solaris. Setting FORCE_QUEUE=YES, forces lpr to # internally queues the job (including banners) before sending the job to # the printer. # This option can also be used with fselpr if FORCE_QUEUE_TMP_DIR is set. # Default is FORCE_QUEUE=NO.#FORCE_QUEUE=NO

# FORCE_QUEUE_TMP_DIR# When used with fselpr and FORCE_QUEUE=YES, the job will be locally # spooled to the directory specified by FORCE_QUEUE_TMP_DIR. The spooled # job is then passed to fselpr where fselpr can accurately determine the # filesize and communicate this to the LPD server. This will result in # the job being buffered twice so it should only be enabled if the print # CALC_DATA_SIZE and ZERO_FILL_TO_SIZE cannot be used.# Note that the OPS user must have read and write permissions on this # directory. The directory/drive must be sufficiently free space to # handle the largest file to be transferred. The following is a windows # example of the directory. Note that double quotes are required to # encapsulate the field if it contains colons or spaces.#FORCE_QUEUE_TMP_DIR = "C:\PB\opspool\a\tempspool"# The following is a linux/solaris example of the directory. #FORCE_QUEUE_TMP_DIR = /opspool/a/tempspool# Default is blank (not enabled).

# CLEAR_FORCE_QUEUE_STARTUP# If set, the directory pointed to by FORCE_QUEUE_TMP_DIR is cleared of# jobs that match this printer name. The temp spool jobs should be# erased automatically after sending to the printer. This option should# only be required if om_lpr halts due to an error or is recycled while# waiting for fselpr to complete sending the job to the LPD server.# The default is NO.#CLEAR_FORCE_QUEUE_STARTUP = NO

# INTERNAL_COPY_GENERATION determines how copies are generated when # specified. Some printers are capable of generating subsequent copies# from a single supplied copy. If the printer does not support that,# then specify INTERNAL_COPY_GENERATION=YES.# The default is NO.#INTERNAL_COPY_GENERATION=NO

# The title string is passed to the lpr printer. The title string consists# of fixed text as well as replacement parameters. Spaces are not allowed# but underscores and dashes are supported. The replacement parameters



# map to FSE job/printer information. The replacement parameters# supported are# *JOBNO*# *JOBID*# *JOBNAME*# *UNIQJOBID*# *USERROOM*# *GROUPNAME*# *USERID*# *CLASS*# *FORMSID*# *BUILDING*# *DEPARTMENT*# *PRINTER*# *TIME*# *DATE*# *UNIQUEJOBID*# *DESTID*# *JOBTICKET*# *VIRTUALPRINTER*# *USERPARM0*# *USERPARM1*# *USERPARM2*# ...# *USERPARM15*## The default title string is TITLE_STRING=*FORMSID*-*JOBNAME*#TITLE_STRING=*FORMSID*-*JOBNAME*# Allow the use of VP(virtual Printer) instead of the queue assigned to# the printer when VP is populated.# he default is NO#USE_VIRTUAL_PRINTER=NO

# start_as_idle# This parameter controls whether om_lpr goes to IDLE state or DRAINED# state whenever it is varied online.# The default is "no" (will start in drained state).#START_AS_IDLE=NO

# end_report_delay# This is the delay (in seconds) that the output manager delays at the # end of each report before processing the next report.# The default is 15 seconds.#END_REPORT_DELAY=15

# calc_data_size# This configures the output manager to estimate the data size of the# data file (including banners and trailers) and sends this to the# printer. This may be required for some LPD printers that do not accept# a zero data size when sending directly to the printer using STDIN.# The default is NO#CALC_DATA_SIZE=NO

# zero_fill_to_size# This parameter is only valid of CALC_DATA_SIZE=YES. This configures the # lpr driver to zero fill the end of the the data file with zeros if it # is smaller than the calc_data_size. Some LPD daemons may reject the job # unless the data size matches exactly the specified size in the control # file header. This problem was observed when sending jobs using the # Solaris LPD daemon. This should only be set to YES if required by the # driver.# The default is NO#ZERO_FILL_TO_SIZE=NO

# lpr_close_delay# This is a configurable delay between the last data transfer and closing# the printer socket. This may be required for some printers that need# extra time to process the data. Increase this value of the print job# is getting truncated at the end of the job.# The default value is 0 seconds.#LPR_CLOSE_DELAY=0

# x_file_type# This is the prmode print file type for the LPD printer. The 'x' # can



# be one of ps, pcl, pdf, line, or afp. Some LPD daemons use this to# interpret how to format the data. The values are# LEAVE_CONTROL_CHARACTERS, FORMATTED_DATA, and POSTSCRIPT_DATA.# The Default is LEAVE_CONTROL_CHARACTERS.#PS_FILE_TYPE = LEAVE_CONTROL_CHARACTERS#PCL_FILE_TYPE = LEAVE_CONTROL_CHARACTERS#PDF_FILE_TYPE = LEAVE_CONTROL_CHARACTERS#LINE_FILE_TYPE = LEAVE_CONTROL_CHARACTERS#AFP_FILE_TYPE = LEAVE_CONTROL_CHARACTERS

# USE_PDFUNITE# Allows pdf banner to be put on the start and end of pdf jobs. It is# used in conjunction with PDFUNITE_COMMAND.# The default is NO#USE_PDFUNITE = NO

# PDFUNITE_COMMAND# Location of the pdfunite executable (part of poppler Linux package)# used in conjuction with USE_PDFUNITE.# The default is undefined#PDFUNITE_COMMAND = /ops/ENT1.1/Linux/oracle/bin/pdfunite


Configuration File ParametersCALC_DATA_SIZE

Whether Output Manager is to estimate the size of the data file (including banners and trailers) and send this information to the printer. This may be required for some LPD printers that do not accept a zero data size when sending directly to the printer using STDIN. The default is NO.

DEBUG

Whether to turn on debugging. The options are Yes and No. The default is No.

END_REPORT_DELAY

The time (in seconds) that the output manager delays at the end of each report, before processing the next. The default is 15 seconds.

FORCE_QUEUE

This parameter is used when ops_lpr is used as the lpr driver. By default, ops_lpr sends the job directly to the network port without internally spooling the job on Solaris. Setting FORCE_QUEUE=YES, forces lpr to internally queue the job (including banners) before sending it to the printer. The default is NO.

FORCE_QUEUE_TMP_DIR

When used with fselpr and FORCE_QUEUE=YES, the job is locally spooled to the directory the specified this parameter. The spooled job is then passed to fselpr where it accurately determines the filesize and communicates this to the LPD server. This results in the job being buffered twice so it should only be enabled if the print CALC_DATA_SIZE and ZERO_FILL_TO_SIZE cannot be used.

Note that the OPS user must have read and write permissions on this directory. The directory/drive must be have sufficient free space to handle the largest file to



be transferred. The following is a windows example of the directory. Note that double quotes are required to encapsulate the field if it contains colons or spaces.

FORCE_QUEUE_TMP_DIR = "C:\PB\opspool\a\tempspool"

The following is a linux/solaris example of the directory.

FORCE_QUEUE_TMP_DIR = /opspool/a/tempspool

The default is blank (not enabled).

INTERNAL_COPY_GENERATION

This parameter controls how multiple copies of a print are generated. Some printers can produce multiple copies from one copy of the job. If this is the case set INTERNAL_COPY_GENERATION=NO, as only one internal copy of the job is required.

If the printer cannot do this, set INTERNAL_COPY_GENERATION=YES to generate multiple copies of the job internally.

The default is NO.

LOCAL

This parameter is used for testing only. For all live running, it should be set to no. The default is no.

LPR_CLOSE_DELAY

This is a configurable delay between the last data transfer and closing the printer socket. This may be required for some printers that need extra time to process the data. Increase this value of the print job is getting truncated at the end of the job. The default value is 0 seconds.

PDFUNITE_COMMAND

The location of the pdfunite executable, part of poppler Linux package, used in conjuction with USE_PDFUNITE. The default is undefined. An example is shon below:

PDFUNITE_COMMAND = /ops/ENT1.1/Linux/oracle/bin/pdfunite

START_AS_IDLE

If set to Yes, om_vip goes to IDLE state when it is varied online. If set to No, om_vip goes to DRAINED state when varied online. The default is No.

TITLE_STRING

The title string which is passed to the lpr printer. This consists of fixed text and replacement parameters. Spaces are not allowed but underscores and dashes are supported. The replacement parameters map to Output Manager EM job/printer information.

The replacement parameters supported are:

• *JOBNO*

• *JOBID*

• *JOBNAME*

• *UNIQJOBID*



• *USERROOM*

• *GROUPNAME*

• *USERID*

• *CLASS*

• *FORMSID*

• *BUILDING*

• *DEPARTMENT*

• *PRINTER*

• *TIME*

• *DATE*

• *UNIQUEJOBID*

• *DESTID*

• *JOBTICKET*

• *VIRTUALPRINTER*

The default title string is *FORMSID*-*JOBNAME*.

X_FILE_TYPE

The prmode print file type for the LPD printer. The X can be one of ps, pcl, pdf, line, or afp. Some LPD daemons use this to interpret how to format the data. The valid values are LEAVE_CONTROL_CHARACTERS, FORMATTED_DATA, and POSTSCRIPT_DATA. The Default is LEAVE_CONTROL_CHARACTERS.

USE_PDFUNITE

The allows pdf banners to be put on the start and end of pdf jobs. It is used in conjunction with PDFUNITE_COMMAND. The default is NO

USE_VIRTUAL_PRINTER

Allow Output Manager EM to use a virtual printer (VP) instead of the queue assigned to the printer, when VP is populated.

The default is NO.

ZERO_FILL_TO_SIZE

This parameter is only valid of CALC_DATA_SIZE is set to YES. It configures the lpr driver to zero fill the end of the data file if it is smaller than the calc_data_size. Some LPD daemons may reject the job unless the data size matches exactly the specified size in the control file header. This problem was observed when sending jobs using the Solaris LPD daemon. This should only be set to YES if required by the driver. The default is NO.


APPENDIX L: OM_IPP EXTERNAL CLIENT EXAMPLE CONFIGURATION FILE

Appendix L: OM_IPP External Client Example Configuration File

NOTE: In order to send the Xerox datastations (LCDS and metacode) to a Xerox printer with an EPS controller, the Xerox data stream support feature must be licensed from Xerox and enabled.


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example OM_IPP configuration file is shown below:

########################################################################### Output Manager EM IPP OM Configuration File###### For each IPP OM, a configuration file exists on Output Manager EM.# The config file is always located in the /ops/data directory.# The config file is named by the module name associated with the OM with an # extension of {.cfg}.## poll_interval - specifies the polling interval (in seconds) for printer # status. Increase the value to decrease the CPU usage. The default value is # 20.##poll_interval=20## Job_Poll_Interval - specifies the polling interval (in seconds) for job # status# Increase the value to decrease the CPU usage. The default value is 20.##job_poll_interval=20## poll_timeout - specifies the time to wait (in seconds) for a response from# the printer after issuing a request. If a response is not received before # this time, the printer is OFFLINE within Output Manager EM.## The default value is 120.##poll_timeout=120## ipp_get_printer_att_name - specifies the IPP printer name used to build the# printer URI for the IPP command "Get Printer Attributes".## The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and up)## Note: The same setting must be used for both the EQ and the OM for this # printer.##ipp_get_printer_att_name=servlet/IPPServlet.IppPrinter## ipp_default_queue_name - specifies the queue name used to build the# printer URI for the IPP command "Get Printer Attributes". Some IPP



# implementations only responds to Get Printer Attributes if a valid, # existing queue name is used.## The default value is default.## Note: The same setting must be used for both the EQ and the OM for this # printer.##ipp_default_queue_name=default## ipp_get_job_att_name - specifies the IPP printer name used to build the# printer URI for the IPP command "Get Job Attributes".## The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and # up)# Note: The same setting must be used for both the EQ and the OM for this printer.##ipp_get_job_att_name=servlet/IPPServlet.IppPrinter## ipp_job_media_sheets - [YES/NO] specifies whether the printer supports the # IPP job attribute of "job-media-sheets-completed". If it does, then this # value is used to set the completed page counts for a job.## The default value is NO.##ipp_job_media_sheets=NO## ipp_job_impressions - [YES/NO] specifies whether the printer supports the # IPP job attribute of "job-impressions-completed". If it does, then this # value is used to set the completed side counts for a job.## The default value is YES.##ipp_job_impressions=YES## gui_popup_for_interventions - [YES/NO] specifies whether printer # interventions should# generate a pop-up message on the Output Manager EM GUI.## The default value is NO.##gui_popup_for_interventions=NO## update_status_for_printer_reprint - [YES/NO] specifies whether printer # based reprints of a job should update the Output Manager EM job status # when the Output Manager EM job is in the COMPLETED state.## The default value is NO.##update_status_for_printer_reprint=NO## warn_on_printer_reprint - [YES/NO] specifies whether a GUI pop-up message# should be presented whenever a printer based reprint of an Enterprise # Manager job is done.## The default value is NO.##warn_on_printer_reprint=NO## force_intervention_timeout - specifies the time in seconds to wait for the# printer to start a job from the idle state. If the printer has not started# printing within this time, the printer is treated as if it in the an # Attention Required# state.#



# The default value is 300. A value of 0 means no timeout occurs##force_intervention_timeout=300## audit_current_page_count_interval - specifies how often (in seconds) that # the current page count audit record should be written.## The default value is 0 (no current page count audit records are written).##audit_current_page_count_interval=0## audit_current_side_count_interval - specifies how often (in seconds) that # the current side count audit record should be written.## The default value is 0 (no current side count audit records are written).##audit_current_side_count_interval=0## ipp_start_ripping_time_att_name - specifies the name of the IPP job # attribute that indicates what time the ripping process started for a job. # This value is used to calculate the ripping time for the job.## There is no default value. Not all printers have this attribute support.##ipp_start_ripping_time_att_name=none## ipp_end_ripping_time_att_name - specifies the name of the IPP job attribute # that indicates what time the ripping process ended for a job. This value is # used to calculate the ripping time for the job.## There is no default value. Not all printers have this attribute support.##ipp_end_ripping_time_att_name=none## ipp_start_marking_time_att_name - specifies the name of the IPP job # attribute that indicates what time the marking process started for a job. # This value is used to calculate the print time for the job.## There is no default value. Not all printers have this attribute support.# If ipp_start_marking_time_att_name/ipp_end_marking_time_att_name is not # available on the printer, then the "print time" is the difference between # the IPP date-time-at-completed attribute value and the IPP date-time-at-# processing attribute value###ipp_start_marking_time_att_name=none## ipp_end_marking_time_att_name - specifies the name of the IPP job attribute # that indicates what time the marking process ended for a job. This value is # used to calculate the print time for the job.## There is no default value. Not all printers have this attribute support.# If ipp_start_marking_time_att_name/ipp_end_marking_time_att_name is not # available on the printer, then the "print time" is the difference between # the IPP date-time-at-completed attribute value and the IPP date-time-at-# processing attribute value###ipp_end_marking_time_att_name=none## dump_ipp_attributes - [YES/NO] specifies whether the IPP command attributes # and the printer response attributes should be written into the process log.# Note that the log level must also be set to 10.## The default value is NO.##dump_ipp_attributes=NO



## ignore_stop_pause - [YES/NO] specifies whether the printer state of stopped # with a reason of paused should be ignored. Some Xerox printers always # report stopped/paused regardless of the actual printer state. If YES is # specified, then the total-impressions count is used to determine if the# printer is idle or printing## The default is NO##ignore_stop_pause=NO## ipp_printer_total_impressions_att_name - specifies the total impressions # IPP printer attribute name. Not all printer support this attribute although # if a Xerox printer supports it, it is total-impressions## There is no default value.##ipp_printer_total_impressions_att_name=## keep_online - The number of seconds between attempts to go online if the OM # client is offline. If the value is 0, no automatic attempts is made to go# online when the OM is in the offline state##keep_online=0# END OF CONFIGURATION FILE

Configuration File ParametersAUDIT_CURRENT_PAGE_COUNT_INTERVAL

Specifies how often (in seconds) that the current page count audit record should be written. The default value is 0 (no current page count audit records are written).

AUDIT_CURRENT_SIDE_COUNT_INTERVAL

Specifies how often (in seconds) that the current side count audit record should be written. The default value is 0 (no current side count audit records are written).

DUMP_IPP_ATTRIBUTE

Specifies whether the IPP command attributes and the printer response attributes should be written into the process log.

NOTE: The log level must also be set to 10.

The value can be YES or NO. The default is NO.

FORCE_INTERVENTION_TIMEOUT

Specifies the time in seconds to wait for the printer to start a job from the idle state. If the printer has not started printing within this time, the printer is treated as if it is in the an Attention Required state.

The default value is 300. A value of 0 means no timeout occurs.

GUI_POPUP_FOR_INTERVENTIONS

Specifies whether printer interventions should generate a pop‐up message on the Output Manager EM GUI.




IGNORE_STOP_PAUSE

Specifies whether the printer state of stopped with a reason of paused should be ignored. Some Xerox printers always report stopped/paused regardless of the actual printer state. If YES is specified, then the total‐impressions count is used to determine if the printer is idle or printing.


IPP_DEFAULT_QUEUE_NAME

Specifies the queue name used to build the printer URI for the IPP command Get Printer Attributes. Some IPP implementations only responds to Get Printer Attributes if a valid, existing queue name is used.

The default value is default.

NOTE: The same setting must be used for both the EQ and the OM for this printer.

IPP_END_MARKING_TIME_ATT_NAME

Specifies the name of the IPP job attribute that indicates what time the marking process ended for a job. This value is used to calculate the print time for the job.

There is no default value. Not all printers have this attribute support.

If ipp_start_marking_time_att_name/ipp_end_marking_time_att_name is not available on the printer, then the ʺprint timeʺ is the difference between the IPP date-time-at-completed attribute value and the IPP date-time-at-processing attribute value.

IPP_END_RIPPING_TIME_ATT_NAME

Specifies the name of the IPP job attribute that indicates what time the ripping process ended for a job. This value is used to calculate the ripping time for the job.


IPP_GET_JOB_ATT_NAME

Specifies the IPP printer name used to build the printer URI for the IPP command Get Job Attributes.

The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version and above).


IPP_GET_PRINTER_ATT_NAME

Specifies the IPP printer name used to build the printer URI for the IPP command Get Printer Attributes.

The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and up).




IPP_JOB_IMPRESSIONS

Specifies whether the printer supports the IPP job attribute of job‐impressions‐completed. If it does, then this value is used to set the completed side counts for a job.

The value can be YES or NO. The default is YES.

IPP_JOB_MEDIA_SHEETS

Specifies whether the printer supports the IPP job attribute of job‐media‐sheets‐completed. If it does, then this value is used to set the completed page counts for a job.


IPP_PRINTER_TOTAL_IMPRESSIONS_ATT_NAME

Specifies the total impressions IPP printer attribute name. Not all printers support this attribute although if a Xerox printer supports it, it is total‐impressions.

There is no default value.

IPP_START_MARKING_TIME_ATT_NAME

Specifies the name of the IPP job attribute that indicates what time the marking process started for a job. This value is used to calculate the print time for the job.


If ipp_start_marking_time_att_name/ipp_end_marking_time_att_name is not available on the printer, then the ʺprint timeʺ is the difference between the IPP date-time-at-completedattribute value and the IPP date-time-at-processing attribute value.

IPP_START_RIPPING_TIME_ATT_NAME

Specifies the name of the IPP job attribute that indicates what time the ripping process started for a job. This value is used to calculate the ripping time for the job.


JOB_POLL_INTERVAL

Specifies the polling interval (in seconds) for the job status. Increase the value to decrease the CPU usage. The default value is 20.

KEEP_ONLINE

The number of seconds between attempts to go online if the OM client is offline. If the value is 0, no automatic attempts is made to go online when the OM is in the offline state.

POLL_INTERVAL

Specifies the polling interval (in seconds) for the printer status. Increase the value to decrease the CPU usage. The default value is 20.



POLL_TIMEOUT

Specifies the time to wait (in seconds) for a response from the printer after issuing a request. If a response is not received before this time, the printer is OFFLINE within Output Manager EM. The default value is 120.

UPDATE_STATUS_FOR_PRINTER_REPRINT

Specifies whether printer based reprints of a job should update the Output Manager EM job status when the Output Manager EM job is in the COMPLETED state.

Values can be YES or NO. The default value is NO.

WARN_ON_PRINTER_REPRINT

Specifies whether a GUI pop‐up message should be presented whenever a printer based reprint of an Output Manager EM job is done.Values can be YES or NO. The default value is NO.


APPENDIX M: IPP EXTERNAL QUEUE EXAMPLE CONFIGURATION FILE

Appendix M: IPP External Queue Example Configuration File

NOTE: In order to send the Xerox datastations (LCDS and metacode) to a Xerox printer with an EPS controller, the Xerox data stream support feature must be licensed from Xerox and enabled.


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example external queue IPP configuration file is shown below:

########################################################################### Output Manager EM IPP External Queue Configuration File### For each IPP External Queue, a configuration file exists on Enterprise # Manager.# The config file is always located in the /ops/data directory.# The config file is named by the module name associated with# the EQ with an extension of {.cfg}.## BUFFER LARGEBLOCKSIZE is the nominal block size of data that is transmitted# to IPP Printer when downloading jobs (except for LCDS). If a record is # smaller, it is buffered until LARGEBLOCKSIZE is reached.##BUFFER LARGEBLOCKSIZE 65536# USE FSE_BANNER_IF_COPIES specifies if Output Manager EM banners pages is# used if multiple copies are indicated. Possible values are "Yes" and "No". # "No" is default. Note that this parameter has no effect if only one copy of # the job is required.## NO - The Output Manager EM banners and trailers is suppressed and # Output Manager EM optimizes the printing of the job. Only one copy of the # job is sent to the IPP printer. The Printer rasterizes the job only once but # print as many copies of the ripped job as required.# This should result in reduced CPU and Network utilization. The job # should also be ready for printing earlier.## YES - The Output Manager EM banners and trailers is sent. Enterprise # Manager internally queues as many copies of the job as required.##USE FSE_BANNER_IF_COPIES NO## PRINTER_ONLINE - specifies whether the printer must be online for job# submission.## YES - default. The External Queue verifies that the printer is ONLINE# when a job is submitted. If the printer is OFFLINE, the job is put# on HOLD, a warning message is posted and the external queue also# goes OFFLINE. This option is more secure since the job cannot be# submitted unless the auditing is available.## NO - The External Queue still checks if the printer is ONLINE.# If the Printer is OFFLINE, a warming message is posted but the job# is still submitted. The auditing for the job is delayed until the # printer is ONLINE.##USE PRINTER_ONLINE YES



## PRINTER_PAGE_RANGE - specifies whether to use the printer page range # support## YES - default. Use printer based page range support## NO - generate page range jobs internally. Only Postscript jobs are # supported.##PRINTER_PAGE_RANGE YES## CHUNKED_DATA - specifies whether the printing device accepts chunked IPP# data## YES - The printer accepts chunked data## NO - Default. Do not send chunked data. All job/attribute data is# written to a temporary file before being sent.##USE CHUNKED_DATA NO## TEMP_FILE_PATH - specifies the directory path for temporary files###USE TEMP_FILE_PATH /ops/tmp## IPP_GET_PRINTER_ATT_NAME - specifies the IPP printer name used to build the# printer URI for the IPP command "Get Printer Attributes".## The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and # up)# Note: The same setting must be used for both the EQ and the OM for this # printer.##USE IPP_GET_PRINTER_ATT_NAME servlet/IPPServlet.IppPrinter## IPP_DEFAULT_QUEUE_NAME - specifies the queue name used to build the printer # URI for the IPP command "Get Printer Attributes". Some IPP implementations# only responds to Get Printer Attributes if a valid, existing queue name is # used.## The default value is default.## Note: The same setting must be used for both the EQ and the OM for this # printer.##USE IPP_DEFAULT_QUEUE_NAME default## IPP_GET_JOB_ATT_NAME - specifies the IPP printer name used to build the# printer URI for the IPP command "Get Job Attributes".## The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and # up)## Note: The same setting must be used for both the EQ and the OM for this # printer.##USE IPP_GET_JOB_ATT_NAME servlet/IPPServlet.IppPrinter## LOG_IPP_ATTRIBUTES - specifies if the IPP attributes used in IPP commands# should be written to the process log. Note that the log level must also be # set to 10.## YES - write attribute details to the process log## NO - default.



##USE LOG_IPP_ATTRIBUTES NO## TIMEOUT_FACTOR - specifies a number used to factor against the report size# to set a IPP reply timeout when sending a job to the printer.## The default value is 1000##USE TIMEOUT_FACTOR 1000## LPS_QUEUE_NAME - the printer queue that has been set up to handle LCDS/# metacode datastations sent by this External Queue module. This queue should # be set up to use a JDL of "OPS" and a JDE of "DFLT".# The queue must be set up for the exclusive use of this EQ.# More than one LPS_QUEUE_NAME can be specified if more than one queue is to # be used for LCDS/metacode data. If an LCDS/metacode job is sent and the # selected queue is one specified in a USE LPS_QUEUE_NAME entry, then the job # is sent to that queue. If the queue name specified is not an LPS_QUEUE_NAME # queue, then the job is sent to the first LPS_QUEUE_NAME specified in this # configuration file.## If the LPS_QUEUE_NAME queue is associated with a streaming network port,# then add the port number after the name separated by a colon (":").# For example, if FSE_LPS is associated with port 9100, then you would# specify## USE LPS_QUEUE_NAME FSE_LPS:9100##USE LPS_QUEUE_NAME FSE_LPS## LPS_IDLE_TIMEOUT - the number of seconds to wait before aborting an idle# service module. A service module is considered idle if it is no longer # updating the report page count while it is sending the Output Manager EM # job/report to the printer.## The default value is 0 (no idle checking is done)##USE LPS_IDLE_TIMEOUT 0## LPS_SOCKET_ID_LOOKUP - the number of seconds to wait before attempting# to determine the job id for a LCDS/metacode job sent to the printer# streaming port.## The default value is 60##USE LPS_SOCKET_ID_LOOKUP 60## SERVICE_INACTIVITY_INTERVENTION - the number of seconds that the streaming # LCDS/metacode port must be idle during job submission before the EQ is # placed into an intervention state.##USE SERVICE_INACTIVITY_INTERVENTION 60# USE TITLE_STRING list - Allows the jobname that is sent to the printer to be# comprised of parameters from the job or report queue. The list may include# *JOBNAME*# *JOBID*# *USERROOM*# *GROUPNAME*# *USERID*# *CLASS*# *FORMSID*# *BUILDING*# *DEPARTMENT*# *PRINTER*# *TIME*# *DATE*# *DESTID*



# For example, if the title string consists of *USERID*_*JOBID*, then# the userid and jobid are extracted from the job table and replace *USERID* # and *JOBID* in the jobname.## Note that the total jobname length cannot exceed the MAX_TITLE_LEN.# Currently the MAX_TITLE_LEN cannot exceed 64 characters. If the total title # length exceeds MAX_TITLE_LEN, then the title is truncated to fit.## The default value is *JOBNAME* (use Output Manager EM job name as the # printer job name)##USE TITLE_STRING *JOBNAME*# USE MAX_TITLE_LEN - sets the maximum job name size.## The default value is 64.##USE MAX_TITLE_LEN 64#########################################################################

Configuration File ParametersBUFFER LARGEBLOCKSIZE

The nominal block size of data that is transmitted to the IPP Printer when downloading jobs (except for LCDS). If a record is smaller, it is buffered until LARGEBLOCKSIZE is reached.

CHUNKED_DATA

Specifies whether the printing device accepts chunked IPP data.

If set to YES, the printer accepts chunked data.

If set to NO, do not sent chunked data. All job/attribute data is written to a temporary file before being sent.

NO is default.

FSE_BANNER_IF_COPIES

This specifies if Output Manager EM banners pages is used if multiple copies are indicated.

If set to YES the Output Manager EM banners and trailers is sent. Output Manager EM internally queues as many copies of the job as required.

If set to NO the Output Manager EM banners and trailers is suppressed and Output Manager EM optimizes the printing of the job. Only one copy of the job is sent to the IPP printer. The printer rasterizes the job only once but print as many copies of the ripped job as required. This should result in reduced CPU and Network utilization. The job should also be ready for printing earlier.

NO is default.

IPP_DEFAULT_QUEUE_NAME

Specifies the queue name used to build the printer URI for the IPP command Get Printer Attributes. Some IPP implementations only responds to Get Printer Attributes if a valid, existing queue name is used.

The default value is default.




IPP_GET_JOB_ATT_NAME

Specifies the IPP printer name used to build the printer URI for the IPP command Get Job Attributes.

The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version 5 and up).


IPP_GET_PRINTER_ATT_NAME

Specifies the IPP printer name used to build the printer URI for the IPP command Get Printer Attributes.

The default value is servlet/IPPServlet.IppPrinter (Xerox EPS version and up).


LOG_IPP_ATTRIBUTES

This specifies if the IPP attributes used in IPP commands should be written to the process log.

NOTE: The log level must also be set to 10.

If set to YES, write attribute details to the process log.

If set to NO, do not write attribute details to the process log.

NO is default.

LPS_IDLE_TIMEOUT

The number of seconds to wait before aborting an idle service module. A service module is considered idle if it is no longer updating the report page count while it is sending the Output Manager EM job/report to the printer.

The default value is 0 (no idle checking is done).

LPS_QUEUE_NAME

The printer queue that has been set up to handle LCDS/metacode datastations sent by this External Queue module. This queue should be set up to use a JDL of ʺOPSʺ and a JDE of ʺDFLTʺ. The queue must be set up for the exclusive use of this EQ.

More than one LPS_QUEUE_NAME can be specified if more than one queue is to be used for LCDS/metacode data. If a LCDS/metacode job is sent and the selected queue is one specified in a USE LPS_QUEUE_NAME entry, then the job is sent to that queue. If the queue name specified is not an LPS_QUEUE_NAME queue, then the job is sent to the first LPS_QUEUE_NAME specified in this configuration file.



If the LPS_QUEUE_NAME queue is associated with a streaming network port, then add the port number after the name separated by a colon (ʺ:ʺ). For example, if FSE_LPS is associated with port 9100, then you would specify:

USE LPS_QUEUE_NAME FSE_LPS:9100

LPS_SOCKET_ID_LOOKUP

The number of seconds to wait before attempting to determine the job id for a LCDS/metacode job sent to the printer streaming port.

The default value is 60.

MAX_TITLE_LEN

This sets the maximum job name size.

The default is 44. This is also the maximum value allowed.

PRINTER_ONLINE

This specifies whether the printer must be online for job submission.

If set to YES, the external queue verifies that the printer is ONLINE when a job is submitted. If the printer is OFFLINE, the job is put on HOLD, a warning message is posted and the external queue also goes OFFLINE. This option is more secure since the job cannot be submitted unless the auditing is available.

If set to NO, the external queue still checks if the printer is ONLINE. If the Printer is OFFLINE, a warming message is posted but the job is still submitted. The auditing for the job is delayed until the printer is ONLINE.

YES is default.

PRINTER_PAGE_RANGE

Specifies whether to use the printer page range support.

If set to YES, printer based page range support is used.

If set to NO, the page range jobs is generated internally. Only PostScript jobs are supported in this case.

YES is default.

SERVICE_INACTIVITY_INTERVENTION

The number of seconds that the streaming LCDS/metacode port must be idle during job submission before the EQ is placed into an intervention state.

TEMP_FILE_PATH

Specifies the directory path for temporary files

TIMEOUT_FACTOR

Specifies a number used to factor against the report size to set an IPP reply timeout when sending a job to the printer.

The default value is 1000.



TITLE_STRING

The job name which is passed to the printer. This consists of parameters from the job or report queues. Spaces are not allowed but underscores and dashes are supported.


• *JOBNAME*

• *JOBID*

• *USERROOM*

• *GROUPNAME*

• *USERID*

• *CLASS*

• *FORMSID*

• *BUILDING*

• *DEPARTMENT*

• *PRINTER*

• *TIME*

• *DATE*

• *DESTID*

The default title string is *FORMSID*‐*JOBNAME*.

For example, if the title string consists of *USERID*_*JOBID*, then the userid and jobid are extracted from the job table and replace *USERID* and *JOBID* in the jobname.

NOTE: The total jobname length cannot exceed the value set by MAX_TITLE_LEN. Currently MAX_TITLE_LEN cannot exceed 64 characters. If the total title length exceeds MAX_TITLE_LEN, then the title is truncated to fit.

The default value is *JOBNAME* (use the Output Manager EM job name as the printer job name).


APPENDIX N: OM_XFER EXAMPLE CONFIGURATION FILE

Appendix N: OM_XFER Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example OM_XFER configuration file is shown below:

# OMXFER configuration and mapping file

# If you want to use the mapping to send jobs to different ftp servers # set FTP_MAPPING to true. The default is FALSE#FTP_MAPPING=TRUE

# If FTP_MAPPING is set to true then specify the user parameters used to # provide the ftp credentials. If any of the user parameters is NULL the # default value would be used.# The default is the value specified in the "Specific" tab of the OM # configuration.# FTP_MACHINE=UP_0# FTP_USERNAME=UP_1# FTP_PASSWORD=UP_2# FTP_DIRECTORY=UP_3#FTP_RDW=UP_4

# The title string is passed to the ftp server. The title string can # consists of fixed text as well as replacement parameters. Spaces are# not allowed but underscores and dashes are supported. The# replacement parameters map to FSE job/printer information. The # replacement parameters supported are:# *JOBNO*# *JOBID*# *REPORTID*# *EXT*# *JOBNAME*# *UNIQJOBID*# *UNIQREPORTID*# *USERROOM*# *GROUPNAME*# *USERID*# *CLASS*# *FORMSID*# *BUILDING*# *DEPARTMENT*# *PRINTER*# *TIME*# *DATE*# *UNIQUEJOBID*# *DESTID*# *JOBTICKET*# *VIRTUALPRINTER*# *USERPARM0*# *USERPARM1*# *USERPARM2*# ...



# *USERPARM15*# *VENDORID*## The default title string is TITLE_STRING=*JOBNAME*-*REPORTID*.*EXT*# TITLE_STRING=*JOBNAME*-*REPORTID*.*EXT*## POLL_INTERVAL - specifies the polling interval (in seconds) for # printer status.Increase the value to decrease the CPU usage.# The default value is 5.#POLL_INTERVAL=5

# If you specify a drive letter in the target path, that is the # # 'Directory' field in FlexConfigure's Specific tab starts with a drive,# this option is ignored. If no drive letter is specified, omxfer # assumes the target is a UNC. With UNC targets, omxfer uses a system # call to link to the target. Once the print file has been tranfered # omxfer releases the link. If you have more than one omxfer writing to # the same target, that is the 'Directory' field in FlexConfigure's # Specific tab is a UNC location and the same value has been entered for # two or more omxfer, you must specify a different drive letter in each # omxfer's config file by filling in a letter in the MAP_TO_DRIVE entry. # To allow omxfer to automatically select the ‘next available' drive # letter use "MAP_TO_DRIVE=?". When '?' is specified, omxfer tries 'Z', # then 'Y', and continues until a free drive letter is found.# Default is '', do not map UNC locations to drive letters.#MAP_TO_DRIVE=

# Specify the number bytes that may be transferred before a sleep of# SLEEP_TIME seconds is executed. A Suffix of 'K', 'M', or 'G' for# kilo bytes, mega bytes or giga bytes may be added the number.#BYTES_TRANSFERRED=0

# Specify the number of seconds to sleep after BYTES_TRANSFERRED bytes# of data have been transferred.#SLEEP_TIME=0

# Specify the number of seconds to sleep after a report has completed# transfer.#REPORT_END_SLEEP_TIME=0

# (DirectCopy only) should the release of a network resource fail,# om_xfer sleeps a second and retry the release. The process is repeated # 'RELEASE_WAIT" times.# The default is 3.#RELEASE_WAIT=3

# A failed transfer forces om_xfer to moved the the drained state. Set# this to YES if you are using om_xfer in AWS mode and you do not want# om_xfer to try to send jobs after a previous tranfer has failed.# The default value is YES.#DrainOnError=YES

# Set to YES to move om_xfer to AWS mode as soon as FSE starts up.# The default is NO.#START_AS_IDLE=NO

# The number of times to try to restart a failed transfer. If the retry# limit is reached the job is placed in HOLD.# The default is 0.#RETRY_TRANSFER_MAXIMUM=0



# The number of seconds to wait before trying to restart a failed# transfer. RETRY_TRANSFER_MAXIMUM must be set greater than 0.# The default is 5#RETRY_TRANSFER_WAIT=5

# Allow om_xfer to ignore transfer failures of the *.nfo file. The nfo# file contains information on the characteristics of the FSE job.# The default is value to NO.#IGNORE_INFO_CLOSE_ERROR=NO

# Suppress the creation of the NFO file# The Default is No#SUPPRESS_NFO=NO

# Suppress the creation of the CTL file# The Default is No (This file is never created with DirectCopy)#SUPPRESS_CTL=NO

# SSH2_PREF_KEX -sets the SSH2 preferred methods for key exchange for# SFTP.# Note that is is a preference only and be ignored if the server side# does not accept the request. Possible values are ## diffie-hellman-group1-sha1# diffie-hellman-group14-sha1# diffie-hellman-group-exchange-sha1## SSH2_PREF_KEX=diffie-hellman-group14-sha1

# SSH2_PREF_HOSTKEY -sets the SSH2 preferred methods for hostkey for # sftp. Possible values are: # ssh-dss# ssh-rsa##SSH2_PREF_HOSTKEY=ssh-rsa

# SSH2_PREF_CRYPT - sets the SSH2 preferred encryption method for SFTP.# Note that is is a preference only and be ignored if the server side# does not accept the request. Possible values are: # aes256-cbc# [email protected]# aes192-cbc# aes128-cbc# blowfish-cbc# arcfour# cast128-cbc# 3des-cbc# aes128-ctr# aes192-ctr# aes256-ctr# arcfour128##SSH2_PREF_CRYPT=aes128-ctr

# SSH2_PREF_MAC - sets the SSH2 preferred Message Authentication Code# algorithm. The possible values are:## hmac-sha1 (SHA-1 with 20-byte digest and key lenggth)# hmac-sha1-96 (SHA-1 with 20-byte key length and 12-byte digest



# length)# hmac-md5 (MD5 with 16-byte digest and key length)# hmac-md5-96 (MD5 with 16-byte key length and 12-byte digest# length)# hmac-ripemd160 (RIPEMD-160 algorithm with 20-byte digest length)# [email protected]# (Alias for hmac-ripemd160)# none##SSH2_PREF_MAC=hmac-sha1

# SSH2_PREF_COMP - sets the preferred compression method for SFTP. # Please note that this is a preference only and may not be supported by# the SFTP server. In addition:# - the amount of compression varies depending on the datastreeam. # - this can increase CPU usage# - for connections with high bandwidth, it may be faster to run without # compression.# Possible values are zlib or none## The default is none#SSH2_PREF_COMP=none

Configuration File ParametersBYTES_TRANSFERRED

The amount of data (in kilobytes, megabytes or gigabytes) that is transferred before a sleep is executed.

The following suffixes can be used with this parameter:

The time of the sleep is determined by SLEEP_TIME.

DRAINONERROR

This parameter only applies in AWS mode.

If set to Yes, om_xfer do not attempt to send jobs after a previous transfer has failed.

If set to No, om_xfer attempts to try and send jobs after a previous transfer has failed.

FTP_MAPPING

Whether or not user parameter mapping is used to send jobs to different FTP servers. Options are TRUE and FALSE. The default is FALSE.

K Bytes transferred in Kilobytes

M Bytes transferred in Megabytes

G Bytes transferred in Gigabytes



If FTP_MAPPING is TRUE, the following parameters are used to specify the FTP credentials:

Example:

FTP_MACHINE=UP_0

The value in user parameter 0 (the first user parameter) is used to specify the FTP machine.

For each of these values, if the user parameter contains a null string, the default value is what was specified in the Specific tab of the OM configuration.

IGNORE_INFO_CLOSE_ERROR

Whether OM_XFER ignores the failure of the *.NFO file to transfer. This file contains information on the characteristics of the Output Manager EM job. Options are YES and NO. The default is NO.

MAP_TO_DRIVE

This option is used when the Directory field in the Output Manager EM Specific tab does NOT contain a drive letter. In such a case, the software assumes the target is a UNC path and use this parameter when determining the drive letter to use. The options are:

This parameter is only applicable on Windows based operating systems.

POLL_INTERVAL

The polling interval (in seconds) for the printer status. Increase the value to decrease the CPU usage. The default value is 20.

REPORT_END_SLEEP_TIME

The number of seconds to sleep after a report has completed transferring.

RELEASE_WAIT

This applies with DirectCopy only. If the release of a network resource fails, OM_XFER waits a second and then retry the release. RELEASE_WAIT determines how many times this happens. The default is 3 times.

FTP_DIRECTORY The user parameter that specifies the FTP directory.

FTP_MACHINE The user parameter that specifies the FTP machine.

FTP_PASSWORD The user parameter that specifies the FTP password.

FTP_RDW The user parameter that specifies the FTP read/write access.

FTP_USERNAME The user parameter that specifies the FTP user name.

? OM_XFER tries the Z, then the Y drive and continues in reverse alphabetical order until a free drive letter is found.

(1 space) Do not map UNC locations to drive letters.



RETRY_TRANSFER_MAXIMUM

The number of times to try and restart a failed transfer. When the limit is reach, the job is placed on HOLD. The default is 0.

RETRY_TRANSFER_WAIT

The number of seconds to wait before trying to restart a failed transfer. This parameter must be greater than 0. The default is 5.

SLEEP_TIME

After a specified number of bytes has been transferred (set by BYTES_TRANSFERRED) the number of seconds to sleep.

SSH2_PREF_KEX

Sets the SSH2 preferred methods for key exchange for SFTP. This is a preference only and may ignored if the server side does not accept the request. Possible values are:

• diffie‐hellman‐group1‐sha1

• diffie‐hellman‐group14‐sha1

• diffie‐hellman‐group‐exchange‐sha1

SSH2_PREF_HOSTKEY

Sets the SSH2 preferred methods for hostkey for sftp. Possible values are: ssh‐dssand ssh‐rsa.

SSH2_PREF_CRYPT

Sets the SSH2 preferred encryption method for SFTP. This is a preference only and may be ignored if the server side does not accept the request. Possible values are:

• aes256‐cbc

• rijndael‐[email protected]

• aes192‐cbc

• aes128‐cbc

• blowfish‐cbc

• arcfour

• cast128‐cbc

• 3des‐cbc

• aes128‐ctr

• aes192‐ctr

• aes256‐ctr

• arcfour128



SSH2_PREF_MACSets the SSH2 preferred Message Authentication Code algorithm. The possible values are:

hmac‐sha1 (SHA‐1 with 20‐byte digest and key lenggth)

hmac‐sha1‐96 (SHA‐1 with 20‐byte key length and 12‐byte digest length)

hmac‐md5 (MD5 with 16‐byte digest and key length)

hmac‐md5‐96 (MD5 with 16‐byte key length and 12‐byte digest length)

hmac‐ripemd160 (RIPEMD‐160 algorithm with 20‐byte digest length)

hmac‐[email protected](Alias for hmac‐ripemd160)

none

SSH2_PREF_COMP

Sets the preferred compression method for SFTP. This is a preference only and may not be supported by the SFTP server. Please be aware that: the amount of compression varies depending on the datastreeam; this can increase CPU usage and for connections with high bandwidth, it may be faster to run without compression. The possible values are zlib or none. The default is none

START_AS_IDLE

If set to YES, then OM_XFER goes into AWS mode as soon as Output Manager EM starts up. Options are YES and NO. The default value is NO.

SUPPRESS_CTL

Whether to suppress the creation of the CTL file. Options are YES (stop the file creation) and NO (create the file). The default is NO. This parameter does has no affect with DirectCopy, as in that case the CTL file is never created.

SUPPRESS_NFO

Whether to suppress the creation of the NFO file. Options are YES (stop the file creation) and NO (create the file). The default is NO.

TITLE_STRING

The title string which is passed to the FTP server. This consists of fixed text and replacement parameters. Spaces are not allowed but underscores and dashes are supported. The replacement parameters map to Output Manager EM job/printer information.


• *JOBNO*

• *JOBID*

• *REPORTID*

• *EXT*

• *JOBNAME*

• *UNIQJOBID*



• *UNIQUEREPORTID*

• *USERROOM*

• *GROUPNAME*

• *USERID*

• *CLASS*

• *FORMSID*

• *BUILDING*

• *DEPARTMENT*

• *PRINTER*

• *TIME*

• *DATE*

• *UNIQUEJOBID*

• *DESTID*

• *JOBTICKET*

• *VIRTUALPRINTER*

• *USERPARM0*

• *USERPARM1*

• *USERPARM2*

• *USERPAAM15*

• *VENDORID*

The default title string is *JOBNAME*-*REPORTID*.*EXT*.


APPENDIX O: OM_PEER EXAMPLE CONFIGURATION FILE

Appendix O: OM_PEER Example Configuration File


You may edit the config files by removing all the characters and spaces on the line before the parameter name and saving the file. An example OM_PEER configuration file is shown below:

# om_peer.cfg (a.k.a se_srv)# Example configuration file for the om_peer Driver# Copy this file to the name of the om_peer.cfg. This is the name of the # om_peer (se_srv) created when you create an om_peer.# Turn on debugging#debug=no# This is the number of seconds to wait between transfers of data blocks to # the remote host. Increase this value only if the remote host or network is # typically busy and you need to throttle data transfer.# THROTTLE = 0# Use 0 when sending jobs to a pre-R5.2.0 version of FSE or to FlexServer that # does not require the use of external binary files# SENDEXTERNALFILES = 1# ENCRYPT specifies if encryption should be used when sending the job to the# Input Receiver on the remote server. Valid options are YES and NO. The# default is NO.#ENCRYPT = NO# KEY specifies the encryption key used on the data (if enabled).# The KEY is defines as 32 or 64 hexadecimal characters. This key must match# the decryption key defined on the remote server.# KEY = F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6# MULTIREC specifies that the remote server supports concurrent encryption # and compression. The original IR for R5.18 and R5.2 did not support # concurrent compression and encryption. IR releases after R5.2 support # concurrent compression and encryption. Check with the system administrator # of the remote FSE to determine the IR on that system has been updated. If # both compression and encryption are enabled and MULTREC is set to NO, then # compression are automatically disabled. Default is YES.#MULTIREC = YES# Q_SendResource specifies a resource file that must be sent with each job # sent to the remote FSE system. The resource must be specified with a full # path and is only sent if the server is enabled to send resources to the # remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise,# set the resource search path as "$/".# There can be multiple occurrences of this configuration option.#Q_SendResource=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_ps specifies a resource file that must be sent with each # Postscript job sent to the remote# FSE system. The resource must be specified with a full path and is only sent # if the server is enabled to send resources to the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search



# path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_ps=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_pdf specifies a resource file that must be sent with each # PDF job sent to the remote FSE system. The resource must be specified with # a full path and is only sent if the server is enabled to send resources to # the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise,# set the resource search path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_pdf=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_pcl specifies a resource file that must be sent with each # PCL job sent to the remote FSE system. The resource must be specified with # a full path and is only sent if the server is enabled to send resources to # the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise,# set the resource search path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_pcl=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_afp specifies a resource file that must be sent with each # AFP job sent to the remote FSE system. The resource must be specified with # a full path and is only sent if the server is enabled to send resources to # the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search # path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_afp=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_line specifies a resource file that must be sent with each # LINE mode job sent to the remote FSE system. The resource must be specified # with a full path and is only sent if the server is enabled to send resources # to the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search # path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_line=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_lcds specifies a resource file that must be sent with each # LCDS job sent to the remote FSE system. The resource must be specified with # a full path and is only sent if the server is enabled to send resources to # the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search # path as "$/".## There can be multiple occurrences of this configuration option.



##Q_SendResource_lcds=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_meta specifies a resource file that must be sent with each # Xerox metacode job sent to the remote FSE system. The resource must be # specified with a full path and is only sent if the server is enabled to send # resources to the remote FSE system.# An optional target subdirectory can be specified by adding (subdirectory # name) to the end of the resource name.# If the subdirectory is specified, set the resource search path in # FlexConfigure as "$/subdirectoryname). Otherwise, set the resource search # path as "$/".## There can be multiple occurrences of this configuration option.##Q_SendResource_meta=/ops/resources/a_resource_name(subdirectory - optional)# Q_SendResource_captured indicates whether resources stored in the Robust # Resource Capture directory should be sent to the remote FSE system.# Note: Captured resources that are job based are saved in the "CAPTURED" # subdirectory. To access them, the resource path must be specified as "$/# CAPTURED" in FlexConfigure.## Valid values are Yes and No. No is the default value.##Q_SendResource_captured=NO# Q_SkipVipFiles indicates whether VIP files (vipopt/setopt/modopt/incopt) # should be sent as resources to the remote FSE system. Yes is the default # value.##Q_SkipVipFiles=YES# IR_PORT allows you to specify the TCP/IP port number used by se_srv. Use # this parameter only if an IR's "SERVICE = " configuration file parameter # # has been set to use the port number. By default both the IR and se_srv use # port 4020.#IR_PORT = 4020#IR_PORT = 4021# START_ENABLED governs whether the server starts up in the enabled state and # so become available for AWS activity without operator intervention. The # default is NO.#START_ENABLED=NO## End of configuration file for se_srv

Configuration File ParametersDEBUG

Whether to turn on debugging. The options are Yes and No. The default is No.

ENCRYPT

Whether encryption should be used when sending the job to the Input Receiver on the remote server. Valid options are Yes and No. The default is No.

IR_PORT

The TCP/IP port number used by se_srv. Use this parameter only if an IRʹs ʺSERVICE = ʺ configuration file parameter has been set to use the port number. By default both the IR and se_srv use port 4020.



KEY

This specifies the encryption key used when encrypting the data (if enabled). The KEY is defined as 32 or 64 hexadecimal characters. This key must match the decryption key defined on the remote server.

The default is F0F1F2F3F4F5F6F7F8F9C1C2C3C4C5C6.

MULTIREC

Whether the remote server supports concurrent encryption and compression. The original IR for R5.18 and R5.2 did not support concurrent compression and encryption. IR releases after R5.2 support concurrent compression and encryption. Check with the system administrator of the remote Output Manager EM to determine that the IR on that system has been updated. If both compression and encryption are enabled and MULTREC is set to No, then compression is automatically disabled. Valid options are Yes and No. The default is No.

Q_SENDRESOURCE_XX

This specifies a resource file that must be sent with certain types of job to the remote Output Manager EM system. The resource must be specified with a full path and is only sent if the server is enabled to send resources to the remote system.



xx specifies the type of job that the resource file is to be sent with. It can be one of the following:



Q_SENDRESOURCE_CAPTURED

This determines whether resources stored in the Robust Resource Capture directory should be sent to the remote Output Manager EM system.

AFP AFP jobs

lcds LCDS jobs

Line Line mode jobs

meta Xerox metacode jobs

PCL PCL jobs

PDF PDF jobs

PS PostScript jobs



NOTE: Captured resources that are job based are saved in the CAPTUREDsubdirectory. To access them, the resource path must be specified as $/CAPTURED in FlexConfigure. Valid options are Yes and No. No is default.

Q_SKIPVIPFILES

This indicates whether Output Manager files (vipopt/setopt/modopt/incopt) should be sent as resources to the remote Output Manager EM system. Yes is default.

SENDEXTERNALFILES

The default value is 1. Change this to 0 when sending jobs to a pre‐R5.2.0 version of Output Manager EM, or one that does not require the use of external binary files.

START_ENABLED

This governs whether the server starts up in the enabled state and so becomes available for AWS activity without operator intervention. The default is NO.

THROTTLE

The number of seconds to wait between transfers of data blocks to the remote host. Increase this value only if the remote host or network is typically busy and you need to throttle data transfer. The default is 0.


APPENDIX P: EXAMPLE CHKR CONFIGURATION FILE

Appendix P: Example CHKR Configuration File

The CHECKER configuration file uses a number of setting found in the database.

A CHECKER configuration files is not automatically created by FlexConfigure. You must copy CHKR.cfg. default to chkr.cfg. Make your changes in chkr.cfg. All CHECKERS use the same chkr.cfg file. An example file is shown below:

# Default configuration file for the CHKR.## The following CHECKER configuration option are taken from t_open_env and# cannot affected by the chkr.cfg file.# RDY_xxxxx <YES|NO># Where 'xxxxx' is the name of a Logical CPU.# If set to YES then a report missing resources but submitted by# the Logical CPU 'xxxxx' has it's status set to READY rather than# RESOURCE HOLD when resources used by the report are found to not# be available in the libraries known to PIEM.# The parameter should not be set unless the PIEM server is being# used as an intermediary and jobs are to forwarded to alternate# server or print system that has an independent library of resources# containing the resources requried by the report.# The default is NO.

# JESType <2|3># The default is 2.## enhAFPRsrcScan <TRUE|FALUE># The resources scanner checks for resources in page objects.# The default is TRUE.## useAFPIPDSFontNames <TRUE|FALUE># Adjusts the handing of Coded Font And Character Set prefixes so# as to improve matching of resources identified in the job to# those found in resource libraries.# The default is TRUE.## CHKR_SKIP_RET_PER <YES|NO># If set to YES then the retention period for a job is based on the # time the job arrived on the PIEM server. If set to NO then the # retention time is based on the time the job was last checked.# The default is NO.## defaultLineFcb# The default FCB used when printing LINE jobs. The stored value is# prefixed by "FCB2". If no default is defined "FCB2STD2" is used.# The default is to not define the setting. FCB2STD2 is used.## defaultXrxcFcb# The default FCB used when printing META/LCDS jobs. The stored value# is prefixed by "FCB2". If no default is defined "FCB2STD2" is used.# The default is to not define the setting. FCB2STD2 is used.######### NOTE: A CHECKER configuration files is not automatically created by# FlexConfigure. You must copy CHKR.cfg.default to chkr.cfg.# Make your changes in chkr.cfg. All CHECKERS use the same# chkr.cfg file.#



####jesopt # Set to YES when the Xerox scanner is to assume line mode streams# have been 'optimized'.# The default is NO.#jesopt = NO#####checkPageSegs [fn]# Used to request secured page segment scanning by the APFDS# scanner. The default for 'fn' is /ops/data/checkPageSegs.cfg on# Unix Systems, %ROOT%\data\checkPageSegs.cfg on Windows systems. # When 'checkPageSegs' is used without a parameter the default 'fn' # is used. See checkPageSegs.cfg.default for information on how to # use secured page segment checking. Omit or comment out the # parameter if you do not require a scan for secured page# segments.# The default is to leave the option commented out, no secured page # segment scanning occurs.#checkPageSegs#####pageSegMaxLen <len>]# Useful only when checking for secured page segments. <len> is # used to override the value specified for PAGESEGMENT_CHAR_LENGTH # in checkPageSegs.cfg.# The default is to have the option comment out.#pageSegMaxLen#####ConnectCheck# Set to YES if the CHKR is to PING the QM prior to checking the # job or report(s). The PING is useful in environments where jobs # occationally go to PROC HOLD on the initial checking but are set# to READY when re-CHECKED.# The default is YES.#ConnectCheck = YES#####debug <level># Set the debug level. Select one of 0, 1, 3, 7, 15, 31, 63, 127,# 255, 511 or 1023. The default Log Level set by FlexConfigure in # the for CHECKER's setup panel.#debug = 0### PDF jobs also only.#####requirePdfHeader <Yes|No> # If the PDF header is missing set the report statusto PROC-HOLD, # default is 'No'.#requirePdfHeader = No#####requirePdfTrailer <Yes|No> # If the PDF trailer is missing set the report status to PROC-HOLD, # default is 'No'.#requirePdfTrailer = No####



#requirePdfPageCount <Yes|No> # If the scanned PDF page count is 0, set the report status to # PROC-HOLD, default is 'No'.#requirePdfPageCount = No#####allowPageTokenScan <Yes|No> # The page count for a PDF that fails normal PDF page tree scanning # can be approximated by counting the '/Page' tokens in the file.# The count may not be accurate as it does not take into account # tokens in compressed objects.# When 'allowPageTokenScan = No' and normal scanning fails, the# page count is set to 0.## Should you require strong checking set 'requirePdfPageCount=Yes' # and 'allowPageTokenScan = No'.# This forces PDF reports that fail normal scanning to PROC-HOLD.# The default is 'Yes'.#allowPageTokenScan = Yes##### skipPdfScan <Yes|No> # Limited checker scanning occurs. A file size of 12 or more bytes # is required to for the job to go to READY. The page count is set # to 0. All other PDF configuration options are ignored.# Set the option to YES if you do not need the checker run a basic # integrity checks on your PDF.# The default is 'No', which means do a scan.# #skipPdfScan - No#FeatureCopies <Yes|No> # Allows the checker to use the NumCopies value in a PostScript # stream to be multiplied to the page and side counts. This is to# allow account generated in audit records. Turning on this feature# could cause unexpected results when viewing the job as there are# less pages in the stream than are going to be reported in the# database and page indexes will also be short.# The default is No.#FeatureCopies = No###

chkr configuration file parametersThe parameters required for this configuration file are given, below:

ALLOWPAGETOKENSCAN

The page count for a PDF that fails normal PDF page tree scanning can be approximated by counting the /Page tokens in the file. The count may not be accurate as it does not take into account tokens in compressed objects.

When set to No and normal scanning fails, the page count is set to 0. Should you require strong checking set the following, which forces PDF reports that fail normal scanning to PROC‐HOLD. The options are Yes and No. The default is Yes.

requirePdfPageCount=Yes allowPageTokenScan=No.



CHKR_SKIP_RET_PER

Whether the retention period for a job is based on the time the job arrived on the PIEM server. If set to NO then the retention time is based on the time the job was last checked. The options are Yes and No. The default is No.

CHECKPAGESEGS [FN]

Requests secured page segment scanning by the APFDS scanner.

The default for fn is /ops/data/checkPageSegs.cfg on Unix Systems, %ROOT%\data\checkPageSegs.cfg on Windows systems. When checkPageSegs is used without a parameter the default ʹfnʹ is used.

See checkPageSegs.cfg.default for information on how to use secured page segment checking. Omit or comment out the parameter if you do not require a scan for secured page segments. The default is to leave the option commented out, no secured page segment scanning occurs.

CONNECTCHECK

Whether the CHKR pings the QM prior to checking the job or report(s). The ping is useful in environments where jobs occasionally go to PROC HOLD on the initial checking but are set to READY when re‐CHECKED. The options are Yesand No. The default is Yes.

DEBUG <LEVEL>

Sets the debug level. Select one of 0, 1, 3, 7, 15, 31, 63, 127, 255, 511 or 1023. The default Log Level set by FlexConfigure in the for CHECKERʹs setup panel.

DEFAULTLINEFCB

The default FCB used when printing LINE jobs. The stored value is prefixed by ʺFCB2ʺ. If no default is defined FCB2STD2 is used. The default is to not define the setting. FCB2STD2 is used.

DEFAULTXRXCFCB

The default FCB used when printing META/LCDS jobs. The stored value is prefixed by ʺFCB2ʺ. If no default is defined FCB2STD2 is used. The default is to not define the setting. FCB2STD2 is used.

ENHAFPRSRCSCAN

Whether the resources scanner checks for resources in page objects. The options are True and False. The default is True.

FEATURECOPIES

Allows the checker to use the NumCopies value in a PostScript stream to be multiplied to the page and side counts. This is to allow account generated in audit records. Specifying FEATURECOPIES=YES may cause unexpected results when viewing the job as there are fewer pages in the stream than are going to be reported in the database; in addition, age indexes will be short. The default is No.

JESTYPE

The JES type being used. The options are 2 and 3. The default is 2.



JESOPT

Whether the Xerox scanner assumes line mode streams have been ʹoptimizedʹ. The options are Yes and No. The default is No.

PAGESEGMAXLEN <LEN>]

Useful only when checking for secured page segments. Where <len> is used to override the value specified for PAGESEGMENT_CHAR_LENGTH in checkPageSegs.cfg. The default is to have the option comment out.

RDY_XXXXX

Where ʹxxxxxʹ is the name of a Logical CPU. Whether a report missing resources but submitted by the Logical CPU ʹxxxxxʹ has its status set to READY rather than RESOURCE HOLD when resources used by the report are found to not be available in the libraries known to PIEM. The options are Yes and No. The default is No.

The parameter should not be set unless the PIEM server is being used as an intermediary and jobs are to forwarded to alternate server or print system that has an independent library of resources containing the resources required by the report.

REQUIREPDFHEADER

Whether to set the report status to PROC‐HOLD if the PDF header is missing. The options are Yes and No. The default is No.

REQUIREPDFTRAILER

Whether to set the report status to PROC‐HOLD if the PDF trailer is missing. The options are Yes and No. The default is No.

REQUIREPDFPAGECOUNT

Whether to set the report status to PROC‐HOLD if the PDF page count is 0. The options are Yes and No. The default is No.

SKIPPDFSCAN

Limited checker scanning occurs. A file size of 12 or more bytes is required to for the job to go to READY. The page count is set to 0. All other PDF configuration options are ignored. Set the option to YES if you do not need the checker run a basic integrity checks on your PDF. The options are Yes and No. The default is No, which means do a scan.

USEAFPIPDSFONTNAMES

Adjusts the handing of Coded Font And Character Set prefixes so as to improve matching of resources identified in the job to those found in resource libraries. The options are True and False. The default is True.


APPENDIX Q: UPGRADING


Appendix Q: UpgradingUpgrading Output Manager EM should only be considered after consulting Pitney Bowes Customer Services. Your plan should take into account any coincidental hardware or software upgrades as well as procedures to ensure production continues to run smoothly during the upgrade process.

APPENDIX R: OFFICEMAIL JOB INFORMATION SENT BY OUTPUT MANAGER EM TO OUTPUT MANAGER

Appendix R: OfficeMail job information sent by Output Manager EM to Output Manager

For an Enterprise Manger job to be considered an OfficeMail job, a number of requirements must be met:

The print file is in Output Manager Block Spool format.

The job has an OfficeMail Ticket.

The job has an OfficeMail Modifier.

The job requires PDF RIP 2 or higher.

The OfficeMail Ticket file name and OfficeMail Modifier file name may be verified by the Output Manager EM’s Report Resources window.

The OfficeMail Modifier contents are transfer to Output Manager as MOD file information. No special setup or configuration steps are required.

The OfficeMail Ticket is placed in a folder accessible to Output Manager. The target file name and location set by the Output Manager EM Controller is composed of a number of components.

Configuration information as set by FlexConfigure,

the T_OPEN_ENV variable parm_valu where parm_name = ʹOFMA_SUBDIRECTORYʹ,

the report’s source file name as specified by fsesccl and

the report’s Output Manager EM report id.

The default parm_valu is parm_valu = 'OFMA_TICKET'.


APPENDIX R: OFFICEMAIL JOB INFORMATION SENT BY OUTPUT MANAGER EM TO OUTPUT MANAGER

Example:

With a Output Manager Controller configured as follows:

The example assumes the job id is 3414 and has a report id of 3465.

The Office Mail Ticket is then moved to:

C:\MGRUSER\OFMA_TICKET\OFMA.TXT.3465.

The breakdown of the location is as follows:

The Office Mail Ticket directory location and file name are passed to Output Manager as HOSTTEXT entries.

HOSTTEXT40=C:\MGRUSER\OFMA_TICKETS\

HOSTTEXT41=OFMA.TKT.3465

NOTE: The target sub‐directory for Office Mail Tickets as specified by the T_OPEN_ENV setting must exist prior to Output Manager EM sending the job to Output Manager. In most situations this means the site analyst must create the sub‐directory when the Output Manager EM Controller is first configured.

FlexConfigure: MGRUser Drive C:

FlexConfigure: MGRUser Path \MGRUSER

T_OPEN_ENV parm_valu where parm_name = ʹOFMA_SUBDIRECTORY’

OFMA_TICKET

Office Mail Ticket file name sent by fsescclʹs ofmaTicket parameter

OFMA.TXT

The Output Manager EM report ID 3465


APPENDIX S: INSTALLING PRINT CLIENTS

Appendix S: Installing Print ClientsNOTE: The information in this appendix applies to Solaris/Linux installations only.

Older legacy printers require a print client to be able to communicate with the Output Manager EM output module. These devices are usually a PC or Sun computer running specific software to communicate with the printer. This section provides instructions for setting up the supported print clients of Output Manager EM.

Xerox LPS & Line print client The Output Manager EM Xerox print driver was designed to drive Xerox LPS print controllers using a Bus and Tag connection. The goal is to provide the ability to manage Xerox print resources and control the complete Xerox printing environment. The Xerox print driver contains the Output Manager EM module om_xerox, and a Windows PC running an Output Manager EM driver opsbd.exe that uses a BARR channel card to connect to a Xerox LPS controller. It manages your resources and controls the programs started on the printer from job to job without operator intervention. Output Manager EM receives status from the Xerox LPS controller, allowing full function operability and accountability. This print client is used for both the Output Manager EM Xerox LPS and Line Mode drivers. It is a TCP/IP server program which responds to connection requests on port 8000 + adapter ID from the Solaris/Linux OMs. Adapter IDs start at zero and increment by one for each additional BARR Card. For example, to access the driver server from the Output Manager on the second BARR Card, you would configure it for port 8001. The print client runs on a PC running Windows 2000/XP and requires a BARR Channel Card.

Hardware requirements

Software requirements MS Windows 2000/XP and service packs

Output Manager EM Xerox Driver

Barr Driver

Installation 1. Create the following directory:

C:\PB

2. Copy the file opsbd.exe from the following directory on your Sun Server:

//ops/ENTX.X/NT/bin to C:\PB

3. Install the driver from a command prompt:

C:\PB\opsbd –installC:\PB\opsbd –start

512MB memory 3 ½ Floppy Disk Drive

20 GB Hard Drive 10/100mbNetwork Card

Keyboard, Mouse BARR channel card

17’ SVGA Monitor



Once the driver is loaded as a Windows Service, you need to set it to start automatically when the PC is started. This is described below with the BARR Card information. To do this:

1. Open the Services window.

In Windows 2000 this is in Start | Settings | Control Panel | Services

In Windows XP this is in Start|Control Panel | Administrative Tools | Services

2. Select FSEBarrDriver0 within the Services list. The Startup Type is displayed as Manual.

3. Click Startup to change the Startup Type from Manual to Automatic.

4. Open the Devices window.

In Windows 2000 this is in Start | Settings | Control Panel | Devices

In Windows XP this is in Start | Control Panel | Administrative Tools | Services

5. Select BARR/CHANNEL OUT Bus & Tag within the Devices list. The Startup Type is displayed as Manual.

6. Click Startup to change the Startup Type from Manual to Automatic.

7. Reboot the Windows PC.

The driver can also run in a console mode for debugging. C:\PB\opsbd –console

opsbd parameters

DEBUG

Enables extended debug information to be displayed. For example, it displays information about each channel command as it is executed and the status returned. For this reason, it should not be enabled unless there is need to examine the Channel Commands on screen or check other behavior. Debugging significantly impacts driver performance.

LOCAL

Instructs the driver not to attempt communication with the Barr Card. This mode can be used on a PC without a Barr Card or to examine the integrity of a data transfer to the client side through the opsbd.0.0.dat file.

NOTES:

• Up to five old versions of these data files are saved with names like opsbd.0.1.dat. If an adapter other than zero is used the file is named opsbd.1.0.dat.

• These data files can become quite large, depending on the files printed. You may need to check available hard disk space and/or periodically clean up these files.

All other functions of opsbd listed in the table below should only be used with the guidance of Pitney Bowes Professional Services, the contact numbers are at the back of this document.



TRACE

Traces commands actually sent to the Barr Card and is used to see the actual data sent to the printer while taking into account sense commands and retries. This is rarely used, but can track driver behavior. If used, this impacts performance slightly.

DUMP

Dumps out a readable version of each channel command as it is sent to the Barr Card. The format of this file is similar to the Xerox OLDUMP Start Command and can be used to compare against that version. This is also useful for discovering the Channel Command make‐up of a data stream, especially when used in conjunction with the local mode. This flag outputs its data to the file opsbd.0.0.dmp in the case of the first Barr Card. Similar to the local flag, multiple dumps are saved as opsbd.0.1.dmp, etc. In addition, if multiple programs are in use, you would see opsbd.1.0.dmp.

NOTE: This command impacts performance slightly and the dump files it generates can become very large. The hexadecimal bytes of the data stream are expanded in to a readable text form that takes many more bytes of storage than the original data stream.

NOCHAIN

Record chaining is a feature specific to the Barr Card where multiple Channel Commands can be “chained” together and executed as a group by the driver. This grouping can increase overall performance by several percent depending on the data. This option exists to provide a fall back mechanism to issue single channel Commands should the chaining feature not work in all cases. The chaining feature seems to provide significant benefits and the “nochain” option may be removed from future releases.

CHANTO

The driver considers Channel Commands which are executed but have not returned a status within 60 seconds to be overdue and causes the driver to go Offline. In most cases this provides enough time for a normal print stream on a normal printer to react as well as providing an error mechanism for Channel Commands that never return due to hardware or channel reasons. However, there are some data streams, for example, on Xerox printers that may take more than 60 seconds to process. These are dependant on a DJDE switch to a new JDL that is complex and takes the printer significant time to process. The 60‐second timeout, therefore, maybe too short to print these jobs before the driver forces itself Offline. In these cases, the driver should be started with this option and a higher timeout specified, for example 120 seconds. This has no impact on the driver other than to take additional time to react to channel problems.

INSTALL

Installs the NT service for a Barr card and must be undertaken to run the service. If no adapter ID is provided it defaults to zero which is the first adapter.



REMOVE

Removes the service from NT. Before attempting to remove the service, insure that the service has been stopped. If no adapter ID is provided it defaults to zero which is the first adapter.

START

Starts the service and is used in both the command‐line and Control Panel Servicesmethods for starting the service. This parameter is required to start the service. If no adapter ID is provided it defaults to zero, which is the first adapter.

STOP

Stops the service. If no adapter ID is provided it defaults to zero which is the first adapter.

QUERY

Checks the status of the service and is used in the command‐line by running opsbd -query and return the following information:

Output Manager EM Barr Driver Version 1.90 PB, Inc. Copyright (C) 1999‐2000, All Rights Reserved Current state: 4 (Running) Controls accepted: 1 Win32 exit code: 0 Service exit code: 0 Check point:0 Wait hint:0

If no adapter ID is provided it defaults to zero which is the first adapter.

CONSOLE

Run opsbd.exe in a DOS session and not as a service. Console mode cannot be used at the same time the service is running unless connecting to separate Barr devices.

The driver logs most of its activities to log files. These file are named along the lines of opsbd.0.0.log and depend on the instance number opsbd.1.0.logand the backup log number opsbd.0.1.log. Currently, there is no automatic log rolling capability, therefore, the log files may become quite large if logging is enabled. If no adapter ID is provided it defaults to zero which is the first adapter.

NOTE: Refer to the Output Manager Installation Guide delivered on the CD for information on how to install the Output Manager software.


APPENDIX T: ROBUST RESOURCE MODE

Appendix T: Robust Resource ModeRobust Resource Mode allows Output Manager EM jobs intended for final output on a Output Manager system to have the native resources controlled by IHRM downloaded to Output Manager EM. This allows a Output Manager system connected to Output Manager EM to print the job with current resources without having to access the IHRM host. Robust Resource Mode is used in conjunction with the Intelligent Host Resource Manager.

Pre installation tasks1. Identify a disk partition on the Output Manager EM platform on which the

captured resources is stored. If one does not already exist, it must be created and the mount point made available to the Output Manager systems.

2. Select a Output Manager disk drive letter that either captures resources or print jobs with captured resources. The drive letter must be the same on all Output Manager systems.

3. At each Output Manager system, mount the Output Manager EM resource capture drive as the disk letter selected above. For example, if the Output Manager EM capture path is /vipflex/capture and the Output Manager capture path is V:, then the Output Manager V drive must point to the mount point /vipflex/capture on the Output Manager EM system. The same effect can be achieved by setting the Output Manager EM capture path to /vipflex/capture, the Output Manager capture path to V:\capture and a mount point of /vipflex.

Setup The following steps are required to set‐up a capture environment.

1. Open FlexConfigure and login in the usual way

:



2. Open the Administration menu and select Options to open the Enter Output Manager EM Values window:

3. Complete the following fields:

4. Click OK to save.

5. Create maprules to direct jobs requiring resource capture to the relevant Output Manager system. This is most easily done by setting the VIP_VIEW job parameter. If you are using the VIP_OUTPUT parameter to submit the job to its output Output Manager system, then this value must be moved to a user parameter field and the VIP_OUTPUT value must be cleared or set to an invalid setting.

NOTE: Refer to the Creating Mapping Rules section.

6. Create the vip_cntl and to_vipflex modules for the Output Manager system performing the resource capture. Enable resource capture for that system by setting the following parameters in the vip_cntl configuration file:

RESOURCECAPTURE=YESVS_VIP_OUTPUT_USER_PARM

ENT Resource Capture Path

The path to the location in which captured Output Manager EM resources are saved, as selected in step 1 of Pre installation tasks. This enables the Output Manager IHRM Resource Capture mode.

MGR Resource Capture Path

The path to the location in which captured Output Manager resources are saved.

NOTE: Refer to the Output Manager EM Installation Overview for more information.



VS_VIP_VIEW_USER_PARMVS_DEST_ID_USER_PARM

The last three set the VIP_OUTPUT, VIP_VIEW and DESTID job values for the system doing the printing.

7. Restart the Output Manager EM system. This is required when enabling the capture and when the capture paths are changed.

NOTE:

• Enabling the mode does not change how jobs already on the Output Manager EM spool are processed. The existing jobs are not treated as resource capture jobs.

• Only IHRM based native resources are captured, not resources existing on Output Manager EM resource drives. In order to print the job with the same resources used during resource capture, the resource paths for the output Output Manager systems must be the same as the resource paths used in capture.

• If VIP_OUTPUT or VIP_VIEW is being set by the submission client, then the vip_cntl, to_vipflex and om_vipflex client names should all be upper case.


APPENDIX U: THE CHANGE_ANY UTILITY

Appendix U: The change_any UtilityIntroduction

Change_any is a utility that is used to modify the Output Manager EM database based on data extracted from a job. It can be used to change the value of certain fields in the database (see Which fields can be changed).

Change_any syntaxThe syntax of change_any is:

change_any <Job name> <Field Name> <Table> [rprt parm name] <String to find> <Lines down from string> <Offset in Line> [-LENGTH extract_length][-DATEFORMAT sql_date_format} [-MAXBLOCKS block_count][-ASCII] [-MULTIWORD] <[-JOB Job_Id] || [list_of_reports]>

Where:

Job name The jobname qualifier. Mandatory. If the jobname does not match, then change_any exits without error. Wildcards can be used in the jobname, including * , which matches all job names.

Field Name The name of the field to change, for a job or a report. Mandatory.

Table The database table name. This must be one of the following:

JOB

RPRT

RPRTPARM

POD

Mandatory.

Rprt parm name This must be set if the table is RPRTPARM. Specifies the ʺparmʺ field name that is set when the field name is set to ʺvaluʺ.

String to find The strings to find in the report data. Mandatory.

Lines down from string

The start position, in lines down, in the spool. Mandatory.

Offset in line The column number on the line.

A + or ‐ sign, before the number, indicates a relative offset. If no sign is used, an absolute offset from the beginning of the buffer is used. Mandatory.

-LENGTH Length of string. Optional.

If absent, the length defaults to the length of the field to change.

-DATEFORMAT If a date field is updated, the SQL date format to use.

-MAXBLOCK The maximum number of blocks that is searched for the string.

-ASCII Optional. If specified, indicates that the file contains ASCII data. If absent, indicates that the file contains EBCDIC data.



Please note the following:

1. The parameters (both mandatory and optional) are identified by their sequence order and must be given in the proper order.

2. The optional parameters are prefixed with a dash.

3. If a numeric field is updated, the data extracted from the job must be in integer format and may include a + or ‐ sign. Decimals, scientific notation, etc. are not supported.

4. If a character field is updated and the extract_length is longer than the database field, then the data is limited to the database field length.

5. If the extracted field goes beyond the current read buffer, then the data is truncated at the end of the buffer.

6. The ʺstring to findʺ is case sensitive and cannot exceed 100 characters.

7. The ʺstring to findʺ is only searched for in the number of blocks set by MAXBLOCKS. If MAXBLOCKS is not specified, the default is 1000 blocks. The block size is dependent on the emulation. For PostScript and Line Jobs, a block is the same as a line.

8. Change_any is not an interpreter. It uses simple searches on the input data file for the ʺstring to findʺ. If the print driver splits the ʺstring to findʺ into two separate positional writes, change_any do not detect it.

9. “Lines downʺ refers to the ʺrawʺ input data. It skips one input buffer for each line down. This algorithm works for LINE and PostScript data. It does not work for PCL, PDF, AFP, or Xerox datastations. In these cases, the ʺstring to findʺ should be on the same line and ʺlines downʺ should be set to zero.

10. ʺOffset in lineʺ refers to the ʺrawʺ input data. Absolute line positioning works well with LINE data. Other datastations should use the relative offset to the ʺstring to findʺ.

11. If the table is RPRTPARM, then the rprt parm name must be specified. Otherwise, the rprt parm name should not be specified.

12. If -ASCII is not specified, an EBCDIC data stream is assumed.

13. If -MULTIWORD is specified on a non multi word database field, it is treated as a SINGLE word.

14. If database character field is specified, any leading blanks from the extracted data is stripped off before it is written to the database.

15. For multi‐report jobs, each report is checked for the ʺstring to findʺ. If the string is not found for a specific report, the database update do not occur for that report.

-MULTIWORD Optional.

If present, indicates that the database field support multiple words, for example, JOB_TCKT_TEXT, and extracts all words up to the extract length.

If absent, indicates the database field supports a single word only. As such, the extract field only extracts a single word.

-JOB The job_id to process. If this is not present, the software assumes that a list of report IDs follows.

<List_of reports>

A list of report IDs. Only used when ‐JOB is not present.



16. If the command line parameter includes a space character, it should be surrounded by single quotes.

17. If a database date field is to be updated, then the -DATEFORMAT must be specified.

18. The DATEFORMAT is a SQL date format string that defines the expected format of the date data. See the example below for usage.

Running change_anyChange_any should be run from ir_process.sh.Ir_process.sh is run for every new job received. It is also run if reprocessing is required for the job from the job from the GUI. The administrator should edit ir_process.sh and add any change requests to the end of the script.

Change_any is usually called using the following script:

change_any TEST1 JDL JOB JDL= 0 +4 -length 8 -ASCII $*

When ir_process.sh is processed, change_any is called with the parameter listed. The $* at the end of the line is converted to ‐job job_id.

ExamplesPaper=letter example

Consider an ASCII LINE job, with the jobname ʺDIFF1ʺ, that contains the text:

paper=letter

In this case, ʺletterʺ is the form type. The following change_any parameters would be set up in ir_process.sh:

change_any DIFF1 form JOB paper= 0 +6 -length 8 -ASCII $*

A relative offset from the beginning of the paper field can be used to reference the beginning of the extract field, in this case letter. Although letter is only six characters long, a longer extract field can be specified. Since the form field is not capable of holding multiple words, a space or linefeed delimiter is sufficient to extract the letter form.

The extraction word can also be at fixed position offset from the beginning of the line. In this case, a ʹ+ʹ or ʹ‐ʹ is not used in front of the ʺoffset in lineʺ. For example, if the ʺletterʺ started at fixed line position 32.

change_any DIFF1 form JOB paper 0 32 -length 8 -ASCII $*

The extraction word can also be on a different line from the ʺstring to findʺ. There is a limitation that the ʺlines downʺ must be greater or equal to 0.

NOTE: The lines down work for LINE data but is unlikely to work for the other datastations.

DATEFORMAT ExampleWhen updating a date field, the DATEFORMAT string must be supplied. The DATEFORMAT string defines the format of the date that is used to update the database



field. The DATEFORMAT string is passed to SQL and must follow the SQL date format model syntax rules. For example, if the date data was displayed as:

20060523 15:33:15

Then the DATEFORMAT string would be YYYYMMDD HH24:MI:SS:

where

YYYY is the 4 digit year

MM is the month

DD is the day of the month

HH24 is the hours is 24 hour format

MI is minutes

SS is second

The extracted string includes a space character, so it should be enclosed in single quotes and -MULTIWORD should also be specified.

change_any TESTDATE RDR_TIME job CreationDate: 0 +14 -LENGTH 18 -ASCII ``-MULTIWORD -DATEFORMAT 'MM/DD/YYYY HH24:MI:SS' -job 62296 $*

RPRTPARM ExampleWhen a rprtparm table is updated, a ʺparmʺ value must specified. For example:

change_any DAILY VALU RPRTPARM TRACKNUM VENDORID= 0 +9 -length 24 -ASCII $*

In this case, the t_oprp_rprt_parm table is updated with parm=ʹtracknumʹ and valu = <extracted value> for each report that matches the job_id.

LoggingErrors detected by change_any is written to the alert log (usually /var/log/opslog.alert) as well as the joblog. They is formatted as in the example below:

CAE080: lines down 'X2' is not numeric

Messages indicating successful processing is written to the opslog (usually /var/log/opslog) and to the joblog. They is formatted as in the example below:

Success: Job ID 29559 table = T_OPJB_JOB, field=user_addr was changed to 75 Mercer St.

Performance IssuesEach time change_any runs, it performs at least one database access to determine if the jobname matches. If the jobname matches (or is a wildcard), change_any then searches the spool files for the ʺstring to matchʺ. This uses system resources. Unless change_any is to run against all jobs, it is recommended to use a jobname qualifier so that it only runs against jobs that match the jobname.



Which fields can be changedOnly specific database fields in the JOB, RPRT, RPRTPARM and POD tables can be set.

Some fields cannot be modified for security reasons, or to maintain data integrity. For example, the job id cannot be modified, since this would affect the referential integrity of the job and report tables.

The tables below give a list of which fields can be modified, the field type, default size as well as if the field can support multiple words.

JOB TABLE

Field Name Type Multi word

JOB_NAME CHAR(8) No

GROUP_NAME CHAR(8) No

CLAS CHAR(1) No

FORM CHAR(8) No

PRIO NUMBER(38) No

JOB_NO CHAR(8) No

USER_ID CHAR(8) No

USER_NAME CHAR(60) Yes

USER_ACCT CHAR(32) Yes

USER_ROOM CHAR(8) No

USER_DEPT CHAR(60) Yes

USER_BLDG CHAR(60) Yes

USER_ADDR CHAR(240) Yes

VISIBLE CHAR(1) No

RDR_TIME DATE Yes

ORIG_SYSID CHAR(4) No

EXEC_SYSID CHAR(4) No

ORIG_NODE CHAR(4) No

EXEC_NODE CHAR(4) No

JDL CHAR(8) No

JDE CHAR(8) No

DEST_ID CHAR(8) No

TITLE CHAR(60) Yes

USER_ROOM_LONG CHAR(60) Yes



REPORT TABLE

RPRTPARM TABLE

Field name Type Multiwarhead

RPRT_NAME CHAR(53) No

DD_NAME CHAR(8) No

PRIO NUMBER(38) No

COPY NUMBER(38) No

FCB CHAR(4) No

UCS CHAR(4) No

FORM_DEF CHAR(8) No

PAGE_DEF CHAR(8) No

FLSH CHAR(4) No

TRC CHAR(1) No

JOB_TCKT_TEXT CHAR(128) Yes

JOB_TCKT_NOTE CHAR(128) Yes

STEP CHAR(8) No

PROC_NAME CHAR(8) No

CHAR_1 CHAR(8) No

CHAR_2 CHAR(8) No

CHAR_3 CHAR(8) No

CHAR_4 CHAR(8) No

ORIG_DATA_FMT NUMBER(38) No

GROUP_NAME CHAR(8) No

GROUP_ID1 NUMBER(38) No

GROUP_ID2 NUMBER(38) No

JDL CHAR(8) No

JDE CHAR(8) No

Column Name Type Multiwarhead

PARM VARCHAR2(20) No

VALU VARCHAR2(100) No



POD TABLE

Column Name Type Multiwarhead

JT VARCHAR2(128) Yes

VP VARCHAR2(100) Yes

UP_0 VARCHAR2(100) Yes

















APPENDIX V: MATCH COLUMN OPTIONS

Appendix V: Match Column OptionsBATCH COUNT The number of batches in the job.

CHAR1 The first character arrangement table, for example, font, specified to be used (at print time) for the print job upon submission to a host platform using JCL. upon direct submission into Output Manager EM using the Output Manager EM Submission Client. Example values: X1GT12, X1AON.

CHAR2 The second character arrangement table value specified.

CHAR3 The third character arrangement table value specified.

CHAR4 The fourth character arrangement table value specified.

NOTE: CHAR1 through CHAR4 are specified at submission time as up to four‐character position names. For example, GT12 or AON are valid CHAR names. When stored in the Output Manager EM database, the names are automatically prefixed with X1 to convert the CHAR name to a standardized IBM Coded Font name. At print time, the printer driver determines the exact Coded Font name prefix to use, for example, printer type, resolution. For a Mapping Rule using criteria to successfully match a Output Manager EM database value, the X1prefix should be specified in the rule for either the Match Value or Replace Value, as applicable.

Class The class assigned to the print job during submission. The values are 0–9 or A‐Z.

Color Whether color is present in the job.

DestID The Destination Id assigned to the print job during submission; this can be up to eight alphanumeric characters.

Envelope Envelope size/type required for the mail‐piece.

Executing Node The node name of the mainframe host where the print job that created the print file was executed. This value is not used or populated when a print job is submitted to Output Manager EM using the Output Manager EM Submission Clients. Values are up to four alphanumeric characters.



Executing System ID The System ID of the mainframe host where the print job that created the print file was executed. This field is populated with the value of the sysid parameter from the default configuration file when a print job is submitted to Output Manager EM using the Output Manager EM Submission Clients. Values are up to four alphanumeric characters.

FCB Forms Control Buffer name specified at time of print submission. Only the significant part of the FCB name should be specified. For example if the FCB to be used is FCB2STD, only STD should be specified. Values are up to four alphanumeric characters. For the vip_cntl module a value of NONE may be specified to prevent an FCB being sent ahead of the job to Output Manager.

Flash An Overlay Form Flash specified at print submission time and supported only by an IBM 3800 printer. Values are up to four alphanumeric characters.

Form Definition The name of the AFP Form Definition printer resource object specified at print submission time for the print job. Values are up to eight alphanumeric characters in length and are typically prefixed with F1 when stored in the Output Manager EM database, for example F12UP.

Form The name of the Form specified at print submission time for the print job. Values are up to eight alphanumeric characters.

Group Name The name of the Output Group specified at print submission time for the print job. Values are up to eight alphanumeric characters.

InsertPulls The number of inserts required for the job.

JDE The name of the starting Xerox Job Descriptor Entry (JDE) specified at print submission time for the print job. Values are up to six alphanumeric characters in length, for example, DFLT.

JDL The name of the starting Xerox Job Descriptor Library (JDL) specified at print submission time for the print job. Values are up to six alphanumeric characters in length, for example, DFAULT.

Job Name The name of the job.



Job Number The host assigned job number of the job creating the print file at print submission time, or when using the Output Manager EM Submission Client, a free format alphanumeric text string of up to eight characters in length used to help identify the job.

Job Ticket Contains the value specified for the -jt parameter when using the Output Manager EM Submission Client. This may contain a free format text string of up to one hundred and twenty‐eight characters used to describe the requirements of the print job.

Mail Piece Count The number of mail pieces required for the job.

MICR Whether MICR is required.

MDRF The path to the Mail Run Data File (MDRF) 255 characters.

MVS Data set name ss The host assigned Job Entry Subsystem (JES) data set name of the print file being submitted to Output Manager EM, or when using the Output Manager EM Submission Client, either a system generated unique representation of the file name being transmitted or the report name as specified to the submission client consisting of free format alphanumeric text of up to fifty‐three characters.

Examples:

Using Flexserversccl –dest Output Manager EM …. -reportname my_report_name …

MVS Data Set Name is: my_report_name

Using Flexserversccl –dest FlexServer ……. –form ABC myFile.txt

MVS Data Set Name is: myFile.txt.dddhhmmss.nnnnnnnn

where:

myFile.txt The base filename (up to thirty‐two characters).

ddd The day/date of the last file edit.

hh The hour of the last file edit.

mm The minutes of the last file edit.

ss The seconds of the last file edit.



nnnnnnnnnn The file size in bytes (ten characters).

From an MVS host, the name is systematically generated. An example MVS Data Set Name would be

N1.A123456.JOBNAME1.JO

B12345.D0000102.

where:

N1 The node name of the host system

A123456 The owning user id of the job

JOBNAME1 The host job name

JOB12345 The host assigned job number

D0000102 The host assigned DD Name.

MVS DD Name The Data Descriptor Name (DDNAME) in the JCL of the print file being submitted to Output Manager EM, or when using the Output Manager EM Submission Client, the -ddname parameter value specified to the submission client consisting of free format text of up to eight alphanumeric characters.

Number of Copies The number of copies of the job to be printed.

Page Definition The name of the AFP Page Definition printer resource object specified at print submission time for the print job. Values are up to eight alphanumeric characters in length and are typically prefixed with P1 when stored in the Output Manager EM database, for example, P1STD1.

Priority The numeric priority value assigned by the host platform upon print submission, or the value assigned for the “-jobprty” parameter when submitted using the Output Manager EM Submission Client. Values typically range from 1 –99.

Proc Name The JCL Procedure Name (PROC) used to process the print file being submitted to Output Manager EM. Not currently used by the Output Manager EM Submission Client. Consists of free format text of up to eight alphanumeric characters.



PR Mode A binary number representation of several attributes used to specify how a print job is to be processed. The attributes include language code set (EBCDIC or ASCII), the carriage control type (None, ASCII, ANSI, Machine), the PDL type (Line, AFPDS, Metacode, LCDS, PCL, PostScript, PDF, VIPP) and for Xerox print jobs, the print mode (Offline, Online).

To manipulate the attributes using Mapping Rules, there are several mnemonics which represent one or a combination of attributes listed above. The mnemonics are:

ANSI ANSI carriage control

ASCI ASCII code set

EBCD EBCDIC code set

LINE PDL type Line

LCDS PDL type LCDS (Xerox Line Conditioned Data Stream)

LCDA PDL type LCDS and ASCII code set

LCFA PDL type LCDS, Offline mode and ASCII code set

LCFS PDL type LCDS and Offline mode

LCNS PDL type LCDS and Online mode

LCNA PDL type LCDS, Online mode and ASCII code set

MACH Machine Carriage control

META PDL type Metacode

MENA PDL type Metacode and Online mode

MEFA PDL type Metacode and Offline mode

MIXD PDL types Line and AFP

NONE No carriage control

OFFL Offline print mode

ONL Online print mode

PAGE PDL type AFPDS



PCL PDL type Printer Control Language (PCL)

PS PDL type PostScript (PS)

PSE PDL type PostScript and EBCDIC code set

TEXT PDL type Text (LINE with ASCII code set)

VIPP PDL type VIPP

VIPPA PDL type VIPP and ASCII code set

VIPPE PDL type VIPP and EBCDIC code set

Retention The time period, expressed as a positive integer value, in hours that a print job is to be retained on the Output Manager EM system after it has been successfully printed or processed and is in a COMPLETED state. A value of 24 represents one day, 72 represents three days, etc.

NOTE: Mapping rules may be utilized to alter the Retention period for a given Job and its affiliated Report(s). However, the Checker, which is normally executed after Mapping Rules in the ir_process.sh file, sets the Default or FORM and CLASS specific retention times, as applicable, to each report that enters the Output Manager EM system based upon retention time settings defined on the t_oprt_time table in the Output Manager EM database. If Mapping Rules functionality is to be utilized to override the retention time setting established by the Checker, Mapping Rules need to be executed again after the Checker in the ir_process.sh file. Extreme care should be taken in this scenario to prevent overlapping Mapping Rules from being inadvertently applied to a specific Job and the affiliated Report(s) more than once.

SLA Service Level Agreement; the time by which the job must be printed.



Source The Logical or Actual Data Transmission (DT) client name used in Output Manager EM to represent the source from which the print job arrived into the Output Manager EM system. The Source is represented by a number (Client ID) in the Output Manager EM database and is resolved to an alphanumeric text string of up to fifteen characters. For Mapping Rule entries that use Source as the Match Column or Replace Column value, the alphanumeric Client Name must be used in the Match Value or Replace Value entry fields as applicable.

Step Name The JCL Step Name (STEP) used to process the print file being submitted to Output Manager EM, or the value of the “‐step” parameter when using the Output Manager EM Submission Client. Consists of free format text of up to eight alphanumeric characters.

Submitting Node The node name of the mainframe host where the print job that created the print file was submitted for execution. This field is populated with the value of the node parameter from the default configuration file when a print job is submitted to Output Manager EM using the Output Manager EM Submission Clients. Values are up to four alphanumeric characters.

Submitting System ID The System ID of the mainframe host where the print job that created the print file was submitted for execution. This field is reserved for internal use when a print job is submitted to Output Manager EM using the Output Manager EM Submission Clients. Values are alphanumeric and up to four characters.

Title Title is a text description of the print job and may contain up to sixty alphanumeric characters. It is originally specified on the OUTPUT card in the JCL of the host job used to submit the print job, or can be specified using the -title parameter of the Output Manager EM Submission Clients.

TRC Table Reference Character. Whether the logical record for each output line in the print stream contains TRC codes. The TRC code specifies which table name in the CHARS parameter is to be used to print the record.



Parameter A flag indicating whether or not Table Reference Characters are used in a print job. Values are Y, N and not specified.

UCS Universal Character Set name specified in the JCL on the OUTPUT or DDNAME cards for the print file being created. UCS names are up to four alphanumeric characters in length, for example, GT12.

User Account Contains accounting information as entered on the host JCL JOB card used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -usracctparameter. May contain up to thirty‐two alphanumeric characters.

User Address Contains address information as entered on the host JCL OUTPUT card used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -usraddr parameter. Up to two hundred and forty alphanumeric characters. User Address is logically split into four sixty‐byte character sequences for individual placement typically on banner pages. However, it is stored in the Output Manager EM database as one contiguous grouping of 240 characters. Using User Address in Mapping Rules changes the value of all 240 bytes. If you would like to alter the individual sets of 60 bytes separately, use User Address Line 1 through User Address Line 4 listed below.

User Address Line 1 See description in User Address. This field contains the first 60 bytes of the User Address as stored in the Output Manager EM database for the print job. When using the Output Manager EM Submission Clients, it is the value specified for the -usraddr1 parameter

User Address Line 2 See description in User Address. This filed contains the second 60 bytes of the User Address as stored in the Output Manager EM database for the print job. When using the Output Manager EM Submission Clients, it is the value specified for the -usraddr2 parameter.



User Address Line 3 See description in User Address. This filed contains the third 60 bytes of the User Address as stored in the Output Manager EM database for the print job. When using the Output Manager EM Submission Clients, it is the value specified for the -usraddr3 parameter.

User Address Line 4 See description in User Address. This filed contains the fourth 60 bytes of the User Address as stored in the Output Manager EM database for the print job. When using the Output Manager EM Submission Clients, it is the value specified for the -usraddr4 parameter.

User Building Contains Building information as entered on the host JCL OUTPUT card used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -usrbldg parameter. Up to sixty alphanumeric characters.

User Department Contains Building information as entered on the host JCL OUTPUT card used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -usrbldg parameter. Up to sixty alphanumeric characters.

User ID Contains the site‐specific User ID “of record” to identify the submitter of a job as entered in the host JCL used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -useridparameter. Up to eight alphanumeric characters, for example, A1234567, JDOE.

User Name Contains the preferred User Name to be printed on banner pages to identify the submitter/owner of a job as entered on the host JCL OUTPUT card used to submit the print job, or when using the Output Manager EM Submission Clients, is the value specified for the -prgname parameter. Up to sixty alphanumeric characters.

User Parameters 0 through 15

Used to document additional information about a print job as it is submitted to a Output Manager EM system. Each User Parameter entry may contain up to one hundred alphanumeric characters. When using the Output Manager EM Submission Clients, the values are specified using the “‐up0” through -up15 parameters. The meaning of each User Parameter is site‐specific. For example: Print Deadline, Customer Info, Printer Setup Specifications, Print Job Requirements, etc.



User Room Contains Room information as entered on the host JCL OUTPUT card used to submit the print job, or when using the Output Manager EM Submission Clients. It is the value specified for the -usrroomparameter. Up to eight alphanumeric characters.

User Room Long Similar to User Room. When using the Output Manager EM Submission Clients, is the value specified in the -usrroomlong parameter. Up to sixty alphanumeric characters.

MGR Merge Group The Output Manager Merge Group value assigned to this job. An empty or blank string indicates no merge group.

MGR Modifier The Output Manager Modifier to be used with this job.

MGR Output The OM_VIPFLEX or vip_cntl name that is the intended output destination for this job. This field drives the Output Manager AWS process.

MGR Transfer Priority A priority value used in Output Manager AWS processing to determine whether a job transferred to a Output Manager platform can be preempted. High values are assigned for GUI driven activities and for jobs started on a Output Manager output client.

MGR View The Output Manager station on which viewing conversion is done. This should be left blank if it is the same as VIP_OUTPUT. This field drives the Output Manager AWS process.

Virtual Printer Identifies the required logical printer name (or queue) to which a print job should be directed. When using the Output Manager EM Submission Clients, this is the value specified for the -vpparameter. Up to 100 alphanumeric characters.

Visible Indicates whether the print job is visible in the Output Manager EM Job Queue. For site‐specific reasons, jobs that enter the Output Manager EM system may need to be hidden from operators or other users as they may be automatically processed using AWS. The options are Y or N.

To control whether a user can see these jobs, see View Invisible Jobs.


APPENDIX W: BANNER PAGES

Appendix W: Banner PagesBanners are usually setup with a default banner for each OM. In addition to the default banners, the banners produced by the output managers, described in the Printers section, are site configurable.

Xerox & Line mode banner pagesThe default start, end, cancel, and position banner page layouts are defined by the following files:

ombanner.sbombanner.ebombanner.cbombanner.pb

These are located in /ops/data. If a file with the name of a printer and an extension of sb, eb, cb, or pb are present, it is used instead, allowing printers specific banners. These files are basically static text files that are reproduced on the banner pages. Text within a “$(..)” are dynamic values that are replaced at print time by job or printer values.

The format is:

$(parmname,columnwidth,options)

The longest line in the file determines the width of all lines in the banner. The space the dynamic tag definition takes in the file is not counted in the line spacing directly, but space must be given to the right, and possibly below, the definition for the dynamically expanded form. Any static text to the right of the variable may be overwritten by the dynamic data. These parameters are not case sensitive.

The values are:

JOBNAME Job name

JOBID OPS Job id

JOBNO MVS JOBNO

JOBFORM Form of job

JOBGROUP Group of job

CLASS Job class

PRINTER The name of the printer where job was printed

DRIVER The Output Manager EM driver used to print the job

ORIGSYSID Original system id

USERID Submitting user id

USERNAME Submitting user name

ROOM Delivery room (short)

BUILDING Delivery building

DEPARTMENT Delivery department

ADDRESS Delivery address



WIDTH

Following the parameter name is the width of the expansion in characters. This should be the maximum expected value for the dynamic value. Any additional characters in the dynamic value are truncated.

OPTIONS

Following the width is a comma‐delimited list of additional options affecting the appearance of the dynamic value expansions. These options may occur in any order and are not case‐sensitive. If none of these options is specified, the default is to use a normal one‐byte‐high expansion left justified. If any of the sizing parameters are used, the default 5x7 block font with letters from the current letter is used unless the ’JES’ option (12x12) is explicitly stated.

The options are:

CLASS Class of job

TYPE Type of banner (START, END, or CANCEL

BANNERINFO Information about how the job is being handled

DATE Date of print in form MM/DD/YYYY

DATESMALL Date of print in form DD MMM YY

TIME Time of print in form HH:MM:SS

RJDL Report JDL (can use JDL in place of RJDL)

RJDE Report JDE (can use JDE in place of RJDE)

PRMODE The print mode of the job

OJDL JDL assigned to the printer (this can be designated in the Printer Setup Display)

OJDE JDE assigned to the printer (this can be designated in the Printer Setup Display)

OPRMODE The print mode assigned to the printer (this can be designated in the Printer Setup Display)

TITLE Title

ROOMLONG Delivery Room (long)

SMALL Widen the font by expanding each character horizontally to two character widths.

MEDIUM Similar to SMALL, but by three character widths.

LARGE Similar to SMALL, but by four character widths.

SHORT Make the font taller by expanding each dot vertically by two character heights.

TALL Similar to SHORT, but by three character heights.

HUGE Similar to SHORT, but by four character heights.

HASH Instead of using the letter in the block, use a hash ’#’.



(SMALL, MEDIUM, LARGE) and (SHORT, TALL, HUGE) and (CENTER, RIGHT) are mutually exclusive; the right‐most option taking precedence.

Example:

$(jobname, 8, italic, center, small, tall, large, hash, short, right) job name

The right‐justify uses the default 5x7 font but is expanded by two dots vertically (SHORT) and four dots horizontally (LARGE) for a 10x28 character block font that uses hashes (#) instead of letters and skews each row of the character definition to the right by one for each row from the bottom (ITALIC).

The block lettering should extend past any or all of the static text in the definition file, you should append spaces to at least one line such that the width of the entire banner can be enlarged to that width.

Similarly, if block lettering is to extend past the bottom of the static file, additional blank lines should be inserted in the banner definition file. If this is not done, truncation occurs.

You may have as many lines and tags as you wish in the definition file as long as this is acceptable to the printer. Carriage control is automatically generated to ensure that the top of each banner starts at the beginning of the page and that each line represents one line of the banner page. However, in some environments the banner printed may not be in a suitable font or orientation to display all of the data on the page. Tags are processed from top to bottom and left to right such that if any dynamic values expand over each other, this is the order of expansion.

Output Manager Banner PagesStandard Output Manager banner pages are printed by default. If custom banners are required, follow the procedure in the Output Manager User Guide, then add SEPHEADER and SEPTRAILER to printer.vipopt with the path name and file name to call the customized banner pages.

The fields sent from Output Manager EM to Output Manager and made available for inclusion on the Banner pages created by Output Manager are as follows:

ITALIC Skew the top of each letter to the right

JES Use the 12x12 JES block font instead of the default 5x7 block font.

CENTER Center‐justify the dynamic value in the center of the width specified.

RIGHT Right‐justify the dynamic value to the right of the width specified.

Output Manager EM Field Output Manager Field

JobName HOSTJOBNAME/HOSTTEXT1

Job Number HOSTJOBID/HOSTTEXT2

Flex Unique JOB ID HOSTTEXT3/HOSTTEXT4

Class HOSTTEXT5



PCL & PS banner pagesTo configure banner pages for PCL and PS, the banner pages must exist and their locations entered in the environmental table, t_open_env. The parameters are as follows:

LPRStartBannerPCLLPRFinishBannerPCLLPRStartBannerPSLPRFinishBannerPCL

The parameter values are the path and file names, for example, /ops/data/startBanner.pcl or /ops/data/endban.ps.

The Device Properties for the printers must then be configured:

1. Open Device Properties window for the relevant device.

Form HOSTTEXT6

Dest ID HOSTTEXT7

Flex JOB ID HOSTTEXT8

Orig Sys ID HOSTTEXT9

Exec Sys ID HOSTTEXT10

Orig Node HOSTTEXT11

Exec Node HOSTTEXT12

Job Ticket HOSTTEXT13

Virtual Printer HOSTTEXT14

User Parameter 0 through 15 HOSTTEXT15 through HOSTTEXT30

Output Manager EM Job Title (if not blank)

HOSTTEXT37

Output Manager EM Job Priority HOSTTEXT38

Output Manager EM Job User AccountField

HOSTTEXT39

Report Step HOSTTEXT90

User ID HOSTUSERID

User Name HOSTUSERNAME

User Room HOSTROOM

User Building USERBLDG

Class HOSTDEPT

Group HOSTCLASS

Group HOSTGROUP

Form HOSTFORM

Address 1 through 4 HOSTADDRESS, HOSTADDRESS2, HOSTADDRESS3, HOSTADDRESS4

Printer Name HOSTDEST



2. Open the Banners tab.

3. Select the Start Banners and End Banners options.

4. Enter the number of Banner Pages required.


The om_lpr module is for PostScript, PCL and PDF printing on a Xerox printer. The module first determines whether the format is PCL or PS and whether banner printing entries have been selected. If the banner files exist and the environmental table has recorded their locations, header and trailer banners are printed for PostScript and PLC files. Banner page printing for PDF files is not currently supported.


APPENDIX X: OUTPUT MANAGER EM LICENSE KEY INSTALLATION

Appendix X: Output Manager EM License Key InstallationOracle

Follow the procedure below:

1. Open a terminal window and type:

ShowHostKey

The response should be similar to:

hostname = opslinuxsrv.nw.pb.comIPAddress = 0a19060fHost Key = opslinuxsrv.nw.pb.com0a19060f54

2. Contact Pitney Bowes Customer Support. Tell them the Host Key and they send you the security key file.

If there is a change to the network IP address a new security key is required.

3. Open the terminal window.

4. Go to the directory where you have just saved the security key file.

5. At a Command prompt, type sqlplus.

6. For User, enter ops.

7. For Password, enter ops.

8. Enter the sqlplus key @xxxxx.key.sql.

9. Commit Complete is now displayed.

10. Type quit and press <Enter> to exit sqlplus and then exit the terminal window.


APPENDIX X: OUTPUT MANAGER EM LICENSE KEY INSTALLATION

PostgreSQLFollow the procedure below:

1. At a Command prompt, type :

psql

2. For User, type:

ops

NOTE: Depending on the database setup, this step may not appear.

3. For Password, type:

ops

4. At the ops=# prompt, type:

\i xxxxxx.key.SQL

5. The following is displayed:

DELETE 1INSERT 0 1DELETE 1INSERT 0 1etc.psql:xxxxxx.key.SQL:113: WARNING: there is no transaction in progressCOMMITops=#

This warning can be ignored.

6. At the ops=# prompt, type:

\q

7. Press <Enter> to exit psql and then exit the terminal window.


APPENDIX Y: SSL SUPPORT


Appendix Y: SSL SupportIf possible, LDAP under SSL should be used which encrypts passwords. To use LDAPs, the LDAP <hostname>:<port> needs to be in the format:

ldaps://hostname:port

The server SSL certificate needs to be added to the default java keystore. Under Linux, the keystore is located in:

$JAVA_HOME/jre/lib/security/cacerts

Under windows, this is:

\Program Files (x86)\PB\jre7\lib\security\cacerts

The server certificate must be provided by the LDAP administrator to prevent “man in the middle” spoofing attacks. If the administrator is unable to provide a host certificate, it may be downloaded, provided you are sure that the host LDAP site is not spoofed. Using a Linux machine, type the following from a terminal window:

echo -n | openssl s_client -connect LDAPhostname:LDAPsport | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > LDAPserver.pem

Replace LDAPhostname:LDAPsport with the your LDAPs hostname. By default, the LDAPsport is 636 but might be set to a different value by the LDAP administrator.

Copy the cacerts file to a local directory and add the host certificate to it using the keytool.

$JAVA_HOME/bin/keytool –import -file LDAPserver.pem –alias UNIQUE_HOSTNAME_ALIAS –keystore cacerts

The syntax of the keytool command may be different, depending on the format of the host certificate. The default password for cacerts is changeit .

If the default cacerts file cannot be updated, an alternate location can be used. When using the GUI, the Common.properties field OPS_SSL_CERTICATE can be used to point to an alternative location, for exampe:

OPS_SSL_CERTIFICATE = c:/localdir/cacerts

In addiotn, FlexConfigure can support an alternative SSL certificate location by setting the SSL_CERTIFICATE parameter in the FlexConfigure.sh script:

SSL_CERTIFICATE=/usr/java/jre/lib/security/cacerts

Technical SupportYou will find full details of the configuration and operation of this product in the user documentation supplied. Should you encounter any difficulties that you cannot resolve with aid of the user documentation, you will be able to obtain technical support from your supplier, or from Pitney Bowes.

Support Email Address: [email protected]

AMER:

Hours: Monday ‐ Friday from 08:00 – 20:00 EST excluding US Holidays

Phone: +1 800 367 6950

Or if dialing from outside the US: +1 518 285 7283

APAC:

Hours: Monday – Friday from 08.00 ‐ 18.00 AEST excluding Public Holidays

Phone: +1 800 648 899

Or if dialing from outside Australia : +61 2 9475 3500

EMEA:

Hours: Monday ‐ Friday from 9:00 am to 5:30 pm GMT, excluding Bank Holidays

Phone: +44 800 840 0001

(option 1, 8)

mailto:[email protected]

3001 Summer StreetStamford CT 06926-0700www.pitneybowes.com

UNITED STATESpb.com/softwareTechnical Support:support.pb.com

CANADA pb.com/softwareTechnical Support:support.pb.com

EUROPE/UNITED KINGDOMpitneybowes.co.uk/softwareTechnical Support:pitneybowes.co.uk/software/support

ASIA PACIFIC/AUSTRALIApitneybowes.com.au/softwareTechnical Support:pbinsight.com.au/software/support

http://www.pitneybowes.com

http://www.pb.com/software

http://www.pitneybowes.co.uk/software

http://www.pitneybowes.com.au/software

http://www.pb.com/software

mailto:support.pb.com

mailto:support.pb.com

mailto:pitneybowes.co.uk/software/support

mailto:pbinsight.com.au/software/support

engageone output manager - pitney bowes€¦ · the engageone output manager em edition...

Documents