Installing, Configuring, and Using IBM Daeja ViewONE

IBM Daeja ViewONE Version 4.1.3 Installing, Configuring, and Using IBM Daeja ViewONE GC27-8105-01

IBM Daeja ViewONE Version 4.1.3 Installing, Configuring, and Using IBM Daeja ViewONE GC27-8105-01

Note Before using this information and the product it supports, read the information in Notices on page 395. This edition applies to Version 4 Release 1 Modification 3 of IBM Daeja ViewONE Standard, IBM Daeja ViewONE Professional, and IBM Daeja ViewONE Virtual (product numbers 5725-Q02, 5725-Q03, and 5725-Q04) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2014, 2015. US Goernment Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents ibm.com and related resources.... xi Contacting IBM............. xi Installing IBM Daeja ViewONE..... 1 Installing IBM Daeja ViewONE iewers and modules 1 Installing IBM Daeja ViewONE interactiely... 2 Installing IBM Daeja ViewONE silently.... 2 Configuring the serlet........... 4 Deploying the serlet........... 5 Configuring iewers: Applet or irtual..... 6 Deploying and configuring the Jaa iewer applet 6 Configuring the irtual iewer....... 7 Configuring the irtual iewer serlet.... 7 Configuring the irtual iewer by using HTML 8 Configuring the irtual iewer by using JaaScript............. 9 Configuring the annotations module...... 11 Enabling annotations in the iewer..... 12 Configuring the annotations serer object... 12 Configuring the object as a serlet..... 13 Configuring the object by using URL-encoded data............... 13 Configuring annotation security..... 14 Simple annotation security model.... 14 Extended annotation security model... 15 Creating an annotation template...... 17 Annotation definition markers and common properties............. 18 EMPTY marker.......... 18 ANNOTINFO marker........ 18 EDIT property.......... 19 PAGE property.......... 19 BLANKOUTIMAGE property..... 20 COLOR property......... 20 CREATEDATE property....... 21 CREATEDID property........ 21 CUSTOMPROPERTY property..... 22 HYPERLINK property........ 22 HYPERLINKSETTINGS property.... 25 LABEL property.......... 26 LINEWIDTH property........ 26 MODIFIEDDATE property...... 27 MODIFIEDID property....... 27 PAGESIZE property........ 28 PAGEURL property......... 28 VIEW property.......... 28 Annotation types and their properties... 29 ARROW annotation type....... 29 CUSTOM annotation type...... 30 FREEHAND annotation type..... 31 HIGHLIGHT annotation type..... 32 HIGHLIGHTPOLYGON annotation type. 33 NOTE annotation type........ 35 OPENPOLYGON annotation type.... 36 OVAL annotation type........ 37 POLYGON annotation type...... 38 RECTANGLE annotation type..... 40 REDACT annotation type....... 41 REDACTPOLYGON annotation type... 42 STAMP annotation type....... 43 TEXT annotation type........ 45 Annotations and flow layout format documents 47 Configuring the streaming module...... 47 Document streaming and prefetching..... 48 Configuring the serlet for document streaming 49 Configuring the client iewer for document streaming.............. 49 Configuring the redaction module....... 50 Configuring the serlet for redactions.... 50 Configuring the client iewer for redactions.. 51 Upgrading IBM Daeja ViewONE.... 53 Uninstalling IBM Daeja ViewONE... 55 Configuring IBM Daeja ViewONE... 57 Configuring the serer........... 57 Logging.............. 58 logfile parameter.......... 58 logfilesize parameter........ 58 logfilecount parameter........ 59 Cache control............. 59 cacheresources parameter....... 59 cacheresourcesmaxitems parameter.... 60 cacheresourcesmaxsize parameter..... 60 cacheroot parameter......... 60 cacheemptyonrestart parameter..... 61 cachechecktime parameter....... 61 cachesizelimit parameter....... 61 cacheagelimit parameter........ 62 opendocumentwaittime parameter..... 62 correctpagewaittime parameter..... 63 correctdocumentwaittime parameter.... 63 anydocumentwaittime parameter..... 64 Serer sessions............ 64 docurlprototype parameter....... 64 Special tokens.......... 65 docidprototype parameter....... 66 sessionauthenticationtimeout parameter.. 66 sessioncookielist parameter...... 67 signinresource parameter....... 68 serersupportsheadrequestmethod parameter 68 modifieddocumentminimumchecktime parameter 68 modifieddocumentcheckmethod parameter.. 69 documentexpirytime parameter...... 69 poolinitialentrycount parameter..... 70 poolmaxentrycount parameter...... 70 Configuring the iewer by using HTML parameters 70 Checking your parameters........ 71 Adanced Cache Manager parameters.... 72 Copyright IBM Corp. 2014, 2015 iii

ACMDownloadPrompt parameter...... 72 ACMDownloadPromptTrigger parameter.... 72 ACMPreInstall parameter........ 73 ACMRedirect parameter........ 73 ACMRedirectTarget parameter...... 74 ACMReInstall parameter........ 74 ACMRemoe parameter......... 75 ACMUpdate parameter......... 75 cachepath parameter......... 76 usewindowstemppath parameter...... 76 Annotations options.......... 76 Angles and rulers.......... 76 angleunits parameter........ 77 rulerscale parameter........ 77 rulerunits parameter........ 77 unitdecimalplaces parameter..... 78 Aailability............ 78 annotate parameter......... 78 annotateedit parameter....... 78 annotationfile parameter...... 79 Color.............. 79 annotationdefaultfillcolor<n> parameter............ 79 annotationdefaultlinecolor<n> parameter............ 80 annotationhighlightcolor parameter... 81 annotationlimitedcolors parameter... 82 annotationlinecolor parameter.... 82 annotationnotecolor parameter.... 82 annotationredactcolor parameter.... 83 Cursor.............. 83 annotationsstickyacrosspages parameter 83 annotationssticky parameter..... 84 Dates.............. 84 annotationdatestyle parameter.... 84 annotationdatetimeoutputlocale parameter............ 85 Deletion............. 85 anndeletealldocconfirm parameter... 86 anndeleteallpageconfirm parameter... 86 Encoding............. 86 annotationencoding parameter..... 86 htmlencoding parameter....... 87 Error messages........... 87 annotationsuppressemptymessages parameter............ 87 Hyperlinks............ 88 annotationhyperlinkweb parameter... 88 annotationtarget<n> parameter.... 88 Kodak WANG file format........ 89 imagesaepost parameter....... 89 imagesaeserlet parameter...... 90 localannotationreadmode parameter... 91 localannotationwritemode parameter... 91 saebuttontoserer parameter..... 92 unsupportedwangerror parameter.... 92 wangtextborder parameter...... 93 webannotationreadmode parameter.... 93 webannotationwritemode parameter... 94 Module ersion and migration...... 94 disableannotinfo parameter...... 94 enablesaebuttonaftermoduleversionchange parameter............ 95 migrateannotationsnotification parameter............ 95 migrateannotationsonmoduleversionchange parameter............ 95 officeemailinstalled parameter.... 96 useannotationdefinedmodule parameter.. 96 Notes.............. 97 annotationnoterectangular parameter.. 97 annotationnotesize parameter..... 98 annotationnotetextwrapping parameter.. 98 annotationsaenoteid parameter.... 98 shownoteids parameter....... 99 shownotetooltips parameter...... 99 Printing............. 99 annotationtemplate parameter..... 99 Redaction............ 100 redactannotationstamp<n> parameter 100 redactannotationstampproperties<n> parameter........... 101 reenabletextannotclipping parameter 102 transparentredactioncolor parameter 103 Resolution............ 103 tiff1dpiallowed parameter...... 103 Saing.............. 104 annotationautoprompt parameter.... 104 annotationautosae parameter.... 105 annotationgzip parameter...... 105 annotationlocalsae parameter.... 106 annotationpostprefix parameter.... 106 annotationsaepost parameter.... 107 annotationsaepostparamnames parameter 107 annotationsaeserlet parameter... 108 Security............. 108 annotationdefaults parameter.... 109 annotationeditpasswordmodify parameter 110 annotationeditpasswordsecurity parameter........... 110 annotationeditpasswordtext parameter 111 annotationjaascriptextensions parameter........... 111 annotationsecuritymodel parameter... 112 useradmin parameter........ 112 userid parameter......... 112 Selection............. 113 annotationdblclick parameter.... 113 defaultannotationselection parameter 113 Stamps............. 114 annotationstamp<n> parameter.... 114 annotationstampproperties<n> parameter 115 matchstampresolution parameter.... 116 stampannotationkeepaspect parameter.. 117 stampannotationresize parameter... 117 Style.............. 117 annotationfreehandlimit parameter... 117 defaultlinewidth parameter..... 118 Text and rotation.......... 118 allowannotationrotationontags parameter........... 118 i Installing, Configuring, and Using IBM Daeja ViewONE

allowresizeannotationrotateddocument parameter........... 119 allowresizerotatedannotation parameter 119 allowtextrubberband parameter.... 119 annotationallowcontrolcodes parameter 120 annotationautowrap parameter.... 120 annotationcleartextlist<n> parameter 120 annotationcleartextonselection parameter........... 121 annotationdynamictextcreation parameter........... 121 annotationfont parameter...... 122 annotationinputkeymapping<n> parameter........... 122 annotationsubstitution<n> parameter 123 annotationtablength parameter.... 124 annotationtemplatevaluesfile parameter 124 annotationtextalignment parameter... 125 annotationtextlimit parameter.... 125 annotationtextlimitreachedmessage parameter........... 126 defaultfontheight parameter..... 126 Text color............. 126 annotationtextcolor parameter.... 126 annotationtextfillcolor parameter... 127 Toolbars, buttons, and menus...... 127 anndeletetoolbarbutton parameter... 127 annotationallowhideall parameter... 128 annotationeditbutton parameter.... 128 annotationhidebuttons parameter... 129 annotationhidecontextbuttons<n> parameter........... 130 annotationhidecontextbuttonsids<n> parameter........... 132 annotationhidecontextbuttonsids parameter........... 133 annotationhidecontextbuttons parameter 134 annotationtoolbarcollapsed parameter 135 hideannotationtoolbar parameter... 136 prefoerrideannotationtoolbar parameter........... 136 Tooltips............. 136 alwaysshowcustomannotationtooltip parameter........... 136 customannotationtooltip parameter... 137 Document Thumbnails and Index Lists.... 138 defaultthumbsdisplaymode parameter... 138 documentindex<n> parameter...... 138 documentindexlist parameter...... 139 docthumb<n> parameter........ 139 docthumbsenabled parameter...... 140 docthumbsimageenabled parameter.... 140 docthumblabel<n> parameter...... 140 docthumblabelcolor<n> parameter.... 141 docthumbstextenabled parameter..... 141 hidethumbnailcloseicon parameter.... 141 index<n> parameter......... 142 indexlist parameter......... 142 prefoerridethumbsdisplaymode parameter 142 thumbsimageenabled parameter..... 143 thumbstextenabled parameter...... 143 thumbstextmodeallowed parameter.... 143 thumbstext parameter........ 144 Font Substitution options........ 144 allowdocumentfontsubstitutions parameter 144 enablefontsubstitutionwarning parameter 145 Graphics.............. 145 actiebuttons parameter....... 145 actiecolor parameter........ 146 animatetransforms parameter...... 146 backcolor parameter......... 146 bar<n>button<n> parameter...... 147 border parameter.......... 148 customresource<n> parameter..... 149 extraretriealmessages parameter.... 149 highlightcolor parameter....... 149 imagedecodetextdelay parameter..... 150 imagetoolbarcollapsed parameter.... 150 retriealtextdelay parameter..... 150 showhotkeys parameter........ 151 splitbarallowed parameter....... 151 statusbar parameter......... 151 theme parameter.......... 152 toolbarcollapsedelay parameter..... 152 toolbarexpandallowed parameter..... 153 toolbarexpanddelay parameter..... 153 tooltipsbackground parameter..... 153 tooltipsforeground parameter..... 154 tooltipsmaxlength parameter...... 154 tooltips parameter......... 154 iewtoolbarcollapsed parameter..... 155 Hyperlinks............. 155 hyperlink<n> parameter....... 155 hyperlinkdblclick parameter...... 155 hyperlink parameter......... 156 openonclick parameter........ 156 openonclickkey parameter....... 157 openonclicktarget parameter...... 157 Image options............ 157 adjustbars parameter........ 158 adjustcontrols1 parameter....... 158 adjustcontrols4 parameter....... 158 adjustcontrols8 parameter....... 159 adjustcontrols24 parameter...... 159 adjustoptions parameter....... 159 allowheadertags parameter....... 160 allowheadertagsonprint (rotation) parameter 160 allowresolutiontags parameter..... 160 areazoom parameter......... 161 areazoomsticky parameter....... 161 autoenhanceblack parameter...... 162 brightness parameter........ 162 contrast parameter......... 162 defaulttransformdoc (preiously defaultrotatedoc) parameter...... 163 enablesharpenhancemodes parameter.... 163 enhancebutton parameter....... 163 enhancecolor parameter........ 164 enhancemenu parameter........ 164 enhancemode parameter........ 164 enhance parameter.......... 165 flipoptions parameter........ 165 Contents

flip parameter........... 165 imagebackcolor parameter....... 166 imagebuttons parameter........ 166 imageforecolor parameter....... 167 imagekeys parameter......... 167 imagemenus parameter........ 167 infooptions parameter........ 168 infooptionsshowsizecm parameter.... 168 infooptionsshowsize parameter..... 168 inertbuttons parameter....... 169 inertkeys parameter........ 169 inertmenus parameter........ 169 inert parameter.......... 170 luminance parameter......... 170 magoptions parameter........ 170 pagerotationn parameter....... 170 persistviewprocessingproperties parameter 171 photometric parameter........ 171 rotation parameter......... 172 scale parameter.......... 172 thirdpartyfilecache parameter..... 173 isibleimagebuttons parameter..... 173 isibleimagekeys parameter...... 173 isibleimagemenus parameter...... 174 zoom100options parameter....... 174 zoom100 parameter.......... 174 JaaScript options........... 175 annotationjaascriptextensions parameter 175 jaascriptextensions parameter..... 175 eenthandler parameter........ 176 eenthandlerjson parameter...... 176 eentinterest parameter....... 176 serereenthandler parameter..... 177 Labels............... 178 displaypagelabels parameter...... 178 docref<n> parameter........ 178 pagelabel<n> parameter....... 178 pagelabelcolor<n> parameter..... 179 pagelabelnullifier parameter..... 179 printlabelborder parameter...... 179 printlabels parameter........ 180 thumblabel<n> parameter....... 180 thumblabelcolor<n> parameter..... 180 Local file options........... 181 defaultsaefilename parameter..... 181 filebuttonclose parameter....... 181 filebuttonopen parameter....... 181 filebuttonsae parameter....... 182 filebuttons parameter........ 182 filekeyclose parameter........ 182 filekeyopen parameter........ 183 filekeysae parameter........ 183 filekeys parameter......... 183 filemenuclose parameter....... 183 filemenuopen parameter........ 184 filemenusae parameter........ 184 filemenus parameter......... 184 fixedsaepath parameter....... 184 jaa2filedialogs parameter...... 185 makesaenamesafe parameter...... 185 newwindowbuttons parameter...... 186 newwindowkey parameter........ 186 saedocumentwithoutannotations parameter 186 tiffsaecolor parameter....... 186 tiffsaeversion6jpeg parameter..... 187 Microsoft Office module options...... 187 allowexternalemailimages parameter... 187 allowsaeemailattachments parameter... 188 blockemailmodule parameter...... 188 emailheaderinfo parameter....... 188 excelgridlines parameter....... 189 excelviewmode parameter....... 189 listemailattachmentsinheader parameter 189 showexternalemailimages parameter.... 190 showplaintextforrtfemail parameter... 190 Documents and images......... 190 basefilename parameter........ 191 description parameter........ 191 doc<n> parameter.......... 191 filebase parameter......... 193 filelist parameter......... 193 filedir parameter.......... 194 filename parameter......... 194 httpredirectallowssl parameter..... 195 httpredirectcountlimit parameter.... 195 page<n> parameter......... 196 pagecount parameter......... 197 pagenumber parameter........ 197 prefetchpages parameter....... 197 prefetchthumbs parameter....... 198 processhttpredirects parameter..... 199 redirectnotfound parameter...... 199 redirecttarget parameter....... 199 resourcetourlencoding parameter.... 200 routedocs parameter......... 200 routehtml parameter......... 201 routehtmltarget parameter....... 201 routexml parameter......... 202 routexmltarget parameter....... 202 routetarget parameter........ 203 suppressmenusduringopen parameter.... 204 thumb<n> parameter......... 204 timeout parameter.......... 205 PDF options............. 205 alwaysshowpdfannotations parameter... 205 autolimitpdfresolutionvalue parameter.. 205 defaultautolimitpdfresolution parameter 206 defaultpdfpixeldepth parameter..... 206 defaultpdfresolution parameter..... 207 findresultcolor parameter....... 207 findresulthighlightcolor parameter... 207 findresulthistorylistsize parameter... 207 forcejaapdf parameter........ 208 Print options............ 208 allowprintheader parameter...... 208 defaultprintdoc parameter....... 208 defaultprintingnotestext parameter... 209 defaultprintnoteannotation parameter.. 209 disableprintcopies parameter..... 210 forceprintsperpage parameter..... 210 imagetoolargeprintheader parameter... 210 jaa2printsetupdialog parameter.... 211 i Installing, Configuring, and Using IBM Daeja ViewONE

multiprintnum parameter....... 211 multiprintgap parameter....... 212 multiprintsingleheader parameter.... 212 printacceleratorforgetsettings parameter 213 printaccelerator parameter...... 213 printacceleratorreersemono parameter.. 213 printannotations parameter...... 214 printautorotate parameter....... 214 printbuttons parameter........ 215 printcomplete parameter....... 215 printdialog parameter........ 215 printdocumentallowed parameter..... 216 printer parameter.......... 216 printheader parameter........ 217 printingcolorheader parameter..... 217 printingfontbold parameter...... 218 printingfontname parameter...... 218 printingfontselectionenabled parameter 219 printingfontsize parameter...... 219 printingnotesfontname parameter.... 220 printingnotesfontsize parameter.... 220 printingnotesstandardfont parameter... 220 printingnotestextpagetitle parameter.. 221 printingnotestexttitle parameter.... 221 printingnotestitlefontsize parameter.. 222 printjobname parameter........ 222 printkeys parameter......... 222 printmenus parameter........ 223 printmonoallowed parameter...... 223 printmono parameter......... 223 printoriginalsizeallowed parameter... 224 printoriginalsizeoerride parameter... 224 printrangeallowed parameter...... 224 printselectedallowed parameter..... 225 printstickymenus parameter...... 225 printvisibleallowed parameter..... 225 printwithusersettings parameter.... 226 reuseprinter parameter........ 226 separator<n> parameter....... 227 separatorlist parameter....... 229 Text file options........... 230 allowtextfilterdisplayanyfile parameter 230 ignoretextfiltermimetypes parameter... 231 textencoding parameter........ 231 textfilterlocalfileextensions parameter 231 textfiltermimetypes parameter..... 232 textfilterpagebreaks parameter..... 232 textfilterpageheight parameter..... 233 textfilterpagewidth parameter..... 233 textfilterwrapping parameter..... 234 Viewing options........... 234 abortsaeonshutdown parameter..... 234 allbuttons parameter........ 234 allkeys parameter.......... 235 allmenus parameter......... 235 autoscroll parameter........ 235 cachemenus parameter........ 236 clipoptions parameter........ 236 defaultlinkviewer parameter...... 236 defaultzoomdoc parameter....... 237 disableshutdowndialogs parameter.... 237 displaycolorprogressiely parameter... 238 doccompare parameter........ 238 displaydocbuttons parameter...... 238 displaymonoprogressiely parameter... 239 draggingenabled parameter....... 239 emptyclipboardonclose parameter.... 239 emptyonclose parameter........ 240 enabledocbuttons parameter...... 240 externalmagnifier parameter...... 241 flickscrollenabled parameter..... 241 focusborder parameter........ 241 helptarget parameter........ 241 helpurl parameter.......... 242 htmllistshortcutenabled parameter.... 242 httpreadtimeout parameter....... 243 initialfocus parameter........ 243 keepalie parameter......... 243 keepalietime parameter....... 244 keepscroll parameter........ 244 magnifierfollowmouse parameter..... 245 magnifierpersistent parameter..... 245 menunewwindow parameter....... 246 mouserightbuttonenabled parameter.... 246 newwindow parameter......... 246 nwviewmode parameter........ 246 obfuscate parameter......... 247 pagebuttons parameter........ 248 pagekeys parameter......... 248 pagemenus parameter......... 248 preferencemenus parameter....... 249 saeextension parameter....... 249 scrollbars parameter........ 249 selectkeys parameter........ 250 selectmenus parameter........ 250 serereentinterest parameter..... 250 sererfilemonitor parameter...... 251 synchronizethumbs parameter...... 251 systeminfoshortcutenabled parameter... 251 thumbdblclick parameter....... 252 thumbdblclickselect parameter (Deprecated) 252 thumbsheight parameter........ 253 thumbswidth parameter........ 253 usebrowseralertonshutdown parameter... 253 useerrorfiles parameter....... 254 iewbuttonsdetail parameter...... 254 iewbuttons parameter........ 254 iewkeys parameter......... 254 iewmenus parameter......... 255 iewmode parameter......... 255 zoom, xscroll, and yscroll parameters... 256 ViewONE Document Streaming Serer Module options.............. 257 cookiealloweddomainlist parameter.... 257 documentcookies parameter....... 257 streamerenabled parameter....... 257 streamerurl parameter........ 258 ViewONE Permanent Redaction Serer Module options.............. 258 annotationburnurl parameter...... 258 annotationdefaults parameter..... 259 burnincrementalannotations parameter.. 260 Contents ii

burnusegzip parameter........ 260 redactionhttpreadtimeout parameter... 260 redactionhttpreadtimeout parameter... 260 showannotationburnprompt parameter... 261 ViewONE Uniersal Viewing Module options 261 obfuscateuv parameter........ 261 utextdirectionmethod parameter.... 262 IBM Daeja ViewONE color scheme text.... 262 IBM Daeja ViewONE Default Stamps.... 263 Supported fonts........... 263 WANG Compliant Annotation Types.... 263 Configuring the iewer by using JaaScript API methods............... 264 Adding selected items to the clipboard.... 265 clearselections method....... 265 copypagetoclipboard method...... 265 getselection method........ 266 selectpage method......... 266 startcopyareatoclipboard method.... 266 Annotations............. 267 Specify an Annotations File....... 267 isshowannotations method...... 267 setannotationfile method...... 267 setshowannotations method..... 268 Open and sae annotations....... 268 reloadannotations method...... 268 saeannotations method...... 269 setannotationfile method...... 269 setannotationpostprefix method... 270 setannotationsae method...... 271 setannotationsaepost method.... 271 setannotationsaeserlet method... 272 Edit and find annotations....... 273 addannotation method....... 273 addannotationstamp method..... 274 addannotationstampwithproperties method............ 274 burnannotations method...... 276 clearannotationstamps method.... 276 deleteallannotations method.... 276 deleteannotation method...... 277 endannotation method....... 278 endmodifyannotations method.... 278 getactieannotation method..... 278 getannotation method....... 279 getannotationlabels method..... 279 getannotationonpage method..... 280 getdelimiter method....... 281 getnumannotations method...... 281 insertannotationstamp method.... 282 isannotationssemitransparent method 283 isannotationtoolbar method..... 284 isannotationsupdated method.... 284 modifyannotation method...... 284 parseproperty method....... 285 remoeannotationstamp method.... 285 setannotateedit method...... 286 setannotationhidebuttons method... 286 setannotationhidecontextbuttons method 287 setannotationhidecontextbuttonsids method............ 289 setannotationssemitransparent method 290 setannotationstamptext method.... 291 setdefaultselectannotation method.. 291 setdelimiter method....... 292 setredactionissemitransparent method 292 setrulerscale method....... 293 setrulerunits method....... 293 setstickyannotations method.... 293 showannotationtoolbar method.... 294 startannotation method...... 294 startannotationwithproperties method 295 startmodifyannotations method.... 297 Document hyperlinks.......... 298 clearhyperlink method........ 298 sethyperlink method........ 298 Documents and images......... 298 closedocument method........ 299 firstdoc method.......... 299 getdocindex method......... 299 getdocreference method....... 300 getnumdocs method......... 301 getnumpages method......... 301 getpage method.......... 301 initializedocumentarray, opendocumentarray, and setdocumentarray method group........... 302 initializepageandthumbsarray, openpagearray, setpagearray, and setthumbsarray method group..... 302 initializepagearray, openpagearray, and setpagearray method group...... 303 lastdoc method.......... 304 nextdoc method.......... 304 nextpage method.......... 305 opendirectory method........ 305 opendoc method.......... 306 openfile method.......... 306 openlist(listfile, page) method.... 307 predoc method.......... 307 preiouspage method........ 308 reloadlist method......... 308 setbackgroundimageenabled method.... 308 setdocumentcookies method...... 309 setdocumentindexlistfile method.... 309 getdescription and setdescription method group.............. 310 setpage method.......... 310 showexternalemailimages method.... 310 ismultipagetif method........ 311 saeasformat method......... 311 sae method............ 311 saepage method.......... 312 saeselected method........ 312 setdefaultsaefilename(filename) method 313 setimagesaeurl method....... 313 Document text search......... 314 cancelfind method......... 314 clearfindresults method....... 314 find method........... 314 nextfindresult method........ 315 prefindresult method........ 315 iii Installing, Configuring, and Using IBM Daeja ViewONE

Eent handlers and eent handling..... 315 Eents IDs and descriptions...... 316 Obtain additional information from an eent 323 Image options............ 323 applyrotationarray, initializerotationarray, and setrotationarray method group..... 323 enduserdragmode method....... 324 getbrightness method........ 324 getcontrast method......... 325 getenhancemode method........ 325 getflip method.......... 325 getimageheight method........ 326 getimagewidth method........ 326 getluminance method........ 326 getrotation method......... 326 getscale method.......... 327 getstates and setstates method group.. 327 getxresolution method........ 328 getyresolution method........ 328 getxscroll method......... 328 getyscroll method......... 328 getzoom method.......... 329 grabimage method.......... 329 inert method........... 332 isdraggingenabled method....... 332 isenhance method.......... 332 isinerted method......... 333 isuserdragmode method........ 333 resetbrightness method....... 333 resetcontrast method........ 334 resetluminance method........ 334 rotateclockwise method....... 334 rotatecounterclockwise method..... 335 rotate180 method.......... 335 setbrightness method........ 335 setcontrast method......... 336 setdraggingenabled method...... 336 setenhancemode method........ 336 setenhance method......... 337 setflip method.......... 337 setinerted method......... 338 setluminance method........ 338 setrotation method......... 339 setscale method.......... 339 setxyscroll method......... 340 setzoomandxyscroll method...... 340 setzoom method.......... 341 startuserdragmode method....... 341 zoomarea method.......... 342 zoomin method........... 343 zoomout method.......... 343 zoom100 method.......... 343 Menus and keyboard shortcuts...... 343 isallkeys method.......... 343 isallmenus() method........ 344 iscachemenus method........ 344 isfilekeys method......... 344 isfilemenus method......... 344 isimagekeys method......... 345 isimagemenus method........ 345 ispagekeys method......... 345 ispagemenus method......... 345 ispreferencemenus method....... 346 isprintkeys method......... 346 isprintmenus method........ 346 isselectkeys method........ 346 isselectmenus method........ 347 isviewkeys method......... 347 isviewmenus method......... 347 setallkeys method......... 347 setallmenus method......... 348 setcachemenus(true/false) method.... 348 setfilekeys method......... 349 setfilemenus method........ 349 setimagekeys method........ 350 setimagemenus method........ 350 setpagekeys method......... 351 setpagemenus method........ 351 setpreferencemenus method...... 351 setprintkeys method........ 352 setprintmenus method........ 352 setselectkeys method........ 353 setselectmenus method........ 353 setviewkeys method......... 354 setviewmenus method........ 354 Print options............ 354 isprintdialog method........ 354 printdocument method........ 355 printpage method.......... 355 printrange method......... 355 printselected method........ 356 printtransformed method....... 356 printvisible method........ 357 setprintautorotate method...... 357 setprintcopies method........ 358 setprintdialog method........ 358 setprinter method......... 359 setprintheader method........ 359 setprintjobname method....... 360 Streamer methods........... 361 setstreamerenabled method...... 361 setstreamerurl method........ 361 Timeout and the user idle control..... 361 istimedout method......... 361 gettimeleft method......... 362 gettimeout method......... 362 setserereenthandler method..... 363 seteenthandlerresponse method.... 363 settimeout method......... 363 stoptimeout method......... 364 wakeup() method.......... 364 Toolbars and buttons.......... 365 isadjusttoolvisible method...... 365 isallbuttons method........ 365 isdocbuttons method........ 366 isfilebuttons method........ 366 isimagebuttons method........ 366 isinertbuttons method....... 366 isnewwindowbuttons method...... 367 ispagebuttons method........ 367 isprintbuttons method........ 367 Contents ix

isscrollbars method........ 367 isstatusbar method......... 368 isviewbuttons method........ 368 iszoom100button method....... 368 setadjusttoolvisible method..... 368 setallbuttons method........ 369 setappletenabled method....... 369 setdocbuttons method........ 370 setfilebuttons method........ 370 setimagebuttons method....... 370 setimagetoolbarcollapsed method.... 371 setinertbuttons method....... 371 setnewwindowbuttons method...... 372 setpagebuttons method........ 372 setprintbuttons method....... 372 setscrollbars method........ 373 setstatusbar method........ 373 setviewbuttons method........ 374 setviewtoolbarcollapsed method.... 374 setzoom100button method....... 374 toggleadjusttool method....... 375 Viewing options........... 375 getmagfactor method........ 375 getview method.......... 375 getviewerwindow method....... 376 getviewerwindowinstanceid method.... 376 initializelabels, setlabel, uselabels, and clearlabels method group....... 377 isareazoom method......... 378 ismagnifier method......... 378 isnewwindowvisible method...... 378 setareazoom method......... 378 setimagebackcolor method....... 379 setimageforecolor method....... 379 setmagbounds method........ 380 setmagfactor method........ 380 setmagnifierinternal method..... 380 setmagnifier method........ 381 setnewwindowvisible method...... 381 setview method.......... 381 showimagebackcolordialog method.... 382 showimageforecolordialog method.... 382 toggleareazoom method........ 382 togglemagnifier method....... 383 Annotating and redacting documents 385 Editing annotations........... 385 Tips for using the iewer......... 386 Troubleshooting and support.... 389 Getting fixes from Fix Central........ 391 Contacting IBM Software Support...... 391 Notices.............. 395 Glossary............. 399 A................. 399 D................. 399 E................. 399 F................. 399 I.................. 399 K................. 400 L................. 400 M................. 400 N................. 400 P................. 400 R................. 400 S................. 400 T................. 400 V................. 400 W................. 400 Z................. 401 x Installing, Configuring, and Using IBM Daeja ViewONE

ibm.com and related resources Contacting IBM Product support and documentation are aailable from ibm.com. Support and assistance From ibm.com, click Support & downloads and select the type of support that you need. From the Support Portal, you can search for product information, download fixes, open serice requests, and access other tools and resources. IBM Knowledge Center See your online product information in IBM Knowledge Center at http://www.ibm.com/support/knowledgecenter/sstphr/welcome. PDF publications See the following PDF publications for your product at https://www.ibm.com/ support/entry/portal/documentation_expanded_list/ enterprise_content_management/case_manager?productcontext=-1017567207. For general inquiries, call 800-IBM-4YOU (800-426-4968). To contact IBM customer serice in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378). For more information about how to contact IBM, including TTY serice, see the Contact IBM website at http://www.ibm.com/contact/us/. Copyright IBM Corp. 2014, 2015 xi

xii Installing, Configuring, and Using IBM Daeja ViewONE

Installing IBM Daeja ViewONE Before you install IBM Daeja ViewONE, you must install all of the prerequisite software. Before you begin IBM Daeja ViewONE requires a web application serer. Ensure that you are using a supported ersion of a web application serer, such as WebSphere Application Serer. Related information: System requirements Installing IBM Daeja ViewONE iewers and modules The installation program automatically installs the built-in modules for your edition. In addition, you use the installation program to install add-on modules for which you hae entitlements.you can install the IBM Daeja ViewONE software on the serer by running the installation program interactiely or by running a silent installation. About this task The IBM Daeja ViewONE installation program is a multiple-product installation program that you use for any product edition: IBM Daeja ViewONE Professional IBM Daeja ViewONE Virtual IBM Daeja ViewONE Standard Procedure To install IBM Daeja ViewONE: 1. Log in to Fix Central. 2. From the Product Group list, select Enterprise Content Manager. 3. From the Select from Enterprise Content Manager list, select the IBM Daeja ViewONE edition that you want to install. You must hae a license for this edition. 4. From the Installed Version list, select the ersion that is installed on your system. Select All if your ersion is not listed. 5. From the Platform list, select the operating system on which you are installing the software and then click Continue. 6. Select Browse for fixes and click Continue. 7. On the Select fixes page, select Version 4.1.3 and click Continue to download the software. 8. Extract the downloaded file into a temporary directory on your system. 9. Run the installation program either interactiely or silently. Copyright IBM Corp. 2014, 2015 1

Installing IBM Daeja ViewONE interactiely You can install IBM Daeja ViewONE on the serer by running the installation program. During installation, you are prompted to select the editions and modules for which you are entitled. About this task The interactie installation program uses a graphical user interface (GUI). If your operating system does not support GUIs, you must install IBM Daeja ViewONE silently. Procedure To install IBM Daeja ViewONE interactiely: 1. Naigate to temporary directory in which you extracted the IBM Daeja ViewONE software package. 2. Run the installation program: Operating system AIX Linux Solaris Windows Command./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin DAEJA_VIEWONE_4.1.3_WIN_ML.exe 3. Complete the IBM Daeja ViewONE installation program. 4. When the installation completes, check for errors in the IBM Daeja ViewONE installation log. The installation log file, DaejaViewONE_install_4.1.3.0.txt, is in the root installation directory. For example, the default location for the log file on a Windows serer is C:\Program Files\IBM\Daeja ViewONE. Installing IBM Daeja ViewONE silently You can install IBM Daeja ViewONE on the serer by running a silent installation. When you run a silent installation, the installation program does not display any installation windows or messages. Instead, any messages and errors are written to the installation log file. About this task A silent installation uses a response file that contains the installation parameters that you specify. The software package includes two sample response files. You must modify one of these files to specify your entitlements. The files contain comments that describe the modifications that you can make. The file that you modify depends on your contract type and operating system: If IBM Daeja ViewONE was purchased from IBM or your company already migrated to an IBM license, then your contract type is Passport Adantage.If you are installing on a Microsoft Windows system, use the win_ibmdaejaviewone_pa.properties file. If you are installing on an AIX, Linux, or Solaris system, use the unix_ibmdaejaviewone_pa.properties file. If you hae a legacy ersion of IBM Daeja ViewONE that was purchased directly from Daeja Systems Ltd., then your contract type is Flexible Contract Type. Ifyou 2 Installing, Configuring, and Using IBM Daeja ViewONE

are installing on a Microsoft Windows system, use the win_ibmdaejaviewone_fct.properties file. If you are installing on an AIX, Linux, or Solaris system, use the unix_ibmdaejaviewone_fct.properties file. Procedure To install IBM Daeja ViewONE silently: 1. Naigate to temporary directory in which you extracted the IBM Daeja ViewONE software package. 2. If your contract type is Passport Adantage, edit the win_ibmdaejaviewone_pa.properties response file or unix_ibmdaejaviewone_pa.properties response file: a. Under Accept the License Agreement, set the alue to TRUE: LICENSE_ACCEPTED=TRUE b. Under Select Edition, set the alue to 1 for the edition that you want to install: Value PRO VIR PRO-VIR STD Edition IBM Daeja ViewONE Professional IBM Daeja ViewONE Virtual IBM Daeja ViewONE Professional and IBM Daeja ViewONE Virtual IBM Daeja ViewONE Standard For example, to install IBM Daeja ViewONE Professional, set the alues as follows: PRO=1 VIR=0 PRO-VIR=0 STD=0 c. If you are installing to a deelopment or test enironment, set PRODUCTION to 0 under Select the Installation enironment: PRODUCTION=0 d. If you purchased ViewONE Office Module that is bundled for IBM Daeja ViewONE Professional and IBM Daeja ViewONE Virtual, set MS_OFFICE_BUNDLE to 1 under Select Bundles: MS_OFFICE_BUNDLE=1 e. Under Select Entitlements, specify the modules that you want to install. For example, to install IBM Daeja ViewONE Virtual with the ViewONE Office Module, set the alue as follows: CHOSEN_INSTALL_FEATURE_LIST=VirtualModuleForMicrosoftOffice 3. If your contract type is Flexible Contract Type, edit the DAEJA_VIEWONE_FCT_silent_install.txt response file: a. Under Accept the License Agreement, set the alue to TRUE: LICENSE_ACCEPTED=TRUE b. Under Select Edition, set the alue to 1 for the edition that you want to install: Value PRO STD Edition IBM Daeja ViewONE Professional IBM Daeja ViewONE Standard Installing IBM Daeja ViewONE 3

For example, to install IBM Daeja ViewONE Professional, set the alues as follows: PRO=1 STD=0 c. Under Select Entitlements, specify the modules that you want to install. You must always include the base product in this alue. For example, to install IBM Daeja ViewONE Professional with the ViewONE Permanent Redaction Serer Module, set the alue as follows: CHOSEN_INSTALL_FEATURE_LIST=ProfessionalPermanentRedactionSererModule 4. Sae your changes to the response file. 5. At a command line, change to the directory that contains the installation program and run the following command: Operating system Command AIX./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin -f response_file Linux./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin -f response_file Solaris./DAEJA_VIEWONE_4.1.3_UNIX_ML.bin -f response_file Windows DAEJA_VIEWONE_4.1.3_WIN_ML.exe -f response_file response_file is the fully qualified path of the edited response file. 6. When the installation completes, check for errors in the IBM Daeja ViewONE installation log. The installation log file, DaejaViewONE_install_4.1.3.0.txt, is in the root installation directory. For example, the default location for the log file on a Windows serer is C:\Program Files\IBM\Daeja ViewONE. Configuring the serlet You must edit the web.xml file and the serlet-name.properties files to configure the iewer serlet. About this task The iewer serlet makes up the core serer component for the IBM Daeja ViewONE software suite. For IBM Daeja ViewONE Professional, the serlet is used for the serer-side ViewONE Document Streaming Serer Module and ViewONE Permanent Redaction Serer Module. For IBM Daeja ViewONE Virtual, the serlet proides the entry point that is required for the iewer to work. To configure the serlet, you need the following files: web.xml This XML file defines the location of the core serlet class files (com.ibm.d.serer.platform). If you are adding IBM Daeja ViewONE to an existing web application, you might already hae a web.xml file. If you are creating a new web application, you might need to create the web.xml file. serlet_name.properties This properties file has the same name as the serlet that you are using, such as iewone.properties. You use this file to configure extended debugging output to a log file. 4 Installing, Configuring, and Using IBM Daeja ViewONE

Procedure To edit the configuration files: 1. Copy all the files and directories from the daeja_install_dir/serer/web-inf directory into the /WEB-INF directory of your web application. These files include the JAR files in the /lib directory and the lic-serer.1 or lic-serer-irtual.1 configuration file. 2. Open the WEB-INF/web.xml file in a text editor and make sure that it contains the following lines. <web-app>... <serlet> <serlet-name>iewone</serlet-name> <serlet-class>com.ibm.d.serer.platform</serlet-class> </serlet> Deploying the serlet <serlet-mapping> <serlet-name>iewone</serlet-name> <url-pattern>/1files/*</url-pattern> </serlet-mapping>... </web-app> You can replace iewone with the name of your serlet. This serlet is called when a request is made to /1files/*. Important: You must include the /* component in the URL-pattern mapping to enable the serlet to load the iewer files and resources that are required for the serlet to function correctly. 3. Open the WEB-INF/serlet_name.properties file in a text editor and make sure that it contains the following lines to configure logging. logfile=web-inf/iewone.log The properties file name must match the serlet name that you defined in WEB-INF/web.xml. For example, name the file iewone.properties. If you do not already hae a WEB-INF/serlet_name.properties file, you must create the file. You can replace iewone with the name of your serlet. To send log information to the standard web application serer log file, use the following line to configure logging: logfile=<stdout> What to do next You can edit these files later to customize the iewer to meet your requirements. Related information: Configuring the serer You can set optional properties to configure and customize the serer elements of IBM Daeja ViewONE. To deploy the core serlet, you must use a Jaa web application serer of your choosing. The procedure for setting up the serlet depends on the web application serer that you are deploying to. Installing IBM Daeja ViewONE 5

Procedure To deploy the application: 1. Follow the directions from your web application serer documentation to deploy the web application to the web application serer. 2. Verify that you can access the application by entering the URL to the serer into the browser. For example, enter the following URL: http:myserer:8080/ iewone_applet.html Related information: WebSphere Application Serer Network Deployment, Version 7.0 documentation See this document for information about deploying the serlet to WebSphere Application Serer Network Deployment, Version 7.0 WebSphere Application Serer Network Deployment, Version 8.0 documentation See this document for information about deploying the serlet to WebSphere Application Serer Network Deployment, Version 8.0 WebSphere Application Serer Network Deployment, Version 8.5.5 documentation See this document for information about deploying the serlet to WebSphere Application Serer Network Deployment, Version 8.5.5 Configuring iewers: Applet or irtual IBM Daeja ViewONE proides a Jaa applet iewer and a irtual iewer. About this task The Jaa applet iewer is deployed for IBM Daeja ViewONE Professional and IBM Daeja ViewONE Standard. This applet renders the images on the client instead of on the serer. Users must be able to download and run the applet to iew files. The IBM Daeja ViewONE Virtual iewer is designed for systems that do not support the Jaa plug-in. All the work is carried out on the serer so that the iewer, associated images, and other releant data are streamed to the client deice. The IBM Daeja ViewONE Virtual iewer is compatible with most mobile deices, such as tablets and phones. Deploying and configuring the Jaa iewer applet The applet iewer is deployed as a Jaa applet. This applet iewer requires the use of a web serer of your choosing to delier the iewer files to the client system by using a standard HTTP request. Procedure 1. Copy all the /client files, including the lic.1 license file, into a directory on your web application serer. For example, copy the files to the /1files directory. 6 Installing, Configuring, and Using IBM Daeja ViewONE

2. If your web serer requires you to register MIME types, add the.1 and.ant MIME types in order for the browser to download files to the client. For details about how to configure the MIME types, refer to your web serer documentation. 3. If you use authentication credentials that are passed as cookies to the serer repository, set the HttpOnly parameter to false. 4. Edit the HTML page that loads the iewer applet to add the <APPLET> section as follows. <APPLET CODEBASE = "." ARCHIVE = "iewone.jar" CODE = "com.ibm.d.client.viewer.class" NAME = "ViewONE" WIDTH = "100%" HEIGHT = "97%" HSPACE = "0" VSPACE = "0" ALIGN = "middle"> </APPLET> The codebase alue must point to the location of the /1files directory relatie to the location of the HTML page. In this example, a dot (.) indicates the current folder. If the iewer fails to run and you see messages that refer to jaa.lang.classnotfoundexception, use the full URL for the location of the codebase files instead of a relatie path. Refer to your web serer logs to determine the issue with deliering the iewer files to the client system. What to do next After you deploy the iewer, you can use the HTML parameters and JaaScript methods to customize the iewer. Related information: Configuring the iewer You can configure the iewer by using HTML parameters and JaaScript API methods. Configuring the irtual iewer IBM Daeja ViewONE Virtual iewer is deployed as a Jaa serlet. About this task When you configure and deploy the serlet, the core of IBM Daeja ViewONE Virtual is also included. Howeer, you must modify the web page that loads the iewer. You can use HTML5 or later or JaaScript to configure the iewer. Important: Ensure that your code that runs the iewer is running from the same location where the serer is installed or else the iewer does not run. Because of the restrictions of cross domain origin policies, it is not possible to run the HTML code from one host while also accessing the JaaScript files from another host. Configuring the irtual iewer serlet You can edit the serlet-name.properties file to configure the irtual iewer serlet. This file is shared with the core IBM Daeja ViewONE serlet. Installing IBM Daeja ViewONE 7

About this task For example, you can add parameters to enable debug output to a specified log file, to control the serlet caching area, or to determine how documents are retrieed. Important: Because the serlet-name.properties file is shared with other modules, you must precede the property entry with tile to indicate the irtual iewer. For example, to specify debugging leel, use tile.tracenet=true. Procedure To edit the configuration file: 1. Open the WEB-INF/serlet_name.properties file in a text editor and make sure that it contains the following lines to configure logging. tile.logfile=web-inf/iewone.log tile.tracenet=true The properties file name must match the serlet name that you defined in WEB-INF/web.xml. For example, use the iewone.properties file. You can replace iewone with the name of your serlet. 2. Optional: Add more parameters as need to customize the serlet. Related information: Configuring the serer You can set optional properties to configure and customize the serer elements of IBM Daeja ViewONE. Configuring the irtual iewer by using HTML You configure the IBM Daeja ViewONE Virtual iewer by using HTML. Procedure 1. Edit the HTML page that displays the irtual iewer to add the following lines. <!DOCTYPE html> <html> <head> <script type="text/jaascript" src="/iewone/1files/iewone.js"> </script> </head> <body> <object class="com.ibm.d.client.viewer" id="iewone" width="600" height="600"> <!-- Optional - place additional HTML parameters here --> </object> </body> </html> Important: The line that begins src= must point to the IBM Daeja ViewONE Virtual iewer serlet that proides the iewer application code. By default, the path for the serlet is "/iewone/1files/iewone.js. Be sure to use the correct path for your enironment. 2. Verify that you can access the iewer by entering the URL to the HTML page in a browser. For example, enter the following URL: http://myserer:8080/ iewone/iewone_irtual.html 8 Installing, Configuring, and Using IBM Daeja ViewONE