Pre-Installation Checklist v5.0

Transcription

1 Pre-Installation Checklist v5.0 November 2010

2 Table of Contents Introduction 3 Network infrastructure 4 ShareScan Manager PC 5 Devices 7 ecopy Connectors 8 Network Communication 13 Document Management Systems 15 Other Information 17 2

3 Introduction This document is used to gather data about your environment to ensure a smooth product implementation. The document is broken into three sections: Network Communication section describes network requirements for setting up the scanning solution for multifunction devices; ShareScan uses TCP ports for communication between the client application running on the multifunction device and the server application on the PC running the ShareScan Manager. ShareScan Manager PC section gathers information for each computer running the Manager. The Devices section gathers information about each device you plan to use with ShareScan. Network infrastructure section gathers information about the domain or workgroup where the product will be installed. For more detailed information about installing ShareScan, refer to the Share- Scan Installation and Setup Guide. 3

4 Network infrastructure Database rights: install/configure/maintain If ShareScan deploys database, either locally or remotely, the ShareScan software (through an sa account) has full rights/access. If ShareScan has to use an existing SQL database: It needs an sa access during installation only (during usage a user with less privilege is used). If we cannot get an sa account from the customer, customer IT department must create a named instance of the SQL Server. Our database will use this named instance with the sa account. Named instance server cannot be merged with original data base and must have own backup scripts, security settings, users, and so on. Database must be in the same domain as the ShareScan Manager. 4

5 ShareScan Manager PC Each site requires at least one PC to run the ShareScan Manager and each Manager can support multiple multifunction devices. The ShareScan Manager must be installed on its own designated machine. Windows Updates: Make sure you have the latest updates installed on your machine and that you turn off Automatic Updates during installing ShareScan. Hardware Only a single NIC card is supported by ShareScan. All the other cards, if any, must be disabled. Operating Systems The following operating systems are supported by ShareScan 5.0: Windows XP SP3 32-bit Windows Vista SP2 32-bit / 64-bit Windows 7 32-bit / 64-bit Windows Server 2003 SP2 32-bit / 64-bit Windows Server bit / 64-bit, Windows Server 2008 R2 On Windows XP and Vista make sure you have the latest version of.net Framework 3.5 installed. The ShareScan Administration Console and the ShareScan Manager cannot be installed on Linux, Solaris or Macintosh operating systems. Memory Configuration 1 GB physical memory (minimum); 2 GB recommended. 5 GB disk space (including SQL server and prerequisites). The ShareScan Manager is only supported on a dedicated machine. During the ShareScan install process, a customized Apache Tomcat web service will be installed. The ShareScan Manager is only supported with this customized version of Apache Tomcat web service. This means that you cannot use an already existing Tomcat install because the ShareScan installer performs different customization and installation steps, such as generating SSL certificate and similar. Drive Type The drive type must be IDE or SCSI. Drive Format ShareScan requires an NTFS format. 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 ShareScan Manager 5

6 PC some ShareScan Connectors (ecopy Quick Connect, ecopy Scan to Desktop, and the ecopy Connector for LDAP/SMTP) 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. Domains and Workgroups ShareScan can be configured to run in either domain-based networks or workgroup environments. Local Security Policy Log on locally rights need to be assigned to all domain users. ShareScan requires that the ShareScan Manager PC login credentials used during normal operation must be those of a local Administrator in order to run the ShareScan Administration Console. ShareScan Manager cannot be installed on a Domain Controller because of impersonation. Local Firewall It is recommended that firewalls are disabled on the ShareScan Services Manager PC. If you choose to enable a firewall, make sure the required ports are open (see Network Communication section) for communication between the Services Manager PC and the multifunction devices. If the Services 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. Virtual Environments ecopy ShareScan v5.0 supports VMWare ESX v4 and the ESX Server portion of VSphere v4. 6

7 Devices Models Visit for information on currently supported multifunction devices. IP Address Static IP address is required for both the multifunction devices and the ShareScan Manager PCs. DHCP is not supported, except for the ScanStation configurations if no other device than the ScanStation client is attached to the Manager serving the ScanStation client. If the (static) IP of a ShareScan Manager PC has to be changed, then a reboot (that will cause the services to restart) is required. Also all the devices must be removed before the IP change and re-added after the IP change. Gateway Address ShareScan does not require a gateway address. DNS Server ShareScan uses IP addresses to register and to keep track of the multifunction devices. ShareScan uses the DNS server to keep the device (host) names synchronized (these device names are stored in the ShareScan configuration database). However, if a DNS server is not functional or cannot be accessed, some operations like device discovery or the Confirm function in the ShareScan Administration Console may take long time to complete. Host Name The host name must not exceed 60 characters. 7

8 ECopy Connectors ecopy Connector for Microsoft Exchange (Mail and/or Fax) ShareScan v5.0 is an Outlook client installed on the Manager PC if the connector is communicating with the Exchange server via MAPI protocol. At the time of configuration, the end user should be prepared to provide a user name, password, Exchange server name, and domain name and the general domain environment for a valid Outlook user. Blank passwords and special characters are not supported by ShareScan. For information on supported Exchange and Outlook versions, go to or and search for ShareScan v5 Compatibility Matrix. Best practice: Have the Outlook credentials match the PC login credentials. ecopy recommends creating a generic ShareScan Outlook account for use by ShareScan. If configuring the Exchange connector using EWS or WebDAV protocols, the Exchange server SSL certificate must be installed on the PC running ShareScan Manager. Certificates should be installed to the Trusted Root Certification Authorities on the Local Computer. ecopy Connector for Lotus Notes (Mail and/or Fax) ShareScan v5.0 requires a Notes client version 8.0 or higher be installed on the Services Manager PC before installing ShareScan. At the time of configuration, the end user should be prepared to provide an Active ID File, user name, password, and Domino server name. If Send messages from personal mail account is not enabled, all s will be sent from the user name and password supplied for configuration purposes. Before sending from a personal Lotus Notes account, the ecopy Mail pass-through database on a Domino HTTP server must be configured first. For information on supported Notes and Domino versions, go to or and search for ShareScan v5 Compatibility Matrix. Best practice: Have the Notes credentials match the PC login credentials. ecopy recommends creating a generic ShareScan Notes account for use by ShareScan. ecopy Connector for LDAP/SMTP (Mail and/or Fax) You will be prompted to enter the following information when configuring the ecopy Connector for LDAP: User name, password and IP address, DNS name or URL for the directory being used, search criteria for users and recipients, LDAP Attributes, LDAP port number, and Base DN of the base or root directory in which to search. For configuring the ecopy Connector for SMTP, you will need to enter the SMTP server IP address or DNS name that will be used for outgoing messages, user name and password, and the SMTP port number. Best practice: Have the LDAP and SMTP credentials match the PC login credentials. ecopy recommends creating a generic ShareScan account for use by ShareScan. Scan to Desktop 8

9 Scan to Desktop involves several different components to enable users to scan and send documents to a designated network folder location for modification and storage. A Scan Inbox subfolder may be added to existing network home directories or the ShareScan software can create Scan Inbox folder locations. The Inbox Root (Inbox Management directory) stores the user list (userdirs.txt) that indicates which users have scan inboxes using Scan to Desktop and if ShareScan has created Inbox folders, these folders would also reside under this directory. For detailed information on configuring Scan to Desktop, see the ecopy Configuration Guide that comes on the CD found in the ShareScan media kit. The Configuration Guide is also available through ShareScan online help. Inbox Root Directory The Inbox Root Directory can reside on the ShareScan Services Manager PC or on a network server. If the directory resides locally, it must be configured as a share on an NTFS drive. If the directory resides on a network server, it must be configured as a share on an NTFS drive or on a NetWare drive. The Inbox Root Directory should not be pointing to a user s home directory. Choose the Scan to Desktop Home Directory option in the connector instead. Network home directories configured through a login script are not supported. ShareScanAdmin Group An Administrative Group must be used to implement the required security. In previous versions of ShareScan, this group required the name ShareScanAdmin. This Administrative Group can now have any name; however, if multiple Services Managers are pointing to the same userdirs.txt file in the lnbox Root Directory, the group to which the service account belongs must be identical on all those Services Managers. The group used must be created on the domain controller for domain-based networks, on NDS for Novell networks, or on the local machine if the customer is running in a workgroup environment. ShareScan uses this group when assigning permissions to the inbox Root Directory and scan inboxes and requires Full Control. Permissions assigned to the directory are as follows: Windows (NTFS) Administrators Full Control. Domain Administrators Full Control (Not used in workgroup configurations) ShareScanAdmin Full Control. Inbox Owner Read or Delete. Novell (Netware) Administrators Full Control. ShareScanAdmin Full Control. Inbox Owner Read or Delete. An account for an administrative user should also be created and added to the Administrative group to be used as the Service Account. This user should have a standard user profile with a user name and password. If running in a workgroup environment, a local account should be created for each Scan to Desktop user on the PC where the Inbox location resides. ecopy Quick Connect 9

10 When selecting a network location as a Quick Connect destination, make sure that the desired users have access to the folder or folders being used as storage options. Databases See the ecopy ShareScan v5.0 Software Compatibility Matrix for additional information. For additional information on supported configurations of the ecopy Quick Connect to Database functionality, reference the Quick Connect Database Recommended Usage document available for download from espn. ecopy Connector for OpenText Fax Server (RIghtFax Edition) The administrator will be prompted to enter a valid RightFax or NT Authentication user name and password. Blank passwords are not supported by ShareScan. The RightFax server name will also need to be entered. Delegation privileges, phone books, cover sheets, and billing codes must be configured on the RightFax server in order to be utilized by the ecopy Connector for RightFax. For information on supported RightFax versions, go to or and search for ShareScan v5 Compatibility Matrix. If Send from personal account is not enabled, all faxes will be sent from the user name and password supplied for configuration purposes. NT Authentication functionality requires the Services Manager PC to reside on the same domain as the RightFax server. Best practice: Have the credentials match the PC login. ecopy recommends creating a generic ShareScan account for use by ShareScan. Scan to Print In order for a printer to be configured for use with Scan to Print, the appropriate print driver must be installed on the Services Manager PC. ecopy Connector for Microsoft SharePoint The administrator should enter a user name and password that will enable the ability to browse to all destination locations, display all index fields, and store documents if Login As authentication is used. The following are the installation prerequisites: If you are using SharePoint 2003: Microsoft SharePoint Portal Server 2003 or Microsoft Windows SharePoint Servers If you are using SharePoint 2007: Microsoft Office SharePoint Server (MOSS) 2007 or Windows SharePoint 2007 Services. If you are using SharePoint 2010: Microsoft SharePoint Server If your company uses a secure SharePoint site, you must install an SSL certification on the ShareScan server. ecopy Connector for EMC Documentum 10

11 The ecopy Connector for EMC Documentum uses the Documentum Foundation Classes (DFC) to connect to the Documentum Server. While all of the necessary DFC files are included with the Connector, DFC needs to be configured as part of the installation process. For Configuring DFC the following information is required: The Primary Connection Broker Host Name: Broker Server Name Port number: Default = Repository Name. Login Name and Password to that Repository. The ecopy Connector for EMC Documentum will then need the Repository chosen from the drop down menu, as well as a User Name and Password. In the Connector Administration, all Repositories available through that Connection Broker will now be available. The administrator should then enter a user name and password that will enable the ability to browse to all desired destination locations within the selected repository and store documents if Login As authentication is used. If you are using a firewall, you must add SQLSERVER.exe and UDP port 1434 to the exceptions list. Connection Broker In previous versions of Documentum was named DocBroker. Connection broker is a service which is running on Documentum server and it is connection point from client. Repository - Previous versions of Documentum were named Docbase. It is document database in the Documentum server. The Connection broker establishes the connection between connector and Repository. ecopy Connector for Autonomy imanage WorkSite The administrator should enter a user name and password that will enable the ability to browse to all destination locations, display all index fields, and store documents if Login As authentication is used. For more information on Impersonation passwords, the administrator should refer to the WorkSite Documentation. ecopy Connector for Livelink ECM - edocs DM Before installing the Connector, the Administrator must install the Windows Explorer DM Extension software for Livelink ECM - edocs DM on the ecopy ShareScan Services Manager PC. Then run the DM Connection Wizard. Both versions of the DM Extension software include the required DM API and the DM Connection Wizard. For instructions about installing the DM Extension software, see your edocs DM documentation. Note the following: Install the Windows Explorer DM Extension component only (under "Optional Components"). You must select "Intranet Mode" (the default mode). Do not select "Internet Mode". After installation, launch the DM Connection Wizard and enter the name of your DM server. The ecopy ShareScan Services Manager must be on the same domain as the DM server, for the DM Connection Wizard to establish a connection with the server. 11

12 The Administrator will need to enter a valid edocs DM user name and password that has the ability to store documents if Login As authentication is used. ecopy Connector for Livelink ECM Document Management The administrator should enter a user name and password that will enable the ability to browse to all destination locations, display all index fields, and store documents if Login As authentication is used. The ecopy Connector for Livelink ECM uses Livelink API (LAPI) and supports TCP/IP direct connections with native Livelink authentication. It does not support HTTP or HTTPS connections or non-native authentication methods. Native authentication using LAPI supports Livelink authentication, NTLM authentication, and LDAP authentication. The Livelink server is responsible for managing the authentication settings and the Connector works transparently with the selected authentication mode. For authentication methods outside of these constraints, refer to your ecopy Technical Consultant. The Administrator will need to provide the following information to properly configure the Connector: LiveLink Database name. LiveLink Server name. The server entered in the Livelink Server field must be on the same network (LAN) or connected via a VPN (WAN) as the Services Manager. It can not be a web-only connected server. The Livelink Connector does not communicate over HTTP or HTTPS, instead it uses TCP/IP and LAPI over the specified port. Even if port 80 is put into the port field, it will not force the connector to communicate over HTTP or HTTPS. Port: This is the port that the LiveLink Server is communicating on. The default is Username and Password: This is a user account that the connecter uses to test the connection and get a list of usernames that the UI presents to the user to select. The Livelink Database information can be found on the Livelink Administrative Site under the Database Administration section. 12

13 Network Communication This section applies only when communicating between a PC running ShareScan Manager and the multifunction devices. Internal traffic between the Manager and the multifunction device is minimal. Ports The following ports should be left open: TCP: UDP: 80 - Used by Tomcat web server for Web clients (Konica Minolta, Xerox, and Canon ScanFront) not using HTTPS Standard HTTPS port. Used by Tomcat web server for Web clients (Konica Minolta, Xerox, Canon ScanFront) when using HTTPS, Used only by Xerox devices Used by Tomcat Used by Tomcat Used by Tomcat for the Simulator TCP port used by the ShareScan Manager to send messages to the clients. In case of Ricoh and Canon MEAP, these are sent directly to the device; in case of web clients (Xerox, HP, Konica Minolta, and Canon ScanFront) these messages are sent to the Tomcat Web server on the same machine For internal usage (only on the PC where the ShareScan Manager runs); the OCR and document creation worker processes and the Manager communicate using these ports Main ShareScan Manager communication port. TCP port used by the ShareScan client to send messages to the ShareScan Manager. In case of Ricoh and Canon MEAP, these messages are sent directly from the device; in case of web clients (Xerox, HP, Konica Minolta, and Canon ScanFront) these messages are sent by the Tomcat Web server on the same machine Communication port used by the Agent Service (Administration Console and Agents on other machines are connecting to this) Used only by Konica Minolta devices Standard port of SNMP protocol (device discovery) Used by the ShareScan Manager to send the status messages that are displayed in the Administration Console and Activity Monitor, Used by ShareScan device discovery Used by ShareScan device discovery. 13

14 If any of these ports are used by other applications, ShareScan displays a warning message indicating what ports are in use. Even though the install will go through, the administration should make the appropriate changes to ensure that ShareScan works properly. Multiple or Single Domains While ShareScan supports multiple domains, a single domain is highly recommended for best performance. Multiple or Single Workgroups While ShareScan supports multiple workgroups, a single workgroup is highly recommended for best performance. 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 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 SNP based device discovery mechanisms may not be functional. Multiple network adapters in the Manager PC ShareScan 5.0 does not support multiple network adapters in the ShareScan Manager PC. 14

15 Document Management Systems EMC Documentum: edocs: EMC DFC component has to be installed before ShareScan installation. The setup of the component is available on the product installation media. It is strongly recommended that you store documents using the doctype named "dm_ document" or a customized doctype that is based on "dm_document". When the edocs DM Extension Client v SR6 or later is installed on the same computer as the ShareScan Manager (not in the same domain as the DM server), you cannot configure the ecopy connector. Default values that are assigned by the edocs DM server appear in the Client. To use a different value, you must remove the default value and then use the Search feature or the "Search while typing" option to specify the new value. If a profile for an application does not appear, contact your administrator. The application may be disabled from within the edocs DM software. Open Text Content Server: Before installing the ecopy Connector for Open Text Content Server, the Administrator must install and configure the Windows Explorer DM Extension software for Open Text Document Management, edocs Edition 5.1, 5.2, 6.0 or later or Hummingbird DM 5.1, 5.2, and 6.0 on the same PC as the ecopy ShareScan Manager. After that, run the DM Connection Wizard. Both versions of the DM Extension software include the required DM API and the DM Connection Wizard. For instructions about installing the DM Extension software refer to your edocs documentation. If the Open Text Content Server environment requires a user to change password at the next logon to the system, the user must change the password at the workstation before using ShareScan. If the user does not do this, the system will display a message that the password has expired and that the user will not be able to store the scanned documents. Microsoft SharePoint: Dates are validated by the client regional settings; invalid date formats are not accepted. The connector does not fully support storing to workspaces. Storing to an Attendees location is inconsistent and may result in failure to store the scanned document. The All Day Event, Recurrence, and Workspace checkboxes will not appear in the calendar list. imanage WorkSite: When you use Novell Trusted Login, make sure that the Novell Client configuration on the computer running the ShareScan Manager includes a value for the "Preferred Server" option. If you leave this field blank or you enter an incorrect value, users will not be able to store scanned documents. 15

16 ecopy Quick Connect: To deliver scanned documents to an Access database, you must disable UAC. Quick Connect does not support the sending of scanned documents to a Microsoft Office Access 2007 database. Quick Connect supports Oracle Database 10g. When you install Oracle Client 10g, select the Custom Installation option and then make sure that you select the Oracle Provider for OLE DB component. This enables Quick Connect to connect to the Oracle database and store scanned documents and other information. 16

17 Other Information DNS Host names are resolved using DNS. LDAP ShareScan v.5.0 requires a server supporting LDAP v3 protocols if using LDAP for or fax. Domains ShareScan v.5.0 supports Windows 2003 or later domain environment. Network Attached Storage Devices (NAS) ShareScan v5.0 does not support NAS devices. Clusters ShareScan v5.0 can run in a cluster environment but is not cluster aware. To access Install Guides and Release Notes for ShareScan, you need to have a PDF Reader application installed on your system. 17