ecopy ShareScan 5.1 Installation Guide for ScanStation devices

Transcription

1 ecopy ShareScan 5.1 Installation Guide for ScanStation devices

2 Licensing, Copyright, and Trademark information The information in this document is subject to change and does not represent a commitment on the part of Nuance Communications, Inc. The software described in this document is furnished under a license agreement. The software may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specified in the license agreement. No part of this 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 language for any purpose other than the purchaser s personal use, without the written permission of Nuance Communications, Inc Nuance Communications. All Rights Reserved. Nuance, the Nuance logo, ecopy PaperWorks and OmniPage are trademarks or registered trademarks of Nuance Communications, Inc. or its affiliates in the United States and/or other countries. All other trademarks referenced herein are the property of their respective owners. Open Text, edocs, Open Text Fax Server, and RightFax are registered trademarks or trademarks of Open Text 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 Lotus Development 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, and MS-DOS are registered trademarks and Windows Server is trademark of Microsoft Corporation in the USA and in other countries. Autonomy and the Autonomy logo, imanage, Interwoven, and WorkSite are registered trademarks or trademarks of Autonomy Corporation plc. Part of the software embedded in this product is gsoap software. Portions created by gsoap are Copyright Robert A. van Engelen, Genivia inc. All Rights Reserved. The software in this product was in part provided by Genivia Inc and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. in no event shall the author be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. - i -

3 Customer Support services Customer Support services include the following components: Note: Customer support for licensing, registration, and other non-technical issues Technical support Hardware RMA (Return Merchandise Authorization), where applicable Nuance Communications does not provide hardware support. Contact your hardware dealer/distributor, or system integrator for support information. The support services are available to registered users of Nuance Communications software during the warranty period or for the duration of your software Maintenance and Support (M&S) agreement. Contact your supplier for details, as described in the M&S agreement. The main Support page is at where you can obtain information about Customer Support services, hours of operation, contact information, policies, and process descriptions. In the list 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 Ask ecopy Web site provides 24x7 access to a knowledge base. To access Ask ecopy, click the link on the main Support page. If you purchased your software directly from Nuance Communications, check Ask ecopy for solutions to your technical problems. If necessary, open a ticket from the Ask ecopy Web site. Contact information US/North America Corporate Headquarters Telephone: Customer Support Services Telephone: Outside North America Please contact your local dealer or national sales organization. - ii -

4 ecopy ShareScan Installation Guide iii ShareScan Installation Guide The ecopy ShareScan software extends the capabilities of digital copiers and scanners. When installing and setting up a ShareScan system, you must be familiar with the scanning devices that you will use with ShareScan, 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 of ShareScan. 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 Administration Console usage, refer to the Help (accessible via pressing F1 on the Administration Console). This document is written under the assumption that readers are familiar with working in a server-client architecture and environment. IMPORTANT: The installation process for ShareScan 5.1 has been improved based on user feedback. It is different from the procedure in the previous releases (5.0, Service Packs and Performance Updates). If you are about to install or upgrade to ShareScan 5.1, consult this document. If you are installing ShareScan 5.0 and/or a Service Pack or Performance Update, consult the relevant Installation Guide. In this guide: ShareScan Installation Guide iii 1 - ShareScan documentation Typical installation workflows Pre-install considerations System requirements for the ShareScan Manager PC Operating systems Virtual environments Memory Configuration Checklist for the ShareScan Manager PC Database rights Network Support information Languages Supported devices Installing ShareScan 6

5 ecopy ShareScan Installation Guide iv 4.1- Basic workflow Installing ShareScan Custom installation Creating a ShareScan configuration database User rights necessary for ShareScan database creation Installing only the ShareScan Server Maintenance Upgrading profiles Profile migration during installation Migrating profiles between PCs Best practices Upgrading multiple ScanStations Profile Tool Best practices Exporting profiles from a ShareScan 5.0 SP4 / SP5 / SP6 manager PC Database migration between two SQL Servers Adding devices Client-side installation Installing a TWAIN or ISIS Driver Send to ecopy ShareScan service Send to ecopy ShareScan configuration options Configuration settings: Send to ecopy ShareScan settings ecopy connectors ecopy connector for Microsoft Exchange (Mail and/or Fax) Supported versions: Installation prerequisites and suggestions Configuring MAPI/MAPI protocol for Exchange Mail and Fax connectors Exchange 2010 CAS support for MAPI protocol ecopy connector for IBM Lotus Notes (Mail and/or Fax) Supported versions Installation prerequisites and suggestions ecopy connector for LDAP/SMTP (Mail and/or Fax) 25

6 ecopy ShareScan Installation Guide v Supported versions Installation prerequisites and suggestions ecopy Scan to Desktop Installation prerequisites and suggestions ecopy Quick Connect Supported versions Installation prerequisites and suggestions ecopy connector for OpenText Fax Server (RightFax Edition) Supported versions Installation prerequisites and suggestions ecopy Scan to Printer Installation prerequisites and suggestions ecopy connector for Microsoft SharePoint Supported versions Installation prerequisites and suggestions ecopy connector for EMC Documentum Supported versions Installation prerequisites and suggestions ecopy connector for Autonomy imanage WorkSite Supported versions Installation prerequisites and suggestions ecopy connector for Open Text Content Server - edocs Edition Supported versions Installation prerequisites and suggestions ecopy connector for Open Text Content Server Supported versions Installation prerequisites and suggestions Licensing devices Loading licenses Activating licenses Loading activated licenses Reactivating licenses Removing licenses 33

7 ecopy ShareScan Installation Guide vi 9 - ShareScan post-install Configuring ShareScan (examples) To configure a service (example Activity Tracking): To configure an Extender (example Forms Processing Extender): To configure a Quick Connect connector profile to use Forms Processing Extender data To test the configuration of a profile: Next steps Best practices Technical support Troubleshooting tips 38

8 ecopy ShareScan Installation Guide ShareScan documentation The following documentation is available for your perusal with Nuance ShareScan: Pre-installation Checklist and sizing guide (this documentpdf) provides info on the issues to be addressed before deploying ShareScan. Installation Guide (this documentpdf) - contains information on installing Nuance ShareScan, including hardware and software prerequisites. Administration Console help the integrated help of the application, covering the use of ShareScan beyond installation, and provides configuration information. The help is accessible by pressing F1 on the ShareScan Administration Console. Troubleshooter Users Guide (PDF) contains information on how to use the ShareScan Troubleshooter, a built-in diagnostic tool of the product. Release Notes (PDF) contains an overview of the changes for the given ShareScan release. Offline Processing Guide (PDF) - contains information on how to use the offline processing feature of ShareScan. Profile Tool User Guide (PDF) - contains information on how to use the Profile Tool to migrate ShareScan-related profiles and data between ShareScan Managers. To view the PDF documentation, you must have a PDF reader application installed. 2 - Typical installation workflows ShareScan 5.1 installation has three typical scenarios, which are briefly outlined below. For a more detailed description, read the Installing ShareScan section of this document. Installing ShareScan 5.1 to a clean system: 1. Ensure that the ShareScan prerequisites (listed in the following chapter) are installed. 2. Start the ShareScan installer, and click through the Installation Wizard. Upgrading from ShareScan 4.x 1. Use the ShareScan Upgrade Tool to export your existing ShareScan 4.x profile and system data. 2. Ensure that the ShareScan prerequisites (listed in the following chapter) are installed. 3. Start the ShareScan installer, and click through the Installation Wizard. 4. Import the profile and system data either by running the ShareScan Upgrade Tool, or by selecting the relevant option during installation. Upgrading from ShareScan 5 1. Use the ShareScan Profile Tool to export your existing ShareScan 5 profile and system data. 2. Ensure that the ShareScan prerequisites (listed in the following chapter) are installed. 3. Start the ShareScan installer, and click through the Installation Wizard.

9 ecopy ShareScan Installation Guide 2 4. Import the profile and system data either by running the ShareScan Profile Tool, or by selecting the relevant option during installation. 3 - Pre-install considerations The following chapter contains information on the various tasks to be performed prior to installing ShareScan, as well as the requirements that must be met before the product installation System requirements for the ShareScan Manager PC Operating systems Windows XP Professional Edition SP3 32-bit Windows 7 Professional or Ultimate Edition SP1 32-bit / 64-bit Windows Server 2003 SP2 32-bit Windows Server 2008 SP2 32-bit Windows Server 2008 R2 SP1 64-bit Latest version of.net Framework 3.5 SP1 installed (for Windows XP) The ShareScan Administration Console and the ShareScan Manager cannot be installed on Linux, Solaris or Macintosh operating systems Virtual environments VMware ESX v4 and the ESX Server portion of VSphere v4 VMware Workstation 6.5 or HyperV Memory Configuration 2 GB physical memory (minimum); 4 GB recommended (8 GB recommended for systems using 100+ MFPs) 5 GB disk space (including SQL server and prerequisites) Checklist for the ShareScan Manager PC Ensure you are about to install the ShareScan Manager to a dedicated PC (that is, a PC exclusively tasked with the running of the ShareScan Manager). Run the Automatic Updates before you start installing ShareScan. Pay extra attention that you have Automatic Updates of the operating system TURNED OFF during the installation. ShareScan 5.1 installs a customized Apache Tomcat web service. Already existing Tomcat installs are not supported. Ensure that Microsoft.NET Framework 3.5 SP1 is installed and enabled. For instructions on checking and enabling the Service Pack, click here. When designing the network architecture, note that Windows XP can handle a maximum number of 10 concurrent network connections. For Windows 7, this limit is 20 concurrent connections. If you want to use more devices, you need Windows Server as an operating system.

10 ecopy ShareScan Installation Guide 3 If you have multiple NIC cards, disable all but the one you will use for your ShareScan installation. From ShareScan Service Pack 4 onwards, this is not required, as you can use a registry setting to control which NIC is used by the Manager. The same limitation applies to virtual environments: the VM configuration should contain only a single network adapter bridged to a physical adapter that connects to the same network where the MFP devices and the backend systems are connected to. The hosting machine can have multiple physical NICs. For ScanStation platforms with multiple NICs, you have to enter the IP address of the NIC card in the ScanStation configuration file (config.xml). You have to ensure that the IP address in the SERVER manager line is the same as the IP address given to the ShareScan Manager in the registry, and it must also correspond to the value of the address in config.xml. For virtual environment usage, ensure that your virtual drive type is IDE. Check if your drive format is NTFS. Ensure that Microsoft IIS is not installed or is not listening to the ports used by ShareScan (listed below). ShareScan 5.1 licenses are installed to a SQL Server to allow easy management of devices. Prior to installing ShareScan 5.1, it is important to determine if licenses will be managed individually from each ShareScan Manager, or if you would like to manage all licenses from a single SQL Server. The ShareScan installer can install a local copy of SQL Server 2008 R2 Express for managing licenses (in addition to storing configuration data). It can also create the appropriate database structure on an existing SQL server for consolidated key management. ShareScan 5.1 license keys must be activated against a Nuance Activation Server. License keys can only be activated once, so inspect the setup carefully prior to activation. All license keys provide a 30-day grace period before activation is required to ensure the setup is as intended. Manual activation is available 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 databases after ShareScan installation. If you plan to use the Single Sign On feature of the Session Logon service, ensure that the ShareScan Manager PC is a member of the domain for which Session Logon is configured. The logged in user running and configuring the Session Logon must be an Active Directory user with the necessary rights to read properties in Active Directory (this is a default value). Ensure that you use the Active Directory user account to log in into this domain (and not into the local system). This Active Directory user must have the necessary rights to read Active Directory properties (generally this is a default behavior, however this can be modified in Active Directory). Check whether you have a working, installed Java runtime environment by running java version via cmd.exe. If the command does not display a version number, (re)install Java runtime environment to make ShareScan client applications work properly. On Windows 7, you can use the Start Menu > Control Panel > Uninstall a program to check and update your Java version as necessary. ShareScan 5.1 includes Java Runtime Environment 1.6 update 37; thus, if you have a newer version, no update is required. Make sure you disable local firewalls. If you do not disable the firewalls, and the Manager PC is running Windows XP SP3, you must add the ShareScanManager.exe, ShareScanAgent.exe, ShareScanAdminConsole.exe, InBoxAgent.exe, and SQLServer.exe under the Control Panel > Windows Firewall > Exception tab.

11 ecopy ShareScan Installation Guide 4 If you are planning to have firewalls enabled, leave the following ports open (between ShareScan Manager and the multifunctional device): TCP: 80, 443, 2121, 7627, 8005, 8009, 8080, 9030, , 9600, 9601, 50001, 50002, 9998, 9999 UDP: 161, 8125, 8899, 9988 If any of these ports are in use, ShareScan displays a warning. Ports in use do not block installation, but must be opened later for proper functionality Database rights If you use your own SQL server installation, ensure that you use "mixed mode" authentication (that is, SQL Server Authentication plus Windows Integrated Authentication). In case the SQL server is already installed, check if this type of authentication is in use. You can find the setting under Server Properties. For working with the ShareScan databases, you must use an account that has db_owner rights for the ecopysharescan database. An sa-level account can be used, but it is not mandatory. For more information on database rights and installation scenarios, see section User rights necessary for ShareScan database creation in this document Network Domains and Workgroups: ShareScan can be configured to run in either domain-based networks or workgroup environments. Windows 2003 or later domain environments are supported. Nuance recommends using a domain environment. Subnets and VLANs: The ShareScan Manager PC can be on different subnets or VLANs from the multifunction devices, provided that the multifunction devices can communicate with the Manager PC using an IP address. If your multifunction devices span multiple subnets or VLANs, a router is required to pass packets back and forth. However, in these situations the UDP and the SNMP based device discovery mechanisms may not be functional. Also, consider that bidirectional communication is required between the ShareScan Manager and the MFPs (meaning both the devices shall be able to send TCP messages to the Manager and vice versa), on the ports listed in section Checklist for the ShareScan Manager PC. IP Addresses: Use static IP addresses for both the ShareScan Manager PC and the MFPs. To change the IP address of the Manager PC: (a) remove all devices from the Manager, (b) change the IP address, and (c) reboot the Manager PC. If your devices require a certificate to work, the workflow changes slightly when changing the Manager IP address: (a) remove all devices from the Manager, (b) change the IP address, (c) reboot the Manager PC, d) recreate the certificate(s), and e) re-add the devices to the Manager. Gateway Address: ShareScan does not require a gateway address. Host Name: The host name must not exceed 60 characters. Device host names are resolved using DNS. This happens once you have added a device and confirmed it. If the device is not registered in the DNS, then its name in the Devices tab (Administration Console) may change after confirmation. Note that changing the host name after installation can cause licensing and database issues, and is therefore not supported. If you must change the host name, you must do a full reinstallation of ShareScan. Network Attached Storage Devices (NAS): ShareScan 5.1 supports NAS drivers and folders that are fully compatible with NTFS file system and Windows access control mechanisms.

12 ecopy ShareScan Installation Guide 5 Novell: ShareScan does not support direct communication between a ShareScan Manager PC and a multifunction device on Novell networks. However, when Novell client software is installed on the Manager PC some Connectors (ecopy Quick Connect, and the ecopy Scan to Desktop) can bridge to a Novell server. A Novell client must be installed on the ShareScan Manager PC if Novell authentication of Scan Inboxes is required. The ecopy Connector for LDAP/SMTP requires a Novell client to work properly with Session Logon. Local Security Policy: In order to use the Administration Console on the ShareScan Manager PC, you require local administrator-level credentials. ShareScan Manager cannot be installed on a Domain Controller Support information Languages ShareScan 5.1 supports the following languages: Note: English Brazilian Portuguese Dutch French German Italian Spanish This list only refers to the languages available for the user interface. For the OCR process, the language support is much wider, comprising over 100 languages Supported devices For the most current information on supported devices, go to the Support Web site. Supported backend services For a detailed list of connector-specific backend version, see section ecopy connectors in this Installation Guide.

13 ecopy ShareScan Installation Guide Installing ShareScan The following chapter contains information on the various tasks associated with installing ShareScan Basic workflow To install, configure, and license ShareScan: 1. Install the ShareScan software on a network computer. You have the option to customize the database installation. 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 Clientside installation chapter of this guide). 3. Start the Administration Console. 4. Add licenses, add devices (if they do not appear automatically on the Devices tab), and/or set up scanners. 5. Install and configure Services, Connectors, and Devices. When you open the Administration Console, the Welcome page displays a list of the main tasks that you can perform, in the recommended configuration sequence: Services, Connectors, and Devices. For in-depth information about configuring and managing the Services, Connectors, and Devices that ShareScan uses, refer to the ShareScan Help. To access the Help, click F1 or click the Help button that is located in the upper-right corner of the ShareScan Administration Console Installing ShareScan Use the ShareScan installation program to install the software components on a network computer. Notes: When running Windows 7, Windows Server 2008 R2 or Windows Server 2008, ensure that the.net Framework 3.5 core feature is set to Enabled. You can do this via Control Panel > Turn Windows features on and off. ShareScan is only compatible with the Apache Tomcat version included in the installation program. If you have Apache 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 the Use port 80 and 443 as alternatives for incoming connections option is unchecked in Skype. Ports to be left open Ensure that the following ports are left open: TCP: 23, 80, 443, 2121, 7627, 8005, 8009, 8080, 9030, 9600, 9601, 50001, 50002, 9602, 9998, 9999 UDP: 161, 8125, 8888, 8899, 9988, 9999 To install ShareScan: Follow these instructions when installing ShareScan.

14 ecopy ShareScan Installation Guide 7 Notes: Installing ShareScan to folders specific to an individual user's profile (My Documents, for example, or Documents and Settings on older systems) is NOT advised. When upgrading existing ShareScan versions using the relevant Upgrade options of the installer, ShareScan 5.1 always performs a complete installation; you can only customize the installation location and database access credentials in such cases. 1. Ensure that you have the latest system updates on your machine and that Automatic Windows Updates are turned off. If you are planning to upgrade from a previous ShareScan version in a multi-manager environment, stop ALL Managers for the duration of the upgrade to avoid database conflicts. Start the Manager service on a particular server connecting to the shared database upgraded to version 5.1 only after upgrading ShareScan on that particular server version to ShareScan If you are planning to export profile information in a multi-manager environment during the installation process, start the ShareScan Administration Console, and use the Remote Management function to see if you have any unused Manager data (for example, due to a changed IP address). If you have such data, insert the ShareScan installation medium in the drive, browse to the Tools folder, and launch the ShareScanTroubleshooter.exe file. You can then use the Remove unused manager data function of the Troubleshooter to remove unwanted Manager data prior to proceeding with the installation. Note that ALL Managers ever connected to the database are listed in the Troubleshooter tool, so ensure that you select the proper ones by using the IP addresses (displayed by the tool) as an identification. If you want to export profile information from a ShareScan 5 SP4 / SP5 / SP6, Nuance recommends following the export process outlined in section Exporting profiles from a ShareScan 5.0 SP4 / SP5 / SP6 manager PC, below. 3. Insert the ShareScan installation medium in the drive, and browse to the folder where the ShareScan5.1.exe is located. 4. Run ShareScan5.1.exe. 5. Choose a language for your installation via the dropdown menu. 6. Click Next. The Welcome screen is displayed. The Welcome screen offers different options, when the installer is run on a machine which has a previous version of ShareScan installed: If ShareScan 5.0 SPx is present, the following options are offered: Upgrade ShareScan 5.0 to 5.1: this option removes the older ShareScan version, then proceeds to install the new one. This option preserves configuration data. Export ShareScan 5.0 data and upgrade to ShareScan 5.1: this option allows you to export your existing ShareScan profile information, then import it into the new ShareScan 5.1 installation. This option is similar to the one above, but before starting the upgrade, it launches the Profile Export tool. The exported data can be used as a backup or it can be imported to another ShareScan 5.1 Manager. The export-import of profiles is NOT required to upgrade a specific ShareScan Manager. Note that this option is only available from ShareScan 5.0 SP4 and upward. If ShareScan 4.x is present, the following options are offered:

15 ecopy ShareScan Installation Guide 8 Upgrade ShareScan 4 to 5.1: this option removes the older ShareScan version, then proceeds to install the new one. Selecting this option does not preserve configuration data. Export ShareScan 4 configuration and upgrade to ShareScan 5.1: this option allows you to export your existing ShareScan profile information, then import it into the new ShareScan 5.1 installation. Choose this option if you want to upgrade your system with all the configuration data in place. 7. Click Next. The System Check screen is displayed. This screen provides information on any possible issues related to ShareScan prerequisites, and a brief description on how to solve those issues. If you encounter any, you must exit the installer, solve the issue, then restart the ShareScan installation. 8. Click Next and enter the Product License Key (22 characters with dashes, or 18 without dashes; the system accepts either). 9. Click Next, and select your geographic region. 10. Click Next. The End-User License Agreement (EULA) is displayed. 11. Accept the EULA, and click Next. 12. Select either Complete or Custom as the installation type. If you select Complete, the automatic full installation is performed with the following features and settings: ShareScan server 5.1 is installed SQL Server is installed On Windows Server 2008 or later, the SQL Server 2012 Express Local DB is installed (faster install) Note: As you cannot connect to this type of database engine from another PC on the network, this option is not recommended if you plan to share the database installed between multiple Managers. In that case, select the Custom installation option. On Windows Server 2003 or Windows XP SP3, the SQL Server 2008 Express R2 is installed ShareScan configuration database is created on the installed SQL Server WebClient is installed (including the Apache Tomcat server) If you are installing in a multi-manager environment, using a single, common database, you have to run the Complete install only once, for the first Manager, as doing so will create the ShareScan database. For the rest of the Managers, simply run a Custom installation, installing only the ShareScan server, and you can set them to connect to the newly created ShareScan database. 13. Click Finish when the ShareScan components are installed. You are now ready to configure a connector profile Custom installation This section outlines the process available when selecting the Custom installation option.the installation process diverges from the Complete installation outlined above after accepting the EULA. Notes: The ecopy ShareScan 5.1 Server is a required component, and is always installed.

16 ecopy ShareScan Installation Guide 9 If you install the web client, the Simulator function of the ShareScan Administration Console defaults to using the web client for the Simulator. If you want to use your ScanStation for the Simulator in this case, you must set the UseScanStationAsSimulator DWORD registry setting to 1 under HKLM\SOFTWARE\Nuance\ShareScan. 1. The Custom Setup screen is displayed. Select the program features you want to install, and click Next. Microsoft SQL Server database engine check this component if you want a local installation of Microsoft SQL Server Express. This deployment option is recommended for small-scale deployments with a single Manager. If you do not select this component, the Installer assumes you have an existing SQL Server installation either locally or on another server on the network, and you are planning to connect to that. ShareScan configuration database check this component if you want to create a ShareScan configuration database. It is necessary to select this component if you install a single ShareScan Manager or if you plan to install multiple Managers and you do not want to share the same database across them, or if you plan to have multiple Managers and you are installing the first ShareScan Manager. ShareScan Web client enable this component if you plan to use scanner devices with web browser enabled user interface. 2. Select the Destination folder for the ShareScan server and Apache Tomcat web server installation (the Apache Tomcat web server is required for ShareScan Web client). 3. Click Next. 4. Select the SQL server database engine. In Windows Server 2008 or later operating systems, the SQL Server 2012 Express LocalDB option is selected by default. On operating systems older than Windows Server 2008, the SQL Server 2008 R2 Express is offered. Regardless of the operating system and the selected SQL Server type, you can override the password of the SQL Server system administrator (that is, the sa password), by unchecking the checkbox at the bottom of the screen. If you do so, you must provide a password that complies with the password policy in effect. 5. The Database Server and Runtime Account Information screen is displayed. On this screen, the hostname or IP (and optionally, the instance name) of the SQL Server must be specified. Also, you can specify a runtime account for the configuration database. 6. Click Next. A summary of the set options is displayed. 7. Check the information, and click Install to proceed. 8. Click Finish when the ShareScan components are installed Creating A ShareScan Configuration Database If you opted to create a ShareScan configuration database, you need to specify a user account that is used for database creation. You can do so on the Administrative Credentials for Database Creation screen. The screen is displayed after the Database Server and Runtime Account Information screen. 1. The Custom Setup screen is displayed. Select the program features you want to install, and click Next. For a detailed description of the options, see above. 2. Select the Destination folder for the ShareScan server and Apache Tomcat web server installation (the Apache Tomcat web server is required for ShareScan Web client). 3. Click Next.

17 ecopy ShareScan Installation Guide Select the SQL server database engine. In Windows Server 2008 or later operating systems, the SQL Server 2012 Express LocalDB option is selected by default. On operating systems older than Windows Server 2008, the SQL Server 2008 R2 Express is offered. Regardless of the operating system and the selected SQL Server type, you can override the password of the SQL Server system administrator (that is, the sa password), by unchecking the checkbox at the bottom of the screen. If you do so, you must provide a password that complies with the password policy in effect. 5. The Database Server and Runtime Account Information screen is displayed. On this screen, the hostname or IP (and optionally, the instance name) of the SQL Server must be specified. Also, you can specify a runtime account for the configuration database. 6. The Administrative Credentials for Database Creation screen is displayed. The credentials entered on this screen are required when installing or upgrading the database. The information is not stored, it is only required during the installation or upgrade process, for the database connection. The following options are displayed: The default sa account and the default password used by ShareScan The Windows identity of the user running the ShareScan installer Specifying a user ID and the corresponding password. (SQL Server authentication). This can be an sa account with the corresponding password, or it can be a completely different user ID that is valid on the SQL Server having the proper rights for the ShareScan database creation. 7. Click Next. A summary of the set options is displayed. 8. Check the information, and click Install to proceed. 9. Click Finish when the ShareScan components are installed User Rights Necessary For ShareScan Database Creation This section lists the supported scenarios, from the least restrictive to the most restrictive: The provided administrative account has SysAdmin SQL Server role, like sa Note: In 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. The provided administrative account has dbcreator and securityadmin roles on the SQL Server These rights are enough to create both the ShareScan database and the login ID of the runtime account. If you are connecting to a corporate database server, and your database administrator is not providing you the credentials of the sa account, then the database administrator needs to provide another account for the ShareScan database installation (practically with lower privileges), having the dbcreator and the securityadmin roles. This administrative user will be a db_owner on the created ecopysharescan database.

18 ecopy ShareScan Installation Guide 11 If security policy is stricter, and the administrative account only with dbcreator role is possible to use In this case, the login ID in SQL Server for the ShareScan runtime account must be created by the database administrator manually. This manually created SQL Server login ID must be used on the Database Server and Runtime Account Information screen of the ShareScan Installation Wizard. This manually created SQL login ID needs to have a public server role and it is not required to have it mapped to any database (it will be mapped to the ecopysharescan database with a minimal 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. The most restrictive environment The most restrictive scenario (from the point of view of database access) ShareScan installer supports is similar to the one directly aboe, with the following additional restrictions: The database administrator must create the empty ShareScan database named as ecopysharescan An account must be provided (on the Administrative Credentials for Database Creation screen) to enable the creation of the ShareScan database content for this, the account needs to be a db_owner on the empty ecopysharescan database The account is not needed to have neither dbcreator nor securityadmin rights. In any of the above cases, the Installer Wizard checks the server connection and the provided credentials, and it also checks if the accounts or users provided have the necessary rights granted. If the user rights are not set properly, the corresponding error message is displayed. On the Administrative Credentials for Database Creation screen you can select an option when the database creation is performed in the name of the Windows user currently running the ShareScan installer. In case of a centralized corporate database server, this option allows the database administrator to use a Windows (domain) account as the database creator, using any of the above options according to the security policy in place. Note: The runtime account ShareScan uses still needs to be a SQL Server login ID. If the IT security policy does not allow to use SQL Server authentication (with the SQL Server login ID and password), but forces Windows Integrated Authentication, look up the ecopy Knowledge Base for instructions on setting up the system for that type of operation Installing Only The ShareScan Server This is the case when someone installs a Manager into a system which already has an 5.1 database, or a multi-manager clean installation, where the database is already installed. Or, in case of an update, one of the Managers has been updated already, and the database installation / update option was selected during that installation. In this case, it is not necessary to update the shared database again; though performing the database update more than once causes no issues. 1. The Custom Setup screen is displayed. Deselect all options. The ecopy ShareScan server is always enabled. 2. Select the Destination folder for ecopy ShareScan.

19 ecopy ShareScan Installation Guide Click Next. The Database Server and Runtime Account Information screen is displayed. On this screen, the hostname or IP (and optionally, the instance name) of the SQL Server must be specified. Also, you can specify a runtime account for the configuration database, by selecting the Use the following credentials option, and entering the relevant username and password. You need to specify user name and password only when the ShareScan configuration database was created with a custom runtime account and password. 4. Click Next. A summary of the set options is displayed. 5. Check the information, and click Install to proceed. 6. Click Finish when the ShareScan components are installed Maintenance After the successful installation of ShareScan 5.1, relaunching the installer displays the Maintenance screen, where the following options are available: Export ShareScan 5.1 profiles Selecting this option starts the profile tool in Export mode; you can export your existing ShareScan 5.1 profiles. Import ShareScan 4 configuration data Selecting this option starts the Data Upgrade Tool, which allows you to migrate ShareScan 4.x information (profiles, system data) to your ShareScan 5.1 installation Import ShareScan 5.0 or 5.1 profiles Selecting this option starts the profile tool in Import mode; you can import ShareScan 5.x profiles to your installation. Modify Allows you to install or uninstall the ShareScan Web client (and the Apache Tomcat server). Repair Selecting this option repairs all ShareScan components (Server, WebClient, database) using their respective installers. Note that if you used the Add/Remove Programs on the Windows Control Panel to remove either the ShareScan Help or the ShareScan Web Client, you CANNOT use the Repair function to reinstall those. To reinstall either of these components, you have to launch the.msi installer from the relevant, component-specific subfolder of the installation media. Remove Removes all ShareScan features (Server, WebClient). The so-called dependency packages (SQL Server, Apache Tomcat,.NET runtimes, and so forth) can be removed from the Programs / Features manager of Windows. Note that if you installed ShareScan 5.1 over an existing ShareScan version, removing ShareScan 5.1 DOES NOT bring back the previously existing ShareScan version! Removing the WebClient feature of ShareScan also removes the Apache Tomcat server Upgrading profiles ShareScan 5.1 allows you to migrate profile and system data from existing 4.x versions to the new installation. You can do this by running the Data Upgrade tool. The tool is included in the ShareScan installer, so if you are installing over an existing version, you simply select the relevant options during the installation process (the relevant steps will be described below, and are also listed in the ShareScan installation procedure description, here).

20 ecopy ShareScan Installation Guide 13 If you are installing on a PC that does not have ShareScan installed, and want to migrate your existing profiles to the new PC, you can run the Profile Migration tool separately on the old PC. The tool can be launched separately from the installer, by starting ShareScanDataUpgradeTool.exe (located in the root directory of the ShareScan installation directory; by default, under Program files\nuance\sharescan5.1\server) Profile migration during installation If you install ShareScan 5.1 over an existing version, you can migrate your connector profile and service information during the installation process Note: 1. Run the ShareScan installer. The program automatically detects the existing ShareScan 4.x installation, and allows you to start the Data Upgrade Tool by clicking Export ShareScan 4 configuration and upgrade to ShareScan 5.1. For a more detailed description of the ShareScan installation process, see here. 2. The Data Export screen is displayed. The tool automatically locates your existing profiles, as well as the existing ShareScan version. Select a location where you want to save the.zip file containing the profiles. 3. Click Start to create an encoded.zip file from them. When the.zip file is created, click Finish to close the tool, and return to the ShareScan installation process. 4. When the ShareScan installation is finished, you can restart the Data Upgrade tool in Import mode. On the Data Upgrade screen, wait until the tool finishes checking the prerequisites, and click Next if all items are marked green. Note that Autosync must be TURNED OFF for the duration of the import operation if more ShareScan Managers connect to the same ShareScan database. 5. Browse to the location of the.zip file containing the profiles. 6. Click Start. The content of the.zip file is expanded to a temporary folder. Click Next. Note that import is NOT YET PERFORMED at this stage! 7. Select the connectors for which you want to perform the import. Click Next. 8. Check Migrate system profile if you want to import the devices and service settings data as well as the previously-imported connector profile information. Importing the Bates profile is only possible if the Migrate system profile checkbox is marked (this is automatically done by the system), and the profile existed in your exported 4.x settings. If you do not want to add devices to the new ShareScan 5.1 Manager, you can simply delete them after completing the data migration in the ShareScan Administration Console. 9. Click Start to perform the actual import. 10. The Data Upgrade Tool imports the selected profile (and if selected, service and system) information, and you can click Finish to finalize the ShareScan installation. Migrating profiles from 3.x versions is not supported Migrating profiles between PCs If you are migrating profiles between PCs, follow the steps below: 1. Ensure that the PC running Windows XP has.net 2.0 installed and enabled (the feature is automatically available from Windows XP SP2 onwards).

21 ecopy ShareScan Installation Guide 14 Note: 2. Copy the following from the PC running ShareScan 5.1 to the PC running ShareScan 4.x to the same folder: ShareScanDataUpgradeTool.exe (located in the root directory of the ShareScan installation directory; by default, under Program files\nuance\sharescan5.1\server) ShareScanDataUpgradeTool.exe.config (same location as above) SqlLocalDbManager.dll (located in the PrivateAssemblies folder of the ShareScan installation directory). You do not need to copy it with the folder structure intact, you can simply copy it next to the ShareScanDataUpgradeTool.exe. If localized versions are needed, you must also copy the relevant language folder from the root directory of the ShareScan installation directory (for example, de-de, es-es, fr-fr, and so forth). 3. Start the ShareScanDataUpgradeTool.exe. 4. Select Export and click Next. 5. The tool displays the ShareScan version found on the PC, and offers a location to save the.zip file containing the profile data (you can change the location, if you want to). 6. Click Start to create the.zip file, and wait until the operation is concluded. 7. Transfer the resulting.zip file to the PC running ShareScan 5.1 via a portable media of your choice. 8. Launch ShareScanDataUpgradeTool.exe from the ShareScan installation folder. 9. Click on Data Upgrade, then click Next. Wait until the tool finishes checking the prerequisites, and click Next if all items are marked green. Note that Autosync must be TURNED OFF for the duration of the import operation if more ShareScan Managers connect to the same ShareScan database. 10. Browse to the.zip file you created on the 4.x machine. 11. Click Start. The content of the.zip file is expanded to a temporary folder. Click Next. Note that import is NOT YET PERFORMED at this stage! 12. Select the connectors for which you want to perform the import. Click Next 13. Check Migrate system profile if you want to import the devices and service settings data as well as the previously-imported connector profile information. Importing the Bates profile is only possible if the Migrate system profile checkbox is marked (this is automatically done by the system), and the profile existed in your exported 4.x settings. If you do not want to add devices to the new ShareScan 5.1 Manager, you can simply delete them after completing the data migration in the ShareScan Administration Console. 14. Click Start to perform the actual import. The data import overwrites ALL data in the database, so it is recommended to create a backup before performing the data migration Best practices The user must have administrator access to the PC to be used. The user must have a %temp directory.

22 ecopy ShareScan Installation Guide 15 The PC must have enough free disk space available; the minimum amount needed is the size of the Connectors folder. As the import process overwrites all data in the database, create a backup of your ShareScan database before you start the import process. If you want to migrate profiles from a PC running Windows XP, ensure that.net 2.0 is installed and enabled on the machine. The feature is included from Windows XP SP2 onwards Upgrading multiple ScanStations If you want to upgrade multiple ScanStations from ShareScan 5 (with or without Service Packs) to ShareScan 5.1, with minimized downtime, follow the steps below: 1. Create a backup of the production database via the Database Backup/Restore option of the ShareScan Administration Console. For more information on how the database backup of ShareScan works, consult the relevant Help topic. 2. Set up a new ShareScan Manager (RTM + SP4) installation (hotfixes are not required, if there were any deployed on the production PCs). The ScanStation client is not required to be installed. The database created with this option is used as a temporary database until all PCs in the fleet are upgraded. This ShareScan Manager can have either of the following: 1. A local SQL Server 2008 Express database (installed by ShareScan installer) 2. A new named instance on the same SQL server where the currently used shared database exists. The new instance on the SQL Server must to be created by the database administrator. 3. Using the backup database file created in Step 1, perform a Restore of the database. It is recommended to do so by running the db_restore.cmd script from the <Program Files>\Nuance\ShareScan5\Server\Tools\Database folder. The syntax of the script is as follows: db_restore.cmd <SQLSERVER> sa <sa password> <BackupFilePath> ecopy <password of the ecopy user> For example, using the default ecopy credentials, the script syntax looks like this: db_restore.cmd sa e+c0py2007_@x "c:\backup\sp4dbbackup.bak" ecopy e+c0py2007_@x Notes: This script can be executed on the newly installed ShareScan Manager PC, but in this case, you need to move the SQL database backup file from the SQL Server to the same PC. If the new (temporary) database was created as per Step 2/2, and the database administrator does not want to handle sa credentials, the backup can be restored in the new temporary SQL Server instance. In this case, the ecopysharescan-restore.sql SQL script is required, as opposed to simply restoring the database backup, as this script performs some necessary operations that are required for the successful restore operation. 4. At this moment, the newly set up ShareScan Manager has a functional copy of the production database. Note: your license(s) appear at this point with a Hardware fingerprint mismatch message, which you can ignore for the time of the upgrade process, as ShareScan is still fully functional for thirty (30) days.