Document Imaging Solutions AutoStore 7.0 SP4 Installation Guide Version 7.0 SP4
Nuance AutoStore 7.0 SP4 Installation Guide Document Revision Date Revision List March 10, 2015 AutoStore 7.0 December 14, 2016 Updated installation instructions May 30, 2017 AutoStore 7.0 SP3 June 23, 2017 AutoStore 7.0 SP4 Symbols Used In This Guide The accompanying text provides cross-reference links, tips, or general information that can add to your understanding of a topic. The accompanying text provides key information about a step or action that might produce unexpected results if not followed precisely. Read the acocompanying text carefully. This text can help you avoid making errors that might negatively affect program behavior. 2017 Nuance Communications, Inc. All rights reserved All rights to this document, domestic and international, are reserved by Nuance Communications, Inc. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise) without prior written permission of Nuance Communications, Inc. 2
Trademarks Nuance, AutoStore, AutoCapture, Output Manager, QuickCapture, and Business Connect are trademarks or registered trademarks of Nuance Communications, Inc. All other brands and their products are trademarks or registered trademarks of their respective holders, and should be noted as such. 3
Contents Installation of AutoStore 7.0...5 Prepare to install AutoStore...6 System requirements...6 Download software... 8 Turn off Microsoft Windows Firewall...8 Install AutoStore... 10 Upgrade a previous installation of AutoStore... 11 Upgrade checklist... 11 Upgrade AutoStore...12 Upgrade with expired licenses... 12 License AutoStore... 16 AutoStore tutorial... 24 Communication port reference... 32 Troubleshooting tips... 41 4
Installation of AutoStore 7.0 This guide describes options and procedures to install or upgrade AutoStore server and how to license installed components. The installation installs the AutoStore server and workflow components for capturing, processing, and routing of documents within an enterprise. Client applications included with the installation can be installed separately on the server on distributed to install on user workstations. During installation of the server, you can accept the default settings or select to install individual components. After installation of the server, availability of installed components depends on licensing. In This Guide Section Description Prepare for Installation Describes how to prepare a computer for AutoStore: System requirements Download software Turn of Microsoft Windows Firewall Install AutoStore Steps through a new install of AutoStore 7.0. Upgrade AutoStore Describes steps to upgrade from a previous version of AutoStore. License AutoStore Describes how to license AutoStore server and its components. AutoStore tutorial Describes how start the AutoStore Process Designer and build and run a simple workflow. Communication port reference Provides general information on ports and protocols for AutoStore components. Troubleshooting tips Provides tips to solve known issues. 5
Prepare to install AutoStore Depending on your requirements, the AutoStore 7.0 setup application installs a new instance of AutoStore, upgrades an existing instance, or provides maintenance options. Topics in this section address important considerations for the computer where AutoStore will be installed. Before you install AutoStore review the information in this section. System requirements This topic describes system prerequisites before you run setup for AutoStore 7.0. Category Requirement Processor Small deployment recommendation: Single dual core desktop CPU 2 GHz or higher Medium deployment recommendation: XEON or Opteron CPU 2MB or more 2nd-level cache, 1 or 2 CPUs/ cores Large deployment recommendation: Memory XEON or Opteron CPU 2MB or more 2nd-level cache, multiple CPUs/ cores Small deployment recommendation: 2 GB of RAM Medium deployment recommendation: 2 4 GB of RAM Large deployment recommendation: At least 4 GB of RAM 6
Category Requirement Hard disk space Small deployment recommendation: 10 GB Medium deployment recommendation: 40 GB Large deployment recommendation: 100 GB Network card NIC card Operating system Server: Windows Server 2012 R2 Standard and Datacenter Windows Server 2012 Standard and Datacenter Windows Server 2008 R2 Standard, Enterprise, and Datacenter Windows Server 2008 (32\64 bit) Standard, Enterprise, and Datacenter Windows 10 (32\64 bit) Pro and Enterprise * Windows 8.0 /8.1 (32\64 bit) Pro and Enterprise Windows 7 (32\64 bit) Professional, Ultimate, and Enterprise Note: Small Business Server / domain controllers are not supported for installing AutoStore. Client: Windows 7 (32\64 bit) Professional, Ultimate, and Enterprise * Windows 8.0 /8.1 (32\64 bit) Pro and Enterprise Windows 10 (32\64 bit) Pro and Enterprise For all platforms, Microsoft recommends that you upgrade to the latest Windows Service Pack and critical updates available from the Windows Update website to ensure the best compatibility and security. Installation of the latest Windows Service Pack may be required on some operating systems. * * Windows 8.0 is supported when running the latest service pack from Microsoft. 7
Category Requirement Software Internet browser for viewing Notable Solutions web Help: Internet Explorer 9.0 or greater Edge on Windows 10 Firefox 4.0 or greater Google Chrome 10.0 or greater Database management: Framework Microsoft SQL Server Express (32 bit) Microsoft SQL Server 2005 (32-bit) Microsoft SQL Server 2008 (32- and 64-bit) The AutoStore installation prompts to install required versions of Microsoft.NET Framework if they are not already available on a host machine. Virtualization platform Microsoft.NET Framework 3.5 Microsoft.NET Framework 4.0 Microsoft.NET Framework 4.6 This release of AutoStore has been tested for migrating virtual machines between physical servers with VMware VMotion. Remaining prerequisites are installed during the installation process. Download software A single self-extracting ZIP file contains the installation software for AutoStore and Device Registration Service. Download the executable package from the Nuance Web License Tool and double-click it to unzip the contents to a temporary location on the computer. Before installing software, review the setup.htm file from the unzipped installation package. After you expand the installation package, the AutoStore installation executable (AutoStore7SP4.exe) is located in the AutoStore Installation folder. Turn off Microsoft Windows Firewall Turn off Microsoft Windows Firewall before installing the AutoStore software and setting up your AutoStore environment. Turning off the firewall ensures that the AutoStore server can communicate with AutoStore components on the network. After you install AutoStore and set up your environment, you can turn on the firewall and coordinate with your network administrator to ensure that the firewall does not block access to the ports that the server and components use to communicate. If you cannot turn off Prerequisite for Device Registration Service. SQL Server Express is included with the AutoStore distributable as the default database server for Device Registration Service. SQL Server Express is not recommended to run in a high availability enterprise environment. 8
the firewall because of security protocols, coordinate with your network administrator prior to installation to configure port access. Refer to Microsoft Help for information on how to turn off Microsoft Windows Firewall. The Communication port reference on page 32 topic provides more information on default port assignments for network-enabled components and lists port assignments that you can modify. 9
Install AutoStore Complete the steps in this procedure for a new installation of the AutoStore software. 1. Turn on Microsoft Windows Updates to enable the installation wizard to install Microsoft Windows Identity Foundation. Tip: If the installation wizard fails to install Microsoft Windows Identity Foundation, cancel the installation, verify that Microsoft Windows Updates is turned turn on, and restart the installation. You can restore the Microsoft Windows Updates settings after installing the AutoStore software. 2. Start the installation executable file from the AutoStore installation subfolder in the installation package described in Download software on page 8. Administrator permissions are required to install AutoStore. Usually you can right-click the executable file (for example, AutoStore7.0SP4.exe) and click Run as administrator. 3. If the installation wizard prompts you to install required software, click Install. 4. After the installation wizard installs the required software, click Next. 5. Review and accept the license agreement. 6. On the Customer Information screen, type a user name and organization. 7. On the Custom Setup screen, select the AutoStore components that you want to install. Important: By default, all capture and process components are selected for installation. Route components that require client software are not selected by default. If you select a route component that requires client software, verify that the client software is on the local machine. The installation fails if you select a route component and its client software is not on the machine. 8. If necessary, change the location where the installation wizard installs the software. If you change the default location, use a location on the local machine. Do not use a location on a network drive. 9. On the Ready to Install the Program screen, click Install. In AutoStore 7.0, some AutoStore 6.0 components were moved to a Sunset category. Sunset components are listed in the product release notes. Nuance no longer releases software updates for these components, although it still supports their use with AutoStore 7.0. Sunset components are not included in the default AutoStore installation. To install Sunset components, use Software Updates in AutoStore Process Designer to download and install the updates. 10
Upgrade a previous installation of AutoStore You can run the AutoStore 7.0 installation executable to upgrade earlier versions of AutoStore 7.0 to AutoStore 7.0. To upgrade an AutoStore 6.0 server, you must first uninstall AutoStore before performing the AutoStore 7.0 installation. Refer to information in the following topics to perform an upgrade. Upgrade checklist on page 11 Upgrade AutoStore on page 12 Upgrade with expired licenses on page 12 Upgrade checklist Complete the items in the following checklist when upgrading from an earlier version of AutoStore 7.0 to AutoStore 7.0: Verify that you have administrator rights on the machine. Verify that your test and production environments satisfy the requirements described in System requirements on page 6. Important: A simple upgrade is only supported for earlier installations of AutoStore 7.0. For earlier versions of AutoStore (6 or earlier), you must first remove the earlier version of AutoStore before you install AutoStore 7.0. When upgrading AutoStore 7.0 to the latest Service Pack, ensure that all AutoStore-related processes are stopped (batch.exe, the ASGSB service, and the OmniPage OCR service have to be stopped manually) and that all AutoStore applications are closed. Verify that your license maintenance contract is current. 11
Upgrade AutoStore Complete the steps in this procedure to upgrade the AutoStore software from an earlier version of AutoStore 7.0. Make sure that you stop the AutoStore service and close AutoStore application windows as described in this procedure before you begin the upgrade. 1. Review the Upgrade checklist on page 11. 2. Open AutoStore Process Designer. 3. On the Home ribbon, click Stop to stop the AutoStore service. 4. Close the AutoStore Process Designer window. 5. Close the AutoStore Status Monitor window if it is open. 6. Install the new version of the AutoStore software as described in Install AutoStore on page 10. 7. After the install program completes, open AutoStore Process Designer. 8. On the Home ribbon, click About, and verify that the about screen shows AutoStore 7.0. 9. On the Home ribbon, click Start to start the AutoStore service. 10.On the Home ribbon, click Status Monitor to start AutoStore Status Monitor. 11.If you installed the new AutoStore software in a test environment, use your test plan to test your workflows. The evaluation license allows you to test before migrating the new software to the production environment. 12.After successful testing, migrate the new software to the production environment. 13.If necessary, license the AutoStore 7.0 components as described in License AutoStore on page 16. Note: Existing AutoStore 7.0 licenses are migrated to AutoStore 7.0 during the upgrade.. Upgrade with expired licenses To upgrade an environment with expired licenses, get a software maintenance key so you can download the AutoStore software. 1. Verify that your maintenance contract is active. 2. Type your Maintenance Contract ID and then click Get Key. 12
The Software Maintenance page appears with the Maintenance Contract ID that you entered. 13
3. Click Submit. If the Maintenance Contract ID is valid, the next page shows your unlock key. 4. Right-click the selected text and click Copy to copy the key to the clipboard. 5. Paste the key in the Unlock Key field and click OK. 14
6. Complete the procedure in Upgrade AutoStore on page 12. 15
License AutoStore This procedure explains how to license AutoStore for a new installation and an installation in an environment that has active licenses. 1. On the Microsoft Windows taskbar, click Start > All Programs > Notable Solutions > AutoStore 7 > AutoStore 7 Process Designer. 2. On the Home tab of the ribbon, click the License Manager button. On the Server tab, the AutoStore license appears as expired for a new installation: For environments that have active or expired licenses, the tab shows the licenses, their statuses, and the software maintenance status. 3. Click Create Request. 4. In the Save As dialog box, type a license file name and save the file locally. Note the file location. 16
5. Click Web License. The Nuance Web License Tool page opens in a browser. If you are a new user, continue with step 6 on page 17. If you have a user account, go to step 7 on page 18. 6. Create an account: a) Click Create account b) Enter the requested information and click Create My Account. 17
Note: Do not use free email accounts such as Hotmail or Gmail. c) In the confirmation email that you receive, click the link to confirm your account registration. If the confirmation email is not in your inbox, check your SPAM folder or junk email folder. d) Return to the Nuance Web License Tool page. 7. Enter your login credentials and click Login. 8. Choose the AutoStore 7 in the Select Product box, and click Proceed to License Activation. 18
9. Choose the license type from the License Type drop-down list box: If you choose Evaluation/Extension, click Browse and browse to the license file that you created in step 4 on page 16. Click Submit and go to 13 on page 22. If you select Production/NFR, click Browse and browse to the license file that you created in step 4 on page 16. Enter a License/Activation Number. Click Submit and continue with step 10 on page 20. 19
10.On the Product details page, specify the number of licenses and click Submit. 20
11.Click Download License. 21
12.Save the file locally and note the location of the file. 13.Open AutoStore Process Designer, and on the Home tab, click License Manager. 14.Click Load Keys and then select the location of the license file that was downloaded. 15.On the Load license keys dialog box, click OK. 22
The new license status appears. 23
AutoStore tutorial To get familiar with AutoStore, complete the following tutorial. The tutorial explains how to use AutoStore Process Designer to design a simple task that routes documents from one folder to another folder. 1. Click Start on the Microsoft Windows taskbar and click All Programs > Notable Solutions > AutoStore 7 > AutoStore 7 Process Designer. 2. If Microsoft Windows prompts you for permission to make changes to the computer, click. 3. On the AutoStore Process Designer ribbon, click License Manager to verify that the component licenses are current. If licenses are not current, review License AutoStore on page 16 or contact your Nuance sales representative for instructions. 4. Click New to create a configuration file. Within the configuration, you create a workflow process with capture and route components. Type Sample in the Name field. Use the default values for the other options. 24
5. In the Toolbox, expand Capture, Process and Route to show capture, process, and route components. 25
6. In the Capture tab, click and drag the Multi-Poll component onto the Sample configuration file workspace. 7. In the Route tab, click the Send to Folder component and drag it onto the workspace. 26
An arrow connects the components. The arrow shows the logical flow from the Multi-Poll component to the Send to Folder component. 8. Double-click the Multi-Poll component on the workspace. 9. On the Folders tab, click Add Folders. 10.Click Make New Folder, and create a folder to contain the files to be captured. 27
For this example, name the folder Capture. 11.In the next Multi-Poll dialog box that appears, clear Remember the choice, and then click No. If you click, the component captures all documents in the Capture folder and documents in subfolders. 12.Click the Configurations tab and then click the browse button ( ). 28
The Send to Folder dialog box appears. 13.Configure the Send to Folder route component: a) On the Send to Folder dialog box, click Add. b) Click the Folder Path browse button ( ). 29
c) On the Browse for Folder dialog box, click Make New Folder and make a destination folder named Route. This folder stores all documents that have been captured to the Capture folder. d) On the Configurations dialog box, use the default values. 30
14.On the AutoStore Process Designer ribbon, click Save and save the configuration file. 15.Click Start to start the AutoStore service. 16.Test the workflow by placing a file in the Capture folder. AutoStore polls the folder according to the Every interval as shown in step 4 on page 24. When AutoStore finds the file, AutoStore routes it to the Route folder. 31
Communication port reference The following tables provide general information on ports and protocols for AutoStore components. The component Help files contain information on configuring the components. Table 1: Capture Components (Table 1 of 2) Component Supported Authentication Types Supports SSL for Data Device Authentication and Images? Protocol AutoCapture Not supported Fuji Xerox AIP Microsoft Windows, Custom Script, Device HP MFP/Digital Sender (OXPd) Standard, Novell NetWare, Custom Plugin HP OXPd Standard, Novell NetWare, Custom Plugin IMAP Capture Not supported IMAP Konica Minolta ioption Microsoft Windows, Custom Script HTTPS Konica Minolta MFP Standard, Novell NetWare, Custom Plugin SOAP/XML Kyocera MFP (HyPAS) Microsoft Windows, Novell NetWare, Custom Script 32
Component Supported Authentication Types Supports SSL for Data Device Authentication and Images? Protocol Lexmark MFP Standard, Novell NetWare, Custom Plugin POP3 email Not supported SMTP Ricoh Desktop SF Standard, Novell NetWare, Custom Plugin Ricoh ESA Microsoft Windows, Active Directory, Novell NetWare, Script, Script (No Prompt) RightFax Capture NT Authentication The component relies Native on the API. It does not control communication protocols and ports. Refer to the vendor documentation for more information. Samsung Microsoft Windows, Custom Script No HTTP Samsung Smart UX Microsoft Windows, Custom Script Sharp MFP (OSA) Microsoft Windows, Novell NetWare, Custom Script No SMTP Capture Not supported No Limited by IP address Toshiba Unified Client Microsoft Windows, Custom Script No Web Capture Integrated Windows, Active Directory, LDAP, Custom Script Integrated Windows, Active Directory, LDAP, Custom Script Xerox EIP Connect Microsoft Windows, Novell NetWare, Custom Script No, Device Xerox WorkCentre Pro Not supported No Native Device Output Manager Capture 33
Table 2: Capture Components (Table 2 of 2) Component Device Display Menu Protocol Device File Transport Protocol Default Port Communication Modifiable? Port Numbers Required Device Components and Notes AutoCapture 8085 Client Client communicates with AutoStore server. Fuji Xerox AIP FTP Web server: 3242 FTP: 3281 HP MFP/Digital Sender (OXPd) HP OXPd HTTP: 3233 No HTTPS: 3234 HTTP: 3233 No HP OXPd package No applet HTTPS: 3234 IMAP Capture Not supported IMAP 143 SSL: 993 Konica Minolta ioption FTP/WebDAV Web server: 3348 FTP: 3281 Application OpenAPI : 13351 Authority OpenAPI :13352 WebDAV: 13391 Konica Minolta MFP SOAP/XML FTP/WebDAV 50001 SSL: 50003 34
Component Device Display Menu Protocol Device File Transport Protocol Default Port Communication Modifiable? Port Numbers Required Device Components and Notes Kyocera MFP (HyPAS) HTTP: 3250 Application package Lexmark MFP HTTPS: 3251 3233 The application package is distributed with the component and is required to communicate with the AutoStore server. SSL: 3234 Output Manager Capture Net.Tcp 8064 The application package is distributed with the component and is required to communicate with the AutoStore server. It is a signed JAR file. POP3 email Not supported SMTP 110 Not applet Ricoh Desktop SF 3233 The application package is distributed with the component and is required to communicate with the AutoStore server. It is a signed JAR file. SSL: 3234 35
Component Device Display Menu Protocol Device File Transport Protocol Default Port Communication Modifiable? Port Numbers Required Device Components and Notes Ricoh ESA 8084 Xlet Java Xlet VM card with AutoStore Xlet on the device for communication with the AutoStore server. RightFax Capture Not supported Native Refer to RightFax documentation for more information. No Samsung HTTP FTP/WebDAV Web application: 3349 FTP port: 3281 WebDAV port: 13392 Samsung Smart UX 3300 Sharp MFP (OSA) FTP 3240 SMTP Capture Not applicable No applet IIS web application connects to the AutoStore web service. The device connects to the IIS web application. SMTP 25 Toshiba Unified Client 3310 Web Capture 3290 No applet 36
Component Device Display Menu Protocol Device File Transport Protocol Default Port Communication Modifiable? Port Numbers Required Device Components and Notes Xerox EIP Connect FTP/SMB 3241 No applet Xerox WorkCentre Pro FTP/SMB IIS web application connects to the AutoStore web service. The device connects to the IIS web application. FTP/SMB 21/SMB FTP Port - No applet Table 3: Additional Components Component Protocol Autonomy WorkSite 9 The component relies on the API. It does not control communication protocols and ports. Box HTTPS d.3 Refer to d.3 vendor 3400 documentation for more information. Y Datacap 8.1 HTTP and HTTPS for communicating with the server. HTTP: 808 Y, DFC : No default Documentum Default Communication Port Numbers 443 Port Modifiable? N HTTPS: 443 Y DFC: 1489 DocuShare HTTP on IIS: 80 Y HTTP on Tomcat: 8080 HTTPS: 443 37
Component Protocol Default Communication Port Numbers Port Modifiable? DocuWare Native, Native: Refer to Native: N DocuWare vendor : Y documentation for more information. : No default Dropbox HTTP and HTTPS for the authorization service and communicating with the DMS. Authorization service: 3240 DMS HTTP: 80 DMS HTTPS: 443 Refer to SharpBox API documentation for more information on DMS implementations. FileNet P8 7001 Y FileNet Native Refer to FileNet vendor N documentation for more information. Fortis ODBC TCP 1433 (SQL Server)/1521 (ORACLE) N FortisBlue No default Y GoogleDocs No default Y HP TRIM HTTP and HTTPS for communicating through web services. Communicating through Communicating through web services: web services: Y Protocol is unknown for client communication. Hummingbird/Open Text Refer to Hummingbird/ edocs Open Text edocs vendor documentation for more information. IBM Content Manager HTTP: 80 HTTPS: 443 Authorization service: Y DMS: N Client: Y Client communication: 1137 No default N Refer to IBM Content No default Manager vendor documentation for more information. N 38
Component Protocol Default Communication Port Numbers Port Modifiable? IBM Content Manager OnDemand Uses the Microsoft Not applicable Windows File Management API for file operations. Not applicable Laserfiche Native No default N OpenText Document Server, Alchemy Native Refer to OpenText Document Server, Alchemy vendor documentation for more information Refer to OpenText Document Server, Alchemy vendor documentation for more information OpenText Livelink/ Content Server Native, Native: 2099 Y HTTP: 80 HTTPS: 443 Output Manager Route Net.Tcp, Net.Tcp: 8072 N HTTP: 8066 HTTPS: 8067 RightfFax Route Native Refer to RightFax vendor documentation for more information N Send to Database Not applicable TCP 1433 (SQL Server)/1521 (ORACLE)/None N Send to Folder Uses the Microsoft Not applicable Windows File Management API for file operations. Not applicable Send to FTP FTP 21 Y Send to HTTP 80 Y Send to Mail Recipient Native, SMTP, HTTP, HTTPS Native: Refer to vendor Native: N documentation for more SMTP: Y information. : Y SMTP: 25, 465 HTTP: 80 HTTPS: 443 39
Component Protocol Default Communication Port Numbers Port Modifiable? Send to PC TCP (for file transport) 3711 Y Send to Printer Port and protocol details Not applicable are specific to the device and driver. Not applicable Send to SFTP SFTP 22 Y SharePoint 2007 HTTP: 80 Y HTTPS: 443 SharePoint 2010 HTTP: 80 Y HTTPS: 443 WebDAV Route HTTP: 80 Y HTTPS: 443 Windream DCOM, TCP/IP TCP/IP 32-bit: 534 N TCP/IP 64-bit: 53464 WORLDOX NetBIOS Native/NetBIOS N 40
Troubleshooting tips This topic provides tips for issues that have been identified while installing AutoStore. Problem Cause Solution Unable to license AutoStore server on an Intel NUC computer because of Invalid Server ID. AutoStore requires the system serial number for licensing. The Invalid Server ID message is received when licensing AutoStore if the serial number in the System Information is not set on an Intel Next Unit of Computing (NUC) computer. The serial number on a NUC computer is part of the SMBIOS and may be set manually using the Intel Integrator Toolkit (ITK). The ITK is available for download at the Intel Download Center. Use the option to Customize this Computer's BIOS file to set an SMBIOS serial number with the ITK. Note: The ITK download may be unavailable at the Intel Download Center. For help in changing the serial number, please contact Intel Support. 41