VirtualViewer® V4.8 VirtualViewer® HTML5 for Java Client Administrator’s Guide An online version of this manual contains information on the latest updates to Vir- tualViewer. To find the most recent version of this manual, please visit the online ver- sion at www.virtualviewer.com or download the most recent version from our website at www.snowbound.com/support/manuals.html. Important Note: Most recent additions to VirtualViewer HTML5 are in the included 4.8 Release Notes. DOC-0168-01 1 Copyright Information While Snowbound® Software believes the information included in this publication is correct as of the publication date, information in this document is subject to change without notice. UNLESS EXPRESSLY SET FORTH IN A WRITTEN AGREEMENT SIGNED BY AN AUTHORIZED REPRESENTATIVE OF SNOWBOUND SOFTWARE CORPORATION MAKES NO WARRANTY OR REPRESENTATION OF ANY KIND WITH RESPECT TO THE INFORMATION CONTAINED HEREIN, INCLUDING WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PURPOSE, NON-INFRINGEMENT, OR THOSE WHICH MAY BE IMPLIED THROUGH COURSE OF DEALING OR CUSTOM OF TRADE. WITHOUT LIMITING THE FOREGOING, CUSTOMER UNDERSTANDS THAT SNOWBOUND DOES NOT WARRANT THAT CUSTOMER’S OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, THAT ALL DEFECTS IN THE SOFTWARE WILL BE CORRECTED, OR THAT THE RESULTS OF THE SOFTWARE WILL BE ERROR-FREE. Snow- bound Software Corporation assumes no responsibility or obligation of any kind for any errors contained herein or in connection with the furnishing, performance, or use of this document. Software described in Snowbound documents (a) is the property of Snowbound Software Corporation or the third party, (b) is furnished only under license, and (c) may be copied or used only as expressly permitted under the terms of the license. All contents of this manual are copyrighted by Snowbound Software Corporation. The information contained herein is the exclusive property of Snowbound Software Corporation and shall not be copied, transferred, photocopied, translated on paper, film, electronic media, or computer-readable form, or otherwise reproduced in any way, without the express written permission of Snowbound Soft- ware Corporation. Microsoft, MS, MS-DOS, Windows, Windows NT, and SQL Server are either trademarks or registered trademarks of Microsoft Cor- poration in the United States and/or other countries. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated. Sun, Sun Microsystems, the Sun Logo, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. iText Copyright (c) 1998-2016 iText Group NV, Authors: Bruno Lowagie, Paulo Soares, et al iText® is a registered trademark of iText Group NV. Kakadu JPEG2000©, is copyrighted by Dr. David Taubman, and is proprietary to NewSouth Innovations, Pty. Ltd, Australia. Aspose™, Aspose.Cells© (copyrighted 2003), Aspose.Words© (copyrighted 2003), and Aspose.Slides© (copyrighted 2004), are all proprietary to Aspose Software, Pty. Ltd, Australia. United States Government Restricted Rights The Software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the United States Government is subject to restrictions as set forth under subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause of DFARS 252.227 –19 or subparagraphs (c)(i) and (2) of the Commercial Computer Software-Restricted Rights at 48 CFR 52.227 – 19 as applic- able. The Manufacturer is Snowbound Software Corporation, 309 Waverley Oaks Rd., Suite 401, Waltham, MA 02452, USA. All other trademarks and registered trademarks are the property of their respective holders. Manual Title: Snowbound Software VirtualViewer® HTML5 for Java Client Administrator’s Guide Part Number: DOC-0168-02 Revision: 01 VirtualViewer® HTML5 for Java Release Number: 4.8 VirtualViewer® Release Number: 4.8 Printing Date: July 2017 Published by Snowbound Software Corporation. 309 Waverley Oaks Road Suite 401 Waltham, MA 02452 USA phone: 617-607-2000 fax: 617-607-2002 ©1996 - 2017 by Snowbound Software Corporation. All rights reserved. 2 Table of Contents Getting Started 19 System Requirements 19 Content Server 19 Servlet Container 19 Server Java Version 19 Client Browser Versions 19 Performance Testing Requirements 20 Validation Minimum Requirements 20 Performance Minimum Requirements 20 Performance Recommended Requirements 20 Determining Memory Requirements 21 Determining Memory Needed for the Number of Users and Pages Viewed in Vir- tualViewer® HTML5 22 Exceptions to Supported File Formats and Platforms 23 Licensing 23 What to Expect in an Evaluation Version of VirtualViewer® HTML5 24 What to Expect in a Production Version of VirtualViewer® HTML5 24 Installing the Production Version of VirtualViewer® HTML5 25 Installing 25 Verifying 27 Running VirtualViewer® HTML5 in a Browser 27 Verifying that the Sample Documents Work in VirtualViewer® HTML5 28 3 Verifying that Your Documents Work in VirtualViewer® HTML5 29 Using VirtualViewer® HTML5 31 The Image Controls Toolbar 31 Load Local Files with Upload Document 31 Exporting a Document 32 Exporting a Document with Annotations 32 Emailing a Document 34 Printing 34 Printing with or without Annotations 35 Zooming 35 Rubber Band Zoom 35 Magnifier 36 Page Controls 36 Fit-to-Page 36 Continuous Scrolling 36 Picture Controls 37 Crop Page Selection 38 User Preference 40 Display Document and Page Properties 43 The Annotation Toolbar 44 Creating Annotations 44 Editing a Filled Annotation 45 Editing a Line Annotation 46 Copying and Pasting an Annotation 47 4 Editing a Sticky Note Annotation 48 Using Text Edit Annotations 49 Search Annotation Text 50 Annotation Commenting 51 Annotation Indicators and Navigation 53 Saving Annotations 55 Deleting Annotations 55 Annotation Information 55 Using Image Rubber Stamp Annotations 56 The Pages and Documents Panels 57 Hiding the Pages and Documents Panel 57 Split Screen View 58 Document Notes 60 Creating Document Notes 61 Editing Document Notes 62 Printing Document Notes 62 Select Pages from the Thumbnails Panel 63 Substitute Image Thumbnails 65 Extract and Append Page Ranges 66 Bookmarks 66 Creating Bookmarks 67 Viewing Bookmarks 68 Text Searching 69 Setting the Default Colors 70 5 Pattern Based Text Searching 71 Additional Notes 73 Working with Redactions 73 Redaction Information Warning Message 73 Redaction Areas 74 Redacting by Selecting Text 75 Search and Redact 76 Save Document As, Export Document, Email Document and Prints 76 Page Manipulations with Redactions 76 Annotation Redaction Tagging 77 Tag Search Results 78 Disabling Redaction Tags for Export, Print, Email, or Saving As 80 Page Manipulations 81 Manipulating Page Order using Thumbnails 82 Page Manipulations 82 Selecting a Page 82 Loading the Page Manipulation Context Menu 82 Cutting, Copying, Deleting and Inserting Pages 83 Dragging and Dropping Pages 83 Additional Notes 84 Saving Page Manipulations 85 Copy to New Document 85 Rotate Specific Pages 87 Page Manipulations Across Multiple Browser Sessions 87 6 Customization 89 System Configuration 89 Configuring web.xml 89 Retrieval Servlet 89 Upload Servlet 90 Defining the Servlet Paths 90 Servlet Tags for web.xml 90 Customizing the User Interface 105 Configuring the Pages and Document Panel Display 106 availableDocuments 107 viewedDocuments 108 specifiedDocuments 108 Config.js Parameters 109 Descriptions of Config.js Parameters 109 Config.js Parameters 109 Hiding the Pages and Documents Panel 125 Disabling Page Manipulations 125 Disabling Copy to New Document 126 Configuring Text Rubber Stamp Annotations 126 Configuring Image Rubber Stamp Annotations 127 Configuring the Magnifier 129 Configuring Default Annotation Values 129 Configuring the Annotations Checkbox 130 Configuring Email Documents 130 7 Localization 131 Localization Files 131 Converting Terms 132 Supporting Accents/Special Characters 132 Force a Specific Language 133 Using Keyboard Shortcuts 134 Customizing VirtualViewer® HTML5 through JavaScript API Methods 136 JavaScript API Descriptions 137 Document Methods for Setting, Printing, Exporting, and Saving 146 getDocumentId() 146 getClientInstanceId() 147 setClientInstanceId(id) 147 setDocumentId(id) 148 setSendDocumentCompletedHandler(fn) 148 setDocumentIdGenerator(fn) 149 setSaveDocumentCompletedHandler(fn) 149 setExportDocumentNameGenerator(fn) 149 setDocumentId(id) 150 getDisplayName() 150 getProperty(key, value) 150 setProperty(key, value) 151 emailDocument() 151 exportDocument() 152 getPageCount() 154 8 printDocument() 154 printDocumentLocal() 155 printDocumentServer() 155 reloadDocumentModel() 156 saveDocument() 156 saveAllDocuments(sync) 158 setImageLoadCompletedHandler(Function) 158 setImageLoadRequestedHandler(Function) 159 sendDocument() 159 removeDocumentFromCache() 159 Interacting with Document Pages within the Viewer 161 splitScreen() 161 undoSplitScreen() 161 addPageToSelection() 161 closeTab(tabNumber) 162 copySelectionToNewDocument(newDocumentId) 162 copySelection() 162 collapseAllStickyNotes() 162 countPagesForDocument() 163 cutSelection(delPages, showAlert, callback) 163 cutSelectionToNewDocument(newId) 164 cropPageClient(top, left, bottom, right, page) 164 removeAllCrop() 164 removeCropOnPage(page) 164 9 despeckleImage() 164 enterGuideMode() 165 enterPanMode() 165 enterSelectTextMode() 165 getActiveTab() 165 getBrightness() 166 getContrast() 166 getGamma() 166 getPageNumber() 166 getPageProperties() 167 getPagePropertyByCaption() 167 getPagePropertyByFieldId() 167 hideImageInfo()