Device Registration Service - dl.nsiautostore.comdl.nsiautostore.com/swupdates/7.00/DRS/DRS Install Guide.pdf · Business Intelligence, ... • Microsoft SQL Server 2008 and 2008

Document Imaging Solutions EN-DRS-7.11-IG-20171116

Device Registration ServiceInstallation Guide

Nuance® Device Registration Service Installation Guide EN-DRS-7.11-IG-20171116

Nuance® Device RegistrationService Installation Guide

Document Revision Date Revision List

September 16, 2017 Updated for DRS 7.11

May 19, 2017 Updated for DRS 7.10

April 18, 2017 Updated for DRS 7.9

August 22, 2016 Updated for DRS 7.8

April 25, 2016 Updated for DRS 7.7

February 20, 2016 Updated for DRS 7.6

December 20, 2016 Updated for DRS 7.5

March 11, 2015 Initial release

Symbols Used In This Guide

The accompanying text provides cross-reference links, tips, or general information thatcan add to your understanding of a topic.

The accompanying text provides key information about a step or action that mightproduce unexpected results if not followed precisely.

Read the acocompanying text carefully. This text can help you avoid making errors thatmight negatively affect program behavior.

2


2017 © Nuance Communications, Inc.® All rights reservedAll 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 formor by any means (electronic, mechanical, photocopying, recording, or otherwise) without prior writtenpermission of Nuance Communications, Inc.

TrademarksNuance, AutoStore, Output Manager, Equitrac and eCopy ShareScan are registered trademarksof Nuance Communications, Inc. All other brands and their products are trademarks or registeredtrademarks of their respective holders, and should be noted as such.

3


Contents

Introduction............................................................................................... 5Product features.............................................................................................................................. 5Device Registration Service prerequisites...................................................................................... 5Component prerequisites................................................................................................................ 8

Installing Device Registration Service................................................. 10How to install Device Registration Service...................................................................................10

Upgrading Device Registration Service............................................... 15

Configuring Device Registration Service.............................................16How to configure Device Registration Service............................................................................. 16

Starting Device Registration Service....................................................20How to start Device Registration Service..................................................................................... 20

Migrating Device Configurations.......................................................... 22

Communication Port Reference............................................................24

4


Introduction

Product features

Device Registration Service enables you to perform the following tasks:

• Manage Device Registration Service configuration settings.• Manage applications, device groups, and devices through a single web-based interface.• Manage and administer Microsoft Windows services and databases.

Device Registration Service consists of the following components:

• Device Registration Service• Device Registration Service Configuration Manager• Plug-ins for Konica Minolta, Ricoh, Samsung, Toshiba, Epson and Xerox.

For more information on using the Device Registration Service and Device Configuration Managercomponents, refer to the component Help files.

Device Registration Service prerequisites

Verify that the Device Registration Service environment meets the requirements listed in the followingtable:

5


Component Requirement

Operating system The Device Registration Service supports thefollowing operating systems:

• Windows Server 2016 — Standard andDatacenter

• Windows Server 2012 R2 — Standard andDatacenter

• Windows Server 2012 — Standard andDatacenter

• 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

Specific operating system versions (such asProfessional, Standard, and Enterprise) aresupported except for Small Business Server.

Database server Device Registration Service supports MicrosoftSQL Server 2005 or later. The various editionsof Microsoft SQL Server, such as Enterprise,Business Intelligence, and Standard, aresupported.

Note: This is required only if you use aseparate database server instead of theMicrosoft SQL Server Express or ExpressLocalDB application that is installed withDevice Registration Service.

Database servers recommended for highavailability enterprise environments:

• Microsoft SQL Server 2005 (32-bit)• Microsoft SQL Server 2008 and 2008 R2 (32

and 64-bit)• Microsoft SQL Server 2012 (32 and 64-bit)• Microsoft SQL Server 2014 (32 and 64-bit)

* Windows 8.0 is supported when running the latest service pack from Microsoft.

6


Component Requirement

Software Installed during Device Registration Serviceinstallation:

• Microsoft .NET 4.0 and Microsoft .NET 4.5• Microsoft WSE 3.0• Microsoft Visual C++ 2010 runtime• Oracle Java JRE 7

Important: Device Registration Serviceinstallation requires the 32-bit version ofJRE 7. If your environment has the 64-bitversion installed, the Device RegistrationService installation still requires the 32-bitversion.

Internet browser for viewing web Help:

• Internet Explorer 9.0 or later• Firefox 4.0 or later• Google Chrome 10.0 or later

• Microsoft SQL Server Express LocalDB

SQL Server Express is included with theAutoStore distributable as the default databaseserver for Device Registration Service. SQLServer Express is not recommended to run in ahigh availability enterprise environment.

Nuance • Nuance AutoStore 7.0 SP4• Nuance Equitrac 5.7• Nuance Output Manager 4.0 SP2• Nuance eCopy ShareScan 6.1

Common Access Card (CAC) authentication Supported versions for the Nuance UnifiedClient for Ricoh Smart Operation Panel EquitracEmbedded for Ricoh PCC 5 (only supported withAutoStore and Output Manager):

• 3.1.4• 3.1.8• 3.1.12• 4.0.1-264

Before you install Device Registration Service on Microsoft Windows 8 and Microsoft Windows 10or Microsoft Windows 2012 and Microsoft Windows 2016 Server machine, enable ASP.NET forMicrosoft .NET 4.5 or ASP.NET for Microsoft .NET 4.6:

Microsoft Windows 8:

• Open Control Panel.• In Category view, click Programs.• Under Programs and Features, click Turn Windows features on or off.• In Turn Windows features on or off, select .NET Framework 4.5 Advanced Services.

7


• Select .NET Framework 4.5.

Microsoft Windows 10:

• Open Control Panel.• In Category view, click Programs.• Under Programs and Features, click Turn Windows features on or off.• In Turn Windows features on or off, select .NET Framework 4.6 Advanced Services.• Select .NET Framework 4.6.

Microsoft Windows 2008 R2/2012 R2 Server:

1. Open Server Manager.2. Click Add Roles and Features.3. Click Features.4. Restart the Virtual Machine.5. Install DRS.

Microsoft Windows 2012 Server:

1. Open Server Manager.2. Click Add Roles and Features.3. Click Features.4. Select .NET Framework 4.5.

Microsoft Windows 2016 Server:

1. Open Server Manager.2. Click Add Roles and Features.3. Click Features.4. Select .NET Framework 4.6.25. Restart the Virtual Machine.6. Install DRS.

Follow these steps if you are upgrading Device Registration Service:

1. Stop Device Registration Service.2. Disable FIPS if it is enabled.3. Disable SSL if it is enabled.4. Upgrade Device Registration Service.5. Enable FIPS if required.6. Enable SSL if required.

Component prerequisitesThis section lists component-specific system requirements.

Ricoh ESA

• Microsoft Visual C++ 2010 runtime• Oracle Java JRE 7

For supported versions of the Java platform on Ricoh devices, see the requirements section of theRicoh Combined Client User Guide in the Device Registration Service Help after you install DeviceRegistration Service.

8


Xerox EIP

• Microsoft Web Service Enhancements 3.0

Any additional prerequisites are installed during the installation process.

9


Installing Device RegistrationService

How to install Device Registration ServiceComplete the steps in this procedure to install the Device Registration Service.

1. Right-click the executable file for Device Registration Service and click to Run as administrator,then click Yes to continue.

2. Click Install to install the required software.

10


3. Click Yes if the installation wizard prompts to reboot the machine.

Note: Contact your system administrator if you are uncertain about whether to reboot themachine.

The installation continues automatically after the machine restarts. If the installation does notcontinue after the machine restarts, run the executable again to restart the process.

4. On the Java Setup dialog box, click Install.

5. After Java is installed, click Close.

6. Click Next to install Microsoft SQL Server Express or Express LocalDB.

11


7. Review and accept the Microsoft SQL Server license agreement.8. Click Install to start the Microsoft SQL Server installation.9. Click Finish.10.Click Next to start the Device Registration Service installation.

11.Review and accept the license agreement.12.On the Customer Information screen, enter customer information and click Next.

12


13.On the Setup Type screen, select the setup type and click Next.

14.Click Install.

13


15.Click Finish to complete the installation.16.Check for software updates.

Refer to How to configure Device Registration Service on page 16 for more information onchecking for updated Device Registration Service software.

14


Upgrading DeviceRegistration Service

This procedure describes how to upgrade the Device Registration Service software.

1. Back up the DRS_LDB.mdf and DRS_LDB_log.ldf files by copying them from the DeviceRegistration Service installation folder to a temporary location.For example, from C:\Program Files (x86)\Nuance\Device Registration Service\Service\.

Note: The files store application and device configurations. The files are deleted when youuninstall Device Registration Service software. If you do not back up the files, you cannotrecover the configurations and you have to manually re-create them in the new version of DeviceRegistration Service.

2. Install version 7.0 of the Device Registration Service software as described in Installing DeviceRegistration Service.You must restart your system for changes to Microsoft SQL Server to take effect. When prompted,you can click Yes to restart immediately or No to restart manually later.

3. Replace the new versions of the DRS_LDB.mdf and DRS_LDB_log.ldf files in the DeviceRegistration Service installation folder with the files that you backed up in step 1 on page 15.

Complete the remaining steps to update existing Device profiles.4. In Device Configuration Manager, start the DRS service.5. Open the Device Registration Service web client.6. For each Device profile that is listed in the Devices pane, do the following:

a) In the Devices pane, click the Device profile to select it.b) In the Details pane, click the edit button.c) In the Details pane, click the save button.Completing this step updates Device characteristics and options to those found in the updatedversion of DRS.

15


Configuring DeviceRegistration Service

How to configure Device Registration ServicePerform configuration of the Device Registration Service after you complete the installation.

1. On the Windows Start menu, select All Programs > Nuance > Device Registration Service >Device Configuration Manager.

2. Click Yes when prompted to make changes to the computer.3. Configure settings on the Service tab as described in the following table:

Settings Description

Run service under You can run the service under the local systemaccount or a network account. The selectedaccount needs system permissions to run theservice. The account proper permission tomanage, update and configure the SQL Serverdatabase when Windows Authentication is usedto connect to the SQL Server.

Service Actions Select the Microsoft Windows service startuptype for the Device Registration Service.

Database Connection A database repository stores the configurationoptions that you specify in Device RegistrationService. The repository can reside in MicrosoftSQL Server Express or Express LocalDBinstalled with Device Registration Service, orit can reside on a remote instance of MicrosoftSQL Server.

Select Enable Local Db to use the ExpressLocalDB.

Complete step 4 on page 17 to use a remoteinstance of Microsoft SQL Server.

16



Service Settings Device Registration Service requires severalports to be specified for communication betweenthe Web service and Web client. The Web clientis the browser that you will use to access DeviceRegistration Service.

An Access Group should be specified. Theaccess group is a user or group of users whowill have access (and permission) to use DeviceRegistration Service.

4. To use a remote instance of Microsoft SQL Server to host the repository:a) Clear the Enable Local DB check box, and then click Properties to open the Connection

Properties dialog box.

b) Configure Microsoft SQL Server settings as described in the following table:


Server name For the default instance of SQL Server,enter the server name or IP address of theserver that is running SQL Server. If youare using a named instance of SQL Server,enter the instance name as well in the format,server_name\instance_name.

Log on to the server Select the type of authentication for connectingto the server. For the selected type, verify thatthe credentials have permissions to update orcreate a database on the specified instance ofMicrosoft SQL Server.

17



Connect to a database Select an existing database or create one withthe latest schema.

c) Click Test Connection to test the settings.d) Click OK if the connection is successful.

5. On the Security tab, enable SSL on the web service or the web client:

To create a self-signed certificate:

a) Select Enable SSL on Web Service or Enable SSL on Web Client.b) In the Choose Certificate box, click New Self-Signed.c) Enter the certificate information and click OK.

d) In the Certificate Path box, type the location where you want to store the certificate.The Certificate Password is the same password that you entered when creating the certificate.The masked field automatically populates with the password that you entered.

To use an existing certificate:

a) Select Enable SSL on Web Service or Enable SSL on Web Client.b) In the Choose Certificate box, click Browse.

18


c) In the Certificate Path box, type the path to the certificate.d) In the Certificate Password box, type the certificate password.

6. Configure logging settings on the Administration tab as described in the following table:


Web Service Logging In the Log Path box, type the path to thelocation where you want to store the web servicelog file, or click Browse to select the location.

To generate more detailed log files for debuggingand advanced troubleshooting with Support,select the Enable Tracing check box.

Note: This option may affect DeviceRegistration Service performance. Enabletracing only when it is necessary.

Click Show Logs to open the log file in a texteditor.

Web Client Logging In the Log Path box, type the path to thelocation where you want to store the web clientlog file, or click Browse to select the location.

To generate more detailed log files for debuggingand advanced troubleshooting with Support,select Enable Tracing.

Note: This option may affect DeviceRegistration Service performance. Enabletracing only when it is necessary.

Click Show Logs to open the log file in a texteditor.

Options Click Software Updates to check for updatedDevice Registration Service software.

Refer to the Device Configuration Manager Help for more information on logging.

19


Starting Device RegistrationService

How to start Device Registration Service1. On the Windows Start menu, click All Programs > Nuance > Device Registration Service >

Device Configuration Manager.This opens the Device Registration System Configuration dialog box.

2. Click Yes if you are prompted to confirm that you want to make changes to the computer.3. On the Service tab, in Run Service under choose a designated local or domain account to run DRS

service instead of running the service under Local System Account (due to the Windows update'sremoval of the SQL server database instance). Click Log on as a service permission to the account:a) Open Local Security Policy, click Start > Control Panel > Administrative Tools > Local

Security Policy (double-click).b) In the console tree, double-click Local Policies and then click User Rights Assignment.c) In the details pane, double-click Log on as a service.d) Click Add User or Group..., and then add the appropriate account to the list of accounts that

possess the Log on as a service right.4. Allow Full control permission of the two LocalDB database files to the account and restart the

service.5. Click the link for Web Client URL.

20


This opens Device Registration Service in your default web browser.

21


Migrating DeviceConfigurations

Starting with AutoStore version 7.0, the Ricoh ESA and Xerox EIP Connect Unified Clients do notsupport the device manager tool in the Ricoh ESA and Xerox EIP Connect non-Unified Clients. To useAutoStore 6.0 device configurations in AutoStore 7.0, use the Device Registration Service migration toolto migrate the configurations to AutoStore 7.0.

Open the migration tool from the AutoStore 7 installation folder. The default path to the tool is C:\Program Files (x86)\Notable Solutions\AutoStore 7\DeviceMigrationTool.exe.The folder location for your environment may vary. The migration tool Help provides more information onconverting AutoStore 6.0 device configurations to CSV files for import into Device Registration Service.

The following table lists the procedures for migrating configurations:

Unified Client Procedure

Ricoh ESA 1. Install Device Registration Service and createthe application profile.

2. Export the AutoStore 6.0 configuration withthe non-Unified Client device manager tool.Access the device manager tool through thenon-Unified Client component Preferencestab.

3. Convert the exported file with the migrationtool.

4. Import the converted file into DeviceRegistration Service.

22


Unified Client Procedure

Xerox EIP Connect 1. Install Device Registration Service and createthe application profile.

2. If the AutoStore 6.0 configuration containsdevice groups, create device groups with thesame group names in Device RegistrationService.

3. Convert the AutoStore 6.0RegistrationGroups.xml file with themigration tool. The default location of the fileis C:\XeroxEIPCapture. The migration toolcreates a separate CSV file for each devicegroup in the file.

4. Import the converted files into DeviceRegistration Service.

The Device Registration Service User Guide and Device Registration Service Help explain how tocreate applications, create device groups, and import device configuration files.

23


Communication PortReference

The following tables provide general information on ports and protocols for DRS server and unified orcombined clients. The component Help files contain information on configuring the components.

Table 1: DRS and Unified or Combined Client ports

Component DeviceDisplay MenuProtocol

Device FileTransportProtocol

DefaultCommunicationPort Numbers

PortModifiable?

RequiredDeviceComponentsand Notes

DRS server HTTP, HTTPS HTTP, HTTPS • Web server:8753

• ClientServer:9000

• Yes

24





PortModifiable?


CombinedClient forKonica Minolta

HTTP, HTTPS FTP/WebDAV • Webapplication:3348

Device settingfor web server

• OpenAPI:50001

• OpenAPISSL/TLS:50003

TCP Socketsetting

• 59158• SSL/TLS:

59159• ASCII

mode:59160

• Yes (exceptfor Webserver OpenAPI SSL/TLS)

The Webapplicationport numbershould matchthe componentsetting inAutoStore (orthe OutputManagersetting whennot usingAutoStore).

CombinedClient for Ricoh

HTTP, HTTPS HTTP, HTTPS AutoStoreapplicationport:

• AutoStoreserver: 8084

OutputManagerapplicationport:

• 8068• (SSL): 8069

• Yes Xlet

Java XletVM card withAutoStoreXlet on thedevice forcommunicationwith theAutoStoreserver.

25





PortModifiable?


Nuance UnifiedClient forRicoh SmartOperationPanel, RicohPCC5



OutputManagerapplicationport:

• 8068• (SSL): 8069

Equitrac

• 8443

Unified Clientfor Samsung

HTTP FTP/WebDAV • Webapplication:3349

• FTP port:3281

• WebDAVport: 13392

DRS on aremote server:

• Serviceport: 8753

• Web client:9000

• Yes

Note: All portsettings for thiscomponentare configuredon thePreferencestab of thecomponentsettings.

The Webapplicationport numbershould matchthe componentsetting inAutoStore (orthe OutputManagersetting whennot usingAutoStore).

Unified Clientfor Xerox

HTTP, HTTPS FTP/SMB OutputManagerserver ports:

• HTTPS:8069

• HTTP: 8068• nettcp: 8070

Web app port:

• 3241

Yes No applet

IIS webapplicationconnects tothe AutoStoreweb service.The deviceconnects tothe IIS webapplication.

26





PortModifiable?


Nuance UnifiedClient forEpson v1.0

HTTP, HTTPS HTTP, HTTPS eCopyShareScanapplicationport:

• eCopyShareScanserver:9655/9656

Equitrac

• 8443

Yes

Unified Clientfor Toshiba



Equitrac

• 8444

Yes

27

Documents

Device Registration Service - dl.nsiautostore.comdl.nsiautostore.com/swupdates/7.00/DRS/DRS Install Guide.pdf · Business Intelligence, ... • Microsoft SQL Server 2008 and 2008