P/I Enterprise Manager Version: 1.4

WatchDT User Guide 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 600 6 Hercules Way Leavesden Watford WD25 7GS United 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, P/ITM Output Manager, P/ITM Output Enhancement, P/ITM Enterprise Manager, P/ITM Wizard, P/ ITM Direct Access, P/I 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 Contents OVERVIEW ...... 5 Watch_DT executables...... 5 INSTALLING WATCH_DT ...... 6 Linux Platforms...... 6 Windows Platforms...... 6 Watch_DT configuration file...... 6 Linux ...... 6 Windows...... 7 WATCH_DT BATCH FILE SETUP ...... 8 Linux Platforms...... 8 Windows Platforms...... 8 PARAMETERS ...... 9 Positional parameters...... 9 Named parameters...... 10 RECURSIVE FILE PROCESSING ...... 17 Configuring Recursive File Processing...... 17 WATCHDT_Config in sub-directories...... 17 WATCH_DT CONFIGURATION FILE ...... 19 Filename parsing parameters...... 20 Processing Rules...... 21 Example Configuration File...... 22 Configuration File Parameters ...... 41 FSESCCL CONFIGURATION FILES ...... 50 Locating the FSESCCL configuration file ...... 50 Setup ...... 51 Assumptions and Considerations ...... 51 WATCH_DT SUPPORT FOR P/I OFFICEMAIL FILES ...... 53 APPENDIX A: INSTALLING AND EXECUTING WATCH_DT ON LINUX ...... 54 Installing Watch_DT...... 54 Invoking Watch_DT ...... 54 Verifying the Watch_DT install...... 55 Alternate method of verifying Watch_DT...... 55 APPENDIX B: INSTALLING AND EXECUTING WATCH_DT ON WINDOWS PLATFORMS ...... 56 APPENDIX C: RUNNING MULTIPLE INSTANCES OF WATCH_DT ...... 57 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE ...... 58 Command line options...... 58 INSTALL ...... 59 ALTER ...... 60 REMOVE ...... 60 START ...... 60 STOP ...... 61 PAUSE ...... 61 RESUME ...... 61 QUERY ...... 62 STATS ...... 63

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 3 TABLE OF CONTENTS

Sample Statistical Reports...... 64 Daily ...... 64 Cumulative...... 64 Parameters ...... 65

4 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE OVERVIEW

Overview

Watch_DT continually scans a directory structure, selecting applicable files and processes them for transmission to a specified P/I Enterprise Manager system. Watch_DT allows the transmission of the following data streams from an Windows or Linux environment to a specified P/I Enterprise Manager system.  text  PostScript  PCL  Line  Page/AFP  LCDS  META  PDF  VIPP Print stream parameters associated with a data streams can be set for specific jobs, or all jobs in a watched directory using configuration files. Watch_DT executables There are currently two variants of the Watch_DT executable file:

Watch_dt This processes files in the watch directory and uses the prefix name of the file as the Job Name (‘-jobname’ parameter) on the underlying FSESCCL invocation. For example, a file named testjob.pcl, using prefix.suffix format, renders the prefix as ‘testjob’. If using FSESCCL to transmit files to P/I Enterprise Manager, the job is submitted with the ‘-jobname testjob’ command line parameter name/value pair which overrides any specification of jobname in the configuration file used to process the print file. Windows platforms: watch_dt.exe Linux platforms: watch_dt watch_dt_c This processes files in the watch directory and gives all command line parameter name/value pair precedence to the applicable configuration file used to send the file to a P/I Enterprise Manager system. For example, using the filename, testjob.pcl, if an applicable configuration file, FSESC_Config.testjob exists in the watch directory and it specifies ‘jobname pcltest1’, then the job is submitted to P/I Enterprise Manager and appears in the Job Queue by the name PCLTEST1 instead of TESTJOB. Windows platforms: watch_dt_c.exe Linux platforms: watch_dt_c

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 5 INSTALLING WATCH_DT

Installing Watch_DT

Linux Platforms The installation of Watch_DT on Linux platforms is not currently an automated process. The executable is delivered via FTP, email and/or CD-ROM for installation on the target platform. Specific instructions are provided by Pitney Bowes regarding the installation and use of the product. Refer to “Appendix A: Installing and Executing Watch_DT on Linux” on page 54 for generic installation instructions. Contact Pitney Bowes for more information about Watch_DT for the Linux platforms.

Windows Platforms The installation of Watch_DT on Windows platforms is achieved by running the Submission Utilities Installer, ENT1.4_FSE_SUI, or the Client Utilities Installer, ENT1.4_FSE_CUI. These are distributed as self-extracting setup programs. Refer to “Appendix B: Installing and Executing Watch_DT on Windows Platforms” on page 56 for generic installation instructions. Contact Pitney Bowes for more information about the Submission Utilities and Client Utilities Installers.

Watch_DT configuration file If you intend using the Watch_DT configuration file, copy the one provided to an appropriate directory.

Linux The sample WATCHDT_Config file is installed in: /data/WATCHDT_Config where is usually of the form: \ops\R5.3 \ops\R5.4 \ops\R5.5 \ops\ENT1.0 \ops\ENT1.1 \ops\ENT1.2 \ops\ENT1.3 \ops\ENT1.4 etc.

6 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE INSTALLING WATCH_DT

Windows The sample WATCHDT_Config file is installed in: \

\config\ WATCHDT_Config where: The drive letter and path that the user selects (default is: C:\Program Files (x86)\PB\ENT1.4\bin\

An abbreviation for the marketing designation for the release, for example, P/I Enterprise Manager 1.4. This is usually the literal "ENT" followed by the release ., for example, ENT1.4. Watch_DT is installed separately as part of the Submission Utilities Installer, ENT1.4_FSE_SUI, or the Client Utilities Installer, ENT1.4_FSE_CUI. Modify the WATCHDT_config and at the very minimum set the following parameters: wdir dest OStype Refer to “Parameters” on page 9 for more information.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 7 WATCH_DT BATCH FILE SETUP

Watch_DT Batch File Setup

Linux Platforms A shell script can be created on Linux platforms to execute Watch_DT. For example, a file could be created called watch1_afp.sh in the /PB/watch/afp directory. Assuming that ‘watch_dt’ is found in the path, the contents of the file might be as follows: #!/bin/ksh watch_dt /PB/watch/afp P/I Enterprise Managerhostname page The permission attributes for the shell script file must be set to allow execute permission on the user, group and other as appropriate to your installation. Windows Platforms This file, or a modified copy of it, can be used to start one to many instances of Watch_DT as background tasks. The format of the Watch_DT command in the batch file is similar to that executed from the command line. Both the positional, and the parameter name/value pair command formats are supported within the batch file. For an explanation of command line options, see “Parameters” on page 9.

NOTE: For more information on these command line options, execute watch_dt -help.

For an example, see “Example Configuration File” on page 22. Also see “Appendix C: Running Multiple Instances of Watch_DT” on page 55.

8 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE PARAMETERS

Parameters

This section describes each command line parameter (except those when running Watch_DT as a Windows service, see “Appendix D: Running Watch_DT as a Windows Service” on page 58). Positional parameters watch_dt|watch_dt_c watch_directory ip_address|hostname process_mode [platform_indicator] [utility_name] [dir_timer] [file_timer]

WATCH_DIRECTORY Mandatory. A valid DOS directory name. Used by the Watch_DT application to identify the directory to be scanned to transmit files to P/I Enterprise Manager.

IP_ADDRESS|HOSTNAME Mandatory. A valid IP address or resolvable hostname. This is used by the Watch_DT application to identify the P/I Enterprise Manager system to which files are transmitted.

PROCESS_MODE Mandatory. Enables Watch_DT to filter the transmission of files to those that match the specified process mode. Files transmitted by process mode must have a file extension of that mode, these are:

LCDS Xerox LCDS mode LINE Line mode META Xerox Meta PAGE or AFP AFP and Mixed mode PCL PCL mode PDF Portable Document Format PS PostScript mode TXT Text mode VIPP Variable Data Intelligent PostScript PrintWare OFMA P/I OfficeMail mode NONE All modes

PLATFORM_INDICATOR Optional. The on which Watch_DT is being executed; if entered, the permitted values are Windows or Linux. This is no longer used by Watch_DT.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 9 PARAMETERS

UTILITY_NAME Optional. The P/I Enterprise Manager client submission utility used to process the file; if specified, this is one of the following:

FSESCCL P/I Enterprise Manager Client Submission command line. This is the default. FSESCUI P/I Enterprise Manager Submission Client User Interface

DIRECTORY CYCLE TIMER Optional. The directory scanning cycle wait time. Watch_DT opens the specified directory and scans for files to be processed and sent to a P/I Enterprise Manager site. Once complete Watch_DT closes the directory and waits the specified number of seconds before starting again. The permitted value is in the range 0 – 99999 seconds. The default is 30.

FILE STATUS CYCLE TIMER Optional. The time, in seconds, to wait while processing a file in the watch directory if that file is in use by another application. For example, another application may be writing a file into the watch directory, while this is happening, Watch_DT scans the directory and determines whether the file is eligible to be processed and transmitted to P/I Enterprise Manager. Watch_DT queries the system file status indicators to ascertain whether the file is in use. If so, Watch_DT waits for the specified time, then queries the system file status indicators. This processing loop occurs four times after this point, if the file is still ‘in use’ Watch_DT skips processing of the file and moves on to the next file in the directory. The permitted value is in the range 0 – 60 seconds. The default is 15. Named parameters In addition to the positional parameters, Watch_DT supports command line options by name; in this mode, the parameter name is listed followed by its parameter value: watch_dt|watch_dt_c [-CONFIG configFileName ] [-FSESCCONFIG fsescConfigFileName] [-WDIR dirParm] [-DEST IP|Hostname] [-PRMODE prMode [-OSTYPE OStype] [-UTILNAME utilName] [-DTIMER dTimer] [-FTIMER fTimer] [-DELETEOK OKTimer] [-DELETEFAIL FailTimer] [-TIMESTAMPOK YES | NO] [-TIMESTAMPFAIL YES | NO] [-RECURS YES | NO] [-PARMREF CONFIG | STANDARD] [-RETRYFAILEDSUBMISSION NO | NEXT | ALWAYS] [-LOGDIR logDirParm] [-USECOMPLOGFILENAME YES | NO] [-OFMABUNDLETYPE bundletype] [-OFMAENABLED YES | NO] [-OFMAMODTYPE Modtype] [-OFMATICKETTYPE tickettype] [-LOGCOUNT maxlogs]

10 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE PARAMETERS

[-ROLLLOGS YES | NO] [-SKIPTEMPFILES YES | NO] [-TESTMODE YES | NO | ERROR] [-UNIXSPECIALCHARS YES | NO] [-VIPMODENABLED YES | NO] [-VIPMODPARMPREF VIPMOD | FILENAME] [-VIPMODTYPE modifierFileType] {LISTFOOT}

NOTE: The names and positional parameters cannot be mixed and matched, you must use one set or the other.

CONFIG The name of the Watch_DT configuration file. Refer to “Watch_DT Configuration File” on page 19.

FSESCCONFIG The default config file name passed to the fsesccl utility. If not specified, Watch_DT searches for an appropriate config file based on FSESC_Default_Config.

WDIR The watched directory; this must be a valid absolute, relative or UNC formatted directory path.

DEST Formerly IP|Hostname. The destination P/I Enterprise Manager system to which the processed files are sent using FSESCCL. The permitted values are: • A hostname. Either explicitly justified or fully qualified, for example, flexuk01.PB.com. • An IP address.

PRMODE The specific PDL type, if known, of the files processed from the watched directory. The file extension or prMode value in the job-specific configuration file may be used to set the PDL type for the file during submission. Alternatively, the prMode can be the same as the file extension if the useExtPrMode option is configured. In addition, the prMode can be set using the filename parameter parsing. The permitted values range are:

afp Advanced Function Presentation, fully-composed MO:DCA lcds Xerox Line Conditioned Data Stream line IBM 3211 Line data meta Xerox MetaCode none PDL type not specified for the watched directory (default) page Same as afp pcl Printer Control Language pdf Portable Document Format ps PostScript

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 11 PARAMETERS

txt ASCII Text vipp Variable-data Intelligent PostScript Printware

OSTYPE The operating system on which Watch_DT is running. This is no longer required but is maintained for compatibility.

UTILNAME The Submission utility used submit the print file. The permitted values are:

fsesccl P/I Enterprise Manager Submission Client Command Line. If used the transmission occurs entirely in the background without user intervention. fsescgui P/I Enterprise Manager Submission Client User Interface. If used the P/I Enterprise Manager Submission Client User Interface is opened during transmission. In this case the submission parameters may be customized on an individual job-by-job basis as a print file appears in the watch directory. This is the default.

DTIMER The directory cycle time controlling the length of time, in seconds, between scans for new files of a watch directory.

FTIMER The file “in use” cycle time controlling the length of time, in seconds, that Watch_DT waits for a file to become available before moving on to the next file in the current directory. This prevents transmission of files currently being written by another application. If Watch_DT encounters a file whose size changes within the “in use” cycle time, it moves on to subsequent files. This feature is currently only used on the Linux platforms as Windows has other methods of determining whether a file is not currently in use. The permitted value is in the range 0 - 60. The default is 15.

DELETEOK The automatic file deletion time, in minutes, for successfully transferred files. Successfully submitted files are given an .fsesccl extension and are automatically deleted after the time specified here. The permitted value is in the range 0 - 5256000 (10 years). The default is 0. This parameter can be disabled by setting the value to N (-DELETEOK N).

DELETEFAIL The automatic file deletion time, in minutes, for files that failed to transfer. These are given an .error extension and are automatically deleted after the time specified here. The permitted value is in the range 0 - 5256000 (10 years). The default is 0. This parameter can be disabled by setting the value to N (-DELETEFAIL N).

12 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE PARAMETERS

TIMESTAMPOK Whether the time stamp is reset after successfully transferring the file via FSESCCL. The permitted values are:

YES The time stamp is set to the current time, the file is deleted when the time set by DELETEOK elapses. This is the default. N0 The time stamp is not reset.

TIMESTAMPFAIL Whether the time stamp is reset after failing to transfer the file via FSESCCL. The permitted values are:

YES The time stamp is set to the current time, the file is deleted when the time set by DELETEOK expires. This is the default. N0 The time stamp is not reset.

RECURS Whether to recursively process the directory tree from the root watch directory, as specified by WDIR, down through the subdirectory tree). The permitted values are YES or NO. The default is NO.

PARMREF How to derive the submission parameters when a file is processed. The permitted values are:

CONFIG All submission parameters is derived from the applicable Watch_DT or FSESCCL configuration files used when the file is processed. STANDARD The JobName submission parameter is derived from the file name being processed. The FSESCCL destination submission parameter is:  The value specified on the Watch_DT command link, or  The FSESCCL configuration file specified on the Watch_DT command line, or  The Watch_DT configuration file (with the order of preference). This is the default.

RETRYFAILEDSUBMISSION Whether to retry when an ospdt/fsesccl transmission has failed due to network issues. The permitted values are:

NO Do not retry. NEXT Retry once. ALWAYS Retry on every loop.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 13 PARAMETERS

LOGDIR Specifies the absolute or relative path to which the logging file is written. If missing, the default location is the path specified by -WDIR.

USECOMPLOGFILENAME The log file name to use when running a command line application. The permitted values are:

YES WatchDT.log, the compatibility log file name, is used. NO WatchDTLog is used. This is the default.

When running Watch_DT as a Windows service, the log file name is Watchdt_n.log where n is the service instance number determined during installation, for example, first instance number is 1, second 2, etc.

OFMABUNDLETYPE Optional. Specifies the extension of the P/I OfficeMail bundle file. This parameter has no effect unless OFMAENABLED=YES. Note that different bundle file types are generated by different versions of P/I OfficeMail.

Version of P/I OfficeMail Bundle File type 2.0 PDF 3.0 BSV. This is the default.

OFMAENABLED Optional. Indicates if P/I OfficeMail bundle processing is in effect. Requires prmode=OFMA. The permitted values are:

YES Watch_DT scans for P/I OfficeMail bundle, ticket and modifier files. When found, all of these files are transmitted as a set via FSESCCL. NO There is no P/I OfficeMail bundling. This is the default.

OFMABUNDLETYPE, OFMAMODTYPE and OFMATICKETTYPE relate to this parameter.

OFMAMODTYPE Optional. Specifies the extension of the P/I OfficeMail modifier file. This has no effect unless OFMAENABLED=YES. Note that different modifier file types are generated by different versions of P/I OfficeMail.

Version of P/I OfficeMail Modifier File type 2.0 PDF.MOD 3.0 BSV.MOD. This is the default.

OFMATICKETTYPE Optional. Specifies the extension of the P/I OfficeMail ticket file. Has no effect unless OFMAENABLED=YES. The permitted value is a file extension. The default is tkt.

14 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE PARAMETERS

Note that P/I OfficeMail 2.0 and P/I OfficeMail 3.0 both generate a ticket file of type TKT.

LOGCOUNT Works in conjunction with ROLLLOGS=Yes. Determines the maximum number of watch_DT logs. If this limit is reached, the oldest log is deleted. The default value is 10.

ROLLLOGS At start-up and at midnight, the current log file is rolled to WatchDTlog.1. Older log files are also rolled to their next higher number. The values are YES and NO. The default is NO, logs are not rolled.

SKIPTEMPFILES Whether files with a filename prefix, suffix or extension of temp. are skipped and not processed. The values are YES and NO, where no specifies that the files are processed normally. The default is YES.

TESTMODE Whether he FSESCCL submission is simulated with a successful return code (RC=0). The values are: YES the FSESCCL submission is simulated. ERROR the FSESCCL submission is simulated and a return code indicating a failure (RC=-1) results. NO files are processed normally by FSESCCL. This is the default.

UNIXSPECIALCHARS Whether special shell processing is used to allow Unix shell special characters like $ to be used in job filenames. The values are YES and NO. The default is NO.

VIPMODENABLED Whether the watch directory is searched for VIP Modifier files. Any parsed VIPMOD keywords are substituted by a corresponding opsdt keyword and passed to opsdt along with the VIPMOD value. Opsdt keywords are matched to VIPMOD keywords in WATCHDT_Config using the VIPMODFSESCCL configuration option. TThe values are YES and NO. The default is NO.

VIPMODPARMPREF determines which parameter will have precedence if an opsdt parameter is specified by both a VIPMOD file as well as filename parameter parsing. The values are VIPMOD or FILENAME. VIPMOD is the default.

VIPMODTYPE Specifies the filetype to be scanned for VIP Modifiers. The Default is MOD.

LISTFOOT This is a standalone option, with no parameters, which displays version information in case it is requested by support. Typing watch_dt –listfoot on the command line displays the following: Enterprise Manager Watch DT Version 6.4.0 Pitney Bowes Inc. Copyright (C) 1999-2015, All Rights Reserved

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 15 PARAMETERS

Bld: Oct 20 2015-03:44:06 Mod: Tue Oct 20 00:32:18 2015

Listfoot version information: watch_dt: Executable Format (.FOOTPRINT BIN) Manner of creation ({-c attribs}target: sources ...): R64_BRANCH_BUILD_102015 -- watch_dt Sources: 06 Oct 2015 14:30:50 opsversion.h 09 Mar 2015 16:03:50 watch_dt.h 20 Oct 2015 00:32:18 watch_dt.c end of listfoot

16 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE RECURSIVE FILE PROCESSING

Recursive File Processing

If the Watch folder contains sub-directories, Watch_DT recursively scans each of these. A different version of WATCHDT_Config can be placed in each sub-folder, so that files can be processed differently depending on the folder in which are placed. Therefore, a single instance of Watch_DT can scan a number of different directories and deal with a variety of file inputs. Configuring Recursive File Processing The main WATCHDT_Config file resides in the Watch_DT root directory. Within this file the recurs parameter controls recursive directory/sub directory processing:

RECURS Specifies whether recursive file processing is to occur. The permitted values are:

YES Recursive file processing is to occur. NO Only files in the top level of the watch file are scanned

The following parameters may only be set in main WarchDT_Config file:  wdir  dtimer  logdir  usecomplogfilename Refer to “Configuration File Parameters” on page 41 for descriptions of these parameters. These options are ignored if found in any other configuration file further down the directory structure. Other parameters may be set in this file, but are overwritten if re- set by a local version of WATCHDT_Config in a sub-directory.

WATCHDT_Config in sub-directories Each sub-directory can have its own version of WATCHDT_Config. This enables files in different sub-directories to be processed differently. If using files in this way, please note the following points:  Sub-directories of sub-directories can be scanned and can have their own local copy of WATCHDT_Config. As many levels as required may exist in the hierarchy, although this is dependent on the number allowed by the operating system.  recurs=NO can be set in any version of WATCHDT_Config. Recursive processing stops at this point and any sub-directories further down the hierarchy are NOT searched.  Any parameter set in a WATCHDT_Config overwrites any settings made further up in the hierarchy.  You need only specify parameters that change in a local copy of WATCHDT_Config. Other parameters are inherited if set further up the hierarchy.  The only exception is filename parsing parameters. If any of these are reset, then ALL filename parsing set at higher levels is ignored. Therefore, if you change

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 17 RECURSIVE FILE PROCESSING

filename parsing, then you must define all the required parameters in the local copies of WATCHDT_Config. For example, if the main WATCHDT_Config is set as follows: recurs=YES dest=dallas prmode=PS utilname=fsesccl ftimer=5 deleteOK=10 deleteFail=5 and there is a sub-directory of the main watch directory called Boca_Watch and there is a local version of WATCHDT_Config in this directory, set as follows: recurs=NO dest=boca The following happens:  A data file found in the main watch directory has its destination set to dallas.  The Boca_Watch directory is scanned.  A data file found in the sub-directory has its destination set to boca.  Any sub-directory of the Boca_Watch directory is NOT scanned.

18 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

Watch_DT Configuration File Setting up Watch_DT to automatically transmit print files to P/I Enterprise Manager requires the creation/modification of one or more data transmission configuration files.

NOTE: • The Watch_DT and FSESCCL configuration file parameters cannot be mixed and matched. • The Watch_DT parameters can be used in both the Watch_DT command line and the configuration file, with the Watch_DT command line taking precedence. • The Watch_DT configuration file is read every time the watch directory is scanned. Changes to this file are processed dynamically, there is no need to restart Watch_DT.

Refer to “FSESCCL Configuration Files” on page 50 for more information on using the FSESCCL method of transmitting print jobs using configuration files. The location of the configuration file is determined by the presence of applicable command line options specifying locations to scan:

-WDIR The directory is specified, but not the filename. There must be a file called WATCHDT_CONFIG in the directory, or an error is returned and Watch_DT exits. For example, WATCH_DT -WDIR C:\WATCHDIR The software scans for a file called WATCHDT_CONFIG in directory WATCHDIR.

-CONFIG A fully qualified filename is specified. For example: watch_dt -config c:\watchdir\WATCHDT_Config. The software scans for a file called WATCHDT_CONFIG in directory WATCHDIR. No option The directory and filename are not specified. The current working directory is scanned for the file. For example, WATCH_DT The software scans for a file called WATCHDT_CONFIG in the current working directory.

NOTE: • The Watch_DT configuration file should not be confused with the FSESCCL configuration file, refer to “FSESCCL Configuration Files” on page 50. • A default Watch_DT configuration file is supplied with this release; this can be copied and modified as necessary.

The basic elements of the configuration file are:

Comments Lines beginning “#” are comments and are not processed when the configuration file is read.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 19 WATCH_DT CONFIGURATION FILE

Directory Specification Lines beginning “[” (open square bracket) denote a directory to be scanned. Each line beginning “[” must contain a valid directory path terminated with a “]” (closing bracket), for example: [/OPS/WATCHDIR]for Linux [C:\WATCHDIR] for Windows Only one directory can be specified in the configuration file. This is the same as the command line DIRPARM positional parameter on the Watch_DT command line. Parameter Name/ Lines formatted as “PARM_NAME=PARM_VALUE” define Values configuration parameters and their values. These parameters are similar to the command line parameters listed previously, see “Named parameters” on page 10. When the parameter is listed on both the command line and in the configuration file, the command line parameter has precedence. Examples of these parameters are as follows: PRMODE=prMode OSTYPE=OStype UTILNAME=utilName DTIMER=dTimer FTIMER=fTimer DELETEOK=OKTimer DELETEFAIL=FailTimer

Refer to “Filename parsing parameters” on page 20 for descriptions of these and additional configuration parameters related to filename parameter parsing. Filename parsing parameters Filename parsing allows segments of a file being processed for transmission to be used as FSESCCL submission parameter values during the transmission.

FDPC=”_” Filename parsing delimiter character. Defines the character(s) used to parse the filename into segments. The character is specified in quotes. The default is an underscore “_”.

FPDT=”.” File name parsing termination character. Defines the character used to separate the filename from the extension. The character is specified in quotes. The default is a period (".").

FPETMM=EXTENSION Optional. Filename parsing extension type, where MM is the enumerated identifier.

FPTRNN[:MM]=FSESCCLOPTION Filename parsing segment relationship where NN is the segment number in the filename and MM is the associated extension identifier, derived from FPETMM. MM is optional and if not specified, the token relationship is the default for that segment number.

20 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

USEEXTASPRMODE Allows Watch_DT to automatically generate a prMode option based on the file extension. The values are YES and NO without the quotes. The default is NO. If the PRMODE is set via an FPTRNN option, then the extension PRMODE is not issued. For example, DFLT-DEFAULT-PRT11-A-INV.META where:

DFLT JDE name DEFAULT JDL name PRT11 DEST-ID (or device name) A Submission class INV Job Name

In this case, when not specifying extensions, using the above filename, the values for these parameters are as follows: fpdc=“-” fpdt= “.” fptr01=jde fptr02=jdl fptr03=destid fptr04=class fptr05=jobname In a more complicated scenario, you may wish to configure the token relationships based on the file type written to the watch directory. This is achieved as follows: fpdc=“-” fpdt= “.” fpet01=meta fpet02=afp fptr01:01=jde fptr02:01=jdl fptr01:02=pagedef fptr02:02=formdef fptr03=destid fptr04=class fptr05=jobname With this setup, if a file with an extension of META is placed in a watch directory, the file is submitted to P/I Enterprise Manager with segment #01 used as the JDE parameter value and segment #02 used as the JDL parameter value. Likewise, if a file with an extension of AFP is placed in the watch directory, the segment #01 is used as the page definition parameter value and segment #02 is used as the form definition value. In either case, if the file type specific notation is not explicitly specified, that is, in the parameters FPTR03 through FPTR05 above, then those segment value relationships are used for all file types processed in the watch directory. Processing Rules 1. Multiple delimiter characters can be defined, for example, FPDC = “_-“, where the delimiter is an underscore or a dash. 2. The FPDT value should not be the same as the FPDC value.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 21 WATCH_DT CONFIGURATION FILE

3. The FSESCCL option is not checked for validity by Watch_DT. If an illegal or unknown FSESCCL option is used, an error is returned and transmission of the job is aborted. The failed job is given an ".error" extension. Example Configuration File ################################################################# # This configuration file is used to customize Watch_DT. # ################################################################# # # The configuration file can be referenced by the command line # option "-config" when executing Watch_DT. # # For example # # watch_dt -config /ops/data/WATCHDT_Config # # Lines beginning with "#" are considered comments and ignored # by Watch_DT. # # The configuration parameters can be referenced in this config- # uration file or on the command line when launching Watch_DT or # both. When the parameter is listed on both, then the command # line option will have precedence. # # Watch directory - The directory that Watch_DT watches is en- # closed by square brackets. # # For Windows platforms, the drive letter should also be used. # [c:\watchdir] # For UNUX platforms, this should be specified off the root. # [/ops/watchdir] # If supported by the OS and the credentials of the user/account # being used to execute Watch_DT are sufficient, then UNC paths # may also be specified. # [\\servername\mount_point\directory\sub-directory] # # Note: If this is the root of the watch directory tree, then the # watch directory must be specified. If this is recursive sub-directory # (see RECURS later in this document), then this watch directory # does not have to be specified, # # The remainder of the options and values consist of keyword # pairs and values separated by an equal sign. # #################################################################

# CHECKFILESIZEFORCOMPLETE - Check for changing file size. # When set to Yes, WatchDT will use the original algorithm for # determining if a file being written into the watch directory # is complete and ready for transmission. If set to "No", a # more efficient algorithm will be used by Watch_DT that can # determine if a file is ready to be transmitted without the # delay incurred using the original algorithm. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. #

22 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

#CheckFileSizeForComplete=No

# DELETEFAIL - File deletion retention time for files that are # not transmitted successfully. # Time (in minutes) that the transmitted file will be deleted # from the watch directory after a FAILED transmission. # Valid range: # 0 - 52,560,000 (ten years) # # The file that failed to be transmitted can also be configured # to never be deleted by setting the parameter value to 'n' # (e.g.: deletefail=n). # # Note: This parameter is OPTIONAL. # Note: Default value is 0 (delete immediately). # #DeleteFail=0

# DELETEJOBCONFIGFILE - Delete file-specific submission # configuration file? # If set to "Yes", Watch_DT will delete the FSESCCL or OPSDT # file-specific submission configuration file. The file- # specific submission configuration file will be of the form: # # FSESC_Config. # # or # # opsDTconfig. # # where must match the basename of the file # to be transmitted where files have the file name syntax: # # . # # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #DeleteJobConfigFile=No

# DELETEJOBCONTROLFILESn - Specify action on control files after # successful file transmission. # If set, Watch_DT will treat files with the # as a file to be filtered from sending via fsesccl where # the filename syntax is: # # . # # In addition, when the associated job file is deleted, the file # with filename extension will also be deleted. For ex- # ample, if the job file is named "09091001.dat" and the value # specified for this parameters is "ctl", then file # "09091001.ctl" will be deleted when file "09091001.dat" is # automatically deleted. Watch_DT supports specification of up

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 23 WATCH_DT CONFIGURATION FILE

# to 2 control file types by specifying DeleteJobControlFiles1 # and DeleteJobControlFiles2. # # Note: This parameter is OPTIONAL. # Note: The default action is to process and transmit all files # encountered in a watch directory with the exception of # known control files and files specified by this param- # eter. # #DeleteJobControlFiles1=ctl #DeleteJobControlFiles2=nfo

# DELETEOK - File deletion retention time for successfully # transmitted file. # Time (in minutes) that the transmitted file will be deleted # from the current directory after a SUCCESSFULL transmission. # Valid range: # 0 - 52,560,000 (ten years) # # The transmitted file can also be configured to never be deleted # by setting the parameter value to 'n' (e.g.: deleteok=n). # # Note: This parameter is OPTIONAL. # Note: Default value is 0 (delete immediately). # #DeleteOK=0

# DEST - Destination IP address or Hostname of target FlexServer # platform. # #Dest=172.28.12.233

# DTIMER - Directory cycle timer (in seconds). # Valid range: # 0 - 99999 # # Note: This parameter is OPTIONAL. # Note: Default value is 30. # Note: If WatchDT is executed on the command line using the # positional command format syntax and [fTimer] is # specified, this parameter becomes MANDATORY. # #DTimer=30

# FILELOCKPRETEST - File Lock Pre-Test # This parameter controls whether or not WatchDT will attempt to # perform a file rename test prior to processing a file. If the # test is performed and WatchDT can not rename the file success- # fully, then the file will be skipped and processed later and # will be assumed to be in use by another application. If the # file can be renamed, processing will continue on the file nor- # mally. # # Note: This parameter is only effective on Windows platforms. # Note: This parameter is OPTIONAL. # Note: Default value is YES. #

24 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

#FileLockPreTest

# FSESCCONFIG - FSESCCL Submission Configuration file. # This parameter allows the specification of a file name to be # passed into the "-config " option on the # FSESCCL command line. This file name can be specified by # providing the extension of a local FSESC_Config file, or by # explicitly specifying the absolute path and file name to be # used. In local mode, the name specified is appended to # "FSESC_Config". For example, if the fsescConfig value is: # # fsescConfig=myconfig # # then the file name "FSESC_Config.myconfig" would be used from # the local directory. If an absolute/explicit path and # name is used similar to: # # fsescConfig=C:\ops\data\fsescp1.cfg (Windows) # # or: # # fsescConfig=/ops/data/fsescp1.cfg (Unix) # # then the the config file named "fsescp1.cfg" in the platform- # specific "/ops/data" subdirectory will be used as entered # without adding the "FSESC_Config." prefix. If neither is # found, then the "FSESC_Default_Config" is searched in the # current directory. # #FSESCConfig=

# FTIMER - File status cycle timer (in seconds). # Valid range: # 0 - 60 # # Note: This parameter is OPTIONAL. # Note: Default value is 15. # #FTimer=15

# LOGCOUNT - Maximum number of Watch_DT log files to maintain. # If specified, this parameter specifies how many previous it- # erations of the Watch_DT log file to keep before deleting the # oldest iteration. Specifying a value of 0 will have the net # effect of not rolling the log files. See also ROLLOGS param- # eter. # Valid range: # 0 - 30 # # Note: This parameter is OPTIONAL. # Note: Default value is 10. # #LogCount=10

# LOGDIR - User-specified Logging Directory. # Use this parameter to specify the relative or explicit logging # directory path where the Watch_DT log file should be written.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 25 WATCH_DT CONFIGURATION FILE

# If not specified, the log file will be written to the path # specified by the "-WDIR" parameter by default. If "-WDIR" is # also not specified, then the current working directory will be # used as the logging directory path. # # Note: This parameter is OPTIONAL. # Note: If path specified contains spaces, then use double quotes # ("path name") to enclose the path specified. # #Examples for Windows OS: #LogDir="c:\explicit\log file\directory" #LogDir=..\relative\log\directory # #Examples for UNUX: #LogDir="/explicit/log file/directory" #LogDir=../relative/log/directory

# OFMABUNDLETYPE - Specify the extension of the OFMA Bundle file. # When specified, this parameter specifies the filetype extension # for the OFMA bundle. # # Note: This parameter is OPTIONAL. # Note: Default value is "BSV" which is the default for PI # OfficeMail 3.0. For PI OfficeMail 2.0, use "pdf". # Note: This parameter, if present, has no effect unless # OFMAENABLED is set to YES. # #OfMaBundleType=BSV

# OFMAENABLED - Is Office Mail Bundle processing in effect? # If set to YES, Watch_DT will scan for Office Mail bundle files # (default filetype "VBS"), OFMA ticket files (default file type # "TKT") and OFMA modifer files (default type "MOD"). When found, # all of the files will be transmitted together as a set via # FSESCCL. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # Note: To use this parameter, the PRMODE parameter must be set # to OFMA for this transmission configuration. # #OfMaEnabled=NO

# OFMAMODTYPE - Specify the extension of the OFMA Modifier file. # When specified, this parameter specifies the filetype extension # for the OFMA modifier file. # # Note: This parameter is OPTIONAL. # Note: Default value is "mod" which is the default for PI # OfficeMail 3.0. For PI OfficeMail 2.0, use "pdf.mod". # Note: This parameter, if present, has no effect unless # OFMAENABLED is set to YES. # #OfMaModType=mod

26 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# OFMATICKETTYPE - Specify the extension of the OFMA Ticket file. # When specified, this parameter specifies the filetype extension # for the OFMA ticket file. # # Note: This parameter is OPTIONAL. # Note: Default value is "tkt". # Note: This parameter, if present, has no effect unless # OFMAENABLED is set to YES. # #OfMaTicketType=tkt

# OSTYPE - Local machine Operating System type. # Valid values: # UNIX # NT # # Note: This parameter is optional for backward compatibility. # Note: If a value is specified, it is no longer checked. # #OSType=NT

# PARMPREF - FSESCCL submission parameter preference selection. # When set to "Config", watch_dt_c compatibility mode is # enabled where the -jobname and -dest parameters are suppressed. # In this case, an FSESC_Config file must supply the jobname and # dest parameters. If set to "Standard", then the -jobname and # -dest parameters will be issued to FSESCCL on the command line. # Valid values: # CONFIG # STANDARD # # Note: This parameter is OPTIONAL. # Note: Default value is STANDARD. # #ParmPref=Standard

# PRMODE - Process mode of print file. # Valid values: # PS # PCL # PDF # PAGE # LCDS # AFP # TXT # LINE # META # VIPP # OFMA # NONE # If the prmode is not specified, then the prmode will be deter- # mined from the file extension of the job in the directory. # #PrMode=none

# RECURS - Recursively process directory tree?

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 27 WATCH_DT CONFIGURATION FILE

# If set to "Yes", then the subdirectories of the current # directory will be scanned for eligible files to be selected # and transmitted. If set to "No", then any subdirectories # found in the current directory will be skipped. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #Recurs=No

# RETRYFAILEDSUBMISSION - Attempt to retransmit a file that was # previously unsuccessfully transmitted. # This parameter determines the action to take when a file # transmission fails with a network communication error. If set # to NO, the file will be renamed with the ".error" suffix and no # attempt will be made to automatically retransmit the file. If # set to NEXT, the file will be renamed with the ".retry" suffix # and an attempt will be made to retransmit the file one time # the next time the directory is processed. If the subsequent # transmission attempt also fails, the file will be renamed with # the ".error" suffix and no further attempt will be made to # retransmit the file. If set to ALWAYS, the file will be # renamed with the ".retry" suffix and an attempt will be made # to retransmit the file each time the directory is processed # until the file is successfully transmitted. # Valid values: # NO # NEXT # ALWAYS # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #RetryFailedSubmission=NO

# ROLLLOGS - Manage the Watch_DT Log Files. # If set to YES, Watch_DT will rename ("roll") the base log file # from "" to ".1" and all other exist- # ing log files from ".n" to ".n+1". # If the LOGCOUNT parameter value setting is exceeded, the last # log file being rolled will be deleted. Log file management # occurs at program start-up as well as at midnight. If set to # NO, Watch_DT will not roll the log file and the log file will # grow in size until it is manually erased. See also LOGCOUNT # parameter. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #RollLogs=No

# SKIPTEMPFILES - Skip temporary files

28 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# This parameter controls whether or not WatchDT will skip files # that are named with the filename prefix "temp." or the filename # suffix/extension ".temp". If set to YES, these temporary files # will be skipped and not processed. If set to NO, files with # the filename prefix "temp." or suffix/extension ".temp" will be # processed normally. # # Note: This parameter is OPTIONAL. # Note: Default value is YES. # #SkipTempFiles

# TESTMODE - Set Test Mode # When specified, this parameters is used to control whether # submission by FSESCCL is actually performed or simulated, and # if simulated, whether or not the submission is SUCCESSFUL or # results in an ERROR. This can be used to verify how files will # be processed without actually attempting to transmit them with # FSESCCL. # Valid values: # NO Transmit files (Default) # YES Simulate SUCCESSFUL file transmissions # ERROR Simulate FAILED file transmissions # #TestMode=NO

# TIMESTAMPOK - Update file timestamp if transmission is # successful. # If set to YES, the timestamp of a successfully transmitted # file will be set to the current time immediately after adding # the ".fsesccl" suffix. If set to NO, the file will be renamed # but the timestamp will remain unchanged. The timestamp on the # file is used by the deleteOK option to determine when enough # time has elapsed to delete the file. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is YES. # #TimeStampOK=YES

# TIMESTAMPFAIL - Update file timestamp if transmission is # unsuccessful. # If set to YES, the timestamp of an unsuccessfully transmitted # file will be set to the current time immediately after adding # the ".error" suffix. If set to NO, the file will be renamed # but the timestamp will remain unchanged. The timestamp on the # file is used by the deleteFail option to determine when enough # time has elapsed to delete the file. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is YES. # Note: If an attempt is to be made to resume/recover interrupted

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 29 WATCH_DT CONFIGURATION FILE

# file transmissions, this parameter should be set to NO. # By maintaining the original timestamp, when processed # again after a transmission interruption, the file will # resume transmission from the last checkpoint and the # ".error" suffix will be automatically removed if the # recovery is successful. Otherwise, the updated timestamp # on the file may cause the transmission receiver to # interpret the file as a new print job being received # instead of performing a recovery. # #TimeStampFail=YES

# UNIXSPECIALCHARS - Specify how to handle special characters # while performing Unix transmissions. # The Unix based WatchDT uses the Unix shell to start FSESCCL. # There are several characters that can be part of filenames that # can confuse the shell including dollar sign ($) and ampersand # (&). If unixSpecialChars is set to YES, Watch_DT will surround # filenames and fsesccl command-line parameters with single # quotes to stop the Unix shell from interpreting the Unix spec- # ial characters. unixSpecialChars is not used for Windows based # Watch_DT. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #UnixSpecialChars=No

# USECOMPLOGFILENAME - Use compatibility Watch_DT Log file name? # If set to YES, Watch_DT uses the log file name "watchDTlog" # when running as a command-line application for backward com- # patibility with prior versions of Watch_DT. Otherwise, the log # file will be written to "WatchDT.log" when running as a command # -line application. If Watch_DT is running as a Windows # Service, the log file name is established based upon the # Service instance number (e.g.: WatchDT_1.log, WatchDT_2.log, # etc.) and this parameter setting is ignored. # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #UseCompLogFilename=No

# USEEXTASPRMODE - Use File Extension as prmode. # Flag that indicates if the prmode value should be specified # based upon the extension of the file being transmitted. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # Note: If the file extension is also set by a file name # parameter parsing value (e.g. fptr1=prmode), then # the file name parameter parsing token value will have

30 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# precedence. # #UseExtAsPrMode=Yes

# UTILNAME - FlexServer data transmission utility name. # Valid values: # FSESCCL # FSESCGUI # FSESCGUIPOD # # Note: This parameter is OPTIONAL. # Note: Default value is FSESCCL. # UtilName=fsesccl

# VIPMODENABLED - Are VIP modifier files supported? # If set to YES, Watch_DT will scan for VIP Modifier files. # VIP modifier files will have the same filename as the file # to be transferred with a filetype determined by VIPMODTYPE. # Any parsed keywords from the VIP modifier file will be substituted # by a corresponding fsesccl keyword and passed to fsesccl along # with the parsed VIP modifier value. NOTE: When this mode is enabled, it # is expected that all files in this directory will have a VIP modifier. # Any files that are not accompanied by a VIP modifier will be skipped. # # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #VipModEnabled=NO

# VIPMODFSESCCL - This option will link a specific VIP Modifier keyword # with a fseesccl parameter name. This option is dependent on # VipModEnabled=Yes. The format is # # VIPMODFSESCCL=VipModKeyword FsescclParameterName # # with a space(s) separating VipModKeyword and FsescclParameterName. # If set, the fsesccl parameter name will be sent to fsesccl # along with the VIP modifier value associated with the VIPMOD # value. # # For example, if the VIP Modifier file has an entry # # HOSTJOBNAME=G56JRK # HOSTUSERID=JHOBBS # HOSTUSERNAME=TESTNAME # HOSTFORM=STD1 # CLASS=1 # HOSTDEST=EMTEX # HOSTJOBID=10242321 # COPIES=1 # HOSTGROUP= # # If the following were defined for the above mod file: #

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 31 WATCH_DT CONFIGURATION FILE

# VipModFsesccl HOSTJOBNAME jobname # VipModFsesccl HOSTUSERID userid # VipModFsesccl HOSTFORM form # VipModFsesccl CLASS class # VipModFsesccl HOSTUSERNAME usracct # VipModFsesccl HOSTDEST destid # VipModFsesccl HOSTJOBID jobno # VipModFsesccl COPIES copies # VipModFsesccl HOSTGROUP group # # The resultant fsesccl command would be # # fsesccl -dest ..... -jobname G56JRK -userid JHOBBS -form STD1 -class 1 # -usracct TESTNAME -destid EMTEX -jobno 10242321 -copies 1 jobfilename # # ## Note: When recursive directory processing is enabled, the # VipModFsesccl statements may be inherited to lower level # directories with the following exception: # If VipModFsesccl is specified in a child directory # then NO inheritance will take place and ALL VipModFsesccl # statements must be restated in the child directory config # file. # # There are no default definitions for VipModFsesccl # # VipModFsesccl HOSTJOBNAME jobname # VipModFsesccl HOSTUSERID userid # VipModFsesccl HOSTFORM form # VipModFsesccl CLASS class # VipModFsesccl HOSTUSERNAME usracct # VipModFsesccl HOSTDEST destid # VipModFsesccl HOSTJOBID jobno # VipModFsesccl COPIES copies # VipModFsesccl HOSTGROUP group

# VIPMODPARMPREF - FSESCCL submission parameter preference selection # when a FSESCCL parameter name is duplicated by VIPMOD processing # as well as filename parameter parsing. If set to VIPMOD. the # FSESCCL parameter value will be set VIP Modifier processing. If set # FILENAME, the FSESCCL parameter value will be set filename parameter # parsing. # Valid values: # VIPMOD # FILENAME # # Note: This parameter is OPTIONAL. # Note: Default value is VIPMOD. # #VipModParmPref=VIPMOD

# VIPMODTYPE - Specify the extension of the VIP Modifier file. # When specified, this parameter specifies the filetype extension # for the VIP modifier file. # # Note: This parameter is OPTIONAL. # Note: Default value is "mod"

32 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# Note: This parameter, if present, has no effect unless # VIPMODENABLED is set to YES. # #VipModType=mod

# WINSPECIALCHARS - Specify how to handle special characters # while performing Windows transmissions. # The Windows based WatchDT uses the DOS shell to start FSESCCL. # There are several characters that can be part of filenames that # can confuse the shell including the ampersand (&). # If winSpecialChars is set to YES, Watch_DT will surround # filenames and fsesccl command-line parameters with double # quotes to stop the DOS shell from interpreting the special # characters. winSpecialChars is not used for Unix based # Watch_DT. # Valid values: # YES # NO # # Note: This parameter is OPTIONAL. # Note: Default value is NO. # #WinSpecialChars=No

################################################################# # The following parameters are used to configure the file name # parsing (FP) parameters. Using this capability, the file name # can be used to set multiple FSESCCL submission options where # each option is represented by a segment of the file name. The # segments are separated by the default or user-specified # delimiter character(s). # # Note: All file name parsing parameters are OPTIONAL. However, # if one FP parameter is specified, there may be coreq- # uisite dependencies for other FP parameters to also be # specified simultaneously to allow FP functionality to # produce the desired results. # # Note: When recursive directory processing is enabled, file # parsing directives may be inherited to lower level- # directories with the following exceptions: # - If FPCL is specified in a child directory with a # different value than the parent directory, or # - If any FPET, FPTRnn, FPSP, FPFEN, FPFFN or FPFSN # parameter is specified in a child directory # then NO inheritence will take place and ALL file parsing # directives must be restated in the child directory config # file. ################################################################# # #------# FPCL - File name parsing capability level. #------# Specifies the file parsing mode that should be used to parse # a file. There are three possible settings: # 0 - File parsing is DISABLED # 1 - Compatibility mode (direct assignment) # 2 - Extended mode (variable assignment) #

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 33 WATCH_DT CONFIGURATION FILE

# When set to 0, file parsing is disabled in the directory that # is being processed and the defaults are used for the FPDC and # FPTC settings (see below). # # When set to 1, file parsing will occur with direct assignment # of tokenized file name segments to FSESCCL submission para- # meters. Assignment is made using the FPTRnn, FPFEN, FPFFN and # FPFSN parameters (see below). # # When set to 2, file parsing will occur with indirect assign- # ment of tokenized filename segments to variables first, and # then from the variables to FSESCCL submission parameters. # Assignment to variables is made using the FPTRnn, FPFEN, FPFFN # and FPFSN parameters (see below) while assignment to FSESCCL # submission parameters is made by using FPSP parameters (see # below). FPSP parameters allow full or partial variable values # to be assigned using subscript range specifications as well as # using fixed text comingled with the variable names (see below). # # Note: This parameter is OPTIONAL. # Note: Default value is 1 (Compatibility mode) # #FPCL=1

#------# FPDC - File name parsing delimiter character. #------# Defines the character(s) used to separate the file name being # processed into usable "segments". The delimiter character is # enclosed by double quotes. # # Note: This parameter is OPTIONAL. # Note: Default value is an underscore ("_"). # #FPDC="_"

#------# FPDT - File name parsing delimiter terminator. #------# Specifies the character that separates the file stem (base) # name from the file extension (usually a period, '.'). The FPDT # value is enclosed by duoble quotes. # # Note: This parameter is OPTIONAL. # Note: Default value is a period ("."). # #FPDT="."

#------# FPETmm - File name parsing extension type. #------# With FPCL=1: # ------# It is possible to assign FSESCCL submission parameter options # dependent upon the file name extension of the file being trans- # mitted. FPETmm=extension is used to define the relationship of # the file extension to the file name parsing token (segment) # relationship (FPTRnn=parameter) values where mm is the file

34 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# extension association identifier. The syntax: # # fpetMM=extension # fptrNN:MM= # or # % # # is used to associate the parsed file name segment 'NN' with the # file extension identifier MM and the fsescclOption submission # option. MM can be any positive number beginning at 1. # For example: # # fpet01=meta # fpet02=afp # fpet03=ps # fptr01=jobname # fptr02=form # fptr03=class # fptr-02:01=jde # fptr-01:01=jdl # fptr-02:02=pagedef # fptr-01:02=formdef # fptr04:03=title # # Since fptr01=jobname does not contain a colon, it is considered # the default assignment of the first parsed segment value to the # FSESCCL "-jobname " submission parameter and will be # applied to all files transmitted. If the file name is: # # metajob_std_X_myjde_myjdl.meta # # then the FSESCCL utility will be invoked with the following # command line: # # fsesccl -prmode meta ... -jobname metajob -form std # -class X -jde myjde -jdl myjdl # metajob_std_X_myjde_myjdl.meta # # If the file name is: # # afpjob_std_B_PDEF01_FDEF01.afp # # then the FSESCCL utility will be invoked with the following # command line: # # fsesccl -prmode page ... -jobname afpjob -form std # -class B -pagedef PDEF01 -formdef FDEF01 # afpjob_std_B_PDEF01_FDEF01.afp # # If the file name is: # # psjob_frm1_p_Weekly Report.ps # # then the FSESCCL utility will be invoked with the following # command line: # # fsesccl -prmode ps ... -jobname psjob -form frm1 # -class p -title "Weekly Report" # "psjob_frm1_p_Weekly Report.ps" # #

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 35 WATCH_DT CONFIGURATION FILE

# With FPCL=2: # ------# When FPCL=2, the assignment of file name segments to variables # can be made to be specific to the file extension being pro- # cessed. The syntax: # # fpetMM=extension # fptrNN:MM=% # # For example: # fpet01=meta # fpet02=afp # fpet03=ps # fptr01=%jobname # fptr02=%form # fptr03=%class # fptr-02:01=%jde # fptr-01:01=%jdl # fptr-02:02=%pagedef # fptr-01:02=%formdef # fptr04:03=%title # # Using the same files as above, if the file name is: # # metajob_std_X_myjde_myjdl.meta # # then the variable values assigned would be: # # %jobname = "metajob" # %form = "std" # %class = "X" # %jde = "myjde" # %jdl = "myjdl" # # If the file name is: # # afpjob_std_B_PDEF01_FDEF01.afp # # then the variable values assigned would be: # # %jobname = "afpjob" # %form = "std" # %class = "B" # %pagedef = "PDEF01" # %formdef = "FDEF01" # # If the file name is: # # psjob_frm1_p_Weekly Report.ps # # then the variable values assigned would be: # # %jobname = "psjob" # %form = "frm1" # %class = "p" # %title = "Weekly Report" # #FPETnn=

#------

36 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# FPFEN - File name parsing file extension name. #------# After a file name has been parsed into segments, this parameter # assigns the value of the file name extension (if identifiable) # to: # 1) a FSESCCL submission parameter when FPCL=1, or # 2) a WatchDT variable name when FPCL=2. # # For example (assuming default FPDC and FPTC values): # # With FPCL=1: # ------# fptr01=jobname # fptr02=prmode # fpfen=up10 # # If the file name is "weekly_ps_std_blue.ps", then FSESCCL will # be invoked as follows: # # fsesccl -jobname weekly -prmode ps -up10 ps weekly_ps.ps # # With FPCL=2: # ------# fpfen=%Var06 # # If using the same file name above, the variable would be # assigned: # # %Var06 = "ps" # # Note: This parameter is OPTIONAL. # #FPFEN=

#------# FPFFN - File name parsing file full name. #------# Similar to the FPFEN parameter above, this parameter will # assign the file full name to: # 1) a FSESCCL submission parameter when FPCL=1, or # 2) a WatchDT variable name when FPCL=2. # # Note: This parameter is OPTIONAL. # #FPFFN=

#------# FPFSN - File name parsing file stem (base) name. #------# Similar to the FPFEN parameter above, this parameter will # assign the file stem (or base) name (i.e.: the file name with- # out the extension and seperating character defined by FPTC) to: # 1) a FSESCCL submission parameter when FPCL=1, or # 2) a WatchDT variable name when FPCL=2. # # Note: This parameter is OPTIONAL. # #FPFSN=

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 37 WATCH_DT CONFIGURATION FILE

#------# FPSP_ - File name parsing submission parameter. #------# The FPSP parameter is allowed only when FPCL=2. This parameter # allows submission parameters to be assigned values in a flex- # ible manner based upon the file name extension (associated with # the FPETmm parameter) of the file being processed. Assignments # can be made using: # # 1) fixed text # 2) WatchDT variables # 3) substrings of WatchDT variables # 4) any mixture of the above # # For example: # fpet01=meta # fpet02=afp # fpet03=ps # fptr01=%jobname # fptr02=%form # fptr03=%class # fptr-02:01=%jde # fptr-01:01=%jdl # fptr-02:02=%pagedef # fptr-01:02=%formdef # fptr04:03=%title # fpsp_jobname=%jobname # fpsp_form=%form # fpsp_class=%class # fpsp01_jde=%jde # fpsp01_jdl=%jdl # fpsp02_pagedef=%pagedef # fpsp02_formdef=%formdef # fpsp03_title=%title # # Using the same files as above, if the file name is: # # metajob_std_X_myjde_myjdl.meta # # then the submission parameter values assigned would be: # # ... -class X -form std -jobname metajob # -jde myjde -jdl myjdl ... # # If the file name is: # # afpjob_std_B_PDEF01_FDEF01.afp # # then the submission parameter values assigned would be: # # ... -class B -form std -jobname afpjob # -pagedef PDEF01 -formdef FDEF01 # # If the file name is: # # psjob_frm1_p_Weekly Report.ps # # then the submission parameter values assigned would be: # # ... class p -form frm1 -jobname psjob

38 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# -title "Weekly Report" # # Alternatively, using the FPSP parameter also allows multiple # variables intermixed with fixed text to be assigned to sub- # mission parameters. Variables may also be subscripted such # that only the desired portion of the variable value is assigned # to the submission parameter. Subscripting a variable value may # be performed from left-to-right by using positive numbers # starting at 1, or may be done from right-to-left by using neg- # ative numbers starting at -1. If the subscripting range speci- # fied extends completely beyond the length of the variable value # or partially beyond the length of the variable value, then the # resulting value assigned to the submission parameter will be an # empty string ("") or a partial string, respectively. # # Some examples: # fpet01=pcl # fpet03=ps # fptr01=%SEG01 # fptr02=%SEG02 # fptr-01=%SEGLAST # fptr01:01=%PCLSEG01 # fptr03:01=%PCLSEG03 # fptr04:01=%PCLSEG04 # fptr03:03=%PSSEG03 # fptr04:03=%PSSEG04 # fpsp_jobname=%SEG01[-4:-1] # fpsp_form=%SEG02[7:15] # fpsp_destid=%SEGLAST # fpsp01_jobname=%PCLSEG01[3:8] # fpsp01_up1="Use %PCLSEG03[5:12] paper." # fpsp01_up2="Print on %PCLSEG04[3:7] printer." # fpsp03_up1="Use %PSSEG03[4:7] paper size %PSSEG04[-10:-6]." # # If the file processed is: # # P#CREDIT01_X-Y-Z-STD1_FRM-GREEN_B4COLOR24_KANSAS.pcl # # then the variable assignments would be: # # %SEG01 = "P#CREDIT01" # %SEG02 = "X-Y-Z-STD1" # %SEGLAST = "KANSAS" # %PCLSEG01 = "P#CREDIT01" # %PCLSEG03 = "FRM-GREEN" # %PCLSEG04 = "B4COLOR24" # # and the resulting submission parameter assignments would be: # # ... -destid KANSAS -form STD1 -jobname CREDIT # -up1 "Use GREEN paper." # -up2 "Print on COLOR printer." ... # # If the file processed is: # # PROD0123_8X11-A_27-BILL24_a4HLITE_EUROPE.ps # # then the variable assignments would be: # # %SEG01 = "PROD0123" # %SEG02 = "8X11-A"

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 39 WATCH_DT CONFIGURATION FILE

# %SEGLAST = "EUROPE" # %PSSEG03 = "27-BILL24" # %PSSEG04 = "a4HLITE" # # and the resulting submission parameter assignments would be: # # ... -destid EUROPE -jobname 0123 # -up1 "Use BILL paper size a4" ... # # Note that any submission parameter that results in an empty # string ("") or that is not assigned a value will not be in- # cluded in the submission parameter string that is passed to # FSESCCL. # #FPSP_jobname= #FPSP_class= #FPSP_dest= #FPSPnn_formdef= #FPSPnn_pagedef=

#------# FPTR[-/+]nn - File name parsing token (segment) relationship. #------# Depending on the FPCL mode in effect, this option assigns a # parsed file name segment value from the file stem (base) name # (i.e.: does not include the file extension if it can be parsed # and identfied seperately) to either: # 1) a FSESCCL submission parameter when FPCL=1, or # 2) a WatchDT variable name when FPCL=2. # The optional '-/+' indicates which direction, right-to-left # or left-to-right (default if not specified or if just a posi- # tive number is used), respectively, to select a file name # segment. The 'nn' is the segment number, starting at 1, of the # file name that has been parsed. So, +01 (or 01) would be the # first segment of the parsed file name from left-to-right, while # -02 would be the second segment of the parsed file name from # right-to-left. If the segment number specified goes beyond the # number of parsed segments available, then no value is assigned. # # For example (assuming default FPDC and FPTC values): # # With FPCL=1: # ------# fptr01=jobname # fptr02=prmode # fptr-02=form # # If the file name is "weekly_ps_std_blue.ps", then FSESCCL will # be invoked as follows: # # fsesccl -jobname weekly -prmode ps -form std weekly_ps.ps # # Note: The fsescclOption is not checked for validity by # Watch_DT. If an illegal or unknown FSESCCL option is # used, FSESCCL will declare an error and not send the job. # The file that failed to be transmitted will be renamed by # adding ".error" as the file name extension. # # With FPCL=2: # ------

40 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

# fptr01=%var01 # fptr02=%var02 # fptr-02=%var03 # # If the file name is "weekly_ps_std_blue.ps", then the variables # would be assigned values: # # %var01 = "weekly" # %var02 = "ps" # %var03 = "std" # #FPTRnn=

Configuration File Parameters

CHECKFILESIZEFORCOMPLETE The permitted values are:

Yes The original algorithm for determining if an incoming watch file is complete is used. No A new algorithm which has fewer delays in finding eligible files for transfer s used. This is thee default.

DELETEFAIL Time, in minutes, after which the transmitted file is deleted from the watch directory after FAILING to transfer. The permitted value is in the range 0 - 52,560,000 (ten years). In addition, the file may be configured to never delete by setting the value to 'n', for example, DELETEFAIL=N. The default value is 0 (delete immediately).

DELETEJOBCONFIGFILE The permitted values are:

YES Watch_DT deletes the fsesccl or opsdt file-specific submission configuration file. This file is of the form FSESC_CONFIG. or OPSDTCONFIG. where must match the filename of the file to be submitted. The file name must be in the format .. NO he file is not deleted. The default is No.

DELETEJOBCONTROLFILES Optional. Specifies what to do with control files after a successful file transmission and is specified in the format DELETEJOBCONTROLFILES=. If specified, a file with the same base name as the job file, and the suffix as specified by , is NOT transmitted and is deleted when the job file is deleted. The permitted values are:

=1 for the first entry of this parameter. =2 for the second entry (if required).

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 41 WATCH_DT CONFIGURATION FILE

A maximum of two entries are allowed. Example: The job file is ABC.DAT, The parameter has been set to: DELETEJOBCONTROLFILES1=CTL DELETEJOBCONTROLFILES2=NFO The software looks for two files named ABC.CTL and ABC.NFO.These two files are not transmitted and are deleted when the job file is deleted after transmission. A maximum of two file extensions may be specified. It is useful when receiving data from the OM_XFER module, which creates control files with extensions of CTL and NFO. If not specified, the default is to process all files in the watch directory.

DELETEOK The time, in minutes, between a file being successfully transferred from the watch directory and it being deleted. The permitted value is in the range 0 - 52,560,000 (10 years). DELETEOK=N specifies that the file is never deleted. The default is 0 - delete immediately.

DEST IP address or hostname of the target P/I Enterprise Manager platform.

DTIMER The directory cycle timer in seconds. The permitted value is in the range 0 - 99999. The default is 30 seconds.

NOTE: This field is mandatory if Watch_DT is executed using the command line positional parameter syntax, and if [fTimer] is specified.

FPDC Defines the filename parsing delimiter character(s) used to separate the fsesccl options. The character is specified in quotes. The default is an underscore “_”.

FPDT Defines the file name parsing termination character used to separate the filename from the extension. The character is specified in quotes. The default is a period (".").

FPETMM It is possible to assign fsesccl options that are file extension dependent.

fpetMM Defines the extension where MM is the file extension identifier. fptrN:MM fsesccl option associates the filename segment 'N' with the file extension identifier MM and the fsesccl option. For example: fpet01=meta fpet02=ps fptr01=jobname fptr02=prmode fptr03=title fptr03:01=jde fptr04:01=jdl

42 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

Since FPTR1=JOBNAME does not contain a colon, it is considered default and is applied to filenames that are not redefined. If the filename is MYMETAJOB_METAMYJDE_MYJDL.META then fsesccl is called as: FSESCCL -JOBNAME MYMETAJOB -PRMODE META -JDE METAMYJDE -JDL MYJDL MYMETAJOB_METAMYJDE_MYJDL.META. If the filename is WEEKLY_PS_WEEKLY REPORT.PS, then the default FPTR3 is used: FSESCCL -JOBNAME WEEKLY -PRMODE PS -TITLE "Weekly Report".

FPTRN Associates a segment of the filename with a parameter to be sent. N is the segment number. For example: fptr1=jobname fptr2=prmode With a filename of WEEKLY_PS.PS, fsesccl is called as follows: FSESCCL -JOBNAME WEEKLY -PRMODE PS WEEKLY_PS.PS The FSESCCLOPTION is not checked for validity by Watch_DT. If an illegal or unknown fsesccl option is used, fsesccl returns an error and does not send the job. The failed job is renamed with the ERROR extension.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 43 WATCH_DT CONFIGURATION FILE

FSESCONFIG The name and location of the FSESCCONFIG file to pass to FSESCCL. The permitted values are: • A path and file name, for example, /OPS/DATA/FSESCP1.CFG. • A file name suffix. A file name with this suffix is then looked for in the current directory. For example: FSESCCONFIG=MYCONFIG searches for a file named FSESC_CONFIG.MYCONFIG in the current directory. If, with either option, the file cannot be found, then FSESC_DEFAULT_CONFIG in the current directory is searched for.

FTIMER Optional. The file status cycle timer in seconds. The permitted value is in the range 0 - 60. The default is 15 seconds.

LOGCOUNT Optional. This parameter works with ROLLOGS. ROLLOGS, which adds or increments a counter at the end of each log file name and determines when this counter is reset. See “ROLLOGS” on page 46 . The permitted value is an integer in the range 1 - 30.

LOGDIR Optional. Specifies the absolute or relative path to which the logging file is written. If missing, the default location is the path specified by -WDIR. If -WDIR is missing, the log file is written to the current working directory. If path specified contains spaces, then use double quotes to enclose the path, for example, "PATH NAME" .

OFMABUNDLETYPE Optional. Specifies the extension of the P/I OfficeMail bundle file. This has no effect unless OFMAENABLED=YES. Note that different bundle file types are generated by different versions of P/I OfficeMail.

Version of P/I OfficeMail Bundle File type 2.0 PDF 3.0 BSV. The default.

OFMAENABLED Optional. Specifies whether P/I OfficeMail bundle processing is in effect. This has no effect unless PRMODE=YES.The permitted values are:

YES Watch_DT scans for P/I OfficeMail bundle, ticket and modifier files. When found, all of these files are transmitted as a set via FSESCCL. NO There is no P/I OfficeMail bundle processing.

OFMABUNDLETYPE, OFMAMODTYPE and OFMATICKETTYPE relate to this parameter.

44 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

OFMAMODTYPE Optional. Specifies the extension of the P/I OfficeMail modifier file. This has no effect unless OFMAENABLED=YES. Note that different modifier file types are generated by different versions of P/I OfficeMail.

Version of P/I OfficeMail Modifier File type 2.0 PDF.MOD 3.0 BSV.MOD - The default.

OFMATICKETTYPE Optional. Specifies the extension of the P/I OfficeMail ticket file. This has no effect unless OFMAENABLED=YES. The default is TKT. Note that P/I OfficeMail 2.0 and P/I OfficeMail 3.0 both generate a ticket file of type TKT.

OSTYPE Optional. The local machine Operating System. The permitted values are UNIX or NT. The values are no longer checked.

PARMPREF Specifies how the -JOBNAME and -DEST parameters are defined. The permitted values are:

Config WATCH_DT_C compatibility mode is enabled. The -JOBNAME and -DEST parameters are not issued to fsesccl on the command line. They must be supplied by an FSESC config file. STANDARD The -JOBNAME and -DEST parameters are issued to fsesccl on the command line.

PRMODE The process mode of print file. If PRMODE is not specified, then this is determined from the file extension of the job in the directory, which can be in one of the following formats.

PS LCDS LINE OFMA PCL AFP META NONE PDF TXT VIPP RECURS PAGE

The permitted values are:

YES The subdirectories of the current directory are scanned for eligible files to transfer. NO The subdirectories are skipped.

See “Recursive File Processing” on page 17.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 45 WATCH_DT CONFIGURATION FILE

RETRYFAILEDSUBMISSION Whether to retry when an OSPDT/FSESCCL transmission has failed due to network issues. The permitted values are:

NO Do not retry. NEXT Retry once. ALWAYS Retry on every loop.

ROLLOGS Optional. Specifies whether to change the log files names by adding or incrementing a counter at the end of each name. The permitted values are YES and NO. The default is NO. If set to NO, the log file name will not change. The log file will grow in size until manually deleted. For example: ROLLOGS=YES LOGFILENAME is changed to LOGFILENAME.1 LOGFILENAME.1 is changed to LOGFILENAME.2 LOGFILENAME.2 is changed to LOGFILENAME.3 If the counter value exceeds the value of LOGCOUNT, the counter is reset and the oldest log file is overwritten.

TIMESTAMPOK Whether the time stamp is reset after successfully transferring the file via FSESCCL. The permitted values are:

YES The time stamp is set to the current time. The file is deleted when the time set by DELETEOK expires). This is the default. NO The file is not deleted.

TIMESTAMPFAIL Whether the time stamp is reset after failing to transfer the file via FSESCCL. The permitted values are:

YES The time stamp is set to the current time. The file is deleted when the time set by DELETEFAIL expires). This is the default. NO The file is not deleted.

UNIXSPECIALCHARS This parameter is only applicable on Linux based operating systems. It specifies how to handle special characters while performing Linux transmissions. The Linux version of WatchDT uses the Linux shell to start FSESCCL. There are several characters that can be part of filenames that confuse the shell, including the dollar sign $ and ampersand &.

46 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

The permitted values are:

Yes Watch_DT surrounds filenames and FSESCC command line parameters with single quotes to stop these characters being interpreted. No No action is taken. This is the default.

USECOMPLOGFILENAME Optional. The log file name to use when running a command line application. The permitted values are:

YES WATCHDTLOG is used. This is the correct name for P/I Enterprise Manager versions 5.2.2 and earlier. NO WATCHDT.LOG is used. This format conforms to most log generating applications. The default.

When running Watch_DT as a Windows service, this parameter has no effect on the log file name.

USEXTASPRMODE Whether to set the prmode to be the same as the file extension. The permitted values are:

YES PRMODE is set to the file extension. NO

Note that values set by filename parameters, for example, FTPR1=PRMODE has precedence over this parameter.

UTILNAME Optional. The P/I Enterprise Manager data transmission utility name. The permitted values are: FSESCCL. The default. FSESCGUI FSESCGUIPOD

LOGCOUNT Maximum number of Watch_DT log files to maintain. If specified, this parameter specifies how many previous iterations of the Watch_DT log file to keep before deleting the oldest iteration. Specifying 0 has the net effect of not rolling the log files. The values are a number in the range 0 - 30. The default is 10. See also ROLLOGS parameter.

SKIPTEMPFILES Controls whether WatchDT skips files with the filename prefix, suffix or extension of TEMP.. If set to YES, these temporary files are skipped and not processed. If set to NO, these files are processed normally. Default value is YES.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 47 WATCH_DT CONFIGURATION FILE

TESTMODE Whether submission by FSESCCL is actually performed or simulated, and if simulated, whether the submission is SUCCESSFUL or results in an ERROR. This can be used to verify how files will be processed without attempting to transmit them with FSESCCL. The values are: NO Transmit files (Default) YES Simulate SUCCESSFUL file transmissions ERROR Simulate FAILED file transmissions

VIPMODENABLED Whether VIP modifier files are supported. If set to YES, Watch_DT scans for VIP Modifier files. These files have the same filename as the file to be transferred with a filetype determined by VIPMODTYPE. Any parsed keywords from the VIP modifier file are substituted for a corresponding fsesccl keyword and passed to fsesccl along with the parsed VIP modifier value. When this mode i s enabled, it is expected that all files in this directory have a VIP modifier. Any files that are not accompanied by a VIP modifier are skipped. The values are YES and NO. The default value is NO.

VIPMODFSESCCL Links a specific VIP Modifier keyword to a fseesccl parameter name. This option is dependent on VIPMODENABLED=YES. The format is as follows, with a space(s) separating VIPMODKEYWORD and FSESCCLPARAMETERNAME. VIPMODFSESCCL=VIPMODKEYWORD FSESCCLPARAMETERNAME If set, the fsesccl parameter name is sent to fsesccl along with the VIP modifier value associated with the VIPMOD value. For example, if the VIP Modifier file has an entry HOSTJOBNAME=G56JRK HOSTUSERID=JHOBBS HOSTUSERNAME=TESTNAME HOSTFORM=STD1 CLASS=1 HOSTDEST=EMTEX HOSTJOBID=10242321 COPIES=1 HOSTGROUP=

If the following were defined for the above mod file: VipModFsesccl HOSTJOBNAME jobname VipModFsesccl HOSTUSERID userid VipModFsesccl HOSTFORM form VipModFsesccl CLASS class VipModFsesccl HOSTUSERNAME usracct VipModFsesccl HOSTDEST destid VipModFsesccl HOSTJOBID jobno VipModFsesccl COPIES copies VipModFsesccl HOSTGROUP group

The resultant fsesccl command would be: fsesccl -dest ..... -jobname G56JRK -userid JHOBBS -form STD1 -class 1 -usracct TESTNAME -destid EMTEX -jobno 10242321 -copies 1 jobfilename

48 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT CONFIGURATION FILE

When recursive directory processing is enabled, the VipModFsesccl statements may be inherited to lower level directories with one exception, if VipModFsesccl is specified in a child directory then NO inheritance takes place and ALL VipModFsesccl statements must be restated in the child directory config file. There are no default definitions for VipModFsesccl.

VIPMODPARMPREF FSESCCL submission parameter preference selection when a FSESCCL parameter name is duplicated by VIPMOD processing as well as filename parameter parsing. If set to VIPMOD. the FSESCCL parameter value is set to VIP Modifier processing. If set FILENAME, the FSESCCL parameter value is set to filename parameter parsing. The values are VIPMOD and FILENAME. The default is VIPMOD.

VIPMODTYPE The extension of the VIP Modifier file. This is the filetype extension for the VIP modifier file. This parameter is dependent on VIPMODENABLED=YES. The default value is MOD.

WINSPECIALCHARS How special characters are handled while performing Windows transmissions. The Windows based WatchDT uses the DOS shell to start FSESCCL. There are several characters that can be used in filenames that confuse the shell including the ampersand (&). If WINSPECIALCHARS is set to YES, Watch_DT surrounds filenames and fsesccl command-line parameters with double quotes to stop the DOS shell from interpreting the special characters. WINSPECIALCHARS is not used for Unix based Watch_DT. The values are YES and NO. The default value is NO.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 49 FSESCCL CONFIGURATION FILES

FSESCCL Configuration Files

The FSESCCL configuration file is used by Watch_DT when it is transmitting data to P/I Enterprise Manager. Watch_DT needs to locate the FSESCCL configuration file. It tries a number of methods to achieve this, the next method in turn being used if the current one fails.

NOTE: The Watch_DT and FSESCCL configuration file parameters cannot be mixed and matched.

Locating the FSESCCL configuration file The ways in which Watch_DT attempts to locate the FSESCCL configuration file are listed below, in the order in which they are tried. 1. Filename derived using the job filename and parameters in the Watch_DT configuration file. See “Recursive File Processing” on page 17. A local copy of WATCHDT_Config may be placed in each sub-directory. Parameters in this file can be used to determine the name of the FSESCCL using the job file name. See “Filename parsing parameters” on page 20 for background information. The name of the FSESCCL configuration file begins with FSESC_Config, a string derived using the fptc and fptr parameters. Appended to this is a string that can be derived using the fptc and fptr parameters. For example: fptc=”_” fptr01=jobname fptr02=config Here fptc specifies that the delimiter character will be an underscore. The fptr02 parameter determines what to do with the second segment, as determined by underscores. Setting this character to config specifies that this second segment is used in the FSESCCL configuration file name. So if job file name = sum01_P1 the FSESSCL configuration file name is FSESC_Config.P1. Watch_DT looks for a file with this name in the same directory as the Watch_DT configuration file. 2. Filename derived using the Watch_DT command line. If the Watch_DT command line contains the -fsescConfig parameter, this is used in determining the FSESCCL configuration file name. The name of the FSESCCL configuration file begins with FSESC_Config, this is appended with a string defined by -fsescConfig. For example: watch_dt - wdir /watchdir - config /watchcfg/wconfig -fsescConfig P2 Watch_DT looks for a file with the name FSESC_Config.P2, in each scanned directory.

50 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE FSESCCL CONFIGURATION FILES

3. Filename set to match job file name. The software looks for a file called FSESC_Config. in each scanned directory. For example: If the job name is P2, then the software looks for a file named FSESC_Config.P2 in each scanned directory. 4. Filename and path specified in the Watch_DT command line. In option 2 above, the -fsescConfig determined one part of the file name. It can be used to determine the whole filename and the path to the folder in which it resides. In such a case, the path and filename are appended to -fsescConfig in the command line. For example: watch_dt - wdir /watchdir - config /watchcfg/wconfig -fsescConfig / watchcfg /fscon.cfg Watch_DT looks for a file with the name fscon.cfg in the folder watchcfg. 5. Filename and path specified in the Watch_DT configuration file. In option 1 above, the Watch_DT configuration file determined one part of the file name. It can determine the whole filename and the path to the folder in which it resides. In such a case, the path and filename are appended to the fsescConfig parameter in the file. For example: fsescConfig=/watchcfg/fscon.cfg Watch_DT looks for a file with the name fscon.cfg in the folder watchcfg. 6. Look for file fsescConfig in each scanned directory. In each scanned directory, the software looks for a file named fsesc_Config. 7. Look for the default FSESCCL configuration file. If all else fails, the software looks for a file named FSESC_Default_Config in the directory specified by the FSESC_CFG environment variable. Setup 1. Copy the FSESC_Default_Config file from the installation directory to each watch directory. Replace the destination, prMode, carriage control and other parameters specific to processing files used in this watch directory for transmission to P/I Enterprise Manager. 2. Setup the site default FSESC_Default_Config file, whose location is specified by the FSESC_CFG environment variable entry, by editing the file and entering your site specific preferences for transmission of files to P/I Enterprise Manager. 3. Create job/print file specific configuration files in each watch directory by copying the FSESC_Default_Config file and renaming it FSESC_Config. for each file in the watch directory, for example, .. Assumptions and Considerations  Watch_DT is not capable of transmitting files to a P/I Enterprise Manager system unless a DT configuration for your Windows machine or an Anonymous DT configuration has been entered into the P/I Enterprise Manager database. Allow Anonymous Clients must be selected in FlexConfigure’s Enter P/I Enterprise Manager Values window to enable this functionality.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 51 FSESCCL CONFIGURATION FILES

 Watch_DT assumes all file names are in a . format with no spaces in the filename. If spaces are included the results are unpredictable.  Watch_DT does not process Excel spreadsheets, Word or Write documents.  Watch_DT assumes that all files contain data. Processing an empty file gives unpredictable results.  To send PC desktop application files, for example: Microsoft Office, Acrobat, Notepad, Write, etc., to P/I Enterprise Manager, use GhostGum’s Redirection Port Monitor (RedMon). This allows you to configure a Windows based printer driver by selecting the required output PDL type from those currently supported by P/I Enterprise Manager, in order to redirect the post-printer driver output to an executable that accepts standard input (STDIN). The FSESCCL and FSESCUI support receiving input data from STDIN and so can be set up as the executable to receive the output from the selected printer driver. The printer can be configured to route the print file directly into the P/I Enterprise Manager system from the Windows application by selecting Print from the File menu in any PC desktop application.  If you use printer drivers or document production software that can only produce disk files, Watch_DT automates the submission of these files directly into P/I Enterprise Manager using either FSESCCL or FSESCUI as the Watch_DT utility.

52 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE WATCH_DT SUPPORT FOR P/I OFFICEMAIL FILES

Watch_DT Support for P/I OfficeMail Files

Watch_DT can import data from P/I OfficeMail in the following file formats, the default file type is shown in brackets:  P/I OfficeMail file bundle (BSV)  P/I OfficeMail Ticket File (TKT)  P/I OfficeMail Modifier File (BSV.MOD) All three files need to be available before they are transferred to P/I Enterprise using FSESCCL. For example: To import a P/I OfficeMail bundle 20100603_set1 bundle, the following files need to exist in the watch directory:  20100603_set1.bsv  20100603_set1.tkt  20100603_set1.bsv.mod

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 53 APPENDIX A: INSTALLING AND EXECUTING WATCH_DT ON LINUX

Appendix A: Installing and Executing Watch_DT on Linux Installing Watch_DT 1. Installed the watch_dt executable in the following location: /ops/Rm.n.y/Linux6/oraclez/bin for Linux OS machines, where:

m.n.y The major, minor and fix/patch level release of P/I Enterprise Manager. z The Oracle release value, for example 8 or 9i.

b. Ensure the Watch_dt executable has execute permission settings of r-xr-xr-x for user, group and other. Invoking Watch_DT There are three methods in which Watch_DT can be invoked: 1. At the Linux command prompt, type in the executable name and the command line parameter values. For example, from within the directory to be ‘watched’, type the following to run the process in the foreground: Linux:/PB/watch > watch_dt . fsehostname ps To run the process in the background, type: Linux:/PB/watch > watch_dt . fsehostname ps & To run the process in the background and have the it continue to execute even if you terminate the session, type: Linux:/PB/watch > (watch_dt . fsehostname ps &) 2. Edit the Linux Initialization Table file o start Watch_DT. The file may be found in the following location: /etc/inittab Three parameters for startup are required: •The watch directory • The IP address or resolvable hostname of the P/I Enterprise Manager system • The print file type. For example, if the watch_dt executable is located in the path: 200:a:respawn:su - ops -c 'watch_dt /PB/watch fsebox page' Once the /etc/inittab file is updated, run the following commands for the new entry to take effect without rebooting the Linux machine: Linux:/ > /etc/telinit qunix:/ > /etc/telinit a 3. If Watch_DT resides on a machine that is located with P/I Enterprise Manager, FlexControl could manage the execution of Watch_DT. The following is an example of an entry in the flexcontrol.cfg file:

54 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX A: INSTALLING AND EXECUTING WATCH_DT ON LINUX

#INITTAB ENTRIES QM , showend+outfile, start, stop+1, qm, 1 IR , showend+outfile, start+1, stop+1, ir, 2 RM , showend+outfile, start+1, stop+1, resmgr, 3 : : WATCH1, showend+outfile, start+1, stop+1, watch_dt, /PB/watch1 fsehostname page WATCH2, showend+outfile, start+1, stop+1, watch_dt, /PB/watch2 fsehostname ps WATCH3, showend+outfile, start+1, stop+1, watch_dt, /PB/watch3 fsehostname pcl : : Verifying the Watch_DT install Ensure that a backup of the flexcontrol.cfg file is made prior to making changes. Once the flexcontrol.cfg file has been amended verify the syntax of the entries added to the file, by running: Linux:/ops/data > flexcontrol verify To reload the FlexControl configuration file entries into memory, run: Linux:/ops/data > flexcontrol reload To check the status of each of the processes controlled by FlexControl, run: Linux:/ops/data > flexcontrol status Alternate method of verifying Watch_DT An alternate way of verifying that the Watch_DT is executing, is to run: Linux:/ops/data > ps -ef | grep watch_dt

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 55 APPENDIX B: INSTALLING AND EXECUTING WATCH_DT ON WINDOWS PLATFORMS

Appendix B: Installing and Executing Watch_DT on Windows Platforms

1. Acquire the Submission Utilities Installer (ENT1.4_FSE_SUI) or the Client Utilities Installer (ENT1.4_FSE_CUI) from Pitney Bowes. 2. These are delivered as a self-extracting Zip file containing an InstallShield setup program. Once executed, the setup program presents selection panels which guide you through the installation process. 3. Once the Installer has completed the setup process, you may be required to reboot your machine for all installation actions to take effect. 4. Open a command window and enter ‘watch_dt’ with no parameters to receive the usage information.

56 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX C: RUNNING MULTIPLE INSTANCES OF WATCH_DT

Appendix C: Running Multiple Instances of Watch_DT

Multiple Watch_DT instances can be started and executed in the background from within a single command/batch file on Windows platforms. This can be achieved by using the START command and the /B (run in background) option. Example: start “Dir1” /b watch_dt c:\watch\dir1 flexhost pcl nt fsesccl 30 15 start “Dir2” /b watch_dt c:\watch\dir2 flexhost ps nt fsesccl 30 15 start “Dir3” /b watch_dt c:\watch\dir3 flexhost afp nt fsesccl 30 15 start “Dir4” /b watch_dt c:\watch\dir4 flexhost line nt fsesccl 30 15 These individual Watch_DT instances would run in the background but would be children of the parent window where the batch/command file is executed. If the above START commands were listed in a text file named watchdt_flexhost.bat, which resided in the watch directory, then it could also be started using the START command as follows: start “WatchDT - flexhost” /min watchdt_flexhost.bat This would launch a single minimized window entitled WatchDT – flexhost within which all of the Watch_DT instances listed would execute as children tasks. Messages from each of the Watch_DT instances would be sent to the parent window and all instances would stop executing when the parent window is closed.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 57 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

Appendix D: Running Watch_DT as a Windows Service

Watch_DT can be installed, executed and managed as a Windows Service using Windows Service Control Manager (SCM). When installed, critical information about the Watch_DT executable, command line parameters and start-up/restart/recovery settings are stored in the SCM database, which is stored in the Windows Registry. Multiple instances of Watch_DT can be installed on the same Windows machine to process multiple root “watch” directories independent of each other. In addition, the Watch_DT logging messages can be routed to the Windows Event Log. This allows messages to be captured what otherwise would have been written to standard output (STDOUT) prior to the Watch_DT log file being opened. These messages cannot be seen in a command window when Watch_DT is running as a Windows Service process, as it is running as a background task. Command line options Command line options provide the following operations:  Install Watch_DT as a Windows Service (Install).  Modify Watch_DT after installation (Alter).  Remove Watch_DT as a Windows Service (Remove).  Manage Watch_DT while running as a Windows Service (Start, Stop, Pause, Resume).  Display the status of Watch_DT while running as a Windows Service (Query).  Provide a statistical summary of transmissions occurring over the duration of the period that the Watch_DT Service has been running (Stats). Logging functionality allows messages to be routed to the Windows Event Log as required when Watch_DT is installed as a Windows Service. During system startup, or when started manually, or running as a Service there is no command window or console in which Watch_DT STDOUT messages are displayed, read or captured. Several messages are written to STDOUT prior to determining where to write the Watch_DT log file. These messages must be captured in the Windows Event Log. Warning and error messages are written to the Windows Event Log in the event that the Watch_DT log file is accidently deleted, overwritten or if the Watch_DT service fails prior to the log file being created and/or opened. The options are shown by running watch_dt –help. The –instance option is only required if more than one instance of Watch_DT is currently installed. Otherwise, the option may be omitted. See “Parameters” on page 65 for details of the parameters that can be used with these options.

NOTE:You require Administrator level access rights on the Windows platform to use these options.

58 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

INSTALL The INSTALL option creates a new instance of the Watch_DT Service. Multiple instances may be installed on the same Windows platform so that multiple “watch” directories or directory trees can be processed independently. However, a non- exhaustive check is performed during the installation process to prevent multiple instances processing the same root “watch” directory. This configuration gives unpredictable results. Service Names, for example, WatchDT_1, are automatically generated in numerical sequence during the installation process. If a “gap” is detected in the numerical sequence the installation process reclaims and reuses an available slot number. However, once installed, the designated service instance/slot number cannot be modified. The parameters are as follows: watch_dt|watch_dt_c -INSTALL [-CONFIG watch_dtConfigFileName] [-WDIR dirParm] [-LOGDIR logDirParm] [-DISPLAYNAME name_to_display] [-DESC description_of_service] [-STARTTYPE AUTO | MANUAL | DISABLED] [-STARTPRTY NORMAL | DELAY] [-ERRORCNTL NORMAL | IGNORE | SEVERE | CRITICAL] [-ACCOUNT LOCALSYSTEM | domain_name\user_name | user_name] [-PASSWORD password] Only -install is mandatory. However, -config or -wdir must be specified for the installation to proceed successfully. If -config is specified, a valid Watch_DT configuration file must be specified. The configuration file is read during the installation process to verify that a watch directory value has been specified. If no watch directory is found in the configuration file entered on the command line, the installation fails. Error messages indicate the reason for failure. This prevents the Watch_DT Service from “watching” and processing the Windows System directory, which could cause serious corruption of operating system files. If -wdir is specified and -config omitted, then Watch_DT expects a default Watch_DT configuration file in the watch directory. Otherwise an error occurs and the installation fails. It is not necessary to specify the destination of the Watch_DT configuration file in the “root” directory, as directory-specific Watch_DT configuration files or file-specific and directory-specific FSESCCL configuration files may explicitly set the destination for the print file transmissions. All of the optional parameters are defaulted if not explicitly specified. -startprty delay is a Windows operating system specific setting that only applies to Windows Vista, Windows Server 2008 and more recent Windows operating systems. An message is presented if the OS is determined to be at a level that does not support the option and the value defaults to normal. If –account LOCALSYSTEM is specified, –password is not required. If network resources, for example Network Drives, UNC Resource paths, Domain drives, etc., are required or referenced during installation, they may be accepted. However, during execution of the service, access to the resources is validated against

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 59 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

the Access Control Token, authority and resource access privileges associated with the account credentials. If the account used to run the service does not have appropriate privileges, the service may terminate abnormally.

ALTER The ALTER option changes some of the configuration parameters of an existing instance of the Watch_DT Service. This eliminates the need to REMOVE and INSTALL an instance when the configuration, for example, the description needs to be changed. The relevant service instance must be in the STOPPED state for this command to be successful; otherwise an error message is generated.The parameters are as follows: watch_dt|watch_dt_c -ALTER [-DISPLAYNAME name_to_display] [-DESC description_of_service] [-STARTTYPE AUTO | MANUAL | DISABLED] [-STARTPRTY NORMAL | DELAY] [-ERRORCNTL NORMAL | IGNORE | SEVERE | CRITICAL] [-ACCOUNT LOCALSYSTEM | domain_name\user_name |user_name] [-PASSWORD password] [-INSTANCE instance_nbr] Only -alter is mandatory and at least one option and value must be specified for it to proceed successfully. If –account LOCALSYSTEM is specified, –password is not required.

REMOVE The REMOVE option deletes an existing instance of the Watch_DT Service. The Service is removed from the Service Control Manager database (stored in the Windows Registry). However, some information about the Watch_DT Service remains in the Registry so that the Windows Event Log entries previously generated by the Service instance can be presented correctly. The status of the service must be STOPPED; otherwise an error message is generated. The parameters are as follows: watch_dt|watch_dt_c -REMOVE [-INSTANCE instance_nbr]

START The START option starts a Watch_DT Service instance in a STOPPED state. If the Service instance is RUNNING or PAUSED, the subcommand fails. The parameters are as follows: watch_dt|watch_dt_c -START [-INSTANCE instance_nbr] [-CONFIG watch_dtConfigFileName] [-WDIR dirParm] [-LOGDIR logDirParm] The Watch_DT Service may be started from the Windows Computer Management: Services or Service Properties panels. Alternatively, they may be started using the Windows Service Controller sc command, for example, sc start watchdt_1. The START option allows you to enter command line override options. The -wdir, - config and -logdir command line parameter name/value pair options override the values stored in the Service Control Manager (SCM) database for the Service. If either -wdir or -config is specified on the START command as an override, this replaces the specification of -wdir or -config or both if specified during the initial installation of the Service. Similar results may be achieved by populating the Start parameters

60 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

text entry box on the Services Properties page on the General tab in Windows Computer Management: Services or Service Properties panels.

STOP The STOP option stops a Watch_DT Service instance that is RUNNING or PAUSED. If the Service instance is already STOPPED state, this fails and an error is generated. The parameters are as follows: watch_dt|watch_dt_c -STOP [-INSTANCE instance_nbr] The Watch_DT Service may be stopped from the Windows Computer Management: Services or Service Properties panels, or may be stopped using the Windows Service Controller sc command, for example, sc stop watchdt_1. If the STOP command is issued while a file in the “watch” directory tree is being processed, then the Service’s “parent” thread exits leaving a “worker” thread active to continue processing the current file. After a STOP command is issued the “worker” thread continues until complete if the Windows machine remains on. However, if the Windows system is shutdown the OS requests all instances of the Watch_DT service to STOP. Any files being processed in this situation continue to be processed by the “worker” threads until such time that the OS kills them during shutdown. For example, if a FSESCCL transmission is in progress and the system goes down, when the system reboots and the service is restarted, the file is processed again by Watch_DT. FSESCCL attempts to recover the transmission if the prior transmission was incomplete. If the transmission completed but the file was not renamed to indicate successful transmission, the transmission is reattempted on restart but a “Duplicate Report” error is received by the FSESCCL transmission attempt. The file is then renamed accordingly.

PAUSE The PAUSE option discontinues processing files found in the “watch” directory tree by a Watch_DT Service instance in the RUNNING state. The Service process continues to execute while paused but remains in a “sleep” loop until subsequently instructed to RESUME or STOP. This allows the Watch_DT instance to process the QUERY and STATS commands while the Service is in a PAUSED state. The parameters are as follows: watch_dt|watch_dt_c -PAUSE [-INSTANCE instance_nbr] The Watch_DT Service may be paused from the Windows Computer Management: Services or Service Properties panels, or may be paused using the Windows Service Controller sc command, for example, sc pause watchdt_1.

RESUME The RESUME option can be used against a running Watch_DT Service instance that is in PAUSED state to resume processing of files found in the “watch” directory tree. The parameters are as follows: watch_dt|watch_dt_c -RESUME [-INSTANCE instance_nbr] The Watch_DT Service may be resumed from the Windows Computer Management: Services or Service Properties panels, or may be resumed using the Windows Service Controller sc command, for example, sc continue watchdt_1.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 61 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

QUERY The QUERY option obtains status and control information about a specific Watch_DT service instance or all installed instances. This lists the following:  Service Name  Display Name  Current State  Controls accepted  Win32 Exit Code  Service Exit Code  Check Point  Wait Hint The parameters are as follows: watch_dt|watch_dt_c -QUERY [-INSTANCE instance_nbr] Unlike the START, STOP, Pause and Resume options, the QUERY command cannot be called from the Windows Computer Management: Services or Service Properties panels. The QUERY operation, with slightly different results, may be performed via the Windows Service Controller sc command, for example, sc [query|queryex] watchdt_1. Sample output produced by the watch_dt –query command is as follows: C:\WatchDT_Test\bin\Windows> watch_dt -query

PI Enterprise Manager Watch DT Version 1.4 Pitney Bowes Copyright (C) 1999-2013, All Rights Reserved

Sep 15 11:45:44 [WDTSQ00I-06180(05508)] ************************* Sep 15 11:45:44 [WDTSQ00I-06180(05508)] * WatchDT Service Query * Sep 15 11:45:44 [WDTSQ00I-06180(05508)] ************************* Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Service Name: WatchDT_1 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Display Name: WatchDT_1 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Current State: 1 (STOPPED) Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Controls accepted: 0 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Win32 Exit Code: 1077 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Service Exit Code: 0 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Check Point: 0 Sep 15 11:45:44 [WDTSQH0I-06180(05508)] Wait Hint: 0 Sample output produced by the sc query watchdt_1 command:

C:\WatchDT_Test\bin\Windows> sc query watchdt_1

SERVICE_NAME: watchdt_1 TYPE : 10 WIN32_OWN_PROCESS STATE : 1 STOPPED (NOT_STOPPABLE,NOT_PAUSABLE,IGNORES_SHUTDOWN) WIN32_EXIT_CODE : 1077 (0x435) SERVICE_EXIT_CODE : 0 (0x0) CHECKPOINT : 0x0 WAIT_HINT : 0x0

62 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

C:\WatchDT_Test\bin\Windows> Sample output produced by the sc queryex watchdt_1 command: C:\WatchDT_Test\bin\Windows> sc queryex watchdt_1

SERVICE_NAME: watchdt_1 TYPE : 10 WIN32_OWN_PROCESS STATE : 1 STOPPED (NOT_STOPPABLE,NOT_PAUSABLE,IGNORES_SHUTDOWN) WIN32_EXIT_CODE : 1077 (0x435) SERVICE_EXIT_CODE : 0 (0x0) CHECKPOINT : 0x0 WAIT_HINT : 0x0 PID : 0 FLAGS :

C:\WatchDT_Test\bin\Windows>

STATS The STATS option list the processing statistics for a specified instance of the Watch_DT Service instance if in RUNNING or PAUSED state. The output produced is written to the applicable Watch_DT Service log file. The parameters are as follows: watch_dt|watch_dt_c -STATS [-INSTANCE instance_nbr] Unlike the Start, Stop, Pause and Resume command line options supported by the Watch_DT Service, the Stats command may not be performed from the Windows Computer Management: Services or Service Properties panels. There are four levels of statistical reporting, each one is automatically generated as detailed below:

Daily Generated at, or immediately after, midnight as the day number advances. In addition, this report is generated when the STATS command is issued to a RUNNING or PAUSED instance of the Watch_DT service. If the STATS command is issued manually, the report only contains statistical information for the current day up to the point that the request was made during the 24 hour period. Monthly Generated at, or immediately after, midnight as the month number advances. This report contains all activity since the Watch_DT service started, or for the previous month, whichever is shorter. Yearly Generated at, or immediately after, midnight as the year number advances. This report contains all activity since the Watch_DT service started, or for the previous year, whichever is shorter. Cumulative Generated at, or immediately after, midnight when the Watch_DT service has been running for more than a single day, for example, start day + 1. The Cumulative report contains all activity since the Watch_DT service started.

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 63 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

Sample Statistical Reports

Daily Sep19 00:00:20 [WDTWS20I-3756(3092)] *************************************** Sep19 00:00:20 [WDTWS20I-3756(3092)] * * Sep19 00:00:20 [WDTWS20I-3756(3092)] * Watch DT Statistics Report * Sep19 00:00:20 [WDTWS20I-3756(3092)] * * Sep19 00:00:20 [WDTWS20I-3756(3092)] *************************************** Sep19 00:00:20 [WDTWS20I-3756(3092)] *STATS STATS STATS STATS STATS STATS * Sep19 00:00:20 [WDTWS20I-3756(3092)] *************************************** Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Watch DT Started : Sep 18 11:36:19 Sep19 00:00:20 [WDTWS20I-3756(3092)] Transmission Utility: FSESCCL Sep19 00:00:20 [WDTWS20I-3756(3092)] Current State : Sleeping Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Last transmission statistics Sep19 00:00:20 [WDTWS20I-3756(3092)] Date/Time : Sep19 00:00:20 [WDTWS20I-3756(3092)] Duration : 0 Hrs 0 Mins 0 Secs Sep19 00:00:20 [WDTWS20I-3756(3092)] File Size : 0 KBytes Sep19 00:00:20 [WDTWS20I-3756(3092)] Rate : 0 KBytes/second Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Today's activities & statistics summary Sep19 00:00:20 [WDTWS20I-3756(3092)] ------Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Watch DT Service commands processed Sep19 00:00:20 [WDTWS20I-3756(3092)] Pause Count : 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Resume Count : 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Statistics Count: 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Transmission Counts Sep19 00:00:20 [WDTWS20I-3756(3092)] Total : 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Successes : 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Failures : 0 Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Transmission Times Sep19 00:00:20 [WDTWS20I-3756(3092)] Longest : 0 Hrs 0 Mins 0 Secs Sep19 00:00:20 [WDTWS20I-3756(3092)] Shortest : 0 Hrs 0 Mins 0 Secs Sep19 00:00:20 [WDTWS20I-3756(3092)] Average : 0 Hrs 0 Mins 0 Secs Sep19 00:00:20 [WDTWS20I-3756(3092)] Total : 0 Hrs 0 Mins 0 Secs Sep19 00:00:20 [WDTWS20I-3756(3092)] Sep19 00:00:20 [WDTWS20I-3756(3092)] Transmission Sizes

Cumulative Sep 19 18:43:46 [WDTWS50I-3756(4396)] Cumulative activities & statistics Sep 19 18:43:46 [WDTWS50I-3756(4396)] ------Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] Watch DT Service commands processed Sep 19 18:43:46 [WDTWS50I-3756(4396)] Pause Count : 0 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Resume Count : 0 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Statistics Count: 1 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] Transmission Counts Sep 19 18:43:46 [WDTWS50I-3756(4396)] Total : 0 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Successes : 0 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Failures : 0 Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] Transmission Times Sep 19 18:43:46 [WDTWS50I-3756(4396)] Longest : 0 Hrs 0 Mins 0 Secs Sep 19 18:43:46 [WDTWS50I-3756(4396)] Shortest : 0 Hrs 0 Mins 0 Secs Sep 19 18:43:46 [WDTWS50I-3756(4396)] Average : 0 Hrs 0 Mins 0 Secs Sep 19 18:43:46 [WDTWS50I-3756(4396)] Total : 0 Hrs 0 Mins 0 Secs Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] Transmission Sizes Sep 19 18:43:46 [WDTWS50I-3756(4396)] Largest : 0 KBytes Sep 19 18:43:46 [WDTWS50I-3756(4396)] Smallest : 0 KBytes Sep 19 18:43:46 [WDTWS50I-3756(4396)] Average : 0 KBytes Sep 19 18:43:46 [WDTWS50I-3756(4396)] Total : 0 KBytes Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] Transmission Rates Sep 19 18:43:46 [WDTWS50I-3756(4396)] Fastest : 0 KBytes/second

64 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

Sep 19 18:43:46 [WDTWS50I-3756(4396)] Slowest : 0 KBytes/second Sep 19 18:43:46 [WDTWS50I-3756(4396)] Average : 0 KBytes/second Sep 19 18:43:46 [WDTWS50I-3756(4396)] Sep 19 18:43:46 [WDTWS50I-3756(4396)] *************************************** Parameters This section describes the parameters used where Watch_DT runs as a Windows service. See “Command line options” on page 58 for how to use these parameters. The parameters are listed here in alphabetical order for convenience:

ACCOUNT The name of the account under which the service should run. This specified in the form DomainNameUserName. The service process is topped on as this user. If the account belongs to the built-in domain, specify .\UserName. If not specified, the LocalSystem account is used. If NT AUTHORITY\LocalService is specified, the LocalService account is used. If NT AUTHORITY\NetworkService is specified, the NetworkService account is used.

CONFIG The name of the Watch_DT configuration file. If used a valid Watch_DT configuration file must be specified. The configuration file is read during installation to verify that a watch directory value has been specified. If no watch directory is found in the configuration file entered on the command line, the installation fails with an error message. This prevents the Watch_DT Service from “watching” and processing the Windows System directory, which could seriously corrupt operating system files.

DESC The description displayed in the Windows Computer Management | Services panel.

DISPLAYNAME The name displayed in the Windows Computer Management | Services panel.

ERRORCNTL The action taken by the Windows operating system an error occurs during the start-up of the Watch_DT process. The the options/errors are:

NORMAL Logged and normal boot-up occurs. IGNORE Ignored and normal boot-up occurs. SEVERE Logged and the last-known-good configuration is used to reboot. CRITICAL Logged and the last-known-good configuration is used to reboot if not currently used, otherwise boot- up fails.

INSTANCE When multiple Watch_DT service instances are installed simultaneously, the service action verbs, with the exception of INSTALL and QUERY, require this parameter to stop the request being ambiguous. The permitted value is the

P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE 65 APPENDIX D: RUNNING WATCH_DT AS A WINDOWS SERVICE

required instance number as a positive integer and the same as the Watch_DT service name suffix when installed.

LOGDIR The absolute or relative path to which the logging file is written. If omitted, the default location is the path specified by -WDIR.

PASSWORD The password for the account name specified in ACCOUNT. Use an empty string if the account has no password or if the service runs in the LocalService, NetworkService or LocalSystem account. If –account LOCALSYSTEM is specified, the –password option is not required.

STARTYPE The startup type displayed in the Windows Computer Management|Services|Service Properties panel. The permitted values are:

AUTO Service is automatically started at system boot-up. The default. MANUAL Service is not automatically started at system boot-up, but may be started by an authorized user. DISABLED Service is not automatically started at system boot-up, and may not be started by an authorized user until the start.

STARTPRTY The startup priority displayed in the Windows Computer Management|Services|Service Properties panel. If supported by the operating system, this controls how quickly the system is launched during system boot-up then STARTYPE=AUTO. This setting has no effect when the STARTTYPE=MANUAL or DISABLED. The permitted values are:

NORMAL Service is started automatically according to dependencies and load ordering groups. The default. DELAY Service is started after a short delay, determined by the operating system, according to dependencies and load ordering groups.

NOTE: This option is supported on Windows Vista, 2008 and all subsequent versions of Windows.

WDIR The watched directory; this must be a valid absolute, relative or UNC formatted directory path. If the -wdir option is specified and the -config option omitted, Watch_DT expects to find a default Watch_DT configuration file in the watch directory. Otherwise an error occurs and the installation fails.

66 P/I ENTERPRISE MANAGER WATCH_DT INSTALLATION AND USER GUIDE Technical Support

You 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) 3001 Summer Street Stamford CT 06926-0700 www.pitneybowes.com

UNITED STATES pb.com/software Technical Support: support.pb.com

CANADA pb.com/software Technical Support: support.pb.com

EUROPE/UNITED KINGDOM pitneybowes.co.uk/software Technical Support: pitneybowes.co.uk/software/support

ASIA PACIFIC/AUSTRALIA pitneybowes.com.au/software Technical Support: pbinsight.com.au/software/support