TM
DocConverter™
Product Manual
EULA, Copyright Notice & Trademarks
End User License Agreement
NOTICE TO USER: THIS IS A CONTRACT. BY INSTALLING THIS SOFTWARE YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT. This activePDF, Inc. ("ACTIVEPDF") End User License Agreement ("EULA") accompanies all activePDF products and related explanatory materials ("SOFTWARE"). The term "SOFTWARE" shall also include any upgrades, modified versions or updates of the Software licensed to you by ACTIVEPDF. Please read this EULA carefully. If you are reading this prior to electronic distribution, you will be asked to accept this agreement and continue to install or, if you wish to decline this agreement, in which case you will not be able to use the Software. The SOFTWARE is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The SOFTWARE is licensed, not sold. 1. DEFINITIONS I. SERVER - A single computer wholly owned, rented or leased by a single individual or entity on which one or more applications load and execute SOFTWARE in the memory space of that computer so that one or more users may access it. II. VIRTUAL SERVER - A single computer wholly owned, rented or leased by one individual or entity and who, in turn, rents or leases access to this computer to other individuals or entities and on which one or more applications load and execute SOFTWARE in the memory space of that computer so that multiple users may access it. III. DEVELOPMENT - The act of programming a tool or application that interacts with SOFTWARE. IV. APPLICATION SERVICE PROVIDER - An individual or entity ("OWNER") and who, in turn, charges other individuals or entities a fee for access to software applications wholly owned or licensed and maintained by the OWNER. The OWNER's application(s) load and execute SOFTWARE in the memory space of that computer so that multiple users may access it. 2. GRANT OF LICENSE : Upon issuance of a valid SERIAL NUMBER (for SERVER and VIRTUAL SERVER LICENSES) by ACTIVEPDF to you, this EULA grants you the following rights: a. SOFTWARE PRODUCT : ACTIVEPDF grants to you as an individual, a non-transferable, nonexclusive license to use the SOFTWARE PRODUCT as follows: I. IF YOU PURCHASED A SERVER LICENSE - Usage is restricted to a single SERVER for a single individual or entity. All SERVERS that use this product must be licensed. III. IF YOU PURCHASED A VIRTUAL SERVER LICENSE - Usage is restricted to a single individual or entity. All other individuals or entities that can access or use SOFTWARE must purchase a separate VIRTUAL SERVER LICENSE. II. If you Purchased a Development License or a Developer Bundle. (SALES AND GRANT OF DEVELOPER LICENSES ARE AT ACTIVEPDF'S DISCRETION AND ALWAYS REQUIRE THE PURCHASE OR EXISTENCE OF VALID PRODUCTION LICENSES) You are hereby granted the right for development use only for the license or licenses purchased as development licenses. You must purchase a license for each developer granted access and for each development machine where you load the software. Development software is for Development purposes only and you may not use Development licenses in a live test or production environment (Test Servers require full licenses not Development Licenses). You may not resell, transfer, rent, or lease the SOFTWARE. You agree not to modify, adapt, translate, reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code of the Software. You may not alter or modify in any way the installer for the Software, or create a new installer for the Software. You also agree to hold in the strictest confidentiality any and all code given to you by ACTIVEPDF to enable your application. b. If you are an entity, ACTIVEPDF grants you the right the same rights as above. c. UNTIL A VALID SERIAL NUMBER HAS BEEN ISSUED TO YOU BY ACTIVEPDF, YOU MAY ONLY USE THE SOFTWARE FOR A TRIAL PERIOD NOT TO EXCEED FIFTEEN (15) DAYS FROM THE INITIAL INSTALLATION. YOU AGREE TO REMOVE ANY COPIES OF THE SOFTWARE UPON EXPIRATION OF THE TRIAL PERIOD IF YOU DO NOT PURCHASE THE SOFTWARE. YOU MAY NOT DISTRIBUTE ANY PORTION OF THE SOFTWARE, INCLUDING THOSE PORTIONS OUTLINED UNDER "REDISTRIBUTABLE CODE" BELOW, UNTIL YOU ARE ISSUED A VALID SERIAL NUMBER. NO LICENSE IS GRANTED UNTIL THAT TIME. d. ELECTRONIC DOCUMENTS : Solely with respect to electronic documents included with the SOFTWARE, you may make an unlimited number of copies (either in hardcopy or electronic form), provided that such copies shall be used only for internal purposes and are not republished or distributed to any third party. e. STORAGE/NETWORK USE : You may store or install one (1) copy of the SOFTWARE on a storage device, such as a network server, for backup and archival purposes only. A license for the SOFTWARE may not be shared or used concurrently on different computers. f. You agree not to modify the Producer or Creator fields within any PDF documents created by SOFTWARE. g. ACTIVEPDF reserves all rights not expressly granted. 3. COPYRIGHT. The SOFTWARE is owned by ACTIVEPDF and its suppliers, and its structure, organization and code are the valuable trade secrets of ACTIVEPDF and its suppliers. The SOFTWARE is protected by United States Copyright Law and International Treaty provisions. You may use trademarks only insofar as required to comply with Section 1 of this EULA and to identify printed output produced by the Software, in accordance with accepted trademark practice, including identification of trademark owner's name. Such use of any trademark does not give you any rights of ownership in that trademark. Except as stated above, this EULA does not grant you any intellectual property rights in the Software. 4. RESTRICTIONS. You may not resell, transfer, rent or lease the SOFTWARE. You agree not to modify, adapt, translate, reverse engineer, decompile, disassemble or otherwise attempt to discover the source code of the Software. You may not alter or modify in any way the installer for the Software, or create a new installer for the Software. Redistribution rights, if any, are outlined below. 5. ADDITIONAL RESTRICTIONS. I. For activePDF Server, activePDF DocConverter or activePDF WebGrabber : You agree that you will only use SOFTWARE on a SERVER and all applications that will access SOFTWARE will reside on the SERVER and you will not permit remote access to SOFTWARE except through your application residing on the SERVER. Additionally, you agree not to use SOFTWARE in a generic, bureau-like fashion whereby the only functionality of your application is to submit files for conversion to PDF. II. For activePDF DocConverter v3.8 ii Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ activePDF Server : You agree to not attempt to violate the internal licensing mechanism for processing thread increases. You also agree to not attempt to defeat said internal licensing mechanism by, directly or indirectly, halting and restarting the SOFTWARE. III. For activePDF DocConverter : You agree that you will not charge any fees, directly or indirectly, internally or externally, for access to SOFTWARE. This restriction includes charging per document, for the right to convert documents on your server and/or as a requirement of any sort. You also agree that should you violate this restriction, you will pay ACTIVEPDF an amount commensurate to the total amount collected by you for said restricted services or $2,000 US, whichever is more. You also agree to surrender your license(s) immediately upon notification of violation of this restriction and that you will not be refunded any monies upon surrendering your license. You agree to not attempt to violate the internal licensing mechanism for document processing increases. You also agree to not attempt to defeat said internal licensing mechanism by, directly or indirectly, halting and restarting the SOFTWARE. IV. For activePDF WebGrabber : You agree to only render HTML to which you have a legal and lawful right to access and that you will not violate any individual's or entity's copyright protection with unauthorized access to that individual's or entity's content. You also agree to indemnify and hold harmless ACTIVEPDF from any such activity even if such violation is unintentional. V. For activePDF DocConverter : Installation and use by an APPLICATION SERVICE PROVIDER requires a separate, signed agreement and is prohibited by this EULA. 6. UPGRADES. If the SOFTWARE is labeled as an upgrade, you must be properly licensed to use a product identified by ACTIVEPDF as being eligible for the upgrade in order to use the SOFTWARE. SOFTWARE labeled as an upgrade replaces and/or supplements the product that formed the basis for your eligibility for the upgrade. You may use the resulting upgraded product only in accordance with the terms of this EULA. If the SOFTWARE is an upgrade of a component of a package of software programs that you licensed as a single product, the SOFTWARE may be used and transferred only as part of that single product package and may not be separated for use on more than one computer. Development licenses are not eligible for upgrades or other rights granted to products purchased with subscription. 7. REDISTRIBUTABLE CODE : I. SERVER LICENSE - No portion of SOFTWARE PRODUCTS may be redistributed. II. VIRTUAL SERVER LICENSE - No portion of SOFTWARE PRODUCTS may be redistributed. 8. EXPORT RESTRICTIONS. You agree that neither you nor your customers intend to or will, directly or indirectly, export or transmit (a) the SOFTWARE or related documentation and technical data or (b) your software products as defined under of this EULA (or any part thereof), or any process or service that is the direct product of the SOFTWARE to any country to which such export or transmission is restricted by any applicable U.S. regulation or statute, without the prior written consent, if required, of the Bureau of Export Administration of the U.S. Department of Commerce, or such other governmental entity as may have jurisdiction over such export or transmission. 9. NO WARRANTY. The SOFTWARE is being delivered to you AS IS and ACTIVEPDF makes no warranty as to its use or performance. ACTIVEPDF AND ITS SUPPLIERS DO NOT AND CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY OBTAIN BY USING THE SOFTWARE OR DOCUMENTATION. ACTIVEPDF AND ITS SUPPLIERS MAKE NO WARRANTIES, EXPRESS OR IMPLIED, AS TO NONINFRINGEMENT OF THIRD PARTY RIGHTS, MERCHANTABILITY, OR FITNESS FOR ANY PARTICULAR PURPOSE. IN NO EVENT WILL ACTIVEPDF OR ITS SUPPLIERS BE LIABLE TO YOU FOR ANY CONSEQUENTIAL, INCIDENTAL OR SPECIAL DAMAGES, INCLUDING ANY LOST PROFITS OR LOST SAVINGS, EVEN IF AN ACTIVEPDF REPRESENTATIVE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY THIRD PARTY. Some states or jurisdictions do not allow the exclusion or limitation of incidental, consequential or special damages, or the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you. 10. GOVERNING LAW AND GENERAL PROVISIONS. This EULA will be governed by the laws of the State of California, U.S.A., excluding the application of its conflicts of law rules. This EULA will not be governed by the United Nations Convention on Contracts for the International Sale of Goods, the application of which is expressly excluded. If any part of this EULA is found void and unenforceable, it will not affect the validity of the balance of the EULA, which shall remain valid and enforceable according to its terms. You agree that the Software will not be shipped, transferred or exported into any country or used in any manner prohibited by the United States Export Administration Act or any other export laws, restrictions or regulations. This EULA shall automatically terminate upon failure by you to comply with its terms. This Agreement may only be modified in writing signed by an authorized officer of ACTIVEPDF. 11. Notice to Government End Users. If this product is acquired under the terms of a: GSA contract- Use, reproduction or disclosure is subject to the restrictions set forth in the applicable ADP Schedule contract; U.S. DoD contract- Use, duplication or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of 252.227-7013; Civilian agency contract- Use, reproduction, or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in this EULA. Unpublished-rights reserved under the copyright laws of the United States. activePDF, Inc., a California Corporation, 27405 Puerta Real, Suite 100, Mission Viejo, California 92691. Effective 3/1/2005
Copyright Notice
Copyright © 2000-2006, activePDF, Inc., All Rights Reserved Portions of this publication copyright © 2000 Glance AG. All Right Reserved. Released 02/2005 by activePDF, Inc. This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior consent in writing from activePDF, Inc. 27405 Puerta Real, Suite 100, Mission Viejo, CA 92691-6314. ALL EXAMPLES OF NAMES OR COMPANIES APPEARING IN THIS MANUAL ARE FICTIONAL. ANY SIMILARITY TO ACTUAL NAMES OR COMPANIES IS PURELY COINCIDENTAL. Every effort has been made to ensure accuracy of this manual. However, activePDF, Inc. makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. activePDF, Inc. shall not be liable for any errors or for incidental or consequential damages in connection with the furnishing, performance or use of this manual or the examples herein. The information in this document is subject to change without notice.
activePDF DocConverter v3.8 iii Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Trademarks
activePDF ®, the activePDF Logo, activePDF Server TM , and activePDF DocConverter TM are all registered trademarks or trademarks of activePDF, Inc. respectively. Adobe ®, Adobe Acrobat ® and Adobe Acrobat Reader ® are registered trademarks of Adobe ® Systems, Inc. Microsoft ®, Microsoft Windows ®, Windows NT ® and Windows 2000 ® are registered trademarks of Microsoft Corporation. All product names mentioned in this manual may be trademarks or registered trademarks of their respective companies and are the sole property of their respective manufacturers.
activePDF DocConverter v3.8 iv Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
activePDF, Inc. Corporate Headquarters activePDF is a leading provider of PDF generation and manipulation tools. Our products are easy to use, enabling you to create PDF files that are compatible with 3rd party PDF tools and conform to the latest version of the PDF Specification, published by Adobe ® Systems. activePDF, Inc. 27405 Puerto Real Suite 100 Mission Viejo, California 92691-6314 United States Toll Free (U.S.): (866) GOTO PDF Elsewhere: +1-949-582-9002 Fax: (949) 582-9004 World Wide Web: www.activepdf.com
activePDF DocConverter v3.8 v Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Technical Support
At activePDF, we are committed to providing you with timely answers to all of your technical support questions. For current hours of operation and details about support offerings, please visit the activePDF website at http://www.activepdf.com/support/supportprogram/supportservices/ . activePDF’s support services are subject to the terms and conditions in place at the time the service is used.
activePDF DocConverter v3.8 vi Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Sales
activePDF is a leading provider of server-side PDF generation and manipulation tools. For information on other activePDF product offerings, please contact activePDF’s Sales Department by calling (866) GOTO PDF in the U.S., or +1-949-582-9002 elsewhere. You can also visit us on the web at www.activepdf.com .
activePDF DocConverter v3.8 vii Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Table of Contents
About this Document...... 9 : Getting Started...... 10 :....System Requirements...... 11 :....Installation...... 12 : :....activePDF License Manager...... 13 : :....Installing the Software...... 15 : :....Increasing the Document Per Hour Limit...... 16 : :....Upgrading DocConverter's Version or Edition...... 17 : : :....From a Previous Version or Service Pack...... 18 : : :....From an Evaluation Edition...... 20 :....Testing DocConverter Installation...... 21 :....Using DocConverter...... 23 : :....Accessing the COM component...... 24 : :....Hot Folders...... 25 : :....Interactive Conversion...... 26 : DocConverter Maintenance...... 27 :....Directories...... 28 :....Directory Filters...... 31 :....Document Signatures...... 33 :....Installed Applications...... 37 :....Interactive Conversion...... 41 : Processors...... 43 :....Default...... 44 :....NULL...... 45 :....Microsoft Office...... 46 : :....Office 97 Processors...... 47 : : :....Excel 97...... 48 : : :....PowerPoint 97...... 49 : : :....Word 97...... 51 : :....Office 2000 Processors...... 54 : : :....Excel 2000...... 55 : : :....PowerPoint 2000...... 56 : : :....Word 2000...... 58 : :....Office 2003 Processors...... 61 : : :....Excel 2003...... 62 : : :....PowerPoint 2003...... 63 : : :....Word 2003...... 65 :....PostScript...... 68 :....RTF Only...... 69 :....WordPerfect 9...... 70 : Object Reference...... 71 :....Instantiating the Object...... 72 :....Methods...... 73 : :....CheckStatus...... 74 : :....RetrieveFile...... 76 : :....ServerConfigurationPath...... 77 : :....SetFilterOptions...... 78 : :....SetLinearize...... 79
activePDF DocConverter v3.8 viii Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ : :....SetSecurityOptions...... 80 : :....SetSecurityOptions128...... 82 : :....Submit...... 84 : :....TransmitFile...... 86 :....Properties...... 87 : :....ConverterType...... 88 : :....StatusTimeout...... 89 : Advanced Configuration...... 90 :....Using DocConverter 3.5.2 in .NET...... 91 :....Remote Operation...... 93 :....Document Signatures...... 95 : :....Creating a Signature...... 96 : :....Signature Examples...... 101 : : :....Include Signatures...... 102 : : :....Exclude Signatures...... 104 :....Scripting...... 106 :....Using the Registry Switches...... 107 : Appendices...... 111 :....Supported File Types...... 112 :....DocConverter 3.5.2 Updates...... 118
activePDF DocConverter v3.8 ix Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
About this Document
This document provides information for deploying activePDF DocConverter in a development environment. It is organized into the following sections:
Getting Started - Covers the System Requirements, Installation, Testing, and DocConverter Usage. DocConverter Maintenance - Details the DocConverter Maintenance program options. Processors - Contains a complete list of the available processors. Object Reference - Includes object instantiation instructions and lists all methods and properties. Advanced Configuration - Covers the use of DocConverter in .NET, Remote Operations, Creating a Signature, Scripting, and Registry Switches. Appendices - Provides a partial list of Supported File Types and the Update History.
Who Should Read This Guide
This guide has been written for the developer who wants to programmatically generate PDFs and control the resultant output. The guide assumes you have a general knowledge of PostScript ® and PDF, and that you are comfortable programming in a COM-enabled environment.
Documentation Feedback activePDF strives to produce quality technical documentation. If you have comments or suggestions regarding our help files, PDF, print or online manuals please send an email to the activePDF Documentation Team . Please include the following information in your message:
Product name and version number Print manual, PDF or help file Section or Topic title Brief description of content Your suggestion for improvement or correction
NOTE: This email address is only for documentation feedback. If you have a technical question, please contact Technical Support .
activePDF DocConverter v3.8 x Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Getting Started
DocConverter works with activePDF Server TM to convert over 280 different file types directly to PDF. It operates in batch mode via directory scanning, and in direct mode via a COM component. Once the file is submitted to DocConverter, it is assigned to a Processor based on file type before being converted to PDF via activePDF Server. The conversions run Out-of- Process on a server-machine, which allows your documents to be converted without need for interaction or monitoring.
System Requirements Installation Using DocConverter
activePDF DocConverter v3.8 Page 11 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started
System Requirements
Operating System Requirements
Microsoft Windows NT ® 4.0 (Service Pack 5 minimum) or Microsoft Windows ® 2000 or Microsoft Windows Server 2003 Strong Encryption
NOTE: Strong encryption is only required for 128-bit encryption.
Minimum Recommended Hardware Requirements
Pentium III 500-MHz or higher 128 MB of RAM 15MB of Hard Disk Space (for application)
Port Requirements
By default, port 53540 must remain open and dedicated for the CheckStatus and Submit methods. By default, port 53541 must remain open and dedicated for the RetrieveFile and TransmitFile methods.
Additional Software Requirements
activePDF Server TM Microsoft Office ® 97, if using the Microsoft Word ® 97, Excel ® 97, PowerPoint ® 97 processors Microsoft Office 2000, if using the Microsoft Word 2000, Excel 2000, PowerPoint 2000 processors (this is the recommended configuration for processing Office documents) Microsoft Office 2003, if using the Microsoft Word 2003, Excel 2003, PowerPoint 2003 processors (this is the recommended configuration for processing Office documents) WordPerfect ® 9, if using the WordPerfect Native processor
activePDF DocConverter v3.8 Page 12 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started
Installation
Installing the registered production edition of activePDF DocConverter requires a Product Serial Number , the activePDF License Manager , and the installation software. The Product Serial Number is supplied via email upon purchase. If you are installing the evaluation edition, proceed directly to Installing the Software .
activePDF License Manager Installing the Software Increasing the Document Per Hour Limit Upgrading DocConverter's Version or Edition
activePDF DocConverter v3.8 Page 13 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation
activePDF License Manager
The activePDF License Manager simplifies the process of adding additional licenses, enabling software upgrades, and retrieving existing license information. The License Manager is available at http://www.activepdf.com/AltDownloads/Utilities/LicMgr.exe .
Interface
Figure 2.1: The activePDF License Manager.
The License Manager the following information for each activePDF product you have installed:
Product: The name of the activePDF product. If you are using an evaluation version, this field will read "Evaluation Key". Serial Number: The product serial number or demo key. Status: The status of the license. Ready - The product is fully licensed and ready for use. Invalid License - The serial number is invalid. Number of days left: If you are using an activePDF product in evaluation mode, the status field will contain the number of days remaining in your trial period. Expired - Your trial period has ended. Remarks: Contains additional information about the status of your license(s).
The License Manager also offers several options that can be used in managing your licenses:
Add: Allows you to add a new serial number. View: Allows you to view the details for a selected license. Remove: Allows you to remove a license. Activate: Used with specialized activePDF Products.
Adding the Product Serial Number
These instructions require that you have access to your activePDF Product Serial Number.
activePDF DocConverter v3.8 Page 14 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ 1. Log in as the Local Administrator 2. Download the License Manager from http://www.activepdf.com/AltDownloads/Utilities/LicMgr.exe . 3. Double-click LicMgr.exe to run License Manager. 4. Click Add , type your Product Serial Number , and then click OK .
NOTE: The Product Serial Number is case sensitive.
5. Verify the Status is Licensed properly and ready to use , and then click OK
activePDF DocConverter v3.8 Page 15 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation
Installing the Software
Production and Evaluation Editions of activePDF DocConverter are available for download from http://www.activepdf.com/downloads/serverproducts/index.cfm . activePDF DocConverter requires activePDF Server TM . Refer to the activePDF Server Product Manual for activePDF Server installation instructions. You must specify a DocConverter user during installation. We strongly recommend the user account created by DocConverter, which is generated with the necessary rights. The account must be a Local Administrator or a Domain user with Local Administration rights for remote use.
NOTE: To install DocConverter Processors , you must install the required program listed in System Requirements prior to installing DocConverter.
1. Log in as the Local Administrator 2. Insert your activePDF CD or download DocConverter from http://www.activepdf.com/downloads/serverproducts/index.cfm .
NOTE: If you have purchased, complete the steps for the License Manager at this time.
3. Double-click APDCConv.EXE and then follow the onscreen instructions to complete the installation. 4. Restart your computer
activePDF DocConverter v3.8 Page 16 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation
Increasing the Document Per Hour Limit
The production edition of DocConverter can convert up to 120 documents per hour or 240 documents per hour with the purchase of activePDF Portfolio . Increases are available for purchase in 120 documents per hour increments as well as Unlimited Conversion . You can add the document per hour increases using the activePDF License Manager . For additional information, contact activePDF Sales .
NOTE: A single-server DocConverter license must be installed to use any increase. During the free evaluation period, this limit is 10 documents per hour.
activePDF DocConverter v3.8 Page 17 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation
Upgrading DocConverter's Version or Edition
It is possible to upgrade from a previous service pack as well as from an evaluation edition without re-applying your Product Serial Number . This makes it easy to transition from testing to the latest enhancements.
From a Previous Version or Service Pack From an Evaluation Edition
activePDF DocConverter v3.8 Page 18 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation -> Upgrading DocConverter's Version or Edition
From a Previous Version or Service Pack
Periodically, activePDF releases Service Pack upgrades including updates and fixes for the current version of DocConverter. Due to the nature of DocConverter's operations, you will need to remove the previous installation before installing the update.
NOTE: You must install the corresponding version or edition of activePDF Server when upgrading. In addition, you must update your .NET Wrapper .
Retaining your Configuration
Complete these steps first to retain your DocConverter configuration settings. Otherwise, proceed to Removing the Previous Installation .
1. Log on as a Local Administrator . 2. Click Start > Run , type X:\WINDOWS\APSDoc or X:\WinNT\APSDoc , based on your installed version of Windows, and then click OK . 3. Move a copy of these files to your Desktop:
APSDATA.isd
APSDATA.isf
APSDATA.isl
APSDATA.ism
APSSIGS.isd
APSSIGS.isl
APSSIGS.ism
4. Complete the Removal and Installation steps. 5. Move the copied files back to their original location. 6. Restart your machine.
NOTE: You must reassign your Document Signatures .
Removing the Previous Installation
1. Log on as a Local Administrator . 2. Click Start > Run , type Control Panel , and then click OK . 3. Double-click Add or Remove Programs . 4. For each reference to activePDF DocConverter, click Remove . 5. Restart your machine.
activePDF DocConverter v3.8 Page 19 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Installing the Update
After removing the previous version or edition, follow the Standard Installation Instructions .
activePDF DocConverter v3.8 Page 20 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Installation -> Upgrading DocConverter's Version or Edition
From an Evaluation Edition
The evaluation edition of DocConverter is a fully functional and free to use. The evaluation period expires after 15-days and all output contains the activePDF brand. After purchasing a production license for activePDF DocConverter, you can upgrade your evaluation edition by adding the serial number using the activePDF License Manager . Simply add the number to remove the evaluation watermark.
NOTE: You may need to restart your server-machine before adding the serial number.
activePDF DocConverter v3.8 Page 21 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Testing DocConverter Installation
The following VBScript example is can be used to test your DocConverter installation by submitting a document locally. Refer to the Object Reference for a detailed explanation of the object instantiation and usage requirements. These files are required:
test.txt - The input document to convert. BasicCOM.vbs - Code detail provided below.
1. Log in as the Local Administrator . 2. Click here to download the example (includes required files) :
3. Unzip the contents to your desktop. 4. Double-click BasicCOM.vbs to run the script.
' Get local path as varPath arrayScr = Split (WScript.ScriptFullName , "\", -1, 1) For i = 0 to UBound (arrayScr ) - 1 varPath = varPath & arrayScr (i) & "\" Next
' Define Variables ' File to convert varFile = varPath & "test.txt"
' Output Directory varOutput = varPath
' Error Directory varError = varPath
' Original Directory varOriginal = varPath
' IP address of server with DocConverter varIP = "127.0.0.1"
' Port of server with DocConverter varPort = 0
' Timeout varTimeout = 120
' Instantiate Object Set objDC = CreateObject ("APDocConv.Object")
' Timeout for CheckStatus objDC.StatusTimeout = varTimeout
' Submit the file for conversion varReturn = objDC.Submit (varIP , varPort , varFile ,_ varOutput , varError , varOriginal , "", "", False , "") If varReturn <> 0 Then Error ("Submit") End If
activePDF DocConverter v3.8 Page 22 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ ' Check the status of the conversion varReturn = objDC.CheckStatus ("", varPort , varFile , varOutput , varError ) If varReturn <> 1 Then Error ("CheckStatus") Else Msgbox "Done!" End If
' Release Object Set objDC = Nothing
' Error Handling Sub Error (Method ) Msgbox "'" & Method & "' failed with a '" & varReturn & _ "'" & VBCRLF & "KB article on Return codes:" & VBCRLF & _ "http://www.activepdf.com/support/kb/?id=10347&tk=ts" Set objDC = Nothing Wscript.Quit End Sub
activePDF DocConverter v3.8 Page 23 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started
Using DocConverter
DocConverter supports three standard modes of operation for increased versatility. This enables you to tailor your use of DocConverter for everything from custom applications to batch conversions.
Accessing the COM component Hot Folders Interactive Conversion
activePDF DocConverter v3.8 Page 24 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Using DocConverter
Accessing the COM component
This is the most common use of activePDF DocConverter. The COM object is instantiated in your COM enabled scripting environment providing access to the object's methods and properties. COM instancing offers the most versatile implementation of activePDF DocConverter. Refer to the Object Reference for a detailed explanation of the object instantiation and usage requirements.
activePDF DocConverter v3.8 Page 25 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Using DocConverter
Hot Folders
Hot Folder technology is at the heart of DocConverter batch conversion. Hot Folder are directories watched by DocConverter so that any time a file is dropped in the folder, DocConverter begins the analysis of the file type and prepares the appropriate Processor for conversion to PDF. Hot Folder and their properties can be created and assigned using the DocConverter Maintenance and Directories .
activePDF DocConverter v3.8 Page 26 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Getting Started -> Using DocConverter
Interactive Conversion
Interactive Conversion provides a quick and easy way to convert single documents with a specific Processor . The conversion runs under the logged on user account, which means it is also useful for testing problematic conversions. You can access the Interactive Conversion in the DocConverter Maintenance menu.
activePDF DocConverter v3.8 Page 27 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
DocConverter Maintenance
The DocConverter Maintenance allows you to setup Hot Folders , create and modify Document Signatures , and configure the Processor Options for you installed applications. To run DocConverter Maintenance:
1. Log in as the Local Administrator . 2. Click Start > Run , type APDCMNT.exe , and then click OK .
Figure 3.1: The Maintenance Dialog.
Option Description
Directories Configure directories for scanning.
Directory Filters Create and configure directory filters.
Document Signatures Create and modify document signatures.
Installed Applications Configure processor options for installed applications.
Interactive Conversion Open DocConverter Interactive Mode.
Quit Quit the Maintenance application.
activePDF DocConverter v3.8 Page 28 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Directories
Use this option to create or modify Hot Folders for directory scanning. Any previously created Hot Folders are listed under this option.
Figure 3.2: Directories Dialog.
Directories supports these choices:
Add Directory Change Directory Delete Directory
Add Directory
Creates a Hot Folder for directory scanning by setting the directory options listed below Figure 3.3 .
activePDF DocConverter v3.8 Page 29 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 3.3: The Directory Detail Dialog.
Option Description
Directory to scan The full path to the folder to watch. Files placed in the folder are filtered and processed according to the Directory Filter , Signatures , and Installed Applications .
NOTE: You must delete and create a new directory to change this path.
Where to place converted The full path to place generated output PDFs. files
Where to place files that The full path to place input documents that cannot be converted. Must select cannot be converted Unresolved to Errors .
NOTE: Files will be deleted if left blank
Where to place original The full path to move input documents after conversion. files after conversion NOTE: Files will be deleted if left blank
Script to execute upon The full path to the script to execute upon completion of each conversion. Refer to completion Scripting for usage requirements.
activePDF DocConverter v3.8 Page 30 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Scripting Language The language for the Script to execute upon completion .
VBScript - Visual Basic Scripting Language. (Default)
JScript - JavaScript.
Saved activePDF Server Uses a predefined Server Configuration for the conversion. Refer to the Server Product Configuration to use Manual for additional information. Leave blank to use default configuration. (Default)
Support unzipping of Set to allow DocConverter to convert files contained in a zipped file. DocConverter files indicates the files processed and not processed.
Unresolved to Errors Instructs DocConverter to move files that cannot be converted for any reason to the location specified for Where to place files that cannot be converted . Files remain in Directory to Scan if not selected.
Filters The Directory Filters applied to the directory. Up to 9 filters can be processed in order.
Linearize Document The output PDF is prepared for Byte-Serving , which allows it to be downloaded one page at a time on supported browsers and PDF viewers.
User Password Case-sensitive password required to view document.
32 character maximum length, no control characters. Cannot be changed. For evaluation, DEMO is prefixed to the password and counts toward character limit.
Owner Password Case-sensitive password required to modify encryption settings. Defaults to User Password .
32 character maximum length, no control characters. Cannot be changed. For evaluation, DEMO is prefixed to the password and counts toward character limit.
Permit Printing Enable users to print output.
Permit Changing Enable users to edit text or images when permitted by PDF viewer.
Permit Selecting Enable users to copy text and graphics.
Permit Modifying Forms Enable users to modify documents, including rearranging of pages.
128-bit encryption Enable the 128-bit security options. Your machine must support Strong Encryption
Permit Form Filling (128-bit) Enable users to fill PDF form fields when permitted by PDF viewer.
Permit Accessibility (128-bit) Enable users to use Accessibility aids, including tagged PDF structure, when included in PDF and permitted by PDF viewer.
Permit Assembly (128-bit) Enable users to insert, rotate or delete pages, and generate bookmarks and thumbnails even if Permit Modifying is not selected.
Permit True (128-bit) Enable user to print faithful reproduction of PDF. Low-resolution printing Reproduction enabled if not selected and Permit Printing is selected.
Change Directory
Enables you to change options pictured in Figure 3.3 for the selected directory.
NOTE: Directory to scan cannot be changed.
Delete Directory
Delete the selected directory so that it will not be scanned unless added with Add Directory .
activePDF DocConverter v3.8 Page 31 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Directory Filters
You can create a directory filter to prevent files from converting by file type extension. Use this option conjunction with Document Signatures to streamline your DocConverter batch conversion process. Files excluded by the filter are placed in the location defined as Where to place files that cannot be converted - all other files are converted as normal. Any previously created filters display in the dialog window.
Figure 3.4: The Directory Filter Dialog.
Directory Filters supports these options:
Add Filter Change Filter Delete Filter
Add Filter
Creates a filter for assigning to Directories .
activePDF DocConverter v3.8 Page 32 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 3.5: The Add Filter Dialog.
Option Description
Filter ID A unique identifier or one of the installed Document Signatures .
NOTE: You must delete and create a new filter to change this ID.
Filter Name The name of the filter. Used for the filter description.
Extensions The file type extensions to exclude from conversions. Separate multiple extensions with a pipe ("|"). For example DOC|TXT|RTF . This field can be left blank.
Supported All file types included under the selected Document Signatures will be excluded from conversion. Signatures
Change Filter
Enables you to change options pictured in Figure 3.5 for the selected filter.
NOTE: Filter ID cannot be changed.
Delete Filter
Delete the selected filter.
activePDF DocConverter v3.8 Page 33 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Document Signatures
Signatures allow you to assign file types to be processed by specific Application Processors . This option allows you to manage the Included Signatures and add new signatures. The Included Signatures appear in the dialog window.
Figure 3.6: The Document Signatures Dialog.
Document Signatures supports these options:
Add Signature Change Signature Delete Signature
Add Signature
Creates a new signature. Refer to Creating a Document Signature for information on creating a signature.
activePDF DocConverter v3.8 Page 34 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 3.7: The Add Signature Dialog.
Option Description
Signature ID A unique identifier for the signature.
NOTE: You must delete and create a new signature to change this ID.
Signature Name The name of the signature. Used for the signature description.
Signature Type Extension, Binary, or Text.
Signature Data Data information defining the signature. Refer to Creating a Document Signature for more information.
Assigned The Application Processor used to process the signature. Processor NOTE: Automatically updates Supported Signature selection.
Change Signature
Enables you to change options pictured in Figure 3.7 for the selected signature.
NOTE: Signature ID cannot be changed.
activePDF DocConverter v3.8 Page 35 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Delete Signature
Delete the selected signature.
Included Signatures
ID Description
$$DFLT Default Signature
EPS Encapsulated PostScript ®
EPSP EPS File with Preview
EX21 Excel 2.1 Worksheet
EX30 Excel 3.0 Worksheet
EX40 Excel 4.0 Worksheet
EX50 Excel 5.0/95 Document
EX97 Excel 97/2000 Document
EXDO Excel Ole DLL Signature
POST PostScript ® Data
PP30 PowerPoint 3.0
PP40 PowerPoint OLE DLL Signature
PP95 PowerPoint 95
PP97 PowerPoint 97/2000
QUAT Quattro Pro/DOS
QUATW1 Quattro Pro/Windows v1
QUATW2 Quattro Pro/Windows v2
RTF RTF File
WD60 Word 6.0 Document
WD60O Word 6.0 OLE Compound Document
WD70O Word 95 OLE Compound Document
WD80 Microsoft Word 8.0 Signature
WD80O Word 8.0 OLE Compound Signature
WD97 Word 97/2000 Document File
WDDO Word OLE DLL Signature
WDMC4 Word For Macintosh 4.0
WDMC5 Word For Macintosh 5.x
WKS Lotus Worksheet (v1)
WKS2 Lotus Worksheet (v2)
WKS3 Lotus Worksheet (v3)
WPFCT WordPerfect
activePDF DocConverter v3.8 Page 36 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: We strongly recommend that you do not alter these signatures.
activePDF DocConverter v3.8 Page 37 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Installed Applications
Enables you to modify the default configurations for the Available Applications .
NOTE: Certain processors are only available in the corresponding application is installed prior to installing DocConverter.
Figure 3.8: The Installed Applications Dialog.
Click the Change App Info button to alter the settings for the selected Application .
Change App Info
You can change various settings for the selected Application .
activePDF DocConverter v3.8 Page 38 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 3.9: The Application Details Dialog.
Option Description
Simultaneous Threads The maximum number of threads the processor can use.
NOTE: Certain Applications do not support multi-threaded processing. Increasing this number may decrease performance.
Default Application Allows you to edit processor specific options when supported by the application. Refer to Options Application Processors for details on the processors that support this option.
Supported Signatures Select the signatures processed by the application.
NOTE: Automatically updates Assigned Processor selection.
Use Static Printer Pool Assign the processor to use the Static Printer Pool created by activePDF Server. Refer to the activePDF Server Product Manual for information on creating the pool.
Reject if Pre-Processing Instructs DocConverter to move documents that cannot be opened by the fails corresponding application to the Where to place files that cannot be converted location.
Print to PostScript File Prints a PostScript ® file with the activePDF Server TM activePDF Shadow Printer and calls PSToPDF .
Do not set default Prevents DocConverter from assigning the last used printer as the system default. printer
activePDF DocConverter v3.8 Page 39 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Do not delete PostScript The temporary PostScript file is not deleted from the X:\WINDOWS\ActivePDF or file X:\WinNT\ActivePDF folder after conversion.
NOTE: You may need to set the corresponding option in activePDF Server. The document name is not retained and will appear similar to ActivePDF-22.PS .
Run under System Enable DocConverter to run under the SystemOnly Launch service. account NOTE: Do enable this setting unless instructed by activePDF Technical Support .
Wait for PDF generation Instructs DocConverter to wait for the document PostScript to finish printing before the conversion to PDF. This may be useful with large documents that begin conversion to PDF before the PS has finished printing.
Maximum # of The number of attempted conversion before the document is moved to the Where to conversion retries place files that cannot be converted location.
Default = 6.
# of Conversions The number of conversions the application remains open. This eliminates the need for between application the application to close after each conversion and can speed up large volume launches conversions.
Default = 1000.
Password protect DocConverter does not support Password Protected Documents . Set a return code to document rejection code indicate the document has been moved to the Where to place files that cannot be converted location.
Pre-check document The wait time in seconds during which DocConverter verifies that the document path is existence # seconds valid. This can be useful when processing a large volume of documents.
Seconds to wait before The wait time in seconds before the application closes after assigned number of application quit conversions.
NOTE: If # of Conversions between application launches set to 0, the value indicates the wait after each conversion.
Reject BLANK password Excel Only: DocConverter does not support Password Protected Documents . Set this documents option to prevent conversion failure for documents with blank passwords, which will not convert.
Print all worksheets at Excel Only: DocConverter prints all worksheets as a single print job. This can be useful once to control page numbering when worksheets are printed as separate jobs.
Available Applications
DocConverter includes the following processors. The corresponding application must be installed before installing DocConverter for the processor to be available.
ID Description Max Threads
DFLT Generic activePDF DocConverter Processor
EX97 Excel 97 Processor 1
EX2K Excel 2000 Processor 2
EX23 Excel 2003 Processor 2
NULL NULL Processor
POST PostScript Processor
activePDF DocConverter v3.8 Page 40 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ PP97 PowerPoint ® 97 Processor 1
PP2K PowerPoint ® 2000 Processor 2
PP23 PowerPoint ® 2003 Processor 2
RTFO RTF Only Converter
WD97 Word 97 Processor 1
WD2K Word 2000 Processor 2
WD23 Word 2003 Processor 2
WP90 WordPerfect ® 9.0
NOTE: Refer to Application Processors for processor details.
activePDF DocConverter v3.8 Page 41 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Interactive Conversion
Allows you to convert a single document to PDF using a selected processor. Interactive conversion runs under the Logged On User account.
Figure 3.10: Interactive Conversion Dialog.
Option Description
Selected The Installed Application assigned to convert the document. Processor
Output Filename The full path to place the generated output PDF.
Processor The processor option used for the conversion. Refer to Application Processors for more Options information.
Convert Begin the conversion.
NOTE: On-screen dialogs will detail the status of the conversion.
Linearize The output PDF is prepared for Byte-Serving , which allows it to be downloaded one page at a Document time on supported browsers and PDF viewers.
User Password Case-sensitive password required to view document.
32 character maximum length, no control characters. Cannot be changed. For evaluation, DEMO is prefixed to the password and counts toward character limit.
Owner Password Case-sensitive password required to modify encryption settings. Defaults to User Password .
32 character maximum length, no control characters. Cannot be changed. For evaluation, DEMO is prefixed to the password and counts toward character limit.
Permit Printing Enable users to print output.
Permit Changing Enable users to edit text or images when permitted by PDF viewer.
Permit Selecting Enable users to copy text and graphics.
activePDF DocConverter v3.8 Page 42 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Permit Modifying Enable users to modify documents, including rearranging of pages. Forms
activePDF DocConverter v3.8 Page 43 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Processors activePDF DocConverter uses Application Processors to direct the conversion process. Once a file is submitted, DocConverter analyzes the file type and instructs the native application to open the file and print to PostScript ®. Application Processors are specialized code that controls the PostScript printing, after which DocConverter passes PostScript to activePDF Server for conversion to PDF.
NOTE: You must have the corresponding native application installed prior to installing DocConverter
DocConverter includes the following processors depending on your installation:
Default NULL Microsoft Office PostScript RTF Only WordPerfect 9
activePDF DocConverter v3.8 Page 44 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
Default
Processor ID: DFLT
Description: The Default Application Processor is a generic processor used when all other processors do not apply.
Threads: Supports multi-threaded processing.
Remarks: This processor does not have the same level of fidelity as the native application processors. We strongly recommend using the native application processor when possible. Multi-threaded performance is based on machine specifications.
activePDF DocConverter v3.8 Page 45 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
NULL
Processor ID: NULL
Description: The NULL Application Processor transfers non-convertible file types directly to the output location. By default, the processor excludes PDFs from conversion.
Threads: Not applicable.
Remarks: You can add additional file types using Document Signatures or through the Installed Applications option.
NOTE: Files processed by the NULL processor do not count towards the Document Per Hour Limit
activePDF DocConverter v3.8 Page 46 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
Microsoft Office
The Microsoft ® Office processors support the conversion of Microsoft Excel, PowerPoint ®, and Word documents. To install the processors, you must have the corresponding version of Office installed prior to installing DocConverter.
Office 97 Processors Office 2000 Processors Office 2003 Processors
activePDF DocConverter v3.8 Page 47 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office
Office 97 Processors
The Office 97 processors are designed to convert Microsoft Excel, PowerPoint ®, and Word documents created with product versions up to Office 97.
NOTE: The Office 97 Processors may not support all features.
Excel 97 PowerPoint 97 Word 97
activePDF DocConverter v3.8 Page 48 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 97 Processors
Excel 97
Processor ID: EX97
Description: The Microsoft ® Excel 97 processor is used during the conversion of Excel 97 and earlier .XLS files.
Threads: Single threaded.
Processor Options: The Excel 97 processor has one option available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
WhichWorksheets A value indicating the corresponding worksheets in the Excel file to print. You can specify ranges by using a hyphen (" -") and multiple worksheets with a comma. By default, all worksheets are printed.
Example = "WhichWorksheets=1-3,5,8"
activePDF DocConverter v3.8 Page 49 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 97 Processors
PowerPoint 97
Processor ID: PP97
Description: The Microsoft ® PowerPoint ® 97 processor is used during the conversion of PowerPoint 97 and earlier .PPT files.
Threads: Single threaded.
Processor Options: The PowerPoint 97 processor has seven options available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
FitToPage The page is scaled to fit the output page size.
-1 = The output is fit to page.
0 = The output prints at original size. May clip.
NOTE: Does not apply to handouts
HandoutOrder Determines the leading edge when printed.
1 = Vertical edge first.
2 = Horizontal edge first. (Default)
NOTE: OutputType must be set to a handout type.
OutputType Indicates how the slides are printed.
1 = Slides. (Default)
2 = 2 slides per handout.
3 = 3 slides per handout.
4 = 6 slides per handout.
5 = Single slide with notes.
6 = Slide outline.
7 = Print all interim stage build slides.
8 = 4 slides per handout.
9 = 9 slides per handout.
activePDF DocConverter v3.8 Page 50 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: FrameSlides must be set to -1 for handouts.
FrameSlides Prints a border around the slide.
-1 = Border is printed.
0 = No Border. (Default)
NOTE: Must be set to -1 for handouts
PrintColorType The color setting for the output.
1 = Color. (Default)
2 = Black and white using gradients.
3 = Pure black and white.
PrintFontsAsGraphics Print TrueType as graphics. May be necessary to print certain characters or symbols.
-1 = TrueType fonts printed as graphics.
0 = TrueType fonts not printed as graphics. (Default)
NOTE: This setting may not work with certain emulated printers.
PrintHiddenSlides Enables slides marked as hidden to print.
-1 = Hidden slides are printed.
0 = Hidden slides are not printed. (Default)
Remarks: Multiple Processor Options can be specified with a semicolon. For example, "FitToPage=- 1;OutputType=1;PrintColorType=1"
activePDF DocConverter v3.8 Page 51 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 97 Processors
Word 97
Processor ID: WD97
Description: The Microsoft ® Word 97 processor is used during the conversion of Word 97 and earlier .DOC files.
Threads: Single threaded.
Application Options: The Word 97 application has seventeen options available under the Default Application Options on the Installed Applications dialog.
Figure 4.1: Word Default Configuration Parameters Dialog
Option Description & Usage
Enable Macro Virus Checking Documents containing macros are moved to the Where to place files that cannot be converted location.
Support Intelligent PDF Enables use of the options listed below. Intelligent documents Creation contain added features, such as Header styles converted to linked bookmarks.
Convert Headings to Bookmarks In document text defined with Header styles are converted to linked PDF bookmarks.
Link Footnotes and Endnotes Convert Word Footnote and Endnote links to PDF links.
Create Internet Links Links to external HTTP addresses entered as Hyperlinks are converted to PDF web links.
Convert Comments to Notes Word comments are converted to PDF Note type comments.
Create Cross-reference and Internal cross-reference and Table of Content links are
activePDF DocConverter v3.8 Page 52 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Table of Contents Links converted to PDF document links.
Convert Textboxes to Threads Text placed in Word Form Text Boxes is converted to PDF text.
Create Cross-document links Word Hyperlink links to external documents are retained as external document PDF links.
Convert Document Information Word document properties, such as Author are converted to PDF document properties.
Convert Form Fields Word Form Text Boxes are converted to PDF form fields.
NOTE: Text is not retained. If Convert Textboxes to Threads is selected, text appears underneath PDF form field.
Open to page only Output PDF displays only the PDF page on initial view when supported by PDF viewer.
Open to bookmarks and page Output PDF displays the Bookmarks panel and page on initial view when supported by PDF viewer.
PDF Link Type Creates desired border width around links.
Invisible Rectangle = Links have no border. (Default)
Thin Visible Rectangle = Links have a thin border around all edges.
Thick Visible Rectangle = Links have a thick border around all edges.
PDF Link Highlight Creates link with desired highlight effect.
None = Links are not highlighted. (Default)
Invert = Link color displays as opposite.
Outline = Link border color displays as opposite.
Inset = Link appears as embossed rectangle.
NOTE: If no PDF Link Type is selected, Outline may create black link.
PDF Link Color The color of the output links. Defaults to Blue .
Black = Color
Blue = Color
Cyan = Color
Green = Color
Magenta = Color
Red = Color
Yellow = Color
activePDF DocConverter v3.8 Page 53 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ White = Color
NOTE: Colors may vary.
PDF Link Style Creates link with desired link style.
Solid = Appears as a solid line if link selected. (Default)
Dashed = Appears as a broken line if link selected.
Processor Options: The Word 97 processor has two options available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
EnableVirusProtection Documents containing macros are moved to the Where to place files that cannot be converted location.
1 = Enabled.
0 = Disabled. (Default)
IntelligentPDF Uses the intelligent PDF options currently defined under Application Options .
1 = Enabled.
0 = Disabled. (Default)
Remarks: Multiple Processor Options can be specified with a semicolon. For example, "EnableVirusProtection=0;IntelligentPDF=1"
activePDF DocConverter v3.8 Page 54 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office
Office 2000 Processors
The Office 2000 processors are designed to convert Microsoft Excel ®, PowerPoint ®, and Word documents created with product versions up to Office 2000.
Excel 2000 PowerPoint 2000 Word 2000
activePDF DocConverter v3.8 Page 55 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2000 Processors
Excel 2000
Processor ID: EX2K
Description: The Microsoft ® Excel 2000 processor is used during the conversion of Excel 2000 and earlier .XLS files.
Threads: Single threaded.
Processor Options: The Excel 2000 processor has one option available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
WhichWorksheets A value indicating the corresponding worksheets in the Excel file to print. You can specify ranges by using a hyphen (" -") and multiple worksheets with a comma. By default, all worksheets are printed.
Example = "WhichWorksheets=1-3,5,8"
activePDF DocConverter v3.8 Page 56 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2000 Processors
PowerPoint 2000
Processor ID: PP2K
Description: The Microsoft ® PowerPoint ® 2000 processor is used during the conversion of PowerPoint 2000 and earlier .PPT files.
Threads: Single threaded.
Processor Options: The PowerPoint 2000 processor has seven options available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
FitToPage The page is scaled to fit the output page size.
-1 = The output is fit to page.
0 = The output prints at original size. May clip.
NOTE: Does not apply to handouts
HandoutOrder Determines the leading edge when printed.
1 = Vertical edge first.
2 = Horizontal edge first. (Default)
NOTE: OutputType must be set to a handout type.
OutputType Indicates how the slides are printed.
1 = Slides. (Default)
2 = 2 slides per handout.
3 = 3 slides per handout.
4 = 6 slides per handout.
5 = Single slide with notes.
6 = Slide outline.
7 = Print all interim stage build slides.
8 = 4 slides per handout.
9 = 9 slides per handout.
activePDF DocConverter v3.8 Page 57 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: FrameSlides must be set to -1 for handouts.
FrameSlides Prints a border around the slide.
-1 = Border is printed.
0 = No Border. (Default)
NOTE: Must be set to -1 for handouts
PrintColorType The color setting for the output.
1 = Color. (Default)
2 = Black and white using gradients.
3 = Pure black and white.
PrintFontsAsGraphics Print TrueType as graphics. May be necessary to print certain characters or symbols.
-1 = TrueType fonts printed as graphics.
0 = TrueType fonts not printed as graphics. (Default)
NOTE: This setting may not work with certain emulated printers.
PrintHiddenSlides Enables slides marked as hidden to print.
-1 = Hidden slides are printed.
0 = Hidden slides are not printed. (Default)
Remarks: Multiple Processor Options can be specified with a semicolon. For example, "FitToPage=- 1;OutputType=1;PrintColorType=1"
activePDF DocConverter v3.8 Page 58 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2000 Processors
Word 2000
Processor ID: WD2K
Description: The Microsoft ® Word 2000 processor is used during the conversion of Word 2000 and earlier .DOC files.
Threads: Maximum of 2 threads.
Application Options: The Word 2000 application has sixteen options available under the Default Application Options on the Installed Applications dialog.
NOTE: Enable Macro Virus Checking appears as a selectable option, but only applies to the Word 97 processor.
Figure 4.2: Word Default Configuration Parameters Dialog
Option Description & Usage
Support Intelligent PDF Enables use of the options listed below. Intelligent documents Creation contain added features, such as Header styles converted to linked bookmarks.
Convert Headings to In document text defined with Header styles are converted to Bookmarks linked PDF bookmarks.
Link Footnotes and Convert Word Footnote and Endnote links to PDF links. Endnotes
Create Internet Links Links to external HTTP addresses entered as Hyperlinks are converted to PDF web links.
Convert Comments to Notes Word comments are converted to PDF Note type comments.
activePDF DocConverter v3.8 Page 59 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Create Cross-reference and Internal cross-reference and Table of Content links are converted Table of Contents Links to PDF document links.
Convert Textboxes to Text placed in Word Form Text Boxes is converted to PDF text. Threads
Create Cross-document Word Hyperlink links to external documents are retained as links external document PDF links.
Convert Document Word document properties, such as Author are converted to PDF Information document properties.
Convert Form Fields Word Form Text Boxes are converted to PDF form fields.
NOTE: Text is not retained. If Convert Textboxes to Threads is selected, text appears underneath PDF form field.
Open to page only Output PDF displays only the PDF page on initial view when supported by PDF viewer.
Open to bookmarks and Output PDF displays the Bookmarks panel and page on initial view page when supported by PDF viewer.
PDF Link Type Creates desired border width around links.
Invisible Rectangle = Links have no border. (Default)
Thin Visible Rectangle = Links have a thin border around all edges.
Thick Visible Rectangle = Links have a thick border around all edges.
PDF Link Highlight Creates link with desired highlight effect.
None = Links are not highlighted. (Default)
Invert = Link color displays as opposite.
Outline = Link border color displays as opposite.
Inset = Link appears as embossed rectangle.
NOTE: If no PDF Link Type is selected, Outline may create black link.
PDF Link Color The color of the output links. Defaults to Blue .
Black = Color
Blue = Color
Cyan = Color
Green = Color
Magenta = Color
Red = Color
Yellow = Color
activePDF DocConverter v3.8 Page 60 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
White = Color
NOTE: Colors may vary.
PDF Link Style Creates link with desired link style.
Solid = Appears as a solid line if link selected. (Default)
Dashed = Appears as a broken line if link selected.
Processor Options: The Word 2000 processor has one option available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
IntelligentPDF Uses the intelligent PDF options currently defined under Application Options .
1 = Enabled.
0 = Disabled. (Default)
activePDF DocConverter v3.8 Page 61 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office
Office 2003 Processors
The Office 2003 processors are designed to convert Microsoft Excel, PowerPoint®, and Word documents created with product versions up to Office 2003.
Excel 2003 PowerPoint 2003 Word 2003
activePDF DocConverter v3.8 Page 62 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2003 Processors
Excel 2003
Processor ID: EX23
Description: The Microsoft ® Excel ® 2003 processor is used during the conversion of Excel 2003 and earlier .XLS files.
Threads: Single threaded.
Processor Options: The Excel 2003 processor has one option available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
WhichWorksheets A value indicating the corresponding worksheets in the Excel file to print. You can specify ranges by using a hyphen (" -") and multiple worksheets with a comma. By default, all worksheets are printed.
Example = "WhichWorksheets=1-3,5,8"
activePDF DocConverter v3.8 Page 63 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2003 Processors
PowerPoint 2003
Processor ID: PP23
Description: The Microsoft ® PowerPoint ® 2003 processor is used during the conversion of PowerPoint 2003 and earlier .PPT files.
Threads: Single threaded.
Processor Options: The PowerPoint 2003 processor has seven options available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
FitToPage The page is scaled to fit the output page size.
-1 = The output is fit to page.
0 = The output prints at original size. May clip.
NOTE: Does not apply to handouts
HandoutOrder Determines the leading edge when printed.
1 = Vertical edge first.
2 = Horizontal edge first. (Default)
NOTE: OutputType must be set to a handout type.
OutputType Indicates how the slides are printed.
1 = Slides. (Default)
2 = 2 slides per handout.
3 = 3 slides per handout.
4 = 6 slides per handout.
5 = Single slide with notes.
6 = Slide outline.
7 = Print all interim stage build slides.
8 = 4 slides per handout.
9 = 9 slides per handout.
activePDF DocConverter v3.8 Page 64 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: FrameSlides must be set to -1 for handouts.
FrameSlides Prints a border around the slide.
-1 = Border is printed.
0 = No Border. (Default)
NOTE: Must be set to -1 for handouts
PrintColorType The color setting for the output.
1 = Color. (Default)
2 = Black and white using gradients.
3 = Pure black and white.
PrintFontsAsGraphics Print TrueType as graphics. May be necessary to print certain characters or symbols.
-1 = TrueType fonts printed as graphics.
0 = TrueType fonts not printed as graphics. (Default)
NOTE: This setting may not work with certain emulated printers.
PrintHiddenSlides Enables slides marked as hidden to print.
-1 = Hidden slides are printed.
0 = Hidden slides are not printed. (Default)
Remarks: Multiple Processor Options can be specified with a semicolon. For example, "FitToPage=- 1;OutputType=1;PrintColorType=1"
activePDF DocConverter v3.8 Page 65 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors -> Microsoft Office -> Office 2003 Processors
Word 2003
Processor ID: WD23
Description: The Microsoft ® Word 2003 processor is used during the conversion of Word 2003 and earlier .DOC files.
Threads: Maximum of 2 threads.
Application Options: The Word 2003 application has sixteen options available under the Default Application Options on the Installed Applications dialog.
NOTE: Enable Macro Virus Checking appears as a selectable option, but only applies to the Word 97 processor.
Figure 4.3: Word Default Configuration Parameters Dialog
Option Description & Usage
Support Intelligent PDF Enables use of the options listed below. Intelligent documents Creation contain added features, such as Header styles converted to linked bookmarks.
Convert Headings to In document text defined with Header styles are converted to Bookmarks linked PDF bookmarks.
Link Footnotes and Convert Word Footnote and Endnote links to PDF links. Endnotes
Create Internet Links Links to external HTTP addresses entered as Hyperlinks are converted to PDF web links.
Convert Comments to Notes Word comments are converted to PDF Note type comments.
activePDF DocConverter v3.8 Page 66 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Create Cross-reference and Internal cross-reference and Table of Content links are converted Table of Contents Links to PDF document links.
Convert Textboxes to Text placed in Word Form Text Boxes is converted to PDF text. Threads
Create Cross-document Word Hyperlink links to external documents are retained as links external document PDF links.
Convert Document Word document properties, such as Author are converted to PDF Information document properties.
Convert Form Fields Word Form Text Boxes are converted to PDF form fields.
NOTE: Text is not retained. If Convert Textboxes to Threads is selected, text appears underneath PDF form field.
Open to page only Output PDF displays only the PDF page on initial view when supported by PDF viewer.
Open to bookmarks and Output PDF displays the Bookmarks panel and page on initial view page when supported by PDF viewer.
PDF Link Type Creates desired border width around links.
Invisible Rectangle = Links have no border. (Default)
Thin Visible Rectangle = Links have a thin border around all edges.
Thick Visible Rectangle = Links have a thick border around all edges.
PDF Link Highlight Creates link with desired highlight effect.
None = Links are not highlighted. (Default)
Invert = Link color displays as opposite.
Outline = Link border color displays as opposite.
Inset = Link appears as embossed rectangle.
NOTE: If no PDF Link Type is selected, Outline may create black link.
PDF Link Color The color of the output links. Defaults to Blue .
Black = Color
Blue = Color
Cyan = Color
Green = Color
Magenta = Color
Red = Color
Yellow = Color
activePDF DocConverter v3.8 Page 67 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
White = Color
NOTE: Colors may vary.
PDF Link Style Creates link with desired link style.
Solid = Appears as a solid line if link selected. (Default)
Dashed = Appears as a broken line if link selected.
Processor Options: The Word 2003 processor has one options available for use with Interactive Conversion or when calling the Submit method.
Option Description & Usage
IntelligentPDF Uses the intelligent PDF options currently defined under Application Options .
1 = Enabled.
0 = Disabled. (Default)
activePDF DocConverter v3.8 Page 68 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
PostScript
Processor ID: POST
Description: The PostScript Application processor is used during the conversion of PostScript ®(.PS ) and Encapsulated PostScript( .EPS ) files.
Threads: Supports multi-threaded processing.
activePDF DocConverter v3.8 Page 69 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
RTF Only
Processor ID: RTFO
Description: The Rich Text File( .RTF ) Only processor is used during the conversion of RTF files.
Threads: Supports multi-threaded processing.
Remarks: The Office processors may provide better fidelity for RTF conversion.
activePDF DocConverter v3.8 Page 70 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Processors
WordPerfect 9
Processor ID: WP90
Description: The WordPerfect ® 9 processor is used during the conversion of WordPerfect 9 and earlier .WPD files.
Threads: Single threaded.
Remarks: The Office processors can be used to convert WPD files if you install the optional plug-in prior to conversion. The optional plug-in is included with the Microsoft® Office CD.
activePDF DocConverter v3.8 Page 71 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Object Reference activePDF DocConverter supports file conversion through a programmable COM object. This section contains the technical documentation for the Methods and Properties defined in the DocConverter COM object. Once you have become familiar with Instantiating the DocConverter Object , you can use this as your main resource for understanding DocConverter.
Instantiating the Object Methods Properties
activePDF DocConverter v3.8 Page 72 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference
Instantiating the Object
The DocConverter COM object is represented by the Class ID APDocConv.Object . You can use this Class ID to instantiate the object.
Instantiation
The instantiation of the DocConverter COM object using the Class ID depends on your scripting environment. We recommend the use of Late-Binding as the DocConverter type library is already registered in the Object Registry . The following VBScript example demonstrates the instantiation process.
' Instantiate Object Set objDC = CreateObject ("APDocConv.Object")
Clean-Up
Certain scripting environments support clearing the variables. Destroying the object prevents the memory build-up after the conversion is finished. Below is a VBScript example that would appear at the end of your code.
' Release Object Set objDC = Nothing
activePDF DocConverter v3.8 Page 73 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference
Methods
The DocConverter object contains eight methods that allow you to perform actions from file submission to output encryption. The following is the complete list of DocConverter's methods.
CheckStatus RetrieveFile ServerConfigurationPath SetFilterOptions SetLinearize SetSecurityOptions SetSecurityOptions128 Submit TransmitFile
activePDF DocConverter v3.8 Page 74 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
CheckStatus
Description: Returns the status of the current conversion.
NOTE: Use the StatusTimeout property to set a wait time for this method.
Syntax: retValue = object .CheckStatus ( "IPAddress", "PortNumber", "FileToConvert", "ConvertedDirectory", "ErrorsDirectory" )
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
IPAddress STRING The IP address of the server-machine where DocConverter is installed. ( Typically, 127.0.0.1 ).
PortNumber LONG The port assigned to DocConverter.
0 = Defaults to standard 53540. (Default)
FileToConvert STRING The full path and filename for the file to convert.
ConvertedDirectory STRING The full path to the output directory.
ErrorsDirectory STRING The full path to the error files directory.
retValue: Value Type Description & Settings
LONG A value indicating the success of the operation:
-2 = DocConverter Service cannot resolve the document to a signature.
0 = General error. Enable debugging and create your activePDF Log Files .
1 = Success.
2 = Conversion failed. Invalid document type or permissions.
-99 = Timeout reached.
-777 = Unable to print. The activePDF Server static printers the job is printing to have not been created. Ensure that all activePDF services, as well as the Print Spooler service, are set to Automatic and are started. Ensure activePDF Server is installed and working.
activePDF DocConverter v3.8 Page 75 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Remarks: All paths must be consistent and specific to the local or remote machine. For example:
Local - X:\activePDFDocs\originals
Remote - \\computername\sharename\originals
The DocConverter Remote OCX is required for remote submission. The DocConverter Service user account must be in the Local Administrators group and have access to all remote locations and files.
activePDF DocConverter v3.8 Page 76 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
RetrieveFile
Description: Specifies a remote file to retrieve for use with remote submission.
Syntax: retValue = object .RetrieveFile ( "IPAddress", "PortNumber", "RemoteFilePath", "DestinationFilePath" )
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
IPAddress STRING The IP address of the server-machine where DocConverter is installed. (Typically, 127.0.0.1 ).
PortNumber LONG The port assigned to DocConverter.
0 = Defaults to standard 53541. (Default)
RemoteFilePath STRING A UNC path to the remove file.
DestinationFilePath STRING The local path and fllename to create.
retValue: Value Type Description & Settings
LONG A value indicating the success of the operation:
0 = Success.
<>0 = An error has occurred.
NOTE: Contact activePDF Technical Support if 0 is not returned
activePDF DocConverter v3.8 Page 77 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
ServerConfigurationPath
Description: Specifies the path to a preconfigured activePDF Server Document Configuration Profile ( APS ) for use when generating the output PDF.
Syntax: retValue = object .ServerConfigurationPath ( "ServerConfigAPS" )
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
ServerConfigAPS STRING The name and path for the .APS .
activePDF DocConverter v3.8 Page 78 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
SetFilterOptions
Description: Sets the filters to use by Filter ID as defined in Directory Filters .
NOTE: Must be called prior to Submit .
Syntax: object .SetFilterOptions MoveUnresolved, "FilterID1", "FilterID2", "FilterID3", "FilterID4", "FilterID5", "FilterID6", "FilterID7", "FilterID8", "FilterID9"
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
MoveUnresolved BOOLEAN A value indicating how DocConverter handles unresolved files.
True = Files are moved to the ErrorsDirectory specified in the Submit call.
False = No action is applied to unresolved files.
FilterID1 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID2 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID3 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID4 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID5 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID6 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID7 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID8 STRING A filter ID. Use empty quotes ( "" ) for no filter.
FilterID9 STRING A filter ID. Use empty quotes ( "" ) for no filter.
activePDF DocConverter v3.8 Page 79 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
SetLinearize
Description: Instructs DocConverter to Linearize the output.
NOTE: Must be called prior to Submit .
Syntax: object .SetLinearize OnOffFlag
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
OnOffFlag BOOLEAN A value indicating the linearization status.
True = Output is linearized.
False = Output is not linearized. (Default)
activePDF DocConverter v3.8 Page 80 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
SetSecurityOptions
Description: Adds 40-bit security to the output PDF.
NOTE: Must be called prior to Submit . Options might not be supported by all PDF viewers.
Syntax: object .SetSecurityOptions "UserPassword", "OwnerPassword", CanPrint, CanEdit, CanCopy, CanModify
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
UserPassword STRING Case-sensitive password required to view document, which has a 32- character maximum and cannot contain control characters.
NOTE: The password cannot be changed once set. For evaluations, the prefix DEMO will is added and counts towards the character limit. For example, the password TEST becomes DEMOTEST .
OwnerPassword STRING Case-sensitive password required to modify document, which has a 32- character maximum and cannot contain control characters.
NOTE: The password cannot be changed once set. For evaluations, the prefix DEMO will is added and counts towards the character limit. For example, the password TEST becomes DEMOTEST .
CanPrint LONG Enables or disables printing for the output PDF.
True = Enable printing. (Default)
False = Disable printing.
CanEdit BOOLEAN Enables or Disables editing for the output PDF.
True = Enable editing (Default)
False = Disable editing.
CanCopy BOOLEAN Enables or disables copying of text and graphics for the output PDF.
True = Enable copying of text and graphics. (Default)
False = Disable copying of text and graphics.
CanModify BOOLEAN Enable or disable document modification in the output PDF.
True = Enable modification. (Default)
False = Disable modification.
activePDF DocConverter v3.8 Page 81 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ activePDF DocConverter v3.8 Page 82 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
SetSecurityOptions128
Description: Adds 128-bit security to the output PDF.
NOTE: Must be called prior to Submit . Options might not be supported by all PDF viewers.
Syntax: object .SetSecurityOptions128 "UserPassword", "OwnerPassword", CanPrint, CanEdit, CanCopy, CanModify, CanFillInFormFields, CanMakeAccessible, CanAssemble, CanReproduce
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
UserPassword STRING Case-sensitive password required to view document, which has a 32- character maximum and cannot contain control characters.
NOTE: The password cannot be changed once set. For evaluations, the prefix DEMO will is added and counts towards the character limit. For example, the password TEST becomes DEMOTEST .
OwnerPassword STRING Case-sensitive password required to modify document, which has a 32- character maximum and cannot contain control characters.
NOTE: The password cannot be changed once set. For evaluations, the prefix DEMO will is added and counts towards the character limit. For example, the password TEST becomes DEMOTEST .
CanPrint LONG Enables or disables printing for the output PDF.
True = Enable printing. (Default)
False = Disable printing.
CanEdit BOOLEAN Enables or Disables editing for the output PDF.
True = Enable editing (Default)
False = Disable editing.
CanCopy BOOLEAN Enables or disables copying of text and graphics for the output PDF.
True = Enable copying of text and graphics. (Default)
False = Disable copying of text and graphics.
CanModify BOOLEAN Enable or disable document modification in the output PDF.
True = Enable modification. (Default)
False = Disable modification.
activePDF DocConverter v3.8 Page 83 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ CanFillInFormFields BOOLEAN Enable or disable form field population in the output PDF.
True = Enable form field population. (Default)
False = Disable form field population.
CanMakeAccessible BOOLEAN Enables or disables the use of any accessibility aids added to the output PDF with an external application.
True = Enable the use of accessibility aids. (Default)
False = Disable the use of accessibility aids.
CanAssemble BOOLEAN Enables or disables document assembly for output PDF.
True = Enable user to insert, rotate, delete pages, generate bookmarks and thumbnails. (Default)
False = Disable document assembly.
NOTE: Supersedes CanModify
CanReproduce BOOLEAN Enables or disables reproduction of output PDF.
True = Enable faithful reproduction. (Default)
False = Disable reproduction.
NOTE: If False and CanPrint is set to True , low-resolution printing is enabled.
activePDF DocConverter v3.8 Page 84 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
Submit
Description: Submits a document for conversion.
Syntax: retValue = object .Submit ( "IPAddress", "PortNumber", "FileToConvert", "OutputDirectory", "ErrorsDirectory", "OriginalsDirectory", "ScriptName", "ScriptLang", SupportsZip, "ProcessorOptions" )
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
IPAddress STRING The IP address of the server-machine where DocConverter is installed. (Typically, 127.0.0.1 ).
PortNumber LONG The port assigned to DocConverter.
0 = Defaults to standard 53540. (Default)
FileToConvert STRING The full path and filename for the file to convert.
ErrorsDirectory STRING The full path where error files are placed.
OriginalsDirectory STRING The full path where the FileToConvert is moved after conversion.
ScriptName STRING The full path to the script to execute upon completion. Refer to Scripting for usage information. Use "" for no script. (Default)
ScriptLang STRING The language of the ScriptName script.
VBScript = Visual Basic Script. (Default)
JScript = JavaScript ®.
SupportsZip BOOLEAN A value indicating if the FileToConvert is a zipped file.
True = The file is zipped.
False = The file is not zipped. (Default)
NOTE: If True , DocConverter indicates the files processed and not processed. CheckStatus cannot be used with zipped files
ProcessorOptions STRING Options specific to the selected processor, as documented for each processor in Processor Options .
activePDF DocConverter v3.8 Page 85 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ retValue: Value Type Description & Settings
LONG A value indicating the success of the operation:
1 = Service not started or invalid IP specified.
0 = Success.
-2 = General error. Ensure service is started and user account is valid with proper permissions, may require domain user. Enable debugging and create your activePDF Log Files .
-3 = Evaluation period or document per hour limit exceeded.
-99 = Timeout reached.
Remarks: All paths must be consistent and specific to the local or remote machine. For example:
Local - X:\activePDFDocs\originals
Remote - \\computername\sharename\originals
The DocConverter Remote OCX is required for remote submission. The DocConverter Service user account must be in the Local Administrators group and have access to all remote locations and files.
activePDF DocConverter v3.8 Page 86 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Methods
TransmitFile
Description: Transmits a file to a remote DocConverter server.
Syntax: retValue = object .TransmitFile ( "IPAddress", "PortNumber", "FileToTransmit", "DestinationFilePath" )
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
IPAddress STRING The IP address of the server-machine where DocConverter is installed. (Typically, 127.0.0.1 ).
PortNumber LONG The port assigned to DocConverter.
0 = Defaults to standard 53541. (Default)
FileToTransmit STRING The local file name to transmit to the remote machine running DocConverter.
DestinationFilePath STRING A UNC path to the remote location specifying the filename to create.
retValue: Value Type Description & Settings
LONG A value indicating the success of the operation:
0 = Success.
<>0 = An error has occurred.
NOTE: Contact activePDF Technical Support if 0 is not returned
activePDF DocConverter v3.8 Page 87 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference
Properties
The DocConverter object contains two properties designed to supplement your implementation of the CheckStatus and Submit methods. The following is the complete list of DocConverter's properties.
ConverterType StatusTimeout
activePDF DocConverter v3.8 Page 88 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Properties
ConverterType
Description: Returns the Application ID for the Installed Application used in the last conversion.
NOTE: Must call after Submit .
Syntax: "retValue" = object .ConverterType
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
retValue: Value Type Description & Settings
STRING Application ID for the Installed Application used in the last conversion.
Empty quotes ( "" ) = File was not processed. Ensure a processor is selected.
activePDF DocConverter v3.8 Page 89 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Object Reference -> Properties
StatusTimeout
Description: Specifies the wait time in seconds before the CheckStatus method returns a status.
Syntax: object .StatusTimeout = setValue
Arguments: Argument Value Type Description & Settings
object N/A Set to an instance of the DocConverter object.
setValue LONG The wait time in seconds for the CheckStatus method. Defaults to 0 ( zero ) seconds
activePDF DocConverter v3.8 Page 90 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Advanced Configuration
DocConverter includes several advanced techniques designed to expand the possibilities of your implementation. This section details these techniques, including step by step instructions and examples.
NOTE: We strongly recommend that you familiarize yourself with the basic operations of DocConverter before implementing advanced configurations.
Using DocConverter 3.5.2 in .NET Remote Operation Document Signatures Scripting Using the Registry Switches
activePDF DocConverter v3.8 Page 91 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration
Using DocConverter 3.5.2 in .NET
Using DocConverter in .NET requires activePDF Server, the APServerNET.DLL wrapper, and the APDocConvNET.DLL wrapper.
Installing the APDocConvNET.DLL and APServerNET.DLL Wrappers
The APDocConvNET.DLL and APServerNET.DLL COM Interop wrappers are not installed with activePDF DocConverter and Server. After installing DocConverter and Server, you need to download the wrappers from http://www.activePDF.com/altdownloads/Products/dotNET/APDocConvNET_SP7.zip , and then unzip the DLLs to a location accessible by your .NET scripting software.
Namespace in .NET
In .NET, the DocConverter namespace becomes APDocConvNET.APDocConverter and the Server namespace becomes APServerNET.APServer .
Referencing APDocConvNET.DLL and APServerNET.DLL
You must add a reference to APDocConvNET.DLL and APServerNET.DLL in your .NET scripting environment. A missing or invalid reference will result in a missing type or namespace error. Use the following steps to add a reference in Visual Studio ® .NET:
1. Start Visual Studio .NET. 2. In the Solution Explorer , right-click Reference , and then select Add Reference . 3. In the Add Reference dialog, click Browse . 4. In the Browse field, type the location of the APDocConvNET.DLL , and then click Open . 5. Repeat these steps to reference the APServerNET.DLL .
Instantiating the Object
After referencing the .NET DLLs, you must instantiate the DocConverter and Server objects in .NET using the syntax of the script language. Instantiation instructions for VB.NET and C# are provided below.
VB.NET
1. Add the following lines to the beginning of your .NET code:
Imports APServerNET Imports APDocConvNET
2. Instantiate the DocConverter and Server objects:
activePDF DocConverter v3.8 Page 92 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ 'Instantiate the Server object. Dim SVR As APServerNET.APServer SVR = New APServer 'Instantiate the DocConverter object. Dim DCN As APDocConvNET.APDocConverter DCN = New APDocConverter
C#
1. Add the following lines to the beginning of your .NET code:
Using APServerNET; Using APDocConvNET;
2. Instantiate the DocConverter and Server objects:
//Instantiate the Server object. APServerNET .APServer SVR = new APServer (); //Instantiate the DocConverter object. APDocConvNET .APDocConverter DCN = new APDocConverter ();
activePDF DocConverter v3.8 Page 93 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration
Remote Operation
Submitting a file to DocConverter from a remote location requires that you install the activePDF Server TM and DocConverter software on the server-machine, and the DocConverter OCX and the following DocConverter EXE ( APDocConv.EXE ) on the remote machine.
NOTE: The server-machine where the conversion takes place must be licensed installation. All builds must match exactly. Refer to the activePDF Knowledge Base for a Remote Submission example.
Installing the Remote Components
1. On the server-machine , log on as the Local Administrator or a User account with administrative rights. 2. Download the latest software from http://www.activepdf.com/downloads/serverproducts/index.cfm . 3. Run the installation per the standard instructions. 4. Download the Remote Components from http://www.activepdf.com/altdownloads/Temp/APDOCCNV.zip . 5. Unzip APDOCCNV.zip . The zipped file contains the following files:
APDocConv.OCX
APDocConv.EXE
6. Click Start > Run , type services.msc /s , and then click OK . 7. Right-click the Print Spooler service, and then click Stop .
NOTE: Stopping the Print Spooler service will stop all system printing processes.
8. Move both files to the System32 directory. If necessary, overwrite the existing file on that machine. 9. Click Start > Run , type services.msc /s , and then click OK . 10. Right-click the Print Spooler service, and then click Restart .
NOTE: Restarting the Print Spooler service will restart all system printing processes.
11. Repeat the steps for the remote-machine , but in Step 2 , install the Remote OCX instead of the full software.
Submitting from a Remote Location
The following configuration is necessary for remote submission:
Location Required Installations
Server-Machine activePDF Server and DocConverter.
Remote-Machine DocConverter Remote Components.
The IPAddress must be the address of the Server-Machine when submitting files from the remote location. Refer to the Submit method for additional details.
activePDF DocConverter v3.8 Page 94 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: Virtual IP's are not supported.
activePDF DocConverter v3.8 Page 95 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration
Document Signatures
Signatures allow you to assign file types to be processed by specific Application Processors . DocConverter supports three signature types.
Type Description Process Order
Binary Uses the unique case-sensitive binary identifier from the document type. 1 ( Very Exact )
Text A sequence of text contained in the first two kilobytes of the file data. 2 ( Less Exact )
Extension The document's file type extension. 3 ( Least Exact )
Creating a Signature Signature Examples
activePDF DocConverter v3.8 Page 96 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration -> Document Signatures
Creating a Signature
Before creating a, you will need the Binary , Text , or Extension for the intended file type. Refer to Signature Examples for reference.
NOTE: Always choose the most exact type available when creating a signature for processing or exclusion. Refer to the information provided by the software creator for the most accurate information.
1. On the Document Signatures dialog, click Add Signature .
Figure 6.1: Signature Definition Dialog
2. For Signature ID , type a unique ID.
activePDF DocConverter v3.8 Page 97 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 6.2: Type a unique ID
3. For Signature Name , type a descriptive name.
activePDF DocConverter v3.8 Page 98 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 6.3: Type a signature name
4. For Signature Type , click to select the type of signature want to create. 5. For Signature Data , enter the signature data according to the Signature Type format:
Binary Format:
A unique binary sequence indicating the starting location, the byte range and expected bytes in the range.
Startbyte-numberbytes:bytesinhex
Argument Description
Startbyte The starting byte.
numberbytes The number of bytes after the Startbyte to verify.
bytesinhex The bytes from the Startbyte to numberbytes .
You can enter multiple ranges separated by a pipe (" |") character. For example, the first four bytes of a Microsoft ® Excel document are D0 CF 11 E0 and the four bytes following position 512 are EC A5 C1 00 . The binary signature would be 0-4:D0CF11E0|512-4:ECA5C100 .
Text Format:
activePDF DocConverter v3.8 Page 99 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ The text data contained within the first 2 kilobytes of file information.
TextToFind
Argument Description
TextToFind A string representing the first 2 Kb of text data.
For example, a Postscript ® text signature would be %!PS and an HTML test signature would be
Extension Format:
The file type extension.
.extension;
Argument Description
. Required start character.
extension The file type extension.
; Required end character.
You can specify multiple extensions. For example, a valid extension signature for HTML files would be .HTM;.HTML; . 6. For Application Processor , do one of the following:
To INCLUDE in conversions:
Select one of the Available Processors .
To EXCLUDE from conversions:
Leave the field blank, and then click to select Do not process the signature . Files remain in input location prefixed with $DNP .
activePDF DocConverter v3.8 Page 100 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Figure 6.4: Select a processor
7. Click OK to save the signature.
activePDF DocConverter v3.8 Page 101 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration -> Document Signatures
Signature Examples
You can reference these examples when Creating a Document Signature .
Include Signatures Exclude Signatures
activePDF DocConverter v3.8 Page 102 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration -> Document Signatures -> Signature Examples
Include Signatures
These Document Signatures examples are designed to include the file type in conversions. Refer to Exclude Signature for additional examples or to Creating a Signature for the steps to create a signature. These settings apply to the Signature Definition Dialog .
Figure 6.6: DocConverter Signature Definition Dialog.
Example: Binary
Signature Definition Value or Setting
Signature ID XLS
Signature Name Microsoft Excel 97 Files
Signature Type Binary
Signature Data 0-4:D0CF11E0|512-4:ECA5C100
Assigned Processor Excel 2003 Processor
Do not process this signature Not Selected
activePDF DocConverter v3.8 Page 103 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Example: Text
Signature Definition Value or Setting
Signature ID EPS
Signature Name Encapsulated PostScript Files
Signature Type Text
Signature Data EPSF-1
Assigned Processor PostScript Processor
Do not process this signature Not Selected
Example: Extension
Signature Definition Value or Setting
Signature ID TEXT
Signature Name Text Files
Signature Type Extension
Signature Data .TXT;
Assigned Processor Word 2003 Processor
Do not process this signature Not Selected
activePDF DocConverter v3.8 Page 104 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration -> Document Signatures -> Signature Examples
Exclude Signatures
These Document Signatures examples are designed to exclude the file type from conversions. Refer to Include Signature for additional examples or to Creating a Signature for the steps to create a signature. These settings apply to the Signature Definition Dialog .
Figure 6.7: DocConverter Signature Definition Dialog.
Example: Binary
Signature Definition Value or Setting
Signature ID EXE
Signature Name Executable Files
Signature Type Binary
Signature Data .0-2:4D5A|128-2:5045
Assigned Processor Blank
Do not process this signature Selected
activePDF DocConverter v3.8 Page 105 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Example: Text
Signature Definition Value or Setting
Signature ID EPS
Signature Name Encapsulated PostScript Files
Signature Type Text
Signature Data EPSF-1
Assigned Processor Blank
Do not process this signature Selected
Example: Extension
Signature Definition Value or Setting
Signature ID HTML
Signature Name HTML Files
Signature Type Extension
Signature Data .HTM;.HTML;
Assigned Processor Blank
Do not process this signature Selected
activePDF DocConverter v3.8 Page 106 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration
Scripting
DocConverter supports additional scripting upon document completion or non-completion using the Script to execute upon completion option under Directories or the ScriptName argument for the Submit method. The script can be created in VBScript or JavaScript ®.
NOTE: Scripting only recognizes the compressed documents when processing zipped files.
Intrinsic Variables
Scripting Variable Description
APDCSourceFileName The input filename to convert.
APDCDestFileName The name of the output document placed in the Where to place converted files or Where to place files that cannot be converted location.
APDCProcessorType The Application ID for the Installed Application used during conversion.
APDCStatus A descriptive status for the conversion.
OK = Sucess
ERROR = Failure
Scripting Example Template
If APDCStatus = "OK" then ' send an email with the PDF document contained in APDCDestFileName to whoever Else ' send an email to an Administrator with the document named in APDCDestFileName End If
activePDF DocConverter v3.8 Page 107 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Advanced Configuration
Using the Registry Switches
Registry switches can be used to control the default or enable additional DocConverter functionality. Do not alter or create these values unless instructed by Technical Support . The following categories of switches are available:
Main Switch Control Switches Excel Processor Switches NULL Processor Switches PostScript Processor Switches PowerPoint Processor Switches RTF Only Processor Switches Word Processor Switches
CAUTION: We strongly recommend that you back up the registry before making any changes. Incorrect changes to the registry may result in permanent data loss or damaged files. Make sure that you modify only the keys specified. For additional information on editing the registry, refer to you Microsoft Windows documentation before proceeding.
Main Switch
This switch applies to the HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\APDocConvert key.
String Value Description & Settings
Installed Indicates the product OCX is installed.
Control Switches
These switches apply to the HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert key.
String Value Description & Settings
CheckImagesFirst Controls how the Default Processor checks images.
0 = Uses the default image library. (Default)
1 = Uses the activePDF Toolkit TM image library to check images.
NOTE: The default library is faster but not as robust.
DebugMode Enables the activePDF DocConverter debug mode.
0 = Disabled. (Default)
1 = Enabled.
KeepPortDocument Legacy: Use the Do not delete PostScript file setting for the desired application.
MaxOLEServerTimeout Sets the time in seconds that DocConverter waits before terminating a conversion and placing the input document in the Where to place files that cannot be converted location. Defaults to 180.
activePDF DocConverter v3.8 Page 108 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ NOTE: Must disable any intelligent PDF options.
Excel Processor Switches
These switches apply to the following keys:
HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\EX97 HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\EX2K HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\EX23
String Value Description & Settings
DisplayName The Description for the Application ID .
DoNotSetDefault Use the Do not set default printer setting.
KeepPortDocument Use the Do not delete PostScript file setting.
MaxAppCount Use the # of Conversions between application launches setting.
NoBlankPasswords Use the Reject BLANK password documents setting.
NumThreads Use the Simultaneous Threads setting.
PreCheckDoc Use the Pre-check document existence # seconds setting.
PrintToFile Use the Print to PostScript File setting.
PrintWorksheets Use the Print all worksheets at once setting.
RejectPasswordDocs Uses the Password protect document rejection code setting.
RetryMax Use the Maximum # of conversion retries setting.
RunUnderSystemAccount Use the Run under System account setting.
UseStaticPool Use the Use Static Printer Pool setting.
WaitForQuit Use the Seconds to wait before application quit setting.
WaitForPDFGen Use the Wait for PDF generation setting.
NULL Processor Switches
These switches apply to the HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\NULL key.
String Value Description & Settings
DisplayName The Description for the Application ID .
NumThreads Use the Simultaneous Threads setting.
RunUnderSystemAccount Use the Run under System account setting.
PostScript Processor Switches
activePDF DocConverter v3.8 Page 109 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ These switches apply to the HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\POST key.
String Value Description & Settings
DisplayName The Description for the Application ID .
NumThreads Use the Simultaneous Threads setting.
RunUnderSystemAccount Use the Run under System account setting.
PowerPoint Processor Switches
These switches apply to the following keys:
HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\PP97 HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\PP2K HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\PP23
String Value Description & Settings
DisplayName The Description for the Application ID .
KeepPortDocument Use the Do not delete PostScript file setting.
NumThreads Use the Simultaneous Threads setting.
RunUnderSystemAccount Use the Run under System account setting.
RTF Only Processor Switches
These switches apply to the HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\RTFO key.
String Value Description & Settings
DisplayName The Description for the Application ID .
DoNotSetDefault Use the Do not set default printer setting.
KeepPortDocument Use the Do not delete PostScript file setting.
MaxAppCount Use the # of Conversions between application launches setting.
NumThreads Use the Simultaneous Threads setting.
PreCheckDoc Use the Pre-check document existence # seconds setting.
PrintToFile Use the Print to PostScript File setting.
RejectPasswordDocs Uses the Password protect document rejection code setting.
RejectPreProc Use the Reject if Pre-Processing fails setting.
RetryMax Use the Maximum # of conversion retries setting.
RunUnderSystemAccount Use the Run under System account setting.
UseStaticPool Use the Use Static Printer Pool setting.
WaitForQuit Use the Seconds to wait before application quit setting.
activePDF DocConverter v3.8 Page 110 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ WaitForPDFGen Use the Wait for PDF generation setting.
Word Processor Switches
These switches apply to the following keys:
HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\WD97 HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\WD2K HKEY_LOCAL_MACHINE\SOFTWARE\activePDF\DocConvert\InstalledApps\WD23
String Value Description & Settings
DisplayName The Description for the Application ID .
DoNotSetDefault Use the Do not set default printer setting.
EnableVirusProtection Use the Word Processor Default Application Options .
IntelligentPDF Use the Word Processor Default Application Options .
KeepPortDocument Use the Do not delete PostScript file setting.
MaxAppCount Use the # of Conversions between application launches setting.
NumThreads Use the Simultaneous Threads setting.
PreCheckDoc Use the Pre-check document existence # seconds setting.
PrintToFile Use the Print to PostScript File setting.
RejectPasswordDocs Uses the Password protect document rejection code setting.
RejectPreProc Use the Reject if Pre-Processing fails setting.
RetryMax Use the Maximum # of conversion retries setting.
RunUnderSystemAccount Use the Run under System account setting.
UseStaticPool Use the Use Static Printer Pool setting.
WaitForQuit Use the Seconds to wait before application quit setting.
WaitForPDFGen Use the Wait for PDF generation setting.
activePDF DocConverter v3.8 Page 111 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™
Appendices
Refer to the following appendices for additional data regarding DocConverter:
Supported File Types DocConverter 3.5.2 Updates
activePDF DocConverter v3.8 Page 112 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ Appendices
Supported File Types
DocConverter supports the following file type categories:
Word Processing Formats Spreadsheet Formats Presentation Formats Picture Formats
Word Processing Formats
Extension File Type
TXT ASCII Text
TXT ANSI Text
AW Applix Words v4.2
AW Applix Words v4.3
AW Applix Words v4.4
EXE Executables
HTM, HTML HTML v1.x
HTM, HTML HTML v2.x
HTM, HTML HTML v3.x
HTM, HTML HTML v4
DCA, RTF IBM DCA/RFT vSC23-0758-1
DCA IBM Displaywrite v4
DCA IBM Displaywrite v5
SAM Lotus AMI Pro v2
SAM Lotus AMI Pro v3
SAM Lotus AMI Professional Write Plus
LWP Lotus Word Pro v96
LWP Lotus Word Pro v97
LWP Lotus Word Pro R9
MIF Maker Interchnge Format (MIF)v5.5
RTF Microsoft Rich Text File
DOC Microsoft Word for PC v2
DOC Microsoft Word for PC v3
DOC Microsoft Word for PC v4
DOC Microsoft Word for PC v5.5
DOC Microsoft Word for Macintosh v4
DOC Microsoft Word for Macintosh v5
activePDF DocConverter v3.8 Page 113 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ DOC Microsoft Word for Macintosh v6
DOC Microsoft Word for Macintosh v98
DOC Microsoft Word for Windows v2.x
DOC Microsoft Word for Windows v6.0
DOC Microsoft Word for Windows 95
DOC Microsoft Word for Windows 97
DOC Microsoft Word for Windows 2000
DOC Microsoft Word for Windows 2003
WKS Microsoft Works v1.0
WKS Microsoft Works v2.0
WKS Microsoft Works v3.0
WKS Microsoft Works v4.0
WRI Microsoft Window Write v1.0
WRI Microsoft Windows Write v2.0
WRI Microsoft Windows Write v3.0
TXT Unicode Text
WPD WordPerfect v5.x
WPD WordPerfect v6
WPD WordPerfect v7
WPD WordPerfect v8
WPD WordPerfect v9 (aka 2000)
WPD WordPerfect for Macintosh v2
WPD WordPerfect for Macintosh v3
XY XyWrite v 4.12
Spreadsheet Formats
Extension File Type
AS Applix Spreadsheets v4.3
AS Applix Spreadsheets v4.4
WBI Corel QuattroPro v7
WBI Corel QuattroPro v8
123 Lotus 1-2-3 v2
123 Lotus 1-2-3 v3
123 Lotus 1-2-3 v4
123 Lotus 1-2-3 v5
123 Lotus 1-2-3 96
activePDF DocConverter v3.8 Page 114 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ 123 Lotus 1-2-3 97
123 Lotus 1-2-3 R9
XLS Microsoft Excel v3
XLS Microsoft Excel v4
XLS Microsoft Excel v5
XLS Microsoft Excel v6
XLS Microsoft Excel 97
XLS Microsoft Excel 2000
XLS Microsoft Excel 2003
XLS Microsoft Excel for Mac 98
WKS Microsoft Works Spreadsheet v1.0
WKS Microsoft Works Spreadsheet v2.0
WKS Microsoft Works Spreadsheet v3.0
WKS Microsoft Works Spreadsheet v4.0
Presentation Formats
Extension File Type
AP Applix Presents v4.3
AP Applix Presents v4.4
SHW Corel Presentations v7.0
SHW Corel Presentations v8.0
PRZ Lotus Freelance 96
PRZ Lotus Freelance 97
PRZ Lotus Freelance R9
PPT Microsoft PowerPoint 4.0
PPT Microsoft PowerPoint 95
PPT Microsoft PowerPoint 97
PPT Microsoft PowerPoint 2000
PPT Microsoft PowerPoint 2003
PPT Microsoft PowerPoint for Macintosh 98
Picture Formats
Extension File Type
AWD At Work Document: Microsoft Fax
activePDF DocConverter v3.8 Page 115 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ BMI Zoner Bitmap
BMP MS Windows Bitmap, including compressed and HiColor
BMP OS/2 Bitmap
BW Black-and-White images in SGI Image file format
CAL CALS Raster Type I
CDR CorelDraw! 2.0 - 9.0, preview and imported bitmaps only
CDT CorelDraw! 2.0 - 9.0 Template, preview and imported bitmaps only
CEL Autodesk Animator Pro animation
CEL Autodesk Animator still picture
CLP MS Windows Clipboard file
CMX Corel Metafile Exchange 5.0 - 9.0, preview and imported bitmaps only
CPT Corel PhotoPaint 6.0
CUR MS Windows cursors
CUT Dr. Halo/Dr.Genius Clipboard Format
DCX Intel's multi-page fax-format
DIB MS Windows Device Independent Bitmap, including compressed
FLC Autodesk Animator Pro Animation
FLI Autodesk Animator Animation
HAM Amiga Interchange File Format in hardware modes (HAM)
HMR GeoTIFF, produced by SW by HMR Inc.
HRZ Slow scan television
ICN Images from RIPTerm program
ICO MS Windows Icons, including HiColor and TrueColor
ICO OS/2 Icons
IFF Amiga Interchange File Format
IMG GEM IMG
IMG IMG Software Set
IMG Vivid Raytracer
JFF JPEG File Format, including Progressive Mode
JIF JPEG File Interchange Format, including Progressive Mode
JMX Images from a Tetris game
JPEG JPEG, including Progressive Mode
JPG JPEG, including Progressive Mode
LBM Amiga Interchange File Format, Interleaved Bitmap
MAC MacPaint
MIL CALS Raster Type I
MSP Microsoft Paint
OFX OLIFAX fax package
activePDF DocConverter v3.8 Page 116 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ PAN SmoothMove Pan Viewer, preview only
PAT CorelDraw! 6.0 - 9.0 patterns, preview only
PBM Portable Bitmap
PC2 Degas Elite Medium Resolution
PCD Kodak PhotoCD - Base/16, Base/4 and Base only
PCT MacIntosh PICT
PCX PC PaintBrush
PGM Portable GrayMap
PIC PC Paint/Pictor, including HiColor
PIC Dr. Halo/Dr. Genius
PNG Portable Network Graphics
PNM Portable Any Bitmap
PPM Portable PixelMap
PSD Adobe Photoshop 2,5 - 4.0, including CMYK
PYX Old Epson scanner format
QFX Quick Link II Fax file format
RAS Raster SunMicrosystems
RGB TrueColor (RGB) Images in SGI File Format
RLE Compressed MS Windows BMP
RLE Compressed Images in SGI File Format
RLE Compressed Intergraph Raster images, bi-level only
RLE Utah RunLength Encoded
SAM Images in Text Documents from AmiPro
SCx ColorRIX
SEP CMYK Separated Images in TIFF 6.0 File Format
SGI SGI Image File Format
ST NeoPaint for DOS thumbnails
STW NeoPaint for Windows thumbnails
SUN Raster SunMicrosystems
TGA TrueVision Targa
TIFF Tagged Interchange File Format
UDI Corel Graphics Ver 10 Draw Script Textures Bitmap File
WPG WordPerfect Graphics
ZBR Zoner Zebra for Windows 1.0 - 1.5, preview only
ZMF Zoner Metafile, preview only
NOTE: This is not an exhaustive list. All graphics formats listed are supported by the "generic" processor only. Certain processors may give better fidelity than others when converting the same document. If exact appearance is important to you, we advise that you use the native processor (e.g. Microsoft Word). Certain portions of this software are still
activePDF DocConverter v3.8 Page 117 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™ undergoing beta testing and, as a result, particular formats may not convert as expected. With embedded OLE objects, this list could eventually encompass hundreds of converter types.
activePDF DocConverter v3.8 Page 118 of 118 Documentation Updates Created with activePDF WebGrabber™ and Toolkit™