5.4sp2 installationguide forhpdevicesdl.nsiautostore.com/swupdates/ecopy/documentation... · 2017....

Document Imaging Solutions

EN-EC-HPD-IG-5.4-SP2-20160523

5.4 SP2Installation Guidefor HP Devices

Licensing, Copyright, andTrademark InformationThe information in this document is subject to change and does not represent a commitment on the part ofNuance Communications, Inc. The software described in this document is furnished under a licenseagreement. The softwaremay be used or copied only in accordance with the terms of the agreement. It isagainst the law to copy the software on any medium except as specified in the license agreement. No part ofthis document may be reproduced, transmitted in any form or by any means, electronic or mechanical,including photocopying, recording, or information storage and retrieval systems, or translated into any languagefor any purpose other than the purchaser's personal use, without the written permission of NuanceCommunications, Inc.

© 2016 Nuance Communications. All Rights Reserved.

Nuance, the Nuance logo, eCopy PaperWorks andOmniPage are trademarks or registered trademarks ofNuance Communications, Inc. or its affiliates in the United States and/or other countries. All other trademarksreferenced herein are the property of their respective owners.

Open Text, eDOCS, Open Text Fax Server, and RightFax are registered trademarks or trademarks of OpenText Corporation in the United States and/or other countries.

EMC, Documentum, and ISIS are registered trademarks of EMC Corporation.

IBM, Lotus, Lotus Notes, and Lotus Domino are trademarks and/or registered trademarks of LotusDevelopment Corporation and/or IBM Corporation in the United States, other countries or both.

Intel and Pentium are registered trademarks of Intel Corporation.

Microsoft, Windows, Windows NT, Outlook, SharePoint, andMS-DOS are registered trademarks andWindows Server is trademark of Microsoft Corporation in the USA and in other countries.

Autonomy and the Autonomy logo, iManage, Interwoven, andWorkSite are registered trademarks ortrademarks of Autonomy Corporation plc.

EN-EC-HPD-IG-5.4-SP2-20160523

i

Customer Support ServicesCustomer Support services include the following components:

n Customer support for licensing, registration, and other non-technical issues

n Technical support

n Hardware RMA (ReturnMerchandise Authorization), where applicable

Note:Nuance Communications does not provide hardware support. Contact your hardware dealer/distributor, orsystem integrator for support information.

The support services are available to registered users of Nuance Communications software during thewarranty period or for the duration of your softwareMaintenance and Support (M&S) agreement. Contact yoursupplier for details, as described in theM&S agreement.

Themain Support page is at http://www.nuance.com/support/, where you can obtain information aboutCustomer Support services, hours of operation, contact information, policies, and process descriptions. In thelist of products, select the eCopy product and then click Go. The Support Overview page opens.

In addition to support provided by your dealer or distributor, the eCopy Support website provides 24x7 accessto a knowledge base. To access it, click the link on themain Support page.

If you purchased your software directly from Nuance Communications, check the eCopy Support website forsolutions to your technical problems. If necessary, open a ticket from the eCopy Support website.

Contact InformationUS/North America

Corporate Headquarters Telephone: +1.781.565.5000

Customer Support Services Telephone: +1.781.565.4600

Outside North America

Please contact your local dealer or national sales organization.

EN-EC-HPD-IG-5.4-SP2-20160523

ii

http://www.nuance.com/support/http://www.nuance.com/support/ecopy/index.htm

Contents

ShareScan Installation Guide 11 - ShareScan Documentation 22 - Typical Installation Workflow 33 - Pre-install Considerations 53.1- System Requirements for the ShareScanManager PC 5

3.1.1 - Operating Systems 5

3.1.2 - Database 6

3.1.3 - Virtual Environments 6

3.1.4 - Memory Configuration 6

3.1.5 - Checklist for the ShareScanManager PC 6

3.1.6 - Ports to be left open 7

3.1.7 - Database Rights 7

3.1.8 - Network 8

3.2- Support Information 9

3.2.1 - Languages 9

3.2.2 - Supported Devices 10

3.2.3 - Supported Backend Services 10

4 - Installing ShareScan 114.1- Basic Workflow 11

4.2- Installing ShareScan 11

4.3- ShareScan Installation Scenarios 12

4.3.1 - Installing ShareScan to a Clean System 13

4.3.1.1 - Complete Installation 13

4.3.1.2 - Custom Installation 14

4.3.1.2.1 - ALL four components are installed (withWebClient optionally skipped) 15

4.3.1.2.2 - Microsoft SQL Server database engine NOT installed (withWebClient optionallyskipped) 17

EN-EC-HPD-IG-5.4-SP2-20160523

iii

4.3.1.2.3 - ONLY eCopy ShareScan 5.4 Server and eCopy ShareScan 5.4WebClient (optionallyskipped) are installed 19

4.3.1.3 - User rights necessary for ShareScan database creation 20

4.3.1.3.1 - Administrative account with SysAdmin fixed server-level role (e.g. 'sa') 20

4.3.1.3.2 - Administrative account with ‘dbcreator’ and ‘securityadmin’ fixed server-level roles 20

4.3.1.3.3 - Administrative account ONLY with ‘dbcreator’ fixed server-level role 20

4.3.1.3.4 - Most restrictive environment 20

4.3.2 - Upgrading ShareScan 5.x to 5.4 SP2 21

4.3.2.1 - Upgrade from ShareScan 5.x to 5.4 SP2 21

4.3.2.2 - Custom upgrade from ShareScan 5.x to 5.4 SP2 22

4.3.3 - How tomigrate Activity Tracking data when upgrading from ShareScan 5.1 or ShareScan 5.1SP1 23

4.3.4 - Maintenance 24

4.3.5 - Installing Service Packs 24

4.3.6 - UpgradingMultiple Managers 25

4.4- Profile Tool 27

4.4.1 - Best Practices 28

4.4.1.1 - Exporting profiles from a ShareScan 5.x Manager PC 28

5 - Client-side Installation 295.1- Configuring the HP Embedded client 29

5.1.1 - Network configuration 29

5.1.2 - SNMP configuration 30

5.2- Adding Devices 30

5.2.1 - Batch Adding Devices 31

5.3- Configuring the HP S900 series client 32

5.3.1 - Network configuration 32

5.3.2 - SNMP configuration 33

5.3.3 - Device User Authentication 33

5.3.4 - SSL Settings 33

EN-EC-HPD-IG-5.4-SP2-20160523

iv

5.3.5 - Adding Devices 33

5.3.6 - Batch Adding Devices 34

6 - eCopy Connectors 366.1- eCopy Connector for Microsoft Exchange (Mail and/or Fax) 36

6.1.1 - Supported Versions 36

6.1.2 - Installation Prerequisites and Suggestions 36

6.1.3 - ConfiguringMAPI/MAPI Protocol for ExchangeMail and Fax Connectors 36

6.1.4 - Exchange 2010 CAS Support for MAPI Protocol 37

6.2- eCopy Connector for IBM Lotus Notes (Mail and/or Fax) 38



6.3- eCopy Connector for LDAP/SMTP (Mail and/or Fax) 38



6.4- eCopy Scan to Desktop 39


6.5- eCopy Quick Connect 40



6.6- eCopy Connector for OpenText Fax Server (RightFax Edition) 40



6.7- eCopy Scan to Printer 41


6.8- eCopy Connector for Microsoft SharePoint 41



6.9- eCopy Connector for EMC Documentum 42

EN-EC-HPD-IG-5.4-SP2-20160523

v



6.10- eCopy Connector for Autonomy iManageWorkSite 43



6.11- eCopy Connector for Open Text Content Server - eDOCS Edition 43



6.12- eCopy Connector for Open Text Content Server 44



7 - Licensing Devices 467.1- Loading Licenses 46

7.2- Activating Licenses 47

7.3- Loading Activated Licenses 47

7.4- Removing Licenses 47

7.5- Generating a license report 48

8 - ShareScan Post-install 498.1- Configuring ShareScan (examples) 49

8.1.1 - To Configure a Service (example – Activity Tracking) 49

8.1.2 - To Configure an Extender (example – Forms Processing Extender) 50

8.1.3 - To Configure aQuick Connect Connector Profile to Use Forms Processing Extender data 50

8.1.4 - To Test the Configuration of a Profile 51

8.2- Certificate Manager 51

9 - Next Steps 539.1- Best Practices 53

9.2- Technical Support 54

9.3- Troubleshooting Tips 55

EN-EC-HPD-IG-5.4-SP2-20160523

vi

9.3.1 - Re-enable SSLv3 in Tomcat and Java 56

EN-EC-HPD-IG-5.4-SP2-20160523

vii

ShareScan Installation GuideThe eCopy ShareScan software extends the capabilities of digital copiers and scanners. When installing andsetting up a ShareScan system, youmust be familiar with the scanning devices that you will use withShareScan, the ShareScan software components, and the basic installation and configuration workflow.

This guide is intended for administrators responsible for the initial installation, configuration, and licensing ofShareScan. For the device-specific Pre-Installation Checklist (PICL), see the relevant vendor-specific PICL.For information pertaining to the ShareScan (pre)install, see this guide. For configuration and AdministrationConsole usage, refer to the Administration Console Help (accessible via pressing F1 on the AdministrationConsole).

This document is written under the assumption that readers are familiar with working in a server-clientarchitecture and environment.

EN-EC-HPD-IG-5.4-SP2-20160523

1

1 - ShareScan DocumentationThe following documentation is available for your perusal with ShareScan:

n Pre-installation Checklist and Sizing Guide (PDF) – provides info on the issues to be addressedbefore deploying ShareScan

n HP Device Configuration Guide (PDF) - provides information on seamless integration of ShareScanon HP devices

n Installation Guide (this document) - contains information on installing Nuance ShareScan, includinghardware and software prerequisites

n Administration Console help – the integrated help of the application, covering the use of ShareScanbeyond installation, and provides configuration information. The help is accessible by pressing F1 onthe ShareScan Administration Console

n Troubleshooter User Guide (PDF) – contains information on how to use the ShareScanTroubleshooter, a built-in diagnostic tool of the product

n Release Notes (PDF) – contains an overview of the changes for the given ShareScan release

n eCopy ShareScan High Availability and Load Balancing Deployment Guide (PDF) - providesguidance on how to deploy ShareScan to function in high availability mode

n eCopy ShareScan Capture Server Monitor Configuration Guide (PDF) - contains information onhow to use the Capture Server Monitor tool for monitoring ShareScan instances

EN-EC-HPD-IG-5.4-SP2-20160523

2

2 - Typical Installation WorkflowShareScan 5.4 installation has three typical scenarios, which are briefly outlined below. For amore detaileddescription, read the Installing ShareScan section of this document.

Installing ShareScan 5.4 to a clean system

1. Ensure that the ShareScan prerequisites (listed in the following chapter) are installed.

2. Start the ShareScan 5.4 installer, and click through the InstallationWizard.

3. After ShareScan 5.4 is successfully installed, install ShareScan 5.4 SP2

Upgrading from ShareScan 4.x to 5.4 SP2

Important!eCopy ShareScan 5.4 SP2 does not support upgrade/configuration export scenarios in case ShareScan 4.x isinstalled on the target system. In such cases you can upgrade your ShareScan 4.x to ShareScan 5.4 SP2 inthe following way:

1. Exit ShareScan 4.x Administration Console.

2. Run eCopy ShareScan 5.2 installer.

3. ChooseUpgrade ShareScan 4 to 5.2 orExport ShareScan 4 configuration and upgrade toShareScan 5.2 after theWelcome screen and click through the upgrade workflow.

4. After successful upgrade of ShareScan 4.x to 5.2, run the eCopy ShareScan 5.4 installer.

5. ChooseUpgrade from ShareScan 5.x to 5.4 orCustom upgrade from ShareScan 5.x to 5.4 andclick through the upgrade workflow.

6. After successful upgrade of ShareScan 4.x to 5.4, run the eCopy ShareScan 5.4 SP2 installer andclick through the upgrade workflow.

Upgrading from ShareScan 5.x to 5.4 SP2

Before you start the upgrade process, ensure that your current ShareScan installation is working properly. Theeasiest way to do this is starting the Administration Console and verifying that it launches error-free.

1. Exit ShareScan 5.x Administration Console.

2. Ensure that the ShareScan prerequisites (listed in the following chapter) are installed.

3. Run eCopy ShareScan 5.4 installer.

4. ChooseUpgrade ShareScan 5.x to 5.4 orCustom upgrade from ShareScan 5.x to 5.4 after theWelcome screen and click through the upgrade workflow.

EN-EC-HPD-IG-5.4-SP2-20160523

3

5. After successful upgrade of ShareScan 5.x to 5.4, run the eCopy ShareScan 5.4 SP2 installer andclick through the upgrade workflow

EN-EC-HPD-IG-5.4-SP2-20160523

4

3 - Pre-install ConsiderationsThe following chapter contains information on the various tasks to be performed prior to installing ShareScan,as well as the requirements that must bemet before product installation.

3.1- System Requirements for the ShareScan Manager PCThe ShareScan 5.4 install media contains all the required dependency installer files underInstall\ShareScan\SetupPrerequisites\ in separate folders that must be installed to ensure ShareScanfunctions properly. These are the following:

n Java SE Runtime Environment v1.8.0_91

n .NET Framework 4.5.2

n Microsoft Visual C++ 2010 Service Pack 1 Redistributable PackageMFC Security Update (x86) –version 10.0.40219.325

n Microsoft Visual C++ 2012 Update 4 Redistributable (x86) – version 11.0.61030.0

n Microsoft Visual C++ 2013 Redistributable (x86) – version 10.0.21005.1

The installer skips any of the above listed dependencies if they are already installed on the target system, withthis considerably shortening install time.

Note:Microsoft Visual J# 2.0 Redistributable andMicrosoft WSE 3.0 Runtimemust bemanually installed from theinstallationmedia. Before installing these dependencies, .NET Framework 3.5 SP1must also bemanuallyinstalled. This is necessary if you want to use the eCopy Connector for Open Text Content Server (Livelink).

3.1.1 - Operating Systemsn Windows 7 SP1 x86/x64

n Windows 8.1 Update 1 x86/x64

n Windows 10 version 1151 x86/x64

n Windows Server 2008 SP2 x86/x64

n Windows Server 2008 R2 SP1 x64

n Windows Server 2012 x64

n Windows Server 2012 R2 x64

n The ShareScan Administration Console and the ShareScanManager cannot be installed on Linux,Solaris or Macintosh operating systems.

EN-EC-HPD-IG-5.4-SP2-20160523

5

Note:The ShareScan 5.4 installer cannot be launched unless .NET Framework 4.5.2 is installed on thetarget system. When trying to launch the installer with no .NET Framework or any version older thanv4.5.2 installed, a warningmessage pops up detailing the dependency and the install media path forthe offline .NET Framework installer. This warningmessagemust be closed by clickingOK and theinstaller quits. For more information on .NET Framework versions and their operating system relateddependencies click here.

3.1.2 - Databasen SQL server 2008 or above, express and non-express editions

3.1.3 - Virtual Environmentsn VMware ESX Server 4.x and 5.x

n VMwareWorkstation 7.x, 8.x, 9.x, 10.x, 11.x and 12.x.

n Microsoft Hyper Visor (Hyper-V) Server 2012

3.1.4 - Memory Configurationn 4GB physical memory (minimum); 6 GB recommended (8 GB recommended for systems using 100+

MFPs)

n 5GB disk space (including SQL server and prerequisites)

For more details on recommendedmemory configuration, see theSizing recommendations for embeddedconfigurations section of thePre-Installation Checklist and Sizing Guide document.

3.1.5 - Checklist for the ShareScan Manager PCn Ensure you are about to install the ShareScanManager to a dedicated PC (that is, a PC exclusively

tasked with the running of the ShareScanManager).

n Run the Automatic Updates before you start installing ShareScan. Pay extra attention that you haveAutomatic Updates of the operating system TURNED OFF during the installation.

n ShareScan 5.4 installs a customized Apache Tomcat web service. Already existing Tomcatinstallations are not supported.

n When designing the network architecture, note that Windows 7 can handle amaximum number of 20concurrent network connections. If you plan to havemore than 10 devices, you needWindows Serveras an operating system.

n If you havemultiple NIC cards, you need to select an IP address for ShareScan that will be used fordevice-server communication.

n Check if your drive format is NTFS.

EN-EC-HPD-IG-5.4-SP2-20160523

6

http://msdn.microsoft.com/en-us/library/bb822049(v=vs.110).aspx

n Ensure that Microsoft IIS is not installed or is not listening to the ports used by ShareScan (listedbelow).

n ShareScan 5.x licenses are installed to a SQL Server to allow easy management of devices. Prior toinstalling ShareScan 5.4, it is important to determine if licenses will bemanaged individually from eachShareScanManager, or if you would like tomanage all licenses from a single SQL Server. The ShareScan installer can install a local copy of SQL Server 2014 Express for managing licenses (inaddition to storing configuration data). It can also create the appropriate database structure on anexisting SQL server for consolidated key management.

n ShareScan 5.x license keys must be activated against a Nuance Activation Server. License keys canonly be activated once, so inspect the setup carefully prior to activation. All license keys provide a 30-day grace period before activation to ensure the license setup is as intended. Manual activation isavailable for servers that are unable to communicate directly with the Nuance Activation Server.As licenses are tied to the ShareScan database, Nuance does not recommend changing databasesafter ShareScan installation.

n If you plan to use theSingle Sign-On feature of theSession Logon service, ensure that theShareScanManager PC is amember of the domain for which Session Logon is configured. The loggedin user running and configuring the Session Logonmust be an Active Directory user with the necessaryrights to read properties in Active Directory (this is a default value). Ensure that you use the ActiveDirectory user account to log in into this domain (and not into the local system). This Active Directoryuser must have the necessary rights to read Active Directory properties (generally this is a defaultbehavior; however this can bemodified in Active Directory).

3.1.6 - Ports to be left openIf you are planning to have firewalls enabled, leave the following ports open (between ShareScanManager andthemultifunctional device) for both inbound and outbound network traffic:

Inbound traffic:

n TCP: 443, 8080, 9600, 9650, 9700, 9610,

n UDP: 9650,

Outbound traffic:

n TCP: 7, 1433 (SQL server default port, custom port can also be used instead), 7627 (HP S900 doesnot use these ports), 9650,

n UDP: 161 (SNMP), 8899, 9650

If any of these ports are in use, ShareScan displays a warning. Ports in use do not block installation, but mustbe opened later for proper functionality.

3.1.7 - Database Rightsn For working with the ShareScan databases in case of upgrading, youmust use an account that has

db_owner rights for the eCopy ShareScan database. An sa-level account can be used, but it is not

EN-EC-HPD-IG-5.4-SP2-20160523

7

mandatory. For clean installation scenario related database rights, see User rights necessary forShareScan database creation section in this document.

n Do not use an sa account as a ShareScan runtime account for database connection, it does not work.Use only the eCopy account created by the ShareScan database installer, or a user having the sameuser rights as the eCopy account. If you use IntegratedWindows Authentication for databaseconnection, the user accounts specifed during installation should have the proper rights.

Note:If IntegratedWindows Authentication is used to connect to the database, and FPE (Form Processing Extender)or SFE (SmartForms Extender) profile is edited in the Administration Console (by using the template editor ofthe extenders), the database administrator must add the user (or users) to the allowed users of the ShareScandatabase. These users should have db_owner rights andmust have their default schema set to 'ShareScan'.

3.1.8 - Networkn Domains and Workgroups:ShareScan can be configured to run in either domain-based networks or

workgroup environments. Windows 2008 or later domain environments are supported.Nuance recommends using a domain environment.

n Subnets and VLANs: The ShareScanManager PC can be on different subnets or VLANs from themultifunction devices, provided that themultifunction devices can communicate with theManager PCusing an IP address. If your multifunction devices spanmultiple subnets or VLANs, a router is requiredto pass packets back and forth. However, in these situations the UDP and the SNMP based devicediscovery mechanisms may not be functional. Also, consider that bi-directional communication isrequired between the ShareScanManager and theMFPs (meaning both the devices shall be able tosend TCP messages to theManager and vice versa), on the ports listed in section Checklist for theShareScanManager PC.

n IP Addresses:Use static IP addresses for both the ShareScanManager PC and theMFPs. Tochange the IP address of theManager PC:

a. remove all devices from theManager

b. stop all ShareScan related services

c. change the IP address of the NIC andmake sure the network adapters use the new IP(ipconfig command)

d. start the services stopped in (b)

e. re-add the devices

If your devices require a certificate to work, the workflow changes slightly when changing theManagerIP address:

a. remove all devices from theManager

b. change the IP address

c. reboot theManager PC

EN-EC-HPD-IG-5.4-SP2-20160523

8

d. start the ShareScan Administration Console, and confirm the IP address change on the dialogthat automatically opens

e. recreate the certificate(s)

f. re-add the devices to theManager

n Gateway Address: ShareScan does not require a gateway address.

n Host Name: The host namemust not exceed 60 characters. Device host names are resolved usingDNS. This happens once you have added a device and confirmed it. If the device is not registered inthe DNS, then its name in theDevices tab (Administration Console) may change after confirmation.Note that changing the host name after installation can cause licensing and database issues, and istherefore not supported. If youmust change the host name, youmust do a full reinstallation ofShareScan.

n Network Attached Storage Devices (NAS): ShareScan 5.4 supports NAS drives and folders thatare fully compatible with NTFS file system andWindows access control mechanisms.

n Novell:ShareScan does not support direct communication between a ShareScanManager PC and amultifunction device on Novell networks. However, when Novell client software is installed on theManager PC someConnectors (eCopy Quick Connect, and the eCopy Scan to Desktop) can bridge toa Novell server. A Novell client must be installed on the ShareScanManager PC if Novellauthentication of Scan Inboxes is required.The eCopy Connector for LDAP/SMTP requires a Novell client to work properly with Session Logon.

n Local Security Policy: In order to use the Administration Console on the ShareScanManager PC,you require local administrator-level credentials. ShareScanManager cannot be installed on a DomainController.

3.2- Support InformationThis section contains information on the various languages and third-party software supported by ShareScan.

3.2.1 - LanguagesShareScan 5.4 supports the following languages:

n English

n Brazilian Portuguese

n Dutch

n French

n German

n Italian

n Spanish

EN-EC-HPD-IG-5.4-SP2-20160523

9

Note:This list only refers to the languages available for the user interface. For the OCR process, the languagesupport is much wider, comprising over 100 languages.

3.2.2 - Supported DevicesFor themost current information on supported devices, go to the Support Website.

3.2.3 - Supported Backend ServicesFor a detailed list of connector-specific backend version, see section eCopy connectors in this InstallationGuide.

EN-EC-HPD-IG-5.4-SP2-20160523

10

http://www.nuance.com/support/ecopy/supported-devices/index.htm

4 - Installing ShareScanThe following chapter contains information on the various tasks associated with installing ShareScan, includingdeploying Service Packs (as outlined in section Installing Service Packs).

4.1- Basic WorkflowTo install, configure, and license ShareScan:

1. Install the ShareScan software on a network computer. You have the option to customize the databaseinstallation. For more information, see the Custom installation chapter of this guide.

2. Install ShareScan Client, if needed (for more information on installing the client, see the Client-sideinstallation chapter of this guide).

3. Start the Administration Console.

4. Add licenses, add devices (if they do not appear automatically on theDevices tab), and/or set upscanners. TheModel name (in the dialog that appears as part of device addition procedure) differs fromthe name of the Device (displayed in the tree control on theDevice tab). The tree control on theDevicetab contains the network (host) name of the devices (or the IP address of the devices, if the host namecannot be resolved). This ID is used as a unique identifier for the devices in the ShareScan system.This cannot be changed in the Administration Console, only via the Device administration userinterface and / or in the network DNS (Domain name server).

Note:TheModel name specified during device addition can be changed anytime via theModify ModelNamemenu item in the Administration Console: Devices tab > >Modify Model Name).

5. Install and configure Services, Connectors, and Devices.

When you open the Administration Console, theWelcome page displays a list of themain feature highlights ofthe current version.

For in-depth information about configuring andmanaging the Services, Connectors, and Devices thatShareScan uses, refer to the ShareScan Help. To access the Help, click F1 or click theHelp button that islocated in the upper-right corner of the ShareScan Administration Console.

4.2- Installing ShareScanIf you are about to deploy ShareScan as a High Availability system or want to enable ShareScan loadbalancing, consult the eCopy ShareScan High Availability and Load Balancing Deployment Guide.

The present guide gives you guidance on installation in a basic or multi-manager setup.

Use the ShareScan installation program to install the software components on a network computer.

EN-EC-HPD-IG-5.4-SP2-20160523

11

Notes:ShareScanis only compatible with the Apache Tomcat version included in the installation program. If you haveApache Tomcat already installed, remove it prior to installing ShareScan.If you have Skype installed, it can conflict with the Apache Tomcat installed by ShareScan. To avoid this,ensure that theUse port 80 and 443 as alternatives for incoming connections option is unchecked inSkype.

Important!Ensure that the ports used for both inbound and outbound network traffic are left open. See Ports to be left opentopic.

4.3- ShareScan Installation ScenariosBefore running the ShareScan installer, ensure that you have the latest system updates on your machine andthat Automatic Windows Updates are turned off.

Important!Installing ShareScan to folders belonging to individual user profiles (e.g.: My Documents, Documents andSettings on older systems) is NOT recommended.When upgrading existing ShareScan versions using the relevant Upgrade options of the installer, ShareScan5.4 always performs a complete installation; you can only customize the installation location (DestinationFolder screen) and database access and Service account credentials (Service Credentials screen) in suchcases.When you perform an upgrade on amulti-manager deployment, it is recommended that you upgrade theindividual ShareScanManagers one by one.If you plan to deploy ShareScan in a High Availability cluster with multiple ShareScan server nodes, follow theinstructions in the eCopy ShareScan High Availability and Load Balancing Deployment Guide. It isrecommended to set up the individual ShareScan server nodes first, test their basic behavior and thenmovethem into the High Availability cluster as described in the eCopy ShareScan High Availability and LoadBalancing Deployment Guide.

Note:Do not use square brackets ( [ and ] ) in

n user identifiers

n passwords

n database name fields

since they are not handled correctly and are removed. If you need to use these characters in the password,please consider changing it for the time of the installation.

Follow these two basic scenarios when installing ShareScan.

EN-EC-HPD-IG-5.4-SP2-20160523

12

4.3.1 - Installing ShareScan to a Clean System

4.3.1.1 - Complete Installation1. Insert the ShareScan installationmedia in the optical drive of your PC and browse to the folder where

theShareScan5.4.exe file is located. If you have a digital copy of the ShareScan installer, you can findtheShareScan5.4.exe file under the Install/ShareScan path.

2. RunShareScan5.4.exe; theChoose setup language screen is displayed. Select a preferredlanguage (English by default) from the dropdown list and click Next.

3. TheWelcome screen is displayed. Click Next.

4. The installer displays theSystem Check screen. If prompted, select the preferred option(s) from thedropdown list(s). Click Next.

Note:This screen displays warnings on any possible issues that might have an impact on the properoperation of ShareScan and provides information on how to resolve them. If relevant, it also enablesyou to choose frommore than one option such as the number of available network adapters for device-Manager communication.

5. TheEnter Product License Key screen is displayed. Provide your Product License Key (22characters with dashes, or 18 without dashes; the system accepts either). Click Next.

6. Specify your location on theChoose Your Geographic Region screen. Click Next.

7. The End-User License Agreement (EULA) is displayed on the License Agreement screen. Accept theEULA and click Next.

8. TheSetup Type screen is displayed; select Complete:

Automatic full installation is performed with the following features and settings:

n eCopy ShareScan 5.4 server is installed

n Microsoft SQL Server database engine is installed

l SQLServer 2014 Express Local DB is installed.

Note:Since you cannot connect to this type of database engine from another PC on thenetwork, this option is not recommended if you plan to share the database installedbetweenmultiple Managers. In that case, select the Custom installation option. UsingLocalDB as a database server engine is only recommended in case of small-scaleinstallations, if only a few devices are included.

n eCopy ShareScan configuration database is created on the installed SQL Server

n eCopy ShareScan 5.4 WebClient is installed (including the Apache Tomcat server)

EN-EC-HPD-IG-5.4-SP2-20160523

13

n default eCopy credentials (username / password) is used for database access, with SQLserver authentication

n C:\Program Files (x86)\Nuance\ShareScan5.4 is the default installation path

9. The Installation Summary screen is displayed. Click Install.

10. Click Finishwhen the InstallShield Wizard Completed screen appears.Alternately, you can click the Launch ShareScan System Checker Tool to perform a check on thecore components of the ShareScan system.

11. After successful installation of ShareScan 5.4, run the eCopy ShareScan 5.4 SP2 installer and clickthrough the upgrade workflow.

4.3.1.2 - Custom Installation

Note:In case you specify custom folders for all (or some) components (e.g. eCopy ShareScan, Nuance ImagingFramework Trace and Apache Tomcat) during the installation, all selected folders must be different, otherwisethe already installed system will fail after the upgrade (e.g: Service Pack install).

1. Perform steps 1 - 7 as described in the Complete Installation section above.

2. TheSetup Type screen is displayed; select Custom:

3. TheCustom Setup screen is displayed. Select the program features you want to install and clickNext. The following components can be selected for installation:

n eCopy ShareScan 5.4 Server –mandatory component, installed in all possible scenarios,cannot be deselected.

n Microsoft SQL Server database engine (selected by default) – select this component if youwant a local installation of Microsoft SQL Server Express or Express LocalDB. Thesedeployment options are recommended for small-scale deployments with a single Manager. Ifyou do not select this component, the Installer assumes you have an existing SQL Serverinstallation either locally or on another server on the network, and you are planning to connectto that.

n eCopy ShareScan configuration database – select this component if you want to create aShareScan configuration database.It is necessary to select this component

n if you install a single ShareScanManager

n if you plan to install multiple Managers and you do not want to share the samedatabase across them

n if you plan to havemultiple Managers and you are installing the first ShareScanManager.

EN-EC-HPD-IG-5.4-SP2-20160523

14

Note:This component is selected by default. You can deselect it only if theMicrosoft SQL Serverdatabase engine component is deselected, but in this case you need to specify databaseproperties on theDatabase Catalog Name andDatabase Server and Runtime AccountInformation screens.

n eCopy ShareScan 5.4 WebClient (selected by default) – select this component if you plan touse scanner devices with web browser enabled user interface.

You have threemajor custom installation scenarios when on a clean system:

4.3.1.2.1 - ALL four components are installed (with WebClient optionally skipped)

Note:If the eCopy ShareScan 5.4 WebClient component is deselected, the installation scenario iscomprised of the same steps described below, respectively.

This custom setup scenario installs all four components:

n eCopy ShareScan 5.4 Server

n Microsoft SQL Server database engine

n eCopy ShareScan configuration database

n eCopy ShareScan 5.4WebClient

i. Once you selected all components (and/or optionally deselected the eCopy ShareScan 5.4WebClient component) on theCustom setup screen, click Next.

ii. TheDestination Folder screen is displayed. Click theChange button tomodify the defaultdestination folder for the ShareScan server, the Nuance Imaging Framework Trace Service (NIF trace)or the Apache Tomcat web server installation (the Apache Tomcat web server is required forShareScanWeb client). Click Next.

iii. Specify service credentials on theService Credentials screen. Use default service accounts, orspecify your custom service accounts for the ShareScanManager and ShareScan Agent WindowsServices. These accounts must be valid domain accounts (users). Note that while the installersupports using custom accounts to run the services, using IntegratedWindows Authentication for thelocal database connection is NOT supported by the installer when the ShareScan Installer installs theSQL server. If you want to use IntegratedWindows Authentication on a local SQL server, you have toinstall ShareScan first with the available installation type (i.e. using default of custom credentials withSQL Server Authentication) and then later modify the service accounts and database permissionsmanually. Click Next.

EN-EC-HPD-IG-5.4-SP2-20160523

15

Note:When you provide valid non-default accounts for theManager and the Agent and then click theGrantbutton (after the installer detected that some local privileges are not granted to the service accounts),the installer tries to grant themissing privileges.If this cannot be successfully performed, the installer still detects that the privileges aremissing and itdoes not continue the installation. The user must exit from the installer, resolve the issue (either grantthemissing privileges manually or eliminate the blocking factor to allow the installer to grant themduring the next run), and then re-run the installer.

iv. Specify the database type to install on the Local Database Server screen. Select the SQL serverdatabase engine. Regardless of the selected SQL Server type, you can override the password of theSQL Server system administrator (that is, the 'sa' password), by unmarking the checkbox at thebottom of the screen. If you do so, youmust provide a password that complies with the passwordpolicy in effect. If you plan to havemore than onemanager to connect to this SQL server, than youshould select SQL Server 2014 Express instead of localDb. Click Next.

Note:If you specified custom service accounts on theService Credentials screen (Use default serviceaccounts checkbox unmarked), theMicrosoft SQL Server 2014 Express LocalDB option isdisabled, on the Local Database Server screen, since it cannot be used with custom serviceaccounts.

v. The Installation Summary screen is displayed. Click Install.

vi. Click Finishwhen the InstallShield Wizard Completed screen appears.Alternately, you can click the Launch ShareScan System Checker Tool to perform a check on thecore components of the ShareScan system

vii. After successful installation of ShareScan 5.4, run the eCopy ShareScan 5.4 SP2 installer and clickthrough the upgrade workflow.

Note:If the eCopy ShareScan 5.4 WebClient component is selected, this scenario is equal to theComplete Installation scenario, since all four components are installed, but you still need to specifyrelated settings on theDestination Folder, Service Credentials, Local Database Server screens;alternately, you can click through these screens leaving the default settings untouched.

Note:If you specifiedCustom Service Credentials in step iii, eCopy ShareScan 5.4 SP2 installer will askfor Agent service user password.

EN-EC-HPD-IG-5.4-SP2-20160523

16

4.3.1.2.2 - Microsoft SQL Server database engine NOT installed (with WebClient optionallyskipped)


This custom setup scenario only installs the following three components.


n eCopy ShareScan configuration database


i. Once you deselected the Install Microsoft SQL Server database engine component (and/oroptionally deselected the eCopy ShareScan 5.4 WebClient component) on theCustom setupscreen, click Next.


iii. Specify service credentials on theService Credentials screen. Use default service accounts, orspecify a different service account for the ShareScanManager and ShareScan Agent. These accountsmust be valid domain accounts (users). Click Next.

Note:When you plan to use a SQL Server on a different PC than the one used for ShareScanManagerinstallation (remote SQL Server) with IntegratedWindows Authentication for the database connection,youmust use (custom) domain accounts as service accounts, because the default (local) accountscannot connect to a remote database via IntegratedWindows Authentication. Using the defaultaccounts with a remote SQL Server is still possible if (username / password based) SQL ServerAuthentication is used.

iv. TheAdministrative Credentials for Database Creation screen is displayed. On this screen, thehostname or IP (and optionally, the instance name) of the SQL Server must be specified.The credentials entered on this screen are required while installing or upgrading the database. Theinformation is not stored, it is only required during the installation or upgrade process, for the databaseconnection. The following options are displayed:

n SQLServer host / instance name input box: the host name and (optionally) the instance nameof the SQL Server to usemust be specified: e.g. SQLSRV-01, CORPSQL1\SHARESCAN,10.140.1.23\SSCAN1

You need to choose one from the following three options:

n The default sa account and the default password used by ShareScan

EN-EC-HPD-IG-5.4-SP2-20160523

17

n TheWindows identity of the user running the ShareScan installer

n Specifying a user ID and the corresponding password (use SQL Server authentication). Thiscan be an sa account with the corresponding password, or it can be a completely different userID that is valid on the SQL Server having the proper rights for the ShareScan databasecreation.

Click Next.

Note:If the runtime database user (eCopy by default) already exists on a remote SQL server (either from aprevious installation or because it is created by the database administrator manually), a valid passwordmust be specified for login.

v. TheDatabase Catalog Name screen is displayed. Specify the ShareScan database name here orleave the default name. Click Next.

vi. TheDatabase Server and Runtime Account Information screen is displayed. You can specify aruntime account for the configuration database.You need to select amethod how the ShareScan services connect to the SQL Server database:

n via SQL Server authentication, using the default user name 'eCopy' and the default password

n via IntegratedWindows Authentication, using the identity of the accounts running the services(available only if custom accounts were specified on the previous wizard screen)

Note:If this option is selected (theUse specified credentials given to Service Accounts fordatabase connection radio button) and the administrative database user has no db_securityadmin database-level role (cannot create logins), the database administrator has tocreate the database users manually, otherwise the installed system will not operate properly.

n via SQL Server Authentication, using specified user name and password

Note:If the runtime user (SQL server user orWindows login) exists on the SQL Server specified for anyreason, youmust provide the same user credentials / account existing on the SQL Server. If theprovided credentials are valid, these are used during installation and as runtime connection accounts.

Click Next.

vii. The Installation Summary screen is displayed. Click Install.

viii. Click Finishwhen the InstallShield Wizard Completed screen appears.Alternately, you can click the Launch ShareScan System Checker Tool to perform a check on thecore components of the ShareScan system.

EN-EC-HPD-IG-5.4-SP2-20160523

18

ix. After successful installation of ShareScan 5.4, run the eCopy ShareScan 5.4 SP2 installer and clickthrough the upgrade workflow.

Note:If you specifiedCustom Service Credentials in step iii, eCopy ShareScan 5.4 SP2 installer will askfor Agent service user password.

4.3.1.2.3 - ONLY eCopy ShareScan 5.4 Server and eCopy ShareScan 5.4 WebClient(optionally skipped) are installed


This custom setup scenario only installs the following two components:



i. Once you deselected the Install Microsoft SQL Server database engine and eCopy ShareScanconfiguration database components (and/or optionally deselected the eCopy ShareScan 5.4WebClient component) on theCustom setup screen, click Next.


iii. Specify service credentials on theService Credentials screen. Use default service accounts, orspecify a different service account for the ShareScanManager and ShareScan Agent. These accountsmust be valid domain accounts (users). Click Next.

iv. TheDatabase Catalog Name screen is displayed. On this screen, youmust specify the hostname orIP (and optionally, the instance name) of the SQL Server where the existing 5.4 ShareScan databaseis hosted. Youmust also specify the existing database name. Click Next.

v. TheDatabase Server and Runtime Account Information screen is displayed.You need to provide the runtime account information for the configuration database. Click Next.

Note:If theUse specified credentials given to Service Accounts for database connection radio buttonis selected, the database administrator has to create the database users manually, otherwise theinstalled system will not operate properly.

vi. The Installation Summary screen is displayed. Click Install.

EN-EC-HPD-IG-5.4-SP2-20160523

19

vii. Click Finishwhen the InstallShield Wizard Completed screen appears.Alternately, you can click the Launch ShareScan System Checker Tool to perform a check on thecore components of the ShareScan system.

viii. After successful installation of ShareScan 5.4, run the eCopy ShareScan 5.4 SP2 installer and clickthrough the upgrade workflow.

Note:If you specifiedCustom Service Credentials in step iii, eCopy ShareScan 5.4 SP2 installer will ask for Agentservice user password.

You are now ready to configure a connector profile.

4.3.1.3 - User rights necessary for ShareScan database creationThis section lists the supported user right scenarios ShareScan database creation, from the least restrictive tothemost restrictive.

4.3.1.3.1 - Administrative account with SysAdmin fixed server-level role (e.g. 'sa')

Note:Since ShareScan 5.1, sa rights are not required anymore for database installation, allowing the cases below.Having sa rights simplifies the process, as in that case you do not need to set anything on the SQL server.

4.3.1.3.2 - Administrative account with ‘dbcreator’ and ‘securityadmin’ fixed server-level roles

These rights are enough to create both the ShareScan database and the login ID of the runtime account. If youare connecting to a corporate database server, and your database administrator is not providing you thecredentials of the sa account, then the database administrator needs to provide another account for theShareScan database installation (practically with lower privileges), having the dbcreator and thesecurityadmin fixed server-level roles.

This administrative user will be a db_owner on the created eCopyShareScan database.

4.3.1.3.3 - Administrative account ONLY with ‘dbcreator’ fixed server-level role

If security policy is stricter, the login ID in SQL Server for the ShareScan runtime account must be created bythe database administrator manually. This manually created SQL Server login ID orWindows user name (ifIntegrated Authentication is used) must be used on theDatabase Server and Runtime Account Informationscreen of the ShareScan InstallationWizard. This manually created login needs to have a public fixed server-level role and it is not required to have it mapped to any database (it will bemapped to the eCopyShareScandatabase with aminimal set of user rights necessary for the proper operation of the ShareScan server).

This administrative user will be a db_owner on the created eCopyShareScan database.

4.3.1.3.4 - Most restrictive environment

Themost restrictive scenario (if database access is considered) the ShareScan installer supports is similar tothe previous scenario, with the following additional restrictions:

EN-EC-HPD-IG-5.4-SP2-20160523

20

n The database administrator must create the empty ShareScan database. Any name can be chosen.

n An account must be provided (on theAdministrative Credentials for Database Creation screen) toenable the creation of the ShareScan database content – for this, the account needs to be a db_owneron the empty database.

n The account does not need to be amember of the dbcreator or securityadmin fixed server-level roles.

In any of the above cases, the InstallerWizard checks the server connection and the provided credentials, andit also checks if the accounts or users provided have the necessary rights granted. If the user rights are not setproperly, the corresponding error message is displayed.

On theAdministrative Credentials for Database Creation screen you can select an option when thedatabase creation is performed in the name of theWindows user currently running the ShareScan installer. Incase of a centralized corporate database server, this option allows the database administrator to use aWindows (domain) account as the database creator, using any of the above options according to the securitypolicy in place.

4.3.2 - Upgrading ShareScan 5.x to 5.4 SP2When the ShareScan 5.4 installer is run on amachine which has a previous version of ShareScan installed, itoffers two upgrade options.

Note:If Custom Service Credentials is set for the Agent andManager service, the eCopy ShareScan 5.4 SP2installer will ask for the Agent service user password.

Note:Optimal performance is not guaranteed in case the eCopy 5.4 server is used with devices that have v5.2 JARclients installed on them. Background Processingmust be enabled for a functioning configuration of thedifferent version server and client. This setup with legacy clients is only recommended until full transition fromv5.2 to v5.4 happens.

4.3.2.1 - Upgrade from ShareScan 5.x to 5.4 SP21. Insert the ShareScan installationmedia in the optical drive of your PC and browse to the folder where




4. TheSetup Type screen is displayed; select Upgrade from ShareScan 5.x to 5.4:

This option removes the older ShareScan version, then proceeds to install the new one, preservingconfiguration data.

EN-EC-HPD-IG-5.4-SP2-20160523

21


n existing eCopy ShareScan configuration database is updated to the 5.4 schema


5. If the installer is not able to use the default ‘sa’ credentials and the current Windows user does nothave the necessary rights granted for database access, then theAdministrative Credentials forDatabase Creation screen appears, where the proper (administrator level) credentials must beprovided.




4.3.2.2 - Custom upgrade from ShareScan 5.x to 5.4 SP21. Insert the ShareScan installationmedia in the optical drive of your PC and browse to the folder where




4. TheSetup Type screen is displayed; select Custom upgrade from ShareScan 5.x to 5.4: theinstaller performs a complete installation, preserving configuration data:


n existing eCopy ShareScan configuration database is updated to the 5.4 schema


5. TheDestination Folder screen is displayed. Click theChange button tomodify the defaultdestination folder for the ShareScan server, the Nuance Imaging Framework Trace Service (NIF trace)or the Apache Tomcat web server installation (the Apache Tomcat web server is required forShareScanWeb client). Click Next.

6. Specify service credentials on theService Credentials screen. Use default service accounts, orspecify a different ShareScanManager and ShareScan Agent. Click Next.

Note:If the installer detects a LocalDB SQL server connection from the previous ShareScan installation, theService Credentials screen is not displayed.

EN-EC-HPD-IG-5.4-SP2-20160523

22

7. At this point, the user can be presented with the following options:n If the installer is not able to use the default ‘sa’ credentials and the current Windows user does

not have the necessary rights granted for database access, then theAdministrativeCredentials for Database Creation screen appears, where the proper (administrator level)credentials must be provided.

n theDatabase Server and Runtime Account Information screen: in case the user selectedcustom service accounts, as in this case the user is necessary to specify what connectionmethod / account should be used for database connection.

Note:If theUse specified credentials given to Service Accounts for database connection radio buttonis selected and the administrative database user has no db_securityadmin database-level role(cannot create logins), the database administrator has to create the database users manually,otherwise the installed system will not operate properly.

Note:If the connection type is not changed to IntegratedWindows Authentication, then the user name /password should not be changed, otherwise the database connectionmay fail after installation. Thereason is that in case of upgrade, existing users will not be recreated or their passwords changed.




4.3.3 - How to migrate Activity Tracking data when upgrading fromShareScan 5.1 or ShareScan 5.1 SP1

Note:If you have eCopy ShareScan 5.1 Connector Pack or above installed on your system, this procedure does notapply.

In case you want to use your already-existing Activity Tracking data on the newly-installed ShareScan version,you should preferably migrate the data at this point. To do so, launch theActivityTrackingReport.DataMigration.exe tool, located in under theC:\Program Files (x86)\Nuance\ShareScan5.4\Server path of your ShareScan installation. The tool uses the current connectionstring from the registry, and uses that to create a new SQL table for the exported data, which will be availableon the newly installed ShareScanManager.Enter an sa-level username/password combination on the UI of the tool.You can use the following command line arguments for the tool:

EN-EC-HPD-IG-5.4-SP2-20160523

23

n /ConnectTimeout (only set if your database is large-scale, and has exceedingly slow connection)

n /DataSource (by default, taken from the registry)

n /InitialCatalog (by default, taken from the registry)

n /CommandTimeout (this parameter regulates the timeout period of themigration script)

n /BatchSize (this parameter regulates the number of records tomigrate per copy operation)

4.3.4 - MaintenanceIf you re-launch the ShareScan installer after the successful installation of ShareScan 5.4, theProgramMaintenance screen is displayed after you select a preferred language from the dropdown list on theChoosesetup language screen and click Next. The the following options are available:

n RemoveRemoves all ShareScan features (Server, WebClient). The so-called dependency packages (SQLServer, Apache Tomcat, .NET runtimes, and so forth) can be removed from thePrograms / Featuresmanager of Windows.Note that if you installed ShareScan 5.4 over an existing ShareScan version, removing ShareScan 5.4DOES NOT bring back the previously existing ShareScan version.Removing theWebClient feature of ShareScan also removes the Apache Tomcat server.

4.3.5 - Installing Service Packs

Note:eCopy ShareScan 5.4 SP2 is only compatible with the following eCopy ShareScan releases:

n eCopy ShareScan v5.4 RTM

n eCopy ShareScan v5.4 Cumulative Update 1


n eCopy ShareScan v5.4 Service Pack 1


1. Ensure that your ShareScan installation is working properly (for example, if the IP address of theShareScanManager PC changed) by starting the Administration Console. If it starts properly, proceedwith the Service Pack installation. If the Administration Console does not start, youmust perform acomplete reinstall of ShareScan itself, as outlined in the instructions above.

2. Download the Service Pack installer.

3. Run the executable.

4. Select a preferred language on theChoose setup language screen (English by default) from thedropdown list and click Next.

EN-EC-HPD-IG-5.4-SP2-20160523

24

5. TheAdministrative Credentials for Database Update screen is displayed. Here you have to selecteither theUse the Windows account of the current user or theUse SQL Server LoginID - specifyuser name and password below radio button for updating the ShareScan configuration database.Click Next.

6. If custom service credentials had been specified for the Agent andManager services when ShareScan5.4 was installed, theService Credentials screen is displayed where you have to specify thepassword for ShareScan Agent service user. Specify the password and click Next.

7. Click Install to proceed with installing the Service Pack.

8. Click Finishwhen the InstallShield Wizard Completed screen appears.

Note:Optimal performance is not guaranteed if Service Pack installation takes place during ShareScan Serveruptime.

4.3.6 - Upgrading Multiple Managers

Important!When performingmulti-manager upgrade and you start to use IntegratedWindows Authentication (instead ofthe Existing SQL Server type database authentication), then you need to use:

n IntegratedWindows Authentication on all themanagers you connect to the same 5.4 database

n the samewindows service accounts on all theManagers you upgrade.

After you upgraded the first Manager to v5.4 with IntegratedWindows Authentication, you cannot use thedefault service accounts for the Agent andManager services when you upgrade the second one, but you haveto specify the sameWindows users you used on the 1stManager.

Note:For the time of upgradingmultiple managers in any environment (NLB or standard), all managers should bestopped for the time of upgrading the first manager. Databasemodification is also done during the upgrade.When this is complete, the rest of thamanagers can be started and upgraded one by one.

Performing amulti-manager setup (whenmore than one ShareScanManager connect to the same databasecatalog) and then upgrading from version 5.x is similar to the Custom upgrade scenario.

1. Insert the ShareScan installationmedia in the optical drive of your PC and browse to the folder wheretheShareScan5.4.exe file is located. If you have a digital copy of the ShareScan installer, you can findtheShareScan5.4.exe file under the Install/ShareScan path.



EN-EC-HPD-IG-5.4-SP2-20160523

25

4. TheSetup Type screen is displayed; select Custom upgrade from ShareScan 5.x to 5.4: theinstaller performs a complete installation, preserving configuration data:


n existing eCopy ShareScan configuration database is updated to the 5.4 schema or a clone(copy) of the currently used ShareScan database is updated to the 5.4 schema and put in usefor the upgraded installation (the actual behavior is specified on the screen detailed in step 8below)


5. TheDestination Folder screen is displayed. Click theChange button tomodify the defaultdestination folder for the ShareScan server, the Nuance Imaging Framework Trace Service (NIF trace)or the Apache Tomcat web server installation (the Apache Tomcat web server is required forShareScanWeb client). Click Next.

6. Specify service credentials on theService Credentials screen. Use default service accounts, orspecify a different service account for the ShareScanManager and ShareScan Agent services. Theseaccounts must be valid domain accounts (users). Click Next.

7. TheAdministrative Credentials for Database Creation screen is displayed, if the default 'sa'credentials do not work, or the actual Windows user running the installer does not have rights to updatethe database. Otherwise this screen is not shown.

8. TheDatabase Catalog Name screen is displayed. You have three basic scenarios:i. If you select theUse current catalog for database upgrade radio button in the first manager

upgrade installation sequence, the procedure is identical with the single manager Customupgrade from ShareScan 5.x to 5.4 SP2 installation scenario. In this case, the name of thedatabase catalog remains the same (eCopyShareScan), but its structure changes hence ifthere aremultiple managers, only the first Manager currently upgraded will be able to operatecorrectly, while the other Managers will not, until they are upgraded as well. As aconsequence, selecting this option is recommended if all theManagers connecting to thesame database are stopped during the whole upgrade process (of all theManagers).

Note:This option is also useful in scenarios when your database administrator (DBA) does notprovide an administrative account eligible for backup/restore operations. In such case, theDBA must create a copy of the eCopyShareScan database catalog (with a different name) onthe same database server (and on the same instance). Then you need to switch one of yourManagers to this copied database (via theDatabase configuration option of the ShareScanAdministration Console), and upgrade it by selecting this option. Further Managers can thenbe upgraded by selectingOption iii described below.

ii. When upgrading the first Manager, select theCopy current catalog to perform the upgradeon the following one radio button and specify a database name. This optionmakes a copy ofthe already existing database catalog with outdated structure and upgrades the copyreconfiguring theManager to use it. This way the other Managers are able to use the old

EN-EC-HPD-IG-5.4-SP2-20160523

26

catalog without any hindrance. To perform this successfully, the user must have db_backupoperator database-level role and DBCREATOR server level permission since theseallow backup and restore operations.

iii. When upgrading the second and all further Managers, select theUse a different existingShareScan catalog radio button and select the newly created / updated database, alreadyupgraded to 5.4 level. You have to select the database catalog name provided during theupgrade the first Manager.

Note:The dropdown list only contains catalog names that are not the original ones and theShareScanManager to be currently updated is also listed; theManager is reconfigured to usethe new database catalog name.

Click Next.

9. TheDatabase Server and Runtime Account Information screen is displayed if the servicecredentials weremodified. You need to provide the runtime account information for the configurationdatabase. Click Next.



12. After successful installation of ShareScan 5.4, run the eCopy ShareScan 5.4 SP2 installer and clickthrough the upgrade workflow

4.4- Profile ToolThe Profile Tool allows you tomanage connector, service profile information, watchers and Data Publishingmaps between ShareScan 5.x Managers. You can export such profile information from aManager, then start upanother Manager, and import the profile information.

Unlike connector profiles, newly imported watchers do not automatically overwrite watchers with the samename already existing on the target machine. (These imported watchers are created as new ones.) To update awatcher via import, first you have to delete the current watcher (on the target machine) and then do the import.

To access the tool, go toAdministration Console > Advanced tab > Tools > Profile Tool.

To perform an export, do as follows:


2. Start the Profile Tool.

3. Remain on theExport pane.

EN-EC-HPD-IG-5.4-SP2-20160523

27

4. Use the dropdown icons to browse to the connector or service whose profile information you want toexport.

5. Right-click on the connector or service in question.

6. Select Export connector profiles orExport service profiles (as appropriate).

7. Browse to the location where you want to save the file; the generated file automatically has the .profileextension.

To perform an import, do as follows:


2. Start the Profile Tool.

3. Switch to the Import pane.

4. Click theBrowse button to locate the profile file you want to import.

5. Double-click the file to start the import process.

4.4.1 - Best Practices

4.4.1.1 - Exporting profiles from a ShareScan 5.x Manager PCThe Profile Tool is delivered as part of the ShareScan 5.4 (and above) file set with a GUI. To ease the processof exporting profiles on pre-5.4 installations, Nuance offers the following solution for your convenience:

1. Ensure you logged in as an administrator user on theManager PC from where you want to perform theprofile export

2. Download the updated version of the Profile Tool for SP4 / SP5 /SP6 (available as a ZIP file,containing all the binaries required for the profile export) from the eCopy registration site or NuanceNavigator.

3. Extract the content of the ZIP file (preserving the folder structure inside) to any folder of your SP4 /SP5 /SP6Manager PC

4. Launch theProfileImportExportGUI.exe. For the best results, you need to use a number of commandline parameters, in the following syntax: ProfileImportExportGUI.exe whereMode can be: E, ISP Level can be: SP4, SP5, SP6For example: ProfileImportExportGUI.exe E "C:\Program Files (x86)\Nuance\ShareScan5" SP6

5. For more details on Profile Tool capabilities, and usage, see Profile Tool, above, or consult the relevantsection of the Administration Console Help.

To import the exported profile(s):

1. Install the ShareScan 5.4 on your Manager PC

2. Launch the tool from theShareScan Administration Console > Advanced > Tools > Profile tool.

EN-EC-HPD-IG-5.4-SP2-20160523

28

http://registration.ecopy.com/default.aspxhttp://www.nuancenavigator.com/http://www.nuancenavigator.com/

5 - Client-side InstallationThe following chapter contains information on installing device-specific embedded clients.

5.1- Configuring the HP Embedded clientShareScan supports OXPd 1.6-capable HP devices. For a list of supported devices, see the Supported Devicelists available at www.nuance.com. Before you can use ShareScan with HP devices, youmust install and/orenable the following components:

n OXPd 1.6

l Update device firmware to support OXPd 1.6, if necessary.

l Enable OXPd 1.6 if needed.

l ConfigureWeb Proxy settings (used by OXPd 1.6 for http/s communications where the deviceis the client) and the ShareScan server.

l Configure the embedded web browser (timeouts and trusted sites list).

l Manage certificates in the OXPd 1.6 CA certificate store (used by OXPd 1.6 for httpscommunications where the device is the client).

l Due to the number of steps, Nuance recommends using HPWeb Jetadmin when youmustconfigure several devices at once.

Youmay use HPWeb Jetadmin or the deviceWeb Administration page, accessible via http:///) for configuring the device.

The HP Embedded client also provides a switch via the Administration Console, which allows you to togglebetween these settings:

n Use the native software keyboard/physical keyboard of theMFP

n Use the standard eCopy soft keyboard

Nuance recommends using background processing (enabled by default for all connector profiles) in allscenarios. Should you encounter a situation where online processing better serves your interests, it isrecommended that you raise theDevice Inactivity Timeout value to 300 secs. To do this, select theAdministration option on the device, then chooseDisplay Settings and Inactivity Timeout: touch thetextbox and enter 300 (secs) (5minutes) as the Inactivity timeout value.

5.1.1 - Network configurationMake sure you have the IP address of the device so that you can access the deviceWeb Administration page.

1. Open aWeb browser and enter http:// in the Address field.

2. Log in with your Admin credentials when prompted.

EN-EC-HPD-IG-5.4-SP2-20160523

29

http://www.nuance.com/

3. Navigate to Networking > Network Identification and configure the device correctly so that theShareScanManager’s host name can be resolved.

5.1.2 - SNMP configurationTo enable theDevice discovery function in the Administration Console, the devicemust have SNMPv2 readaccess, and aGet Community Name. Set these in the following ways:

n Go toNetworking > Mgmt. Protocols > SNMP. Click theEnable SNMPv1/v2 read-write accessoption. Enter the community name in theSet Community Name textbox.

Note:Youmay disable the write access. ShareScan will need to read device properties. After setting up and installingthe ShareScan application on the device, youmay restore the SNMP settings. SNMP is used only during theinitial ShareScan setup.

n Go toNetworking > Mgmt. Protocols > Other. Mark the checkbox next toMulticast IPv4 underEnable Device Discovery category.

5.2- Adding DevicesAfter adding a license file to the ShareScan system, you can add one or more embedded or integrated devices.

1. Start ShareScan Administration Console.

2. Click Add Device on the toolbar. You can also select Devices on theWelcome page and then right-click in theDevice Configuration window and select Add Device. TheAdd Deviceswindow opens.

3. If your device does not appear in the list, select theSNMP option from theDiscovery list. If theautodiscovery does not succeed, use TCP/IP to add it manually.

4. Select the device you want to add.

5. Click OK. The device registration wizard opens.

6. Enter the device administrator credentials and specify Device Settings.

7. Click Register.

8. When the system prompts you to confirm the device that you want to add to the device list, click OK.

Troubleshooting tip: If your device(s) cannot be discovered and are not shown in the list on theAdd devicedialog with any of the protocols, thenmake sure that:

l The device is up and running.

l It is connected to the network (use the ping command in a commandwindow).

l The required ports are open on the firewalls/routers.

EN-EC-HPD-IG-5.4-SP2-20160523

30

Note:The automatic device discovery is only supported via SNMP. If the autodiscovery does not succeed, useTCP/IP to add the devicemanually. If the devicemodel cannot be detected due to firewall/network restriction,a pre-populated dropdown list pops up the user can select from.

5.2.1 - Batch Adding DevicesIf you want to addmultiple devices in a batch, follow the instructions below:

1. Start the ShareScan Administration Console.

2. Click Add Device, or select Add device from the context menu (by right-clicking in theDeviceConfiguration window).

3. Select Import... from theDiscovery dropdown list; a standardOpen file dialog is displayed and youneed to select a file that describes the devices to add. The file must be a .csv file, containing data inthe following format:

IP/host, Canon, model, password(string), HTTPS(bool), port(int), secure

Example: 10.140.202.99,Canon,300,1111,false,true

IP/host, HP, model, username(string), password(string), SNMPGet(string), HTTPS(bool), AsyncBW(bool)

Example: 10.140.202.70, HP, M4555, admin, 1111, public, false, false

n IP/host: device IP address (or host name)

n HP: must be HP

n model (or *): specific devicemodel name (or * to get themodel name automatically from thedevice)

n username(string): device administrator username used for device registration

n password(string): device administrator password used for device registration

n SNMPGet(string): SNMP get community name (public by default; if otherwise specified onthe device web administration page, the samemust be included here)

n HTTPS(bool): true or false (enable or disable secure communication and file transfer for thedevice)

EN-EC-HPD-IG-5.4-SP2-20160523

31

n AsyncBW(bool): true or false (asynchronous scanning in B&W mode; for optimalperformance, true is recommended)

Note:It is recommended tomanually add a device to the Administration Console for a proper understandingof the .csv file content describing the devices.

4. The Administration Console displays the file content in theBatch add devices progresswindow andstarts adding the devices one by one.

5. When the processing is finished, the results are displayed in theBatch add devices progresswindow.

6. When you are done, click Close to exit the window and check the devices on theDevices tab.

Note:For instructions about removing devices, refer to the ShareScan Help.

5.3- Configuring the HP S900 series clientShareScan supports MFPs in the HP S900 series. For a list of supported devices, see the Supported Devicelists available at www.nuance.com.

The HP S900 series client also provides a switch via the Administration Console, which allows you to togglebetween these settings:

n Use the native software keyboard/physical keyboard of theMFP

n Use the standard eCopy soft keyboard

Nuance recommends using background processing (enabled by default for all connector profiles) in allscenarios. Should you encounter a situation where online processing better serves your interests, it isrecommended that you raiseAutomatic Logout Setting value to 240 secs. To do this, go to theWebadministration page of the device, log in as administrator and then navigate toUser Control > DefaultSettings: mark the checkbox next toAutomatic Logout Setting and choose 240 from the dropdown list.

TheAuto Clear function can also interfere with job processing. If the device is not used for the duration of timeset here, the auto clear function will clear any settings that have been selected and return the screen to thebase screen of copy mode or the job status screen as well as log the user out.If you are the administrator, change the time setting of Auto Clear or disable it inAuto Clear Setting.Navigate toSystem Settings > Operation Settings > Auto Clear Setting. Mark the checkbox next toCancel timer to disable it, or raise its value to 240 secs, as in the case of Automatic Logout Setting.

5.3.1 - Network configurationMake sure you have the IP address of the device so that you can access the deviceWeb Administration page.

1. Open aWeb browser and enter http:// in the Address field.

2. Log in with your Administration credentials when prompted.

EN-EC-HPD-IG-5.4-SP2-20160523

32

http://www.nuance.com/

3. Navigate toNetwork Settings > General Settings and configure the device correctly so that theShareScanManager’s host name can be resolved.

5.3.2 - SNMP configurationTo enable theDevice discovery function in the Administration Console, the devicemust have SNMPv1 readaccess, and aGet Community Name. Set these in the following ways:

n Go toNetwork Settings > Services Settings > SNMP. To enable device discovery, set SNMP v1Settings toEnabled andRead-write access forAccess Method; do not forget to set the communityname.

5.3.3 - Device User AuthenticationDepending onUser Authentication settings on theMFP, device registration in the Administration Console(see below) requires different data.

On the device web administration page, go toUser Control > Default Settings and check UserAuthentication settings:

If set toDisable in Administrator registrationmode, theUser Name string is not validated, only thePassword.

If set toEnable, both theUser Name and thePassword are validated.

To check the administrator user name on the device, go to the deviceHome screen, press theSelect fromList button then press the left pointing arrow in the top right hand corner of the screen and chooseAdminLogin. The administrator name is displayed in the Login Name field.

By default, using theAdministratormode for device registration is sufficient. In certain cases (e.g. whenEquitrac is installed on the device)Servicemode is required for successful device registration.

Note:In order to get the user credential information from the user authenticating via Session Logon service, theHPS900 devices must meet the following requirements:

n OSA version: 3.0 or later

n extension kit: MX-AMX2

5.3.4 - SSL SettingsOn the device web administration page, go toSecurity Settings > SSL Settings and ensure that theRedirectHTTP to HTTPS inDevice Web Page Access checkbox is left unmarked.

5.3.5 - Adding DevicesAfter adding a license file to the ShareScan system, you can add one or more embedded or integrated devices.

EN-EC-HPD-IG-5.4-SP2-20160523

33

1. Start ShareScan Administration Console.

2. Press Add Device on the toolbar. You can also select Devices on theWelcome page and then right-click in theDevice Configuration window and select Add Device. TheAdd Deviceswindow opens.

3. If it does not appear in the list, select theSNMP option from theDiscovery list. If the autodiscoverydoes not succeed, use TCP/IP to add the devicemanually.

4. Select the device you want to add.

5. Click OK. The device registration wizard appears.

6. Enter the device administrator credentials and specify Device Settings.

7. Click Register.

8. When the system prompts you to confirm the device that you want to add to the device list, click OK.

Troubleshooting tip: If your device(s) cannot be discovered and are not shown in the list on theAdd devicedialog with any of the protocols, thenmake sure that:

l The device is up and running.

l It is connected to the network (use the ping command in a commandwindow).

l The required ports are open on the firewalls/routers.

Note:The automatic device discovery is only supported via SNMP. If the autodiscovery does not succeed, useTCP/IP to add the devicemanually.

5.3.6 - Batch Adding DevicesIf you want to addmultiple devices in a batch, follow the instructions below:

1. Start the ShareScan Administration Console.

2. Click Add Device, or select Add device from the context menu (by right-clicking in theDeviceConfiguration window).

3. Select Import... from theDiscovery dropdown list; a standardOpen file dialog is displayed and youneed to select a file that describes the devices to add. The file must be a .csv file, containing data inthe following format:

IP/host, HPS900, model, registrationmode(A|S), username(string), password(string),SNMPGet(string), HTTPSforUI(bool), HTTPSforFileTransfer(bool)

Example: 10.140.202.142, HPS900, *, Administrator, Administrator, admin, public,false, false

EN-EC-HPD-IG-5.4-SP2-20160523

34

n IP/host: device IP address (or host name)

n HPS900: must be HPS900

n model (or *): specific devicemodel name (or * to get themodel name automatically from thedevice)

n registrationmode(A|S): Administrator or Service (see "Device User Authentication" onpage 33)

n username(string): device administrator username used for device registration

n password(string): device administrator password used for device registration

n SNMPGet(string): SNMP get community name (public by default; if otherwise specified onthe device web administration page, the samemust be included here)

n HTTPSforUI(bool): true or false (enable or disable secure communication for the device)

n HTTPSforFileTransfer(bool): true or false (enable or disable secure file transfer for thedevice)

Note:It is recommended tomanually add a device to the Administration Console for a proper understandingof the .csv file content describing the devices.

4. The Administration Console displays the file content in theBatch add devices progresswindow andstarts adding the devices one by one.

5. When the processing is finished, the results are displayed in theBatch add devices progresswindow.

6. When you are done, click Close to exit the window and check the devices on theDevices tab.

Note:For instructions about removing devices, refer to the ShareScan Help.

EN-EC-HPD-IG-5.4-SP2-20160523

35

6 - eCopy ConnectorsNuance recommends matching the application credentials (for Lotus Notes, Microsoft Outlook, SMTP, LDAP,and so forth) with the PC login credentials. Nuance recommends creating a generic, email-enabled“ShareScan” account for use by ShareScan.

The backend applications listed in this section belong to their respective owners, and as such, any further, in-depth information youmay need on the workings of these applications can be found in the application's owndocumentation, NOT in the ShareScan documentation.

6.1- eCopy Connector for Microsoft Exchange (Mail and/or Fax)

6.1.1 - Supported Versionsn Microsoft Exchange 2007 / 2010 / 2013 / Exchange Online for Office 365

n For information on supportedMicrosoft Exchange versions, go tohttp://www.nuancenavigator.com and search for ShareScan 5.4 Compatibility Matrix.

6.1.2 - Installation Prerequisites and Suggestionsn If configuring the Exchange connector using EWS orWebDAV protocols, the Exchange server SSL

certificate must be installed on the PC running ShareScanManager. Certificates should be installed tothe Trusted Root Certification Authorities on the Local Computer.

n To configure and use EWS/EWS protocol, the user's logon name and alias must correspond, due tolimitations of the Exchange web services. For this reason, using LDAP/EWS protocol isrecommended.

n If you intend to useMAPI protocols, ensure that “Log on locally” rights are assigned to all domainusers.ShareScan 5.4 requires anOutlook client installed on theManager PC if the connector iscommunicating with the Exchange server via MAPI protocol. At the time of configuration, the end usershould be prepared to provide a user name, password, Exchange server name, and domain name andthe general domain environment for a valid Outlook user. Blank passwords and special characters arenot supported by ShareScan. To function correctly,Microsoft Outlook® 2007 / 2010 (32-bit version)/ 2013 (32-bit version part of Microsoft Office 365) is required as the client.Also note that usingMAPI protocols is not advised, if an alternative is possible.

6.1.3 - Configuring MAPI/MAPI Protocol for Exchange Mail and FaxConnectors

n To configureMAPI/MAPI protocol for Exchange connectors, the service account (theDomain/Username/Password combination) is expecting to have a configured default Outlook profile.Otherwise you cannot configure the connector as the Administration Console will display an errormessage.

EN-EC-HPD-IG-5.4-SP2-20160523

36

http://www.nuancenavigator.com/

n If your Outlook profile is not preconfigured, you can use the Custom settings via the AdministrationConsole:

a. Log on to the ShareScan server using credentials of the service account intended for use withthe Exchange connectors.

b. Run the Custom settings of the connector, and enter the email address you want to use. Theservice account is now ready, and can be used for configuring the connectors.

c. For Exchange fax connector, define the fax format.

d. Check to see whether you need to reconfigure your existing profiles usingMAPI protocol.

e. This change does not affect LDAP/MAPI configurations.

6.1.4 - Exchange 2010 CAS Support for MAPI Protocoln To support Exchange 2010 environments that have a dedicated Client Access Server (CAS) separate

from theMailbox Server, a feature was introduced to allow administrators to specify the name of theCAS.

n The relevant property value can be specified either via theUse CAS button of theMAPI tab in theAdministration Console, or in the connector's configuration xml file:

l For ExchangeMail connector it is [COMMON_APPDATA]\Nuance\ShareScan\connectors\ExchangeMail\Data\ExchangeMailStore.xml

l For Exchange Fax connector it is [COMMON_APPDATA]\Nuance\ShareScan\connectors\ExchangeFax\Data\ExchangeFaxStore.xml

n An example of applying the property value:

…

EU-Exch-Cas.Nuance.Com