SnowBatch® Batch Image Converter V4.2 Programmer's Reference Guide Note: An online version of this manual contains information on the latest updates to SnowBatch. To find the most recent version of this manual, please visit the online version at www.snowbatch.com or download the most recent version from our website at www.snowbound.com/support/manuals.html. DOC-1125-01 Copyright Information While Snowbound® Software believes the information included in this publication is correct as of the publication date, information in this document is subject to change without notice. UNLESS EXPRESSLY SET FORTH IN A WRITTEN AGREEMENT SIGNED BY AN AUTHORIZED REPRESENTATIVE OF SNOWBOUND SOFTWARE CORPORATION MAKES NO WARRANTY OR REPRESENTATION OF ANY KIND WITH RESPECT TO THE INFORMATION CONTAINED HEREIN, INCLUDING WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PURPOSE. Snowbound Software Corporation assumes no responsibility or obligation of any kind for any errors contained herein or in connection with the furnishing, performance, or use of this document. Software described in Snowbound documents (a) is the property of Snowbound Software Corporation or the third party, (b) is furnished only under license, and (c) may be copied or used only as expressly permitted under the terms of the license. All contents of this manual are copyrighted by Snowbound Software Corporation. The information contained herein is the exclusive property of Snowbound Software Corporation and shall not be copied, transferred, photocopied, translated on paper, film, electronic media, or computer-readable form, or otherwise reproduced in any way, without the express written permission of Snowbound Software Corporation. Microsoft, MS, MS-DOS, Windows, Windows NT, and SQL Server are either trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated. Sun, Sun Microsystems, the Sun Logo, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Foxit PDF Reader©, copyright by Foxit Software Company. All rights reserved. iText, the Initial Developers of the Original Code are Bruno Lowagie and Paolo Soares. Portions created by Bruno Lowagie are Copyright (C) 1999-2009 by Bruno Lowagie. Kakadu JPEG2000©, is copyrighted by Dr. David Taubman, and is proprietary to NewSouth Innovations, Pty. Ltd, Australia. Aspose™, Aspose.Cells© (copyrighted 2003), Aspose.Words© (copyrighted 2003), and Aspose.Slides© (copyrighted 2004), are all proprietary to Aspose Software, Pty. Ltd, Australia. United States Government Restricted Rights The Software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the United States Government is subject to restrictions as set forth under subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause of DFARS 252.227 –19 or subparagraphs (c)(i) and (2) of the Commercial Computer Software-Restricted Rights at 48 CFR 52.227 – 19 as applicable. The Manufacturer is Snowbound Software Corporation, 309 Waverley Oaks Rd., Suite 401, Waltham, MA 02452, USA. All other trademarks and registered trademarks are the property of their respective holders. Manual Title: Snowbound SnowBatch® Batch Image Converter Programmer’s Reference Guide Part Number: DOC-1125-01 Revision: 01 SnowBatch® Batch Image Converter Release Number: 4.2 SnowBatch® Release Number: 4.2 Printing Date: October 2013 Published by Snowbound Software Corporation. 309 Waverley Oaks Road, Suite 401 Waltham, MA 02452 USA phone: 617-607-2000 fax: 617-607-2002 ©1996 - 2013 by Snowbound Software Corporation. All rights reserved. Table of Contents Chapter 1 - System Overview 9 Overview of SnowBatch 9 SnowBatch Benefits 9 Ease of Use 9 System Requirements 9 Supported Operating Systems 10 Memory Requirements 10 Chapter 2 - Getting Started 11 Using the Application 11 Opening the Application 11 Understanding the Main SnowBatch Dialog 12 Closing the Application 12 Format of Output Files 12 Examples Using Multi-page Output File Types 12 Examples Using Non-Multi-page Output File Types 14 Chapter 3 - Setting User Options 16 Processing Directories Recursively 16 Replicating Output Subdirectories 16 Splitting Up Multi-page Files 17 Combining Multiple Source Files into One File 17 Combining Multiple Source Files in a Directory into a File 18 Selecting the Source File Name with the Filter 18 iii Selecting Logging Options 19 Setting Document Input and Output Options 19 Changing Document Input Size 19 Resetting PDF Options 20 Changing PDF Output Size 20 Resetting PDF Options 20 Setting the Source File Options 20 Setting the Source File Options in the Main Dialog Box 21 Deleting Destination Files on Error 21 Deleting Output Files on Error 22 Setting the Overlay Path and Font Mapping Options 22 Setting the Output Naming Convention 22 Working with Watermark Options 23 Chapter 4 - Using the Job Scheduler 28 Working with the Job Scheduler 28 Chapter 5 - Batch Image Conversion 30 Maintaining the Directory Structure 30 Selecting the Source Format 30 Selecting the Destination Format 30 Selecting the Destination Output Extension 31 Selecting Source Directories and Files 31 Choosing Source Directories and Files 32 Selecting Destination Directories and Files 32 Selecting Destination Directories and Files 33 iv Starting the Batch Image Conversion 33 Pausing the Converter 34 Resuming the Converter 34 Permanently Stopping the Converter 35 Chapter 6 - Formatting Information 36 Format Compatibility 36 Format Conversion Problems 37 Chapter 7 - Command Line Batch Processing 38 Running the Batch Conversion Using the Command Line 38 Examples of Using the Command Line 38 Specifying Only the Source Directory 41 Specifying One File in a Directory 41 Specifying All SnowBatch Command Line Options 42 Specifying Multiple Source and Destination Directories 42 Specifying More Source Than Destination Directories 43 Specifying the Replicated Output Subdirectory 43 Specifying An Output Format 43 Specifying Splitting Multi-page Files 44 Combining Multiple Files into One File 44 Specifying Logging Options 45 Specifying Custom Extensions 45 Specifying Document Options 45 Setting the Overlay Path for the AFP File Format 46 Setting the Output Naming Convention 46 v Setting the Font Mapping Path for the AFP File Format 47 Specifying Command Options for Watermark Merging 47 Chapter 8 - Setting Up Open Office 2007 XML (OOXML) Support 50 Setting up Open Office 2007 XML (OOXML) Support 50 Loading the OOXML License 50 Running the OOXML Conversion 51 Using the Command Line for OOXML Support 51 Setting Up the OOXML License File 52 Appendix A - Supported File Formats 53 Descriptions of Supported File Formats 53 File Type Constants Listed by File Type Number 64 Appendix B - Snowbound Error Codes 68 Snowbound Error Codes 68 General Error Define Values Retrieved from Status Property 70 General Status/Error Codes 71 SnowBatch System Errors 71 SnowBatch Errors 71 SnowBatch Cautions 72 Appendix C - Troubleshooting 74 Receiving an Error Code When Converting a Document 74 Output Document Differs from Original Document 74 Output Document Has Much Larger File Size than the Original Document 74 Output Document Has Much Lower Quality than the Original Document 75 Output Document Displays Incorrect or Missing Characters 75 vi Improving Performance 75 Receiving a -3 CORRUPTED_FILE Error code 76 Receiving a -21 PIXEL_DEPTH_UNSUPPORTED Error Code 76 Searching for Text in a Snowbound Software Generated PDF 76 Determining Memory Requirements 77 vii List of Tables Table 2.1: Multi-page Output File Naming Conversion 12 Table 2.6: Non-multi-page Output File Naming Conversion 14 Table 3.1: Relative Position of Watermark 24 Table 3.2: Relative Position of Watermark 25 Table 3.3: Relative Position of Watermark 26 Table 6.1: Formats Listed By Group 36 Table 6.2: Conversion Problems by Format 37 Table 7.1: Command Line Options 39 Table A.1: File Format Key 53 Table A.2: Supported File Format Descriptions 53 Table A.3: File Type Constants listed by File Type Number 64 Table B.1: Detailed Status/Error Codes 68 Table B.2: General Error Define Values Retrieved from Status Property 70 Table B.3: General Status/Error Codes 71 Table B.4: SnowBatch System Errors 71 Table B.5: SnowBatch Cautions 72 Table C.1: Memory Requirements Based on Image Size 77 viii Chapter 1 - System Overview Chapter 1 - System Overview This chapter describes the Snowbound SnowBatch software. This chapter contains the following topics: Overview of SnowBatch SnowBatch Benefits System Requirements Overview of SnowBatch SnowBatch is an image conversion program that converts large batches of files from one format to another. In addition to specifying the file format of the converted files, you can specify other options including: l Format to which images are converted l Directory to save images l PDF output size l PDF Input DPI and resolution and PDF Input bit depth l Whether to split up multi-page files Developed from the latest RasterMaster™ technology,SnowBatch supports over 100+ formats. It is easily installed on any PC or server. It is available for Windows or cross-platform Java™ which runs on Windows, UNIX, MAC, and others. SnowBatch Benefits SnowBatch benefits businesses that have large batch files that are in non-standard formats (unreadable by most standard browsers or viewers) which need to be converted to more common, readable formats, such as JPEG, TIFF, or PDF. Banking, insurance, and medical industries, among others, need to provide readable documents, check images, or records for their customers. Ease of Use SnowBatch is simple to use. Once you select your options, the destination format, and the source and destination directory or file, you can begin your batch image conversion. System Requirements This section describes the supported operating systems and memory requirements for running SnowBatch. 9 Chapter 1 - System Overview Supported Operating Systems SnowBatch is supported by Microsoft Windows 98/2000/NT/ME/XP/Server 2003/XP 64/Vista. Memory Requirements SnowBatch requires 5MB memory, enough combined real and virtual memory to decompress images.